GetSwagger returns the Swagger specification corresponding to the generated code in this file.

Handler creates http.Handler with routing matching OpenAPI spec.

HandlerFromMux creates http.Handler with routing matching OpenAPI spec based on the provided mux.

HandlerWithOptions creates http.Handler with additional options.

Constructs a synthetic filesystem for resolving external references when loading openapi specifications.

Defines values for CreateSpeechRequestResponseFormat.

Defines values for CreateSpeechRequestVoice.

Defines values for MessageObjectRole.

Defines values for DeleteAssistantResponseObject.

Defines values for AssistantFileObjectObject.

Defines values for DeleteAssistantFileResponseObject.

Defines values for AssistantObjectObject.

Defines values for AssistantToolsCodeType.

Defines values for AssistantToolsFunctionType.

Defines values for AssistantToolsRetrievalType.

Defines values for FineTuningJobHyperparametersNEpochs0.

Defines values for CreateImageVariationRequestResponseFormat.

Defines values for CreateCompletionRequestModel1.

Defines values for CreateEmbeddingRequestEncodingFormat.

Defines values for CreateChatCompletionStreamResponseObject.

Defines values for ChatCompletionMessageToolCallChunkType.

Defines values for ChatCompletionMessageToolCallType.

Defines values for ChatCompletionNamedToolChoiceType.

Defines values for ChatCompletionRequestAssistantMessageRole.

Defines values for ChatCompletionRequestFunctionMessageRole.

Defines values for ChatCompletionRequestMessageContentPartImageImageUrlDetail.

Defines values for ChatCompletionRequestMessageContentPartImageImageUrlDetail.

Defines values for ChatCompletionRequestMessageContentPartImageImageUrlDetail.

Defines values for ChatCompletionRequestMessageContentPartTextType.

Defines values for ChatCompletionRequestSystemMessageRole.

Defines values for ChatCompletionRequestToolMessageRole.

Defines values for ChatCompletionRequestUserMessageRole.

Defines values for ChatCompletionResponseMessageRole.

Defines values for ChatCompletionRole.

Defines values for ChatCompletionRole.

Defines values for ChatCompletionRole.

Defines values for ChatCompletionRole.

Defines values for ChatCompletionRole.

Defines values for ChatCompletionStreamResponseDeltaRole.

Defines values for ChatCompletionStreamResponseDeltaRole.

Defines values for ChatCompletionStreamResponseDeltaRole.

Defines values for ChatCompletionStreamResponseDeltaRole.

Defines values for ChatCompletionToolChoiceOption0.

Defines values for ChatCompletionToolChoiceOption0.

Defines values for ChatCompletionToolType.

Defines values for RunStepDetailsToolCallsCodeObjectType.

Defines values for RunObjectRequiredActionType.

Defines values for MessageObjectIncompleteDetailsReason.

Defines values for CreateChatCompletionFunctionResponseChoicesFinishReason.

Defines values for CreateChatCompletionFunctionResponseChoicesFinishReason.

Defines values for CreateChatCompletionFunctionResponseChoicesFinishReason.

Defines values for CreateChatCompletionFunctionResponseChoicesFinishReason.

Defines values for CreateChatCompletionFunctionResponseObject.

Defines values for CreateChatCompletionRequestFunctionCall0.

Defines values for CreateChatCompletionRequestFunctionCall0.

Defines values for CreateChatCompletionRequestModel1.

Defines values for CreateChatCompletionRequestModel1.

Defines values for CreateChatCompletionRequestModel1.

Defines values for CreateChatCompletionRequestModel1.

Defines values for CreateChatCompletionRequestModel1.

Defines values for CreateChatCompletionRequestModel1.

Defines values for CreateChatCompletionRequestModel1.

Defines values for CreateChatCompletionRequestModel1.

Defines values for CreateChatCompletionRequestModel1.

Defines values for CreateChatCompletionRequestModel1.

Defines values for CreateChatCompletionRequestModel1.

Defines values for CreateChatCompletionRequestModel1.

Defines values for CreateChatCompletionRequestModel1.

Defines values for CreateChatCompletionRequestModel1.

Defines values for CreateChatCompletionRequestModel1.

Defines values for CreateChatCompletionRequestModel1.

Defines values for CreateChatCompletionRequestModel1.

Defines values for CreateChatCompletionRequestResponseFormatType.

Defines values for CreateChatCompletionRequestResponseFormatType.

Defines values for CreateChatCompletionResponseChoicesFinishReason.

Defines values for CreateChatCompletionResponseChoicesFinishReason.

Defines values for CreateChatCompletionResponseChoicesFinishReason.

Defines values for CreateChatCompletionResponseChoicesFinishReason.

Defines values for CreateChatCompletionResponseChoicesFinishReason.

Defines values for CreateChatCompletionResponseObject.

Defines values for CreateChatCompletionStreamResponseChoicesFinishReason.

Defines values for CreateChatCompletionStreamResponseChoicesFinishReason.

Defines values for CreateChatCompletionStreamResponseChoicesFinishReason.

Defines values for CreateChatCompletionStreamResponseChoicesFinishReason.

Defines values for CreateChatCompletionStreamResponseChoicesFinishReason.

Defines values for CreateCompletionResponseChoicesFinishReason.

Defines values for CreateCompletionResponseChoicesFinishReason.

Defines values for CreateCompletionResponseChoicesFinishReason.

Defines values for CreateEmbeddingResponseObject.

Defines values for CreateFileRequestPurpose.

Defines values for CreateFileRequestPurpose.

Defines values for CreateFineTuningJobRequestHyperparametersBatchSize0.

Defines values for CreateFineTuningJobRequestHyperparametersLearningRateMultiplier0.

Defines values for CreateFineTuningJobRequestHyperparametersNEpochs0.

Defines values for CreateFineTuningJobRequestModel1.

Defines values for CreateFineTuningJobRequestModel1.

Defines values for CreateFineTuningJobRequestModel1.

Defines values for CreateImageEditRequestModel1.

Defines values for CreateImageEditRequestResponseFormat.

Defines values for CreateImageEditRequestResponseFormat.

Defines values for CreateImageEditRequestSize.

Defines values for CreateImageEditRequestSize.

Defines values for CreateImageEditRequestSize.

Defines values for CreateImageRequestModel1.

Defines values for CreateImageRequestModel1.

Defines values for CreateImageRequestResponseFormat.

Defines values for CreateImageRequestResponseFormat.

Defines values for CreateImageRequestSize.

Defines values for CreateImageRequestSize.

Defines values for CreateImageRequestSize.

Defines values for CreateImageRequestSize.

Defines values for CreateImageRequestSize.

Defines values for CreateMessageRequestRole.

Defines values for CreateTranscriptionRequestModel1.

Defines values for CreateTranscriptionRequestResponseFormat.

Defines values for CreateTranscriptionRequestResponseFormat.

Defines values for CreateTranscriptionRequestResponseFormat.

Defines values for CreateTranscriptionRequestResponseFormat.

Defines values for CreateTranscriptionRequestResponseFormat.

Defines values for CreateTranslationRequestModel1.

Defines values for CreateImageVariationRequestModel1.

Defines values for CreateCompletionRequestModel1.

Defines values for DeleteFileResponseObject.

Defines values for DoneEventEvent.

Defines values for DoneEventData.

Defines values for CreateSpeechRequestVoice.

Defines values for EmbeddingObject.

Defines values for ErrorEventEvent.

Defines values for CreateSpeechRequestVoice.

Defines values for FineTuningJobEventLevel.

Defines values for FineTuningJobEventLevel.

Defines values for FineTuningJobEventLevel.

Defines values for FineTuningJobEventObject.

Defines values for FineTuningJobObject.

Defines values for FineTuningJobStatus.

Defines values for FineTuningJobStatus.

Defines values for FineTuningJobStatus.

Defines values for FineTuningJobStatus.

Defines values for FineTuningJobStatus.

Defines values for FineTuningJobStatus.

Defines values for CreateSpeechRequestResponseFormat.

Defines values for CreateEmbeddingRequestEncodingFormat.

Defines values for CreateCompletionRequestModel1.

Defines values for XAssistantToolsGPTScriptType.

Defines values for CreateImageRequestQuality.

Defines values for ChatCompletionRequestMessageContentPartImageType.

Defines values for ListPaginatedFineTuningJobsResponseObject.

Defines values for ListAssistantFilesParamsOrder.

Defines values for ListAssistantFilesParamsOrder.

Defines values for ListAssistantsParamsOrder.

Defines values for ListAssistantsParamsOrder.

Defines values for ListFilesResponseObject.

Defines values for ListFineTuningJobEventsResponseObject.

Defines values for ListMessageFilesParamsOrder.

Defines values for ListMessageFilesParamsOrder.

Defines values for ListMessagesParamsOrder.

Defines values for ListMessagesParamsOrder.

Defines values for ListModelsResponseObject.

Defines values for ListRunsParamsOrder.

Defines values for ListRunsParamsOrder.

Defines values for ListRunStepsParamsOrder.

Defines values for ListRunStepsParamsOrder.

Defines values for MessageObjectIncompleteDetailsReason.

Defines values for MessageContentImageFileObjectType.

Defines values for MessageContentTextAnnotationsFileCitationObjectType.

Defines values for MessageContentTextAnnotationsFilePathObjectType.

Defines values for MessageContentTextObjectType.

Defines values for RunStepObjectType.

Defines values for MessageDeltaContentImageFileObjectType.

Defines values for MessageDeltaContentTextAnnotationsFileCitationObjectType.

Defines values for MessageDeltaContentTextAnnotationsFilePathObjectType.

Defines values for MessageDeltaObjectDeltaRole.

Defines values for MessageDeltaObjectDeltaRole.

Defines values for MessageDeltaObjectObject.

Defines values for MessageObjectStatus.

Defines values for MessageObjectStatus.

Defines values for MessageObjectStatus.

Defines values for MessageStreamEvent2Event.

Defines values for ModelObject.

Defines values for CreateSpeechRequestResponseFormat.

Defines values for CreateImageVariationRequestSize.

Defines values for CreateImageVariationRequestSize.

Defines values for CreateImageVariationRequestSize.

Defines values for CreateImageRequestStyle.

Defines values for CreateSpeechRequestVoice.

Defines values for CreateSpeechRequestVoice.

Defines values for OpenAIFileObject.

Defines values for OpenAIFilePurpose.

Defines values for OpenAIFilePurpose.

Defines values for OpenAIFilePurpose.

Defines values for OpenAIFilePurpose.

Defines values for OpenAIFileStatus.

Defines values for OpenAIFileStatus.

Defines values for OpenAIFileStatus.

Defines values for CreateSpeechRequestResponseFormat.

Defines values for CreateSpeechRequestResponseFormat.

Defines values for RunStepDetailsToolCallsRetrievalObjectType.

Defines values for MessageObjectIncompleteDetailsReason.

Defines values for MessageObjectIncompleteDetailsReason.

Defines values for MessageObjectIncompleteDetailsReason.

Defines values for RunObjectLastErrorCode.

Defines values for RunObjectLastErrorCode.

Defines values for RunObjectLastErrorCode.

Defines values for RunObjectStatus.

Defines values for RunObjectStatus.

Defines values for RunObjectStatus.

Defines values for RunObjectStatus.

Defines values for RunObjectStatus.

Defines values for RunObjectStatus.

Defines values for RunObjectStatus.

Defines values for RunObjectStatus.

Defines values for RunObjectStatus.

Defines values for RunStepDeltaObjectObject.

Defines values for RunStepDeltaStepDetailsMessageCreationObjectType.

Defines values for RunStepDeltaStepDetailsToolCallsCodeObjectType.

Defines values for RunStepDeltaStepDetailsToolCallsCodeOutputImageObjectType.

Defines values for RunStepDeltaStepDetailsToolCallsCodeOutputLogsObjectType.

Defines values for RunStepDeltaStepDetailsToolCallsFunctionObjectType.

Defines values for RunStepDeltaStepDetailsToolCallsObjectType.

Defines values for RunStepDeltaStepDetailsToolCallsRetrievalObjectType.

Defines values for RunStepDetailsMessageCreationObjectType.

Defines values for RunStepDetailsToolCallsCodeOutputImageObjectType.

Defines values for RunStepDetailsToolCallsCodeOutputLogsObjectType.

Defines values for RunStepDetailsToolCallsFunctionObjectType.

Defines values for RunStepDetailsToolCallsObjectType.

Defines values for RunStepObjectLastErrorCode.

Defines values for RunStepObjectLastErrorCode.

Defines values for RunStepObjectStatus.

Defines values for RunStepObjectStatus.

Defines values for RunStepObjectStatus.

Defines values for RunStepObjectStatus.

Defines values for RunStepObjectStatus.

Defines values for RunStepStreamEvent2Event.

Defines values for RunToolCallObjectType.

Defines values for CreateTranscriptionRequestTimestampGranularities.

Defines values for CreateSpeechRequestVoice.

Defines values for CreateImageRequestQuality.

Defines values for RunObjectRequiredActionType.

Defines values for MessageDeltaContentTextObjectType.

Defines values for CreateCompletionResponseObject.

Defines values for CreateEmbeddingRequestModel1.

Defines values for CreateEmbeddingRequestModel1.

Defines values for CreateEmbeddingRequestModel1.

Defines values for CreateModerationRequestModel1.

Defines values for CreateModerationRequestModel1.

Defines values for ThreadObjectObject.

Defines values for ThreadStreamEvent0Event.

Defines values for DeleteThreadResponseObject.

Defines values for MessageObjectObject.

Defines values for MessageStreamEvent3Event.

Defines values for MessageStreamEvent0Event.

Defines values for DeleteMessageResponseObject.

Defines values for MessageFileObjectObject.

Defines values for MessageStreamEvent4Event.

Defines values for MessageStreamEvent1Event.

Defines values for RunObjectObject.

Defines values for RunStreamEvent7Event.

Defines values for RunStreamEvent6Event.

Defines values for RunStreamEvent4Event.

Defines values for RunStreamEvent0Event.

Defines values for RunStreamEvent8Event.

Defines values for RunStreamEvent5Event.

Defines values for RunStreamEvent2Event.

Defines values for RunStreamEvent1Event.

Defines values for RunStreamEvent3Event.

Defines values for RunStepObjectObject.

Defines values for RunStepStreamEvent5Event.

Defines values for RunStepStreamEvent3Event.

Defines values for RunStepStreamEvent0Event.

Defines values for RunStepStreamEvent6Event.

Defines values for RunStepStreamEvent4Event.

Defines values for RunStepStreamEvent1Event.

Defines values for RunStepObjectType.

Defines values for XDeleteToolResponseObject.

Defines values for CreateSpeechRequestModel1.

Defines values for CreateSpeechRequestModel1.

Defines values for CreateImageVariationRequestResponseFormat.

Defines values for MessageObjectRole.

Defines values for CreateImageRequestStyle.

Defines values for CreateSpeechRequestResponseFormat.

Defines values for CreateTranscriptionRequestTimestampGranularities.

Defines values for XListThreadsParamsOrder.

Defines values for XListThreadsParamsOrder.

Defines values for XListToolsParamsOrder.

Defines values for XListToolsParamsOrder.

Defines values for XToolObjectObject.

AssistantFileObject A list of [Files](/docs/api-reference/files) attached to an `assistant`.

AssistantObject Represents an `assistant` that can call the model and use tools.

AssistantObject_Tools_Item defines model for AssistantObject.tools.Item.

AssistantStreamEvent Represents an event emitted when streaming a Run.

AssistantToolsCode defines model for AssistantToolsCode.

AssistantToolsFunction defines model for AssistantToolsFunction.

AssistantToolsRetrieval defines model for AssistantToolsRetrieval.

ChatCompletionFunctionCallOption Specifying a particular function via `{"name": "my_function"}` forces the model to call that function.

ChatCompletionFunctions defines model for ChatCompletionFunctions.

ChatCompletionMessageToolCall defines model for ChatCompletionMessageToolCall.

ChatCompletionMessageToolCallChunk defines model for ChatCompletionMessageToolCallChunk.

ChatCompletionNamedToolChoice Specifies a tool the model should use.

ChatCompletionRequestAssistantMessage defines model for ChatCompletionRequestAssistantMessage.

ChatCompletionRequestFunctionMessage defines model for ChatCompletionRequestFunctionMessage.

ChatCompletionRequestMessage defines model for ChatCompletionRequestMessage.

ChatCompletionRequestMessageContentPart defines model for ChatCompletionRequestMessageContentPart.

ChatCompletionRequestMessageContentPartImage defines model for ChatCompletionRequestMessageContentPartImage.

ChatCompletionRequestMessageContentPartText defines model for ChatCompletionRequestMessageContentPartText.

ChatCompletionRequestSystemMessage defines model for ChatCompletionRequestSystemMessage.

ChatCompletionRequestToolMessage defines model for ChatCompletionRequestToolMessage.

ChatCompletionRequestUserMessage defines model for ChatCompletionRequestUserMessage.

ChatCompletionRequestUserMessage_Content The contents of the user message.

ChatCompletionResponseMessage A chat completion message generated by the model.

ChatCompletionStreamResponseDelta A chat completion delta generated by streamed model responses.

ChatCompletionTokenLogprob defines model for ChatCompletionTokenLogprob.

ChatCompletionTool defines model for ChatCompletionTool.

ChatCompletionToolChoiceOption Controls which (if any) function is called by the model.

CompletionUsage Usage statistics for the completion request.

CreateAssistantFileRequest defines model for CreateAssistantFileRequest.

CreateAssistantRequest defines model for CreateAssistantRequest.

CreateAssistantRequest_Model ID of the model to use.

CreateAssistantRequest_Tools_Item defines model for CreateAssistantRequest.tools.Item.

CreateChatCompletionFunctionResponse Represents a chat completion response returned by model, based on the provided input.

CreateChatCompletionRequest defines model for CreateChatCompletionRequest.

CreateChatCompletionRequest_FunctionCall Deprecated in favor of `tool_choice`.

CreateChatCompletionRequest_Model ID of the model to use.

CreateChatCompletionRequest_Stop Up to 4 sequences where the API will stop generating further tokens.

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 defines model for CreateCompletionRequest.

CreateCompletionRequest_Model ID of the model to use.

CreateCompletionRequest_Prompt The prompt(s) to generate completions for, encoded as a string, array of strings, array of tokens, or array of token arrays.

CreateCompletionRequest_Stop Up to 4 sequences where the API will stop generating further tokens.

CreateCompletionResponse Represents a completion response from the API.

CreateEmbeddingRequest defines model for CreateEmbeddingRequest.

CreateEmbeddingRequest_Input Input text to embed, encoded as a string or array of tokens.

CreateEmbeddingRequest_Model ID of the model to use.

CreateEmbeddingResponse defines model for CreateEmbeddingResponse.

CreateFileRequest defines model for CreateFileRequest.

CreateFineTuningJobRequest defines model for CreateFineTuningJobRequest.

CreateFineTuningJobRequest_Hyperparameters_BatchSize Number of examples in each batch.

CreateFineTuningJobRequest_Hyperparameters_LearningRateMultiplier Scaling factor for the learning rate.

CreateFineTuningJobRequest_Hyperparameters_NEpochs The number of epochs to train the model for.

CreateFineTuningJobRequest_Model The name of the model to fine-tune.

CreateImageEditRequest defines model for CreateImageEditRequest.

CreateImageEditRequest_Model The model to use for image generation.

CreateImageRequest defines model for CreateImageRequest.

CreateImageRequest_Model The model to use for image generation.

CreateImageVariationRequest defines model for CreateImageVariationRequest.

CreateImageVariationRequest_Model The model to use for image generation.

CreateMessageRequest defines model for CreateMessageRequest.

CreateModerationRequest defines model for CreateModerationRequest.

CreateModerationRequest_Input The input text to classify.

CreateModerationRequest_Model Two content moderations models are available: `text-moderation-stable` and `text-moderation-latest`.

CreateModerationResponse Represents if a given text input is potentially harmful.

CreateRunRequest defines model for CreateRunRequest.

CreateRunRequest_Tools_Item defines model for CreateRunRequest.tools.Item.

CreateSpeechRequest defines model for CreateSpeechRequest.

CreateSpeechRequest_Model One of the available [TTS models](/docs/models/tts): `tts-1` or `tts-1-hd`.

CreateThreadAndRunRequest defines model for CreateThreadAndRunRequest.

CreateThreadAndRunRequest_Tools_Item defines model for CreateThreadAndRunRequest.tools.Item.

CreateThreadRequest defines model for CreateThreadRequest.

CreateTranscriptionRequest defines model for CreateTranscriptionRequest.

CreateTranscriptionRequest_Model ID of the model to use.

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 defines model for CreateTranslationRequest.

CreateTranslationRequest_Model ID of the model to use.

CreateTranslationResponseJson defines model for CreateTranslationResponseJson.

CreateTranslationResponseVerboseJson defines model for CreateTranslationResponseVerboseJson.

DeleteAssistantFileResponse Deletes the association between the assistant and the file, but does not delete the [File](/docs/api-reference/files) object itself.

DeleteAssistantResponse defines model for DeleteAssistantResponse.

DeleteFileResponse defines model for DeleteFileResponse.

DeleteMessageResponse defines model for DeleteMessageResponse.

DeleteModelResponse defines model for DeleteModelResponse.

DeleteThreadResponse defines model for DeleteThreadResponse.

DoneEvent Occurs when a stream ends.

Embedding Represents an embedding vector returned by embedding endpoint.

Embedding_Embedding The embedding vector, which is a list of floats or a base64 encoded string, depending on the requested return type.

Error defines model for Error.

ErrorEvent Occurs when an [error](/docs/guides/error-codes/api-errors) occurs.

ErrorResponse defines model for ErrorResponse.

FineTuningJob The `fine_tuning.job` object represents a fine-tuning job that has been created through the API.

FineTuningJob_Hyperparameters_NEpochs The number of epochs to train the model for.

FineTuningJobEvent Fine-tuning job event object.

FunctionObject defines model for FunctionObject.

Image Represents the url or the content of an image generated by the OpenAI API.

ImagesResponse defines model for ImagesResponse.

ListAssistantFilesParams defines parameters for ListAssistantFiles.

ListAssistantFilesResponse defines model for ListAssistantFilesResponse.

ListAssistantsParams defines parameters for ListAssistants.

ListAssistantsResponse defines model for ListAssistantsResponse.

ListFilesParams defines parameters for ListFiles.

ListFilesResponse defines model for ListFilesResponse.

ListFineTuningEventsParams defines parameters for ListFineTuningEvents.

ListFineTuningJobEventsResponse defines model for ListFineTuningJobEventsResponse.

ListMessageFilesParams defines parameters for ListMessageFiles.

ListMessageFilesResponse defines model for ListMessageFilesResponse.

ListMessagesParams defines parameters for ListMessages.

ListMessagesResponse defines model for ListMessagesResponse.

ListModelsResponse defines model for ListModelsResponse.

ListPaginatedFineTuningJobsParams defines parameters for ListPaginatedFineTuningJobs.

ListPaginatedFineTuningJobsResponse defines model for ListPaginatedFineTuningJobsResponse.

ListRunsParams defines parameters for ListRuns.

ListRunsResponse defines model for ListRunsResponse.

ListRunStepsParams defines parameters for ListRunSteps.

ListRunStepsResponse defines model for ListRunStepsResponse.

ListThreadsResponse defines model for ListThreadsResponse.

MessageContentImageFileObject References an image [File](/docs/api-reference/files) in the content of a message.

MessageContentTextAnnotationsFileCitationObject A citation within the message that points to a specific quote from a specific File associated with the assistant or the message.

MessageContentTextAnnotationsFilePathObject A URL for the file that's generated when the assistant used the `code_interpreter` tool to generate a file.

MessageContentTextObject The text content that is part of a message.

MessageContentTextObject_Text_Annotations_Item defines model for MessageContentTextObject.Text.Annotations.Item.

MessageDeltaContentImageFileObject References an image [File](/docs/api-reference/files) in the content of a message.

MessageDeltaContentTextAnnotationsFileCitationObject A citation within the message that points to a specific quote from a specific File associated with the assistant or the message.

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.

MessageDeltaContentTextObject_Text_Annotations_Item defines model for MessageDeltaContentTextObject.Text.Annotations.Item.

MessageDeltaObject Represents a message delta i.e.

MessageDeltaObject_Delta_Content_Item defines model for MessageDeltaObject.Delta.Content.Item.

MessageFileObject A list of files attached to a `message`.

MessageObject Represents a message within a [thread](/docs/api-reference/threads).

MessageObject_Content_Item defines model for MessageObject.content.Item.

MessageStreamEvent defines model for MessageStreamEvent.

MessageStreamEvent0 Occurs when a [message](/docs/api-reference/messages/object) is created.

MessageStreamEvent1 Occurs when a [message](/docs/api-reference/messages/object) moves to an `in_progress` state.

MessageStreamEvent2 Occurs when parts of a [Message](/docs/api-reference/messages/object) are being streamed.

MessageStreamEvent3 Occurs when a [message](/docs/api-reference/messages/object) is completed.

MessageStreamEvent4 Occurs when a [message](/docs/api-reference/messages/object) ends before it is completed.

Model Describes an OpenAI model offering that can be used with the API.

ModifyAssistantRequest defines model for ModifyAssistantRequest.

ModifyAssistantRequest_Model ID of the model to use.

ModifyAssistantRequest_Tools_Item defines model for ModifyAssistantRequest.tools.Item.

ModifyMessageRequest defines model for ModifyMessageRequest.

ModifyRunRequest defines model for ModifyRunRequest.

ModifyThreadRequest defines model for ModifyThreadRequest.

OpenAIFile The `File` object represents a document that has been uploaded to OpenAI.

RunCompletionUsage Usage statistics related to the run.

RunObject Represents an execution run on a [thread](/docs/api-reference/threads).

RunObject_Tools_Item defines model for RunObject.tools.Item.

RunStepCompletionUsage Usage statistics related to the run step.

RunStepDeltaObject Represents a run step delta i.e.

RunStepDeltaObject_Delta_StepDetails The details of the run step.

RunStepDeltaStepDetailsMessageCreationObject Details of the message creation by the run step.

RunStepDeltaStepDetailsToolCallsCodeObject Details of the Code Interpreter tool call the run step was involved in.

RunStepDeltaStepDetailsToolCallsCodeObject_CodeInterpreter_Outputs_Item defines model for RunStepDeltaStepDetailsToolCallsCodeObject.CodeInterpreter.Outputs.Item.

RunStepDeltaStepDetailsToolCallsCodeOutputImageObject defines model for RunStepDeltaStepDetailsToolCallsCodeOutputImageObject.

RunStepDeltaStepDetailsToolCallsCodeOutputLogsObject Text output from the Code Interpreter tool call as part of a run step.

RunStepDeltaStepDetailsToolCallsFunctionObject defines model for RunStepDeltaStepDetailsToolCallsFunctionObject.

RunStepDeltaStepDetailsToolCallsObject Details of the tool call.

RunStepDeltaStepDetailsToolCallsObject_ToolCalls_Item defines model for RunStepDeltaStepDetailsToolCallsObject.tool_calls.Item.

RunStepDeltaStepDetailsToolCallsRetrievalObject defines model for RunStepDeltaStepDetailsToolCallsRetrievalObject.

RunStepDetailsMessageCreationObject Details of the message creation by the run step.

RunStepDetailsToolCallsCodeObject Details of the Code Interpreter tool call the run step was involved in.

RunStepDetailsToolCallsCodeObject_CodeInterpreter_Outputs_Item defines model for RunStepDetailsToolCallsCodeObject.CodeInterpreter.Outputs.Item.

RunStepDetailsToolCallsCodeOutputImageObject defines model for RunStepDetailsToolCallsCodeOutputImageObject.

RunStepDetailsToolCallsCodeOutputLogsObject Text output from the Code Interpreter tool call as part of a run step.

RunStepDetailsToolCallsFunctionObject defines model for RunStepDetailsToolCallsFunctionObject.

RunStepDetailsToolCallsObject Details of the tool call.

RunStepDetailsToolCallsObject_ToolCalls_Item defines model for RunStepDetailsToolCallsObject.tool_calls.Item.

RunStepDetailsToolCallsRetrievalObject defines model for RunStepDetailsToolCallsRetrievalObject.

RunStepObject Represents a step in execution of a run.

RunStepObject_StepDetails The details of the run step.

RunStepStreamEvent defines model for RunStepStreamEvent.

RunStepStreamEvent0 Occurs when a [run step](/docs/api-reference/runs/step-object) is created.

RunStepStreamEvent1 Occurs when a [run step](/docs/api-reference/runs/step-object) moves to an `in_progress` state.

RunStepStreamEvent2 Occurs when parts of a [run step](/docs/api-reference/runs/step-object) are being streamed.

RunStepStreamEvent3 Occurs when a [run step](/docs/api-reference/runs/step-object) is completed.

RunStepStreamEvent4 Occurs when a [run step](/docs/api-reference/runs/step-object) fails.

RunStepStreamEvent5 Occurs when a [run step](/docs/api-reference/runs/step-object) is cancelled.

RunStepStreamEvent6 Occurs when a [run step](/docs/api-reference/runs/step-object) expires.

RunStreamEvent defines model for RunStreamEvent.

RunStreamEvent0 Occurs when a new [run](/docs/api-reference/runs/object) is created.

RunStreamEvent1 Occurs when a [run](/docs/api-reference/runs/object) moves to a `queued` status.

RunStreamEvent2 Occurs when a [run](/docs/api-reference/runs/object) moves to an `in_progress` status.

RunStreamEvent3 Occurs when a [run](/docs/api-reference/runs/object) moves to a `requires_action` status.

RunStreamEvent4 Occurs when a [run](/docs/api-reference/runs/object) is completed.

RunStreamEvent5 Occurs when a [run](/docs/api-reference/runs/object) fails.

RunStreamEvent6 Occurs when a [run](/docs/api-reference/runs/object) moves to a `cancelling` status.

RunStreamEvent7 Occurs when a [run](/docs/api-reference/runs/object) is cancelled.

RunStreamEvent8 Occurs when a [run](/docs/api-reference/runs/object) expires.

RunToolCallObject Tool call objects.

ServerInterfaceWrapper converts contexts to parameters.

SubmitToolOutputsRunRequest defines model for SubmitToolOutputsRunRequest.

ThreadObject Represents a thread that contains [messages](/docs/api-reference/messages).

ThreadStreamEvent defines model for ThreadStreamEvent.

ThreadStreamEvent0 Occurs when a new [thread](/docs/api-reference/threads/object) is created.

TranscriptionSegment defines model for TranscriptionSegment.

TranscriptionWord defines model for TranscriptionWord.

XAssistantToolsGPTScript defines model for XAssistantToolsGPTScript.

XConfirmRunToolRequest defines model for XConfirmRunToolRequest.

XConfirmToolRunRequest defines model for XConfirmToolRunRequest.

XCreateToolRequest defines model for XCreateToolRequest.

XDeleteToolResponse defines model for XDeleteToolResponse.

XInspectToolRequest defines model for XInspectToolRequest.

XInspectToolResponse defines model for XInspectToolResponse.

XListRunStepEventsParams defines parameters for XListRunStepEvents.

XListRunStepEventsResponse defines model for XListRunStepEventsResponse.

XListThreadsParams defines parameters for XListThreads.

XListThreadsResponse defines model for XListThreadsResponse.

XListToolsParams defines parameters for XListTools.

XListToolsResponse defines model for XListToolsResponse.

XModifyToolRequest defines model for XModifyToolRequest.

XRunStepEventObject defines model for XRunStepEventObject.

XRunToolRequest defines model for XRunToolRequest.

XStreamRunParams defines parameters for XStreamRun.

XToolObject defines model for XToolObject.

XToolSetTool defines model for XToolSetTool.

ServerInterface represents all server handlers.

AssistantFileObjectObject The object type, which is always `assistant.file`.

AssistantObjectObject The object type, which is always `assistant`.

AssistantToolsCodeType The type of tool being defined: `code_interpreter`.

AssistantToolsFunctionType The type of tool being defined: `function`.

AssistantToolsRetrievalType The type of tool being defined: `retrieval`.

ChatCompletionMessageToolCallChunkType The type of the tool.

ChatCompletionMessageToolCalls The tool calls generated by the model, such as function calls.

ChatCompletionMessageToolCallType The type of the tool.

ChatCompletionNamedToolChoiceType The type of the tool.

ChatCompletionRequestAssistantMessageRole The role of the messages author, in this case `assistant`.

ChatCompletionRequestFunctionMessageRole The role of the messages author, in this case `function`.

ChatCompletionRequestMessageContentPartImageImageUrlDetail Specifies the detail level of the image.

ChatCompletionRequestMessageContentPartImageType The type of the content part.

ChatCompletionRequestMessageContentPartTextType The type of the content part.

ChatCompletionRequestSystemMessageRole The role of the messages author, in this case `system`.

ChatCompletionRequestToolMessageRole The role of the messages author, in this case `tool`.

ChatCompletionRequestUserMessageContent0 The text contents of the message.

ChatCompletionRequestUserMessageContent1 An array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images.

ChatCompletionRequestUserMessageRole The role of the messages author, in this case `user`.

ChatCompletionResponseMessageRole The role of the author of this message.

ChatCompletionRole The role of the author of a message.

ChatCompletionStreamResponseDeltaRole The role of the author of this message.

ChatCompletionToolChoiceOption0 `none` means the model will not call a function and instead generates a message.

ChatCompletionToolType The type of the tool.

CreateAssistantFileJSONRequestBody defines body for CreateAssistantFile for application/json ContentType.

CreateAssistantJSONRequestBody defines body for CreateAssistant for application/json ContentType.

CreateAssistantRequestModel0 defines model for .

CreateChatCompletionFunctionResponseChoicesFinishReason The reason the model stopped generating tokens.

CreateChatCompletionFunctionResponseObject The object type, which is always `chat.completion`.

CreateChatCompletionImageResponse Represents a streamed chunk of a chat completion response returned by model, based on the provided input.

CreateChatCompletionJSONRequestBody defines body for CreateChatCompletion for application/json ContentType.

CreateChatCompletionRequestFunctionCall0 `none` means the model will not call a function and instead generates a message.

CreateChatCompletionRequestModel0 defines model for .

CreateChatCompletionRequestModel1 defines model for CreateChatCompletionRequest.Model.1.

CreateChatCompletionRequestResponseFormatType Must be one of `text` or `json_object`.

CreateChatCompletionRequestStop0 defines model for .

CreateChatCompletionRequestStop1 defines model for .

CreateChatCompletionResponseChoicesFinishReason The reason the model stopped generating tokens.

CreateChatCompletionResponseObject The object type, which is always `chat.completion`.

CreateChatCompletionStreamResponseChoicesFinishReason The reason the model stopped generating tokens.

CreateChatCompletionStreamResponseObject The object type, which is always `chat.completion.chunk`.

CreateCompletionJSONRequestBody defines body for CreateCompletion for application/json ContentType.

CreateCompletionRequestModel0 defines model for .

CreateCompletionRequestModel1 defines model for CreateCompletionRequest.Model.1.

CreateCompletionRequestPrompt0 defines model for .

CreateCompletionRequestPrompt1 defines model for .

CreateCompletionRequestPrompt2 defines model for .

CreateCompletionRequestPrompt3 defines model for .

CreateCompletionRequestStop0 defines model for .

CreateCompletionRequestStop1 defines model for .

CreateCompletionResponseChoicesFinishReason The reason the model stopped generating tokens.

CreateCompletionResponseObject The object type, which is always "text_completion".

CreateEmbeddingJSONRequestBody defines body for CreateEmbedding for application/json ContentType.

CreateEmbeddingRequestEncodingFormat The format to return the embeddings in.

CreateEmbeddingRequestInput0 The string that will be turned into an embedding.

CreateEmbeddingRequestInput1 The array of strings that will be turned into an embedding.

CreateEmbeddingRequestInput2 The array of integers that will be turned into an embedding.

CreateEmbeddingRequestInput3 The array of arrays containing integers that will be turned into an embedding.

CreateEmbeddingRequestModel0 defines model for .

CreateEmbeddingRequestModel1 defines model for CreateEmbeddingRequest.Model.1.

CreateEmbeddingResponseObject The object type, which is always "list".

CreateFileMultipartRequestBody defines body for CreateFile for multipart/form-data ContentType.

CreateFileRequestPurpose The intended purpose of the uploaded file.

CreateFineTuningJobJSONRequestBody defines body for CreateFineTuningJob for application/json ContentType.

CreateFineTuningJobRequestHyperparametersBatchSize0 defines model for CreateFineTuningJobRequest.Hyperparameters.BatchSize.0.

CreateFineTuningJobRequestHyperparametersBatchSize1 defines model for .

CreateFineTuningJobRequestHyperparametersLearningRateMultiplier0 defines model for CreateFineTuningJobRequest.Hyperparameters.LearningRateMultiplier.0.

CreateFineTuningJobRequestHyperparametersLearningRateMultiplier1 defines model for .

CreateFineTuningJobRequestHyperparametersNEpochs0 defines model for CreateFineTuningJobRequest.Hyperparameters.NEpochs.0.

CreateFineTuningJobRequestHyperparametersNEpochs1 defines model for .

CreateFineTuningJobRequestModel0 defines model for .

CreateFineTuningJobRequestModel1 defines model for CreateFineTuningJobRequest.Model.1.

CreateImageEditMultipartRequestBody defines body for CreateImageEdit for multipart/form-data ContentType.

CreateImageEditRequestModel0 defines model for .

CreateImageEditRequestModel1 defines model for CreateImageEditRequest.Model.1.

CreateImageEditRequestResponseFormat The format in which the generated images are returned.

CreateImageEditRequestSize The size of the generated images.

CreateImageJSONRequestBody defines body for CreateImage for application/json ContentType.

CreateImageRequestModel0 defines model for .

CreateImageRequestModel1 defines model for CreateImageRequest.Model.1.

CreateImageRequestQuality The quality of the image that will be generated.

CreateImageRequestResponseFormat The format in which the generated images are returned.

CreateImageRequestSize The size of the generated images.

CreateImageRequestStyle The style of the generated images.

CreateImageVariationMultipartRequestBody defines body for CreateImageVariation for multipart/form-data ContentType.

CreateImageVariationRequestModel0 defines model for .

CreateImageVariationRequestModel1 defines model for CreateImageVariationRequest.Model.1.

CreateImageVariationRequestResponseFormat The format in which the generated images are returned.

CreateImageVariationRequestSize The size of the generated images.

CreateMessageJSONRequestBody defines body for CreateMessage for application/json ContentType.

CreateMessageRequestRole The role of the entity that is creating the message.

CreateModerationJSONRequestBody defines body for CreateModeration for application/json ContentType.

CreateModerationRequestInput0 defines model for .

CreateModerationRequestInput1 defines model for .

CreateModerationRequestModel0 defines model for .

CreateModerationRequestModel1 defines model for CreateModerationRequest.Model.1.

CreateRunJSONRequestBody defines body for CreateRun for application/json ContentType.

CreateSpeechJSONRequestBody defines body for CreateSpeech for application/json ContentType.

CreateSpeechRequestModel0 defines model for .

CreateSpeechRequestModel1 defines model for CreateSpeechRequest.Model.1.

CreateSpeechRequestResponseFormat The format to audio in.

CreateSpeechRequestVoice The voice to use when generating the audio.

CreateThreadAndRunJSONRequestBody defines body for CreateThreadAndRun for application/json ContentType.

CreateThreadJSONRequestBody defines body for CreateThread for application/json ContentType.

CreateTranscriptionMultipartRequestBody defines body for CreateTranscription for multipart/form-data ContentType.

CreateTranscriptionRequestModel0 defines model for .

CreateTranscriptionRequestModel1 defines model for CreateTranscriptionRequest.Model.1.

CreateTranscriptionRequestResponseFormat The format of the transcript output, in one of these options: `json`, `text`, `srt`, `verbose_json`, or `vtt`.

CreateTranscriptionRequestTimestampGranularities defines model for CreateTranscriptionRequest.TimestampGranularities.

CreateTranslationMultipartRequestBody defines body for CreateTranslation for multipart/form-data ContentType.

CreateTranslationRequestModel0 defines model for .

CreateTranslationRequestModel1 defines model for CreateTranslationRequest.Model.1.

DeleteAssistantFileResponseObject defines model for DeleteAssistantFileResponse.Object.

DeleteAssistantResponseObject defines model for DeleteAssistantResponse.Object.

DeleteFileResponseObject defines model for DeleteFileResponse.Object.

DeleteMessageResponseObject defines model for DeleteMessageResponse.Object.

DeleteThreadResponseObject defines model for DeleteThreadResponse.Object.

DoneEventData defines model for DoneEvent.Data.

DoneEventEvent defines model for DoneEvent.Event.

EmbeddingEmbedding0 defines model for .

EmbeddingEmbedding1 defines model for .

EmbeddingObject The object type, which is always "embedding".

ErrorEventEvent defines model for ErrorEvent.Event.

FineTuningJobEventLevel defines model for FineTuningJobEvent.Level.

FineTuningJobEventObject defines model for FineTuningJobEvent.Object.

FineTuningJobHyperparametersNEpochs0 defines model for FineTuningJob.Hyperparameters.NEpochs.0.

FineTuningJobHyperparametersNEpochs1 defines model for .

FineTuningJobObject The object type, which is always "fine_tuning.job".

FineTuningJobStatus The current status of the fine-tuning job, which can be either `validating_files`, `queued`, `running`, `succeeded`, `failed`, or `cancelled`.

FunctionParameters The parameters the functions accepts, described as a JSON Schema object.

ListAssistantFilesParamsOrder defines parameters for ListAssistantFiles.

ListAssistantsParamsOrder defines parameters for ListAssistants.

ListFilesResponseObject defines model for ListFilesResponse.Object.

ListFineTuningJobEventsResponseObject defines model for ListFineTuningJobEventsResponse.Object.

ListMessageFilesParamsOrder defines parameters for ListMessageFiles.

ListMessagesParamsOrder defines parameters for ListMessages.

ListModelsResponseObject defines model for ListModelsResponse.Object.

ListPaginatedFineTuningJobsResponseObject defines model for ListPaginatedFineTuningJobsResponse.Object.

ListRunsParamsOrder defines parameters for ListRuns.

ListRunStepsParamsOrder defines parameters for ListRunSteps.

MessageContentImageFileObjectType Always `image_file`.

MessageContentTextAnnotationsFileCitationObjectType Always `file_citation`.

MessageContentTextAnnotationsFilePathObjectType Always `file_path`.

MessageContentTextObjectType Always `text`.

MessageDeltaContentImageFileObjectType Always `image_file`.

MessageDeltaContentTextAnnotationsFileCitationObjectType Always `file_citation`.

MessageDeltaContentTextAnnotationsFilePathObjectType Always `file_path`.

MessageDeltaContentTextObjectType Always `text`.

MessageDeltaObjectDeltaRole The entity that produced the message.

MessageDeltaObjectObject The object type, which is always `thread.message.delta`.

MessageFileObjectObject The object type, which is always `thread.message.file`.

MessageObjectIncompleteDetailsReason The reason the message is incomplete.

MessageObjectObject The object type, which is always `thread.message`.

MessageObjectRole The entity that produced the message.

MessageObjectStatus The status of the message, which can be either `in_progress`, `incomplete`, or `completed`.

MessageStreamEvent0Event defines model for MessageStreamEvent.0.Event.

MessageStreamEvent1Event defines model for MessageStreamEvent.1.Event.

MessageStreamEvent2Event defines model for MessageStreamEvent.2.Event.

MessageStreamEvent3Event defines model for MessageStreamEvent.3.Event.

MessageStreamEvent4Event defines model for MessageStreamEvent.4.Event.

ModelObject The object type, which is always "model".

ModifyAssistantJSONRequestBody defines body for ModifyAssistant for application/json ContentType.

ModifyAssistantRequestModel0 defines model for .

ModifyMessageJSONRequestBody defines body for ModifyMessage for application/json ContentType.

ModifyRunJSONRequestBody defines body for ModifyRun for application/json ContentType.

ModifyThreadJSONRequestBody defines body for ModifyThread for application/json ContentType.

OpenAIFileObject The object type, which is always `file`.

OpenAIFilePurpose The intended purpose of the file.

OpenAIFileStatus Deprecated.

RunObjectLastErrorCode One of `server_error`, `rate_limit_exceeded`, or `invalid_prompt`.

RunObjectObject The object type, which is always `thread.run`.

RunObjectRequiredActionType For now, this is either `submit_tool_outputs` or `confirm`.

RunObjectStatus The status of the run, which can be either `queued`, `in_progress`, `requires_action`, `requires_confirmation`, `cancelling`, `cancelled`, `failed`, `completed`, or `expired`.

RunStepDeltaObjectObject The object type, which is always `thread.run.step.delta`.

RunStepDeltaStepDetailsMessageCreationObjectType Always `message_creation`.

RunStepDeltaStepDetailsToolCallsCodeObjectType The type of tool call.

RunStepDeltaStepDetailsToolCallsCodeOutputImageObjectType Always `image`.

RunStepDeltaStepDetailsToolCallsCodeOutputLogsObjectType Always `logs`.

RunStepDeltaStepDetailsToolCallsFunctionObjectType The type of tool call.

RunStepDeltaStepDetailsToolCallsObjectType Always `tool_calls`.

RunStepDeltaStepDetailsToolCallsRetrievalObjectType The type of tool call.

RunStepDetailsMessageCreationObjectType Always `message_creation`.

RunStepDetailsToolCallsCodeObjectType The type of tool call.

RunStepDetailsToolCallsCodeOutputImageObjectType Always `image`.

RunStepDetailsToolCallsCodeOutputLogsObjectType Always `logs`.

RunStepDetailsToolCallsFunctionObjectType The type of tool call.

RunStepDetailsToolCallsObjectType Always `tool_calls`.

RunStepDetailsToolCallsRetrievalObjectType The type of tool call.

RunStepObjectLastErrorCode One of `server_error` or `rate_limit_exceeded`.

RunStepObjectObject The object type, which is always `thread.run.step`.

RunStepObjectStatus The status of the run step, which can be either `in_progress`, `cancelled`, `failed`, `completed`, or `expired`.

RunStepObjectType The type of run step, which can be either `message_creation` or `tool_calls`.

RunStepStreamEvent0Event defines model for RunStepStreamEvent.0.Event.

RunStepStreamEvent1Event defines model for RunStepStreamEvent.1.Event.

RunStepStreamEvent2Event defines model for RunStepStreamEvent.2.Event.

RunStepStreamEvent3Event defines model for RunStepStreamEvent.3.Event.

RunStepStreamEvent4Event defines model for RunStepStreamEvent.4.Event.

RunStepStreamEvent5Event defines model for RunStepStreamEvent.5.Event.

RunStepStreamEvent6Event defines model for RunStepStreamEvent.6.Event.

RunStreamEvent0Event defines model for RunStreamEvent.0.Event.

RunStreamEvent1Event defines model for RunStreamEvent.1.Event.

RunStreamEvent2Event defines model for RunStreamEvent.2.Event.

RunStreamEvent3Event defines model for RunStreamEvent.3.Event.

RunStreamEvent4Event defines model for RunStreamEvent.4.Event.

RunStreamEvent5Event defines model for RunStreamEvent.5.Event.

RunStreamEvent6Event defines model for RunStreamEvent.6.Event.

RunStreamEvent7Event defines model for RunStreamEvent.7.Event.

RunStreamEvent8Event defines model for RunStreamEvent.8.Event.

RunToolCallObjectType The type of tool call the output is required for.

SubmitToolOuputsToRunJSONRequestBody defines body for SubmitToolOuputsToRun for application/json ContentType.

ThreadObjectObject The object type, which is always `thread`.

ThreadStreamEvent0Event defines model for ThreadStreamEvent.0.Event.

XAssistantToolsGPTScriptType The type of tool being defined: `gptscript`.

XConfirmRunJSONRequestBody defines body for XConfirmRun for application/json ContentType.

XConfirmToolRunJSONRequestBody defines body for XConfirmToolRun for application/json ContentType.

XCreateToolJSONRequestBody defines body for XCreateTool for application/json ContentType.

XDeleteToolResponseObject defines model for XDeleteToolResponse.Object.

XInspectToolJSONRequestBody defines body for XInspectTool for application/json ContentType.

XListThreadsParamsOrder defines parameters for XListThreads.

XListToolsParamsOrder defines parameters for XListTools.

XModifyToolJSONRequestBody defines body for XModifyTool for application/json ContentType.

XRunToolJSONRequestBody defines body for XRunTool for application/json ContentType.

XToolObjectObject The object type, which is always `tool`.