Fork Go OpenAI

Package jsonschema provides very simple functionality for representing a JSON schema as a (nested) struct.

NewClient creates new OpenAI API client.

NewClientWithConfig creates new OpenAI API client for specified config.

NewOrgClient creates new OpenAI API client for specified Organization ID.

Deprecated: The following block will be shut down on January 04, 2024.

Chat message role defined by the OpenAI API.

Chat message role defined by the OpenAI API.

Chat message role defined by the OpenAI API.

Chat message role defined by the OpenAI API.

Chat message role defined by the OpenAI API.

Codex Defines the models provided by OpenAI.

Codex Defines the models provided by OpenAI.

Codex Defines the models provided by OpenAI.

Image sizes defined by the OpenAI API.

Image sizes defined by the OpenAI API.

dall-e-3 supported only.

Image sizes defined by the OpenAI API.

Image sizes defined by the OpenAI API.

GPT3 Defines the models provided by OpenAI to use when generating completions from OpenAI.

GPT3 Defines the models provided by OpenAI to use when generating completions from OpenAI.

GPT3 Defines the models provided by OpenAI to use when generating completions from OpenAI.

GPT3 Defines the models provided by OpenAI to use when generating completions from OpenAI.

GPT3 Defines the models provided by OpenAI to use when generating completions from OpenAI.

GPT3 Defines the models provided by OpenAI to use when generating completions from OpenAI.

Deprecated: Will be shut down on January 04, 2024.

GPT3 Defines the models provided by OpenAI to use when generating completions from OpenAI.

GPT3 Defines the models provided by OpenAI to use when generating completions from OpenAI.

Deprecated: Will be shut down on January 04, 2024.

GPT3 Defines the models provided by OpenAI to use when generating completions from OpenAI.

GPT3 Defines the models provided by OpenAI to use when generating completions from OpenAI.

GPT3 Defines the models provided by OpenAI to use when generating completions from OpenAI.

GPT3 Defines the models provided by OpenAI to use when generating completions from OpenAI.

GPT3 Defines the models provided by OpenAI to use when generating completions from OpenAI.

GPT3 Defines the models provided by OpenAI to use when generating completions from OpenAI.

GPT3 Defines the models provided by OpenAI to use when generating completions from OpenAI.

GPT3 Defines the models provided by OpenAI to use when generating completions from OpenAI.

Deprecated: Will be shut down on January 04, 2024.

Deprecated: Will be shut down on January 04, 2024.

Deprecated: Will be shut down on January 04, 2024.

Deprecated: Will be shut down on January 04, 2024.

Deprecated: Will be shut down on January 04, 2024.

Deprecated: Will be shut down on January 04, 2024.

GPT3 Defines the models provided by OpenAI to use when generating completions from OpenAI.

GPT3 Defines the models provided by OpenAI to use when generating completions from OpenAI.

GPT3 Defines the models provided by OpenAI to use when generating completions from OpenAI.

GPT3 Defines the models provided by OpenAI to use when generating completions from OpenAI.

GPT3 Defines the models provided by OpenAI to use when generating completions from OpenAI.

GPT3 Defines the models provided by OpenAI to use when generating completions from OpenAI.

GPT3 Defines the models provided by OpenAI to use when generating completions from OpenAI.

GPT3 Defines the models provided by OpenAI to use when generating completions from OpenAI.

GPT3 Defines the models provided by OpenAI to use when generating completions from OpenAI.

GPT3 Defines the models provided by OpenAI to use when generating completions from OpenAI.

GPT3 Defines the models provided by OpenAI to use when generating completions from OpenAI.

GPT3 Defines the models provided by OpenAI to use when generating completions from OpenAI.

GPT3 Defines the models provided by OpenAI to use when generating completions from OpenAI.

GPT3 Defines the models provided by OpenAI to use when generating completions from OpenAI.

Deprecated: use ModerationTextStable and ModerationTextLatest instead.

The default is text-moderation-latest which will be automatically upgraded over time.

The default is text-moderation-latest which will be automatically upgraded over time.

TruncationStrategyAuto messages in the middle of the thread will be dropped to fit the context length of the model.

TruncationStrategyLastMessages the thread will be truncated to the n most recent messages in the thread.

Whisper Defines the models provided by OpenAI to use when processing audio with OpenAI.

nolint:lll.

nolint:lll.

nolint:lll.

nolint:lll.

nolint:lll.

nolint:lll.

APIError provides error information returned by the OpenAI API.

AssistantRequest provides the assistant request parameters.

AssistantsList is a list of assistants.

AudioRequest represents a request structure for audio API.

AudioResponse represents a response structure for audio API.

Base64Embedding is a container for base64 encoded embeddings.

ChatCompletionRequest represents a request structure for chat completion API.

ChatCompletionResponse represents a response structure for chat completion API.

ChatCompletionStream Note: Perhaps it is more elegant to abstract Stream using generics.

Client is OpenAI GPT-3 API client.

ClientConfig is a configuration of a client.

CompletionChoice represents one of possible completions.

CompletionRequest represents a request structure for completion API.

CompletionResponse represents a response structure for completion API.

EditsChoice represents one of possible edits.

EditsRequest represents a request structure for Edits API.

EditsResponse represents a response structure for Edits API.

Embedding is a special format of data representation that can be easily utilized by machine learning models and algorithms.

EmbeddingRequestStrings is the input to a create embeddings request with a slice of strings.

EmbeddingResponse is the response from a Create embeddings request.

EmbeddingResponseBase64 is the response from a Create embeddings request with base64 encoding format.

Engine struct represents engine from OpenAPI API.

EnginesList is a list of engines.

File struct represents an OpenAPI file.

FileBytesRequest represents a file upload request.

FilesList is a list of files that belong to the user or organization.

Deprecated: On August 22nd, 2023, OpenAI announced the deprecation of the /v1/fine-tunes API.

Deprecated: On August 22nd, 2023, OpenAI announced the deprecation of the /v1/fine-tunes API.

Deprecated: On August 22nd, 2023, OpenAI announced the deprecation of the /v1/fine-tunes API.

Deprecated: On August 22nd, 2023, OpenAI announced the deprecation of the /v1/fine-tunes API.

Deprecated: On August 22nd, 2023, OpenAI announced the deprecation of the /v1/fine-tunes API.

Deprecated: On August 22nd, 2023, OpenAI announced the deprecation of the /v1/fine-tunes API.

FineTuneModelDeleteResponse represents the deletion status of a fine-tuned model.

Deprecated: On August 22nd, 2023, OpenAI announced the deprecation of the /v1/fine-tunes API.

ImageEditRequest represents the request structure for the image API.

ImageRequest represents the request structure for the image API.

ImageResponse represents a response structure for image API.

ImageResponseDataInner represents a response data structure for image API.

ImageVariRequest represents the request structure for the image API.

InnerError Azure Content filtering.

LogProb represents the probability information for a token.

LogprobResult represents logprob result of Choice.

LogProbs is the top-level structure containing the log probability information.

Model struct represents an OpenAPI model.

ModelsList is a list of models, including those that belong to the user or organization.

ModerationRequest represents a request structure for moderation API.

ModerationResponse represents a response structure for moderation API.

Permission struct represents an OpenAPI permission.

RateLimitHeaders struct represents Openai rate limits headers.

RequestError provides information about generic request errors.

Result represents one of possible moderation results.

ResultCategories represents Categories of Result.

ResultCategoryScores represents CategoryScores of Result.

RunList is a list of runs.

RunStepList is a list of steps.

ThreadTruncationStrategy defines the truncation strategy to use for the thread.

Usage Represents the total token usage per request to OpenAI.

Response formats; Whisper uses AudioResponseFormatJSON by default.

EmbeddingEncodingFormat is the format of the embeddings data.

EmbeddingModel enumerates the models which can be used to generate Embedding vectors.

Deprecated: use FunctionDefinition instead.

PurposeType represents the purpose of the file when uploading.

TruncationStrategy defines the existing truncation strategies existing for thread management in an assistant.