View Source API Reference OpenAI REST API Client v0.4.4

Documentation for OpenExAi.

Provides struct and type for a Assistant

Provides struct and type for a Assistant.ApiResponseFormat

Provides struct and type for a Assistant.CreateRequest

Provides struct and type for a Assistant.CreateRequest.ToolResources

Provides struct and type for a Assistant.CreateRequest.ToolResources.CodeInterpreter

Provides struct and type for a Assistant.DeleteResponse

Provides struct and type for a Assistant.ListResponse

Provides struct and type for a Assistant.NamedToolChoice

Provides struct and type for a Assistant.NamedToolChoiceFunction

Provides struct and type for a Assistant.Tool.Code

Provides struct and type for a Assistant.Tool.File.Search

Provides struct and type for a Assistant.Tool.File.SearchFileSearch

Provides struct and type for a Assistant.Tool.File.SearchTypeOnly

Provides struct and type for a Assistant.Tool.Function

Provides struct and type for a Assistant.Tool.Outputs.RunSubmitRequest

Provides struct and type for a Assistant.Tool.Outputs.RunSubmitRequest.ToolOutputs

Provides struct and type for a Assistant.Tool.Resources

Provides struct and type for a Assistant.Tool.Resources.CodeInterpreter

Provides struct and type for a Assistant.Tool.Resources.FileSearch

Provides struct and type for a Assistant.UpdateRequest

Provides struct and type for a Assistant.UpdateRequest.ToolResources

Provides struct and type for a Assistant.UpdateRequest.ToolResources.CodeInterpreter

Provides struct and type for a Assistant.UpdateRequest.ToolResources.FileSearch

Provides API endpoints related to assistants

Provides API endpoints related to audio

Provides struct and type for a Audio.Speech.CreateRequest

Provides struct and type for a Audio.Transcription.CreateRequest

Provides struct and type for a Audio.Transcription.CreateResponse.Json

Provides struct and type for a Audio.Transcription.CreateResponse.VerboseJson

Provides struct and type for a Audio.Transcription.Segment

Provides struct and type for a Audio.Transcription.Word

Provides struct and type for a Audio.Translation.CreateRequest

Provides struct and type for a Audio.Translation.CreateResponse.Json

Provides struct and type for a Audio.Translation.CreateResponse.VerboseJson

Provides API endpoints related to batch

Provides struct and type for a Batch.Errors

Provides struct and type for a Batch.ErrorsData

Provides struct and type for a Batch.ListResponse

Provides struct and type for a Batch.RequestCounts

Provides API endpoint related to chat

Provides struct and type for a Chat.Completion.CreateRequest

Provides struct and type for a Chat.Completion.CreateRequest.LogitBias

Provides struct and type for a Chat.Completion.CreateResponse

Provides struct and type for a Chat.Completion.CreateResponse.Choice

Provides struct and type for a Chat.Completion.CreateResponse.Choice.Logprobs

Provides struct and type for a Chat.Completion.Function

Provides struct and type for a Chat.Completion.FunctionCallOption

Provides struct and type for a Chat.Completion.MessageTool.Call

Provides struct and type for a Chat.Completion.MessageTool.CallFunction

Provides struct and type for a Chat.Completion.NamedTool.Choice

Provides struct and type for a Chat.Completion.NamedTool.ChoiceFunction

Provides struct and type for a Chat.Completion.Request.AssistantMessage

Provides struct and type for a Chat.Completion.Request.AssistantMessageFunctionCall

Provides struct and type for a Chat.Completion.Request.CreateResponseFormat

Provides struct and type for a Chat.Completion.Request.FunctionMessage

Provides struct and type for a Chat.Completion.Request.SystemMessage

Provides struct and type for a Chat.Completion.Request.ToolMessage

Provides struct and type for a Chat.Completion.Request.UserMessage

Provides struct and type for a Chat.Completion.Response.Message

Provides struct and type for a Chat.Completion.Response.MessageFunctionCall

Provides struct and type for a Chat.Completion.StreamOptions

Provides struct and type for a Chat.Completion.TokenLogprob

Provides struct and type for a Chat.Completion.TokenLogprobTopLogprobs

Provides struct and type for a Chat.Completion.Tool

Module responsible for making requests to the OpenAI API. And transforming the response to the expected response type.

Module for transforming lists to expected types.

Module for transforming streaming responses.

Provides struct and type for a Client.Stream.Error

Module for transforming maps to expected structs.

Module for transforming values to expected types.

Provides struct and type for a Completion.CreateRequest

Provides struct and type for a Completion.CreateRequest.LogitBias

Provides struct and type for a Completion.CreateResponse

Provides struct and type for a Completion.CreateResponse.Choice

Provides struct and type for a Completion.CreateResponse.Choice.Logprobs

Provides struct and type for a Completion.CreateResponse.Choice.LogprobsTopLogprobs

Provides struct and type for a Completion.Usage

Provides API endpoint related to completions

Module responsible for managing the configuration of the OpenAI API client.

Provides struct and type for a Embedding

Provides struct and type for a Embedding.CreateRequest

Provides struct and type for a Embedding.CreateResponse

Provides struct and type for a Embedding.CreateResponse.Usage

Provides API endpoint related to embeddings

Provides struct and type for generic Error

Provides struct and type for a File

Provides struct and type for a File.CreateRequest

Provides struct and type for a File.DeleteResponse

Provides struct and type for a File.ListResponse

Provides API endpoints related to files

Provides API endpoints related to fine tuning

Provides struct and type for a FineTuning.Integration

Provides struct and type for a FineTuning.Integration.Wandb

Provides struct and type for a FineTuning.Job

Provides struct and type for a FineTuning.Job.Checkpoint

Provides struct and type for a FineTuning.Job.Checkpoint.ListResponse

Provides struct and type for a FineTuning.Job.Checkpoint.Metrics

Provides struct and type for a FineTuning.Job.CreateRequest

Provides struct and type for a FineTuning.Job.CreateRequest.Hyperparameters

Provides struct and type for a FineTuning.Job.CreateRequest.Integrations

Provides struct and type for a FineTuning.Job.CreateRequest.IntegrationsWandb

Provides struct and type for a FineTuning.Job.Error

Provides struct and type for a FineTuning.Job.Event

Provides struct and type for a FineTuning.Job.Event.ListResponse

Provides struct and type for a FineTuning.Job.Hyperparameters

Provides struct and type for a FineTuning.Job.ListResponse

Provides struct and type for a Function

Provides struct and type for a Image

Provides struct and type for a Image.CreateRequest

Provides struct and type for a Image.EditCreateRequest

Provides struct and type for a Image.Response

Provides struct and type for a Image.VariationCreateRequest

Provides API endpoints related to images

Provides struct and type for a Message

Provides struct and type for a Message.Attachment

Provides struct and type for a Message.Content.Image.File

Provides struct and type for a Message.Content.Image.FileImageFile

Provides struct and type for a Message.Content.Image.Url

Provides struct and type for a Message.Content.Image.UrlImageUrl

Provides struct and type for a Message.Content.Text

Provides struct and type for a Message.Content.Text.AnnotationsFileCitation

Provides struct and type for a Message.Content.Text.AnnotationsFileCitationFileCitation

Provides struct and type for a Message.Content.Text.AnnotationsFilePath

Provides struct and type for a Message.Content.Text.AnnotationsFilePathFilePath

Provides struct and type for a Message.Content.Text.Text

Provides struct and type for a Message.CreateRequest

Provides struct and type for a Message.CreateRequest.Attachment

Provides struct and type for a Message.DeleteResponse

MessageDeltaObject: type: object title: Message delta object description: |

MessageDeltaContentImageFileObject: title: Image file type: object description: References an image File in the content of a message. properties

Provides struct and type for a Message.Delta.Content.Image.FileImageFile

MessageDeltaContentImageUrlObject: title: Image URL type: object description: References an image URL in the content of a message. properties

Provides struct and type for a Message.Delta.Content.Image.UrlImageUrl

MessageDeltaContentTextObject: title: Text type: object description: The text content that is part of a message. properties

MessageDeltaContentTextAnnotationsFileCitationObject: title: File citation type: object description: A citation within the message that points to a specific quote from a specific File associated with the assistant or the message. Generated when the assistant uses the "file_search" tool to search files. properties

Provides struct and type for a Message.Delta.Content.Text.Annotations.FileCitation.FileCitation

MessageDeltaContentTextAnnotationsFilePathObject: title: File path type: object description: A URL for the file that's generated when the assistant used the code_interpreter tool to generate a file. properties

Provides struct and type for a Message.Delta.Content.Text.Annotations.FilePath.FilePath

Provides struct and type for a Message.Delta.Content.Text.Text

Provides struct and type for a Message.Delta.Delta

Provides struct and type for a Message.IncompleteDetails

Provides struct and type for a Message.ListResponse

Provides struct and type for a Message.UpdateRequest

Mocks for Assistant schema

Mocks for audio related responses.

Mocks for batch related responses.

Mocks for chat completion related responses.

Mocks for completion related responses.

Mocks for embedding related responses.

Mocks for file related responses.

Mocks for fine tuning related responses.

Mocks for function related responses.

Mocks for image related responses.

Mocks for message related responses.

Mocks for message delta related responses.

Mocks for model related responses.

Mocks for moderation related responses.

Mocks for run related responses.

Mocks for run step delta related responses.

Mocks for thread related responses.

Mocks for truncation related responses.

Mocks for vector store related responses.

Mocks for vector store file related responses.

Mocks for vector store file batch related responses.

Provides struct and type for a Model

Provides struct and type for a Model.DeleteResponse

Provides struct and type for a Model.ListResponse

Provides API endpoints related to models

Provides struct and type for a Moderation.CreateRequest

Provides struct and type for a Moderation.CreateResponse

Provides struct and type for a Moderation.CreateResponse.Result

Provides struct and type for a Moderation.CreateResponse.Result.Categories

Provides struct and type for a Moderation.CreateResponse.Result.CategoryScores

Provides API endpoint related to moderations

Provides struct and type for a Run

Provides struct and type for a Run.CompletionUsage

Provides struct and type for a Run.CreateRequest

Provides struct and type for a Run.IncompleteDetails

Provides struct and type for a Run.LastError

Provides struct and type for a Run.ListResponse

Provides struct and type for a Run.RequiredAction

Provides struct and type for a Run.RequiredAction.SubmitToolOutputs

Provides struct and type for a Run.Step

Provides struct and type for a Run.Step.CompletionUsage

RunStepDeltaObject: type: object title: Run step delta object description: |

Provides struct and type for a Run.Step.Delta.Delta

Provides struct and type for a Run.Step.Delta.Step.DetailsMessageCreation

Provides struct and type for a Run.Step.Delta.Step.DetailsMessageCreationMessageCreation

Provides struct and type for a Run.Step.Delta.Step.DetailsToolCalls

Provides struct and type for a Run.Step.Delta.Step.DetailsToolCallsCode

Provides struct and type for a Run.Step.Delta.Step.DetailsToolCallsCodeCodeInterpreter

Provides struct and type for a Run.Step.Delta.Step.DetailsToolCallsCodeOutput

Provides struct and type for a Run.Step.Delta.Step.DetailsToolCallsCodeOutputImage

Provides struct and type for a Run.Step.Delta.Step.DetailsToolCallsCodeOutputImageImage

Provides struct and type for a Run.Step.Delta.Step.DetailsToolCallsCodeOutputLogs

Provides struct and type for a Run.Step.Delta.Step.DetailsToolCallsFileSearch

Provides struct and type for a Run.Step.Delta.Step.DetailsToolCallsFunction

Provides struct and type for a Run.Step.DetailsMessageCreation

Provides struct and type for a Run.Step.DetailsMessageCreationMessageCreation

Provides struct and type for a Run.Step.DetailsToolCalls

Provides struct and type for a Run.Step.DetailsToolCallsCode

Provides struct and type for a Run.Step.DetailsToolCallsCodeCodeInterpreter

Provides struct and type for a Run.Step.DetailsToolCallsCodeOutputImage

Provides struct and type for a Run.Step.DetailsToolCallsCodeOutputImageImage

Provides struct and type for a Run.Step.DetailsToolCallsCodeOutputLogs

Provides struct and type for a Run.Step.DetailsToolCallsFileSearch

Provides struct and type for a Run.Step.DetailsToolCallsFunction

Provides struct and type for a Run.Step.DetailsToolCallsFunctionFunction

Provides struct and type for a Run.Step.LastError

Provides struct and type for a Run.Step.ListResponse

Provides struct and type for a Run.ToolCall

Provides struct and type for a Run.ToolCall.Function

Provides struct and type for a Run.UpdateRequest

Provides struct and type for a Thread

Provides struct and type for a Thread.CreateAndRunRequest

Provides struct and type for a Thread.CreateAndRunRequest.ToolResources

Provides struct and type for a Thread.CreateAndRunRequest.ToolResourcesCodeInterpreter

Provides struct and type for a Thread.CreateAndRunRequest.ToolResourcesFileSearch

Provides struct and type for a Thread.CreateRequest

Provides struct and type for a Thread.CreateRequest.ToolResources

Provides struct and type for a Thread.CreateRequest.ToolResourcesCodeInterpreter

Provides struct and type for a Thread.DeleteResponse

Provides struct and type for a Thread.ToolResources

Provides struct and type for a Thread.ToolResources.CodeInterpreter

Provides struct and type for a Thread.ToolResources.FileSearch

Provides struct and type for a Thread.UpdateRequest

Provides struct and type for a Thread.UpdateRequest.ToolResources

Provides struct and type for a Thread.UpdateRequest.ToolResourcesCodeInterpreter

Provides struct and type for a Thread.UpdateRequest.ToolResourcesFileSearch

Provides struct and type for a Truncation

Provides struct and type for a VectorStore

Provides struct and type for a VectorStore.CreateRequest

Provides struct and type for a VectorStore.DeleteResponse

Provides struct and type for a VectorStore.ExpirationAfter

Provides struct and type for a VectorStore.File

Provides struct and type for a VectorStore.File.Batch

Provides struct and type for a VectorStore.File.Batch.CreateRequest

Provides struct and type for a VectorStore.File.Batch.FileCounts

Provides struct and type for a VectorStore.File.ChunkingStrategy.Auto.RequestParam

Provides struct and type for a VectorStore.File.ChunkingStrategy.Other.ResponseParam

Provides struct and type for a VectorStore.File.ChunkingStrategy.Static

Provides struct and type for a VectorStore.File.ChunkingStrategy.Static.RequestParam

Provides struct and type for a VectorStore.File.ChunkingStrategy.Static.ResponseParam

Provides struct and type for a VectorStore.File.Counts

Provides struct and type for a VectorStore.File.CreateRequest

Provides struct and type for a VectorStore.File.DeleteResponse

Provides struct and type for a VectorStore.File.LastError

Provides struct and type for a VectorStore.File.ListResponse

Provides struct and type for a VectorStore.ListResponse

Provides struct and type for a VectorStore.UpdateRequest

Provides API endpoints related to vector stores