diff --git a/en/java/resources/beta/subresources/assistants/index.md b/en/java/resources/beta/subresources/assistants/index.md deleted file mode 100644 index f89df40..0000000 --- a/en/java/resources/beta/subresources/assistants/index.md +++ /dev/null @@ -1,5371 +0,0 @@ -# Assistants - -## List assistants - -`AssistantListPage beta().assistants().list(AssistantListParamsparams = AssistantListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())` - -**get** `/assistants` - -Returns a list of assistants. - -### Parameters - -- `AssistantListParams params` - - - `Optional after` - - A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. - - - `Optional before` - - A cursor for use in pagination. `before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. - - - `Optional limit` - - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. - - - `Optional order` - - Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order. - - - `ASC("asc")` - - - `DESC("desc")` - -### Returns - -- `class Assistant:` - - Represents an `assistant` that can call the model and use tools. - - - `String id` - - The identifier, which can be referenced in API endpoints. - - - `long createdAt` - - The Unix timestamp (in seconds) for when the assistant was created. - - - `Optional description` - - The description of the assistant. The maximum length is 512 characters. - - - `Optional instructions` - - The system instructions that the assistant uses. The maximum length is 256,000 characters. - - - `Optional metadata` - - Set of 16 key-value pairs that can be attached to an object. This can be - useful for storing additional information about the object in a structured - format, and querying for objects via API or the dashboard. - - Keys are strings with a maximum length of 64 characters. Values are strings - with a maximum length of 512 characters. - - - `String model` - - ID of the model to use. You can use the [List models](https://platform.openai.com/docs/api-reference/models/list) API to see all of your available models, or see our [Model overview](https://platform.openai.com/docs/models) for descriptions of them. - - - `Optional name` - - The name of the assistant. The maximum length is 256 characters. - - - `JsonValue; object_ "assistant"constant` - - The object type, which is always `assistant`. - - - `ASSISTANT("assistant")` - - - `List tools` - - A list of tool enabled on the assistant. There can be a maximum of 128 tools per assistant. Tools can be of types `code_interpreter`, `file_search`, or `function`. - - - `class CodeInterpreterTool:` - - - `JsonValue; type "code_interpreter"constant` - - The type of tool being defined: `code_interpreter` - - - `CODE_INTERPRETER("code_interpreter")` - - - `class FileSearchTool:` - - - `JsonValue; type "file_search"constant` - - The type of tool being defined: `file_search` - - - `FILE_SEARCH("file_search")` - - - `Optional fileSearch` - - Overrides for the file search tool. - - - `Optional maxNumResults` - - The maximum number of results the file search tool should output. The default is 20 for `gpt-4*` models and 5 for `gpt-3.5-turbo`. This number should be between 1 and 50 inclusive. - - Note that the file search tool may output fewer than `max_num_results` results. See the [file search tool documentation](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) for more information. - - - `Optional rankingOptions` - - The ranking options for the file search. If not specified, the file search tool will use the `auto` ranker and a score_threshold of 0. - - See the [file search tool documentation](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) for more information. - - - `double scoreThreshold` - - The score threshold for the file search. All values must be a floating point number between 0 and 1. - - - `Optional ranker` - - The ranker to use for the file search. If not specified will use the `auto` ranker. - - - `AUTO("auto")` - - - `DEFAULT_2024_08_21("default_2024_08_21")` - - - `class FunctionTool:` - - - `FunctionDefinition function` - - - `String name` - - The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. - - - `Optional description` - - A description of what the function does, used by the model to choose when and how to call the function. - - - `Optional parameters` - - The parameters the functions accepts, described as a JSON Schema object. See the [guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. - - Omitting `parameters` defines a function with an empty parameter list. - - - `Optional strict` - - Whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the `parameters` field. Only a subset of JSON Schema is supported when `strict` is `true`. Learn more about Structured Outputs in the [function calling guide](https://platform.openai.com/docs/guides/function-calling). - - - `JsonValue; type "function"constant` - - The type of tool being defined: `function` - - - `FUNCTION("function")` - - - `Optional responseFormat` - - Specifies the format that the model must output. Compatible with [GPT-4o](https://platform.openai.com/docs/models#gpt-4o), [GPT-4 Turbo](https://platform.openai.com/docs/models#gpt-4-turbo-and-gpt-4), and all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`. - - Setting to `{ "type": "json_schema", "json_schema": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema. Learn more in the [Structured Outputs guide](https://platform.openai.com/docs/guides/structured-outputs). - - Setting to `{ "type": "json_object" }` enables JSON mode, which ensures the message the model generates is valid JSON. - - **Important:** when using JSON mode, you **must** also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly "stuck" request. Also note that the message content may be partially cut off if `finish_reason="length"`, which indicates the generation exceeded `max_tokens` or the conversation exceeded the max context length. - - - `JsonValue;` - - - `AUTO("auto")` - - - `class ResponseFormatText:` - - Default response format. Used to generate text responses. - - - `JsonValue; type "text"constant` - - The type of response format being defined. Always `text`. - - - `TEXT("text")` - - - `class ResponseFormatJsonObject:` - - JSON object response format. An older method of generating JSON responses. - Using `json_schema` is recommended for models that support it. Note that the - model will not generate JSON without a system or user message instructing it - to do so. - - - `JsonValue; type "json_object"constant` - - The type of response format being defined. Always `json_object`. - - - `JSON_OBJECT("json_object")` - - - `class ResponseFormatJsonSchema:` - - JSON Schema response format. Used to generate structured JSON responses. - Learn more about [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs). - - - `JsonSchema jsonSchema` - - Structured Outputs configuration options, including a JSON Schema. - - - `String name` - - The name of the response format. Must be a-z, A-Z, 0-9, or contain - underscores and dashes, with a maximum length of 64. - - - `Optional description` - - A description of what the response format is for, used by the model to - determine how to respond in the format. - - - `Optional schema` - - The schema for the response format, described as a JSON Schema object. - Learn how to build JSON schemas [here](https://json-schema.org/). - - - `Optional strict` - - Whether to enable strict schema adherence when generating the output. - If set to true, the model will always follow the exact schema defined - in the `schema` field. Only a subset of JSON Schema is supported when - `strict` is `true`. To learn more, read the [Structured Outputs - guide](https://platform.openai.com/docs/guides/structured-outputs). - - - `JsonValue; type "json_schema"constant` - - The type of response format being defined. Always `json_schema`. - - - `JSON_SCHEMA("json_schema")` - - - `Optional temperature` - - What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. - - - `Optional toolResources` - - A set of resources that are used by the assistant's tools. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs. - - - `Optional codeInterpreter` - - - `Optional> fileIds` - - A list of [file](https://platform.openai.com/docs/api-reference/files) IDs made available to the `code_interpreter`` tool. There can be a maximum of 20 files associated with the tool. - - - `Optional fileSearch` - - - `Optional> vectorStoreIds` - - The ID of the [vector store](https://platform.openai.com/docs/api-reference/vector-stores/object) attached to this assistant. There can be a maximum of 1 vector store attached to the assistant. - - - `Optional topP` - - An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. - - We generally recommend altering this or temperature but not both. - -### Example - -```java -package com.openai.example; - -import com.openai.client.OpenAIClient; -import com.openai.client.okhttp.OpenAIOkHttpClient; -import com.openai.models.beta.assistants.AssistantListPage; -import com.openai.models.beta.assistants.AssistantListParams; - -public final class Main { - private Main() {} - - public static void main(String[] args) { - OpenAIClient client = OpenAIOkHttpClient.fromEnv(); - - AssistantListPage page = client.beta().assistants().list(); - } -} -``` - -#### Response - -```json -{ - "data": [ - { - "id": "id", - "created_at": 0, - "description": "description", - "instructions": "instructions", - "metadata": { - "foo": "string" - }, - "model": "model", - "name": "name", - "object": "assistant", - "tools": [ - { - "type": "code_interpreter" - } - ], - "response_format": "auto", - "temperature": 1, - "tool_resources": { - "code_interpreter": { - "file_ids": [ - "string" - ] - }, - "file_search": { - "vector_store_ids": [ - "string" - ] - } - }, - "top_p": 1 - } - ], - "first_id": "asst_abc123", - "has_more": false, - "last_id": "asst_abc456", - "object": "list" -} -``` - -## Create assistant - -`Assistant beta().assistants().create(AssistantCreateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())` - -**post** `/assistants` - -Create an assistant with a model and instructions. - -### Parameters - -- `AssistantCreateParams params` - - - `ChatModel model` - - ID of the model to use. You can use the [List models](https://platform.openai.com/docs/api-reference/models/list) API to see all of your available models, or see our [Model overview](https://platform.openai.com/docs/models) for descriptions of them. - - - `GPT_5_4("gpt-5.4")` - - - `GPT_5_4_MINI("gpt-5.4-mini")` - - - `GPT_5_4_NANO("gpt-5.4-nano")` - - - `GPT_5_4_MINI_2026_03_17("gpt-5.4-mini-2026-03-17")` - - - `GPT_5_4_NANO_2026_03_17("gpt-5.4-nano-2026-03-17")` - - - `GPT_5_3_CHAT_LATEST("gpt-5.3-chat-latest")` - - - `GPT_5_2("gpt-5.2")` - - - `GPT_5_2_2025_12_11("gpt-5.2-2025-12-11")` - - - `GPT_5_2_CHAT_LATEST("gpt-5.2-chat-latest")` - - - `GPT_5_2_PRO("gpt-5.2-pro")` - - - `GPT_5_2_PRO_2025_12_11("gpt-5.2-pro-2025-12-11")` - - - `GPT_5_1("gpt-5.1")` - - - `GPT_5_1_2025_11_13("gpt-5.1-2025-11-13")` - - - `GPT_5_1_CODEX("gpt-5.1-codex")` - - - `GPT_5_1_MINI("gpt-5.1-mini")` - - - `GPT_5_1_CHAT_LATEST("gpt-5.1-chat-latest")` - - - `GPT_5("gpt-5")` - - - `GPT_5_MINI("gpt-5-mini")` - - - `GPT_5_NANO("gpt-5-nano")` - - - `GPT_5_2025_08_07("gpt-5-2025-08-07")` - - - `GPT_5_MINI_2025_08_07("gpt-5-mini-2025-08-07")` - - - `GPT_5_NANO_2025_08_07("gpt-5-nano-2025-08-07")` - - - `GPT_5_CHAT_LATEST("gpt-5-chat-latest")` - - - `GPT_4_1("gpt-4.1")` - - - `GPT_4_1_MINI("gpt-4.1-mini")` - - - `GPT_4_1_NANO("gpt-4.1-nano")` - - - `GPT_4_1_2025_04_14("gpt-4.1-2025-04-14")` - - - `GPT_4_1_MINI_2025_04_14("gpt-4.1-mini-2025-04-14")` - - - `GPT_4_1_NANO_2025_04_14("gpt-4.1-nano-2025-04-14")` - - - `O4_MINI("o4-mini")` - - - `O4_MINI_2025_04_16("o4-mini-2025-04-16")` - - - `O3("o3")` - - - `O3_2025_04_16("o3-2025-04-16")` - - - `O3_MINI("o3-mini")` - - - `O3_MINI_2025_01_31("o3-mini-2025-01-31")` - - - `O1("o1")` - - - `O1_2024_12_17("o1-2024-12-17")` - - - `O1_PREVIEW("o1-preview")` - - - `O1_PREVIEW_2024_09_12("o1-preview-2024-09-12")` - - - `O1_MINI("o1-mini")` - - - `O1_MINI_2024_09_12("o1-mini-2024-09-12")` - - - `GPT_4O("gpt-4o")` - - - `GPT_4O_2024_11_20("gpt-4o-2024-11-20")` - - - `GPT_4O_2024_08_06("gpt-4o-2024-08-06")` - - - `GPT_4O_2024_05_13("gpt-4o-2024-05-13")` - - - `GPT_4O_AUDIO_PREVIEW("gpt-4o-audio-preview")` - - - `GPT_4O_AUDIO_PREVIEW_2024_10_01("gpt-4o-audio-preview-2024-10-01")` - - - `GPT_4O_AUDIO_PREVIEW_2024_12_17("gpt-4o-audio-preview-2024-12-17")` - - - `GPT_4O_AUDIO_PREVIEW_2025_06_03("gpt-4o-audio-preview-2025-06-03")` - - - `GPT_4O_MINI_AUDIO_PREVIEW("gpt-4o-mini-audio-preview")` - - - `GPT_4O_MINI_AUDIO_PREVIEW_2024_12_17("gpt-4o-mini-audio-preview-2024-12-17")` - - - `GPT_4O_SEARCH_PREVIEW("gpt-4o-search-preview")` - - - `GPT_4O_MINI_SEARCH_PREVIEW("gpt-4o-mini-search-preview")` - - - `GPT_4O_SEARCH_PREVIEW_2025_03_11("gpt-4o-search-preview-2025-03-11")` - - - `GPT_4O_MINI_SEARCH_PREVIEW_2025_03_11("gpt-4o-mini-search-preview-2025-03-11")` - - - `CHATGPT_4O_LATEST("chatgpt-4o-latest")` - - - `CODEX_MINI_LATEST("codex-mini-latest")` - - - `GPT_4O_MINI("gpt-4o-mini")` - - - `GPT_4O_MINI_2024_07_18("gpt-4o-mini-2024-07-18")` - - - `GPT_4_TURBO("gpt-4-turbo")` - - - `GPT_4_TURBO_2024_04_09("gpt-4-turbo-2024-04-09")` - - - `GPT_4_0125_PREVIEW("gpt-4-0125-preview")` - - - `GPT_4_TURBO_PREVIEW("gpt-4-turbo-preview")` - - - `GPT_4_1106_PREVIEW("gpt-4-1106-preview")` - - - `GPT_4_VISION_PREVIEW("gpt-4-vision-preview")` - - - `GPT_4("gpt-4")` - - - `GPT_4_0314("gpt-4-0314")` - - - `GPT_4_0613("gpt-4-0613")` - - - `GPT_4_32K("gpt-4-32k")` - - - `GPT_4_32K_0314("gpt-4-32k-0314")` - - - `GPT_4_32K_0613("gpt-4-32k-0613")` - - - `GPT_3_5_TURBO("gpt-3.5-turbo")` - - - `GPT_3_5_TURBO_16K("gpt-3.5-turbo-16k")` - - - `GPT_3_5_TURBO_0301("gpt-3.5-turbo-0301")` - - - `GPT_3_5_TURBO_0613("gpt-3.5-turbo-0613")` - - - `GPT_3_5_TURBO_1106("gpt-3.5-turbo-1106")` - - - `GPT_3_5_TURBO_0125("gpt-3.5-turbo-0125")` - - - `GPT_3_5_TURBO_16K_0613("gpt-3.5-turbo-16k-0613")` - - - `Optional description` - - The description of the assistant. The maximum length is 512 characters. - - - `Optional instructions` - - The system instructions that the assistant uses. The maximum length is 256,000 characters. - - - `Optional metadata` - - Set of 16 key-value pairs that can be attached to an object. This can be - useful for storing additional information about the object in a structured - format, and querying for objects via API or the dashboard. - - Keys are strings with a maximum length of 64 characters. Values are strings - with a maximum length of 512 characters. - - - `Optional name` - - The name of the assistant. The maximum length is 256 characters. - - - `Optional reasoningEffort` - - Constrains effort on reasoning for - [reasoning models](https://platform.openai.com/docs/guides/reasoning). - Currently supported values are `none`, `minimal`, `low`, `medium`, `high`, and `xhigh`. Reducing - reasoning effort can result in faster responses and fewer tokens used - on reasoning in a response. - - - `gpt-5.1` defaults to `none`, which does not perform reasoning. The supported reasoning values for `gpt-5.1` are `none`, `low`, `medium`, and `high`. Tool calls are supported for all reasoning values in gpt-5.1. - - All models before `gpt-5.1` default to `medium` reasoning effort, and do not support `none`. - - The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort. - - `xhigh` is supported for all models after `gpt-5.1-codex-max`. - - - `Optional responseFormat` - - Specifies the format that the model must output. Compatible with [GPT-4o](https://platform.openai.com/docs/models#gpt-4o), [GPT-4 Turbo](https://platform.openai.com/docs/models#gpt-4-turbo-and-gpt-4), and all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`. - - Setting to `{ "type": "json_schema", "json_schema": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema. Learn more in the [Structured Outputs guide](https://platform.openai.com/docs/guides/structured-outputs). - - Setting to `{ "type": "json_object" }` enables JSON mode, which ensures the message the model generates is valid JSON. - - **Important:** when using JSON mode, you **must** also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly "stuck" request. Also note that the message content may be partially cut off if `finish_reason="length"`, which indicates the generation exceeded `max_tokens` or the conversation exceeded the max context length. - - - `Optional temperature` - - What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. - - - `Optional toolResources` - - A set of resources that are used by the assistant's tools. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs. - - - `Optional codeInterpreter` - - - `Optional> fileIds` - - A list of [file](https://platform.openai.com/docs/api-reference/files) IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files associated with the tool. - - - `Optional fileSearch` - - - `Optional> vectorStoreIds` - - The [vector store](https://platform.openai.com/docs/api-reference/vector-stores/object) attached to this assistant. There can be a maximum of 1 vector store attached to the assistant. - - - `Optional> vectorStores` - - A helper to create a [vector store](https://platform.openai.com/docs/api-reference/vector-stores/object) with file_ids and attach it to this assistant. There can be a maximum of 1 vector store attached to the assistant. - - - `Optional chunkingStrategy` - - The chunking strategy used to chunk the file(s). If not set, will use the `auto` strategy. - - - `JsonValue;` - - - `JsonValue; type "auto"constant` - - Always `auto`. - - - `AUTO("auto")` - - - `class Static:` - - - `InnerStatic static_` - - - `long chunkOverlapTokens` - - The number of tokens that overlap between chunks. The default value is `400`. - - Note that the overlap must not exceed half of `max_chunk_size_tokens`. - - - `long maxChunkSizeTokens` - - The maximum number of tokens in each chunk. The default value is `800`. The minimum value is `100` and the maximum value is `4096`. - - - `JsonValue; type "static"constant` - - Always `static`. - - - `STATIC("static")` - - - `Optional> fileIds` - - A list of [file](https://platform.openai.com/docs/api-reference/files) IDs to add to the vector store. For vector stores created before Nov 2025, there can be a maximum of 10,000 files in a vector store. For vector stores created starting in Nov 2025, the limit is 100,000,000 files. - - - `Optional metadata` - - Set of 16 key-value pairs that can be attached to an object. This can be - useful for storing additional information about the object in a structured - format, and querying for objects via API or the dashboard. - - Keys are strings with a maximum length of 64 characters. Values are strings - with a maximum length of 512 characters. - - - `Optional> tools` - - A list of tool enabled on the assistant. There can be a maximum of 128 tools per assistant. Tools can be of types `code_interpreter`, `file_search`, or `function`. - - - `class CodeInterpreterTool:` - - - `JsonValue; type "code_interpreter"constant` - - The type of tool being defined: `code_interpreter` - - - `CODE_INTERPRETER("code_interpreter")` - - - `class FileSearchTool:` - - - `JsonValue; type "file_search"constant` - - The type of tool being defined: `file_search` - - - `FILE_SEARCH("file_search")` - - - `Optional fileSearch` - - Overrides for the file search tool. - - - `Optional maxNumResults` - - The maximum number of results the file search tool should output. The default is 20 for `gpt-4*` models and 5 for `gpt-3.5-turbo`. This number should be between 1 and 50 inclusive. - - Note that the file search tool may output fewer than `max_num_results` results. See the [file search tool documentation](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) for more information. - - - `Optional rankingOptions` - - The ranking options for the file search. If not specified, the file search tool will use the `auto` ranker and a score_threshold of 0. - - See the [file search tool documentation](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) for more information. - - - `double scoreThreshold` - - The score threshold for the file search. All values must be a floating point number between 0 and 1. - - - `Optional ranker` - - The ranker to use for the file search. If not specified will use the `auto` ranker. - - - `AUTO("auto")` - - - `DEFAULT_2024_08_21("default_2024_08_21")` - - - `class FunctionTool:` - - - `FunctionDefinition function` - - - `String name` - - The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. - - - `Optional description` - - A description of what the function does, used by the model to choose when and how to call the function. - - - `Optional parameters` - - The parameters the functions accepts, described as a JSON Schema object. See the [guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. - - Omitting `parameters` defines a function with an empty parameter list. - - - `Optional strict` - - Whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the `parameters` field. Only a subset of JSON Schema is supported when `strict` is `true`. Learn more about Structured Outputs in the [function calling guide](https://platform.openai.com/docs/guides/function-calling). - - - `JsonValue; type "function"constant` - - The type of tool being defined: `function` - - - `FUNCTION("function")` - - - `Optional topP` - - An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. - - We generally recommend altering this or temperature but not both. - -### Returns - -- `class Assistant:` - - Represents an `assistant` that can call the model and use tools. - - - `String id` - - The identifier, which can be referenced in API endpoints. - - - `long createdAt` - - The Unix timestamp (in seconds) for when the assistant was created. - - - `Optional description` - - The description of the assistant. The maximum length is 512 characters. - - - `Optional instructions` - - The system instructions that the assistant uses. The maximum length is 256,000 characters. - - - `Optional metadata` - - Set of 16 key-value pairs that can be attached to an object. This can be - useful for storing additional information about the object in a structured - format, and querying for objects via API or the dashboard. - - Keys are strings with a maximum length of 64 characters. Values are strings - with a maximum length of 512 characters. - - - `String model` - - ID of the model to use. You can use the [List models](https://platform.openai.com/docs/api-reference/models/list) API to see all of your available models, or see our [Model overview](https://platform.openai.com/docs/models) for descriptions of them. - - - `Optional name` - - The name of the assistant. The maximum length is 256 characters. - - - `JsonValue; object_ "assistant"constant` - - The object type, which is always `assistant`. - - - `ASSISTANT("assistant")` - - - `List tools` - - A list of tool enabled on the assistant. There can be a maximum of 128 tools per assistant. Tools can be of types `code_interpreter`, `file_search`, or `function`. - - - `class CodeInterpreterTool:` - - - `JsonValue; type "code_interpreter"constant` - - The type of tool being defined: `code_interpreter` - - - `CODE_INTERPRETER("code_interpreter")` - - - `class FileSearchTool:` - - - `JsonValue; type "file_search"constant` - - The type of tool being defined: `file_search` - - - `FILE_SEARCH("file_search")` - - - `Optional fileSearch` - - Overrides for the file search tool. - - - `Optional maxNumResults` - - The maximum number of results the file search tool should output. The default is 20 for `gpt-4*` models and 5 for `gpt-3.5-turbo`. This number should be between 1 and 50 inclusive. - - Note that the file search tool may output fewer than `max_num_results` results. See the [file search tool documentation](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) for more information. - - - `Optional rankingOptions` - - The ranking options for the file search. If not specified, the file search tool will use the `auto` ranker and a score_threshold of 0. - - See the [file search tool documentation](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) for more information. - - - `double scoreThreshold` - - The score threshold for the file search. All values must be a floating point number between 0 and 1. - - - `Optional ranker` - - The ranker to use for the file search. If not specified will use the `auto` ranker. - - - `AUTO("auto")` - - - `DEFAULT_2024_08_21("default_2024_08_21")` - - - `class FunctionTool:` - - - `FunctionDefinition function` - - - `String name` - - The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. - - - `Optional description` - - A description of what the function does, used by the model to choose when and how to call the function. - - - `Optional parameters` - - The parameters the functions accepts, described as a JSON Schema object. See the [guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. - - Omitting `parameters` defines a function with an empty parameter list. - - - `Optional strict` - - Whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the `parameters` field. Only a subset of JSON Schema is supported when `strict` is `true`. Learn more about Structured Outputs in the [function calling guide](https://platform.openai.com/docs/guides/function-calling). - - - `JsonValue; type "function"constant` - - The type of tool being defined: `function` - - - `FUNCTION("function")` - - - `Optional responseFormat` - - Specifies the format that the model must output. Compatible with [GPT-4o](https://platform.openai.com/docs/models#gpt-4o), [GPT-4 Turbo](https://platform.openai.com/docs/models#gpt-4-turbo-and-gpt-4), and all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`. - - Setting to `{ "type": "json_schema", "json_schema": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema. Learn more in the [Structured Outputs guide](https://platform.openai.com/docs/guides/structured-outputs). - - Setting to `{ "type": "json_object" }` enables JSON mode, which ensures the message the model generates is valid JSON. - - **Important:** when using JSON mode, you **must** also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly "stuck" request. Also note that the message content may be partially cut off if `finish_reason="length"`, which indicates the generation exceeded `max_tokens` or the conversation exceeded the max context length. - - - `JsonValue;` - - - `AUTO("auto")` - - - `class ResponseFormatText:` - - Default response format. Used to generate text responses. - - - `JsonValue; type "text"constant` - - The type of response format being defined. Always `text`. - - - `TEXT("text")` - - - `class ResponseFormatJsonObject:` - - JSON object response format. An older method of generating JSON responses. - Using `json_schema` is recommended for models that support it. Note that the - model will not generate JSON without a system or user message instructing it - to do so. - - - `JsonValue; type "json_object"constant` - - The type of response format being defined. Always `json_object`. - - - `JSON_OBJECT("json_object")` - - - `class ResponseFormatJsonSchema:` - - JSON Schema response format. Used to generate structured JSON responses. - Learn more about [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs). - - - `JsonSchema jsonSchema` - - Structured Outputs configuration options, including a JSON Schema. - - - `String name` - - The name of the response format. Must be a-z, A-Z, 0-9, or contain - underscores and dashes, with a maximum length of 64. - - - `Optional description` - - A description of what the response format is for, used by the model to - determine how to respond in the format. - - - `Optional schema` - - The schema for the response format, described as a JSON Schema object. - Learn how to build JSON schemas [here](https://json-schema.org/). - - - `Optional strict` - - Whether to enable strict schema adherence when generating the output. - If set to true, the model will always follow the exact schema defined - in the `schema` field. Only a subset of JSON Schema is supported when - `strict` is `true`. To learn more, read the [Structured Outputs - guide](https://platform.openai.com/docs/guides/structured-outputs). - - - `JsonValue; type "json_schema"constant` - - The type of response format being defined. Always `json_schema`. - - - `JSON_SCHEMA("json_schema")` - - - `Optional temperature` - - What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. - - - `Optional toolResources` - - A set of resources that are used by the assistant's tools. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs. - - - `Optional codeInterpreter` - - - `Optional> fileIds` - - A list of [file](https://platform.openai.com/docs/api-reference/files) IDs made available to the `code_interpreter`` tool. There can be a maximum of 20 files associated with the tool. - - - `Optional fileSearch` - - - `Optional> vectorStoreIds` - - The ID of the [vector store](https://platform.openai.com/docs/api-reference/vector-stores/object) attached to this assistant. There can be a maximum of 1 vector store attached to the assistant. - - - `Optional topP` - - An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. - - We generally recommend altering this or temperature but not both. - -### Example - -```java -package com.openai.example; - -import com.openai.client.OpenAIClient; -import com.openai.client.okhttp.OpenAIOkHttpClient; -import com.openai.models.ChatModel; -import com.openai.models.beta.assistants.Assistant; -import com.openai.models.beta.assistants.AssistantCreateParams; - -public final class Main { - private Main() {} - - public static void main(String[] args) { - OpenAIClient client = OpenAIOkHttpClient.fromEnv(); - - AssistantCreateParams params = AssistantCreateParams.builder() - .model(ChatModel.GPT_4O) - .build(); - Assistant assistant = client.beta().assistants().create(params); - } -} -``` - -#### Response - -```json -{ - "id": "id", - "created_at": 0, - "description": "description", - "instructions": "instructions", - "metadata": { - "foo": "string" - }, - "model": "model", - "name": "name", - "object": "assistant", - "tools": [ - { - "type": "code_interpreter" - } - ], - "response_format": "auto", - "temperature": 1, - "tool_resources": { - "code_interpreter": { - "file_ids": [ - "string" - ] - }, - "file_search": { - "vector_store_ids": [ - "string" - ] - } - }, - "top_p": 1 -} -``` - -## Retrieve assistant - -`Assistant beta().assistants().retrieve(AssistantRetrieveParamsparams = AssistantRetrieveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())` - -**get** `/assistants/{assistant_id}` - -Retrieves an assistant. - -### Parameters - -- `AssistantRetrieveParams params` - - - `Optional assistantId` - -### Returns - -- `class Assistant:` - - Represents an `assistant` that can call the model and use tools. - - - `String id` - - The identifier, which can be referenced in API endpoints. - - - `long createdAt` - - The Unix timestamp (in seconds) for when the assistant was created. - - - `Optional description` - - The description of the assistant. The maximum length is 512 characters. - - - `Optional instructions` - - The system instructions that the assistant uses. The maximum length is 256,000 characters. - - - `Optional metadata` - - Set of 16 key-value pairs that can be attached to an object. This can be - useful for storing additional information about the object in a structured - format, and querying for objects via API or the dashboard. - - Keys are strings with a maximum length of 64 characters. Values are strings - with a maximum length of 512 characters. - - - `String model` - - ID of the model to use. You can use the [List models](https://platform.openai.com/docs/api-reference/models/list) API to see all of your available models, or see our [Model overview](https://platform.openai.com/docs/models) for descriptions of them. - - - `Optional name` - - The name of the assistant. The maximum length is 256 characters. - - - `JsonValue; object_ "assistant"constant` - - The object type, which is always `assistant`. - - - `ASSISTANT("assistant")` - - - `List tools` - - A list of tool enabled on the assistant. There can be a maximum of 128 tools per assistant. Tools can be of types `code_interpreter`, `file_search`, or `function`. - - - `class CodeInterpreterTool:` - - - `JsonValue; type "code_interpreter"constant` - - The type of tool being defined: `code_interpreter` - - - `CODE_INTERPRETER("code_interpreter")` - - - `class FileSearchTool:` - - - `JsonValue; type "file_search"constant` - - The type of tool being defined: `file_search` - - - `FILE_SEARCH("file_search")` - - - `Optional fileSearch` - - Overrides for the file search tool. - - - `Optional maxNumResults` - - The maximum number of results the file search tool should output. The default is 20 for `gpt-4*` models and 5 for `gpt-3.5-turbo`. This number should be between 1 and 50 inclusive. - - Note that the file search tool may output fewer than `max_num_results` results. See the [file search tool documentation](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) for more information. - - - `Optional rankingOptions` - - The ranking options for the file search. If not specified, the file search tool will use the `auto` ranker and a score_threshold of 0. - - See the [file search tool documentation](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) for more information. - - - `double scoreThreshold` - - The score threshold for the file search. All values must be a floating point number between 0 and 1. - - - `Optional ranker` - - The ranker to use for the file search. If not specified will use the `auto` ranker. - - - `AUTO("auto")` - - - `DEFAULT_2024_08_21("default_2024_08_21")` - - - `class FunctionTool:` - - - `FunctionDefinition function` - - - `String name` - - The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. - - - `Optional description` - - A description of what the function does, used by the model to choose when and how to call the function. - - - `Optional parameters` - - The parameters the functions accepts, described as a JSON Schema object. See the [guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. - - Omitting `parameters` defines a function with an empty parameter list. - - - `Optional strict` - - Whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the `parameters` field. Only a subset of JSON Schema is supported when `strict` is `true`. Learn more about Structured Outputs in the [function calling guide](https://platform.openai.com/docs/guides/function-calling). - - - `JsonValue; type "function"constant` - - The type of tool being defined: `function` - - - `FUNCTION("function")` - - - `Optional responseFormat` - - Specifies the format that the model must output. Compatible with [GPT-4o](https://platform.openai.com/docs/models#gpt-4o), [GPT-4 Turbo](https://platform.openai.com/docs/models#gpt-4-turbo-and-gpt-4), and all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`. - - Setting to `{ "type": "json_schema", "json_schema": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema. Learn more in the [Structured Outputs guide](https://platform.openai.com/docs/guides/structured-outputs). - - Setting to `{ "type": "json_object" }` enables JSON mode, which ensures the message the model generates is valid JSON. - - **Important:** when using JSON mode, you **must** also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly "stuck" request. Also note that the message content may be partially cut off if `finish_reason="length"`, which indicates the generation exceeded `max_tokens` or the conversation exceeded the max context length. - - - `JsonValue;` - - - `AUTO("auto")` - - - `class ResponseFormatText:` - - Default response format. Used to generate text responses. - - - `JsonValue; type "text"constant` - - The type of response format being defined. Always `text`. - - - `TEXT("text")` - - - `class ResponseFormatJsonObject:` - - JSON object response format. An older method of generating JSON responses. - Using `json_schema` is recommended for models that support it. Note that the - model will not generate JSON without a system or user message instructing it - to do so. - - - `JsonValue; type "json_object"constant` - - The type of response format being defined. Always `json_object`. - - - `JSON_OBJECT("json_object")` - - - `class ResponseFormatJsonSchema:` - - JSON Schema response format. Used to generate structured JSON responses. - Learn more about [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs). - - - `JsonSchema jsonSchema` - - Structured Outputs configuration options, including a JSON Schema. - - - `String name` - - The name of the response format. Must be a-z, A-Z, 0-9, or contain - underscores and dashes, with a maximum length of 64. - - - `Optional description` - - A description of what the response format is for, used by the model to - determine how to respond in the format. - - - `Optional schema` - - The schema for the response format, described as a JSON Schema object. - Learn how to build JSON schemas [here](https://json-schema.org/). - - - `Optional strict` - - Whether to enable strict schema adherence when generating the output. - If set to true, the model will always follow the exact schema defined - in the `schema` field. Only a subset of JSON Schema is supported when - `strict` is `true`. To learn more, read the [Structured Outputs - guide](https://platform.openai.com/docs/guides/structured-outputs). - - - `JsonValue; type "json_schema"constant` - - The type of response format being defined. Always `json_schema`. - - - `JSON_SCHEMA("json_schema")` - - - `Optional temperature` - - What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. - - - `Optional toolResources` - - A set of resources that are used by the assistant's tools. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs. - - - `Optional codeInterpreter` - - - `Optional> fileIds` - - A list of [file](https://platform.openai.com/docs/api-reference/files) IDs made available to the `code_interpreter`` tool. There can be a maximum of 20 files associated with the tool. - - - `Optional fileSearch` - - - `Optional> vectorStoreIds` - - The ID of the [vector store](https://platform.openai.com/docs/api-reference/vector-stores/object) attached to this assistant. There can be a maximum of 1 vector store attached to the assistant. - - - `Optional topP` - - An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. - - We generally recommend altering this or temperature but not both. - -### Example - -```java -package com.openai.example; - -import com.openai.client.OpenAIClient; -import com.openai.client.okhttp.OpenAIOkHttpClient; -import com.openai.models.beta.assistants.Assistant; -import com.openai.models.beta.assistants.AssistantRetrieveParams; - -public final class Main { - private Main() {} - - public static void main(String[] args) { - OpenAIClient client = OpenAIOkHttpClient.fromEnv(); - - Assistant assistant = client.beta().assistants().retrieve("assistant_id"); - } -} -``` - -#### Response - -```json -{ - "id": "id", - "created_at": 0, - "description": "description", - "instructions": "instructions", - "metadata": { - "foo": "string" - }, - "model": "model", - "name": "name", - "object": "assistant", - "tools": [ - { - "type": "code_interpreter" - } - ], - "response_format": "auto", - "temperature": 1, - "tool_resources": { - "code_interpreter": { - "file_ids": [ - "string" - ] - }, - "file_search": { - "vector_store_ids": [ - "string" - ] - } - }, - "top_p": 1 -} -``` - -## Modify assistant - -`Assistant beta().assistants().update(AssistantUpdateParamsparams = AssistantUpdateParams.none(), RequestOptionsrequestOptions = RequestOptions.none())` - -**post** `/assistants/{assistant_id}` - -Modifies an assistant. - -### Parameters - -- `AssistantUpdateParams params` - - - `Optional assistantId` - - - `Optional description` - - The description of the assistant. The maximum length is 512 characters. - - - `Optional instructions` - - The system instructions that the assistant uses. The maximum length is 256,000 characters. - - - `Optional metadata` - - Set of 16 key-value pairs that can be attached to an object. This can be - useful for storing additional information about the object in a structured - format, and querying for objects via API or the dashboard. - - Keys are strings with a maximum length of 64 characters. Values are strings - with a maximum length of 512 characters. - - - `Optional model` - - ID of the model to use. You can use the [List models](https://platform.openai.com/docs/api-reference/models/list) API to see all of your available models, or see our [Model overview](https://platform.openai.com/docs/models) for descriptions of them. - - - `GPT_5("gpt-5")` - - - `GPT_5_MINI("gpt-5-mini")` - - - `GPT_5_NANO("gpt-5-nano")` - - - `GPT_5_2025_08_07("gpt-5-2025-08-07")` - - - `GPT_5_MINI_2025_08_07("gpt-5-mini-2025-08-07")` - - - `GPT_5_NANO_2025_08_07("gpt-5-nano-2025-08-07")` - - - `GPT_4_1("gpt-4.1")` - - - `GPT_4_1_MINI("gpt-4.1-mini")` - - - `GPT_4_1_NANO("gpt-4.1-nano")` - - - `GPT_4_1_2025_04_14("gpt-4.1-2025-04-14")` - - - `GPT_4_1_MINI_2025_04_14("gpt-4.1-mini-2025-04-14")` - - - `GPT_4_1_NANO_2025_04_14("gpt-4.1-nano-2025-04-14")` - - - `O3_MINI("o3-mini")` - - - `O3_MINI_2025_01_31("o3-mini-2025-01-31")` - - - `O1("o1")` - - - `O1_2024_12_17("o1-2024-12-17")` - - - `GPT_4O("gpt-4o")` - - - `GPT_4O_2024_11_20("gpt-4o-2024-11-20")` - - - `GPT_4O_2024_08_06("gpt-4o-2024-08-06")` - - - `GPT_4O_2024_05_13("gpt-4o-2024-05-13")` - - - `GPT_4O_MINI("gpt-4o-mini")` - - - `GPT_4O_MINI_2024_07_18("gpt-4o-mini-2024-07-18")` - - - `GPT_4_5_PREVIEW("gpt-4.5-preview")` - - - `GPT_4_5_PREVIEW_2025_02_27("gpt-4.5-preview-2025-02-27")` - - - `GPT_4_TURBO("gpt-4-turbo")` - - - `GPT_4_TURBO_2024_04_09("gpt-4-turbo-2024-04-09")` - - - `GPT_4_0125_PREVIEW("gpt-4-0125-preview")` - - - `GPT_4_TURBO_PREVIEW("gpt-4-turbo-preview")` - - - `GPT_4_1106_PREVIEW("gpt-4-1106-preview")` - - - `GPT_4_VISION_PREVIEW("gpt-4-vision-preview")` - - - `GPT_4("gpt-4")` - - - `GPT_4_0314("gpt-4-0314")` - - - `GPT_4_0613("gpt-4-0613")` - - - `GPT_4_32K("gpt-4-32k")` - - - `GPT_4_32K_0314("gpt-4-32k-0314")` - - - `GPT_4_32K_0613("gpt-4-32k-0613")` - - - `GPT_3_5_TURBO("gpt-3.5-turbo")` - - - `GPT_3_5_TURBO_16K("gpt-3.5-turbo-16k")` - - - `GPT_3_5_TURBO_0613("gpt-3.5-turbo-0613")` - - - `GPT_3_5_TURBO_1106("gpt-3.5-turbo-1106")` - - - `GPT_3_5_TURBO_0125("gpt-3.5-turbo-0125")` - - - `GPT_3_5_TURBO_16K_0613("gpt-3.5-turbo-16k-0613")` - - - `Optional name` - - The name of the assistant. The maximum length is 256 characters. - - - `Optional reasoningEffort` - - Constrains effort on reasoning for - [reasoning models](https://platform.openai.com/docs/guides/reasoning). - Currently supported values are `none`, `minimal`, `low`, `medium`, `high`, and `xhigh`. Reducing - reasoning effort can result in faster responses and fewer tokens used - on reasoning in a response. - - - `gpt-5.1` defaults to `none`, which does not perform reasoning. The supported reasoning values for `gpt-5.1` are `none`, `low`, `medium`, and `high`. Tool calls are supported for all reasoning values in gpt-5.1. - - All models before `gpt-5.1` default to `medium` reasoning effort, and do not support `none`. - - The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort. - - `xhigh` is supported for all models after `gpt-5.1-codex-max`. - - - `Optional responseFormat` - - Specifies the format that the model must output. Compatible with [GPT-4o](https://platform.openai.com/docs/models#gpt-4o), [GPT-4 Turbo](https://platform.openai.com/docs/models#gpt-4-turbo-and-gpt-4), and all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`. - - Setting to `{ "type": "json_schema", "json_schema": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema. Learn more in the [Structured Outputs guide](https://platform.openai.com/docs/guides/structured-outputs). - - Setting to `{ "type": "json_object" }` enables JSON mode, which ensures the message the model generates is valid JSON. - - **Important:** when using JSON mode, you **must** also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly "stuck" request. Also note that the message content may be partially cut off if `finish_reason="length"`, which indicates the generation exceeded `max_tokens` or the conversation exceeded the max context length. - - - `Optional temperature` - - What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. - - - `Optional toolResources` - - A set of resources that are used by the assistant's tools. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs. - - - `Optional codeInterpreter` - - - `Optional> fileIds` - - Overrides the list of [file](https://platform.openai.com/docs/api-reference/files) IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files associated with the tool. - - - `Optional fileSearch` - - - `Optional> vectorStoreIds` - - Overrides the [vector store](https://platform.openai.com/docs/api-reference/vector-stores/object) attached to this assistant. There can be a maximum of 1 vector store attached to the assistant. - - - `Optional> tools` - - A list of tool enabled on the assistant. There can be a maximum of 128 tools per assistant. Tools can be of types `code_interpreter`, `file_search`, or `function`. - - - `class CodeInterpreterTool:` - - - `JsonValue; type "code_interpreter"constant` - - The type of tool being defined: `code_interpreter` - - - `CODE_INTERPRETER("code_interpreter")` - - - `class FileSearchTool:` - - - `JsonValue; type "file_search"constant` - - The type of tool being defined: `file_search` - - - `FILE_SEARCH("file_search")` - - - `Optional fileSearch` - - Overrides for the file search tool. - - - `Optional maxNumResults` - - The maximum number of results the file search tool should output. The default is 20 for `gpt-4*` models and 5 for `gpt-3.5-turbo`. This number should be between 1 and 50 inclusive. - - Note that the file search tool may output fewer than `max_num_results` results. See the [file search tool documentation](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) for more information. - - - `Optional rankingOptions` - - The ranking options for the file search. If not specified, the file search tool will use the `auto` ranker and a score_threshold of 0. - - See the [file search tool documentation](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) for more information. - - - `double scoreThreshold` - - The score threshold for the file search. All values must be a floating point number between 0 and 1. - - - `Optional ranker` - - The ranker to use for the file search. If not specified will use the `auto` ranker. - - - `AUTO("auto")` - - - `DEFAULT_2024_08_21("default_2024_08_21")` - - - `class FunctionTool:` - - - `FunctionDefinition function` - - - `String name` - - The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. - - - `Optional description` - - A description of what the function does, used by the model to choose when and how to call the function. - - - `Optional parameters` - - The parameters the functions accepts, described as a JSON Schema object. See the [guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. - - Omitting `parameters` defines a function with an empty parameter list. - - - `Optional strict` - - Whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the `parameters` field. Only a subset of JSON Schema is supported when `strict` is `true`. Learn more about Structured Outputs in the [function calling guide](https://platform.openai.com/docs/guides/function-calling). - - - `JsonValue; type "function"constant` - - The type of tool being defined: `function` - - - `FUNCTION("function")` - - - `Optional topP` - - An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. - - We generally recommend altering this or temperature but not both. - -### Returns - -- `class Assistant:` - - Represents an `assistant` that can call the model and use tools. - - - `String id` - - The identifier, which can be referenced in API endpoints. - - - `long createdAt` - - The Unix timestamp (in seconds) for when the assistant was created. - - - `Optional description` - - The description of the assistant. The maximum length is 512 characters. - - - `Optional instructions` - - The system instructions that the assistant uses. The maximum length is 256,000 characters. - - - `Optional metadata` - - Set of 16 key-value pairs that can be attached to an object. This can be - useful for storing additional information about the object in a structured - format, and querying for objects via API or the dashboard. - - Keys are strings with a maximum length of 64 characters. Values are strings - with a maximum length of 512 characters. - - - `String model` - - ID of the model to use. You can use the [List models](https://platform.openai.com/docs/api-reference/models/list) API to see all of your available models, or see our [Model overview](https://platform.openai.com/docs/models) for descriptions of them. - - - `Optional name` - - The name of the assistant. The maximum length is 256 characters. - - - `JsonValue; object_ "assistant"constant` - - The object type, which is always `assistant`. - - - `ASSISTANT("assistant")` - - - `List tools` - - A list of tool enabled on the assistant. There can be a maximum of 128 tools per assistant. Tools can be of types `code_interpreter`, `file_search`, or `function`. - - - `class CodeInterpreterTool:` - - - `JsonValue; type "code_interpreter"constant` - - The type of tool being defined: `code_interpreter` - - - `CODE_INTERPRETER("code_interpreter")` - - - `class FileSearchTool:` - - - `JsonValue; type "file_search"constant` - - The type of tool being defined: `file_search` - - - `FILE_SEARCH("file_search")` - - - `Optional fileSearch` - - Overrides for the file search tool. - - - `Optional maxNumResults` - - The maximum number of results the file search tool should output. The default is 20 for `gpt-4*` models and 5 for `gpt-3.5-turbo`. This number should be between 1 and 50 inclusive. - - Note that the file search tool may output fewer than `max_num_results` results. See the [file search tool documentation](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) for more information. - - - `Optional rankingOptions` - - The ranking options for the file search. If not specified, the file search tool will use the `auto` ranker and a score_threshold of 0. - - See the [file search tool documentation](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) for more information. - - - `double scoreThreshold` - - The score threshold for the file search. All values must be a floating point number between 0 and 1. - - - `Optional ranker` - - The ranker to use for the file search. If not specified will use the `auto` ranker. - - - `AUTO("auto")` - - - `DEFAULT_2024_08_21("default_2024_08_21")` - - - `class FunctionTool:` - - - `FunctionDefinition function` - - - `String name` - - The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. - - - `Optional description` - - A description of what the function does, used by the model to choose when and how to call the function. - - - `Optional parameters` - - The parameters the functions accepts, described as a JSON Schema object. See the [guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. - - Omitting `parameters` defines a function with an empty parameter list. - - - `Optional strict` - - Whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the `parameters` field. Only a subset of JSON Schema is supported when `strict` is `true`. Learn more about Structured Outputs in the [function calling guide](https://platform.openai.com/docs/guides/function-calling). - - - `JsonValue; type "function"constant` - - The type of tool being defined: `function` - - - `FUNCTION("function")` - - - `Optional responseFormat` - - Specifies the format that the model must output. Compatible with [GPT-4o](https://platform.openai.com/docs/models#gpt-4o), [GPT-4 Turbo](https://platform.openai.com/docs/models#gpt-4-turbo-and-gpt-4), and all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`. - - Setting to `{ "type": "json_schema", "json_schema": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema. Learn more in the [Structured Outputs guide](https://platform.openai.com/docs/guides/structured-outputs). - - Setting to `{ "type": "json_object" }` enables JSON mode, which ensures the message the model generates is valid JSON. - - **Important:** when using JSON mode, you **must** also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly "stuck" request. Also note that the message content may be partially cut off if `finish_reason="length"`, which indicates the generation exceeded `max_tokens` or the conversation exceeded the max context length. - - - `JsonValue;` - - - `AUTO("auto")` - - - `class ResponseFormatText:` - - Default response format. Used to generate text responses. - - - `JsonValue; type "text"constant` - - The type of response format being defined. Always `text`. - - - `TEXT("text")` - - - `class ResponseFormatJsonObject:` - - JSON object response format. An older method of generating JSON responses. - Using `json_schema` is recommended for models that support it. Note that the - model will not generate JSON without a system or user message instructing it - to do so. - - - `JsonValue; type "json_object"constant` - - The type of response format being defined. Always `json_object`. - - - `JSON_OBJECT("json_object")` - - - `class ResponseFormatJsonSchema:` - - JSON Schema response format. Used to generate structured JSON responses. - Learn more about [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs). - - - `JsonSchema jsonSchema` - - Structured Outputs configuration options, including a JSON Schema. - - - `String name` - - The name of the response format. Must be a-z, A-Z, 0-9, or contain - underscores and dashes, with a maximum length of 64. - - - `Optional description` - - A description of what the response format is for, used by the model to - determine how to respond in the format. - - - `Optional schema` - - The schema for the response format, described as a JSON Schema object. - Learn how to build JSON schemas [here](https://json-schema.org/). - - - `Optional strict` - - Whether to enable strict schema adherence when generating the output. - If set to true, the model will always follow the exact schema defined - in the `schema` field. Only a subset of JSON Schema is supported when - `strict` is `true`. To learn more, read the [Structured Outputs - guide](https://platform.openai.com/docs/guides/structured-outputs). - - - `JsonValue; type "json_schema"constant` - - The type of response format being defined. Always `json_schema`. - - - `JSON_SCHEMA("json_schema")` - - - `Optional temperature` - - What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. - - - `Optional toolResources` - - A set of resources that are used by the assistant's tools. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs. - - - `Optional codeInterpreter` - - - `Optional> fileIds` - - A list of [file](https://platform.openai.com/docs/api-reference/files) IDs made available to the `code_interpreter`` tool. There can be a maximum of 20 files associated with the tool. - - - `Optional fileSearch` - - - `Optional> vectorStoreIds` - - The ID of the [vector store](https://platform.openai.com/docs/api-reference/vector-stores/object) attached to this assistant. There can be a maximum of 1 vector store attached to the assistant. - - - `Optional topP` - - An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. - - We generally recommend altering this or temperature but not both. - -### Example - -```java -package com.openai.example; - -import com.openai.client.OpenAIClient; -import com.openai.client.okhttp.OpenAIOkHttpClient; -import com.openai.models.beta.assistants.Assistant; -import com.openai.models.beta.assistants.AssistantUpdateParams; - -public final class Main { - private Main() {} - - public static void main(String[] args) { - OpenAIClient client = OpenAIOkHttpClient.fromEnv(); - - Assistant assistant = client.beta().assistants().update("assistant_id"); - } -} -``` - -#### Response - -```json -{ - "id": "id", - "created_at": 0, - "description": "description", - "instructions": "instructions", - "metadata": { - "foo": "string" - }, - "model": "model", - "name": "name", - "object": "assistant", - "tools": [ - { - "type": "code_interpreter" - } - ], - "response_format": "auto", - "temperature": 1, - "tool_resources": { - "code_interpreter": { - "file_ids": [ - "string" - ] - }, - "file_search": { - "vector_store_ids": [ - "string" - ] - } - }, - "top_p": 1 -} -``` - -## Delete assistant - -`AssistantDeleted beta().assistants().delete(AssistantDeleteParamsparams = AssistantDeleteParams.none(), RequestOptionsrequestOptions = RequestOptions.none())` - -**delete** `/assistants/{assistant_id}` - -Delete an assistant. - -### Parameters - -- `AssistantDeleteParams params` - - - `Optional assistantId` - -### Returns - -- `class AssistantDeleted:` - - - `String id` - - - `boolean deleted` - - - `JsonValue; object_ "assistant.deleted"constant` - - - `ASSISTANT_DELETED("assistant.deleted")` - -### Example - -```java -package com.openai.example; - -import com.openai.client.OpenAIClient; -import com.openai.client.okhttp.OpenAIOkHttpClient; -import com.openai.models.beta.assistants.AssistantDeleteParams; -import com.openai.models.beta.assistants.AssistantDeleted; - -public final class Main { - private Main() {} - - public static void main(String[] args) { - OpenAIClient client = OpenAIOkHttpClient.fromEnv(); - - AssistantDeleted assistantDeleted = client.beta().assistants().delete("assistant_id"); - } -} -``` - -#### Response - -```json -{ - "id": "id", - "deleted": true, - "object": "assistant.deleted" -} -``` - -## Domain Types - -### Assistant - -- `class Assistant:` - - Represents an `assistant` that can call the model and use tools. - - - `String id` - - The identifier, which can be referenced in API endpoints. - - - `long createdAt` - - The Unix timestamp (in seconds) for when the assistant was created. - - - `Optional description` - - The description of the assistant. The maximum length is 512 characters. - - - `Optional instructions` - - The system instructions that the assistant uses. The maximum length is 256,000 characters. - - - `Optional metadata` - - Set of 16 key-value pairs that can be attached to an object. This can be - useful for storing additional information about the object in a structured - format, and querying for objects via API or the dashboard. - - Keys are strings with a maximum length of 64 characters. Values are strings - with a maximum length of 512 characters. - - - `String model` - - ID of the model to use. You can use the [List models](https://platform.openai.com/docs/api-reference/models/list) API to see all of your available models, or see our [Model overview](https://platform.openai.com/docs/models) for descriptions of them. - - - `Optional name` - - The name of the assistant. The maximum length is 256 characters. - - - `JsonValue; object_ "assistant"constant` - - The object type, which is always `assistant`. - - - `ASSISTANT("assistant")` - - - `List tools` - - A list of tool enabled on the assistant. There can be a maximum of 128 tools per assistant. Tools can be of types `code_interpreter`, `file_search`, or `function`. - - - `class CodeInterpreterTool:` - - - `JsonValue; type "code_interpreter"constant` - - The type of tool being defined: `code_interpreter` - - - `CODE_INTERPRETER("code_interpreter")` - - - `class FileSearchTool:` - - - `JsonValue; type "file_search"constant` - - The type of tool being defined: `file_search` - - - `FILE_SEARCH("file_search")` - - - `Optional fileSearch` - - Overrides for the file search tool. - - - `Optional maxNumResults` - - The maximum number of results the file search tool should output. The default is 20 for `gpt-4*` models and 5 for `gpt-3.5-turbo`. This number should be between 1 and 50 inclusive. - - Note that the file search tool may output fewer than `max_num_results` results. See the [file search tool documentation](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) for more information. - - - `Optional rankingOptions` - - The ranking options for the file search. If not specified, the file search tool will use the `auto` ranker and a score_threshold of 0. - - See the [file search tool documentation](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) for more information. - - - `double scoreThreshold` - - The score threshold for the file search. All values must be a floating point number between 0 and 1. - - - `Optional ranker` - - The ranker to use for the file search. If not specified will use the `auto` ranker. - - - `AUTO("auto")` - - - `DEFAULT_2024_08_21("default_2024_08_21")` - - - `class FunctionTool:` - - - `FunctionDefinition function` - - - `String name` - - The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. - - - `Optional description` - - A description of what the function does, used by the model to choose when and how to call the function. - - - `Optional parameters` - - The parameters the functions accepts, described as a JSON Schema object. See the [guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. - - Omitting `parameters` defines a function with an empty parameter list. - - - `Optional strict` - - Whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the `parameters` field. Only a subset of JSON Schema is supported when `strict` is `true`. Learn more about Structured Outputs in the [function calling guide](https://platform.openai.com/docs/guides/function-calling). - - - `JsonValue; type "function"constant` - - The type of tool being defined: `function` - - - `FUNCTION("function")` - - - `Optional responseFormat` - - Specifies the format that the model must output. Compatible with [GPT-4o](https://platform.openai.com/docs/models#gpt-4o), [GPT-4 Turbo](https://platform.openai.com/docs/models#gpt-4-turbo-and-gpt-4), and all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`. - - Setting to `{ "type": "json_schema", "json_schema": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema. Learn more in the [Structured Outputs guide](https://platform.openai.com/docs/guides/structured-outputs). - - Setting to `{ "type": "json_object" }` enables JSON mode, which ensures the message the model generates is valid JSON. - - **Important:** when using JSON mode, you **must** also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly "stuck" request. Also note that the message content may be partially cut off if `finish_reason="length"`, which indicates the generation exceeded `max_tokens` or the conversation exceeded the max context length. - - - `JsonValue;` - - - `AUTO("auto")` - - - `class ResponseFormatText:` - - Default response format. Used to generate text responses. - - - `JsonValue; type "text"constant` - - The type of response format being defined. Always `text`. - - - `TEXT("text")` - - - `class ResponseFormatJsonObject:` - - JSON object response format. An older method of generating JSON responses. - Using `json_schema` is recommended for models that support it. Note that the - model will not generate JSON without a system or user message instructing it - to do so. - - - `JsonValue; type "json_object"constant` - - The type of response format being defined. Always `json_object`. - - - `JSON_OBJECT("json_object")` - - - `class ResponseFormatJsonSchema:` - - JSON Schema response format. Used to generate structured JSON responses. - Learn more about [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs). - - - `JsonSchema jsonSchema` - - Structured Outputs configuration options, including a JSON Schema. - - - `String name` - - The name of the response format. Must be a-z, A-Z, 0-9, or contain - underscores and dashes, with a maximum length of 64. - - - `Optional description` - - A description of what the response format is for, used by the model to - determine how to respond in the format. - - - `Optional schema` - - The schema for the response format, described as a JSON Schema object. - Learn how to build JSON schemas [here](https://json-schema.org/). - - - `Optional strict` - - Whether to enable strict schema adherence when generating the output. - If set to true, the model will always follow the exact schema defined - in the `schema` field. Only a subset of JSON Schema is supported when - `strict` is `true`. To learn more, read the [Structured Outputs - guide](https://platform.openai.com/docs/guides/structured-outputs). - - - `JsonValue; type "json_schema"constant` - - The type of response format being defined. Always `json_schema`. - - - `JSON_SCHEMA("json_schema")` - - - `Optional temperature` - - What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. - - - `Optional toolResources` - - A set of resources that are used by the assistant's tools. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs. - - - `Optional codeInterpreter` - - - `Optional> fileIds` - - A list of [file](https://platform.openai.com/docs/api-reference/files) IDs made available to the `code_interpreter`` tool. There can be a maximum of 20 files associated with the tool. - - - `Optional fileSearch` - - - `Optional> vectorStoreIds` - - The ID of the [vector store](https://platform.openai.com/docs/api-reference/vector-stores/object) attached to this assistant. There can be a maximum of 1 vector store attached to the assistant. - - - `Optional topP` - - An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. - - We generally recommend altering this or temperature but not both. - -### Assistant Deleted - -- `class AssistantDeleted:` - - - `String id` - - - `boolean deleted` - - - `JsonValue; object_ "assistant.deleted"constant` - - - `ASSISTANT_DELETED("assistant.deleted")` - -### Assistant Stream Event - -- `class AssistantStreamEvent: A class that can be one of several variants.union` - - Represents an event emitted when streaming a Run. - - Each event in a server-sent events stream has an `event` and `data` property: - - ``` - event: thread.created - data: {"id": "thread_123", "object": "thread", ...} - ``` - - We emit events whenever a new object is created, transitions to a new state, or is being - streamed in parts (deltas). For example, we emit `thread.run.created` when a new run - is created, `thread.run.completed` when a run completes, and so on. When an Assistant chooses - to create a message during a run, we emit a `thread.message.created event`, a - `thread.message.in_progress` event, many `thread.message.delta` events, and finally a - `thread.message.completed` event. - - We may add additional events over time, so we recommend handling unknown events gracefully - in your code. See the [Assistants API quickstart](https://platform.openai.com/docs/assistants/overview) to learn how to - integrate the Assistants API with streaming. - - - `ThreadCreated` - - - `Thread data` - - Represents a thread that contains [messages](https://platform.openai.com/docs/api-reference/messages). - - - `String id` - - The identifier, which can be referenced in API endpoints. - - - `long createdAt` - - The Unix timestamp (in seconds) for when the thread was created. - - - `Optional metadata` - - Set of 16 key-value pairs that can be attached to an object. This can be - useful for storing additional information about the object in a structured - format, and querying for objects via API or the dashboard. - - Keys are strings with a maximum length of 64 characters. Values are strings - with a maximum length of 512 characters. - - - `JsonValue; object_ "thread"constant` - - The object type, which is always `thread`. - - - `THREAD("thread")` - - - `Optional toolResources` - - A set of resources that are made available to the assistant's tools in this thread. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs. - - - `Optional codeInterpreter` - - - `Optional> fileIds` - - A list of [file](https://platform.openai.com/docs/api-reference/files) IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files associated with the tool. - - - `Optional fileSearch` - - - `Optional> vectorStoreIds` - - The [vector store](https://platform.openai.com/docs/api-reference/vector-stores/object) attached to this thread. There can be a maximum of 1 vector store attached to the thread. - - - `JsonValue; event "thread.created"constant` - - - `THREAD_CREATED("thread.created")` - - - `Optional enabled` - - Whether to enable input audio transcription. - - - `ThreadRunCreated` - - - `Run data` - - Represents an execution run on a [thread](https://platform.openai.com/docs/api-reference/threads). - - - `String id` - - The identifier, which can be referenced in API endpoints. - - - `String assistantId` - - The ID of the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for execution of this run. - - - `Optional cancelledAt` - - The Unix timestamp (in seconds) for when the run was cancelled. - - - `Optional completedAt` - - The Unix timestamp (in seconds) for when the run was completed. - - - `long createdAt` - - The Unix timestamp (in seconds) for when the run was created. - - - `Optional expiresAt` - - The Unix timestamp (in seconds) for when the run will expire. - - - `Optional failedAt` - - The Unix timestamp (in seconds) for when the run failed. - - - `Optional incompleteDetails` - - Details on why the run is incomplete. Will be `null` if the run is not incomplete. - - - `Optional reason` - - The reason why the run is incomplete. This will point to which specific token limit was reached over the course of the run. - - - `MAX_COMPLETION_TOKENS("max_completion_tokens")` - - - `MAX_PROMPT_TOKENS("max_prompt_tokens")` - - - `String instructions` - - The instructions that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run. - - - `Optional lastError` - - The last error associated with this run. Will be `null` if there are no errors. - - - `Code code` - - One of `server_error`, `rate_limit_exceeded`, or `invalid_prompt`. - - - `SERVER_ERROR("server_error")` - - - `RATE_LIMIT_EXCEEDED("rate_limit_exceeded")` - - - `INVALID_PROMPT("invalid_prompt")` - - - `String message` - - A human-readable description of the error. - - - `Optional maxCompletionTokens` - - The maximum number of completion tokens specified to have been used over the course of the run. - - - `Optional maxPromptTokens` - - The maximum number of prompt tokens specified to have been used over the course of the run. - - - `Optional metadata` - - Set of 16 key-value pairs that can be attached to an object. This can be - useful for storing additional information about the object in a structured - format, and querying for objects via API or the dashboard. - - Keys are strings with a maximum length of 64 characters. Values are strings - with a maximum length of 512 characters. - - - `String model` - - The model that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run. - - - `JsonValue; object_ "thread.run"constant` - - The object type, which is always `thread.run`. - - - `THREAD_RUN("thread.run")` - - - `boolean parallelToolCalls` - - Whether to enable [parallel function calling](https://platform.openai.com/docs/guides/function-calling#configuring-parallel-function-calling) during tool use. - - - `Optional requiredAction` - - Details on the action required to continue the run. Will be `null` if no action is required. - - - `SubmitToolOutputs submitToolOutputs` - - Details on the tool outputs needed for this run to continue. - - - `List toolCalls` - - A list of the relevant tool calls. - - - `String id` - - The ID of the tool call. This ID must be referenced when you submit the tool outputs in using the [Submit tool outputs to run](https://platform.openai.com/docs/api-reference/runs/submitToolOutputs) endpoint. - - - `Function function` - - The function definition. - - - `String arguments` - - The arguments that the model expects you to pass to the function. - - - `String name` - - The name of the function. - - - `JsonValue; type "function"constant` - - The type of tool call the output is required for. For now, this is always `function`. - - - `FUNCTION("function")` - - - `JsonValue; type "submit_tool_outputs"constant` - - For now, this is always `submit_tool_outputs`. - - - `SUBMIT_TOOL_OUTPUTS("submit_tool_outputs")` - - - `Optional responseFormat` - - Specifies the format that the model must output. Compatible with [GPT-4o](https://platform.openai.com/docs/models#gpt-4o), [GPT-4 Turbo](https://platform.openai.com/docs/models#gpt-4-turbo-and-gpt-4), and all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`. - - Setting to `{ "type": "json_schema", "json_schema": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema. Learn more in the [Structured Outputs guide](https://platform.openai.com/docs/guides/structured-outputs). - - Setting to `{ "type": "json_object" }` enables JSON mode, which ensures the message the model generates is valid JSON. - - **Important:** when using JSON mode, you **must** also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly "stuck" request. Also note that the message content may be partially cut off if `finish_reason="length"`, which indicates the generation exceeded `max_tokens` or the conversation exceeded the max context length. - - - `JsonValue;` - - - `AUTO("auto")` - - - `class ResponseFormatText:` - - Default response format. Used to generate text responses. - - - `JsonValue; type "text"constant` - - The type of response format being defined. Always `text`. - - - `TEXT("text")` - - - `class ResponseFormatJsonObject:` - - JSON object response format. An older method of generating JSON responses. - Using `json_schema` is recommended for models that support it. Note that the - model will not generate JSON without a system or user message instructing it - to do so. - - - `JsonValue; type "json_object"constant` - - The type of response format being defined. Always `json_object`. - - - `JSON_OBJECT("json_object")` - - - `class ResponseFormatJsonSchema:` - - JSON Schema response format. Used to generate structured JSON responses. - Learn more about [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs). - - - `JsonSchema jsonSchema` - - Structured Outputs configuration options, including a JSON Schema. - - - `String name` - - The name of the response format. Must be a-z, A-Z, 0-9, or contain - underscores and dashes, with a maximum length of 64. - - - `Optional description` - - A description of what the response format is for, used by the model to - determine how to respond in the format. - - - `Optional schema` - - The schema for the response format, described as a JSON Schema object. - Learn how to build JSON schemas [here](https://json-schema.org/). - - - `Optional strict` - - Whether to enable strict schema adherence when generating the output. - If set to true, the model will always follow the exact schema defined - in the `schema` field. Only a subset of JSON Schema is supported when - `strict` is `true`. To learn more, read the [Structured Outputs - guide](https://platform.openai.com/docs/guides/structured-outputs). - - - `JsonValue; type "json_schema"constant` - - The type of response format being defined. Always `json_schema`. - - - `JSON_SCHEMA("json_schema")` - - - `Optional startedAt` - - The Unix timestamp (in seconds) for when the run was started. - - - `RunStatus status` - - The status of the run, which can be either `queued`, `in_progress`, `requires_action`, `cancelling`, `cancelled`, `failed`, `completed`, `incomplete`, or `expired`. - - - `QUEUED("queued")` - - - `IN_PROGRESS("in_progress")` - - - `REQUIRES_ACTION("requires_action")` - - - `CANCELLING("cancelling")` - - - `CANCELLED("cancelled")` - - - `FAILED("failed")` - - - `COMPLETED("completed")` - - - `INCOMPLETE("incomplete")` - - - `EXPIRED("expired")` - - - `String threadId` - - The ID of the [thread](https://platform.openai.com/docs/api-reference/threads) that was executed on as a part of this run. - - - `Optional toolChoice` - - 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. - - - `Auto` - - - `NONE("none")` - - - `AUTO("auto")` - - - `REQUIRED("required")` - - - `class AssistantToolChoice:` - - Specifies a tool the model should use. Use to force the model to call a specific tool. - - - `Type type` - - The type of the tool. If type is `function`, the function name must be set - - - `FUNCTION("function")` - - - `CODE_INTERPRETER("code_interpreter")` - - - `FILE_SEARCH("file_search")` - - - `Optional function` - - - `String name` - - The name of the function to call. - - - `List tools` - - The list of tools that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run. - - - `class CodeInterpreterTool:` - - - `JsonValue; type "code_interpreter"constant` - - The type of tool being defined: `code_interpreter` - - - `CODE_INTERPRETER("code_interpreter")` - - - `class FileSearchTool:` - - - `JsonValue; type "file_search"constant` - - The type of tool being defined: `file_search` - - - `FILE_SEARCH("file_search")` - - - `Optional fileSearch` - - Overrides for the file search tool. - - - `Optional maxNumResults` - - The maximum number of results the file search tool should output. The default is 20 for `gpt-4*` models and 5 for `gpt-3.5-turbo`. This number should be between 1 and 50 inclusive. - - Note that the file search tool may output fewer than `max_num_results` results. See the [file search tool documentation](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) for more information. - - - `Optional rankingOptions` - - The ranking options for the file search. If not specified, the file search tool will use the `auto` ranker and a score_threshold of 0. - - See the [file search tool documentation](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) for more information. - - - `double scoreThreshold` - - The score threshold for the file search. All values must be a floating point number between 0 and 1. - - - `Optional ranker` - - The ranker to use for the file search. If not specified will use the `auto` ranker. - - - `AUTO("auto")` - - - `DEFAULT_2024_08_21("default_2024_08_21")` - - - `class FunctionTool:` - - - `FunctionDefinition function` - - - `String name` - - The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. - - - `Optional description` - - A description of what the function does, used by the model to choose when and how to call the function. - - - `Optional parameters` - - The parameters the functions accepts, described as a JSON Schema object. See the [guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. - - Omitting `parameters` defines a function with an empty parameter list. - - - `Optional strict` - - Whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the `parameters` field. Only a subset of JSON Schema is supported when `strict` is `true`. Learn more about Structured Outputs in the [function calling guide](https://platform.openai.com/docs/guides/function-calling). - - - `JsonValue; type "function"constant` - - The type of tool being defined: `function` - - - `FUNCTION("function")` - - - `Optional truncationStrategy` - - Controls for how a thread will be truncated prior to the run. Use this to control the initial context window of the run. - - - `Type type` - - The truncation strategy to use for the thread. The default is `auto`. If set to `last_messages`, the thread will be truncated to the n most recent messages in the thread. When set to `auto`, messages in the middle of the thread will be dropped to fit the context length of the model, `max_prompt_tokens`. - - - `AUTO("auto")` - - - `LAST_MESSAGES("last_messages")` - - - `Optional lastMessages` - - The number of most recent messages from the thread when constructing the context for the run. - - - `Optional usage` - - Usage statistics related to the run. This value will be `null` if the run is not in a terminal state (i.e. `in_progress`, `queued`, etc.). - - - `long completionTokens` - - Number of completion tokens used over the course of the run. - - - `long promptTokens` - - Number of prompt tokens used over the course of the run. - - - `long totalTokens` - - Total number of tokens used (prompt + completion). - - - `Optional temperature` - - The sampling temperature used for this run. If not set, defaults to 1. - - - `Optional topP` - - The nucleus sampling value used for this run. If not set, defaults to 1. - - - `JsonValue; event "thread.run.created"constant` - - - `THREAD_RUN_CREATED("thread.run.created")` - - - `ThreadRunQueued` - - - `Run data` - - Represents an execution run on a [thread](https://platform.openai.com/docs/api-reference/threads). - - - `JsonValue; event "thread.run.queued"constant` - - - `THREAD_RUN_QUEUED("thread.run.queued")` - - - `ThreadRunInProgress` - - - `Run data` - - Represents an execution run on a [thread](https://platform.openai.com/docs/api-reference/threads). - - - `JsonValue; event "thread.run.in_progress"constant` - - - `THREAD_RUN_IN_PROGRESS("thread.run.in_progress")` - - - `ThreadRunRequiresAction` - - - `Run data` - - Represents an execution run on a [thread](https://platform.openai.com/docs/api-reference/threads). - - - `JsonValue; event "thread.run.requires_action"constant` - - - `THREAD_RUN_REQUIRES_ACTION("thread.run.requires_action")` - - - `ThreadRunCompleted` - - - `Run data` - - Represents an execution run on a [thread](https://platform.openai.com/docs/api-reference/threads). - - - `JsonValue; event "thread.run.completed"constant` - - - `THREAD_RUN_COMPLETED("thread.run.completed")` - - - `ThreadRunIncomplete` - - - `Run data` - - Represents an execution run on a [thread](https://platform.openai.com/docs/api-reference/threads). - - - `JsonValue; event "thread.run.incomplete"constant` - - - `THREAD_RUN_INCOMPLETE("thread.run.incomplete")` - - - `ThreadRunFailed` - - - `Run data` - - Represents an execution run on a [thread](https://platform.openai.com/docs/api-reference/threads). - - - `JsonValue; event "thread.run.failed"constant` - - - `THREAD_RUN_FAILED("thread.run.failed")` - - - `ThreadRunCancelling` - - - `Run data` - - Represents an execution run on a [thread](https://platform.openai.com/docs/api-reference/threads). - - - `JsonValue; event "thread.run.cancelling"constant` - - - `THREAD_RUN_CANCELLING("thread.run.cancelling")` - - - `ThreadRunCancelled` - - - `Run data` - - Represents an execution run on a [thread](https://platform.openai.com/docs/api-reference/threads). - - - `JsonValue; event "thread.run.cancelled"constant` - - - `THREAD_RUN_CANCELLED("thread.run.cancelled")` - - - `ThreadRunExpired` - - - `Run data` - - Represents an execution run on a [thread](https://platform.openai.com/docs/api-reference/threads). - - - `JsonValue; event "thread.run.expired"constant` - - - `THREAD_RUN_EXPIRED("thread.run.expired")` - - - `ThreadRunStepCreated` - - - `RunStep data` - - Represents a step in execution of a run. - - - `String id` - - The identifier of the run step, which can be referenced in API endpoints. - - - `String assistantId` - - The ID of the [assistant](https://platform.openai.com/docs/api-reference/assistants) associated with the run step. - - - `Optional cancelledAt` - - The Unix timestamp (in seconds) for when the run step was cancelled. - - - `Optional completedAt` - - The Unix timestamp (in seconds) for when the run step completed. - - - `long createdAt` - - The Unix timestamp (in seconds) for when the run step was created. - - - `Optional expiredAt` - - The Unix timestamp (in seconds) for when the run step expired. A step is considered expired if the parent run is expired. - - - `Optional failedAt` - - The Unix timestamp (in seconds) for when the run step failed. - - - `Optional lastError` - - The last error associated with this run step. Will be `null` if there are no errors. - - - `Code code` - - One of `server_error` or `rate_limit_exceeded`. - - - `SERVER_ERROR("server_error")` - - - `RATE_LIMIT_EXCEEDED("rate_limit_exceeded")` - - - `String message` - - A human-readable description of the error. - - - `Optional metadata` - - Set of 16 key-value pairs that can be attached to an object. This can be - useful for storing additional information about the object in a structured - format, and querying for objects via API or the dashboard. - - Keys are strings with a maximum length of 64 characters. Values are strings - with a maximum length of 512 characters. - - - `JsonValue; object_ "thread.run.step"constant` - - The object type, which is always `thread.run.step`. - - - `THREAD_RUN_STEP("thread.run.step")` - - - `String runId` - - The ID of the [run](https://platform.openai.com/docs/api-reference/runs) that this run step is a part of. - - - `Status status` - - The status of the run step, which can be either `in_progress`, `cancelled`, `failed`, `completed`, or `expired`. - - - `IN_PROGRESS("in_progress")` - - - `CANCELLED("cancelled")` - - - `FAILED("failed")` - - - `COMPLETED("completed")` - - - `EXPIRED("expired")` - - - `StepDetails stepDetails` - - The details of the run step. - - - `class MessageCreationStepDetails:` - - Details of the message creation by the run step. - - - `MessageCreation messageCreation` - - - `String messageId` - - The ID of the message that was created by this run step. - - - `JsonValue; type "message_creation"constant` - - Always `message_creation`. - - - `MESSAGE_CREATION("message_creation")` - - - `class ToolCallsStepDetails:` - - Details of the tool call. - - - `List toolCalls` - - An array of tool calls the run step was involved in. These can be associated with one of three types of tools: `code_interpreter`, `file_search`, or `function`. - - - `class CodeInterpreterToolCall:` - - Details of the Code Interpreter tool call the run step was involved in. - - - `String id` - - The ID of the tool call. - - - `CodeInterpreter codeInterpreter` - - The Code Interpreter tool call definition. - - - `String input` - - The input to the Code Interpreter tool call. - - - `List outputs` - - The outputs from the Code Interpreter tool call. Code Interpreter can output one or more items, including text (`logs`) or images (`image`). Each of these are represented by a different object type. - - - `class LogsOutput:` - - Text output from the Code Interpreter tool call as part of a run step. - - - `String logs` - - The text output from the Code Interpreter tool call. - - - `JsonValue; type "logs"constant` - - Always `logs`. - - - `LOGS("logs")` - - - `class ImageOutput:` - - - `Image image` - - - `String fileId` - - The [file](https://platform.openai.com/docs/api-reference/files) ID of the image. - - - `JsonValue; type "image"constant` - - Always `image`. - - - `IMAGE("image")` - - - `JsonValue; type "code_interpreter"constant` - - The type of tool call. This is always going to be `code_interpreter` for this type of tool call. - - - `CODE_INTERPRETER("code_interpreter")` - - - `class FileSearchToolCall:` - - - `String id` - - The ID of the tool call object. - - - `FileSearch fileSearch` - - For now, this is always going to be an empty object. - - - `Optional rankingOptions` - - The ranking options for the file search. - - - `Ranker ranker` - - The ranker to use for the file search. If not specified will use the `auto` ranker. - - - `AUTO("auto")` - - - `DEFAULT_2024_08_21("default_2024_08_21")` - - - `double scoreThreshold` - - The score threshold for the file search. All values must be a floating point number between 0 and 1. - - - `Optional> results` - - The results of the file search. - - - `String fileId` - - The ID of the file that result was found in. - - - `String fileName` - - The name of the file that result was found in. - - - `double score` - - The score of the result. All values must be a floating point number between 0 and 1. - - - `Optional> content` - - The content of the result that was found. The content is only included if requested via the include query parameter. - - - `Optional text` - - The text content of the file. - - - `Optional type` - - The type of the content. - - - `TEXT("text")` - - - `JsonValue; type "file_search"constant` - - The type of tool call. This is always going to be `file_search` for this type of tool call. - - - `FILE_SEARCH("file_search")` - - - `class FunctionToolCall:` - - - `String id` - - The ID of the tool call object. - - - `Function function` - - The definition of the function that was called. - - - `String arguments` - - The arguments passed to the function. - - - `String name` - - The name of the function. - - - `Optional output` - - The output of the function. This will be `null` if the outputs have not been [submitted](https://platform.openai.com/docs/api-reference/runs/submitToolOutputs) yet. - - - `JsonValue; type "function"constant` - - The type of tool call. This is always going to be `function` for this type of tool call. - - - `FUNCTION("function")` - - - `JsonValue; type "tool_calls"constant` - - Always `tool_calls`. - - - `TOOL_CALLS("tool_calls")` - - - `String threadId` - - The ID of the [thread](https://platform.openai.com/docs/api-reference/threads) that was run. - - - `Type type` - - The type of run step, which can be either `message_creation` or `tool_calls`. - - - `MESSAGE_CREATION("message_creation")` - - - `TOOL_CALLS("tool_calls")` - - - `Optional usage` - - Usage statistics related to the run step. This value will be `null` while the run step's status is `in_progress`. - - - `long completionTokens` - - Number of completion tokens used over the course of the run step. - - - `long promptTokens` - - Number of prompt tokens used over the course of the run step. - - - `long totalTokens` - - Total number of tokens used (prompt + completion). - - - `JsonValue; event "thread.run.step.created"constant` - - - `THREAD_RUN_STEP_CREATED("thread.run.step.created")` - - - `ThreadRunStepInProgress` - - - `RunStep data` - - Represents a step in execution of a run. - - - `JsonValue; event "thread.run.step.in_progress"constant` - - - `THREAD_RUN_STEP_IN_PROGRESS("thread.run.step.in_progress")` - - - `ThreadRunStepDelta` - - - `RunStepDeltaEvent data` - - Represents a run step delta i.e. any changed fields on a run step during streaming. - - - `String id` - - The identifier of the run step, which can be referenced in API endpoints. - - - `RunStepDelta delta` - - The delta containing the fields that have changed on the run step. - - - `Optional stepDetails` - - The details of the run step. - - - `class RunStepDeltaMessageDelta:` - - Details of the message creation by the run step. - - - `JsonValue; type "message_creation"constant` - - Always `message_creation`. - - - `MESSAGE_CREATION("message_creation")` - - - `Optional messageCreation` - - - `Optional messageId` - - The ID of the message that was created by this run step. - - - `class ToolCallDeltaObject:` - - Details of the tool call. - - - `JsonValue; type "tool_calls"constant` - - Always `tool_calls`. - - - `TOOL_CALLS("tool_calls")` - - - `Optional> toolCalls` - - An array of tool calls the run step was involved in. These can be associated with one of three types of tools: `code_interpreter`, `file_search`, or `function`. - - - `class CodeInterpreterToolCallDelta:` - - Details of the Code Interpreter tool call the run step was involved in. - - - `long index` - - The index of the tool call in the tool calls array. - - - `JsonValue; type "code_interpreter"constant` - - The type of tool call. This is always going to be `code_interpreter` for this type of tool call. - - - `CODE_INTERPRETER("code_interpreter")` - - - `Optional id` - - The ID of the tool call. - - - `Optional codeInterpreter` - - The Code Interpreter tool call definition. - - - `Optional input` - - The input to the Code Interpreter tool call. - - - `Optional> outputs` - - The outputs from the Code Interpreter tool call. Code Interpreter can output one or more items, including text (`logs`) or images (`image`). Each of these are represented by a different object type. - - - `class CodeInterpreterLogs:` - - Text output from the Code Interpreter tool call as part of a run step. - - - `long index` - - The index of the output in the outputs array. - - - `JsonValue; type "logs"constant` - - Always `logs`. - - - `LOGS("logs")` - - - `Optional logs` - - The text output from the Code Interpreter tool call. - - - `class CodeInterpreterOutputImage:` - - - `long index` - - The index of the output in the outputs array. - - - `JsonValue; type "image"constant` - - Always `image`. - - - `IMAGE("image")` - - - `Optional image` - - - `Optional fileId` - - The [file](https://platform.openai.com/docs/api-reference/files) ID of the image. - - - `class FileSearchToolCallDelta:` - - - `JsonValue fileSearch` - - For now, this is always going to be an empty object. - - - `long index` - - The index of the tool call in the tool calls array. - - - `JsonValue; type "file_search"constant` - - The type of tool call. This is always going to be `file_search` for this type of tool call. - - - `FILE_SEARCH("file_search")` - - - `Optional id` - - The ID of the tool call object. - - - `class FunctionToolCallDelta:` - - - `long index` - - The index of the tool call in the tool calls array. - - - `JsonValue; type "function"constant` - - The type of tool call. This is always going to be `function` for this type of tool call. - - - `FUNCTION("function")` - - - `Optional id` - - The ID of the tool call object. - - - `Optional function` - - The definition of the function that was called. - - - `Optional arguments` - - The arguments passed to the function. - - - `Optional name` - - The name of the function. - - - `Optional output` - - The output of the function. This will be `null` if the outputs have not been [submitted](https://platform.openai.com/docs/api-reference/runs/submitToolOutputs) yet. - - - `JsonValue; object_ "thread.run.step.delta"constant` - - The object type, which is always `thread.run.step.delta`. - - - `THREAD_RUN_STEP_DELTA("thread.run.step.delta")` - - - `JsonValue; event "thread.run.step.delta"constant` - - - `THREAD_RUN_STEP_DELTA("thread.run.step.delta")` - - - `ThreadRunStepCompleted` - - - `RunStep data` - - Represents a step in execution of a run. - - - `JsonValue; event "thread.run.step.completed"constant` - - - `THREAD_RUN_STEP_COMPLETED("thread.run.step.completed")` - - - `ThreadRunStepFailed` - - - `RunStep data` - - Represents a step in execution of a run. - - - `JsonValue; event "thread.run.step.failed"constant` - - - `THREAD_RUN_STEP_FAILED("thread.run.step.failed")` - - - `ThreadRunStepCancelled` - - - `RunStep data` - - Represents a step in execution of a run. - - - `JsonValue; event "thread.run.step.cancelled"constant` - - - `THREAD_RUN_STEP_CANCELLED("thread.run.step.cancelled")` - - - `ThreadRunStepExpired` - - - `RunStep data` - - Represents a step in execution of a run. - - - `JsonValue; event "thread.run.step.expired"constant` - - - `THREAD_RUN_STEP_EXPIRED("thread.run.step.expired")` - - - `ThreadMessageCreated` - - - `Message data` - - Represents a message within a [thread](https://platform.openai.com/docs/api-reference/threads). - - - `String id` - - The identifier, which can be referenced in API endpoints. - - - `Optional assistantId` - - If applicable, the ID of the [assistant](https://platform.openai.com/docs/api-reference/assistants) that authored this message. - - - `Optional> attachments` - - A list of files attached to the message, and the tools they were added to. - - - `Optional fileId` - - The ID of the file to attach to the message. - - - `Optional> tools` - - The tools to add this file to. - - - `class CodeInterpreterTool:` - - - `JsonValue;` - - - `JsonValue; type "file_search"constant` - - The type of tool being defined: `file_search` - - - `FILE_SEARCH("file_search")` - - - `Optional completedAt` - - The Unix timestamp (in seconds) for when the message was completed. - - - `List content` - - The content of the message in array of text and/or images. - - - `class ImageFileContentBlock:` - - References an image [File](https://platform.openai.com/docs/api-reference/files) in the content of a message. - - - `ImageFile imageFile` - - - `String fileId` - - The [File](https://platform.openai.com/docs/api-reference/files) ID of the image in the message content. Set `purpose="vision"` when uploading the File if you need to later display the file content. - - - `Optional detail` - - Specifies the detail level of the image if specified by the user. `low` uses fewer tokens, you can opt in to high resolution using `high`. - - - `AUTO("auto")` - - - `LOW("low")` - - - `HIGH("high")` - - - `JsonValue; type "image_file"constant` - - Always `image_file`. - - - `IMAGE_FILE("image_file")` - - - `class ImageUrlContentBlock:` - - References an image URL in the content of a message. - - - `ImageUrl imageUrl` - - - `String url` - - The external URL of the image, must be a supported image types: jpeg, jpg, png, gif, webp. - - - `Optional detail` - - Specifies the detail level of the image. `low` uses fewer tokens, you can opt in to high resolution using `high`. Default value is `auto` - - - `AUTO("auto")` - - - `LOW("low")` - - - `HIGH("high")` - - - `JsonValue; type "image_url"constant` - - The type of the content part. - - - `IMAGE_URL("image_url")` - - - `class TextContentBlock:` - - The text content that is part of a message. - - - `Text text` - - - `List annotations` - - - `class FileCitationAnnotation:` - - 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. - - - `long endIndex` - - - `FileCitation fileCitation` - - - `String fileId` - - The ID of the specific File the citation is from. - - - `long startIndex` - - - `String text` - - The text in the message content that needs to be replaced. - - - `JsonValue; type "file_citation"constant` - - Always `file_citation`. - - - `FILE_CITATION("file_citation")` - - - `class FilePathAnnotation:` - - A URL for the file that's generated when the assistant used the `code_interpreter` tool to generate a file. - - - `long endIndex` - - - `FilePath filePath` - - - `String fileId` - - The ID of the file that was generated. - - - `long startIndex` - - - `String text` - - The text in the message content that needs to be replaced. - - - `JsonValue; type "file_path"constant` - - Always `file_path`. - - - `FILE_PATH("file_path")` - - - `String value` - - The data that makes up the text. - - - `JsonValue; type "text"constant` - - Always `text`. - - - `TEXT("text")` - - - `class RefusalContentBlock:` - - The refusal content generated by the assistant. - - - `String refusal` - - - `JsonValue; type "refusal"constant` - - Always `refusal`. - - - `REFUSAL("refusal")` - - - `long createdAt` - - The Unix timestamp (in seconds) for when the message was created. - - - `Optional incompleteAt` - - The Unix timestamp (in seconds) for when the message was marked as incomplete. - - - `Optional incompleteDetails` - - On an incomplete message, details about why the message is incomplete. - - - `Reason reason` - - The reason the message is incomplete. - - - `CONTENT_FILTER("content_filter")` - - - `MAX_TOKENS("max_tokens")` - - - `RUN_CANCELLED("run_cancelled")` - - - `RUN_EXPIRED("run_expired")` - - - `RUN_FAILED("run_failed")` - - - `Optional metadata` - - Set of 16 key-value pairs that can be attached to an object. This can be - useful for storing additional information about the object in a structured - format, and querying for objects via API or the dashboard. - - Keys are strings with a maximum length of 64 characters. Values are strings - with a maximum length of 512 characters. - - - `JsonValue; object_ "thread.message"constant` - - The object type, which is always `thread.message`. - - - `THREAD_MESSAGE("thread.message")` - - - `Role role` - - The entity that produced the message. One of `user` or `assistant`. - - - `USER("user")` - - - `ASSISTANT("assistant")` - - - `Optional runId` - - The ID of the [run](https://platform.openai.com/docs/api-reference/runs) associated with the creation of this message. Value is `null` when messages are created manually using the create message or create thread endpoints. - - - `Status status` - - The status of the message, which can be either `in_progress`, `incomplete`, or `completed`. - - - `IN_PROGRESS("in_progress")` - - - `INCOMPLETE("incomplete")` - - - `COMPLETED("completed")` - - - `String threadId` - - The [thread](https://platform.openai.com/docs/api-reference/threads) ID that this message belongs to. - - - `JsonValue; event "thread.message.created"constant` - - - `THREAD_MESSAGE_CREATED("thread.message.created")` - - - `ThreadMessageInProgress` - - - `Message data` - - Represents a message within a [thread](https://platform.openai.com/docs/api-reference/threads). - - - `JsonValue; event "thread.message.in_progress"constant` - - - `THREAD_MESSAGE_IN_PROGRESS("thread.message.in_progress")` - - - `ThreadMessageDelta` - - - `MessageDeltaEvent data` - - Represents a message delta i.e. any changed fields on a message during streaming. - - - `String id` - - The identifier of the message, which can be referenced in API endpoints. - - - `MessageDelta delta` - - The delta containing the fields that have changed on the Message. - - - `Optional> content` - - The content of the message in array of text and/or images. - - - `class ImageFileDeltaBlock:` - - References an image [File](https://platform.openai.com/docs/api-reference/files) in the content of a message. - - - `long index` - - The index of the content part in the message. - - - `JsonValue; type "image_file"constant` - - Always `image_file`. - - - `IMAGE_FILE("image_file")` - - - `Optional imageFile` - - - `Optional detail` - - Specifies the detail level of the image if specified by the user. `low` uses fewer tokens, you can opt in to high resolution using `high`. - - - `AUTO("auto")` - - - `LOW("low")` - - - `HIGH("high")` - - - `Optional fileId` - - The [File](https://platform.openai.com/docs/api-reference/files) ID of the image in the message content. Set `purpose="vision"` when uploading the File if you need to later display the file content. - - - `class TextDeltaBlock:` - - The text content that is part of a message. - - - `long index` - - The index of the content part in the message. - - - `JsonValue; type "text"constant` - - Always `text`. - - - `TEXT("text")` - - - `Optional text` - - - `Optional> annotations` - - - `class FileCitationDeltaAnnotation:` - - 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. - - - `long index` - - The index of the annotation in the text content part. - - - `JsonValue; type "file_citation"constant` - - Always `file_citation`. - - - `FILE_CITATION("file_citation")` - - - `Optional endIndex` - - - `Optional fileCitation` - - - `Optional fileId` - - The ID of the specific File the citation is from. - - - `Optional quote` - - The specific quote in the file. - - - `Optional startIndex` - - - `Optional text` - - The text in the message content that needs to be replaced. - - - `class FilePathDeltaAnnotation:` - - A URL for the file that's generated when the assistant used the `code_interpreter` tool to generate a file. - - - `long index` - - The index of the annotation in the text content part. - - - `JsonValue; type "file_path"constant` - - Always `file_path`. - - - `FILE_PATH("file_path")` - - - `Optional endIndex` - - - `Optional filePath` - - - `Optional fileId` - - The ID of the file that was generated. - - - `Optional startIndex` - - - `Optional text` - - The text in the message content that needs to be replaced. - - - `Optional value` - - The data that makes up the text. - - - `class RefusalDeltaBlock:` - - The refusal content that is part of a message. - - - `long index` - - The index of the refusal part in the message. - - - `JsonValue; type "refusal"constant` - - Always `refusal`. - - - `REFUSAL("refusal")` - - - `Optional refusal` - - - `class ImageUrlDeltaBlock:` - - References an image URL in the content of a message. - - - `long index` - - The index of the content part in the message. - - - `JsonValue; type "image_url"constant` - - Always `image_url`. - - - `IMAGE_URL("image_url")` - - - `Optional imageUrl` - - - `Optional detail` - - Specifies the detail level of the image. `low` uses fewer tokens, you can opt in to high resolution using `high`. - - - `AUTO("auto")` - - - `LOW("low")` - - - `HIGH("high")` - - - `Optional url` - - The URL of the image, must be a supported image types: jpeg, jpg, png, gif, webp. - - - `Optional role` - - The entity that produced the message. One of `user` or `assistant`. - - - `USER("user")` - - - `ASSISTANT("assistant")` - - - `JsonValue; object_ "thread.message.delta"constant` - - The object type, which is always `thread.message.delta`. - - - `THREAD_MESSAGE_DELTA("thread.message.delta")` - - - `JsonValue; event "thread.message.delta"constant` - - - `THREAD_MESSAGE_DELTA("thread.message.delta")` - - - `ThreadMessageCompleted` - - - `Message data` - - Represents a message within a [thread](https://platform.openai.com/docs/api-reference/threads). - - - `JsonValue; event "thread.message.completed"constant` - - - `THREAD_MESSAGE_COMPLETED("thread.message.completed")` - - - `ThreadMessageIncomplete` - - - `Message data` - - Represents a message within a [thread](https://platform.openai.com/docs/api-reference/threads). - - - `JsonValue; event "thread.message.incomplete"constant` - - - `THREAD_MESSAGE_INCOMPLETE("thread.message.incomplete")` - - - `ErrorEvent` - - - `ErrorObject data` - - - `Optional code` - - - `String message` - - - `Optional param` - - - `String type` - - - `JsonValue; event "error"constant` - - - `ERROR("error")` - -### Assistant Tool - -- `class AssistantTool: A class that can be one of several variants.union` - - - `class CodeInterpreterTool:` - - - `JsonValue; type "code_interpreter"constant` - - The type of tool being defined: `code_interpreter` - - - `CODE_INTERPRETER("code_interpreter")` - - - `class FileSearchTool:` - - - `JsonValue; type "file_search"constant` - - The type of tool being defined: `file_search` - - - `FILE_SEARCH("file_search")` - - - `Optional fileSearch` - - Overrides for the file search tool. - - - `Optional maxNumResults` - - The maximum number of results the file search tool should output. The default is 20 for `gpt-4*` models and 5 for `gpt-3.5-turbo`. This number should be between 1 and 50 inclusive. - - Note that the file search tool may output fewer than `max_num_results` results. See the [file search tool documentation](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) for more information. - - - `Optional rankingOptions` - - The ranking options for the file search. If not specified, the file search tool will use the `auto` ranker and a score_threshold of 0. - - See the [file search tool documentation](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) for more information. - - - `double scoreThreshold` - - The score threshold for the file search. All values must be a floating point number between 0 and 1. - - - `Optional ranker` - - The ranker to use for the file search. If not specified will use the `auto` ranker. - - - `AUTO("auto")` - - - `DEFAULT_2024_08_21("default_2024_08_21")` - - - `class FunctionTool:` - - - `FunctionDefinition function` - - - `String name` - - The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. - - - `Optional description` - - A description of what the function does, used by the model to choose when and how to call the function. - - - `Optional parameters` - - The parameters the functions accepts, described as a JSON Schema object. See the [guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. - - Omitting `parameters` defines a function with an empty parameter list. - - - `Optional strict` - - Whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the `parameters` field. Only a subset of JSON Schema is supported when `strict` is `true`. Learn more about Structured Outputs in the [function calling guide](https://platform.openai.com/docs/guides/function-calling). - - - `JsonValue; type "function"constant` - - The type of tool being defined: `function` - - - `FUNCTION("function")` - -### Code Interpreter Tool - -- `class CodeInterpreterTool:` - - - `JsonValue; type "code_interpreter"constant` - - The type of tool being defined: `code_interpreter` - - - `CODE_INTERPRETER("code_interpreter")` - -### File Search Tool - -- `class FileSearchTool:` - - - `JsonValue; type "file_search"constant` - - The type of tool being defined: `file_search` - - - `FILE_SEARCH("file_search")` - - - `Optional fileSearch` - - Overrides for the file search tool. - - - `Optional maxNumResults` - - The maximum number of results the file search tool should output. The default is 20 for `gpt-4*` models and 5 for `gpt-3.5-turbo`. This number should be between 1 and 50 inclusive. - - Note that the file search tool may output fewer than `max_num_results` results. See the [file search tool documentation](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) for more information. - - - `Optional rankingOptions` - - The ranking options for the file search. If not specified, the file search tool will use the `auto` ranker and a score_threshold of 0. - - See the [file search tool documentation](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) for more information. - - - `double scoreThreshold` - - The score threshold for the file search. All values must be a floating point number between 0 and 1. - - - `Optional ranker` - - The ranker to use for the file search. If not specified will use the `auto` ranker. - - - `AUTO("auto")` - - - `DEFAULT_2024_08_21("default_2024_08_21")` - -### Function Tool - -- `class FunctionTool:` - - - `FunctionDefinition function` - - - `String name` - - The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. - - - `Optional description` - - A description of what the function does, used by the model to choose when and how to call the function. - - - `Optional parameters` - - The parameters the functions accepts, described as a JSON Schema object. See the [guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. - - Omitting `parameters` defines a function with an empty parameter list. - - - `Optional strict` - - Whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the `parameters` field. Only a subset of JSON Schema is supported when `strict` is `true`. Learn more about Structured Outputs in the [function calling guide](https://platform.openai.com/docs/guides/function-calling). - - - `JsonValue; type "function"constant` - - The type of tool being defined: `function` - - - `FUNCTION("function")` - -### Message Stream Event - -- `class MessageStreamEvent: A class that can be one of several variants.union` - - Occurs when a [message](https://platform.openai.com/docs/api-reference/messages/object) is created. - - - `ThreadMessageCreated` - - - `Message data` - - Represents a message within a [thread](https://platform.openai.com/docs/api-reference/threads). - - - `String id` - - The identifier, which can be referenced in API endpoints. - - - `Optional assistantId` - - If applicable, the ID of the [assistant](https://platform.openai.com/docs/api-reference/assistants) that authored this message. - - - `Optional> attachments` - - A list of files attached to the message, and the tools they were added to. - - - `Optional fileId` - - The ID of the file to attach to the message. - - - `Optional> tools` - - The tools to add this file to. - - - `class CodeInterpreterTool:` - - - `JsonValue; type "code_interpreter"constant` - - The type of tool being defined: `code_interpreter` - - - `CODE_INTERPRETER("code_interpreter")` - - - `JsonValue;` - - - `JsonValue; type "file_search"constant` - - The type of tool being defined: `file_search` - - - `FILE_SEARCH("file_search")` - - - `Optional completedAt` - - The Unix timestamp (in seconds) for when the message was completed. - - - `List content` - - The content of the message in array of text and/or images. - - - `class ImageFileContentBlock:` - - References an image [File](https://platform.openai.com/docs/api-reference/files) in the content of a message. - - - `ImageFile imageFile` - - - `String fileId` - - The [File](https://platform.openai.com/docs/api-reference/files) ID of the image in the message content. Set `purpose="vision"` when uploading the File if you need to later display the file content. - - - `Optional detail` - - Specifies the detail level of the image if specified by the user. `low` uses fewer tokens, you can opt in to high resolution using `high`. - - - `AUTO("auto")` - - - `LOW("low")` - - - `HIGH("high")` - - - `JsonValue; type "image_file"constant` - - Always `image_file`. - - - `IMAGE_FILE("image_file")` - - - `class ImageUrlContentBlock:` - - References an image URL in the content of a message. - - - `ImageUrl imageUrl` - - - `String url` - - The external URL of the image, must be a supported image types: jpeg, jpg, png, gif, webp. - - - `Optional detail` - - Specifies the detail level of the image. `low` uses fewer tokens, you can opt in to high resolution using `high`. Default value is `auto` - - - `AUTO("auto")` - - - `LOW("low")` - - - `HIGH("high")` - - - `JsonValue; type "image_url"constant` - - The type of the content part. - - - `IMAGE_URL("image_url")` - - - `class TextContentBlock:` - - The text content that is part of a message. - - - `Text text` - - - `List annotations` - - - `class FileCitationAnnotation:` - - 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. - - - `long endIndex` - - - `FileCitation fileCitation` - - - `String fileId` - - The ID of the specific File the citation is from. - - - `long startIndex` - - - `String text` - - The text in the message content that needs to be replaced. - - - `JsonValue; type "file_citation"constant` - - Always `file_citation`. - - - `FILE_CITATION("file_citation")` - - - `class FilePathAnnotation:` - - A URL for the file that's generated when the assistant used the `code_interpreter` tool to generate a file. - - - `long endIndex` - - - `FilePath filePath` - - - `String fileId` - - The ID of the file that was generated. - - - `long startIndex` - - - `String text` - - The text in the message content that needs to be replaced. - - - `JsonValue; type "file_path"constant` - - Always `file_path`. - - - `FILE_PATH("file_path")` - - - `String value` - - The data that makes up the text. - - - `JsonValue; type "text"constant` - - Always `text`. - - - `TEXT("text")` - - - `class RefusalContentBlock:` - - The refusal content generated by the assistant. - - - `String refusal` - - - `JsonValue; type "refusal"constant` - - Always `refusal`. - - - `REFUSAL("refusal")` - - - `long createdAt` - - The Unix timestamp (in seconds) for when the message was created. - - - `Optional incompleteAt` - - The Unix timestamp (in seconds) for when the message was marked as incomplete. - - - `Optional incompleteDetails` - - On an incomplete message, details about why the message is incomplete. - - - `Reason reason` - - The reason the message is incomplete. - - - `CONTENT_FILTER("content_filter")` - - - `MAX_TOKENS("max_tokens")` - - - `RUN_CANCELLED("run_cancelled")` - - - `RUN_EXPIRED("run_expired")` - - - `RUN_FAILED("run_failed")` - - - `Optional metadata` - - Set of 16 key-value pairs that can be attached to an object. This can be - useful for storing additional information about the object in a structured - format, and querying for objects via API or the dashboard. - - Keys are strings with a maximum length of 64 characters. Values are strings - with a maximum length of 512 characters. - - - `JsonValue; object_ "thread.message"constant` - - The object type, which is always `thread.message`. - - - `THREAD_MESSAGE("thread.message")` - - - `Role role` - - The entity that produced the message. One of `user` or `assistant`. - - - `USER("user")` - - - `ASSISTANT("assistant")` - - - `Optional runId` - - The ID of the [run](https://platform.openai.com/docs/api-reference/runs) associated with the creation of this message. Value is `null` when messages are created manually using the create message or create thread endpoints. - - - `Status status` - - The status of the message, which can be either `in_progress`, `incomplete`, or `completed`. - - - `IN_PROGRESS("in_progress")` - - - `INCOMPLETE("incomplete")` - - - `COMPLETED("completed")` - - - `String threadId` - - The [thread](https://platform.openai.com/docs/api-reference/threads) ID that this message belongs to. - - - `JsonValue; event "thread.message.created"constant` - - - `THREAD_MESSAGE_CREATED("thread.message.created")` - - - `ThreadMessageInProgress` - - - `Message data` - - Represents a message within a [thread](https://platform.openai.com/docs/api-reference/threads). - - - `JsonValue; event "thread.message.in_progress"constant` - - - `THREAD_MESSAGE_IN_PROGRESS("thread.message.in_progress")` - - - `ThreadMessageDelta` - - - `MessageDeltaEvent data` - - Represents a message delta i.e. any changed fields on a message during streaming. - - - `String id` - - The identifier of the message, which can be referenced in API endpoints. - - - `MessageDelta delta` - - The delta containing the fields that have changed on the Message. - - - `Optional> content` - - The content of the message in array of text and/or images. - - - `class ImageFileDeltaBlock:` - - References an image [File](https://platform.openai.com/docs/api-reference/files) in the content of a message. - - - `long index` - - The index of the content part in the message. - - - `JsonValue; type "image_file"constant` - - Always `image_file`. - - - `IMAGE_FILE("image_file")` - - - `Optional imageFile` - - - `Optional detail` - - Specifies the detail level of the image if specified by the user. `low` uses fewer tokens, you can opt in to high resolution using `high`. - - - `AUTO("auto")` - - - `LOW("low")` - - - `HIGH("high")` - - - `Optional fileId` - - The [File](https://platform.openai.com/docs/api-reference/files) ID of the image in the message content. Set `purpose="vision"` when uploading the File if you need to later display the file content. - - - `class TextDeltaBlock:` - - The text content that is part of a message. - - - `long index` - - The index of the content part in the message. - - - `JsonValue; type "text"constant` - - Always `text`. - - - `TEXT("text")` - - - `Optional text` - - - `Optional> annotations` - - - `class FileCitationDeltaAnnotation:` - - 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. - - - `long index` - - The index of the annotation in the text content part. - - - `JsonValue; type "file_citation"constant` - - Always `file_citation`. - - - `FILE_CITATION("file_citation")` - - - `Optional endIndex` - - - `Optional fileCitation` - - - `Optional fileId` - - The ID of the specific File the citation is from. - - - `Optional quote` - - The specific quote in the file. - - - `Optional startIndex` - - - `Optional text` - - The text in the message content that needs to be replaced. - - - `class FilePathDeltaAnnotation:` - - A URL for the file that's generated when the assistant used the `code_interpreter` tool to generate a file. - - - `long index` - - The index of the annotation in the text content part. - - - `JsonValue; type "file_path"constant` - - Always `file_path`. - - - `FILE_PATH("file_path")` - - - `Optional endIndex` - - - `Optional filePath` - - - `Optional fileId` - - The ID of the file that was generated. - - - `Optional startIndex` - - - `Optional text` - - The text in the message content that needs to be replaced. - - - `Optional value` - - The data that makes up the text. - - - `class RefusalDeltaBlock:` - - The refusal content that is part of a message. - - - `long index` - - The index of the refusal part in the message. - - - `JsonValue; type "refusal"constant` - - Always `refusal`. - - - `REFUSAL("refusal")` - - - `Optional refusal` - - - `class ImageUrlDeltaBlock:` - - References an image URL in the content of a message. - - - `long index` - - The index of the content part in the message. - - - `JsonValue; type "image_url"constant` - - Always `image_url`. - - - `IMAGE_URL("image_url")` - - - `Optional imageUrl` - - - `Optional detail` - - Specifies the detail level of the image. `low` uses fewer tokens, you can opt in to high resolution using `high`. - - - `AUTO("auto")` - - - `LOW("low")` - - - `HIGH("high")` - - - `Optional url` - - The URL of the image, must be a supported image types: jpeg, jpg, png, gif, webp. - - - `Optional role` - - The entity that produced the message. One of `user` or `assistant`. - - - `USER("user")` - - - `ASSISTANT("assistant")` - - - `JsonValue; object_ "thread.message.delta"constant` - - The object type, which is always `thread.message.delta`. - - - `THREAD_MESSAGE_DELTA("thread.message.delta")` - - - `JsonValue; event "thread.message.delta"constant` - - - `THREAD_MESSAGE_DELTA("thread.message.delta")` - - - `ThreadMessageCompleted` - - - `Message data` - - Represents a message within a [thread](https://platform.openai.com/docs/api-reference/threads). - - - `JsonValue; event "thread.message.completed"constant` - - - `THREAD_MESSAGE_COMPLETED("thread.message.completed")` - - - `ThreadMessageIncomplete` - - - `Message data` - - Represents a message within a [thread](https://platform.openai.com/docs/api-reference/threads). - - - `JsonValue; event "thread.message.incomplete"constant` - - - `THREAD_MESSAGE_INCOMPLETE("thread.message.incomplete")` - -### Run Step Stream Event - -- `class RunStepStreamEvent: A class that can be one of several variants.union` - - Occurs when a [run step](https://platform.openai.com/docs/api-reference/run-steps/step-object) is created. - - - `ThreadRunStepCreated` - - - `RunStep data` - - Represents a step in execution of a run. - - - `String id` - - The identifier of the run step, which can be referenced in API endpoints. - - - `String assistantId` - - The ID of the [assistant](https://platform.openai.com/docs/api-reference/assistants) associated with the run step. - - - `Optional cancelledAt` - - The Unix timestamp (in seconds) for when the run step was cancelled. - - - `Optional completedAt` - - The Unix timestamp (in seconds) for when the run step completed. - - - `long createdAt` - - The Unix timestamp (in seconds) for when the run step was created. - - - `Optional expiredAt` - - The Unix timestamp (in seconds) for when the run step expired. A step is considered expired if the parent run is expired. - - - `Optional failedAt` - - The Unix timestamp (in seconds) for when the run step failed. - - - `Optional lastError` - - The last error associated with this run step. Will be `null` if there are no errors. - - - `Code code` - - One of `server_error` or `rate_limit_exceeded`. - - - `SERVER_ERROR("server_error")` - - - `RATE_LIMIT_EXCEEDED("rate_limit_exceeded")` - - - `String message` - - A human-readable description of the error. - - - `Optional metadata` - - Set of 16 key-value pairs that can be attached to an object. This can be - useful for storing additional information about the object in a structured - format, and querying for objects via API or the dashboard. - - Keys are strings with a maximum length of 64 characters. Values are strings - with a maximum length of 512 characters. - - - `JsonValue; object_ "thread.run.step"constant` - - The object type, which is always `thread.run.step`. - - - `THREAD_RUN_STEP("thread.run.step")` - - - `String runId` - - The ID of the [run](https://platform.openai.com/docs/api-reference/runs) that this run step is a part of. - - - `Status status` - - The status of the run step, which can be either `in_progress`, `cancelled`, `failed`, `completed`, or `expired`. - - - `IN_PROGRESS("in_progress")` - - - `CANCELLED("cancelled")` - - - `FAILED("failed")` - - - `COMPLETED("completed")` - - - `EXPIRED("expired")` - - - `StepDetails stepDetails` - - The details of the run step. - - - `class MessageCreationStepDetails:` - - Details of the message creation by the run step. - - - `MessageCreation messageCreation` - - - `String messageId` - - The ID of the message that was created by this run step. - - - `JsonValue; type "message_creation"constant` - - Always `message_creation`. - - - `MESSAGE_CREATION("message_creation")` - - - `class ToolCallsStepDetails:` - - Details of the tool call. - - - `List toolCalls` - - An array of tool calls the run step was involved in. These can be associated with one of three types of tools: `code_interpreter`, `file_search`, or `function`. - - - `class CodeInterpreterToolCall:` - - Details of the Code Interpreter tool call the run step was involved in. - - - `String id` - - The ID of the tool call. - - - `CodeInterpreter codeInterpreter` - - The Code Interpreter tool call definition. - - - `String input` - - The input to the Code Interpreter tool call. - - - `List outputs` - - The outputs from the Code Interpreter tool call. Code Interpreter can output one or more items, including text (`logs`) or images (`image`). Each of these are represented by a different object type. - - - `class LogsOutput:` - - Text output from the Code Interpreter tool call as part of a run step. - - - `String logs` - - The text output from the Code Interpreter tool call. - - - `JsonValue; type "logs"constant` - - Always `logs`. - - - `LOGS("logs")` - - - `class ImageOutput:` - - - `Image image` - - - `String fileId` - - The [file](https://platform.openai.com/docs/api-reference/files) ID of the image. - - - `JsonValue; type "image"constant` - - Always `image`. - - - `IMAGE("image")` - - - `JsonValue; type "code_interpreter"constant` - - The type of tool call. This is always going to be `code_interpreter` for this type of tool call. - - - `CODE_INTERPRETER("code_interpreter")` - - - `class FileSearchToolCall:` - - - `String id` - - The ID of the tool call object. - - - `FileSearch fileSearch` - - For now, this is always going to be an empty object. - - - `Optional rankingOptions` - - The ranking options for the file search. - - - `Ranker ranker` - - The ranker to use for the file search. If not specified will use the `auto` ranker. - - - `AUTO("auto")` - - - `DEFAULT_2024_08_21("default_2024_08_21")` - - - `double scoreThreshold` - - The score threshold for the file search. All values must be a floating point number between 0 and 1. - - - `Optional> results` - - The results of the file search. - - - `String fileId` - - The ID of the file that result was found in. - - - `String fileName` - - The name of the file that result was found in. - - - `double score` - - The score of the result. All values must be a floating point number between 0 and 1. - - - `Optional> content` - - The content of the result that was found. The content is only included if requested via the include query parameter. - - - `Optional text` - - The text content of the file. - - - `Optional type` - - The type of the content. - - - `TEXT("text")` - - - `JsonValue; type "file_search"constant` - - The type of tool call. This is always going to be `file_search` for this type of tool call. - - - `FILE_SEARCH("file_search")` - - - `class FunctionToolCall:` - - - `String id` - - The ID of the tool call object. - - - `Function function` - - The definition of the function that was called. - - - `String arguments` - - The arguments passed to the function. - - - `String name` - - The name of the function. - - - `Optional output` - - The output of the function. This will be `null` if the outputs have not been [submitted](https://platform.openai.com/docs/api-reference/runs/submitToolOutputs) yet. - - - `JsonValue; type "function"constant` - - The type of tool call. This is always going to be `function` for this type of tool call. - - - `FUNCTION("function")` - - - `JsonValue; type "tool_calls"constant` - - Always `tool_calls`. - - - `TOOL_CALLS("tool_calls")` - - - `String threadId` - - The ID of the [thread](https://platform.openai.com/docs/api-reference/threads) that was run. - - - `Type type` - - The type of run step, which can be either `message_creation` or `tool_calls`. - - - `MESSAGE_CREATION("message_creation")` - - - `TOOL_CALLS("tool_calls")` - - - `Optional usage` - - Usage statistics related to the run step. This value will be `null` while the run step's status is `in_progress`. - - - `long completionTokens` - - Number of completion tokens used over the course of the run step. - - - `long promptTokens` - - Number of prompt tokens used over the course of the run step. - - - `long totalTokens` - - Total number of tokens used (prompt + completion). - - - `JsonValue; event "thread.run.step.created"constant` - - - `THREAD_RUN_STEP_CREATED("thread.run.step.created")` - - - `ThreadRunStepInProgress` - - - `RunStep data` - - Represents a step in execution of a run. - - - `JsonValue; event "thread.run.step.in_progress"constant` - - - `THREAD_RUN_STEP_IN_PROGRESS("thread.run.step.in_progress")` - - - `ThreadRunStepDelta` - - - `RunStepDeltaEvent data` - - Represents a run step delta i.e. any changed fields on a run step during streaming. - - - `String id` - - The identifier of the run step, which can be referenced in API endpoints. - - - `RunStepDelta delta` - - The delta containing the fields that have changed on the run step. - - - `Optional stepDetails` - - The details of the run step. - - - `class RunStepDeltaMessageDelta:` - - Details of the message creation by the run step. - - - `JsonValue; type "message_creation"constant` - - Always `message_creation`. - - - `MESSAGE_CREATION("message_creation")` - - - `Optional messageCreation` - - - `Optional messageId` - - The ID of the message that was created by this run step. - - - `class ToolCallDeltaObject:` - - Details of the tool call. - - - `JsonValue; type "tool_calls"constant` - - Always `tool_calls`. - - - `TOOL_CALLS("tool_calls")` - - - `Optional> toolCalls` - - An array of tool calls the run step was involved in. These can be associated with one of three types of tools: `code_interpreter`, `file_search`, or `function`. - - - `class CodeInterpreterToolCallDelta:` - - Details of the Code Interpreter tool call the run step was involved in. - - - `long index` - - The index of the tool call in the tool calls array. - - - `JsonValue; type "code_interpreter"constant` - - The type of tool call. This is always going to be `code_interpreter` for this type of tool call. - - - `CODE_INTERPRETER("code_interpreter")` - - - `Optional id` - - The ID of the tool call. - - - `Optional codeInterpreter` - - The Code Interpreter tool call definition. - - - `Optional input` - - The input to the Code Interpreter tool call. - - - `Optional> outputs` - - The outputs from the Code Interpreter tool call. Code Interpreter can output one or more items, including text (`logs`) or images (`image`). Each of these are represented by a different object type. - - - `class CodeInterpreterLogs:` - - Text output from the Code Interpreter tool call as part of a run step. - - - `long index` - - The index of the output in the outputs array. - - - `JsonValue; type "logs"constant` - - Always `logs`. - - - `LOGS("logs")` - - - `Optional logs` - - The text output from the Code Interpreter tool call. - - - `class CodeInterpreterOutputImage:` - - - `long index` - - The index of the output in the outputs array. - - - `JsonValue; type "image"constant` - - Always `image`. - - - `IMAGE("image")` - - - `Optional image` - - - `Optional fileId` - - The [file](https://platform.openai.com/docs/api-reference/files) ID of the image. - - - `class FileSearchToolCallDelta:` - - - `JsonValue fileSearch` - - For now, this is always going to be an empty object. - - - `long index` - - The index of the tool call in the tool calls array. - - - `JsonValue; type "file_search"constant` - - The type of tool call. This is always going to be `file_search` for this type of tool call. - - - `FILE_SEARCH("file_search")` - - - `Optional id` - - The ID of the tool call object. - - - `class FunctionToolCallDelta:` - - - `long index` - - The index of the tool call in the tool calls array. - - - `JsonValue; type "function"constant` - - The type of tool call. This is always going to be `function` for this type of tool call. - - - `FUNCTION("function")` - - - `Optional id` - - The ID of the tool call object. - - - `Optional function` - - The definition of the function that was called. - - - `Optional arguments` - - The arguments passed to the function. - - - `Optional name` - - The name of the function. - - - `Optional output` - - The output of the function. This will be `null` if the outputs have not been [submitted](https://platform.openai.com/docs/api-reference/runs/submitToolOutputs) yet. - - - `JsonValue; object_ "thread.run.step.delta"constant` - - The object type, which is always `thread.run.step.delta`. - - - `THREAD_RUN_STEP_DELTA("thread.run.step.delta")` - - - `JsonValue; event "thread.run.step.delta"constant` - - - `THREAD_RUN_STEP_DELTA("thread.run.step.delta")` - - - `ThreadRunStepCompleted` - - - `RunStep data` - - Represents a step in execution of a run. - - - `JsonValue; event "thread.run.step.completed"constant` - - - `THREAD_RUN_STEP_COMPLETED("thread.run.step.completed")` - - - `ThreadRunStepFailed` - - - `RunStep data` - - Represents a step in execution of a run. - - - `JsonValue; event "thread.run.step.failed"constant` - - - `THREAD_RUN_STEP_FAILED("thread.run.step.failed")` - - - `ThreadRunStepCancelled` - - - `RunStep data` - - Represents a step in execution of a run. - - - `JsonValue; event "thread.run.step.cancelled"constant` - - - `THREAD_RUN_STEP_CANCELLED("thread.run.step.cancelled")` - - - `ThreadRunStepExpired` - - - `RunStep data` - - Represents a step in execution of a run. - - - `JsonValue; event "thread.run.step.expired"constant` - - - `THREAD_RUN_STEP_EXPIRED("thread.run.step.expired")` - -### Run Stream Event - -- `class RunStreamEvent: A class that can be one of several variants.union` - - Occurs when a new [run](https://platform.openai.com/docs/api-reference/runs/object) is created. - - - `ThreadRunCreated` - - - `Run data` - - Represents an execution run on a [thread](https://platform.openai.com/docs/api-reference/threads). - - - `String id` - - The identifier, which can be referenced in API endpoints. - - - `String assistantId` - - The ID of the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for execution of this run. - - - `Optional cancelledAt` - - The Unix timestamp (in seconds) for when the run was cancelled. - - - `Optional completedAt` - - The Unix timestamp (in seconds) for when the run was completed. - - - `long createdAt` - - The Unix timestamp (in seconds) for when the run was created. - - - `Optional expiresAt` - - The Unix timestamp (in seconds) for when the run will expire. - - - `Optional failedAt` - - The Unix timestamp (in seconds) for when the run failed. - - - `Optional incompleteDetails` - - Details on why the run is incomplete. Will be `null` if the run is not incomplete. - - - `Optional reason` - - The reason why the run is incomplete. This will point to which specific token limit was reached over the course of the run. - - - `MAX_COMPLETION_TOKENS("max_completion_tokens")` - - - `MAX_PROMPT_TOKENS("max_prompt_tokens")` - - - `String instructions` - - The instructions that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run. - - - `Optional lastError` - - The last error associated with this run. Will be `null` if there are no errors. - - - `Code code` - - One of `server_error`, `rate_limit_exceeded`, or `invalid_prompt`. - - - `SERVER_ERROR("server_error")` - - - `RATE_LIMIT_EXCEEDED("rate_limit_exceeded")` - - - `INVALID_PROMPT("invalid_prompt")` - - - `String message` - - A human-readable description of the error. - - - `Optional maxCompletionTokens` - - The maximum number of completion tokens specified to have been used over the course of the run. - - - `Optional maxPromptTokens` - - The maximum number of prompt tokens specified to have been used over the course of the run. - - - `Optional metadata` - - Set of 16 key-value pairs that can be attached to an object. This can be - useful for storing additional information about the object in a structured - format, and querying for objects via API or the dashboard. - - Keys are strings with a maximum length of 64 characters. Values are strings - with a maximum length of 512 characters. - - - `String model` - - The model that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run. - - - `JsonValue; object_ "thread.run"constant` - - The object type, which is always `thread.run`. - - - `THREAD_RUN("thread.run")` - - - `boolean parallelToolCalls` - - Whether to enable [parallel function calling](https://platform.openai.com/docs/guides/function-calling#configuring-parallel-function-calling) during tool use. - - - `Optional requiredAction` - - Details on the action required to continue the run. Will be `null` if no action is required. - - - `SubmitToolOutputs submitToolOutputs` - - Details on the tool outputs needed for this run to continue. - - - `List toolCalls` - - A list of the relevant tool calls. - - - `String id` - - The ID of the tool call. This ID must be referenced when you submit the tool outputs in using the [Submit tool outputs to run](https://platform.openai.com/docs/api-reference/runs/submitToolOutputs) endpoint. - - - `Function function` - - The function definition. - - - `String arguments` - - The arguments that the model expects you to pass to the function. - - - `String name` - - The name of the function. - - - `JsonValue; type "function"constant` - - The type of tool call the output is required for. For now, this is always `function`. - - - `FUNCTION("function")` - - - `JsonValue; type "submit_tool_outputs"constant` - - For now, this is always `submit_tool_outputs`. - - - `SUBMIT_TOOL_OUTPUTS("submit_tool_outputs")` - - - `Optional responseFormat` - - Specifies the format that the model must output. Compatible with [GPT-4o](https://platform.openai.com/docs/models#gpt-4o), [GPT-4 Turbo](https://platform.openai.com/docs/models#gpt-4-turbo-and-gpt-4), and all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`. - - Setting to `{ "type": "json_schema", "json_schema": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema. Learn more in the [Structured Outputs guide](https://platform.openai.com/docs/guides/structured-outputs). - - Setting to `{ "type": "json_object" }` enables JSON mode, which ensures the message the model generates is valid JSON. - - **Important:** when using JSON mode, you **must** also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly "stuck" request. Also note that the message content may be partially cut off if `finish_reason="length"`, which indicates the generation exceeded `max_tokens` or the conversation exceeded the max context length. - - - `JsonValue;` - - - `AUTO("auto")` - - - `class ResponseFormatText:` - - Default response format. Used to generate text responses. - - - `JsonValue; type "text"constant` - - The type of response format being defined. Always `text`. - - - `TEXT("text")` - - - `class ResponseFormatJsonObject:` - - JSON object response format. An older method of generating JSON responses. - Using `json_schema` is recommended for models that support it. Note that the - model will not generate JSON without a system or user message instructing it - to do so. - - - `JsonValue; type "json_object"constant` - - The type of response format being defined. Always `json_object`. - - - `JSON_OBJECT("json_object")` - - - `class ResponseFormatJsonSchema:` - - JSON Schema response format. Used to generate structured JSON responses. - Learn more about [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs). - - - `JsonSchema jsonSchema` - - Structured Outputs configuration options, including a JSON Schema. - - - `String name` - - The name of the response format. Must be a-z, A-Z, 0-9, or contain - underscores and dashes, with a maximum length of 64. - - - `Optional description` - - A description of what the response format is for, used by the model to - determine how to respond in the format. - - - `Optional schema` - - The schema for the response format, described as a JSON Schema object. - Learn how to build JSON schemas [here](https://json-schema.org/). - - - `Optional strict` - - Whether to enable strict schema adherence when generating the output. - If set to true, the model will always follow the exact schema defined - in the `schema` field. Only a subset of JSON Schema is supported when - `strict` is `true`. To learn more, read the [Structured Outputs - guide](https://platform.openai.com/docs/guides/structured-outputs). - - - `JsonValue; type "json_schema"constant` - - The type of response format being defined. Always `json_schema`. - - - `JSON_SCHEMA("json_schema")` - - - `Optional startedAt` - - The Unix timestamp (in seconds) for when the run was started. - - - `RunStatus status` - - The status of the run, which can be either `queued`, `in_progress`, `requires_action`, `cancelling`, `cancelled`, `failed`, `completed`, `incomplete`, or `expired`. - - - `QUEUED("queued")` - - - `IN_PROGRESS("in_progress")` - - - `REQUIRES_ACTION("requires_action")` - - - `CANCELLING("cancelling")` - - - `CANCELLED("cancelled")` - - - `FAILED("failed")` - - - `COMPLETED("completed")` - - - `INCOMPLETE("incomplete")` - - - `EXPIRED("expired")` - - - `String threadId` - - The ID of the [thread](https://platform.openai.com/docs/api-reference/threads) that was executed on as a part of this run. - - - `Optional toolChoice` - - 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. - - - `Auto` - - - `NONE("none")` - - - `AUTO("auto")` - - - `REQUIRED("required")` - - - `class AssistantToolChoice:` - - Specifies a tool the model should use. Use to force the model to call a specific tool. - - - `Type type` - - The type of the tool. If type is `function`, the function name must be set - - - `FUNCTION("function")` - - - `CODE_INTERPRETER("code_interpreter")` - - - `FILE_SEARCH("file_search")` - - - `Optional function` - - - `String name` - - The name of the function to call. - - - `List tools` - - The list of tools that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run. - - - `class CodeInterpreterTool:` - - - `JsonValue; type "code_interpreter"constant` - - The type of tool being defined: `code_interpreter` - - - `CODE_INTERPRETER("code_interpreter")` - - - `class FileSearchTool:` - - - `JsonValue; type "file_search"constant` - - The type of tool being defined: `file_search` - - - `FILE_SEARCH("file_search")` - - - `Optional fileSearch` - - Overrides for the file search tool. - - - `Optional maxNumResults` - - The maximum number of results the file search tool should output. The default is 20 for `gpt-4*` models and 5 for `gpt-3.5-turbo`. This number should be between 1 and 50 inclusive. - - Note that the file search tool may output fewer than `max_num_results` results. See the [file search tool documentation](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) for more information. - - - `Optional rankingOptions` - - The ranking options for the file search. If not specified, the file search tool will use the `auto` ranker and a score_threshold of 0. - - See the [file search tool documentation](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) for more information. - - - `double scoreThreshold` - - The score threshold for the file search. All values must be a floating point number between 0 and 1. - - - `Optional ranker` - - The ranker to use for the file search. If not specified will use the `auto` ranker. - - - `AUTO("auto")` - - - `DEFAULT_2024_08_21("default_2024_08_21")` - - - `class FunctionTool:` - - - `FunctionDefinition function` - - - `String name` - - The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. - - - `Optional description` - - A description of what the function does, used by the model to choose when and how to call the function. - - - `Optional parameters` - - The parameters the functions accepts, described as a JSON Schema object. See the [guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. - - Omitting `parameters` defines a function with an empty parameter list. - - - `Optional strict` - - Whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the `parameters` field. Only a subset of JSON Schema is supported when `strict` is `true`. Learn more about Structured Outputs in the [function calling guide](https://platform.openai.com/docs/guides/function-calling). - - - `JsonValue; type "function"constant` - - The type of tool being defined: `function` - - - `FUNCTION("function")` - - - `Optional truncationStrategy` - - Controls for how a thread will be truncated prior to the run. Use this to control the initial context window of the run. - - - `Type type` - - The truncation strategy to use for the thread. The default is `auto`. If set to `last_messages`, the thread will be truncated to the n most recent messages in the thread. When set to `auto`, messages in the middle of the thread will be dropped to fit the context length of the model, `max_prompt_tokens`. - - - `AUTO("auto")` - - - `LAST_MESSAGES("last_messages")` - - - `Optional lastMessages` - - The number of most recent messages from the thread when constructing the context for the run. - - - `Optional usage` - - Usage statistics related to the run. This value will be `null` if the run is not in a terminal state (i.e. `in_progress`, `queued`, etc.). - - - `long completionTokens` - - Number of completion tokens used over the course of the run. - - - `long promptTokens` - - Number of prompt tokens used over the course of the run. - - - `long totalTokens` - - Total number of tokens used (prompt + completion). - - - `Optional temperature` - - The sampling temperature used for this run. If not set, defaults to 1. - - - `Optional topP` - - The nucleus sampling value used for this run. If not set, defaults to 1. - - - `JsonValue; event "thread.run.created"constant` - - - `THREAD_RUN_CREATED("thread.run.created")` - - - `ThreadRunQueued` - - - `Run data` - - Represents an execution run on a [thread](https://platform.openai.com/docs/api-reference/threads). - - - `JsonValue; event "thread.run.queued"constant` - - - `THREAD_RUN_QUEUED("thread.run.queued")` - - - `ThreadRunInProgress` - - - `Run data` - - Represents an execution run on a [thread](https://platform.openai.com/docs/api-reference/threads). - - - `JsonValue; event "thread.run.in_progress"constant` - - - `THREAD_RUN_IN_PROGRESS("thread.run.in_progress")` - - - `ThreadRunRequiresAction` - - - `Run data` - - Represents an execution run on a [thread](https://platform.openai.com/docs/api-reference/threads). - - - `JsonValue; event "thread.run.requires_action"constant` - - - `THREAD_RUN_REQUIRES_ACTION("thread.run.requires_action")` - - - `ThreadRunCompleted` - - - `Run data` - - Represents an execution run on a [thread](https://platform.openai.com/docs/api-reference/threads). - - - `JsonValue; event "thread.run.completed"constant` - - - `THREAD_RUN_COMPLETED("thread.run.completed")` - - - `ThreadRunIncomplete` - - - `Run data` - - Represents an execution run on a [thread](https://platform.openai.com/docs/api-reference/threads). - - - `JsonValue; event "thread.run.incomplete"constant` - - - `THREAD_RUN_INCOMPLETE("thread.run.incomplete")` - - - `ThreadRunFailed` - - - `Run data` - - Represents an execution run on a [thread](https://platform.openai.com/docs/api-reference/threads). - - - `JsonValue; event "thread.run.failed"constant` - - - `THREAD_RUN_FAILED("thread.run.failed")` - - - `ThreadRunCancelling` - - - `Run data` - - Represents an execution run on a [thread](https://platform.openai.com/docs/api-reference/threads). - - - `JsonValue; event "thread.run.cancelling"constant` - - - `THREAD_RUN_CANCELLING("thread.run.cancelling")` - - - `ThreadRunCancelled` - - - `Run data` - - Represents an execution run on a [thread](https://platform.openai.com/docs/api-reference/threads). - - - `JsonValue; event "thread.run.cancelled"constant` - - - `THREAD_RUN_CANCELLED("thread.run.cancelled")` - - - `ThreadRunExpired` - - - `Run data` - - Represents an execution run on a [thread](https://platform.openai.com/docs/api-reference/threads). - - - `JsonValue; event "thread.run.expired"constant` - - - `THREAD_RUN_EXPIRED("thread.run.expired")` - -### Thread Stream Event - -- `class ThreadStreamEvent:` - - Occurs when a new [thread](https://platform.openai.com/docs/api-reference/threads/object) is created. - - - `Thread data` - - Represents a thread that contains [messages](https://platform.openai.com/docs/api-reference/messages). - - - `String id` - - The identifier, which can be referenced in API endpoints. - - - `long createdAt` - - The Unix timestamp (in seconds) for when the thread was created. - - - `Optional metadata` - - Set of 16 key-value pairs that can be attached to an object. This can be - useful for storing additional information about the object in a structured - format, and querying for objects via API or the dashboard. - - Keys are strings with a maximum length of 64 characters. Values are strings - with a maximum length of 512 characters. - - - `JsonValue; object_ "thread"constant` - - The object type, which is always `thread`. - - - `THREAD("thread")` - - - `Optional toolResources` - - A set of resources that are made available to the assistant's tools in this thread. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs. - - - `Optional codeInterpreter` - - - `Optional> fileIds` - - A list of [file](https://platform.openai.com/docs/api-reference/files) IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files associated with the tool. - - - `Optional fileSearch` - - - `Optional> vectorStoreIds` - - The [vector store](https://platform.openai.com/docs/api-reference/vector-stores/object) attached to this thread. There can be a maximum of 1 vector store attached to the thread. - - - `JsonValue; event "thread.created"constant` - - - `THREAD_CREATED("thread.created")` - - - `Optional enabled` - - Whether to enable input audio transcription.