Package com.openai.models
See: Description
-
-
Class Summary Class Description Deserializer Serializer Annotation A citation within the message that points to a specific quote from a specific File associated with the assistant or the message. Deserializer Serializer AnnotationDelta A citation within the message that points to a specific quote from a specific File associated with the assistant or the message. Builder Object Builder Builder CodeInterpreter Builder FileSearch ToolResources A set of resources that are used by the assistant's tools. Assistant Represents an assistant
that can call the model and use tools.Builder Object AssistantDeleted Deserializer Serializer Behavior AssistantResponseFormatOption Specifies the format that the model must output. Deserializer Serializer Builder Event ThreadCreated Occurs when a new thread is created. Builder Event ThreadRunCreated Occurs when a new run is created. Builder Event ThreadRunQueued Occurs when a run moves to a queued
status.Builder Event ThreadRunInProgress Occurs when a run moves to an in_progress
status.Builder Event ThreadRunRequiresAction Occurs when a run moves to a requires_action
status.Builder Event ThreadRunCompleted Occurs when a run is completed. Builder Event ThreadRunIncomplete Occurs when a run ends with status incomplete
.Builder Event ThreadRunFailed Occurs when a run fails. Builder Event ThreadRunCancelling Occurs when a run moves to a cancelling
status.Builder Event ThreadRunCancelled Occurs when a run is cancelled. Builder Event ThreadRunExpired Occurs when a run expires. Builder Event ThreadRunStepCreated Occurs when a run step is created. Builder Event ThreadRunStepInProgress Occurs when a run step moves to an in_progress
state.Builder Event ThreadRunStepDelta Occurs when parts of a run step are being streamed. Builder Event ThreadRunStepCompleted Occurs when a run step is completed. Builder Event ThreadRunStepFailed Occurs when a run step fails. Builder Event ThreadRunStepCancelled Occurs when a run step is cancelled. Builder Event ThreadRunStepExpired Occurs when a run step expires. Builder Event ThreadMessageCreated Occurs when a message is created. Builder Event ThreadMessageInProgress Occurs when a message moves to an in_progress
state.Builder Event ThreadMessageDelta Occurs when parts of a Message are being streamed. Builder Event ThreadMessageCompleted Occurs when a message is completed. Builder Event ThreadMessageIncomplete Occurs when a message ends before it is completed. Builder Event ErrorEvent Occurs when an error occurs. AssistantStreamEvent Represents an event emitted when streaming a Run. Deserializer Serializer AssistantTool Builder Type AssistantToolChoice Specifies a tool the model should use. Builder AssistantToolChoiceFunction Deserializer Serializer Behavior AssistantToolChoiceOption Controls which (if any) tool is called by the model. Builder Type AutoFileChunkingStrategyParam The default strategy. Builder Object Status Builder Errors Batch Builder BatchCancelParams Cancels an in-progress batch. Builder BatchCreateBody Builder CompletionWindow Endpoint Builder Metadata Optional custom metadata for the batch. BatchCreateParams Creates and executes a batch from an uploaded file of requests Builder BatchError Builder Response AutoPager BatchListPage Builder Response AutoPager BatchListPageAsync Builder BatchListParams List your organization's batches. Builder BatchRequestCounts The request counts for different statuses within the batch. Builder BatchRetrieveParams Retrieves a batch. Builder BetaAssistantCreateBody Builder Builder Builder CodeInterpreter Builder Builder VectorStore FileSearch ToolResources A set of resources that are used by the assistant's tools. BetaAssistantCreateParams Create an assistant with a model and instructions. Builder BetaAssistantDeleteParams Delete an assistant. Builder Response AutoPager BetaAssistantListPage Builder Response AutoPager BetaAssistantListPageAsync Builder Order BetaAssistantListParams Returns a list of assistants. Builder BetaAssistantRetrieveParams Retrieves an assistant. Builder BetaAssistantUpdateBody Builder Builder Builder CodeInterpreter Builder FileSearch ToolResources A set of resources that are used by the assistant's tools. BetaAssistantUpdateParams Modifies an assistant. Builder BetaThreadCreateAndRunBody Builder Builder Builder Deserializer Serializer Content The text contents of the message. Role Builder Deserializer Serializer Builder Type FileSearch Tool Attachment Message Builder Builder CodeInterpreter Builder Builder VectorStore FileSearch ToolResources A set of resources that are made available to the assistant's tools in this thread. Thread If no thread is provided, an empty thread will be created. Builder Builder CodeInterpreter Builder FileSearch ToolResources A set of resources that are used by the assistant's tools. Deserializer Serializer Tool Builder Type TruncationStrategy Controls for how a thread will be truncated prior to the run. BetaThreadCreateAndRunParams Create a thread and run it in one request. Builder BetaThreadCreateBody Builder Builder Deserializer Serializer Content The text contents of the message. Role Builder Deserializer Serializer Builder Type FileSearch Tool Attachment Message Builder Builder CodeInterpreter Builder Builder VectorStore FileSearch ToolResources A set of resources that are made available to the assistant's tools in this thread. BetaThreadCreateParams Create a thread. Builder BetaThreadDeleteParams Delete a thread. Builder BetaThreadMessageCreateBody Builder Deserializer Serializer Content The text contents of the message. Role Builder Deserializer Serializer Builder Type FileSearch Tool Attachment BetaThreadMessageCreateParams Create a message. Builder BetaThreadMessageDeleteParams Deletes a message. Builder Response AutoPager BetaThreadMessageListPage Builder Response AutoPager BetaThreadMessageListPageAsync Builder Order BetaThreadMessageListParams Returns a list of messages for a given thread. Builder BetaThreadMessageRetrieveParams Retrieve a message. Builder BetaThreadMessageUpdateBody Builder BetaThreadMessageUpdateParams Modifies a message. Builder BetaThreadRetrieveParams Retrieves a thread. Builder BetaThreadRunCancelParams Cancels a run that is in_progress
.Builder BetaThreadRunCreateBody Builder Builder Deserializer Serializer Content The text contents of the message. Role Builder Deserializer Serializer Builder Type FileSearch Tool Attachment AdditionalMessage Builder Type TruncationStrategy Controls for how a thread will be truncated prior to the run. BetaThreadRunCreateParams Create a run. Builder Response AutoPager BetaThreadRunListPage Builder Response AutoPager BetaThreadRunListPageAsync Builder Order BetaThreadRunListParams Returns a list of runs belonging to a thread. Builder BetaThreadRunRetrieveParams Retrieves a run. Builder Response AutoPager BetaThreadRunStepListPage Builder Response AutoPager BetaThreadRunStepListPageAsync Builder Order BetaThreadRunStepListParams Returns a list of run steps belonging to a run. Builder BetaThreadRunStepRetrieveParams Retrieves a run step. Builder BetaThreadRunSubmitToolOutputsBody Builder Builder ToolOutput BetaThreadRunSubmitToolOutputsParams When a run has the status: "requires_action"
andrequired_action.type
issubmit_tool_outputs
, this endpoint can be used to submit the outputs from the tool calls once they're all completed.Builder BetaThreadRunUpdateBody Builder BetaThreadRunUpdateParams Modifies a run. Builder BetaThreadUpdateBody Builder Builder Builder CodeInterpreter Builder FileSearch ToolResources A set of resources that are made available to the assistant's tools in this thread. BetaThreadUpdateParams Modifies a thread. Builder BetaVectorStoreCreateBody Builder Builder Anchor ExpiresAfter The expiration policy for a vector store. BetaVectorStoreCreateParams Create a vector store. Builder BetaVectorStoreDeleteParams Delete a vector store. Builder BetaVectorStoreFileBatchCancelParams Cancel a vector store file batch. Builder BetaVectorStoreFileBatchCreateBody Builder BetaVectorStoreFileBatchCreateParams Create a vector store file batch. Builder Response AutoPager BetaVectorStoreFileBatchListFilesPage Builder Response AutoPager BetaVectorStoreFileBatchListFilesPageAsync Builder Filter Order BetaVectorStoreFileBatchListFilesParams Returns a list of vector store files in a batch. Builder BetaVectorStoreFileBatchRetrieveParams Retrieves a vector store file batch. Builder BetaVectorStoreFileCreateBody Builder BetaVectorStoreFileCreateParams Create a vector store file by attaching a File to a vector store. Builder BetaVectorStoreFileDeleteParams Delete a vector store file. Builder Response AutoPager BetaVectorStoreFileListPage Builder Response AutoPager BetaVectorStoreFileListPageAsync Builder Filter Order BetaVectorStoreFileListParams Returns a list of vector store files. Builder BetaVectorStoreFileRetrieveParams Retrieves a vector store file. Builder Response AutoPager BetaVectorStoreListPage Builder Response AutoPager BetaVectorStoreListPageAsync Builder Order BetaVectorStoreListParams Returns a list of vector stores. Builder BetaVectorStoreRetrieveParams Retrieves a vector store. Builder BetaVectorStoreUpdateBody Builder Builder Anchor ExpiresAfter The expiration policy for a vector store. BetaVectorStoreUpdateParams Modifies a vector store. Builder Builder FinishReason Builder Logprobs Log probability information for the choice. Choice Object ServiceTier ChatCompletion Represents a chat completion response returned by model, based on the provided input. Builder Role Builder Audio Data about a previous audio response from the model. Deserializer Serializer Deserializer Serializer ChatCompletionRequestAssistantMessageContentPart Learn about text inputs. Content The contents of the assistant message. Builder FunctionCall Deprecated and replaced by tool_calls
.ChatCompletionAssistantMessageParam Messages sent by the model in response to user messages. Builder ChatCompletionAudio If the audio output modality is requested, this object contains data about the audio response from the model. Builder Format Voice ChatCompletionAudioParam Parameters for audio output. Builder Builder Builder Builder FunctionCall Deprecated and replaced by tool_calls
.Role Builder Builder Function Type ToolCall Delta A chat completion delta generated by streamed model responses. FinishReason Builder Logprobs Log probability information for the choice. Choice Object ServiceTier ChatCompletionChunk Represents a streamed chunk of a chat completion response returned by model, based on the provided input. Deserializer Serializer ChatCompletionContentPart Learn about text inputs. Builder Builder Detail ImageUrl Type ChatCompletionContentPartImage Learn about image inputs. Builder Builder Format InputAudio Type ChatCompletionContentPartInputAudio Learn about audio inputs. Builder Type ChatCompletionContentPartRefusal Builder Type ChatCompletionContentPartText Learn about text inputs. Builder ChatCompletionCreateBody Builder Deserializer Serializer Behavior FunctionCall Deprecated in favor of tool_choice
.Builder Function Builder LogitBias Modify the likelihood of specified tokens appearing in the completion. Builder Metadata Developer-defined tags and values used for filtering completions in the dashboard. Deserializer Serializer ResponseFormat An object specifying the format that the model must output. ServiceTier Deserializer Serializer Stop Up to 4 sequences where the API will stop generating further tokens. ChatCompletionCreateParams Creates a model response for the given chat conversation. Builder Deserializer Serializer Content The contents of the developer message. Role ChatCompletionDeveloperMessageParam Developer-provided instructions that the model should follow, regardless of messages sent by the user. Builder ChatCompletionFunctionCallOption Specifying a particular function via {"name": "my_function"}
forces the model to call that function.Builder Role ChatCompletionFunctionMessageParam Builder Role Builder FunctionCall Deprecated and replaced by tool_calls
.ChatCompletionMessage A chat completion message generated by the model. Deserializer Serializer ChatCompletionMessageParam Developer-provided instructions that the model should follow, regardless of messages sent by the user. Builder Builder Function The function that the model called. Type ChatCompletionMessageToolCall ChatCompletionModality Builder Builder Function Type ChatCompletionNamedToolChoice Specifies a tool the model should use. Builder Deserializer Serializer Content The content that should be matched when generating a model response. Type ChatCompletionPredictionContent Static predicted output content, such as the content of a text file that is being regenerated. ChatCompletionReasoningEffort ChatCompletionRole Builder ChatCompletionStreamOptions Options for streaming response. Builder Deserializer Serializer Content The contents of the system message. Role ChatCompletionSystemMessageParam Developer-provided instructions that the model should follow, regardless of messages sent by the user. Builder Builder TopLogprob ChatCompletionTokenLogprob Builder Type ChatCompletionTool Deserializer Serializer Behavior ChatCompletionToolChoiceOption Controls which (if any) tool is called by the model. Builder Deserializer Serializer Content The contents of the tool message. Role ChatCompletionToolMessageParam Builder Deserializer Serializer Content The contents of the user message. Role ChatCompletionUserMessageParam Messages sent by an end user, containing prompts or additional context information. ChatModel Builder Type CodeInterpreterLogs Text output from the Code Interpreter tool call as part of a run step. Builder Type Builder Image CodeInterpreterOutputImage Builder Type CodeInterpreterTool Builder Builder Deserializer Serializer Builder Type LogsOutput Text output from the Code Interpreter tool call as part of a run step. Builder Builder Image Type ImageOutput Output Text output from the Code Interpreter tool call as part of a run step. CodeInterpreter The Code Interpreter tool call definition. Type CodeInterpreterToolCall Details of the Code Interpreter tool call the run step was involved in. Builder Type Builder Deserializer Serializer Output Text output from the Code Interpreter tool call as part of a run step. CodeInterpreter The Code Interpreter tool call definition. CodeInterpreterToolCallDelta Details of the Code Interpreter tool call the run step was involved in. Builder Object Completion Represents a completion response from the API. Builder FinishReason Builder Builder TopLogprob Logprobs CompletionChoice Builder CompletionCreateBody Builder Model Deserializer Serializer Prompt The prompt(s) to generate completions for, encoded as a string, array of strings, array of tokens, or array of token arrays. Builder LogitBias Modify the likelihood of specified tokens appearing in the completion. Deserializer Serializer Stop Up to 4 sequences where the API will stop generating further tokens. CompletionCreateParams Creates a completion for the provided prompt and parameters. Builder Builder CompletionTokensDetails Breakdown of tokens used in a completion. Builder PromptTokensDetails Breakdown of tokens used in the prompt. CompletionUsage Usage statistics for the completion request. Builder Object Builder Usage The usage information for the request. CreateEmbeddingResponse Builder Object Embedding Represents an embedding vector returned by embedding endpoint. Builder EmbeddingCreateBody Builder Deserializer Serializer Input Input text to embed, encoded as a string or array of tokens. EncodingFormat EmbeddingCreateParams Creates an embedding vector representing the input text. EmbeddingModel Builder ErrorObject Deserializer Serializer FileChunkingStrategy The strategy used to chunk the file. Deserializer Serializer FileChunkingStrategyParam The chunking strategy used to chunk the file(s). Builder Builder FileCitation Type FileCitationAnnotation A citation within the message that points to a specific quote from a specific File associated with the assistant or the message. Builder Type Builder FileCitation FileCitationDeltaAnnotation A citation within the message that points to a specific quote from a specific File associated with the assistant or the message. Builder FileDeleteParams Delete a file. Builder Object FileDeleted Builder Response AutoPager FileListPage Builder Response AutoPager FileListPageAsync Builder Order FileListParams Returns a list of files. Builder Object Purpose Status FileObject The File
object represents a document that has been uploaded to OpenAI.Builder Builder FilePath Type FilePathAnnotation A URL for the file that's generated when the assistant used the code_interpreter
tool to generate a file.Builder Type Builder FilePath FilePathDeltaAnnotation A URL for the file that's generated when the assistant used the code_interpreter
tool to generate a file.FilePurpose Builder FileRetrieveParams Returns information about a specific file. Builder Type Builder Builder Ranker RankingOptions The ranking options for the file search. FileSearch Overrides for the file search tool. FileSearchTool Builder Builder Builder Ranker RankingOptions The ranking options for the file search. Builder Builder Type Content Result A result instance of the file search. FileSearch For now, this is always going to be an empty object. Type FileSearchToolCall Builder Type FileSearchToolCallDelta Builder Builder Error For fine-tuning jobs that have failed
, this will contain more information on the cause of the failure.Builder Deserializer Serializer Auto BatchSize Number of examples in each batch. Deserializer Serializer Auto LearningRateMultiplier Scaling factor for the learning rate. Deserializer Serializer Behavior NEpochs The number of epochs to train the model for. Hyperparameters The hyperparameters used for the fine-tuning job. Object Status Builder Builder Builder Deserializer Serializer Auto BatchSize Number of examples in each batch. Deserializer Serializer Auto Beta The beta value for the DPO method. Deserializer Serializer Auto LearningRateMultiplier Scaling factor for the learning rate. Deserializer Serializer Auto NEpochs The number of epochs to train the model for. Hyperparameters The hyperparameters used for the fine-tuning job. Dpo Configuration for the DPO fine-tuning method. Builder Builder Deserializer Serializer Auto BatchSize Number of examples in each batch. Deserializer Serializer Auto LearningRateMultiplier Scaling factor for the learning rate. Deserializer Serializer Auto NEpochs The number of epochs to train the model for. Hyperparameters The hyperparameters used for the fine-tuning job. Supervised Configuration for the supervised fine-tuning method. Type Method The method used for fine-tuning. FineTuningJob The fine_tuning.job
object represents a fine-tuning job that has been created through the API.Builder FineTuningJobCancelParams Immediately cancel a fine-tune job. Builder Builder Metrics Metrics at the step number during the fine-tuning job. Object FineTuningJobCheckpoint The fine_tuning.job.checkpoint
object represents a model checkpoint for a fine-tuning job that is ready to use.Builder Response AutoPager FineTuningJobCheckpointListPage Builder Response AutoPager FineTuningJobCheckpointListPageAsync Builder FineTuningJobCheckpointListParams List checkpoints for a fine-tuning job. Builder FineTuningJobCreateBody Builder Model Builder Deserializer Serializer Behavior BatchSize Number of examples in each batch. Deserializer Serializer Behavior LearningRateMultiplier Scaling factor for the learning rate. Deserializer Serializer Behavior NEpochs The number of epochs to train the model for. Hyperparameters The hyperparameters used for the fine-tuning job. Builder Type Builder Wandb The settings for your integration with Weights and Biases. Integration Builder Builder Builder Deserializer Serializer Auto BatchSize Number of examples in each batch. Deserializer Serializer Auto Beta The beta value for the DPO method. Deserializer Serializer Auto LearningRateMultiplier Scaling factor for the learning rate. Deserializer Serializer Auto NEpochs The number of epochs to train the model for. Hyperparameters The hyperparameters used for the fine-tuning job. Dpo Configuration for the DPO fine-tuning method. Builder Builder Deserializer Serializer Auto BatchSize Number of examples in each batch. Deserializer Serializer Auto LearningRateMultiplier Scaling factor for the learning rate. Deserializer Serializer Auto NEpochs The number of epochs to train the model for. Hyperparameters The hyperparameters used for the fine-tuning job. Supervised Configuration for the supervised fine-tuning method. Type Method The method used for fine-tuning. FineTuningJobCreateParams Creates a fine-tuning job which begins the process of creating a new model from a given dataset. Builder Level Object Type FineTuningJobEvent Fine-tuning job event object Builder Response AutoPager FineTuningJobListEventsPage Builder Response AutoPager FineTuningJobListEventsPageAsync Builder FineTuningJobListEventsParams Get status updates for a fine-tuning job. Builder Response AutoPager FineTuningJobListPage Builder Response AutoPager FineTuningJobListPageAsync Builder FineTuningJobListParams List your organization's fine-tuning jobs Builder FineTuningJobRetrieveParams Get info about a fine-tuning job. Builder FineTuningJobWandbIntegration The settings for your integration with Weights and Biases. Builder Type FineTuningJobWandbIntegrationObject Builder FunctionDefinition Builder FunctionParameters The parameters the functions accepts, described as a JSON Schema object. Builder Type FunctionTool Builder Builder Function The definition of the function that was called. Type FunctionToolCall Builder Type Builder Function The definition of the function that was called. FunctionToolCallDelta Builder Image Represents the url or the content of an image generated by the OpenAI API. Builder Detail ImageFile Builder Type ImageFileContentBlock References an image File in the content of a message. Builder Detail ImageFileDelta Builder Type ImageFileDeltaBlock References an image File in the content of a message. Builder ImageGenerateBody Builder Quality ResponseFormat Size Style ImageGenerateParams Creates an image given a prompt. ImageModel Builder Detail ImageUrl Builder Type ImageUrlContentBlock References an image URL in the content of a message. Builder Detail ImageUrlDelta Builder Type ImageUrlDeltaBlock References an image URL in the content of a message. Builder ImagesResponse Builder Builder Deserializer Serializer Builder Type AssistantToolsFileSearchTypeOnly Tool Attachment Builder Reason IncompleteDetails On an incomplete message, details about why the message is incomplete. Object Role Status Message Represents a message within a thread. Deserializer Serializer MessageContent References an image File in the content of a message. Deserializer Serializer MessageContentDelta References an image File in the content of a message. Deserializer Serializer MessageContentPartParam References an image File in the content of a message. Builder Builder MessageCreation Type MessageCreationStepDetails Details of the message creation by the run step. Builder Object MessageDeleted Builder Role MessageDelta The delta containing the fields that have changed on the Message. Builder Object MessageDeltaEvent Represents a message delta i.e. Deserializer Serializer Builder Event ThreadMessageCreated Occurs when a message is created. Builder Event ThreadMessageInProgress Occurs when a message moves to an in_progress
state.Builder Event ThreadMessageDelta Occurs when parts of a Message are being streamed. Builder Event ThreadMessageCompleted Occurs when a message is completed. Builder Event ThreadMessageIncomplete Occurs when a message ends before it is completed. MessageStreamEvent Occurs when a message is created. Builder Object Model Describes an OpenAI model offering that can be used with the API. Builder ModelDeleteParams Delete a fine-tuned model. Builder ModelDeleted Builder Response AutoPager ModelListPage Builder Response AutoPager ModelListPageAsync Builder ModelListParams Lists the currently available models, and provides basic information about each one such as the owner and availability. Builder ModelRetrieveParams Retrieves a model instance, providing basic information about the model such as the owner and permissioning. Builder Builder Categories A list of the categories, and whether they are flagged or not. Builder Harassment HarassmentThreatening Hate HateThreatening Illicit IllicitViolent SelfHarm SelfHarmInstruction SelfHarmIntent Sexual SexualMinor Violence ViolenceGraphic CategoryAppliedInputTypes A list of the categories along with the input type(s) that the score applies to. Builder CategoryScores A list of the categories along with their scores as predicted by model. Moderation Builder ModerationCreateBody Builder Deserializer Serializer Input Input (or inputs) to classify. ModerationCreateParams Classifies if text and/or image inputs are potentially harmful. Builder ModerationCreateResponse Represents if a given text input is potentially harmful. Builder Builder ImageUrl Contains either an image URL or a data URL for a base64 encoded image. Type ModerationImageUrlInput An object describing an image to classify. ModerationModel Deserializer Serializer ModerationMultiModalInput An object describing an image to classify. Builder Type ModerationTextInput An object describing text to classify. Builder Type OtherFileChunkingStrategyObject This is returned when the chunking strategy is unknown. Builder Type RefusalContentBlock The refusal content generated by the assistant. Builder Type RefusalDeltaBlock The refusal content that is part of a message. Builder Builder Function The function definition. Type RequiredActionFunctionToolCall Tool call objects Builder Type ResponseFormatJsonObject Builder Builder Builder Schema The schema for the response format, described as a JSON Schema object. JsonSchema Type ResponseFormatJsonSchema Builder Type ResponseFormatText Builder Builder Reason IncompleteDetails Details on why the run is incomplete. Builder Code LastError The last error associated with this run. Object Builder Builder SubmitToolOutputs Details on the tool outputs needed for this run to continue. Type RequiredAction Details on the action required to continue the run. Builder Type TruncationStrategy Controls for how a thread will be truncated prior to the run. Builder Usage Usage statistics related to the run. Run Represents an execution run on a thread. RunStatus Builder Builder Code LastError The last error associated with this run step. Object Status Deserializer Serializer StepDetails The details of the run step. Type Builder Usage Usage statistics related to the run step. RunStep Represents a step in execution of a run. Builder Deserializer Serializer StepDetails The details of the run step. RunStepDelta The delta containing the fields that have changed on the run step. Builder Object RunStepDeltaEvent Represents a run step delta i.e. Builder Type Builder MessageCreation RunStepDeltaMessageDelta Details of the message creation by the run step. RunStepInclude Deserializer Serializer Builder Event ThreadRunStepCreated Occurs when a run step is created. Builder Event ThreadRunStepInProgress Occurs when a run step moves to an in_progress
state.Builder Event ThreadRunStepDelta Occurs when parts of a run step are being streamed. Builder Event ThreadRunStepCompleted Occurs when a run step is completed. Builder Event ThreadRunStepFailed Occurs when a run step fails. Builder Event ThreadRunStepCancelled Occurs when a run step is cancelled. Builder Event ThreadRunStepExpired Occurs when a run step expires. RunStepStreamEvent Occurs when a run step is created. Deserializer Serializer Builder Event ThreadRunCreated Occurs when a new run is created. Builder Event ThreadRunQueued Occurs when a run moves to a queued
status.Builder Event ThreadRunInProgress Occurs when a run moves to an in_progress
status.Builder Event ThreadRunRequiresAction Occurs when a run moves to a requires_action
status.Builder Event ThreadRunCompleted Occurs when a run is completed. Builder Event ThreadRunIncomplete Occurs when a run ends with status incomplete
.Builder Event ThreadRunFailed Occurs when a run fails. Builder Event ThreadRunCancelling Occurs when a run moves to a cancelling
status.Builder Event ThreadRunCancelled Occurs when a run is cancelled. Builder Event ThreadRunExpired Occurs when a run expires. RunStreamEvent Occurs when a new run is created. Builder StaticFileChunkingStrategy Builder Type StaticFileChunkingStrategyObject Builder Type StaticFileChunkingStrategyParam Builder Text Builder Type TextContentBlock The text content that is part of a message. Builder Type TextContentBlockParam The text content that is part of a message. Builder TextDelta Builder Type TextDeltaBlock The text content that is part of a message. Builder Object Builder Builder CodeInterpreter Builder FileSearch ToolResources A set of resources that are made available to the assistant's tools in this thread. Thread Represents a thread that contains messages. Builder Object ThreadDeleted Builder Event ThreadStreamEvent Occurs when a new thread is created. Deserializer Serializer ToolCall Details of the Code Interpreter tool call the run step was involved in. Deserializer Serializer ToolCallDelta Details of the Code Interpreter tool call the run step was involved in. Builder Type ToolCallDeltaObject Details of the tool call. Builder Type ToolCallsStepDetails Details of the tool call. Builder Object Status Upload The Upload object can accept byte chunks in the form of Parts. Builder UploadCancelParams Cancels the Upload. Builder UploadCompleteBody Builder UploadCompleteParams Completes the Upload. Builder UploadCreateBody Builder UploadCreateParams Creates an intermediate Upload object that you can add Parts to. Builder Object UploadPart The upload Part represents a chunk of bytes we can add to an Upload object. Builder Builder FileCounts Object Status Builder Anchor ExpiresAfter The expiration policy for a vector store. VectorStore A vector store is a collection of processed files can be used by the file_search
tool.Builder Object VectorStoreDeleted Builder Builder Code LastError The last error associated with this vector store file. Object Status VectorStoreFile A list of files attached to a vector store. Builder Builder FileCounts Object Status VectorStoreFileBatch A batch of files attached to a vector store. Builder Object VectorStoreFileDeleted -