async_openai_types

Module types

Source
Expand description

Types used in OpenAI API requests and responses. These types are created from component schemas in the OpenAPI spec

Structs§

AssistantFileObject
A list of Files attached to an assistant.
AssistantObject
Represents an assistant that can call the model and use tools.
AssistantToolCodeInterpreterResources
AssistantToolFileSearchResources
AssistantToolResources
AssistantToolsFileSearch
Retrieval tool
AssistantToolsFileSearchOverrides
AssistantToolsFunction
Function tool
AssistantVectorStore
AssistantsNamedToolChoice
Specifies a tool the model should use. Use to force the model to call a specific tool.
AudioInput
Base64Embedding
Represents an base64-encoded embedding vector returned by embedding endpoint.
Base64EmbeddingVector
Batch
BatchError
BatchErrors
BatchRequest
BatchRequestArgs
Builder for BatchRequest.
BatchRequestCounts
BatchRequestInput
The per-line object of the batch input file
BatchRequestOutput
The per-line object of the batch output and error files
BatchRequestOutputError
BatchRequestOutputResponse
Category
CategoryScore
A list of the categories along with their scores as predicted by model.
ChatChoice
ChatChoiceLogprobs
ChatChoiceStream
ChatCompletionMessageToolCall
ChatCompletionMessageToolCallChunk
ChatCompletionNamedToolChoice
Specifies a tool the model should use. Use to force the model to call a specific function.
ChatCompletionRequestAssistantMessage
ChatCompletionRequestAssistantMessageArgs
Builder for ChatCompletionRequestAssistantMessage.
ChatCompletionRequestFunctionMessage
ChatCompletionRequestFunctionMessageArgs
Builder for ChatCompletionRequestFunctionMessage.
ChatCompletionRequestMessageContentPartImage
ChatCompletionRequestMessageContentPartImageArgs
Builder for ChatCompletionRequestMessageContentPartImage.
ChatCompletionRequestMessageContentPartRefusal
ChatCompletionRequestMessageContentPartRefusalBuilder
Builder for ChatCompletionRequestMessageContentPartRefusal.
ChatCompletionRequestMessageContentPartText
ChatCompletionRequestMessageContentPartTextArgs
Builder for ChatCompletionRequestMessageContentPartText.
ChatCompletionRequestSystemMessage
ChatCompletionRequestSystemMessageArgs
Builder for ChatCompletionRequestSystemMessage.
ChatCompletionRequestToolMessage
Tool message
ChatCompletionRequestToolMessageArgs
Builder for ChatCompletionRequestToolMessage.
ChatCompletionRequestUserMessage
ChatCompletionRequestUserMessageArgs
Builder for ChatCompletionRequestUserMessage.
ChatCompletionResponseMessage
A chat completion message generated by the model.
ChatCompletionStreamOptions
Options for streaming response. Only set this when you set stream: true.
ChatCompletionStreamResponseDelta
A chat completion delta generated by streamed model responses.
ChatCompletionTokenLogprob
ChatCompletionTool
ChatCompletionToolArgs
Builder for ChatCompletionTool.
Choice
CodeInterpreter
CompletionUsage
Usage statistics for the completion request.
ContentModerationResult
CreateAssistantFileRequest
CreateAssistantRequest
CreateAssistantRequestArgs
Builder for CreateAssistantRequest.
CreateAssistantToolFileSearchResources
CreateAssistantToolResources
CreateBase64EmbeddingResponse
CreateChatCompletionRequest
CreateChatCompletionRequestArgs
Builder for CreateChatCompletionRequest.
CreateChatCompletionResponse
Represents a chat completion response returned by model, based on the provided input.
CreateChatCompletionStreamResponse
Represents a streamed chunk of a chat completion response returned by model, based on the provided input.
CreateCompletionRequest
CreateCompletionRequestArgs
Builder for CreateCompletionRequest.
CreateCompletionResponse
CreateEmbeddingRequest
CreateEmbeddingRequestArgs
Builder for CreateEmbeddingRequest.
CreateEmbeddingResponse
CreateFileRequest
CreateFileRequestArgs
Builder for CreateFileRequest.
CreateFineTuningJobRequest
CreateFineTuningJobRequestArgs
Builder for CreateFineTuningJobRequest.
CreateImageEditRequest
CreateImageEditRequestArgs
Builder for CreateImageEditRequest.
CreateImageRequest
CreateImageRequestArgs
Builder for CreateImageRequest.
CreateImageVariationRequest
CreateImageVariationRequestArgs
Builder for CreateImageVariationRequest.
CreateMessageRequest
CreateMessageRequestArgs
Builder for CreateMessageRequest.
CreateModerationRequest
CreateModerationRequestArgs
Builder for CreateModerationRequest.
CreateModerationResponse
Represents if a given text input is potentially harmful.
CreateRunRequest
CreateRunRequestArgs
Builder for CreateRunRequest.
CreateSpeechRequest
CreateSpeechRequestArgs
Builder for CreateSpeechRequest.
CreateSpeechResponse
CreateThreadAndRunRequest
CreateThreadAndRunRequestArgs
Builder for CreateThreadAndRunRequest.
CreateThreadRequest
CreateThreadRequestArgs
Builder for CreateThreadRequest.
CreateTranscriptionRequest
CreateTranscriptionRequestArgs
Builder for CreateTranscriptionRequest.
CreateTranscriptionResponseJson
Represents a transcription response returned by model, based on the provided input.
CreateTranscriptionResponseVerboseJson
Represents a verbose json transcription response returned by model, based on the provided input.
CreateTranslationRequest
CreateTranslationRequestArgs
Builder for CreateTranslationRequest.
CreateTranslationResponseJson
CreateTranslationResponseVerboseJson
CreateVectorStoreFileBatchRequest
CreateVectorStoreFileBatchRequestArgs
Builder for CreateVectorStoreFileBatchRequest.
CreateVectorStoreFileRequest
CreateVectorStoreFileRequestArgs
Builder for CreateVectorStoreFileRequest.
CreateVectorStoreRequest
CreateVectorStoreRequestArgs
Builder for CreateVectorStoreRequest.
DeleteAssistantFileResponse
Deletes the association between the assistant and the file, but does not delete the File object itself.
DeleteAssistantResponse
DeleteFileResponse
DeleteMessageResponse
DeleteModelResponse
DeleteThreadResponse
DeleteVectorStoreFileResponse
DeleteVectorStoreResponse
DeltaCodeInterpreter
Embedding
Represents an embedding vector returned by embedding endpoint.
EmbeddingUsage
FileCitation
FileInput
FilePath
FileSearchRankingOptions
The ranking options for the file search.
FineTuneJobError
For fine-tuning jobs that have failed, this will contain more information on the cause of the failure.
FineTuningIntegration
FineTuningJob
The fine_tuning.job object represents a fine-tuning job that has been created through the API.
FineTuningJobCheckpoint
The fine_tuning.job.checkpoint object represents a model checkpoint for a fine-tuning job that is ready to use.
FineTuningJobCheckpointMetrics
FineTuningJobEvent
Fine-tuning job event object
FunctionCall
The name and arguments of a function that should be called, as generated by the model.
FunctionCallStream
FunctionName
FunctionObject
FunctionObjectArgs
Builder for FunctionObject.
Hyperparameters
ImageFile
ImageInput
ImageUrl
ImageUrlArgs
Builder for ImageUrl.
ImagesResponse
LastError
ListAssistantFilesResponse
ListAssistantsResponse
ListBatchesResponse
ListFilesResponse
ListFineTuningJobCheckpointsResponse
ListFineTuningJobEventsResponse
ListMessageFilesResponse
ListMessagesResponse
ListModelResponse
ListPaginatedFineTuningJobsResponse
ListRunStepsResponse
ListRunsResponse
ListVectorStoreFilesResponse
ListVectorStoresResponse
Logprobs
MessageAttachment
MessageContentImageFileObject
References an image File in the content of a message.
MessageContentImageUrlObject
References an image URL in the content of a message.
MessageContentRefusalObject
MessageContentTextAnnotationsFileCitationObject
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.
MessageContentTextAnnotationsFilePathObject
MessageContentTextObject
The text content that is part of a message.
MessageCreation
MessageDelta
MessageDeltaContentImageFileObject
References an image File in the content of a message.
MessageDeltaContentImageUrlObject
MessageDeltaContentRefusalObject
MessageDeltaContentText
MessageDeltaContentTextAnnotationsFileCitationObject
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.
MessageDeltaContentTextAnnotationsFilePathObject
A URL for the file that’s generated when the assistant used the code_interpreter tool to generate a file.
MessageDeltaContentTextObject
The text content that is part of a message.
MessageDeltaObject
Represents a message delta i.e. any changed fields on a message during streaming.
MessageFileObject
A list of files attached to a message.
MessageIncompleteDetails
MessageObject
Represents a message within a thread.
MessageRequestContentTextObject
Model
Describes an OpenAI model offering that can be used with the API.
ModifyAssistantRequest
ModifyAssistantRequestArgs
Builder for ModifyAssistantRequest.
ModifyMessageRequest
ModifyRunRequest
ModifyThreadRequest
OpenAIFile
The File object represents a document that has been uploaded to OpenAI.
RequiredAction
ResponseFormatJsonSchema
RunCompletionUsage
RunObject
Represents an execution run on a thread.
RunObjectIncompleteDetails
RunStepCompletionUsage
RunStepDelta
RunStepDeltaObject
Represents a run step delta i.e. any changed fields on a run step during streaming.
RunStepDeltaStepDetailsMessageCreationObject
Details of the message creation by the run step.
RunStepDeltaStepDetailsToolCallsCodeObject
Details of the Code Interpreter tool call the run step was involved in.
RunStepDeltaStepDetailsToolCallsCodeOutputImageObject
Code interpreter image output
RunStepDeltaStepDetailsToolCallsCodeOutputLogsObject
Text output from the Code Interpreter tool call as part of a run step.
RunStepDeltaStepDetailsToolCallsFileSearchObject
RunStepDeltaStepDetailsToolCallsFunctionObject
Function tool call
RunStepDeltaStepDetailsToolCallsObject
Details of the tool call.
RunStepDetailsMessageCreationObject
Details of the message creation by the run step.
RunStepDetailsToolCallsCodeObject
Code interpreter tool call
RunStepDetailsToolCallsCodeOutputImageObject
RunStepDetailsToolCallsCodeOutputLogsObject
Text output from the Code Interpreter tool call as part of a run step.
RunStepDetailsToolCallsFileSearchObject
File search tool call
RunStepDetailsToolCallsFileSearchObjectFileSearch
RunStepDetailsToolCallsFileSearchResultObject
A result instance of the file search.
RunStepDetailsToolCallsFileSearchResultObjectContent
RunStepDetailsToolCallsFunctionObject
RunStepDetailsToolCallsObject
Details of the tool call.
RunStepFunctionObject
RunStepFunctionObjectDelta
RunStepObject
Represents a step in execution of a run.
RunToolCallObject
StaticChunkingStrategy
Static Chunking Strategy
SubmitToolOutputs
SubmitToolOutputsRunRequest
TextData
ThreadObject
Represents a thread that contains messages.
ToolsOutputs
ToolsOutputsArgs
Builder for ToolsOutputs.
TopLogprobs
TranscriptionSegment
TranscriptionWord
TruncationObject
Thread Truncation Controls
UpdateVectorStoreRequest
UpdateVectorStoreRequestArgs
Builder for UpdateVectorStoreRequest.
VectorStoreExpirationAfter
Vector store expiration policy
VectorStoreFileBatchCounts
VectorStoreFileBatchObject
A batch of files attached to a vector store.
VectorStoreFileCounts
VectorStoreFileError
VectorStoreFileObject
VectorStoreObject
A vector store is a collection of processed files can be used by the file_search tool.
WandB

Enums§

AssistantStreamEvent
Represents an event emitted when streaming a Run.
AssistantToolType
AssistantTools
AssistantVectorStoreChunkingStrategy
AssistantsApiResponseFormatOption
Specifies the format that the model must output. Compatible with GPT-4o, GPT-4 Turbo, and all GPT-3.5 Turbo models since gpt-3.5-turbo-1106.
AssistantsApiToolChoiceOption
Controls which (if any) tool is called by the model. none means the model will not call any tools and instead generates a message. auto is the default value and means the model can pick between generating a message or calling one or more tools. required means the model must call one or more tools before responding to the user. Specifying a particular tool like {"type": "file_search"} or {"type": "function", "function": {"name": "my_function"}} forces the model to call that tool.
AudioResponseFormat
BatchCompletionWindow
BatchEndpoint
BatchRequestInputMethod
BatchSize
BatchStatus
ChatCompletionFunctionCall
ChatCompletionRequestAssistantMessageContent
ChatCompletionRequestAssistantMessageContentPart
ChatCompletionRequestMessage
ChatCompletionRequestMessageContentPartRefusalBuilderError
Error type for ChatCompletionRequestMessageContentPartRefusalBuilder
ChatCompletionRequestSystemMessageContent
ChatCompletionRequestSystemMessageContentPart
ChatCompletionRequestToolMessageContent
ChatCompletionRequestToolMessageContentPart
ChatCompletionRequestUserMessageContent
ChatCompletionRequestUserMessageContentPart
ChatCompletionToolChoiceOption
Controls which (if any) tool is called by the model. none means the model will not call any tool and instead generates a message. auto means the model can pick between generating a message or calling one or more tools. required means the model must call one or more tools. Specifying a particular tool via {"type": "function", "function": {"name": "my_function"}} forces the model to call that tool.
ChatCompletionToolType
CodeInterpreterOutput
CompletionFinishReason
CreateMessageRequestContent
DallE2ImageSize
DeltaCodeInterpreterOutput
DeltaStepDetails
EmbeddingInput
EncodingFormat
FilePurpose
FileSearchRanker
FineTuningJobIntegrationType
FineTuningJobStatus
FinishReason
Image
ImageDetail
ImageModel
ImageQuality
ImageResponseFormat
ImageSize
ImageStyle
InputSource
LastErrorCode
LearningRateMultiplier
Level
MessageAttachmentTool
MessageContent
MessageContentInput
MessageContentTextAnnotations
MessageDeltaContent
MessageDeltaContentTextAnnotations
MessageIncompleteDetailsType
MessageRole
MessageStatus
ModerationInput
NEpochs
OpenAIFilePurpose
Prompt
ResponseFormat
Role
RunObjectIncompleteDetailsReason
RunStatus
RunStepDeltaStepDetailsToolCalls
RunStepDetailsToolCalls
RunStepType
ServiceTier
ServiceTierResponse
SpeechModel
SpeechResponseFormat
StepDetails
Stop
TextModerationModel
TimestampGranularity
TruncationObjectType
VectorStoreChunkingStrategy
VectorStoreFileBatchStatus
VectorStoreFileErrorCode
VectorStoreFileObjectChunkingStrategy
VectorStoreFileStatus
VectorStoreStatus
Voice

Type Aliases§

AssistantEventStream
ChatCompletionResponseStream
Parsed server side events stream until an [DONE] is received from server.
CompletionResponseStream
Parsed server side events stream until an [DONE] is received from server.