diff --git a/en/resources/beta/subresources/assistants/streaming-events.md b/en/resources/beta/subresources/assistants/streaming-events.md index bd0562c6..0bd132aa 100644 --- a/en/resources/beta/subresources/assistants/streaming-events.md +++ b/en/resources/beta/subresources/assistants/streaming-events.md @@ -1,15 +1,15 @@ # Assistants streaming events Stream the result of executing a Run or resuming a Run after submitting tool outputs. -You can stream events from the [Create Thread and Run](https://platform.openai.com/docs/api-reference/runs/createThreadAndRun), -[Create Run](https://platform.openai.com/docs/api-reference/runs/createRun), and [Submit Tool Outputs](https://platform.openai.com/docs/api-reference/runs/submitToolOutputs) +You can stream events from the [Create Thread and Run](https://developers.openai.com/docs/api-reference/runs/createThreadAndRun), +[Create Run](https://developers.openai.com/docs/api-reference/runs/createRun), and [Submit Tool Outputs](https://developers.openai.com/docs/api-reference/runs/submitToolOutputs) endpoints by passing `"stream": true`. The response will be a [Server-Sent events](https://html.spec.whatwg.org/multipage/server-sent-events.html#server-sent-events) stream. Our Node and Python SDKs provide helpful utilities to make streaming easy. Reference the -[Assistants API quickstart](https://platform.openai.com/docs/assistants/overview) to learn more. +[Assistants API quickstart](https://developers.openai.com/docs/assistants/overview) to learn more. ## event -Occurs when a new [thread](https://platform.openai.com/docs/api-reference/threads/object) is created. +Occurs when a new [thread](https://developers.openai.com/docs/api-reference/threads/object) is created. ### Schema @@ -19,8 +19,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch { "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 0": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/ThreadStreamEvent/anyOf/0", - "ident": "ThreadCreated", + "oasRef": "#/components/schemas/ThreadStreamEvent/oneOf/0", + "ident": "UnionMember0", "type": { "kind": "HttpTypeObject", "members": [ @@ -35,7 +35,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Occurs when a new [thread](https://platform.openai.com/docs/api-reference/threads/object) is created.", + "docstring": "Occurs when a new [thread](/docs/api-reference/threads/object) is created.", "childrenParentSchema": "object", "children": [ "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 0 > (property) data", @@ -46,7 +46,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 0 > (property) data": { "kind": "HttpDeclProperty", "title": "Thread", - "docstring": "Represents a thread that contains [messages](https://platform.openai.com/docs/api-reference/messages).", + "docstring": "Represents a thread that contains [messages](/docs/api-reference/messages).", "key": "data", "optional": false, "nullable": false, @@ -55,7 +55,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "ident": "Thread", "$ref": "(resource) beta.threads > (model) thread > (schema)" }, - "oasRef": "#/components/schemas/ThreadStreamEvent/anyOf/0/properties/data", + "oasRef": "#/components/schemas/ThreadStreamEvent/oneOf/0/properties/data", "deprecated": false, "schemaType": "object", "modelImplicit": false, @@ -82,9 +82,9 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "literal": "thread.created" } ], - "oasRef": "#/components/schemas/ThreadStreamEvent/anyOf/0/properties/event" + "oasRef": "#/components/schemas/ThreadStreamEvent/oneOf/0/properties/event" }, - "oasRef": "#/components/schemas/ThreadStreamEvent/anyOf/0/properties/event", + "oasRef": "#/components/schemas/ThreadStreamEvent/oneOf/0/properties/event", "deprecated": false, "schemaType": "enum", "childrenParentSchema": "enum", @@ -101,7 +101,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "type": { "kind": "HttpTypeBoolean" }, - "oasRef": "#/components/schemas/ThreadStreamEvent/anyOf/0/properties/enabled", + "oasRef": "#/components/schemas/ThreadStreamEvent/oneOf/0/properties/enabled", "deprecated": false, "schemaType": "boolean", "children": [] @@ -229,7 +229,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Represents a thread that contains [messages](https://platform.openai.com/docs/api-reference/messages).", + "docstring": "Represents a thread that contains [messages](/docs/api-reference/messages).", "childrenParentSchema": "object", "children": [ "(resource) beta.threads > (model) thread > (schema) > (property) id", @@ -317,7 +317,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads > (model) thread > (schema) > (property) tool_resources > (property) code_interpreter > (property) file_ids": { "kind": "HttpDeclProperty", - "docstring": "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.\n", + "docstring": "A list of [file](/docs/api-reference/files) IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files associated with the tool.\n", "key": "file_ids", "optional": true, "nullable": false, @@ -336,7 +336,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads > (model) thread > (schema) > (property) tool_resources > (property) file_search > (property) vector_store_ids": { "kind": "HttpDeclProperty", - "docstring": "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.\n", + "docstring": "The [vector store](/docs/api-reference/vector-stores/object) attached to this thread. There can be a maximum of 1 vector store attached to the thread.\n", "key": "vector_store_ids", "optional": true, "nullable": false, @@ -363,7 +363,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch ## event -Occurs when a new [run](https://platform.openai.com/docs/api-reference/runs/object) is created. +Occurs when a new [run](https://developers.openai.com/docs/api-reference/runs/object) is created. ### Schema @@ -373,8 +373,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch { "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 1": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RunStreamEvent/anyOf/0", - "ident": "ThreadRunCreated", + "oasRef": "#/components/schemas/RunStreamEvent/oneOf/0", + "ident": "UnionMember1", "type": { "kind": "HttpTypeObject", "members": [ @@ -386,7 +386,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Occurs when a new [run](https://platform.openai.com/docs/api-reference/runs/object) is created.", + "docstring": "Occurs when a new [run](/docs/api-reference/runs/object) is created.", "childrenParentSchema": "object", "children": [ "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 1 > (property) data", @@ -396,7 +396,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 1 > (property) data": { "kind": "HttpDeclProperty", "title": "A run on a thread", - "docstring": "Represents an execution run on a [thread](https://platform.openai.com/docs/api-reference/threads).", + "docstring": "Represents an execution run on a [thread](/docs/api-reference/threads).", "key": "data", "optional": false, "nullable": false, @@ -405,7 +405,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "ident": "Run", "$ref": "(resource) beta.threads.runs > (model) run > (schema)" }, - "oasRef": "#/components/schemas/RunStreamEvent/anyOf/0/properties/data", + "oasRef": "#/components/schemas/RunStreamEvent/oneOf/0/properties/data", "deprecated": false, "schemaType": "object", "modelImplicit": false, @@ -454,9 +454,9 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "literal": "thread.run.created" } ], - "oasRef": "#/components/schemas/RunStreamEvent/anyOf/0/properties/event" + "oasRef": "#/components/schemas/RunStreamEvent/oneOf/0/properties/event" }, - "oasRef": "#/components/schemas/RunStreamEvent/anyOf/0/properties/event", + "oasRef": "#/components/schemas/RunStreamEvent/oneOf/0/properties/event", "deprecated": false, "schemaType": "enum", "childrenParentSchema": "enum", @@ -480,7 +480,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) assistant_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for execution of this run.", + "docstring": "The ID of the [assistant](/docs/api-reference/assistants) used for execution of this run.", "key": "assistant_id", "optional": false, "nullable": false, @@ -601,7 +601,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) instructions": { "kind": "HttpDeclProperty", - "docstring": "The instructions that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run.", + "docstring": "The instructions that the [assistant](/docs/api-reference/assistants) used for this run.", "key": "instructions", "optional": false, "nullable": false, @@ -693,7 +693,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) model": { "kind": "HttpDeclProperty", - "docstring": "The model that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run.", + "docstring": "The model that the [assistant](/docs/api-reference/assistants) used for this run.", "key": "model", "optional": false, "nullable": false, @@ -731,7 +731,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) parallel_tool_calls": { "kind": "HttpDeclProperty", - "docstring": "Whether to enable [parallel function calling](https://platform.openai.com/docs/guides/function-calling#configuring-parallel-function-calling) during tool use.", + "docstring": "Whether to enable [parallel function calling](/docs/guides/function-calling#configuring-parallel-function-calling) during tool use.", "key": "parallel_tool_calls", "optional": false, "nullable": false, @@ -772,7 +772,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) response_format": { "kind": "HttpDeclProperty", - "docstring": "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`.\n\nSetting 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).\n\nSetting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\n**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.\n", + "docstring": "Specifies the format that the model must output. Compatible with [GPT-4o](/docs/models#gpt-4o), [GPT-4 Turbo](/docs/models#gpt-4-turbo-and-gpt-4), and all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`.\n\nSetting 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](/docs/guides/structured-outputs).\n\nSetting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\n**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.\n", "key": "response_format", "optional": false, "nullable": true, @@ -818,31 +818,66 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "optional": false, "nullable": false, "type": { - "kind": "HttpTypeReference", - "ident": "RunStatus", - "$ref": "(resource) beta.threads.runs > (model) run_status > (schema)" + "kind": "HttpTypeUnion", + "types": [ + { + "kind": "HttpTypeLiteral", + "literal": "queued" + }, + { + "kind": "HttpTypeLiteral", + "literal": "in_progress" + }, + { + "kind": "HttpTypeLiteral", + "literal": "requires_action" + }, + { + "kind": "HttpTypeLiteral", + "literal": "cancelling" + }, + { + "kind": "HttpTypeLiteral", + "literal": "cancelled" + }, + { + "kind": "HttpTypeLiteral", + "literal": "failed" + }, + { + "kind": "HttpTypeLiteral", + "literal": "completed" + }, + { + "kind": "HttpTypeLiteral", + "literal": "incomplete" + }, + { + "kind": "HttpTypeLiteral", + "literal": "expired" + } + ], + "oasRef": "#/components/schemas/RunObject/properties/status" }, "oasRef": "#/components/schemas/RunObject/properties/status", "deprecated": false, "schemaType": "enum", - "modelImplicit": false, - "modelPath": "(resource) beta.threads.runs > (model) run_status", "childrenParentSchema": "enum", "children": [ - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 0", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 1", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 2", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 3", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 4", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 5", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 6", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 7", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 8" + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 0", + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 1", + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 2", + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 3", + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 4", + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 5", + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 6", + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 7", + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 8" ] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) thread_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the [thread](https://platform.openai.com/docs/api-reference/threads) that was executed on as a part of this run.", + "docstring": "The ID of the [thread](/docs/api-reference/threads) that was executed on as a part of this run.", "key": "thread_id", "optional": false, "nullable": false, @@ -878,7 +913,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) tools": { "kind": "HttpDeclProperty", - "docstring": "The list of tools that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run.", + "docstring": "The list of tools that the [assistant](/docs/api-reference/assistants) used for this run.", "key": "tools", "optional": false, "nullable": false, @@ -886,9 +921,25 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "type": { "kind": "HttpTypeArray", "elementType": { + "kind": "HttpTypeUnion", + "types": [ + { "kind": "HttpTypeReference", - "ident": "AssistantTool", - "$ref": "(resource) beta.assistants > (model) assistant_tool > (schema)" + "ident": "CodeInterpreterTool", + "$ref": "(resource) beta.assistants > (model) code_interpreter_tool > (schema)" + }, + { + "kind": "HttpTypeReference", + "ident": "FileSearchTool", + "$ref": "(resource) beta.assistants > (model) file_search_tool > (schema)" + }, + { + "kind": "HttpTypeReference", + "ident": "FunctionTool", + "$ref": "(resource) beta.assistants > (model) function_tool > (schema)" + } + ], + "oasRef": "#/components/schemas/RunObject/properties/tools/items" }, "oasRef": "#/components/schemas/RunObject/properties/tools" }, @@ -897,9 +948,9 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "schemaType": "array", "childrenParentSchema": "union", "children": [ - "(resource) beta.assistants > (model) assistant_tool > (schema) > (variant) 0", - "(resource) beta.assistants > (model) assistant_tool > (schema) > (variant) 1", - "(resource) beta.assistants > (model) assistant_tool > (schema) > (variant) 2" + "(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 0", + "(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 1", + "(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 2" ] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy": { @@ -1077,7 +1128,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Represents an execution run on a [thread](https://platform.openai.com/docs/api-reference/threads).", + "docstring": "Represents an execution run on a [thread](/docs/api-reference/threads).", "childrenParentSchema": "object", "children": [ "(resource) beta.threads.runs > (model) run > (schema) > (property) id", @@ -1268,7 +1319,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 0": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/anyOf/0", + "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/oneOf/0", "ident": "UnionMember0", "type": { "kind": "HttpTypeUnion", @@ -1278,7 +1329,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "literal": "auto" } ], - "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/anyOf/0" + "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/oneOf/0" }, "docstring": "`auto` is the default value\n", "childrenParentSchema": "enum", @@ -1338,7 +1389,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "literal": "auto" } ], - "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/anyOf/0" + "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/oneOf/0" }, { "kind": "HttpTypeReference", @@ -1358,7 +1409,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch ], "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption" }, - "docstring": "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`.\n\nSetting 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).\n\nSetting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\n**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.\n", + "docstring": "Specifies the format that the model must output. Compatible with [GPT-4o](/docs/models#gpt-4o), [GPT-4 Turbo](/docs/models#gpt-4-turbo-and-gpt-4), and all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`.\n\nSetting 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](/docs/guides/structured-outputs).\n\nSetting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\n**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.\n", "childrenParentSchema": "union", "children": [ "(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 0", @@ -1367,133 +1418,73 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 3" ] }, - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 0": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "queued" } }, - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 1": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 1": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "in_progress" } }, - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 2": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 2": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "requires_action" } }, - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 3": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 3": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "cancelling" } }, - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 4": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 4": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "cancelled" } }, - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 5": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 5": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "failed" } }, - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 6": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 6": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "completed" } }, - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 7": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 7": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "incomplete" } }, - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 8": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 8": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "expired" } }, - "(resource) beta.threads.runs > (model) run_status > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RunStatus", - "ident": "RunStatus", - "type": { - "kind": "HttpTypeUnion", - "types": [ - { - "kind": "HttpTypeLiteral", - "literal": "queued" - }, - { - "kind": "HttpTypeLiteral", - "literal": "in_progress" - }, - { - "kind": "HttpTypeLiteral", - "literal": "requires_action" - }, - { - "kind": "HttpTypeLiteral", - "literal": "cancelling" - }, - { - "kind": "HttpTypeLiteral", - "literal": "cancelled" - }, - { - "kind": "HttpTypeLiteral", - "literal": "failed" - }, - { - "kind": "HttpTypeLiteral", - "literal": "completed" - }, - { - "kind": "HttpTypeLiteral", - "literal": "incomplete" - }, - { - "kind": "HttpTypeLiteral", - "literal": "expired" - } - ], - "oasRef": "#/components/schemas/RunStatus" - }, - "docstring": "The status of the run, which can be either `queued`, `in_progress`, `requires_action`, `cancelling`, `cancelled`, `failed`, `completed`, `incomplete`, or `expired`.", - "childrenParentSchema": "enum", - "children": [ - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 0", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 1", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 2", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 3", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 4", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 5", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 6", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 7", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 8" - ] - }, "(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption/anyOf/0", - "ident": "Auto", + "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption/oneOf/0", + "ident": "UnionMember0", "type": { "kind": "HttpTypeUnion", "types": [ @@ -1510,7 +1501,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "literal": "required" } ], - "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption/anyOf/0" + "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption/oneOf/0" }, "docstring": "`none` means the model will not call any tools and instead generates a message. `auto` means the model can pick between generating a message or calling one or more tools. `required` means the model must call one or more tools before responding to the user.\n", "childrenParentSchema": "enum", @@ -1556,7 +1547,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "literal": "required" } ], - "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption/anyOf/0" + "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption/oneOf/0" }, { "kind": "HttpTypeReference", @@ -1573,7 +1564,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 1" ] }, - "(resource) beta.assistants > (model) assistant_tool > (schema) > (variant) 0": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", @@ -1585,7 +1576,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type" ] }, - "(resource) beta.assistants > (model) assistant_tool > (schema) > (variant) 1": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 1": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", @@ -1598,7 +1589,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search" ] }, - "(resource) beta.assistants > (model) assistant_tool > (schema) > (variant) 2": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 2": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", @@ -1611,36 +1602,63 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.assistants > (model) function_tool > (schema) > (property) type" ] }, - "(resource) beta.assistants > (model) assistant_tool > (schema)": { + "(resource) beta.assistants > (model) code_interpreter_tool > (schema)": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/AssistantTool", - "ident": "AssistantTool", + "oasRef": "#/components/schemas/AssistantToolsCode", + "ident": "CodeInterpreterTool", "type": { - "kind": "HttpTypeUnion", - "types": [ + "kind": "HttpTypeObject", + "members": [ { - "kind": "HttpTypeReference", - "ident": "CodeInterpreterTool", - "$ref": "(resource) beta.assistants > (model) code_interpreter_tool > (schema)" + "ident": "type" + } + ] }, - { - "kind": "HttpTypeReference", + "childrenParentSchema": "object", + "children": [ + "(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type" + ] + }, + "(resource) beta.assistants > (model) file_search_tool > (schema)": { + "kind": "HttpDeclTypeAlias", + "oasRef": "#/components/schemas/AssistantToolsFileSearch", "ident": "FileSearchTool", - "$ref": "(resource) beta.assistants > (model) file_search_tool > (schema)" + "type": { + "kind": "HttpTypeObject", + "members": [ + { + "ident": "type" }, { - "kind": "HttpTypeReference", + "ident": "file_search" + } + ] + }, + "childrenParentSchema": "object", + "children": [ + "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) type", + "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search" + ] + }, + "(resource) beta.assistants > (model) function_tool > (schema)": { + "kind": "HttpDeclTypeAlias", + "oasRef": "#/components/schemas/AssistantToolsFunction", "ident": "FunctionTool", - "$ref": "(resource) beta.assistants > (model) function_tool > (schema)" + "type": { + "kind": "HttpTypeObject", + "members": [ + { + "ident": "function" + }, + { + "ident": "type" } - ], - "oasRef": "#/components/schemas/AssistantTool" + ] }, - "childrenParentSchema": "union", + "childrenParentSchema": "object", "children": [ - "(resource) beta.assistants > (model) assistant_tool > (schema) > (variant) 0", - "(resource) beta.assistants > (model) assistant_tool > (schema) > (variant) 1", - "(resource) beta.assistants > (model) assistant_tool > (schema) > (variant) 2" + "(resource) beta.assistants > (model) function_tool > (schema) > (property) function", + "(resource) beta.assistants > (model) function_tool > (schema) > (property) type" ] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) type": { @@ -1963,7 +1981,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "JSON Schema response format. Used to generate structured JSON responses.\nLearn more about [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs).\n", + "docstring": "JSON Schema response format. Used to generate structured JSON responses.\nLearn more about [Structured Outputs](/docs/guides/structured-outputs).\n", "childrenParentSchema": "object", "children": [ "(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema", @@ -2091,23 +2109,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type > (member) 0" ] }, - "(resource) beta.assistants > (model) code_interpreter_tool > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/AssistantToolsCode", - "ident": "CodeInterpreterTool", - "type": { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "type" - } - ] - }, - "childrenParentSchema": "object", - "children": [ - "(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type" - ] - }, "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) type": { "kind": "HttpDeclProperty", "docstring": "The type of tool being defined: `file_search`", @@ -2158,27 +2159,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options" ] }, - "(resource) beta.assistants > (model) file_search_tool > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/AssistantToolsFileSearch", - "ident": "FileSearchTool", - "type": { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "type" - }, - { - "ident": "file_search" - } - ] - }, - "childrenParentSchema": "object", - "children": [ - "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) type", - "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search" - ] - }, "(resource) beta.assistants > (model) function_tool > (schema) > (property) function": { "kind": "HttpDeclProperty", "key": "function", @@ -2226,27 +2206,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.assistants > (model) function_tool > (schema) > (property) type > (member) 0" ] }, - "(resource) beta.assistants > (model) function_tool > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/AssistantToolsFunction", - "ident": "FunctionTool", - "type": { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "function" - }, - { - "ident": "type" - } - ] - }, - "childrenParentSchema": "object", - "children": [ - "(resource) beta.assistants > (model) function_tool > (schema) > (property) function", - "(resource) beta.assistants > (model) function_tool > (schema) > (property) type" - ] - }, "(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { @@ -2263,7 +2222,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "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.", + "docstring": "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](/docs/api-reference/runs/submitToolOutputs) endpoint.", "key": "id", "optional": false, "nullable": false, @@ -2420,7 +2379,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema > (property) strict": { "kind": "HttpDeclProperty", - "docstring": "Whether to enable strict schema adherence when generating the output.\nIf set to true, the model will always follow the exact schema defined\nin the `schema` field. Only a subset of JSON Schema is supported when\n`strict` is `true`. To learn more, read the [Structured Outputs\nguide](https://platform.openai.com/docs/guides/structured-outputs).\n", + "docstring": "Whether to enable strict schema adherence when generating the output.\nIf set to true, the model will always follow the exact schema defined\nin the `schema` field. Only a subset of JSON Schema is supported when\n`strict` is `true`. To learn more, read the [Structured Outputs\nguide](/docs/guides/structured-outputs).\n", "key": "strict", "optional": true, "nullable": true, @@ -2508,7 +2467,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) max_num_results": { "kind": "HttpDeclProperty", - "docstring": "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.\n\nNote 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.\n", + "docstring": "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.\n\nNote that the file search tool may output fewer than `max_num_results` results. See the [file search tool documentation](/docs/assistants/tools/file-search#customizing-file-search-settings) for more information.\n", "key": "max_num_results", "optional": true, "nullable": false, @@ -2527,7 +2486,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options": { "kind": "HttpDeclProperty", "title": "File search tool call ranking options", - "docstring": "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.\n\nSee the [file search tool documentation](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) for more information.\n", + "docstring": "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.\n\nSee the [file search tool documentation](/docs/assistants/tools/file-search#customizing-file-search-settings) for more information.\n", "key": "ranking_options", "optional": true, "nullable": false, @@ -2581,7 +2540,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) $shared > (model) function_definition > (schema) > (property) parameters": { "kind": "HttpDeclProperty", - "docstring": "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. \n\nOmitting `parameters` defines a function with an empty parameter list.", + "docstring": "The parameters the functions accepts, described as a JSON Schema object. See the [guide](/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. \n\nOmitting `parameters` defines a function with an empty parameter list.", "key": "parameters", "optional": true, "nullable": false, @@ -2599,7 +2558,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) $shared > (model) function_definition > (schema) > (property) strict": { "kind": "HttpDeclProperty", - "docstring": "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).", + "docstring": "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](/docs/guides/function-calling).", "key": "strict", "optional": true, "nullable": true, @@ -2747,7 +2706,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch ], "oasRef": "#/components/schemas/FunctionParameters" }, - "docstring": "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. \n\nOmitting `parameters` defines a function with an empty parameter list.", + "docstring": "The parameters the functions accepts, described as a JSON Schema object. See the [guide](/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. \n\nOmitting `parameters` defines a function with an empty parameter list.", "children": [] }, "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options > (property) ranker > (member) 0": { @@ -2775,7 +2734,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch ## event -Occurs when a [run](https://platform.openai.com/docs/api-reference/runs/object) moves to a `queued` status. +Occurs when a [run](https://developers.openai.com/docs/api-reference/runs/object) moves to a `queued` status. ### Schema @@ -2785,8 +2744,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch { "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 2": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RunStreamEvent/anyOf/1", - "ident": "ThreadRunQueued", + "oasRef": "#/components/schemas/RunStreamEvent/oneOf/1", + "ident": "UnionMember2", "type": { "kind": "HttpTypeObject", "members": [ @@ -2798,7 +2757,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Occurs when a [run](https://platform.openai.com/docs/api-reference/runs/object) moves to a `queued` status.", + "docstring": "Occurs when a [run](/docs/api-reference/runs/object) moves to a `queued` status.", "childrenParentSchema": "object", "children": [ "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 2 > (property) data", @@ -2808,7 +2767,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 2 > (property) data": { "kind": "HttpDeclProperty", "title": "A run on a thread", - "docstring": "Represents an execution run on a [thread](https://platform.openai.com/docs/api-reference/threads).", + "docstring": "Represents an execution run on a [thread](/docs/api-reference/threads).", "key": "data", "optional": false, "nullable": false, @@ -2817,7 +2776,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "ident": "Run", "$ref": "(resource) beta.threads.runs > (model) run > (schema)" }, - "oasRef": "#/components/schemas/RunStreamEvent/anyOf/1/properties/data", + "oasRef": "#/components/schemas/RunStreamEvent/oneOf/1/properties/data", "deprecated": false, "schemaType": "object", "modelImplicit": false, @@ -2866,9 +2825,9 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "literal": "thread.run.queued" } ], - "oasRef": "#/components/schemas/RunStreamEvent/anyOf/1/properties/event" + "oasRef": "#/components/schemas/RunStreamEvent/oneOf/1/properties/event" }, - "oasRef": "#/components/schemas/RunStreamEvent/anyOf/1/properties/event", + "oasRef": "#/components/schemas/RunStreamEvent/oneOf/1/properties/event", "deprecated": false, "schemaType": "enum", "childrenParentSchema": "enum", @@ -2892,7 +2851,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) assistant_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for execution of this run.", + "docstring": "The ID of the [assistant](/docs/api-reference/assistants) used for execution of this run.", "key": "assistant_id", "optional": false, "nullable": false, @@ -3013,7 +2972,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) instructions": { "kind": "HttpDeclProperty", - "docstring": "The instructions that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run.", + "docstring": "The instructions that the [assistant](/docs/api-reference/assistants) used for this run.", "key": "instructions", "optional": false, "nullable": false, @@ -3105,7 +3064,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) model": { "kind": "HttpDeclProperty", - "docstring": "The model that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run.", + "docstring": "The model that the [assistant](/docs/api-reference/assistants) used for this run.", "key": "model", "optional": false, "nullable": false, @@ -3143,7 +3102,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) parallel_tool_calls": { "kind": "HttpDeclProperty", - "docstring": "Whether to enable [parallel function calling](https://platform.openai.com/docs/guides/function-calling#configuring-parallel-function-calling) during tool use.", + "docstring": "Whether to enable [parallel function calling](/docs/guides/function-calling#configuring-parallel-function-calling) during tool use.", "key": "parallel_tool_calls", "optional": false, "nullable": false, @@ -3184,7 +3143,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) response_format": { "kind": "HttpDeclProperty", - "docstring": "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`.\n\nSetting 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).\n\nSetting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\n**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.\n", + "docstring": "Specifies the format that the model must output. Compatible with [GPT-4o](/docs/models#gpt-4o), [GPT-4 Turbo](/docs/models#gpt-4-turbo-and-gpt-4), and all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`.\n\nSetting 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](/docs/guides/structured-outputs).\n\nSetting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\n**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.\n", "key": "response_format", "optional": false, "nullable": true, @@ -3230,31 +3189,66 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "optional": false, "nullable": false, "type": { - "kind": "HttpTypeReference", - "ident": "RunStatus", - "$ref": "(resource) beta.threads.runs > (model) run_status > (schema)" + "kind": "HttpTypeUnion", + "types": [ + { + "kind": "HttpTypeLiteral", + "literal": "queued" + }, + { + "kind": "HttpTypeLiteral", + "literal": "in_progress" + }, + { + "kind": "HttpTypeLiteral", + "literal": "requires_action" + }, + { + "kind": "HttpTypeLiteral", + "literal": "cancelling" + }, + { + "kind": "HttpTypeLiteral", + "literal": "cancelled" + }, + { + "kind": "HttpTypeLiteral", + "literal": "failed" + }, + { + "kind": "HttpTypeLiteral", + "literal": "completed" + }, + { + "kind": "HttpTypeLiteral", + "literal": "incomplete" + }, + { + "kind": "HttpTypeLiteral", + "literal": "expired" + } + ], + "oasRef": "#/components/schemas/RunObject/properties/status" }, "oasRef": "#/components/schemas/RunObject/properties/status", "deprecated": false, "schemaType": "enum", - "modelImplicit": false, - "modelPath": "(resource) beta.threads.runs > (model) run_status", "childrenParentSchema": "enum", "children": [ - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 0", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 1", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 2", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 3", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 4", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 5", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 6", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 7", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 8" + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 0", + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 1", + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 2", + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 3", + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 4", + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 5", + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 6", + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 7", + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 8" ] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) thread_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the [thread](https://platform.openai.com/docs/api-reference/threads) that was executed on as a part of this run.", + "docstring": "The ID of the [thread](/docs/api-reference/threads) that was executed on as a part of this run.", "key": "thread_id", "optional": false, "nullable": false, @@ -3290,7 +3284,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) tools": { "kind": "HttpDeclProperty", - "docstring": "The list of tools that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run.", + "docstring": "The list of tools that the [assistant](/docs/api-reference/assistants) used for this run.", "key": "tools", "optional": false, "nullable": false, @@ -3298,9 +3292,25 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "type": { "kind": "HttpTypeArray", "elementType": { + "kind": "HttpTypeUnion", + "types": [ + { + "kind": "HttpTypeReference", + "ident": "CodeInterpreterTool", + "$ref": "(resource) beta.assistants > (model) code_interpreter_tool > (schema)" + }, + { + "kind": "HttpTypeReference", + "ident": "FileSearchTool", + "$ref": "(resource) beta.assistants > (model) file_search_tool > (schema)" + }, + { "kind": "HttpTypeReference", - "ident": "AssistantTool", - "$ref": "(resource) beta.assistants > (model) assistant_tool > (schema)" + "ident": "FunctionTool", + "$ref": "(resource) beta.assistants > (model) function_tool > (schema)" + } + ], + "oasRef": "#/components/schemas/RunObject/properties/tools/items" }, "oasRef": "#/components/schemas/RunObject/properties/tools" }, @@ -3309,9 +3319,9 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "schemaType": "array", "childrenParentSchema": "union", "children": [ - "(resource) beta.assistants > (model) assistant_tool > (schema) > (variant) 0", - "(resource) beta.assistants > (model) assistant_tool > (schema) > (variant) 1", - "(resource) beta.assistants > (model) assistant_tool > (schema) > (variant) 2" + "(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 0", + "(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 1", + "(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 2" ] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy": { @@ -3489,7 +3499,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Represents an execution run on a [thread](https://platform.openai.com/docs/api-reference/threads).", + "docstring": "Represents an execution run on a [thread](/docs/api-reference/threads).", "childrenParentSchema": "object", "children": [ "(resource) beta.threads.runs > (model) run > (schema) > (property) id", @@ -3680,7 +3690,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 0": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/anyOf/0", + "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/oneOf/0", "ident": "UnionMember0", "type": { "kind": "HttpTypeUnion", @@ -3690,7 +3700,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "literal": "auto" } ], - "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/anyOf/0" + "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/oneOf/0" }, "docstring": "`auto` is the default value\n", "childrenParentSchema": "enum", @@ -3750,7 +3760,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "literal": "auto" } ], - "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/anyOf/0" + "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/oneOf/0" }, { "kind": "HttpTypeReference", @@ -3770,7 +3780,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch ], "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption" }, - "docstring": "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`.\n\nSetting 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).\n\nSetting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\n**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.\n", + "docstring": "Specifies the format that the model must output. Compatible with [GPT-4o](/docs/models#gpt-4o), [GPT-4 Turbo](/docs/models#gpt-4-turbo-and-gpt-4), and all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`.\n\nSetting 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](/docs/guides/structured-outputs).\n\nSetting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\n**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.\n", "childrenParentSchema": "union", "children": [ "(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 0", @@ -3779,133 +3789,73 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 3" ] }, - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 0": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "queued" } }, - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 1": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 1": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "in_progress" } }, - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 2": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 2": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "requires_action" } }, - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 3": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 3": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "cancelling" } }, - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 4": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 4": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "cancelled" } }, - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 5": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 5": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "failed" } }, - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 6": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 6": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "completed" } }, - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 7": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 7": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "incomplete" } }, - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 8": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 8": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "expired" } }, - "(resource) beta.threads.runs > (model) run_status > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RunStatus", - "ident": "RunStatus", - "type": { - "kind": "HttpTypeUnion", - "types": [ - { - "kind": "HttpTypeLiteral", - "literal": "queued" - }, - { - "kind": "HttpTypeLiteral", - "literal": "in_progress" - }, - { - "kind": "HttpTypeLiteral", - "literal": "requires_action" - }, - { - "kind": "HttpTypeLiteral", - "literal": "cancelling" - }, - { - "kind": "HttpTypeLiteral", - "literal": "cancelled" - }, - { - "kind": "HttpTypeLiteral", - "literal": "failed" - }, - { - "kind": "HttpTypeLiteral", - "literal": "completed" - }, - { - "kind": "HttpTypeLiteral", - "literal": "incomplete" - }, - { - "kind": "HttpTypeLiteral", - "literal": "expired" - } - ], - "oasRef": "#/components/schemas/RunStatus" - }, - "docstring": "The status of the run, which can be either `queued`, `in_progress`, `requires_action`, `cancelling`, `cancelled`, `failed`, `completed`, `incomplete`, or `expired`.", - "childrenParentSchema": "enum", - "children": [ - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 0", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 1", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 2", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 3", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 4", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 5", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 6", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 7", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 8" - ] - }, "(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption/anyOf/0", - "ident": "Auto", + "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption/oneOf/0", + "ident": "UnionMember0", "type": { "kind": "HttpTypeUnion", "types": [ @@ -3922,7 +3872,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "literal": "required" } ], - "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption/anyOf/0" + "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption/oneOf/0" }, "docstring": "`none` means the model will not call any tools and instead generates a message. `auto` means the model can pick between generating a message or calling one or more tools. `required` means the model must call one or more tools before responding to the user.\n", "childrenParentSchema": "enum", @@ -3968,7 +3918,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "literal": "required" } ], - "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption/anyOf/0" + "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption/oneOf/0" }, { "kind": "HttpTypeReference", @@ -3985,7 +3935,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 1" ] }, - "(resource) beta.assistants > (model) assistant_tool > (schema) > (variant) 0": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", @@ -3997,7 +3947,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type" ] }, - "(resource) beta.assistants > (model) assistant_tool > (schema) > (variant) 1": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 1": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", @@ -4010,7 +3960,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search" ] }, - "(resource) beta.assistants > (model) assistant_tool > (schema) > (variant) 2": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 2": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", @@ -4023,36 +3973,63 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.assistants > (model) function_tool > (schema) > (property) type" ] }, - "(resource) beta.assistants > (model) assistant_tool > (schema)": { + "(resource) beta.assistants > (model) code_interpreter_tool > (schema)": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/AssistantTool", - "ident": "AssistantTool", + "oasRef": "#/components/schemas/AssistantToolsCode", + "ident": "CodeInterpreterTool", "type": { - "kind": "HttpTypeUnion", - "types": [ + "kind": "HttpTypeObject", + "members": [ { - "kind": "HttpTypeReference", - "ident": "CodeInterpreterTool", - "$ref": "(resource) beta.assistants > (model) code_interpreter_tool > (schema)" + "ident": "type" + } + ] }, - { - "kind": "HttpTypeReference", + "childrenParentSchema": "object", + "children": [ + "(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type" + ] + }, + "(resource) beta.assistants > (model) file_search_tool > (schema)": { + "kind": "HttpDeclTypeAlias", + "oasRef": "#/components/schemas/AssistantToolsFileSearch", "ident": "FileSearchTool", - "$ref": "(resource) beta.assistants > (model) file_search_tool > (schema)" + "type": { + "kind": "HttpTypeObject", + "members": [ + { + "ident": "type" }, { - "kind": "HttpTypeReference", + "ident": "file_search" + } + ] + }, + "childrenParentSchema": "object", + "children": [ + "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) type", + "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search" + ] + }, + "(resource) beta.assistants > (model) function_tool > (schema)": { + "kind": "HttpDeclTypeAlias", + "oasRef": "#/components/schemas/AssistantToolsFunction", "ident": "FunctionTool", - "$ref": "(resource) beta.assistants > (model) function_tool > (schema)" + "type": { + "kind": "HttpTypeObject", + "members": [ + { + "ident": "function" + }, + { + "ident": "type" } - ], - "oasRef": "#/components/schemas/AssistantTool" + ] }, - "childrenParentSchema": "union", + "childrenParentSchema": "object", "children": [ - "(resource) beta.assistants > (model) assistant_tool > (schema) > (variant) 0", - "(resource) beta.assistants > (model) assistant_tool > (schema) > (variant) 1", - "(resource) beta.assistants > (model) assistant_tool > (schema) > (variant) 2" + "(resource) beta.assistants > (model) function_tool > (schema) > (property) function", + "(resource) beta.assistants > (model) function_tool > (schema) > (property) type" ] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) type": { @@ -4375,7 +4352,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "JSON Schema response format. Used to generate structured JSON responses.\nLearn more about [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs).\n", + "docstring": "JSON Schema response format. Used to generate structured JSON responses.\nLearn more about [Structured Outputs](/docs/guides/structured-outputs).\n", "childrenParentSchema": "object", "children": [ "(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema", @@ -4503,23 +4480,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type > (member) 0" ] }, - "(resource) beta.assistants > (model) code_interpreter_tool > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/AssistantToolsCode", - "ident": "CodeInterpreterTool", - "type": { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "type" - } - ] - }, - "childrenParentSchema": "object", - "children": [ - "(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type" - ] - }, "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) type": { "kind": "HttpDeclProperty", "docstring": "The type of tool being defined: `file_search`", @@ -4570,27 +4530,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options" ] }, - "(resource) beta.assistants > (model) file_search_tool > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/AssistantToolsFileSearch", - "ident": "FileSearchTool", - "type": { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "type" - }, - { - "ident": "file_search" - } - ] - }, - "childrenParentSchema": "object", - "children": [ - "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) type", - "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search" - ] - }, "(resource) beta.assistants > (model) function_tool > (schema) > (property) function": { "kind": "HttpDeclProperty", "key": "function", @@ -4638,27 +4577,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.assistants > (model) function_tool > (schema) > (property) type > (member) 0" ] }, - "(resource) beta.assistants > (model) function_tool > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/AssistantToolsFunction", - "ident": "FunctionTool", - "type": { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "function" - }, - { - "ident": "type" - } - ] - }, - "childrenParentSchema": "object", - "children": [ - "(resource) beta.assistants > (model) function_tool > (schema) > (property) function", - "(resource) beta.assistants > (model) function_tool > (schema) > (property) type" - ] - }, "(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { @@ -4675,7 +4593,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "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.", + "docstring": "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](/docs/api-reference/runs/submitToolOutputs) endpoint.", "key": "id", "optional": false, "nullable": false, @@ -4832,7 +4750,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema > (property) strict": { "kind": "HttpDeclProperty", - "docstring": "Whether to enable strict schema adherence when generating the output.\nIf set to true, the model will always follow the exact schema defined\nin the `schema` field. Only a subset of JSON Schema is supported when\n`strict` is `true`. To learn more, read the [Structured Outputs\nguide](https://platform.openai.com/docs/guides/structured-outputs).\n", + "docstring": "Whether to enable strict schema adherence when generating the output.\nIf set to true, the model will always follow the exact schema defined\nin the `schema` field. Only a subset of JSON Schema is supported when\n`strict` is `true`. To learn more, read the [Structured Outputs\nguide](/docs/guides/structured-outputs).\n", "key": "strict", "optional": true, "nullable": true, @@ -4920,7 +4838,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) max_num_results": { "kind": "HttpDeclProperty", - "docstring": "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.\n\nNote 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.\n", + "docstring": "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.\n\nNote that the file search tool may output fewer than `max_num_results` results. See the [file search tool documentation](/docs/assistants/tools/file-search#customizing-file-search-settings) for more information.\n", "key": "max_num_results", "optional": true, "nullable": false, @@ -4939,7 +4857,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options": { "kind": "HttpDeclProperty", "title": "File search tool call ranking options", - "docstring": "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.\n\nSee the [file search tool documentation](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) for more information.\n", + "docstring": "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.\n\nSee the [file search tool documentation](/docs/assistants/tools/file-search#customizing-file-search-settings) for more information.\n", "key": "ranking_options", "optional": true, "nullable": false, @@ -4993,7 +4911,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) $shared > (model) function_definition > (schema) > (property) parameters": { "kind": "HttpDeclProperty", - "docstring": "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. \n\nOmitting `parameters` defines a function with an empty parameter list.", + "docstring": "The parameters the functions accepts, described as a JSON Schema object. See the [guide](/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. \n\nOmitting `parameters` defines a function with an empty parameter list.", "key": "parameters", "optional": true, "nullable": false, @@ -5011,7 +4929,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) $shared > (model) function_definition > (schema) > (property) strict": { "kind": "HttpDeclProperty", - "docstring": "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).", + "docstring": "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](/docs/guides/function-calling).", "key": "strict", "optional": true, "nullable": true, @@ -5159,7 +5077,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch ], "oasRef": "#/components/schemas/FunctionParameters" }, - "docstring": "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. \n\nOmitting `parameters` defines a function with an empty parameter list.", + "docstring": "The parameters the functions accepts, described as a JSON Schema object. See the [guide](/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. \n\nOmitting `parameters` defines a function with an empty parameter list.", "children": [] }, "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options > (property) ranker > (member) 0": { @@ -5187,7 +5105,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch ## event -Occurs when a [run](https://platform.openai.com/docs/api-reference/runs/object) moves to an `in_progress` status. +Occurs when a [run](https://developers.openai.com/docs/api-reference/runs/object) moves to an `in_progress` status. ### Schema @@ -5197,8 +5115,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch { "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 3": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RunStreamEvent/anyOf/2", - "ident": "ThreadRunInProgress", + "oasRef": "#/components/schemas/RunStreamEvent/oneOf/2", + "ident": "UnionMember3", "type": { "kind": "HttpTypeObject", "members": [ @@ -5210,7 +5128,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Occurs when a [run](https://platform.openai.com/docs/api-reference/runs/object) moves to an `in_progress` status.", + "docstring": "Occurs when a [run](/docs/api-reference/runs/object) moves to an `in_progress` status.", "childrenParentSchema": "object", "children": [ "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 3 > (property) data", @@ -5220,7 +5138,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 3 > (property) data": { "kind": "HttpDeclProperty", "title": "A run on a thread", - "docstring": "Represents an execution run on a [thread](https://platform.openai.com/docs/api-reference/threads).", + "docstring": "Represents an execution run on a [thread](/docs/api-reference/threads).", "key": "data", "optional": false, "nullable": false, @@ -5229,7 +5147,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "ident": "Run", "$ref": "(resource) beta.threads.runs > (model) run > (schema)" }, - "oasRef": "#/components/schemas/RunStreamEvent/anyOf/2/properties/data", + "oasRef": "#/components/schemas/RunStreamEvent/oneOf/2/properties/data", "deprecated": false, "schemaType": "object", "modelImplicit": false, @@ -5278,9 +5196,9 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "literal": "thread.run.in_progress" } ], - "oasRef": "#/components/schemas/RunStreamEvent/anyOf/2/properties/event" + "oasRef": "#/components/schemas/RunStreamEvent/oneOf/2/properties/event" }, - "oasRef": "#/components/schemas/RunStreamEvent/anyOf/2/properties/event", + "oasRef": "#/components/schemas/RunStreamEvent/oneOf/2/properties/event", "deprecated": false, "schemaType": "enum", "childrenParentSchema": "enum", @@ -5304,7 +5222,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) assistant_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for execution of this run.", + "docstring": "The ID of the [assistant](/docs/api-reference/assistants) used for execution of this run.", "key": "assistant_id", "optional": false, "nullable": false, @@ -5425,7 +5343,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) instructions": { "kind": "HttpDeclProperty", - "docstring": "The instructions that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run.", + "docstring": "The instructions that the [assistant](/docs/api-reference/assistants) used for this run.", "key": "instructions", "optional": false, "nullable": false, @@ -5517,7 +5435,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) model": { "kind": "HttpDeclProperty", - "docstring": "The model that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run.", + "docstring": "The model that the [assistant](/docs/api-reference/assistants) used for this run.", "key": "model", "optional": false, "nullable": false, @@ -5555,7 +5473,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) parallel_tool_calls": { "kind": "HttpDeclProperty", - "docstring": "Whether to enable [parallel function calling](https://platform.openai.com/docs/guides/function-calling#configuring-parallel-function-calling) during tool use.", + "docstring": "Whether to enable [parallel function calling](/docs/guides/function-calling#configuring-parallel-function-calling) during tool use.", "key": "parallel_tool_calls", "optional": false, "nullable": false, @@ -5596,7 +5514,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) response_format": { "kind": "HttpDeclProperty", - "docstring": "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`.\n\nSetting 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).\n\nSetting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\n**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.\n", + "docstring": "Specifies the format that the model must output. Compatible with [GPT-4o](/docs/models#gpt-4o), [GPT-4 Turbo](/docs/models#gpt-4-turbo-and-gpt-4), and all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`.\n\nSetting 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](/docs/guides/structured-outputs).\n\nSetting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\n**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.\n", "key": "response_format", "optional": false, "nullable": true, @@ -5642,31 +5560,66 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "optional": false, "nullable": false, "type": { - "kind": "HttpTypeReference", - "ident": "RunStatus", - "$ref": "(resource) beta.threads.runs > (model) run_status > (schema)" + "kind": "HttpTypeUnion", + "types": [ + { + "kind": "HttpTypeLiteral", + "literal": "queued" + }, + { + "kind": "HttpTypeLiteral", + "literal": "in_progress" + }, + { + "kind": "HttpTypeLiteral", + "literal": "requires_action" + }, + { + "kind": "HttpTypeLiteral", + "literal": "cancelling" + }, + { + "kind": "HttpTypeLiteral", + "literal": "cancelled" + }, + { + "kind": "HttpTypeLiteral", + "literal": "failed" + }, + { + "kind": "HttpTypeLiteral", + "literal": "completed" + }, + { + "kind": "HttpTypeLiteral", + "literal": "incomplete" + }, + { + "kind": "HttpTypeLiteral", + "literal": "expired" + } + ], + "oasRef": "#/components/schemas/RunObject/properties/status" }, "oasRef": "#/components/schemas/RunObject/properties/status", "deprecated": false, "schemaType": "enum", - "modelImplicit": false, - "modelPath": "(resource) beta.threads.runs > (model) run_status", "childrenParentSchema": "enum", "children": [ - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 0", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 1", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 2", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 3", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 4", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 5", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 6", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 7", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 8" + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 0", + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 1", + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 2", + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 3", + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 4", + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 5", + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 6", + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 7", + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 8" ] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) thread_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the [thread](https://platform.openai.com/docs/api-reference/threads) that was executed on as a part of this run.", + "docstring": "The ID of the [thread](/docs/api-reference/threads) that was executed on as a part of this run.", "key": "thread_id", "optional": false, "nullable": false, @@ -5702,7 +5655,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) tools": { "kind": "HttpDeclProperty", - "docstring": "The list of tools that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run.", + "docstring": "The list of tools that the [assistant](/docs/api-reference/assistants) used for this run.", "key": "tools", "optional": false, "nullable": false, @@ -5710,9 +5663,25 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "type": { "kind": "HttpTypeArray", "elementType": { + "kind": "HttpTypeUnion", + "types": [ + { + "kind": "HttpTypeReference", + "ident": "CodeInterpreterTool", + "$ref": "(resource) beta.assistants > (model) code_interpreter_tool > (schema)" + }, + { + "kind": "HttpTypeReference", + "ident": "FileSearchTool", + "$ref": "(resource) beta.assistants > (model) file_search_tool > (schema)" + }, + { "kind": "HttpTypeReference", - "ident": "AssistantTool", - "$ref": "(resource) beta.assistants > (model) assistant_tool > (schema)" + "ident": "FunctionTool", + "$ref": "(resource) beta.assistants > (model) function_tool > (schema)" + } + ], + "oasRef": "#/components/schemas/RunObject/properties/tools/items" }, "oasRef": "#/components/schemas/RunObject/properties/tools" }, @@ -5721,9 +5690,9 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "schemaType": "array", "childrenParentSchema": "union", "children": [ - "(resource) beta.assistants > (model) assistant_tool > (schema) > (variant) 0", - "(resource) beta.assistants > (model) assistant_tool > (schema) > (variant) 1", - "(resource) beta.assistants > (model) assistant_tool > (schema) > (variant) 2" + "(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 0", + "(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 1", + "(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 2" ] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy": { @@ -5901,7 +5870,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Represents an execution run on a [thread](https://platform.openai.com/docs/api-reference/threads).", + "docstring": "Represents an execution run on a [thread](/docs/api-reference/threads).", "childrenParentSchema": "object", "children": [ "(resource) beta.threads.runs > (model) run > (schema) > (property) id", @@ -6092,7 +6061,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 0": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/anyOf/0", + "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/oneOf/0", "ident": "UnionMember0", "type": { "kind": "HttpTypeUnion", @@ -6102,7 +6071,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "literal": "auto" } ], - "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/anyOf/0" + "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/oneOf/0" }, "docstring": "`auto` is the default value\n", "childrenParentSchema": "enum", @@ -6162,7 +6131,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "literal": "auto" } ], - "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/anyOf/0" + "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/oneOf/0" }, { "kind": "HttpTypeReference", @@ -6182,7 +6151,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch ], "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption" }, - "docstring": "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`.\n\nSetting 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).\n\nSetting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\n**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.\n", + "docstring": "Specifies the format that the model must output. Compatible with [GPT-4o](/docs/models#gpt-4o), [GPT-4 Turbo](/docs/models#gpt-4-turbo-and-gpt-4), and all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`.\n\nSetting 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](/docs/guides/structured-outputs).\n\nSetting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\n**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.\n", "childrenParentSchema": "union", "children": [ "(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 0", @@ -6191,133 +6160,73 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 3" ] }, - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 0": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "queued" } }, - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 1": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 1": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "in_progress" } }, - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 2": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 2": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "requires_action" } }, - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 3": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 3": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "cancelling" } }, - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 4": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 4": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "cancelled" } }, - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 5": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 5": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "failed" } }, - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 6": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 6": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "completed" } }, - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 7": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 7": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "incomplete" } }, - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 8": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 8": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "expired" } }, - "(resource) beta.threads.runs > (model) run_status > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RunStatus", - "ident": "RunStatus", - "type": { - "kind": "HttpTypeUnion", - "types": [ - { - "kind": "HttpTypeLiteral", - "literal": "queued" - }, - { - "kind": "HttpTypeLiteral", - "literal": "in_progress" - }, - { - "kind": "HttpTypeLiteral", - "literal": "requires_action" - }, - { - "kind": "HttpTypeLiteral", - "literal": "cancelling" - }, - { - "kind": "HttpTypeLiteral", - "literal": "cancelled" - }, - { - "kind": "HttpTypeLiteral", - "literal": "failed" - }, - { - "kind": "HttpTypeLiteral", - "literal": "completed" - }, - { - "kind": "HttpTypeLiteral", - "literal": "incomplete" - }, - { - "kind": "HttpTypeLiteral", - "literal": "expired" - } - ], - "oasRef": "#/components/schemas/RunStatus" - }, - "docstring": "The status of the run, which can be either `queued`, `in_progress`, `requires_action`, `cancelling`, `cancelled`, `failed`, `completed`, `incomplete`, or `expired`.", - "childrenParentSchema": "enum", - "children": [ - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 0", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 1", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 2", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 3", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 4", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 5", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 6", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 7", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 8" - ] - }, "(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption/anyOf/0", - "ident": "Auto", + "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption/oneOf/0", + "ident": "UnionMember0", "type": { "kind": "HttpTypeUnion", "types": [ @@ -6334,7 +6243,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "literal": "required" } ], - "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption/anyOf/0" + "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption/oneOf/0" }, "docstring": "`none` means the model will not call any tools and instead generates a message. `auto` means the model can pick between generating a message or calling one or more tools. `required` means the model must call one or more tools before responding to the user.\n", "childrenParentSchema": "enum", @@ -6380,7 +6289,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "literal": "required" } ], - "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption/anyOf/0" + "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption/oneOf/0" }, { "kind": "HttpTypeReference", @@ -6397,7 +6306,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 1" ] }, - "(resource) beta.assistants > (model) assistant_tool > (schema) > (variant) 0": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", @@ -6409,7 +6318,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type" ] }, - "(resource) beta.assistants > (model) assistant_tool > (schema) > (variant) 1": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 1": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", @@ -6422,7 +6331,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search" ] }, - "(resource) beta.assistants > (model) assistant_tool > (schema) > (variant) 2": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 2": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", @@ -6435,36 +6344,63 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.assistants > (model) function_tool > (schema) > (property) type" ] }, - "(resource) beta.assistants > (model) assistant_tool > (schema)": { + "(resource) beta.assistants > (model) code_interpreter_tool > (schema)": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/AssistantTool", - "ident": "AssistantTool", + "oasRef": "#/components/schemas/AssistantToolsCode", + "ident": "CodeInterpreterTool", "type": { - "kind": "HttpTypeUnion", - "types": [ + "kind": "HttpTypeObject", + "members": [ { - "kind": "HttpTypeReference", - "ident": "CodeInterpreterTool", - "$ref": "(resource) beta.assistants > (model) code_interpreter_tool > (schema)" + "ident": "type" + } + ] }, - { - "kind": "HttpTypeReference", + "childrenParentSchema": "object", + "children": [ + "(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type" + ] + }, + "(resource) beta.assistants > (model) file_search_tool > (schema)": { + "kind": "HttpDeclTypeAlias", + "oasRef": "#/components/schemas/AssistantToolsFileSearch", "ident": "FileSearchTool", - "$ref": "(resource) beta.assistants > (model) file_search_tool > (schema)" + "type": { + "kind": "HttpTypeObject", + "members": [ + { + "ident": "type" }, { - "kind": "HttpTypeReference", + "ident": "file_search" + } + ] + }, + "childrenParentSchema": "object", + "children": [ + "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) type", + "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search" + ] + }, + "(resource) beta.assistants > (model) function_tool > (schema)": { + "kind": "HttpDeclTypeAlias", + "oasRef": "#/components/schemas/AssistantToolsFunction", "ident": "FunctionTool", - "$ref": "(resource) beta.assistants > (model) function_tool > (schema)" + "type": { + "kind": "HttpTypeObject", + "members": [ + { + "ident": "function" + }, + { + "ident": "type" } - ], - "oasRef": "#/components/schemas/AssistantTool" + ] }, - "childrenParentSchema": "union", + "childrenParentSchema": "object", "children": [ - "(resource) beta.assistants > (model) assistant_tool > (schema) > (variant) 0", - "(resource) beta.assistants > (model) assistant_tool > (schema) > (variant) 1", - "(resource) beta.assistants > (model) assistant_tool > (schema) > (variant) 2" + "(resource) beta.assistants > (model) function_tool > (schema) > (property) function", + "(resource) beta.assistants > (model) function_tool > (schema) > (property) type" ] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) type": { @@ -6787,7 +6723,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "JSON Schema response format. Used to generate structured JSON responses.\nLearn more about [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs).\n", + "docstring": "JSON Schema response format. Used to generate structured JSON responses.\nLearn more about [Structured Outputs](/docs/guides/structured-outputs).\n", "childrenParentSchema": "object", "children": [ "(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema", @@ -6915,23 +6851,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type > (member) 0" ] }, - "(resource) beta.assistants > (model) code_interpreter_tool > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/AssistantToolsCode", - "ident": "CodeInterpreterTool", - "type": { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "type" - } - ] - }, - "childrenParentSchema": "object", - "children": [ - "(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type" - ] - }, "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) type": { "kind": "HttpDeclProperty", "docstring": "The type of tool being defined: `file_search`", @@ -6982,27 +6901,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options" ] }, - "(resource) beta.assistants > (model) file_search_tool > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/AssistantToolsFileSearch", - "ident": "FileSearchTool", - "type": { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "type" - }, - { - "ident": "file_search" - } - ] - }, - "childrenParentSchema": "object", - "children": [ - "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) type", - "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search" - ] - }, "(resource) beta.assistants > (model) function_tool > (schema) > (property) function": { "kind": "HttpDeclProperty", "key": "function", @@ -7050,27 +6948,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.assistants > (model) function_tool > (schema) > (property) type > (member) 0" ] }, - "(resource) beta.assistants > (model) function_tool > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/AssistantToolsFunction", - "ident": "FunctionTool", - "type": { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "function" - }, - { - "ident": "type" - } - ] - }, - "childrenParentSchema": "object", - "children": [ - "(resource) beta.assistants > (model) function_tool > (schema) > (property) function", - "(resource) beta.assistants > (model) function_tool > (schema) > (property) type" - ] - }, "(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { @@ -7087,7 +6964,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "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.", + "docstring": "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](/docs/api-reference/runs/submitToolOutputs) endpoint.", "key": "id", "optional": false, "nullable": false, @@ -7244,7 +7121,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema > (property) strict": { "kind": "HttpDeclProperty", - "docstring": "Whether to enable strict schema adherence when generating the output.\nIf set to true, the model will always follow the exact schema defined\nin the `schema` field. Only a subset of JSON Schema is supported when\n`strict` is `true`. To learn more, read the [Structured Outputs\nguide](https://platform.openai.com/docs/guides/structured-outputs).\n", + "docstring": "Whether to enable strict schema adherence when generating the output.\nIf set to true, the model will always follow the exact schema defined\nin the `schema` field. Only a subset of JSON Schema is supported when\n`strict` is `true`. To learn more, read the [Structured Outputs\nguide](/docs/guides/structured-outputs).\n", "key": "strict", "optional": true, "nullable": true, @@ -7332,7 +7209,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) max_num_results": { "kind": "HttpDeclProperty", - "docstring": "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.\n\nNote 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.\n", + "docstring": "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.\n\nNote that the file search tool may output fewer than `max_num_results` results. See the [file search tool documentation](/docs/assistants/tools/file-search#customizing-file-search-settings) for more information.\n", "key": "max_num_results", "optional": true, "nullable": false, @@ -7351,7 +7228,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options": { "kind": "HttpDeclProperty", "title": "File search tool call ranking options", - "docstring": "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.\n\nSee the [file search tool documentation](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) for more information.\n", + "docstring": "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.\n\nSee the [file search tool documentation](/docs/assistants/tools/file-search#customizing-file-search-settings) for more information.\n", "key": "ranking_options", "optional": true, "nullable": false, @@ -7405,7 +7282,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) $shared > (model) function_definition > (schema) > (property) parameters": { "kind": "HttpDeclProperty", - "docstring": "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. \n\nOmitting `parameters` defines a function with an empty parameter list.", + "docstring": "The parameters the functions accepts, described as a JSON Schema object. See the [guide](/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. \n\nOmitting `parameters` defines a function with an empty parameter list.", "key": "parameters", "optional": true, "nullable": false, @@ -7423,7 +7300,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) $shared > (model) function_definition > (schema) > (property) strict": { "kind": "HttpDeclProperty", - "docstring": "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).", + "docstring": "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](/docs/guides/function-calling).", "key": "strict", "optional": true, "nullable": true, @@ -7571,7 +7448,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch ], "oasRef": "#/components/schemas/FunctionParameters" }, - "docstring": "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. \n\nOmitting `parameters` defines a function with an empty parameter list.", + "docstring": "The parameters the functions accepts, described as a JSON Schema object. See the [guide](/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. \n\nOmitting `parameters` defines a function with an empty parameter list.", "children": [] }, "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options > (property) ranker > (member) 0": { @@ -7599,7 +7476,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch ## event -Occurs when a [run](https://platform.openai.com/docs/api-reference/runs/object) moves to a `requires_action` status. +Occurs when a [run](https://developers.openai.com/docs/api-reference/runs/object) moves to a `requires_action` status. ### Schema @@ -7609,8 +7486,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch { "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 4": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RunStreamEvent/anyOf/3", - "ident": "ThreadRunRequiresAction", + "oasRef": "#/components/schemas/RunStreamEvent/oneOf/3", + "ident": "UnionMember4", "type": { "kind": "HttpTypeObject", "members": [ @@ -7622,7 +7499,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Occurs when a [run](https://platform.openai.com/docs/api-reference/runs/object) moves to a `requires_action` status.", + "docstring": "Occurs when a [run](/docs/api-reference/runs/object) moves to a `requires_action` status.", "childrenParentSchema": "object", "children": [ "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 4 > (property) data", @@ -7632,7 +7509,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 4 > (property) data": { "kind": "HttpDeclProperty", "title": "A run on a thread", - "docstring": "Represents an execution run on a [thread](https://platform.openai.com/docs/api-reference/threads).", + "docstring": "Represents an execution run on a [thread](/docs/api-reference/threads).", "key": "data", "optional": false, "nullable": false, @@ -7641,7 +7518,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "ident": "Run", "$ref": "(resource) beta.threads.runs > (model) run > (schema)" }, - "oasRef": "#/components/schemas/RunStreamEvent/anyOf/3/properties/data", + "oasRef": "#/components/schemas/RunStreamEvent/oneOf/3/properties/data", "deprecated": false, "schemaType": "object", "modelImplicit": false, @@ -7690,9 +7567,9 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "literal": "thread.run.requires_action" } ], - "oasRef": "#/components/schemas/RunStreamEvent/anyOf/3/properties/event" + "oasRef": "#/components/schemas/RunStreamEvent/oneOf/3/properties/event" }, - "oasRef": "#/components/schemas/RunStreamEvent/anyOf/3/properties/event", + "oasRef": "#/components/schemas/RunStreamEvent/oneOf/3/properties/event", "deprecated": false, "schemaType": "enum", "childrenParentSchema": "enum", @@ -7716,7 +7593,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) assistant_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for execution of this run.", + "docstring": "The ID of the [assistant](/docs/api-reference/assistants) used for execution of this run.", "key": "assistant_id", "optional": false, "nullable": false, @@ -7837,7 +7714,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) instructions": { "kind": "HttpDeclProperty", - "docstring": "The instructions that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run.", + "docstring": "The instructions that the [assistant](/docs/api-reference/assistants) used for this run.", "key": "instructions", "optional": false, "nullable": false, @@ -7929,7 +7806,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) model": { "kind": "HttpDeclProperty", - "docstring": "The model that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run.", + "docstring": "The model that the [assistant](/docs/api-reference/assistants) used for this run.", "key": "model", "optional": false, "nullable": false, @@ -7967,7 +7844,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) parallel_tool_calls": { "kind": "HttpDeclProperty", - "docstring": "Whether to enable [parallel function calling](https://platform.openai.com/docs/guides/function-calling#configuring-parallel-function-calling) during tool use.", + "docstring": "Whether to enable [parallel function calling](/docs/guides/function-calling#configuring-parallel-function-calling) during tool use.", "key": "parallel_tool_calls", "optional": false, "nullable": false, @@ -8008,7 +7885,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) response_format": { "kind": "HttpDeclProperty", - "docstring": "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`.\n\nSetting 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).\n\nSetting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\n**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.\n", + "docstring": "Specifies the format that the model must output. Compatible with [GPT-4o](/docs/models#gpt-4o), [GPT-4 Turbo](/docs/models#gpt-4-turbo-and-gpt-4), and all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`.\n\nSetting 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](/docs/guides/structured-outputs).\n\nSetting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\n**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.\n", "key": "response_format", "optional": false, "nullable": true, @@ -8054,31 +7931,66 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "optional": false, "nullable": false, "type": { - "kind": "HttpTypeReference", - "ident": "RunStatus", - "$ref": "(resource) beta.threads.runs > (model) run_status > (schema)" + "kind": "HttpTypeUnion", + "types": [ + { + "kind": "HttpTypeLiteral", + "literal": "queued" + }, + { + "kind": "HttpTypeLiteral", + "literal": "in_progress" + }, + { + "kind": "HttpTypeLiteral", + "literal": "requires_action" + }, + { + "kind": "HttpTypeLiteral", + "literal": "cancelling" + }, + { + "kind": "HttpTypeLiteral", + "literal": "cancelled" + }, + { + "kind": "HttpTypeLiteral", + "literal": "failed" + }, + { + "kind": "HttpTypeLiteral", + "literal": "completed" + }, + { + "kind": "HttpTypeLiteral", + "literal": "incomplete" + }, + { + "kind": "HttpTypeLiteral", + "literal": "expired" + } + ], + "oasRef": "#/components/schemas/RunObject/properties/status" }, "oasRef": "#/components/schemas/RunObject/properties/status", "deprecated": false, "schemaType": "enum", - "modelImplicit": false, - "modelPath": "(resource) beta.threads.runs > (model) run_status", "childrenParentSchema": "enum", "children": [ - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 0", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 1", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 2", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 3", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 4", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 5", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 6", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 7", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 8" + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 0", + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 1", + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 2", + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 3", + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 4", + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 5", + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 6", + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 7", + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 8" ] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) thread_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the [thread](https://platform.openai.com/docs/api-reference/threads) that was executed on as a part of this run.", + "docstring": "The ID of the [thread](/docs/api-reference/threads) that was executed on as a part of this run.", "key": "thread_id", "optional": false, "nullable": false, @@ -8114,7 +8026,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) tools": { "kind": "HttpDeclProperty", - "docstring": "The list of tools that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run.", + "docstring": "The list of tools that the [assistant](/docs/api-reference/assistants) used for this run.", "key": "tools", "optional": false, "nullable": false, @@ -8122,9 +8034,25 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "type": { "kind": "HttpTypeArray", "elementType": { + "kind": "HttpTypeUnion", + "types": [ + { "kind": "HttpTypeReference", - "ident": "AssistantTool", - "$ref": "(resource) beta.assistants > (model) assistant_tool > (schema)" + "ident": "CodeInterpreterTool", + "$ref": "(resource) beta.assistants > (model) code_interpreter_tool > (schema)" + }, + { + "kind": "HttpTypeReference", + "ident": "FileSearchTool", + "$ref": "(resource) beta.assistants > (model) file_search_tool > (schema)" + }, + { + "kind": "HttpTypeReference", + "ident": "FunctionTool", + "$ref": "(resource) beta.assistants > (model) function_tool > (schema)" + } + ], + "oasRef": "#/components/schemas/RunObject/properties/tools/items" }, "oasRef": "#/components/schemas/RunObject/properties/tools" }, @@ -8133,9 +8061,9 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "schemaType": "array", "childrenParentSchema": "union", "children": [ - "(resource) beta.assistants > (model) assistant_tool > (schema) > (variant) 0", - "(resource) beta.assistants > (model) assistant_tool > (schema) > (variant) 1", - "(resource) beta.assistants > (model) assistant_tool > (schema) > (variant) 2" + "(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 0", + "(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 1", + "(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 2" ] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy": { @@ -8313,7 +8241,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Represents an execution run on a [thread](https://platform.openai.com/docs/api-reference/threads).", + "docstring": "Represents an execution run on a [thread](/docs/api-reference/threads).", "childrenParentSchema": "object", "children": [ "(resource) beta.threads.runs > (model) run > (schema) > (property) id", @@ -8504,7 +8432,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 0": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/anyOf/0", + "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/oneOf/0", "ident": "UnionMember0", "type": { "kind": "HttpTypeUnion", @@ -8514,7 +8442,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "literal": "auto" } ], - "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/anyOf/0" + "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/oneOf/0" }, "docstring": "`auto` is the default value\n", "childrenParentSchema": "enum", @@ -8574,7 +8502,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "literal": "auto" } ], - "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/anyOf/0" + "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/oneOf/0" }, { "kind": "HttpTypeReference", @@ -8594,7 +8522,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch ], "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption" }, - "docstring": "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`.\n\nSetting 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).\n\nSetting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\n**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.\n", + "docstring": "Specifies the format that the model must output. Compatible with [GPT-4o](/docs/models#gpt-4o), [GPT-4 Turbo](/docs/models#gpt-4-turbo-and-gpt-4), and all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`.\n\nSetting 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](/docs/guides/structured-outputs).\n\nSetting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\n**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.\n", "childrenParentSchema": "union", "children": [ "(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 0", @@ -8603,133 +8531,73 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 3" ] }, - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 0": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "queued" } }, - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 1": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 1": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "in_progress" } }, - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 2": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 2": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "requires_action" } }, - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 3": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 3": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "cancelling" } }, - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 4": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 4": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "cancelled" } }, - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 5": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 5": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "failed" } }, - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 6": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 6": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "completed" } }, - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 7": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 7": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "incomplete" } }, - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 8": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 8": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "expired" } }, - "(resource) beta.threads.runs > (model) run_status > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RunStatus", - "ident": "RunStatus", - "type": { - "kind": "HttpTypeUnion", - "types": [ - { - "kind": "HttpTypeLiteral", - "literal": "queued" - }, - { - "kind": "HttpTypeLiteral", - "literal": "in_progress" - }, - { - "kind": "HttpTypeLiteral", - "literal": "requires_action" - }, - { - "kind": "HttpTypeLiteral", - "literal": "cancelling" - }, - { - "kind": "HttpTypeLiteral", - "literal": "cancelled" - }, - { - "kind": "HttpTypeLiteral", - "literal": "failed" - }, - { - "kind": "HttpTypeLiteral", - "literal": "completed" - }, - { - "kind": "HttpTypeLiteral", - "literal": "incomplete" - }, - { - "kind": "HttpTypeLiteral", - "literal": "expired" - } - ], - "oasRef": "#/components/schemas/RunStatus" - }, - "docstring": "The status of the run, which can be either `queued`, `in_progress`, `requires_action`, `cancelling`, `cancelled`, `failed`, `completed`, `incomplete`, or `expired`.", - "childrenParentSchema": "enum", - "children": [ - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 0", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 1", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 2", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 3", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 4", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 5", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 6", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 7", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 8" - ] - }, "(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption/anyOf/0", - "ident": "Auto", + "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption/oneOf/0", + "ident": "UnionMember0", "type": { "kind": "HttpTypeUnion", "types": [ @@ -8746,7 +8614,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "literal": "required" } ], - "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption/anyOf/0" + "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption/oneOf/0" }, "docstring": "`none` means the model will not call any tools and instead generates a message. `auto` means the model can pick between generating a message or calling one or more tools. `required` means the model must call one or more tools before responding to the user.\n", "childrenParentSchema": "enum", @@ -8792,7 +8660,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "literal": "required" } ], - "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption/anyOf/0" + "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption/oneOf/0" }, { "kind": "HttpTypeReference", @@ -8809,7 +8677,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 1" ] }, - "(resource) beta.assistants > (model) assistant_tool > (schema) > (variant) 0": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", @@ -8821,7 +8689,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type" ] }, - "(resource) beta.assistants > (model) assistant_tool > (schema) > (variant) 1": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 1": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", @@ -8834,7 +8702,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search" ] }, - "(resource) beta.assistants > (model) assistant_tool > (schema) > (variant) 2": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 2": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", @@ -8847,36 +8715,63 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.assistants > (model) function_tool > (schema) > (property) type" ] }, - "(resource) beta.assistants > (model) assistant_tool > (schema)": { + "(resource) beta.assistants > (model) code_interpreter_tool > (schema)": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/AssistantTool", - "ident": "AssistantTool", + "oasRef": "#/components/schemas/AssistantToolsCode", + "ident": "CodeInterpreterTool", "type": { - "kind": "HttpTypeUnion", - "types": [ + "kind": "HttpTypeObject", + "members": [ { - "kind": "HttpTypeReference", - "ident": "CodeInterpreterTool", - "$ref": "(resource) beta.assistants > (model) code_interpreter_tool > (schema)" + "ident": "type" + } + ] }, - { - "kind": "HttpTypeReference", + "childrenParentSchema": "object", + "children": [ + "(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type" + ] + }, + "(resource) beta.assistants > (model) file_search_tool > (schema)": { + "kind": "HttpDeclTypeAlias", + "oasRef": "#/components/schemas/AssistantToolsFileSearch", "ident": "FileSearchTool", - "$ref": "(resource) beta.assistants > (model) file_search_tool > (schema)" + "type": { + "kind": "HttpTypeObject", + "members": [ + { + "ident": "type" }, { - "kind": "HttpTypeReference", + "ident": "file_search" + } + ] + }, + "childrenParentSchema": "object", + "children": [ + "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) type", + "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search" + ] + }, + "(resource) beta.assistants > (model) function_tool > (schema)": { + "kind": "HttpDeclTypeAlias", + "oasRef": "#/components/schemas/AssistantToolsFunction", "ident": "FunctionTool", - "$ref": "(resource) beta.assistants > (model) function_tool > (schema)" + "type": { + "kind": "HttpTypeObject", + "members": [ + { + "ident": "function" + }, + { + "ident": "type" } - ], - "oasRef": "#/components/schemas/AssistantTool" + ] }, - "childrenParentSchema": "union", + "childrenParentSchema": "object", "children": [ - "(resource) beta.assistants > (model) assistant_tool > (schema) > (variant) 0", - "(resource) beta.assistants > (model) assistant_tool > (schema) > (variant) 1", - "(resource) beta.assistants > (model) assistant_tool > (schema) > (variant) 2" + "(resource) beta.assistants > (model) function_tool > (schema) > (property) function", + "(resource) beta.assistants > (model) function_tool > (schema) > (property) type" ] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) type": { @@ -9199,7 +9094,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "JSON Schema response format. Used to generate structured JSON responses.\nLearn more about [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs).\n", + "docstring": "JSON Schema response format. Used to generate structured JSON responses.\nLearn more about [Structured Outputs](/docs/guides/structured-outputs).\n", "childrenParentSchema": "object", "children": [ "(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema", @@ -9327,23 +9222,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type > (member) 0" ] }, - "(resource) beta.assistants > (model) code_interpreter_tool > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/AssistantToolsCode", - "ident": "CodeInterpreterTool", - "type": { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "type" - } - ] - }, - "childrenParentSchema": "object", - "children": [ - "(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type" - ] - }, "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) type": { "kind": "HttpDeclProperty", "docstring": "The type of tool being defined: `file_search`", @@ -9394,27 +9272,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options" ] }, - "(resource) beta.assistants > (model) file_search_tool > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/AssistantToolsFileSearch", - "ident": "FileSearchTool", - "type": { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "type" - }, - { - "ident": "file_search" - } - ] - }, - "childrenParentSchema": "object", - "children": [ - "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) type", - "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search" - ] - }, "(resource) beta.assistants > (model) function_tool > (schema) > (property) function": { "kind": "HttpDeclProperty", "key": "function", @@ -9462,27 +9319,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.assistants > (model) function_tool > (schema) > (property) type > (member) 0" ] }, - "(resource) beta.assistants > (model) function_tool > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/AssistantToolsFunction", - "ident": "FunctionTool", - "type": { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "function" - }, - { - "ident": "type" - } - ] - }, - "childrenParentSchema": "object", - "children": [ - "(resource) beta.assistants > (model) function_tool > (schema) > (property) function", - "(resource) beta.assistants > (model) function_tool > (schema) > (property) type" - ] - }, "(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { @@ -9499,7 +9335,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "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.", + "docstring": "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](/docs/api-reference/runs/submitToolOutputs) endpoint.", "key": "id", "optional": false, "nullable": false, @@ -9656,7 +9492,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema > (property) strict": { "kind": "HttpDeclProperty", - "docstring": "Whether to enable strict schema adherence when generating the output.\nIf set to true, the model will always follow the exact schema defined\nin the `schema` field. Only a subset of JSON Schema is supported when\n`strict` is `true`. To learn more, read the [Structured Outputs\nguide](https://platform.openai.com/docs/guides/structured-outputs).\n", + "docstring": "Whether to enable strict schema adherence when generating the output.\nIf set to true, the model will always follow the exact schema defined\nin the `schema` field. Only a subset of JSON Schema is supported when\n`strict` is `true`. To learn more, read the [Structured Outputs\nguide](/docs/guides/structured-outputs).\n", "key": "strict", "optional": true, "nullable": true, @@ -9744,7 +9580,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) max_num_results": { "kind": "HttpDeclProperty", - "docstring": "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.\n\nNote 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.\n", + "docstring": "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.\n\nNote that the file search tool may output fewer than `max_num_results` results. See the [file search tool documentation](/docs/assistants/tools/file-search#customizing-file-search-settings) for more information.\n", "key": "max_num_results", "optional": true, "nullable": false, @@ -9763,7 +9599,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options": { "kind": "HttpDeclProperty", "title": "File search tool call ranking options", - "docstring": "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.\n\nSee the [file search tool documentation](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) for more information.\n", + "docstring": "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.\n\nSee the [file search tool documentation](/docs/assistants/tools/file-search#customizing-file-search-settings) for more information.\n", "key": "ranking_options", "optional": true, "nullable": false, @@ -9817,7 +9653,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) $shared > (model) function_definition > (schema) > (property) parameters": { "kind": "HttpDeclProperty", - "docstring": "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. \n\nOmitting `parameters` defines a function with an empty parameter list.", + "docstring": "The parameters the functions accepts, described as a JSON Schema object. See the [guide](/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. \n\nOmitting `parameters` defines a function with an empty parameter list.", "key": "parameters", "optional": true, "nullable": false, @@ -9835,7 +9671,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) $shared > (model) function_definition > (schema) > (property) strict": { "kind": "HttpDeclProperty", - "docstring": "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).", + "docstring": "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](/docs/guides/function-calling).", "key": "strict", "optional": true, "nullable": true, @@ -9983,7 +9819,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch ], "oasRef": "#/components/schemas/FunctionParameters" }, - "docstring": "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. \n\nOmitting `parameters` defines a function with an empty parameter list.", + "docstring": "The parameters the functions accepts, described as a JSON Schema object. See the [guide](/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. \n\nOmitting `parameters` defines a function with an empty parameter list.", "children": [] }, "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options > (property) ranker > (member) 0": { @@ -10011,7 +9847,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch ## event -Occurs when a [run](https://platform.openai.com/docs/api-reference/runs/object) is completed. +Occurs when a [run](https://developers.openai.com/docs/api-reference/runs/object) is completed. ### Schema @@ -10021,8 +9857,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch { "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 5": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RunStreamEvent/anyOf/4", - "ident": "ThreadRunCompleted", + "oasRef": "#/components/schemas/RunStreamEvent/oneOf/4", + "ident": "UnionMember5", "type": { "kind": "HttpTypeObject", "members": [ @@ -10034,7 +9870,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Occurs when a [run](https://platform.openai.com/docs/api-reference/runs/object) is completed.", + "docstring": "Occurs when a [run](/docs/api-reference/runs/object) is completed.", "childrenParentSchema": "object", "children": [ "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 5 > (property) data", @@ -10044,7 +9880,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 5 > (property) data": { "kind": "HttpDeclProperty", "title": "A run on a thread", - "docstring": "Represents an execution run on a [thread](https://platform.openai.com/docs/api-reference/threads).", + "docstring": "Represents an execution run on a [thread](/docs/api-reference/threads).", "key": "data", "optional": false, "nullable": false, @@ -10053,7 +9889,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "ident": "Run", "$ref": "(resource) beta.threads.runs > (model) run > (schema)" }, - "oasRef": "#/components/schemas/RunStreamEvent/anyOf/4/properties/data", + "oasRef": "#/components/schemas/RunStreamEvent/oneOf/4/properties/data", "deprecated": false, "schemaType": "object", "modelImplicit": false, @@ -10102,9 +9938,9 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "literal": "thread.run.completed" } ], - "oasRef": "#/components/schemas/RunStreamEvent/anyOf/4/properties/event" + "oasRef": "#/components/schemas/RunStreamEvent/oneOf/4/properties/event" }, - "oasRef": "#/components/schemas/RunStreamEvent/anyOf/4/properties/event", + "oasRef": "#/components/schemas/RunStreamEvent/oneOf/4/properties/event", "deprecated": false, "schemaType": "enum", "childrenParentSchema": "enum", @@ -10128,7 +9964,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) assistant_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for execution of this run.", + "docstring": "The ID of the [assistant](/docs/api-reference/assistants) used for execution of this run.", "key": "assistant_id", "optional": false, "nullable": false, @@ -10249,7 +10085,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) instructions": { "kind": "HttpDeclProperty", - "docstring": "The instructions that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run.", + "docstring": "The instructions that the [assistant](/docs/api-reference/assistants) used for this run.", "key": "instructions", "optional": false, "nullable": false, @@ -10341,7 +10177,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) model": { "kind": "HttpDeclProperty", - "docstring": "The model that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run.", + "docstring": "The model that the [assistant](/docs/api-reference/assistants) used for this run.", "key": "model", "optional": false, "nullable": false, @@ -10379,7 +10215,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) parallel_tool_calls": { "kind": "HttpDeclProperty", - "docstring": "Whether to enable [parallel function calling](https://platform.openai.com/docs/guides/function-calling#configuring-parallel-function-calling) during tool use.", + "docstring": "Whether to enable [parallel function calling](/docs/guides/function-calling#configuring-parallel-function-calling) during tool use.", "key": "parallel_tool_calls", "optional": false, "nullable": false, @@ -10420,7 +10256,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) response_format": { "kind": "HttpDeclProperty", - "docstring": "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`.\n\nSetting 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).\n\nSetting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\n**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.\n", + "docstring": "Specifies the format that the model must output. Compatible with [GPT-4o](/docs/models#gpt-4o), [GPT-4 Turbo](/docs/models#gpt-4-turbo-and-gpt-4), and all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`.\n\nSetting 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](/docs/guides/structured-outputs).\n\nSetting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\n**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.\n", "key": "response_format", "optional": false, "nullable": true, @@ -10466,31 +10302,66 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "optional": false, "nullable": false, "type": { - "kind": "HttpTypeReference", - "ident": "RunStatus", - "$ref": "(resource) beta.threads.runs > (model) run_status > (schema)" + "kind": "HttpTypeUnion", + "types": [ + { + "kind": "HttpTypeLiteral", + "literal": "queued" + }, + { + "kind": "HttpTypeLiteral", + "literal": "in_progress" + }, + { + "kind": "HttpTypeLiteral", + "literal": "requires_action" + }, + { + "kind": "HttpTypeLiteral", + "literal": "cancelling" + }, + { + "kind": "HttpTypeLiteral", + "literal": "cancelled" + }, + { + "kind": "HttpTypeLiteral", + "literal": "failed" + }, + { + "kind": "HttpTypeLiteral", + "literal": "completed" + }, + { + "kind": "HttpTypeLiteral", + "literal": "incomplete" + }, + { + "kind": "HttpTypeLiteral", + "literal": "expired" + } + ], + "oasRef": "#/components/schemas/RunObject/properties/status" }, "oasRef": "#/components/schemas/RunObject/properties/status", "deprecated": false, "schemaType": "enum", - "modelImplicit": false, - "modelPath": "(resource) beta.threads.runs > (model) run_status", "childrenParentSchema": "enum", "children": [ - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 0", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 1", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 2", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 3", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 4", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 5", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 6", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 7", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 8" + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 0", + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 1", + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 2", + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 3", + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 4", + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 5", + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 6", + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 7", + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 8" ] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) thread_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the [thread](https://platform.openai.com/docs/api-reference/threads) that was executed on as a part of this run.", + "docstring": "The ID of the [thread](/docs/api-reference/threads) that was executed on as a part of this run.", "key": "thread_id", "optional": false, "nullable": false, @@ -10526,7 +10397,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) tools": { "kind": "HttpDeclProperty", - "docstring": "The list of tools that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run.", + "docstring": "The list of tools that the [assistant](/docs/api-reference/assistants) used for this run.", "key": "tools", "optional": false, "nullable": false, @@ -10534,9 +10405,25 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "type": { "kind": "HttpTypeArray", "elementType": { + "kind": "HttpTypeUnion", + "types": [ + { + "kind": "HttpTypeReference", + "ident": "CodeInterpreterTool", + "$ref": "(resource) beta.assistants > (model) code_interpreter_tool > (schema)" + }, + { + "kind": "HttpTypeReference", + "ident": "FileSearchTool", + "$ref": "(resource) beta.assistants > (model) file_search_tool > (schema)" + }, + { "kind": "HttpTypeReference", - "ident": "AssistantTool", - "$ref": "(resource) beta.assistants > (model) assistant_tool > (schema)" + "ident": "FunctionTool", + "$ref": "(resource) beta.assistants > (model) function_tool > (schema)" + } + ], + "oasRef": "#/components/schemas/RunObject/properties/tools/items" }, "oasRef": "#/components/schemas/RunObject/properties/tools" }, @@ -10545,9 +10432,9 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "schemaType": "array", "childrenParentSchema": "union", "children": [ - "(resource) beta.assistants > (model) assistant_tool > (schema) > (variant) 0", - "(resource) beta.assistants > (model) assistant_tool > (schema) > (variant) 1", - "(resource) beta.assistants > (model) assistant_tool > (schema) > (variant) 2" + "(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 0", + "(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 1", + "(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 2" ] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy": { @@ -10725,7 +10612,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Represents an execution run on a [thread](https://platform.openai.com/docs/api-reference/threads).", + "docstring": "Represents an execution run on a [thread](/docs/api-reference/threads).", "childrenParentSchema": "object", "children": [ "(resource) beta.threads.runs > (model) run > (schema) > (property) id", @@ -10916,7 +10803,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 0": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/anyOf/0", + "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/oneOf/0", "ident": "UnionMember0", "type": { "kind": "HttpTypeUnion", @@ -10926,7 +10813,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "literal": "auto" } ], - "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/anyOf/0" + "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/oneOf/0" }, "docstring": "`auto` is the default value\n", "childrenParentSchema": "enum", @@ -10986,7 +10873,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "literal": "auto" } ], - "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/anyOf/0" + "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/oneOf/0" }, { "kind": "HttpTypeReference", @@ -11006,7 +10893,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch ], "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption" }, - "docstring": "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`.\n\nSetting 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).\n\nSetting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\n**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.\n", + "docstring": "Specifies the format that the model must output. Compatible with [GPT-4o](/docs/models#gpt-4o), [GPT-4 Turbo](/docs/models#gpt-4-turbo-and-gpt-4), and all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`.\n\nSetting 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](/docs/guides/structured-outputs).\n\nSetting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\n**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.\n", "childrenParentSchema": "union", "children": [ "(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 0", @@ -11015,133 +10902,73 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 3" ] }, - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 0": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "queued" } }, - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 1": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 1": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "in_progress" } }, - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 2": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 2": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "requires_action" } }, - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 3": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 3": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "cancelling" } }, - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 4": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 4": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "cancelled" } }, - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 5": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 5": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "failed" } }, - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 6": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 6": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "completed" } }, - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 7": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 7": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "incomplete" } }, - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 8": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 8": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "expired" } }, - "(resource) beta.threads.runs > (model) run_status > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RunStatus", - "ident": "RunStatus", - "type": { - "kind": "HttpTypeUnion", - "types": [ - { - "kind": "HttpTypeLiteral", - "literal": "queued" - }, - { - "kind": "HttpTypeLiteral", - "literal": "in_progress" - }, - { - "kind": "HttpTypeLiteral", - "literal": "requires_action" - }, - { - "kind": "HttpTypeLiteral", - "literal": "cancelling" - }, - { - "kind": "HttpTypeLiteral", - "literal": "cancelled" - }, - { - "kind": "HttpTypeLiteral", - "literal": "failed" - }, - { - "kind": "HttpTypeLiteral", - "literal": "completed" - }, - { - "kind": "HttpTypeLiteral", - "literal": "incomplete" - }, - { - "kind": "HttpTypeLiteral", - "literal": "expired" - } - ], - "oasRef": "#/components/schemas/RunStatus" - }, - "docstring": "The status of the run, which can be either `queued`, `in_progress`, `requires_action`, `cancelling`, `cancelled`, `failed`, `completed`, `incomplete`, or `expired`.", - "childrenParentSchema": "enum", - "children": [ - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 0", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 1", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 2", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 3", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 4", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 5", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 6", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 7", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 8" - ] - }, "(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption/anyOf/0", - "ident": "Auto", + "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption/oneOf/0", + "ident": "UnionMember0", "type": { "kind": "HttpTypeUnion", "types": [ @@ -11158,7 +10985,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "literal": "required" } ], - "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption/anyOf/0" + "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption/oneOf/0" }, "docstring": "`none` means the model will not call any tools and instead generates a message. `auto` means the model can pick between generating a message or calling one or more tools. `required` means the model must call one or more tools before responding to the user.\n", "childrenParentSchema": "enum", @@ -11204,7 +11031,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "literal": "required" } ], - "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption/anyOf/0" + "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption/oneOf/0" }, { "kind": "HttpTypeReference", @@ -11221,7 +11048,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 1" ] }, - "(resource) beta.assistants > (model) assistant_tool > (schema) > (variant) 0": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", @@ -11233,7 +11060,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type" ] }, - "(resource) beta.assistants > (model) assistant_tool > (schema) > (variant) 1": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 1": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", @@ -11246,7 +11073,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search" ] }, - "(resource) beta.assistants > (model) assistant_tool > (schema) > (variant) 2": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 2": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", @@ -11259,36 +11086,63 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.assistants > (model) function_tool > (schema) > (property) type" ] }, - "(resource) beta.assistants > (model) assistant_tool > (schema)": { + "(resource) beta.assistants > (model) code_interpreter_tool > (schema)": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/AssistantTool", - "ident": "AssistantTool", + "oasRef": "#/components/schemas/AssistantToolsCode", + "ident": "CodeInterpreterTool", "type": { - "kind": "HttpTypeUnion", - "types": [ + "kind": "HttpTypeObject", + "members": [ { - "kind": "HttpTypeReference", - "ident": "CodeInterpreterTool", - "$ref": "(resource) beta.assistants > (model) code_interpreter_tool > (schema)" + "ident": "type" + } + ] }, - { - "kind": "HttpTypeReference", + "childrenParentSchema": "object", + "children": [ + "(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type" + ] + }, + "(resource) beta.assistants > (model) file_search_tool > (schema)": { + "kind": "HttpDeclTypeAlias", + "oasRef": "#/components/schemas/AssistantToolsFileSearch", "ident": "FileSearchTool", - "$ref": "(resource) beta.assistants > (model) file_search_tool > (schema)" + "type": { + "kind": "HttpTypeObject", + "members": [ + { + "ident": "type" }, { - "kind": "HttpTypeReference", + "ident": "file_search" + } + ] + }, + "childrenParentSchema": "object", + "children": [ + "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) type", + "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search" + ] + }, + "(resource) beta.assistants > (model) function_tool > (schema)": { + "kind": "HttpDeclTypeAlias", + "oasRef": "#/components/schemas/AssistantToolsFunction", "ident": "FunctionTool", - "$ref": "(resource) beta.assistants > (model) function_tool > (schema)" + "type": { + "kind": "HttpTypeObject", + "members": [ + { + "ident": "function" + }, + { + "ident": "type" } - ], - "oasRef": "#/components/schemas/AssistantTool" + ] }, - "childrenParentSchema": "union", + "childrenParentSchema": "object", "children": [ - "(resource) beta.assistants > (model) assistant_tool > (schema) > (variant) 0", - "(resource) beta.assistants > (model) assistant_tool > (schema) > (variant) 1", - "(resource) beta.assistants > (model) assistant_tool > (schema) > (variant) 2" + "(resource) beta.assistants > (model) function_tool > (schema) > (property) function", + "(resource) beta.assistants > (model) function_tool > (schema) > (property) type" ] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) type": { @@ -11611,7 +11465,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "JSON Schema response format. Used to generate structured JSON responses.\nLearn more about [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs).\n", + "docstring": "JSON Schema response format. Used to generate structured JSON responses.\nLearn more about [Structured Outputs](/docs/guides/structured-outputs).\n", "childrenParentSchema": "object", "children": [ "(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema", @@ -11739,23 +11593,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type > (member) 0" ] }, - "(resource) beta.assistants > (model) code_interpreter_tool > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/AssistantToolsCode", - "ident": "CodeInterpreterTool", - "type": { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "type" - } - ] - }, - "childrenParentSchema": "object", - "children": [ - "(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type" - ] - }, "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) type": { "kind": "HttpDeclProperty", "docstring": "The type of tool being defined: `file_search`", @@ -11806,27 +11643,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options" ] }, - "(resource) beta.assistants > (model) file_search_tool > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/AssistantToolsFileSearch", - "ident": "FileSearchTool", - "type": { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "type" - }, - { - "ident": "file_search" - } - ] - }, - "childrenParentSchema": "object", - "children": [ - "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) type", - "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search" - ] - }, "(resource) beta.assistants > (model) function_tool > (schema) > (property) function": { "kind": "HttpDeclProperty", "key": "function", @@ -11874,27 +11690,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.assistants > (model) function_tool > (schema) > (property) type > (member) 0" ] }, - "(resource) beta.assistants > (model) function_tool > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/AssistantToolsFunction", - "ident": "FunctionTool", - "type": { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "function" - }, - { - "ident": "type" - } - ] - }, - "childrenParentSchema": "object", - "children": [ - "(resource) beta.assistants > (model) function_tool > (schema) > (property) function", - "(resource) beta.assistants > (model) function_tool > (schema) > (property) type" - ] - }, "(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { @@ -11911,7 +11706,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "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.", + "docstring": "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](/docs/api-reference/runs/submitToolOutputs) endpoint.", "key": "id", "optional": false, "nullable": false, @@ -12068,7 +11863,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema > (property) strict": { "kind": "HttpDeclProperty", - "docstring": "Whether to enable strict schema adherence when generating the output.\nIf set to true, the model will always follow the exact schema defined\nin the `schema` field. Only a subset of JSON Schema is supported when\n`strict` is `true`. To learn more, read the [Structured Outputs\nguide](https://platform.openai.com/docs/guides/structured-outputs).\n", + "docstring": "Whether to enable strict schema adherence when generating the output.\nIf set to true, the model will always follow the exact schema defined\nin the `schema` field. Only a subset of JSON Schema is supported when\n`strict` is `true`. To learn more, read the [Structured Outputs\nguide](/docs/guides/structured-outputs).\n", "key": "strict", "optional": true, "nullable": true, @@ -12156,7 +11951,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) max_num_results": { "kind": "HttpDeclProperty", - "docstring": "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.\n\nNote 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.\n", + "docstring": "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.\n\nNote that the file search tool may output fewer than `max_num_results` results. See the [file search tool documentation](/docs/assistants/tools/file-search#customizing-file-search-settings) for more information.\n", "key": "max_num_results", "optional": true, "nullable": false, @@ -12175,7 +11970,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options": { "kind": "HttpDeclProperty", "title": "File search tool call ranking options", - "docstring": "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.\n\nSee the [file search tool documentation](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) for more information.\n", + "docstring": "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.\n\nSee the [file search tool documentation](/docs/assistants/tools/file-search#customizing-file-search-settings) for more information.\n", "key": "ranking_options", "optional": true, "nullable": false, @@ -12229,7 +12024,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) $shared > (model) function_definition > (schema) > (property) parameters": { "kind": "HttpDeclProperty", - "docstring": "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. \n\nOmitting `parameters` defines a function with an empty parameter list.", + "docstring": "The parameters the functions accepts, described as a JSON Schema object. See the [guide](/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. \n\nOmitting `parameters` defines a function with an empty parameter list.", "key": "parameters", "optional": true, "nullable": false, @@ -12247,7 +12042,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) $shared > (model) function_definition > (schema) > (property) strict": { "kind": "HttpDeclProperty", - "docstring": "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).", + "docstring": "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](/docs/guides/function-calling).", "key": "strict", "optional": true, "nullable": true, @@ -12395,7 +12190,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch ], "oasRef": "#/components/schemas/FunctionParameters" }, - "docstring": "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. \n\nOmitting `parameters` defines a function with an empty parameter list.", + "docstring": "The parameters the functions accepts, described as a JSON Schema object. See the [guide](/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. \n\nOmitting `parameters` defines a function with an empty parameter list.", "children": [] }, "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options > (property) ranker > (member) 0": { @@ -12423,7 +12218,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch ## event -Occurs when a [run](https://platform.openai.com/docs/api-reference/runs/object) ends with status `incomplete`. +Occurs when a [run](https://developers.openai.com/docs/api-reference/runs/object) ends with status `incomplete`. ### Schema @@ -12433,8 +12228,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch { "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 6": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RunStreamEvent/anyOf/5", - "ident": "ThreadRunIncomplete", + "oasRef": "#/components/schemas/RunStreamEvent/oneOf/5", + "ident": "UnionMember6", "type": { "kind": "HttpTypeObject", "members": [ @@ -12446,7 +12241,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Occurs when a [run](https://platform.openai.com/docs/api-reference/runs/object) ends with status `incomplete`.", + "docstring": "Occurs when a [run](/docs/api-reference/runs/object) ends with status `incomplete`.", "childrenParentSchema": "object", "children": [ "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 6 > (property) data", @@ -12456,7 +12251,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 6 > (property) data": { "kind": "HttpDeclProperty", "title": "A run on a thread", - "docstring": "Represents an execution run on a [thread](https://platform.openai.com/docs/api-reference/threads).", + "docstring": "Represents an execution run on a [thread](/docs/api-reference/threads).", "key": "data", "optional": false, "nullable": false, @@ -12465,7 +12260,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "ident": "Run", "$ref": "(resource) beta.threads.runs > (model) run > (schema)" }, - "oasRef": "#/components/schemas/RunStreamEvent/anyOf/5/properties/data", + "oasRef": "#/components/schemas/RunStreamEvent/oneOf/5/properties/data", "deprecated": false, "schemaType": "object", "modelImplicit": false, @@ -12514,9 +12309,9 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "literal": "thread.run.incomplete" } ], - "oasRef": "#/components/schemas/RunStreamEvent/anyOf/5/properties/event" + "oasRef": "#/components/schemas/RunStreamEvent/oneOf/5/properties/event" }, - "oasRef": "#/components/schemas/RunStreamEvent/anyOf/5/properties/event", + "oasRef": "#/components/schemas/RunStreamEvent/oneOf/5/properties/event", "deprecated": false, "schemaType": "enum", "childrenParentSchema": "enum", @@ -12540,7 +12335,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) assistant_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for execution of this run.", + "docstring": "The ID of the [assistant](/docs/api-reference/assistants) used for execution of this run.", "key": "assistant_id", "optional": false, "nullable": false, @@ -12661,7 +12456,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) instructions": { "kind": "HttpDeclProperty", - "docstring": "The instructions that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run.", + "docstring": "The instructions that the [assistant](/docs/api-reference/assistants) used for this run.", "key": "instructions", "optional": false, "nullable": false, @@ -12753,7 +12548,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) model": { "kind": "HttpDeclProperty", - "docstring": "The model that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run.", + "docstring": "The model that the [assistant](/docs/api-reference/assistants) used for this run.", "key": "model", "optional": false, "nullable": false, @@ -12791,7 +12586,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) parallel_tool_calls": { "kind": "HttpDeclProperty", - "docstring": "Whether to enable [parallel function calling](https://platform.openai.com/docs/guides/function-calling#configuring-parallel-function-calling) during tool use.", + "docstring": "Whether to enable [parallel function calling](/docs/guides/function-calling#configuring-parallel-function-calling) during tool use.", "key": "parallel_tool_calls", "optional": false, "nullable": false, @@ -12832,7 +12627,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) response_format": { "kind": "HttpDeclProperty", - "docstring": "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`.\n\nSetting 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).\n\nSetting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\n**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.\n", + "docstring": "Specifies the format that the model must output. Compatible with [GPT-4o](/docs/models#gpt-4o), [GPT-4 Turbo](/docs/models#gpt-4-turbo-and-gpt-4), and all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`.\n\nSetting 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](/docs/guides/structured-outputs).\n\nSetting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\n**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.\n", "key": "response_format", "optional": false, "nullable": true, @@ -12878,31 +12673,66 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "optional": false, "nullable": false, "type": { - "kind": "HttpTypeReference", - "ident": "RunStatus", - "$ref": "(resource) beta.threads.runs > (model) run_status > (schema)" + "kind": "HttpTypeUnion", + "types": [ + { + "kind": "HttpTypeLiteral", + "literal": "queued" + }, + { + "kind": "HttpTypeLiteral", + "literal": "in_progress" + }, + { + "kind": "HttpTypeLiteral", + "literal": "requires_action" + }, + { + "kind": "HttpTypeLiteral", + "literal": "cancelling" + }, + { + "kind": "HttpTypeLiteral", + "literal": "cancelled" + }, + { + "kind": "HttpTypeLiteral", + "literal": "failed" + }, + { + "kind": "HttpTypeLiteral", + "literal": "completed" + }, + { + "kind": "HttpTypeLiteral", + "literal": "incomplete" + }, + { + "kind": "HttpTypeLiteral", + "literal": "expired" + } + ], + "oasRef": "#/components/schemas/RunObject/properties/status" }, "oasRef": "#/components/schemas/RunObject/properties/status", "deprecated": false, "schemaType": "enum", - "modelImplicit": false, - "modelPath": "(resource) beta.threads.runs > (model) run_status", "childrenParentSchema": "enum", "children": [ - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 0", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 1", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 2", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 3", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 4", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 5", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 6", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 7", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 8" + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 0", + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 1", + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 2", + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 3", + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 4", + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 5", + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 6", + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 7", + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 8" ] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) thread_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the [thread](https://platform.openai.com/docs/api-reference/threads) that was executed on as a part of this run.", + "docstring": "The ID of the [thread](/docs/api-reference/threads) that was executed on as a part of this run.", "key": "thread_id", "optional": false, "nullable": false, @@ -12938,7 +12768,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) tools": { "kind": "HttpDeclProperty", - "docstring": "The list of tools that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run.", + "docstring": "The list of tools that the [assistant](/docs/api-reference/assistants) used for this run.", "key": "tools", "optional": false, "nullable": false, @@ -12946,9 +12776,25 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "type": { "kind": "HttpTypeArray", "elementType": { + "kind": "HttpTypeUnion", + "types": [ + { "kind": "HttpTypeReference", - "ident": "AssistantTool", - "$ref": "(resource) beta.assistants > (model) assistant_tool > (schema)" + "ident": "CodeInterpreterTool", + "$ref": "(resource) beta.assistants > (model) code_interpreter_tool > (schema)" + }, + { + "kind": "HttpTypeReference", + "ident": "FileSearchTool", + "$ref": "(resource) beta.assistants > (model) file_search_tool > (schema)" + }, + { + "kind": "HttpTypeReference", + "ident": "FunctionTool", + "$ref": "(resource) beta.assistants > (model) function_tool > (schema)" + } + ], + "oasRef": "#/components/schemas/RunObject/properties/tools/items" }, "oasRef": "#/components/schemas/RunObject/properties/tools" }, @@ -12957,9 +12803,9 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "schemaType": "array", "childrenParentSchema": "union", "children": [ - "(resource) beta.assistants > (model) assistant_tool > (schema) > (variant) 0", - "(resource) beta.assistants > (model) assistant_tool > (schema) > (variant) 1", - "(resource) beta.assistants > (model) assistant_tool > (schema) > (variant) 2" + "(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 0", + "(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 1", + "(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 2" ] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy": { @@ -13137,7 +12983,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Represents an execution run on a [thread](https://platform.openai.com/docs/api-reference/threads).", + "docstring": "Represents an execution run on a [thread](/docs/api-reference/threads).", "childrenParentSchema": "object", "children": [ "(resource) beta.threads.runs > (model) run > (schema) > (property) id", @@ -13328,7 +13174,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 0": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/anyOf/0", + "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/oneOf/0", "ident": "UnionMember0", "type": { "kind": "HttpTypeUnion", @@ -13338,7 +13184,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "literal": "auto" } ], - "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/anyOf/0" + "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/oneOf/0" }, "docstring": "`auto` is the default value\n", "childrenParentSchema": "enum", @@ -13398,7 +13244,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "literal": "auto" } ], - "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/anyOf/0" + "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/oneOf/0" }, { "kind": "HttpTypeReference", @@ -13418,7 +13264,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch ], "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption" }, - "docstring": "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`.\n\nSetting 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).\n\nSetting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\n**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.\n", + "docstring": "Specifies the format that the model must output. Compatible with [GPT-4o](/docs/models#gpt-4o), [GPT-4 Turbo](/docs/models#gpt-4-turbo-and-gpt-4), and all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`.\n\nSetting 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](/docs/guides/structured-outputs).\n\nSetting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\n**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.\n", "childrenParentSchema": "union", "children": [ "(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 0", @@ -13427,133 +13273,73 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 3" ] }, - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 0": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "queued" } }, - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 1": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 1": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "in_progress" } }, - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 2": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 2": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "requires_action" } }, - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 3": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 3": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "cancelling" } }, - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 4": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 4": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "cancelled" } }, - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 5": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 5": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "failed" } }, - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 6": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 6": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "completed" } }, - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 7": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 7": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "incomplete" } }, - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 8": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 8": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "expired" } }, - "(resource) beta.threads.runs > (model) run_status > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RunStatus", - "ident": "RunStatus", - "type": { - "kind": "HttpTypeUnion", - "types": [ - { - "kind": "HttpTypeLiteral", - "literal": "queued" - }, - { - "kind": "HttpTypeLiteral", - "literal": "in_progress" - }, - { - "kind": "HttpTypeLiteral", - "literal": "requires_action" - }, - { - "kind": "HttpTypeLiteral", - "literal": "cancelling" - }, - { - "kind": "HttpTypeLiteral", - "literal": "cancelled" - }, - { - "kind": "HttpTypeLiteral", - "literal": "failed" - }, - { - "kind": "HttpTypeLiteral", - "literal": "completed" - }, - { - "kind": "HttpTypeLiteral", - "literal": "incomplete" - }, - { - "kind": "HttpTypeLiteral", - "literal": "expired" - } - ], - "oasRef": "#/components/schemas/RunStatus" - }, - "docstring": "The status of the run, which can be either `queued`, `in_progress`, `requires_action`, `cancelling`, `cancelled`, `failed`, `completed`, `incomplete`, or `expired`.", - "childrenParentSchema": "enum", - "children": [ - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 0", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 1", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 2", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 3", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 4", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 5", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 6", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 7", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 8" - ] - }, "(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption/anyOf/0", - "ident": "Auto", + "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption/oneOf/0", + "ident": "UnionMember0", "type": { "kind": "HttpTypeUnion", "types": [ @@ -13570,7 +13356,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "literal": "required" } ], - "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption/anyOf/0" + "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption/oneOf/0" }, "docstring": "`none` means the model will not call any tools and instead generates a message. `auto` means the model can pick between generating a message or calling one or more tools. `required` means the model must call one or more tools before responding to the user.\n", "childrenParentSchema": "enum", @@ -13616,7 +13402,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "literal": "required" } ], - "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption/anyOf/0" + "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption/oneOf/0" }, { "kind": "HttpTypeReference", @@ -13633,7 +13419,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 1" ] }, - "(resource) beta.assistants > (model) assistant_tool > (schema) > (variant) 0": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", @@ -13645,7 +13431,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type" ] }, - "(resource) beta.assistants > (model) assistant_tool > (schema) > (variant) 1": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 1": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", @@ -13658,7 +13444,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search" ] }, - "(resource) beta.assistants > (model) assistant_tool > (schema) > (variant) 2": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 2": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", @@ -13671,36 +13457,63 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.assistants > (model) function_tool > (schema) > (property) type" ] }, - "(resource) beta.assistants > (model) assistant_tool > (schema)": { + "(resource) beta.assistants > (model) code_interpreter_tool > (schema)": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/AssistantTool", - "ident": "AssistantTool", + "oasRef": "#/components/schemas/AssistantToolsCode", + "ident": "CodeInterpreterTool", "type": { - "kind": "HttpTypeUnion", - "types": [ + "kind": "HttpTypeObject", + "members": [ { - "kind": "HttpTypeReference", - "ident": "CodeInterpreterTool", - "$ref": "(resource) beta.assistants > (model) code_interpreter_tool > (schema)" + "ident": "type" + } + ] }, - { - "kind": "HttpTypeReference", + "childrenParentSchema": "object", + "children": [ + "(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type" + ] + }, + "(resource) beta.assistants > (model) file_search_tool > (schema)": { + "kind": "HttpDeclTypeAlias", + "oasRef": "#/components/schemas/AssistantToolsFileSearch", "ident": "FileSearchTool", - "$ref": "(resource) beta.assistants > (model) file_search_tool > (schema)" + "type": { + "kind": "HttpTypeObject", + "members": [ + { + "ident": "type" }, { - "kind": "HttpTypeReference", + "ident": "file_search" + } + ] + }, + "childrenParentSchema": "object", + "children": [ + "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) type", + "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search" + ] + }, + "(resource) beta.assistants > (model) function_tool > (schema)": { + "kind": "HttpDeclTypeAlias", + "oasRef": "#/components/schemas/AssistantToolsFunction", "ident": "FunctionTool", - "$ref": "(resource) beta.assistants > (model) function_tool > (schema)" + "type": { + "kind": "HttpTypeObject", + "members": [ + { + "ident": "function" + }, + { + "ident": "type" } - ], - "oasRef": "#/components/schemas/AssistantTool" + ] }, - "childrenParentSchema": "union", + "childrenParentSchema": "object", "children": [ - "(resource) beta.assistants > (model) assistant_tool > (schema) > (variant) 0", - "(resource) beta.assistants > (model) assistant_tool > (schema) > (variant) 1", - "(resource) beta.assistants > (model) assistant_tool > (schema) > (variant) 2" + "(resource) beta.assistants > (model) function_tool > (schema) > (property) function", + "(resource) beta.assistants > (model) function_tool > (schema) > (property) type" ] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) type": { @@ -14023,7 +13836,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "JSON Schema response format. Used to generate structured JSON responses.\nLearn more about [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs).\n", + "docstring": "JSON Schema response format. Used to generate structured JSON responses.\nLearn more about [Structured Outputs](/docs/guides/structured-outputs).\n", "childrenParentSchema": "object", "children": [ "(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema", @@ -14151,23 +13964,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type > (member) 0" ] }, - "(resource) beta.assistants > (model) code_interpreter_tool > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/AssistantToolsCode", - "ident": "CodeInterpreterTool", - "type": { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "type" - } - ] - }, - "childrenParentSchema": "object", - "children": [ - "(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type" - ] - }, "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) type": { "kind": "HttpDeclProperty", "docstring": "The type of tool being defined: `file_search`", @@ -14218,27 +14014,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options" ] }, - "(resource) beta.assistants > (model) file_search_tool > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/AssistantToolsFileSearch", - "ident": "FileSearchTool", - "type": { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "type" - }, - { - "ident": "file_search" - } - ] - }, - "childrenParentSchema": "object", - "children": [ - "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) type", - "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search" - ] - }, "(resource) beta.assistants > (model) function_tool > (schema) > (property) function": { "kind": "HttpDeclProperty", "key": "function", @@ -14286,27 +14061,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.assistants > (model) function_tool > (schema) > (property) type > (member) 0" ] }, - "(resource) beta.assistants > (model) function_tool > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/AssistantToolsFunction", - "ident": "FunctionTool", - "type": { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "function" - }, - { - "ident": "type" - } - ] - }, - "childrenParentSchema": "object", - "children": [ - "(resource) beta.assistants > (model) function_tool > (schema) > (property) function", - "(resource) beta.assistants > (model) function_tool > (schema) > (property) type" - ] - }, "(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { @@ -14323,7 +14077,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "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.", + "docstring": "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](/docs/api-reference/runs/submitToolOutputs) endpoint.", "key": "id", "optional": false, "nullable": false, @@ -14480,7 +14234,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema > (property) strict": { "kind": "HttpDeclProperty", - "docstring": "Whether to enable strict schema adherence when generating the output.\nIf set to true, the model will always follow the exact schema defined\nin the `schema` field. Only a subset of JSON Schema is supported when\n`strict` is `true`. To learn more, read the [Structured Outputs\nguide](https://platform.openai.com/docs/guides/structured-outputs).\n", + "docstring": "Whether to enable strict schema adherence when generating the output.\nIf set to true, the model will always follow the exact schema defined\nin the `schema` field. Only a subset of JSON Schema is supported when\n`strict` is `true`. To learn more, read the [Structured Outputs\nguide](/docs/guides/structured-outputs).\n", "key": "strict", "optional": true, "nullable": true, @@ -14568,7 +14322,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) max_num_results": { "kind": "HttpDeclProperty", - "docstring": "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.\n\nNote 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.\n", + "docstring": "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.\n\nNote that the file search tool may output fewer than `max_num_results` results. See the [file search tool documentation](/docs/assistants/tools/file-search#customizing-file-search-settings) for more information.\n", "key": "max_num_results", "optional": true, "nullable": false, @@ -14587,7 +14341,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options": { "kind": "HttpDeclProperty", "title": "File search tool call ranking options", - "docstring": "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.\n\nSee the [file search tool documentation](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) for more information.\n", + "docstring": "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.\n\nSee the [file search tool documentation](/docs/assistants/tools/file-search#customizing-file-search-settings) for more information.\n", "key": "ranking_options", "optional": true, "nullable": false, @@ -14641,7 +14395,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) $shared > (model) function_definition > (schema) > (property) parameters": { "kind": "HttpDeclProperty", - "docstring": "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. \n\nOmitting `parameters` defines a function with an empty parameter list.", + "docstring": "The parameters the functions accepts, described as a JSON Schema object. See the [guide](/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. \n\nOmitting `parameters` defines a function with an empty parameter list.", "key": "parameters", "optional": true, "nullable": false, @@ -14659,7 +14413,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) $shared > (model) function_definition > (schema) > (property) strict": { "kind": "HttpDeclProperty", - "docstring": "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).", + "docstring": "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](/docs/guides/function-calling).", "key": "strict", "optional": true, "nullable": true, @@ -14807,7 +14561,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch ], "oasRef": "#/components/schemas/FunctionParameters" }, - "docstring": "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. \n\nOmitting `parameters` defines a function with an empty parameter list.", + "docstring": "The parameters the functions accepts, described as a JSON Schema object. See the [guide](/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. \n\nOmitting `parameters` defines a function with an empty parameter list.", "children": [] }, "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options > (property) ranker > (member) 0": { @@ -14835,7 +14589,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch ## event -Occurs when a [run](https://platform.openai.com/docs/api-reference/runs/object) fails. +Occurs when a [run](https://developers.openai.com/docs/api-reference/runs/object) fails. ### Schema @@ -14845,8 +14599,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch { "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 7": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RunStreamEvent/anyOf/6", - "ident": "ThreadRunFailed", + "oasRef": "#/components/schemas/RunStreamEvent/oneOf/6", + "ident": "UnionMember7", "type": { "kind": "HttpTypeObject", "members": [ @@ -14858,7 +14612,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Occurs when a [run](https://platform.openai.com/docs/api-reference/runs/object) fails.", + "docstring": "Occurs when a [run](/docs/api-reference/runs/object) fails.", "childrenParentSchema": "object", "children": [ "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 7 > (property) data", @@ -14868,7 +14622,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 7 > (property) data": { "kind": "HttpDeclProperty", "title": "A run on a thread", - "docstring": "Represents an execution run on a [thread](https://platform.openai.com/docs/api-reference/threads).", + "docstring": "Represents an execution run on a [thread](/docs/api-reference/threads).", "key": "data", "optional": false, "nullable": false, @@ -14877,7 +14631,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "ident": "Run", "$ref": "(resource) beta.threads.runs > (model) run > (schema)" }, - "oasRef": "#/components/schemas/RunStreamEvent/anyOf/6/properties/data", + "oasRef": "#/components/schemas/RunStreamEvent/oneOf/6/properties/data", "deprecated": false, "schemaType": "object", "modelImplicit": false, @@ -14926,9 +14680,9 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "literal": "thread.run.failed" } ], - "oasRef": "#/components/schemas/RunStreamEvent/anyOf/6/properties/event" + "oasRef": "#/components/schemas/RunStreamEvent/oneOf/6/properties/event" }, - "oasRef": "#/components/schemas/RunStreamEvent/anyOf/6/properties/event", + "oasRef": "#/components/schemas/RunStreamEvent/oneOf/6/properties/event", "deprecated": false, "schemaType": "enum", "childrenParentSchema": "enum", @@ -14952,7 +14706,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) assistant_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for execution of this run.", + "docstring": "The ID of the [assistant](/docs/api-reference/assistants) used for execution of this run.", "key": "assistant_id", "optional": false, "nullable": false, @@ -15073,7 +14827,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) instructions": { "kind": "HttpDeclProperty", - "docstring": "The instructions that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run.", + "docstring": "The instructions that the [assistant](/docs/api-reference/assistants) used for this run.", "key": "instructions", "optional": false, "nullable": false, @@ -15165,7 +14919,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) model": { "kind": "HttpDeclProperty", - "docstring": "The model that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run.", + "docstring": "The model that the [assistant](/docs/api-reference/assistants) used for this run.", "key": "model", "optional": false, "nullable": false, @@ -15203,7 +14957,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) parallel_tool_calls": { "kind": "HttpDeclProperty", - "docstring": "Whether to enable [parallel function calling](https://platform.openai.com/docs/guides/function-calling#configuring-parallel-function-calling) during tool use.", + "docstring": "Whether to enable [parallel function calling](/docs/guides/function-calling#configuring-parallel-function-calling) during tool use.", "key": "parallel_tool_calls", "optional": false, "nullable": false, @@ -15244,7 +14998,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) response_format": { "kind": "HttpDeclProperty", - "docstring": "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`.\n\nSetting 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).\n\nSetting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\n**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.\n", + "docstring": "Specifies the format that the model must output. Compatible with [GPT-4o](/docs/models#gpt-4o), [GPT-4 Turbo](/docs/models#gpt-4-turbo-and-gpt-4), and all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`.\n\nSetting 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](/docs/guides/structured-outputs).\n\nSetting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\n**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.\n", "key": "response_format", "optional": false, "nullable": true, @@ -15290,31 +15044,66 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "optional": false, "nullable": false, "type": { - "kind": "HttpTypeReference", - "ident": "RunStatus", - "$ref": "(resource) beta.threads.runs > (model) run_status > (schema)" + "kind": "HttpTypeUnion", + "types": [ + { + "kind": "HttpTypeLiteral", + "literal": "queued" + }, + { + "kind": "HttpTypeLiteral", + "literal": "in_progress" + }, + { + "kind": "HttpTypeLiteral", + "literal": "requires_action" + }, + { + "kind": "HttpTypeLiteral", + "literal": "cancelling" + }, + { + "kind": "HttpTypeLiteral", + "literal": "cancelled" + }, + { + "kind": "HttpTypeLiteral", + "literal": "failed" + }, + { + "kind": "HttpTypeLiteral", + "literal": "completed" + }, + { + "kind": "HttpTypeLiteral", + "literal": "incomplete" + }, + { + "kind": "HttpTypeLiteral", + "literal": "expired" + } + ], + "oasRef": "#/components/schemas/RunObject/properties/status" }, "oasRef": "#/components/schemas/RunObject/properties/status", "deprecated": false, "schemaType": "enum", - "modelImplicit": false, - "modelPath": "(resource) beta.threads.runs > (model) run_status", "childrenParentSchema": "enum", "children": [ - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 0", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 1", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 2", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 3", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 4", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 5", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 6", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 7", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 8" + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 0", + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 1", + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 2", + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 3", + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 4", + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 5", + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 6", + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 7", + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 8" ] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) thread_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the [thread](https://platform.openai.com/docs/api-reference/threads) that was executed on as a part of this run.", + "docstring": "The ID of the [thread](/docs/api-reference/threads) that was executed on as a part of this run.", "key": "thread_id", "optional": false, "nullable": false, @@ -15350,7 +15139,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) tools": { "kind": "HttpDeclProperty", - "docstring": "The list of tools that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run.", + "docstring": "The list of tools that the [assistant](/docs/api-reference/assistants) used for this run.", "key": "tools", "optional": false, "nullable": false, @@ -15358,9 +15147,25 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "type": { "kind": "HttpTypeArray", "elementType": { + "kind": "HttpTypeUnion", + "types": [ + { + "kind": "HttpTypeReference", + "ident": "CodeInterpreterTool", + "$ref": "(resource) beta.assistants > (model) code_interpreter_tool > (schema)" + }, + { + "kind": "HttpTypeReference", + "ident": "FileSearchTool", + "$ref": "(resource) beta.assistants > (model) file_search_tool > (schema)" + }, + { "kind": "HttpTypeReference", - "ident": "AssistantTool", - "$ref": "(resource) beta.assistants > (model) assistant_tool > (schema)" + "ident": "FunctionTool", + "$ref": "(resource) beta.assistants > (model) function_tool > (schema)" + } + ], + "oasRef": "#/components/schemas/RunObject/properties/tools/items" }, "oasRef": "#/components/schemas/RunObject/properties/tools" }, @@ -15369,9 +15174,9 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "schemaType": "array", "childrenParentSchema": "union", "children": [ - "(resource) beta.assistants > (model) assistant_tool > (schema) > (variant) 0", - "(resource) beta.assistants > (model) assistant_tool > (schema) > (variant) 1", - "(resource) beta.assistants > (model) assistant_tool > (schema) > (variant) 2" + "(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 0", + "(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 1", + "(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 2" ] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy": { @@ -15549,7 +15354,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Represents an execution run on a [thread](https://platform.openai.com/docs/api-reference/threads).", + "docstring": "Represents an execution run on a [thread](/docs/api-reference/threads).", "childrenParentSchema": "object", "children": [ "(resource) beta.threads.runs > (model) run > (schema) > (property) id", @@ -15740,7 +15545,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 0": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/anyOf/0", + "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/oneOf/0", "ident": "UnionMember0", "type": { "kind": "HttpTypeUnion", @@ -15750,7 +15555,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "literal": "auto" } ], - "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/anyOf/0" + "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/oneOf/0" }, "docstring": "`auto` is the default value\n", "childrenParentSchema": "enum", @@ -15810,7 +15615,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "literal": "auto" } ], - "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/anyOf/0" + "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/oneOf/0" }, { "kind": "HttpTypeReference", @@ -15830,7 +15635,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch ], "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption" }, - "docstring": "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`.\n\nSetting 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).\n\nSetting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\n**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.\n", + "docstring": "Specifies the format that the model must output. Compatible with [GPT-4o](/docs/models#gpt-4o), [GPT-4 Turbo](/docs/models#gpt-4-turbo-and-gpt-4), and all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`.\n\nSetting 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](/docs/guides/structured-outputs).\n\nSetting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\n**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.\n", "childrenParentSchema": "union", "children": [ "(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 0", @@ -15839,133 +15644,73 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 3" ] }, - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 0": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "queued" } }, - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 1": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 1": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "in_progress" } }, - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 2": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 2": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "requires_action" } }, - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 3": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 3": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "cancelling" } }, - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 4": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 4": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "cancelled" } }, - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 5": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 5": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "failed" } }, - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 6": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 6": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "completed" } }, - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 7": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 7": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "incomplete" } }, - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 8": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 8": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "expired" } }, - "(resource) beta.threads.runs > (model) run_status > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RunStatus", - "ident": "RunStatus", - "type": { - "kind": "HttpTypeUnion", - "types": [ - { - "kind": "HttpTypeLiteral", - "literal": "queued" - }, - { - "kind": "HttpTypeLiteral", - "literal": "in_progress" - }, - { - "kind": "HttpTypeLiteral", - "literal": "requires_action" - }, - { - "kind": "HttpTypeLiteral", - "literal": "cancelling" - }, - { - "kind": "HttpTypeLiteral", - "literal": "cancelled" - }, - { - "kind": "HttpTypeLiteral", - "literal": "failed" - }, - { - "kind": "HttpTypeLiteral", - "literal": "completed" - }, - { - "kind": "HttpTypeLiteral", - "literal": "incomplete" - }, - { - "kind": "HttpTypeLiteral", - "literal": "expired" - } - ], - "oasRef": "#/components/schemas/RunStatus" - }, - "docstring": "The status of the run, which can be either `queued`, `in_progress`, `requires_action`, `cancelling`, `cancelled`, `failed`, `completed`, `incomplete`, or `expired`.", - "childrenParentSchema": "enum", - "children": [ - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 0", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 1", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 2", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 3", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 4", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 5", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 6", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 7", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 8" - ] - }, "(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption/anyOf/0", - "ident": "Auto", + "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption/oneOf/0", + "ident": "UnionMember0", "type": { "kind": "HttpTypeUnion", "types": [ @@ -15982,7 +15727,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "literal": "required" } ], - "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption/anyOf/0" + "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption/oneOf/0" }, "docstring": "`none` means the model will not call any tools and instead generates a message. `auto` means the model can pick between generating a message or calling one or more tools. `required` means the model must call one or more tools before responding to the user.\n", "childrenParentSchema": "enum", @@ -16028,7 +15773,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "literal": "required" } ], - "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption/anyOf/0" + "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption/oneOf/0" }, { "kind": "HttpTypeReference", @@ -16045,7 +15790,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 1" ] }, - "(resource) beta.assistants > (model) assistant_tool > (schema) > (variant) 0": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", @@ -16057,7 +15802,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type" ] }, - "(resource) beta.assistants > (model) assistant_tool > (schema) > (variant) 1": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 1": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", @@ -16070,7 +15815,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search" ] }, - "(resource) beta.assistants > (model) assistant_tool > (schema) > (variant) 2": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 2": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", @@ -16083,36 +15828,63 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.assistants > (model) function_tool > (schema) > (property) type" ] }, - "(resource) beta.assistants > (model) assistant_tool > (schema)": { + "(resource) beta.assistants > (model) code_interpreter_tool > (schema)": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/AssistantTool", - "ident": "AssistantTool", + "oasRef": "#/components/schemas/AssistantToolsCode", + "ident": "CodeInterpreterTool", "type": { - "kind": "HttpTypeUnion", - "types": [ + "kind": "HttpTypeObject", + "members": [ { - "kind": "HttpTypeReference", - "ident": "CodeInterpreterTool", - "$ref": "(resource) beta.assistants > (model) code_interpreter_tool > (schema)" + "ident": "type" + } + ] }, - { - "kind": "HttpTypeReference", + "childrenParentSchema": "object", + "children": [ + "(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type" + ] + }, + "(resource) beta.assistants > (model) file_search_tool > (schema)": { + "kind": "HttpDeclTypeAlias", + "oasRef": "#/components/schemas/AssistantToolsFileSearch", "ident": "FileSearchTool", - "$ref": "(resource) beta.assistants > (model) file_search_tool > (schema)" + "type": { + "kind": "HttpTypeObject", + "members": [ + { + "ident": "type" }, { - "kind": "HttpTypeReference", + "ident": "file_search" + } + ] + }, + "childrenParentSchema": "object", + "children": [ + "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) type", + "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search" + ] + }, + "(resource) beta.assistants > (model) function_tool > (schema)": { + "kind": "HttpDeclTypeAlias", + "oasRef": "#/components/schemas/AssistantToolsFunction", "ident": "FunctionTool", - "$ref": "(resource) beta.assistants > (model) function_tool > (schema)" + "type": { + "kind": "HttpTypeObject", + "members": [ + { + "ident": "function" + }, + { + "ident": "type" } - ], - "oasRef": "#/components/schemas/AssistantTool" + ] }, - "childrenParentSchema": "union", + "childrenParentSchema": "object", "children": [ - "(resource) beta.assistants > (model) assistant_tool > (schema) > (variant) 0", - "(resource) beta.assistants > (model) assistant_tool > (schema) > (variant) 1", - "(resource) beta.assistants > (model) assistant_tool > (schema) > (variant) 2" + "(resource) beta.assistants > (model) function_tool > (schema) > (property) function", + "(resource) beta.assistants > (model) function_tool > (schema) > (property) type" ] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) type": { @@ -16435,7 +16207,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "JSON Schema response format. Used to generate structured JSON responses.\nLearn more about [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs).\n", + "docstring": "JSON Schema response format. Used to generate structured JSON responses.\nLearn more about [Structured Outputs](/docs/guides/structured-outputs).\n", "childrenParentSchema": "object", "children": [ "(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema", @@ -16563,23 +16335,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type > (member) 0" ] }, - "(resource) beta.assistants > (model) code_interpreter_tool > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/AssistantToolsCode", - "ident": "CodeInterpreterTool", - "type": { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "type" - } - ] - }, - "childrenParentSchema": "object", - "children": [ - "(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type" - ] - }, "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) type": { "kind": "HttpDeclProperty", "docstring": "The type of tool being defined: `file_search`", @@ -16630,27 +16385,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options" ] }, - "(resource) beta.assistants > (model) file_search_tool > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/AssistantToolsFileSearch", - "ident": "FileSearchTool", - "type": { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "type" - }, - { - "ident": "file_search" - } - ] - }, - "childrenParentSchema": "object", - "children": [ - "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) type", - "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search" - ] - }, "(resource) beta.assistants > (model) function_tool > (schema) > (property) function": { "kind": "HttpDeclProperty", "key": "function", @@ -16698,27 +16432,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.assistants > (model) function_tool > (schema) > (property) type > (member) 0" ] }, - "(resource) beta.assistants > (model) function_tool > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/AssistantToolsFunction", - "ident": "FunctionTool", - "type": { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "function" - }, - { - "ident": "type" - } - ] - }, - "childrenParentSchema": "object", - "children": [ - "(resource) beta.assistants > (model) function_tool > (schema) > (property) function", - "(resource) beta.assistants > (model) function_tool > (schema) > (property) type" - ] - }, "(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { @@ -16735,7 +16448,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "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.", + "docstring": "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](/docs/api-reference/runs/submitToolOutputs) endpoint.", "key": "id", "optional": false, "nullable": false, @@ -16892,7 +16605,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema > (property) strict": { "kind": "HttpDeclProperty", - "docstring": "Whether to enable strict schema adherence when generating the output.\nIf set to true, the model will always follow the exact schema defined\nin the `schema` field. Only a subset of JSON Schema is supported when\n`strict` is `true`. To learn more, read the [Structured Outputs\nguide](https://platform.openai.com/docs/guides/structured-outputs).\n", + "docstring": "Whether to enable strict schema adherence when generating the output.\nIf set to true, the model will always follow the exact schema defined\nin the `schema` field. Only a subset of JSON Schema is supported when\n`strict` is `true`. To learn more, read the [Structured Outputs\nguide](/docs/guides/structured-outputs).\n", "key": "strict", "optional": true, "nullable": true, @@ -16980,7 +16693,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) max_num_results": { "kind": "HttpDeclProperty", - "docstring": "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.\n\nNote 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.\n", + "docstring": "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.\n\nNote that the file search tool may output fewer than `max_num_results` results. See the [file search tool documentation](/docs/assistants/tools/file-search#customizing-file-search-settings) for more information.\n", "key": "max_num_results", "optional": true, "nullable": false, @@ -16999,7 +16712,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options": { "kind": "HttpDeclProperty", "title": "File search tool call ranking options", - "docstring": "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.\n\nSee the [file search tool documentation](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) for more information.\n", + "docstring": "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.\n\nSee the [file search tool documentation](/docs/assistants/tools/file-search#customizing-file-search-settings) for more information.\n", "key": "ranking_options", "optional": true, "nullable": false, @@ -17053,7 +16766,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) $shared > (model) function_definition > (schema) > (property) parameters": { "kind": "HttpDeclProperty", - "docstring": "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. \n\nOmitting `parameters` defines a function with an empty parameter list.", + "docstring": "The parameters the functions accepts, described as a JSON Schema object. See the [guide](/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. \n\nOmitting `parameters` defines a function with an empty parameter list.", "key": "parameters", "optional": true, "nullable": false, @@ -17071,7 +16784,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) $shared > (model) function_definition > (schema) > (property) strict": { "kind": "HttpDeclProperty", - "docstring": "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).", + "docstring": "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](/docs/guides/function-calling).", "key": "strict", "optional": true, "nullable": true, @@ -17219,7 +16932,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch ], "oasRef": "#/components/schemas/FunctionParameters" }, - "docstring": "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. \n\nOmitting `parameters` defines a function with an empty parameter list.", + "docstring": "The parameters the functions accepts, described as a JSON Schema object. See the [guide](/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. \n\nOmitting `parameters` defines a function with an empty parameter list.", "children": [] }, "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options > (property) ranker > (member) 0": { @@ -17247,7 +16960,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch ## event -Occurs when a [run](https://platform.openai.com/docs/api-reference/runs/object) moves to a `cancelling` status. +Occurs when a [run](https://developers.openai.com/docs/api-reference/runs/object) moves to a `cancelling` status. ### Schema @@ -17257,8 +16970,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch { "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 8": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RunStreamEvent/anyOf/7", - "ident": "ThreadRunCancelling", + "oasRef": "#/components/schemas/RunStreamEvent/oneOf/7", + "ident": "UnionMember8", "type": { "kind": "HttpTypeObject", "members": [ @@ -17270,7 +16983,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Occurs when a [run](https://platform.openai.com/docs/api-reference/runs/object) moves to a `cancelling` status.", + "docstring": "Occurs when a [run](/docs/api-reference/runs/object) moves to a `cancelling` status.", "childrenParentSchema": "object", "children": [ "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 8 > (property) data", @@ -17280,7 +16993,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 8 > (property) data": { "kind": "HttpDeclProperty", "title": "A run on a thread", - "docstring": "Represents an execution run on a [thread](https://platform.openai.com/docs/api-reference/threads).", + "docstring": "Represents an execution run on a [thread](/docs/api-reference/threads).", "key": "data", "optional": false, "nullable": false, @@ -17289,7 +17002,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "ident": "Run", "$ref": "(resource) beta.threads.runs > (model) run > (schema)" }, - "oasRef": "#/components/schemas/RunStreamEvent/anyOf/7/properties/data", + "oasRef": "#/components/schemas/RunStreamEvent/oneOf/7/properties/data", "deprecated": false, "schemaType": "object", "modelImplicit": false, @@ -17338,9 +17051,9 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "literal": "thread.run.cancelling" } ], - "oasRef": "#/components/schemas/RunStreamEvent/anyOf/7/properties/event" + "oasRef": "#/components/schemas/RunStreamEvent/oneOf/7/properties/event" }, - "oasRef": "#/components/schemas/RunStreamEvent/anyOf/7/properties/event", + "oasRef": "#/components/schemas/RunStreamEvent/oneOf/7/properties/event", "deprecated": false, "schemaType": "enum", "childrenParentSchema": "enum", @@ -17364,7 +17077,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) assistant_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for execution of this run.", + "docstring": "The ID of the [assistant](/docs/api-reference/assistants) used for execution of this run.", "key": "assistant_id", "optional": false, "nullable": false, @@ -17485,7 +17198,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) instructions": { "kind": "HttpDeclProperty", - "docstring": "The instructions that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run.", + "docstring": "The instructions that the [assistant](/docs/api-reference/assistants) used for this run.", "key": "instructions", "optional": false, "nullable": false, @@ -17577,7 +17290,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) model": { "kind": "HttpDeclProperty", - "docstring": "The model that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run.", + "docstring": "The model that the [assistant](/docs/api-reference/assistants) used for this run.", "key": "model", "optional": false, "nullable": false, @@ -17615,7 +17328,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) parallel_tool_calls": { "kind": "HttpDeclProperty", - "docstring": "Whether to enable [parallel function calling](https://platform.openai.com/docs/guides/function-calling#configuring-parallel-function-calling) during tool use.", + "docstring": "Whether to enable [parallel function calling](/docs/guides/function-calling#configuring-parallel-function-calling) during tool use.", "key": "parallel_tool_calls", "optional": false, "nullable": false, @@ -17656,7 +17369,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) response_format": { "kind": "HttpDeclProperty", - "docstring": "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`.\n\nSetting 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).\n\nSetting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\n**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.\n", + "docstring": "Specifies the format that the model must output. Compatible with [GPT-4o](/docs/models#gpt-4o), [GPT-4 Turbo](/docs/models#gpt-4-turbo-and-gpt-4), and all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`.\n\nSetting 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](/docs/guides/structured-outputs).\n\nSetting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\n**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.\n", "key": "response_format", "optional": false, "nullable": true, @@ -17702,31 +17415,66 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "optional": false, "nullable": false, "type": { - "kind": "HttpTypeReference", - "ident": "RunStatus", - "$ref": "(resource) beta.threads.runs > (model) run_status > (schema)" + "kind": "HttpTypeUnion", + "types": [ + { + "kind": "HttpTypeLiteral", + "literal": "queued" + }, + { + "kind": "HttpTypeLiteral", + "literal": "in_progress" + }, + { + "kind": "HttpTypeLiteral", + "literal": "requires_action" + }, + { + "kind": "HttpTypeLiteral", + "literal": "cancelling" + }, + { + "kind": "HttpTypeLiteral", + "literal": "cancelled" + }, + { + "kind": "HttpTypeLiteral", + "literal": "failed" + }, + { + "kind": "HttpTypeLiteral", + "literal": "completed" + }, + { + "kind": "HttpTypeLiteral", + "literal": "incomplete" + }, + { + "kind": "HttpTypeLiteral", + "literal": "expired" + } + ], + "oasRef": "#/components/schemas/RunObject/properties/status" }, "oasRef": "#/components/schemas/RunObject/properties/status", "deprecated": false, "schemaType": "enum", - "modelImplicit": false, - "modelPath": "(resource) beta.threads.runs > (model) run_status", "childrenParentSchema": "enum", "children": [ - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 0", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 1", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 2", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 3", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 4", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 5", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 6", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 7", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 8" + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 0", + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 1", + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 2", + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 3", + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 4", + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 5", + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 6", + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 7", + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 8" ] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) thread_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the [thread](https://platform.openai.com/docs/api-reference/threads) that was executed on as a part of this run.", + "docstring": "The ID of the [thread](/docs/api-reference/threads) that was executed on as a part of this run.", "key": "thread_id", "optional": false, "nullable": false, @@ -17762,7 +17510,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) tools": { "kind": "HttpDeclProperty", - "docstring": "The list of tools that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run.", + "docstring": "The list of tools that the [assistant](/docs/api-reference/assistants) used for this run.", "key": "tools", "optional": false, "nullable": false, @@ -17770,9 +17518,25 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "type": { "kind": "HttpTypeArray", "elementType": { + "kind": "HttpTypeUnion", + "types": [ + { + "kind": "HttpTypeReference", + "ident": "CodeInterpreterTool", + "$ref": "(resource) beta.assistants > (model) code_interpreter_tool > (schema)" + }, + { + "kind": "HttpTypeReference", + "ident": "FileSearchTool", + "$ref": "(resource) beta.assistants > (model) file_search_tool > (schema)" + }, + { "kind": "HttpTypeReference", - "ident": "AssistantTool", - "$ref": "(resource) beta.assistants > (model) assistant_tool > (schema)" + "ident": "FunctionTool", + "$ref": "(resource) beta.assistants > (model) function_tool > (schema)" + } + ], + "oasRef": "#/components/schemas/RunObject/properties/tools/items" }, "oasRef": "#/components/schemas/RunObject/properties/tools" }, @@ -17781,9 +17545,9 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "schemaType": "array", "childrenParentSchema": "union", "children": [ - "(resource) beta.assistants > (model) assistant_tool > (schema) > (variant) 0", - "(resource) beta.assistants > (model) assistant_tool > (schema) > (variant) 1", - "(resource) beta.assistants > (model) assistant_tool > (schema) > (variant) 2" + "(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 0", + "(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 1", + "(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 2" ] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy": { @@ -17961,7 +17725,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Represents an execution run on a [thread](https://platform.openai.com/docs/api-reference/threads).", + "docstring": "Represents an execution run on a [thread](/docs/api-reference/threads).", "childrenParentSchema": "object", "children": [ "(resource) beta.threads.runs > (model) run > (schema) > (property) id", @@ -18152,7 +17916,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 0": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/anyOf/0", + "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/oneOf/0", "ident": "UnionMember0", "type": { "kind": "HttpTypeUnion", @@ -18162,7 +17926,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "literal": "auto" } ], - "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/anyOf/0" + "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/oneOf/0" }, "docstring": "`auto` is the default value\n", "childrenParentSchema": "enum", @@ -18222,7 +17986,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "literal": "auto" } ], - "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/anyOf/0" + "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/oneOf/0" }, { "kind": "HttpTypeReference", @@ -18242,7 +18006,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch ], "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption" }, - "docstring": "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`.\n\nSetting 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).\n\nSetting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\n**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.\n", + "docstring": "Specifies the format that the model must output. Compatible with [GPT-4o](/docs/models#gpt-4o), [GPT-4 Turbo](/docs/models#gpt-4-turbo-and-gpt-4), and all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`.\n\nSetting 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](/docs/guides/structured-outputs).\n\nSetting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\n**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.\n", "childrenParentSchema": "union", "children": [ "(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 0", @@ -18251,133 +18015,73 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 3" ] }, - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 0": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "queued" } }, - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 1": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 1": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "in_progress" } }, - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 2": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 2": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "requires_action" } }, - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 3": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 3": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "cancelling" } }, - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 4": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 4": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "cancelled" } }, - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 5": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 5": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "failed" } }, - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 6": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 6": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "completed" } }, - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 7": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 7": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "incomplete" } }, - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 8": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 8": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "expired" } }, - "(resource) beta.threads.runs > (model) run_status > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RunStatus", - "ident": "RunStatus", - "type": { - "kind": "HttpTypeUnion", - "types": [ - { - "kind": "HttpTypeLiteral", - "literal": "queued" - }, - { - "kind": "HttpTypeLiteral", - "literal": "in_progress" - }, - { - "kind": "HttpTypeLiteral", - "literal": "requires_action" - }, - { - "kind": "HttpTypeLiteral", - "literal": "cancelling" - }, - { - "kind": "HttpTypeLiteral", - "literal": "cancelled" - }, - { - "kind": "HttpTypeLiteral", - "literal": "failed" - }, - { - "kind": "HttpTypeLiteral", - "literal": "completed" - }, - { - "kind": "HttpTypeLiteral", - "literal": "incomplete" - }, - { - "kind": "HttpTypeLiteral", - "literal": "expired" - } - ], - "oasRef": "#/components/schemas/RunStatus" - }, - "docstring": "The status of the run, which can be either `queued`, `in_progress`, `requires_action`, `cancelling`, `cancelled`, `failed`, `completed`, `incomplete`, or `expired`.", - "childrenParentSchema": "enum", - "children": [ - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 0", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 1", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 2", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 3", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 4", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 5", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 6", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 7", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 8" - ] - }, "(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption/anyOf/0", - "ident": "Auto", + "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption/oneOf/0", + "ident": "UnionMember0", "type": { "kind": "HttpTypeUnion", "types": [ @@ -18394,7 +18098,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "literal": "required" } ], - "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption/anyOf/0" + "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption/oneOf/0" }, "docstring": "`none` means the model will not call any tools and instead generates a message. `auto` means the model can pick between generating a message or calling one or more tools. `required` means the model must call one or more tools before responding to the user.\n", "childrenParentSchema": "enum", @@ -18440,7 +18144,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "literal": "required" } ], - "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption/anyOf/0" + "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption/oneOf/0" }, { "kind": "HttpTypeReference", @@ -18457,7 +18161,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 1" ] }, - "(resource) beta.assistants > (model) assistant_tool > (schema) > (variant) 0": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", @@ -18469,7 +18173,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type" ] }, - "(resource) beta.assistants > (model) assistant_tool > (schema) > (variant) 1": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 1": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", @@ -18482,7 +18186,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search" ] }, - "(resource) beta.assistants > (model) assistant_tool > (schema) > (variant) 2": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 2": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", @@ -18495,36 +18199,63 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.assistants > (model) function_tool > (schema) > (property) type" ] }, - "(resource) beta.assistants > (model) assistant_tool > (schema)": { + "(resource) beta.assistants > (model) code_interpreter_tool > (schema)": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/AssistantTool", - "ident": "AssistantTool", + "oasRef": "#/components/schemas/AssistantToolsCode", + "ident": "CodeInterpreterTool", "type": { - "kind": "HttpTypeUnion", - "types": [ + "kind": "HttpTypeObject", + "members": [ { - "kind": "HttpTypeReference", - "ident": "CodeInterpreterTool", - "$ref": "(resource) beta.assistants > (model) code_interpreter_tool > (schema)" + "ident": "type" + } + ] }, - { - "kind": "HttpTypeReference", + "childrenParentSchema": "object", + "children": [ + "(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type" + ] + }, + "(resource) beta.assistants > (model) file_search_tool > (schema)": { + "kind": "HttpDeclTypeAlias", + "oasRef": "#/components/schemas/AssistantToolsFileSearch", "ident": "FileSearchTool", - "$ref": "(resource) beta.assistants > (model) file_search_tool > (schema)" + "type": { + "kind": "HttpTypeObject", + "members": [ + { + "ident": "type" }, { - "kind": "HttpTypeReference", + "ident": "file_search" + } + ] + }, + "childrenParentSchema": "object", + "children": [ + "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) type", + "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search" + ] + }, + "(resource) beta.assistants > (model) function_tool > (schema)": { + "kind": "HttpDeclTypeAlias", + "oasRef": "#/components/schemas/AssistantToolsFunction", "ident": "FunctionTool", - "$ref": "(resource) beta.assistants > (model) function_tool > (schema)" + "type": { + "kind": "HttpTypeObject", + "members": [ + { + "ident": "function" + }, + { + "ident": "type" } - ], - "oasRef": "#/components/schemas/AssistantTool" + ] }, - "childrenParentSchema": "union", + "childrenParentSchema": "object", "children": [ - "(resource) beta.assistants > (model) assistant_tool > (schema) > (variant) 0", - "(resource) beta.assistants > (model) assistant_tool > (schema) > (variant) 1", - "(resource) beta.assistants > (model) assistant_tool > (schema) > (variant) 2" + "(resource) beta.assistants > (model) function_tool > (schema) > (property) function", + "(resource) beta.assistants > (model) function_tool > (schema) > (property) type" ] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) type": { @@ -18847,7 +18578,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "JSON Schema response format. Used to generate structured JSON responses.\nLearn more about [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs).\n", + "docstring": "JSON Schema response format. Used to generate structured JSON responses.\nLearn more about [Structured Outputs](/docs/guides/structured-outputs).\n", "childrenParentSchema": "object", "children": [ "(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema", @@ -18975,23 +18706,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type > (member) 0" ] }, - "(resource) beta.assistants > (model) code_interpreter_tool > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/AssistantToolsCode", - "ident": "CodeInterpreterTool", - "type": { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "type" - } - ] - }, - "childrenParentSchema": "object", - "children": [ - "(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type" - ] - }, "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) type": { "kind": "HttpDeclProperty", "docstring": "The type of tool being defined: `file_search`", @@ -19042,27 +18756,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options" ] }, - "(resource) beta.assistants > (model) file_search_tool > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/AssistantToolsFileSearch", - "ident": "FileSearchTool", - "type": { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "type" - }, - { - "ident": "file_search" - } - ] - }, - "childrenParentSchema": "object", - "children": [ - "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) type", - "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search" - ] - }, "(resource) beta.assistants > (model) function_tool > (schema) > (property) function": { "kind": "HttpDeclProperty", "key": "function", @@ -19110,27 +18803,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.assistants > (model) function_tool > (schema) > (property) type > (member) 0" ] }, - "(resource) beta.assistants > (model) function_tool > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/AssistantToolsFunction", - "ident": "FunctionTool", - "type": { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "function" - }, - { - "ident": "type" - } - ] - }, - "childrenParentSchema": "object", - "children": [ - "(resource) beta.assistants > (model) function_tool > (schema) > (property) function", - "(resource) beta.assistants > (model) function_tool > (schema) > (property) type" - ] - }, "(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { @@ -19147,7 +18819,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "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.", + "docstring": "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](/docs/api-reference/runs/submitToolOutputs) endpoint.", "key": "id", "optional": false, "nullable": false, @@ -19304,7 +18976,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema > (property) strict": { "kind": "HttpDeclProperty", - "docstring": "Whether to enable strict schema adherence when generating the output.\nIf set to true, the model will always follow the exact schema defined\nin the `schema` field. Only a subset of JSON Schema is supported when\n`strict` is `true`. To learn more, read the [Structured Outputs\nguide](https://platform.openai.com/docs/guides/structured-outputs).\n", + "docstring": "Whether to enable strict schema adherence when generating the output.\nIf set to true, the model will always follow the exact schema defined\nin the `schema` field. Only a subset of JSON Schema is supported when\n`strict` is `true`. To learn more, read the [Structured Outputs\nguide](/docs/guides/structured-outputs).\n", "key": "strict", "optional": true, "nullable": true, @@ -19392,7 +19064,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) max_num_results": { "kind": "HttpDeclProperty", - "docstring": "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.\n\nNote 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.\n", + "docstring": "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.\n\nNote that the file search tool may output fewer than `max_num_results` results. See the [file search tool documentation](/docs/assistants/tools/file-search#customizing-file-search-settings) for more information.\n", "key": "max_num_results", "optional": true, "nullable": false, @@ -19411,7 +19083,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options": { "kind": "HttpDeclProperty", "title": "File search tool call ranking options", - "docstring": "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.\n\nSee the [file search tool documentation](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) for more information.\n", + "docstring": "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.\n\nSee the [file search tool documentation](/docs/assistants/tools/file-search#customizing-file-search-settings) for more information.\n", "key": "ranking_options", "optional": true, "nullable": false, @@ -19465,7 +19137,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) $shared > (model) function_definition > (schema) > (property) parameters": { "kind": "HttpDeclProperty", - "docstring": "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. \n\nOmitting `parameters` defines a function with an empty parameter list.", + "docstring": "The parameters the functions accepts, described as a JSON Schema object. See the [guide](/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. \n\nOmitting `parameters` defines a function with an empty parameter list.", "key": "parameters", "optional": true, "nullable": false, @@ -19483,7 +19155,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) $shared > (model) function_definition > (schema) > (property) strict": { "kind": "HttpDeclProperty", - "docstring": "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).", + "docstring": "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](/docs/guides/function-calling).", "key": "strict", "optional": true, "nullable": true, @@ -19631,7 +19303,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch ], "oasRef": "#/components/schemas/FunctionParameters" }, - "docstring": "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. \n\nOmitting `parameters` defines a function with an empty parameter list.", + "docstring": "The parameters the functions accepts, described as a JSON Schema object. See the [guide](/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. \n\nOmitting `parameters` defines a function with an empty parameter list.", "children": [] }, "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options > (property) ranker > (member) 0": { @@ -19659,7 +19331,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch ## event -Occurs when a [run](https://platform.openai.com/docs/api-reference/runs/object) is cancelled. +Occurs when a [run](https://developers.openai.com/docs/api-reference/runs/object) is cancelled. ### Schema @@ -19669,8 +19341,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch { "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 9": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RunStreamEvent/anyOf/8", - "ident": "ThreadRunCancelled", + "oasRef": "#/components/schemas/RunStreamEvent/oneOf/8", + "ident": "UnionMember9", "type": { "kind": "HttpTypeObject", "members": [ @@ -19682,7 +19354,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Occurs when a [run](https://platform.openai.com/docs/api-reference/runs/object) is cancelled.", + "docstring": "Occurs when a [run](/docs/api-reference/runs/object) is cancelled.", "childrenParentSchema": "object", "children": [ "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 9 > (property) data", @@ -19692,7 +19364,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 9 > (property) data": { "kind": "HttpDeclProperty", "title": "A run on a thread", - "docstring": "Represents an execution run on a [thread](https://platform.openai.com/docs/api-reference/threads).", + "docstring": "Represents an execution run on a [thread](/docs/api-reference/threads).", "key": "data", "optional": false, "nullable": false, @@ -19701,7 +19373,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "ident": "Run", "$ref": "(resource) beta.threads.runs > (model) run > (schema)" }, - "oasRef": "#/components/schemas/RunStreamEvent/anyOf/8/properties/data", + "oasRef": "#/components/schemas/RunStreamEvent/oneOf/8/properties/data", "deprecated": false, "schemaType": "object", "modelImplicit": false, @@ -19750,9 +19422,9 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "literal": "thread.run.cancelled" } ], - "oasRef": "#/components/schemas/RunStreamEvent/anyOf/8/properties/event" + "oasRef": "#/components/schemas/RunStreamEvent/oneOf/8/properties/event" }, - "oasRef": "#/components/schemas/RunStreamEvent/anyOf/8/properties/event", + "oasRef": "#/components/schemas/RunStreamEvent/oneOf/8/properties/event", "deprecated": false, "schemaType": "enum", "childrenParentSchema": "enum", @@ -19776,7 +19448,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) assistant_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for execution of this run.", + "docstring": "The ID of the [assistant](/docs/api-reference/assistants) used for execution of this run.", "key": "assistant_id", "optional": false, "nullable": false, @@ -19897,7 +19569,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) instructions": { "kind": "HttpDeclProperty", - "docstring": "The instructions that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run.", + "docstring": "The instructions that the [assistant](/docs/api-reference/assistants) used for this run.", "key": "instructions", "optional": false, "nullable": false, @@ -19989,7 +19661,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) model": { "kind": "HttpDeclProperty", - "docstring": "The model that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run.", + "docstring": "The model that the [assistant](/docs/api-reference/assistants) used for this run.", "key": "model", "optional": false, "nullable": false, @@ -20027,7 +19699,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) parallel_tool_calls": { "kind": "HttpDeclProperty", - "docstring": "Whether to enable [parallel function calling](https://platform.openai.com/docs/guides/function-calling#configuring-parallel-function-calling) during tool use.", + "docstring": "Whether to enable [parallel function calling](/docs/guides/function-calling#configuring-parallel-function-calling) during tool use.", "key": "parallel_tool_calls", "optional": false, "nullable": false, @@ -20068,7 +19740,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) response_format": { "kind": "HttpDeclProperty", - "docstring": "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`.\n\nSetting 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).\n\nSetting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\n**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.\n", + "docstring": "Specifies the format that the model must output. Compatible with [GPT-4o](/docs/models#gpt-4o), [GPT-4 Turbo](/docs/models#gpt-4-turbo-and-gpt-4), and all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`.\n\nSetting 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](/docs/guides/structured-outputs).\n\nSetting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\n**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.\n", "key": "response_format", "optional": false, "nullable": true, @@ -20114,31 +19786,66 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "optional": false, "nullable": false, "type": { - "kind": "HttpTypeReference", - "ident": "RunStatus", - "$ref": "(resource) beta.threads.runs > (model) run_status > (schema)" + "kind": "HttpTypeUnion", + "types": [ + { + "kind": "HttpTypeLiteral", + "literal": "queued" + }, + { + "kind": "HttpTypeLiteral", + "literal": "in_progress" + }, + { + "kind": "HttpTypeLiteral", + "literal": "requires_action" + }, + { + "kind": "HttpTypeLiteral", + "literal": "cancelling" + }, + { + "kind": "HttpTypeLiteral", + "literal": "cancelled" + }, + { + "kind": "HttpTypeLiteral", + "literal": "failed" + }, + { + "kind": "HttpTypeLiteral", + "literal": "completed" + }, + { + "kind": "HttpTypeLiteral", + "literal": "incomplete" + }, + { + "kind": "HttpTypeLiteral", + "literal": "expired" + } + ], + "oasRef": "#/components/schemas/RunObject/properties/status" }, "oasRef": "#/components/schemas/RunObject/properties/status", "deprecated": false, "schemaType": "enum", - "modelImplicit": false, - "modelPath": "(resource) beta.threads.runs > (model) run_status", "childrenParentSchema": "enum", "children": [ - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 0", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 1", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 2", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 3", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 4", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 5", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 6", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 7", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 8" + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 0", + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 1", + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 2", + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 3", + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 4", + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 5", + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 6", + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 7", + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 8" ] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) thread_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the [thread](https://platform.openai.com/docs/api-reference/threads) that was executed on as a part of this run.", + "docstring": "The ID of the [thread](/docs/api-reference/threads) that was executed on as a part of this run.", "key": "thread_id", "optional": false, "nullable": false, @@ -20174,7 +19881,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) tools": { "kind": "HttpDeclProperty", - "docstring": "The list of tools that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run.", + "docstring": "The list of tools that the [assistant](/docs/api-reference/assistants) used for this run.", "key": "tools", "optional": false, "nullable": false, @@ -20182,9 +19889,25 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "type": { "kind": "HttpTypeArray", "elementType": { + "kind": "HttpTypeUnion", + "types": [ + { "kind": "HttpTypeReference", - "ident": "AssistantTool", - "$ref": "(resource) beta.assistants > (model) assistant_tool > (schema)" + "ident": "CodeInterpreterTool", + "$ref": "(resource) beta.assistants > (model) code_interpreter_tool > (schema)" + }, + { + "kind": "HttpTypeReference", + "ident": "FileSearchTool", + "$ref": "(resource) beta.assistants > (model) file_search_tool > (schema)" + }, + { + "kind": "HttpTypeReference", + "ident": "FunctionTool", + "$ref": "(resource) beta.assistants > (model) function_tool > (schema)" + } + ], + "oasRef": "#/components/schemas/RunObject/properties/tools/items" }, "oasRef": "#/components/schemas/RunObject/properties/tools" }, @@ -20193,9 +19916,9 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "schemaType": "array", "childrenParentSchema": "union", "children": [ - "(resource) beta.assistants > (model) assistant_tool > (schema) > (variant) 0", - "(resource) beta.assistants > (model) assistant_tool > (schema) > (variant) 1", - "(resource) beta.assistants > (model) assistant_tool > (schema) > (variant) 2" + "(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 0", + "(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 1", + "(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 2" ] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy": { @@ -20373,7 +20096,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Represents an execution run on a [thread](https://platform.openai.com/docs/api-reference/threads).", + "docstring": "Represents an execution run on a [thread](/docs/api-reference/threads).", "childrenParentSchema": "object", "children": [ "(resource) beta.threads.runs > (model) run > (schema) > (property) id", @@ -20564,7 +20287,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 0": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/anyOf/0", + "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/oneOf/0", "ident": "UnionMember0", "type": { "kind": "HttpTypeUnion", @@ -20574,7 +20297,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "literal": "auto" } ], - "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/anyOf/0" + "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/oneOf/0" }, "docstring": "`auto` is the default value\n", "childrenParentSchema": "enum", @@ -20634,7 +20357,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "literal": "auto" } ], - "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/anyOf/0" + "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/oneOf/0" }, { "kind": "HttpTypeReference", @@ -20654,7 +20377,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch ], "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption" }, - "docstring": "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`.\n\nSetting 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).\n\nSetting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\n**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.\n", + "docstring": "Specifies the format that the model must output. Compatible with [GPT-4o](/docs/models#gpt-4o), [GPT-4 Turbo](/docs/models#gpt-4-turbo-and-gpt-4), and all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`.\n\nSetting 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](/docs/guides/structured-outputs).\n\nSetting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\n**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.\n", "childrenParentSchema": "union", "children": [ "(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 0", @@ -20663,133 +20386,73 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 3" ] }, - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 0": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "queued" } }, - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 1": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 1": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "in_progress" } }, - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 2": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 2": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "requires_action" } }, - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 3": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 3": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "cancelling" } }, - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 4": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 4": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "cancelled" } }, - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 5": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 5": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "failed" } }, - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 6": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 6": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "completed" } }, - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 7": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 7": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "incomplete" } }, - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 8": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 8": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "expired" } }, - "(resource) beta.threads.runs > (model) run_status > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RunStatus", - "ident": "RunStatus", - "type": { - "kind": "HttpTypeUnion", - "types": [ - { - "kind": "HttpTypeLiteral", - "literal": "queued" - }, - { - "kind": "HttpTypeLiteral", - "literal": "in_progress" - }, - { - "kind": "HttpTypeLiteral", - "literal": "requires_action" - }, - { - "kind": "HttpTypeLiteral", - "literal": "cancelling" - }, - { - "kind": "HttpTypeLiteral", - "literal": "cancelled" - }, - { - "kind": "HttpTypeLiteral", - "literal": "failed" - }, - { - "kind": "HttpTypeLiteral", - "literal": "completed" - }, - { - "kind": "HttpTypeLiteral", - "literal": "incomplete" - }, - { - "kind": "HttpTypeLiteral", - "literal": "expired" - } - ], - "oasRef": "#/components/schemas/RunStatus" - }, - "docstring": "The status of the run, which can be either `queued`, `in_progress`, `requires_action`, `cancelling`, `cancelled`, `failed`, `completed`, `incomplete`, or `expired`.", - "childrenParentSchema": "enum", - "children": [ - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 0", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 1", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 2", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 3", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 4", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 5", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 6", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 7", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 8" - ] - }, "(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption/anyOf/0", - "ident": "Auto", + "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption/oneOf/0", + "ident": "UnionMember0", "type": { "kind": "HttpTypeUnion", "types": [ @@ -20806,7 +20469,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "literal": "required" } ], - "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption/anyOf/0" + "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption/oneOf/0" }, "docstring": "`none` means the model will not call any tools and instead generates a message. `auto` means the model can pick between generating a message or calling one or more tools. `required` means the model must call one or more tools before responding to the user.\n", "childrenParentSchema": "enum", @@ -20852,7 +20515,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "literal": "required" } ], - "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption/anyOf/0" + "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption/oneOf/0" }, { "kind": "HttpTypeReference", @@ -20869,7 +20532,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 1" ] }, - "(resource) beta.assistants > (model) assistant_tool > (schema) > (variant) 0": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", @@ -20881,7 +20544,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type" ] }, - "(resource) beta.assistants > (model) assistant_tool > (schema) > (variant) 1": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 1": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", @@ -20894,7 +20557,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search" ] }, - "(resource) beta.assistants > (model) assistant_tool > (schema) > (variant) 2": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 2": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", @@ -20907,36 +20570,63 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.assistants > (model) function_tool > (schema) > (property) type" ] }, - "(resource) beta.assistants > (model) assistant_tool > (schema)": { + "(resource) beta.assistants > (model) code_interpreter_tool > (schema)": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/AssistantTool", - "ident": "AssistantTool", + "oasRef": "#/components/schemas/AssistantToolsCode", + "ident": "CodeInterpreterTool", "type": { - "kind": "HttpTypeUnion", - "types": [ + "kind": "HttpTypeObject", + "members": [ { - "kind": "HttpTypeReference", - "ident": "CodeInterpreterTool", - "$ref": "(resource) beta.assistants > (model) code_interpreter_tool > (schema)" + "ident": "type" + } + ] }, - { - "kind": "HttpTypeReference", + "childrenParentSchema": "object", + "children": [ + "(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type" + ] + }, + "(resource) beta.assistants > (model) file_search_tool > (schema)": { + "kind": "HttpDeclTypeAlias", + "oasRef": "#/components/schemas/AssistantToolsFileSearch", "ident": "FileSearchTool", - "$ref": "(resource) beta.assistants > (model) file_search_tool > (schema)" + "type": { + "kind": "HttpTypeObject", + "members": [ + { + "ident": "type" }, { - "kind": "HttpTypeReference", + "ident": "file_search" + } + ] + }, + "childrenParentSchema": "object", + "children": [ + "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) type", + "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search" + ] + }, + "(resource) beta.assistants > (model) function_tool > (schema)": { + "kind": "HttpDeclTypeAlias", + "oasRef": "#/components/schemas/AssistantToolsFunction", "ident": "FunctionTool", - "$ref": "(resource) beta.assistants > (model) function_tool > (schema)" + "type": { + "kind": "HttpTypeObject", + "members": [ + { + "ident": "function" + }, + { + "ident": "type" } - ], - "oasRef": "#/components/schemas/AssistantTool" + ] }, - "childrenParentSchema": "union", + "childrenParentSchema": "object", "children": [ - "(resource) beta.assistants > (model) assistant_tool > (schema) > (variant) 0", - "(resource) beta.assistants > (model) assistant_tool > (schema) > (variant) 1", - "(resource) beta.assistants > (model) assistant_tool > (schema) > (variant) 2" + "(resource) beta.assistants > (model) function_tool > (schema) > (property) function", + "(resource) beta.assistants > (model) function_tool > (schema) > (property) type" ] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) type": { @@ -21259,7 +20949,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "JSON Schema response format. Used to generate structured JSON responses.\nLearn more about [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs).\n", + "docstring": "JSON Schema response format. Used to generate structured JSON responses.\nLearn more about [Structured Outputs](/docs/guides/structured-outputs).\n", "childrenParentSchema": "object", "children": [ "(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema", @@ -21387,23 +21077,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type > (member) 0" ] }, - "(resource) beta.assistants > (model) code_interpreter_tool > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/AssistantToolsCode", - "ident": "CodeInterpreterTool", - "type": { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "type" - } - ] - }, - "childrenParentSchema": "object", - "children": [ - "(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type" - ] - }, "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) type": { "kind": "HttpDeclProperty", "docstring": "The type of tool being defined: `file_search`", @@ -21454,27 +21127,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options" ] }, - "(resource) beta.assistants > (model) file_search_tool > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/AssistantToolsFileSearch", - "ident": "FileSearchTool", - "type": { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "type" - }, - { - "ident": "file_search" - } - ] - }, - "childrenParentSchema": "object", - "children": [ - "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) type", - "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search" - ] - }, "(resource) beta.assistants > (model) function_tool > (schema) > (property) function": { "kind": "HttpDeclProperty", "key": "function", @@ -21522,27 +21174,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.assistants > (model) function_tool > (schema) > (property) type > (member) 0" ] }, - "(resource) beta.assistants > (model) function_tool > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/AssistantToolsFunction", - "ident": "FunctionTool", - "type": { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "function" - }, - { - "ident": "type" - } - ] - }, - "childrenParentSchema": "object", - "children": [ - "(resource) beta.assistants > (model) function_tool > (schema) > (property) function", - "(resource) beta.assistants > (model) function_tool > (schema) > (property) type" - ] - }, "(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { @@ -21559,7 +21190,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "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.", + "docstring": "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](/docs/api-reference/runs/submitToolOutputs) endpoint.", "key": "id", "optional": false, "nullable": false, @@ -21716,7 +21347,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema > (property) strict": { "kind": "HttpDeclProperty", - "docstring": "Whether to enable strict schema adherence when generating the output.\nIf set to true, the model will always follow the exact schema defined\nin the `schema` field. Only a subset of JSON Schema is supported when\n`strict` is `true`. To learn more, read the [Structured Outputs\nguide](https://platform.openai.com/docs/guides/structured-outputs).\n", + "docstring": "Whether to enable strict schema adherence when generating the output.\nIf set to true, the model will always follow the exact schema defined\nin the `schema` field. Only a subset of JSON Schema is supported when\n`strict` is `true`. To learn more, read the [Structured Outputs\nguide](/docs/guides/structured-outputs).\n", "key": "strict", "optional": true, "nullable": true, @@ -21804,7 +21435,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) max_num_results": { "kind": "HttpDeclProperty", - "docstring": "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.\n\nNote 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.\n", + "docstring": "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.\n\nNote that the file search tool may output fewer than `max_num_results` results. See the [file search tool documentation](/docs/assistants/tools/file-search#customizing-file-search-settings) for more information.\n", "key": "max_num_results", "optional": true, "nullable": false, @@ -21823,7 +21454,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options": { "kind": "HttpDeclProperty", "title": "File search tool call ranking options", - "docstring": "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.\n\nSee the [file search tool documentation](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) for more information.\n", + "docstring": "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.\n\nSee the [file search tool documentation](/docs/assistants/tools/file-search#customizing-file-search-settings) for more information.\n", "key": "ranking_options", "optional": true, "nullable": false, @@ -21877,7 +21508,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) $shared > (model) function_definition > (schema) > (property) parameters": { "kind": "HttpDeclProperty", - "docstring": "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. \n\nOmitting `parameters` defines a function with an empty parameter list.", + "docstring": "The parameters the functions accepts, described as a JSON Schema object. See the [guide](/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. \n\nOmitting `parameters` defines a function with an empty parameter list.", "key": "parameters", "optional": true, "nullable": false, @@ -21895,7 +21526,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) $shared > (model) function_definition > (schema) > (property) strict": { "kind": "HttpDeclProperty", - "docstring": "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).", + "docstring": "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](/docs/guides/function-calling).", "key": "strict", "optional": true, "nullable": true, @@ -22043,7 +21674,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch ], "oasRef": "#/components/schemas/FunctionParameters" }, - "docstring": "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. \n\nOmitting `parameters` defines a function with an empty parameter list.", + "docstring": "The parameters the functions accepts, described as a JSON Schema object. See the [guide](/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. \n\nOmitting `parameters` defines a function with an empty parameter list.", "children": [] }, "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options > (property) ranker > (member) 0": { @@ -22071,7 +21702,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch ## event -Occurs when a [run](https://platform.openai.com/docs/api-reference/runs/object) expires. +Occurs when a [run](https://developers.openai.com/docs/api-reference/runs/object) expires. ### Schema @@ -22081,8 +21712,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch { "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 10": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RunStreamEvent/anyOf/9", - "ident": "ThreadRunExpired", + "oasRef": "#/components/schemas/RunStreamEvent/oneOf/9", + "ident": "UnionMember10", "type": { "kind": "HttpTypeObject", "members": [ @@ -22094,7 +21725,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Occurs when a [run](https://platform.openai.com/docs/api-reference/runs/object) expires.", + "docstring": "Occurs when a [run](/docs/api-reference/runs/object) expires.", "childrenParentSchema": "object", "children": [ "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 10 > (property) data", @@ -22104,7 +21735,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 10 > (property) data": { "kind": "HttpDeclProperty", "title": "A run on a thread", - "docstring": "Represents an execution run on a [thread](https://platform.openai.com/docs/api-reference/threads).", + "docstring": "Represents an execution run on a [thread](/docs/api-reference/threads).", "key": "data", "optional": false, "nullable": false, @@ -22113,7 +21744,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "ident": "Run", "$ref": "(resource) beta.threads.runs > (model) run > (schema)" }, - "oasRef": "#/components/schemas/RunStreamEvent/anyOf/9/properties/data", + "oasRef": "#/components/schemas/RunStreamEvent/oneOf/9/properties/data", "deprecated": false, "schemaType": "object", "modelImplicit": false, @@ -22162,9 +21793,9 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "literal": "thread.run.expired" } ], - "oasRef": "#/components/schemas/RunStreamEvent/anyOf/9/properties/event" + "oasRef": "#/components/schemas/RunStreamEvent/oneOf/9/properties/event" }, - "oasRef": "#/components/schemas/RunStreamEvent/anyOf/9/properties/event", + "oasRef": "#/components/schemas/RunStreamEvent/oneOf/9/properties/event", "deprecated": false, "schemaType": "enum", "childrenParentSchema": "enum", @@ -22188,7 +21819,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) assistant_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for execution of this run.", + "docstring": "The ID of the [assistant](/docs/api-reference/assistants) used for execution of this run.", "key": "assistant_id", "optional": false, "nullable": false, @@ -22309,7 +21940,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) instructions": { "kind": "HttpDeclProperty", - "docstring": "The instructions that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run.", + "docstring": "The instructions that the [assistant](/docs/api-reference/assistants) used for this run.", "key": "instructions", "optional": false, "nullable": false, @@ -22401,7 +22032,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) model": { "kind": "HttpDeclProperty", - "docstring": "The model that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run.", + "docstring": "The model that the [assistant](/docs/api-reference/assistants) used for this run.", "key": "model", "optional": false, "nullable": false, @@ -22439,7 +22070,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) parallel_tool_calls": { "kind": "HttpDeclProperty", - "docstring": "Whether to enable [parallel function calling](https://platform.openai.com/docs/guides/function-calling#configuring-parallel-function-calling) during tool use.", + "docstring": "Whether to enable [parallel function calling](/docs/guides/function-calling#configuring-parallel-function-calling) during tool use.", "key": "parallel_tool_calls", "optional": false, "nullable": false, @@ -22480,7 +22111,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) response_format": { "kind": "HttpDeclProperty", - "docstring": "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`.\n\nSetting 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).\n\nSetting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\n**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.\n", + "docstring": "Specifies the format that the model must output. Compatible with [GPT-4o](/docs/models#gpt-4o), [GPT-4 Turbo](/docs/models#gpt-4-turbo-and-gpt-4), and all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`.\n\nSetting 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](/docs/guides/structured-outputs).\n\nSetting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\n**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.\n", "key": "response_format", "optional": false, "nullable": true, @@ -22526,31 +22157,66 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "optional": false, "nullable": false, "type": { - "kind": "HttpTypeReference", - "ident": "RunStatus", - "$ref": "(resource) beta.threads.runs > (model) run_status > (schema)" + "kind": "HttpTypeUnion", + "types": [ + { + "kind": "HttpTypeLiteral", + "literal": "queued" + }, + { + "kind": "HttpTypeLiteral", + "literal": "in_progress" + }, + { + "kind": "HttpTypeLiteral", + "literal": "requires_action" + }, + { + "kind": "HttpTypeLiteral", + "literal": "cancelling" + }, + { + "kind": "HttpTypeLiteral", + "literal": "cancelled" + }, + { + "kind": "HttpTypeLiteral", + "literal": "failed" + }, + { + "kind": "HttpTypeLiteral", + "literal": "completed" + }, + { + "kind": "HttpTypeLiteral", + "literal": "incomplete" + }, + { + "kind": "HttpTypeLiteral", + "literal": "expired" + } + ], + "oasRef": "#/components/schemas/RunObject/properties/status" }, "oasRef": "#/components/schemas/RunObject/properties/status", "deprecated": false, "schemaType": "enum", - "modelImplicit": false, - "modelPath": "(resource) beta.threads.runs > (model) run_status", "childrenParentSchema": "enum", "children": [ - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 0", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 1", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 2", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 3", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 4", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 5", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 6", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 7", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 8" + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 0", + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 1", + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 2", + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 3", + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 4", + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 5", + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 6", + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 7", + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 8" ] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) thread_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the [thread](https://platform.openai.com/docs/api-reference/threads) that was executed on as a part of this run.", + "docstring": "The ID of the [thread](/docs/api-reference/threads) that was executed on as a part of this run.", "key": "thread_id", "optional": false, "nullable": false, @@ -22586,7 +22252,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) tools": { "kind": "HttpDeclProperty", - "docstring": "The list of tools that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run.", + "docstring": "The list of tools that the [assistant](/docs/api-reference/assistants) used for this run.", "key": "tools", "optional": false, "nullable": false, @@ -22594,9 +22260,25 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "type": { "kind": "HttpTypeArray", "elementType": { + "kind": "HttpTypeUnion", + "types": [ + { + "kind": "HttpTypeReference", + "ident": "CodeInterpreterTool", + "$ref": "(resource) beta.assistants > (model) code_interpreter_tool > (schema)" + }, + { + "kind": "HttpTypeReference", + "ident": "FileSearchTool", + "$ref": "(resource) beta.assistants > (model) file_search_tool > (schema)" + }, + { "kind": "HttpTypeReference", - "ident": "AssistantTool", - "$ref": "(resource) beta.assistants > (model) assistant_tool > (schema)" + "ident": "FunctionTool", + "$ref": "(resource) beta.assistants > (model) function_tool > (schema)" + } + ], + "oasRef": "#/components/schemas/RunObject/properties/tools/items" }, "oasRef": "#/components/schemas/RunObject/properties/tools" }, @@ -22605,9 +22287,9 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "schemaType": "array", "childrenParentSchema": "union", "children": [ - "(resource) beta.assistants > (model) assistant_tool > (schema) > (variant) 0", - "(resource) beta.assistants > (model) assistant_tool > (schema) > (variant) 1", - "(resource) beta.assistants > (model) assistant_tool > (schema) > (variant) 2" + "(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 0", + "(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 1", + "(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 2" ] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy": { @@ -22785,7 +22467,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Represents an execution run on a [thread](https://platform.openai.com/docs/api-reference/threads).", + "docstring": "Represents an execution run on a [thread](/docs/api-reference/threads).", "childrenParentSchema": "object", "children": [ "(resource) beta.threads.runs > (model) run > (schema) > (property) id", @@ -22976,7 +22658,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 0": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/anyOf/0", + "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/oneOf/0", "ident": "UnionMember0", "type": { "kind": "HttpTypeUnion", @@ -22986,7 +22668,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "literal": "auto" } ], - "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/anyOf/0" + "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/oneOf/0" }, "docstring": "`auto` is the default value\n", "childrenParentSchema": "enum", @@ -23046,7 +22728,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "literal": "auto" } ], - "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/anyOf/0" + "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/oneOf/0" }, { "kind": "HttpTypeReference", @@ -23066,7 +22748,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch ], "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption" }, - "docstring": "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`.\n\nSetting 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).\n\nSetting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\n**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.\n", + "docstring": "Specifies the format that the model must output. Compatible with [GPT-4o](/docs/models#gpt-4o), [GPT-4 Turbo](/docs/models#gpt-4-turbo-and-gpt-4), and all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`.\n\nSetting 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](/docs/guides/structured-outputs).\n\nSetting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\n**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.\n", "childrenParentSchema": "union", "children": [ "(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 0", @@ -23075,133 +22757,73 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 3" ] }, - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 0": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "queued" } }, - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 1": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 1": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "in_progress" } }, - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 2": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 2": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "requires_action" } }, - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 3": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 3": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "cancelling" } }, - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 4": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 4": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "cancelled" } }, - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 5": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 5": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "failed" } }, - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 6": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 6": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "completed" } }, - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 7": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 7": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "incomplete" } }, - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 8": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 8": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "expired" } }, - "(resource) beta.threads.runs > (model) run_status > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RunStatus", - "ident": "RunStatus", - "type": { - "kind": "HttpTypeUnion", - "types": [ - { - "kind": "HttpTypeLiteral", - "literal": "queued" - }, - { - "kind": "HttpTypeLiteral", - "literal": "in_progress" - }, - { - "kind": "HttpTypeLiteral", - "literal": "requires_action" - }, - { - "kind": "HttpTypeLiteral", - "literal": "cancelling" - }, - { - "kind": "HttpTypeLiteral", - "literal": "cancelled" - }, - { - "kind": "HttpTypeLiteral", - "literal": "failed" - }, - { - "kind": "HttpTypeLiteral", - "literal": "completed" - }, - { - "kind": "HttpTypeLiteral", - "literal": "incomplete" - }, - { - "kind": "HttpTypeLiteral", - "literal": "expired" - } - ], - "oasRef": "#/components/schemas/RunStatus" - }, - "docstring": "The status of the run, which can be either `queued`, `in_progress`, `requires_action`, `cancelling`, `cancelled`, `failed`, `completed`, `incomplete`, or `expired`.", - "childrenParentSchema": "enum", - "children": [ - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 0", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 1", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 2", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 3", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 4", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 5", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 6", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 7", - "(resource) beta.threads.runs > (model) run_status > (schema) > (member) 8" - ] - }, "(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption/anyOf/0", - "ident": "Auto", + "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption/oneOf/0", + "ident": "UnionMember0", "type": { "kind": "HttpTypeUnion", "types": [ @@ -23218,7 +22840,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "literal": "required" } ], - "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption/anyOf/0" + "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption/oneOf/0" }, "docstring": "`none` means the model will not call any tools and instead generates a message. `auto` means the model can pick between generating a message or calling one or more tools. `required` means the model must call one or more tools before responding to the user.\n", "childrenParentSchema": "enum", @@ -23264,7 +22886,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "literal": "required" } ], - "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption/anyOf/0" + "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption/oneOf/0" }, { "kind": "HttpTypeReference", @@ -23281,7 +22903,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 1" ] }, - "(resource) beta.assistants > (model) assistant_tool > (schema) > (variant) 0": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", @@ -23293,7 +22915,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type" ] }, - "(resource) beta.assistants > (model) assistant_tool > (schema) > (variant) 1": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 1": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", @@ -23306,7 +22928,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search" ] }, - "(resource) beta.assistants > (model) assistant_tool > (schema) > (variant) 2": { + "(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 2": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", @@ -23319,36 +22941,63 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.assistants > (model) function_tool > (schema) > (property) type" ] }, - "(resource) beta.assistants > (model) assistant_tool > (schema)": { + "(resource) beta.assistants > (model) code_interpreter_tool > (schema)": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/AssistantTool", - "ident": "AssistantTool", + "oasRef": "#/components/schemas/AssistantToolsCode", + "ident": "CodeInterpreterTool", "type": { - "kind": "HttpTypeUnion", - "types": [ + "kind": "HttpTypeObject", + "members": [ { - "kind": "HttpTypeReference", - "ident": "CodeInterpreterTool", - "$ref": "(resource) beta.assistants > (model) code_interpreter_tool > (schema)" + "ident": "type" + } + ] }, - { - "kind": "HttpTypeReference", + "childrenParentSchema": "object", + "children": [ + "(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type" + ] + }, + "(resource) beta.assistants > (model) file_search_tool > (schema)": { + "kind": "HttpDeclTypeAlias", + "oasRef": "#/components/schemas/AssistantToolsFileSearch", "ident": "FileSearchTool", - "$ref": "(resource) beta.assistants > (model) file_search_tool > (schema)" + "type": { + "kind": "HttpTypeObject", + "members": [ + { + "ident": "type" }, { - "kind": "HttpTypeReference", + "ident": "file_search" + } + ] + }, + "childrenParentSchema": "object", + "children": [ + "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) type", + "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search" + ] + }, + "(resource) beta.assistants > (model) function_tool > (schema)": { + "kind": "HttpDeclTypeAlias", + "oasRef": "#/components/schemas/AssistantToolsFunction", "ident": "FunctionTool", - "$ref": "(resource) beta.assistants > (model) function_tool > (schema)" + "type": { + "kind": "HttpTypeObject", + "members": [ + { + "ident": "function" + }, + { + "ident": "type" } - ], - "oasRef": "#/components/schemas/AssistantTool" + ] }, - "childrenParentSchema": "union", + "childrenParentSchema": "object", "children": [ - "(resource) beta.assistants > (model) assistant_tool > (schema) > (variant) 0", - "(resource) beta.assistants > (model) assistant_tool > (schema) > (variant) 1", - "(resource) beta.assistants > (model) assistant_tool > (schema) > (variant) 2" + "(resource) beta.assistants > (model) function_tool > (schema) > (property) function", + "(resource) beta.assistants > (model) function_tool > (schema) > (property) type" ] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) type": { @@ -23671,7 +23320,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "JSON Schema response format. Used to generate structured JSON responses.\nLearn more about [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs).\n", + "docstring": "JSON Schema response format. Used to generate structured JSON responses.\nLearn more about [Structured Outputs](/docs/guides/structured-outputs).\n", "childrenParentSchema": "object", "children": [ "(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema", @@ -23799,23 +23448,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type > (member) 0" ] }, - "(resource) beta.assistants > (model) code_interpreter_tool > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/AssistantToolsCode", - "ident": "CodeInterpreterTool", - "type": { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "type" - } - ] - }, - "childrenParentSchema": "object", - "children": [ - "(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type" - ] - }, "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) type": { "kind": "HttpDeclProperty", "docstring": "The type of tool being defined: `file_search`", @@ -23866,27 +23498,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options" ] }, - "(resource) beta.assistants > (model) file_search_tool > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/AssistantToolsFileSearch", - "ident": "FileSearchTool", - "type": { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "type" - }, - { - "ident": "file_search" - } - ] - }, - "childrenParentSchema": "object", - "children": [ - "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) type", - "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search" - ] - }, "(resource) beta.assistants > (model) function_tool > (schema) > (property) function": { "kind": "HttpDeclProperty", "key": "function", @@ -23934,27 +23545,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.assistants > (model) function_tool > (schema) > (property) type > (member) 0" ] }, - "(resource) beta.assistants > (model) function_tool > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/AssistantToolsFunction", - "ident": "FunctionTool", - "type": { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "function" - }, - { - "ident": "type" - } - ] - }, - "childrenParentSchema": "object", - "children": [ - "(resource) beta.assistants > (model) function_tool > (schema) > (property) function", - "(resource) beta.assistants > (model) function_tool > (schema) > (property) type" - ] - }, "(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { @@ -23971,7 +23561,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "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.", + "docstring": "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](/docs/api-reference/runs/submitToolOutputs) endpoint.", "key": "id", "optional": false, "nullable": false, @@ -24128,7 +23718,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema > (property) strict": { "kind": "HttpDeclProperty", - "docstring": "Whether to enable strict schema adherence when generating the output.\nIf set to true, the model will always follow the exact schema defined\nin the `schema` field. Only a subset of JSON Schema is supported when\n`strict` is `true`. To learn more, read the [Structured Outputs\nguide](https://platform.openai.com/docs/guides/structured-outputs).\n", + "docstring": "Whether to enable strict schema adherence when generating the output.\nIf set to true, the model will always follow the exact schema defined\nin the `schema` field. Only a subset of JSON Schema is supported when\n`strict` is `true`. To learn more, read the [Structured Outputs\nguide](/docs/guides/structured-outputs).\n", "key": "strict", "optional": true, "nullable": true, @@ -24216,7 +23806,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) max_num_results": { "kind": "HttpDeclProperty", - "docstring": "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.\n\nNote 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.\n", + "docstring": "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.\n\nNote that the file search tool may output fewer than `max_num_results` results. See the [file search tool documentation](/docs/assistants/tools/file-search#customizing-file-search-settings) for more information.\n", "key": "max_num_results", "optional": true, "nullable": false, @@ -24235,7 +23825,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options": { "kind": "HttpDeclProperty", "title": "File search tool call ranking options", - "docstring": "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.\n\nSee the [file search tool documentation](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) for more information.\n", + "docstring": "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.\n\nSee the [file search tool documentation](/docs/assistants/tools/file-search#customizing-file-search-settings) for more information.\n", "key": "ranking_options", "optional": true, "nullable": false, @@ -24289,7 +23879,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) $shared > (model) function_definition > (schema) > (property) parameters": { "kind": "HttpDeclProperty", - "docstring": "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. \n\nOmitting `parameters` defines a function with an empty parameter list.", + "docstring": "The parameters the functions accepts, described as a JSON Schema object. See the [guide](/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. \n\nOmitting `parameters` defines a function with an empty parameter list.", "key": "parameters", "optional": true, "nullable": false, @@ -24307,7 +23897,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) $shared > (model) function_definition > (schema) > (property) strict": { "kind": "HttpDeclProperty", - "docstring": "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).", + "docstring": "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](/docs/guides/function-calling).", "key": "strict", "optional": true, "nullable": true, @@ -24455,7 +24045,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch ], "oasRef": "#/components/schemas/FunctionParameters" }, - "docstring": "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. \n\nOmitting `parameters` defines a function with an empty parameter list.", + "docstring": "The parameters the functions accepts, described as a JSON Schema object. See the [guide](/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. \n\nOmitting `parameters` defines a function with an empty parameter list.", "children": [] }, "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options > (property) ranker > (member) 0": { @@ -24483,7 +24073,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch ## event -Occurs when a [run step](https://platform.openai.com/docs/api-reference/run-steps/step-object) is created. +Occurs when a [run step](https://developers.openai.com/docs/api-reference/run-steps/step-object) is created. ### Schema @@ -24493,8 +24083,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch { "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 11": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RunStepStreamEvent/anyOf/0", - "ident": "ThreadRunStepCreated", + "oasRef": "#/components/schemas/RunStepStreamEvent/oneOf/0", + "ident": "UnionMember11", "type": { "kind": "HttpTypeObject", "members": [ @@ -24506,7 +24096,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Occurs when a [run step](https://platform.openai.com/docs/api-reference/run-steps/step-object) is created.", + "docstring": "Occurs when a [run step](/docs/api-reference/run-steps/step-object) is created.", "childrenParentSchema": "object", "children": [ "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 11 > (property) data", @@ -24525,7 +24115,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "ident": "RunStep", "$ref": "(resource) beta.threads.runs.steps > (model) run_step > (schema)" }, - "oasRef": "#/components/schemas/RunStepStreamEvent/anyOf/0/properties/data", + "oasRef": "#/components/schemas/RunStepStreamEvent/oneOf/0/properties/data", "deprecated": false, "schemaType": "object", "modelImplicit": false, @@ -24563,9 +24153,9 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "literal": "thread.run.step.created" } ], - "oasRef": "#/components/schemas/RunStepStreamEvent/anyOf/0/properties/event" + "oasRef": "#/components/schemas/RunStepStreamEvent/oneOf/0/properties/event" }, - "oasRef": "#/components/schemas/RunStepStreamEvent/anyOf/0/properties/event", + "oasRef": "#/components/schemas/RunStepStreamEvent/oneOf/0/properties/event", "deprecated": false, "schemaType": "enum", "childrenParentSchema": "enum", @@ -24589,7 +24179,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) assistant_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the [assistant](https://platform.openai.com/docs/api-reference/assistants) associated with the run step.", + "docstring": "The ID of the [assistant](/docs/api-reference/assistants) associated with the run step.", "key": "assistant_id", "optional": false, "nullable": false, @@ -24756,7 +24346,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) run_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the [run](https://platform.openai.com/docs/api-reference/runs) that this run step is a part of.", + "docstring": "The ID of the [run](/docs/api-reference/runs) that this run step is a part of.", "key": "run_id", "optional": false, "nullable": false, @@ -24845,7 +24435,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) thread_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the [thread](https://platform.openai.com/docs/api-reference/threads) that was run.", + "docstring": "The ID of the [thread](/docs/api-reference/threads) that was run.", "key": "thread_id", "optional": false, "nullable": false, @@ -25300,9 +24890,25 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "type": { "kind": "HttpTypeArray", "elementType": { + "kind": "HttpTypeUnion", + "types": [ + { "kind": "HttpTypeReference", - "ident": "ToolCall", - "$ref": "(resource) beta.threads.runs.steps > (model) tool_call > (schema)" + "ident": "CodeInterpreterToolCall", + "$ref": "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema)" + }, + { + "kind": "HttpTypeReference", + "ident": "FileSearchToolCall", + "$ref": "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema)" + }, + { + "kind": "HttpTypeReference", + "ident": "FunctionToolCall", + "$ref": "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema)" + } + ], + "oasRef": "#/components/schemas/RunStepDetailsToolCallsObject/properties/tool_calls/items" }, "oasRef": "#/components/schemas/RunStepDetailsToolCallsObject/properties/tool_calls" }, @@ -25311,9 +24917,9 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "schemaType": "array", "childrenParentSchema": "union", "children": [ - "(resource) beta.threads.runs.steps > (model) tool_call > (schema) > (variant) 0", - "(resource) beta.threads.runs.steps > (model) tool_call > (schema) > (variant) 1", - "(resource) beta.threads.runs.steps > (model) tool_call > (schema) > (variant) 2" + "(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) tool_calls > (items) > (variant) 0", + "(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) tool_calls > (items) > (variant) 1", + "(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) tool_calls > (items) > (variant) 2" ] }, "(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) type": { @@ -25361,7 +24967,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "literal": "message_creation" } }, - "(resource) beta.threads.runs.steps > (model) tool_call > (schema) > (variant) 0": { + "(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) tool_calls > (items) > (variant) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", @@ -25375,7 +24981,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) type" ] }, - "(resource) beta.threads.runs.steps > (model) tool_call > (schema) > (variant) 1": { + "(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) tool_calls > (items) > (variant) 1": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", @@ -25389,7 +24995,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) type" ] }, - "(resource) beta.threads.runs.steps > (model) tool_call > (schema) > (variant) 2": { + "(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) tool_calls > (items) > (variant) 2": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", @@ -25403,110 +25009,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) type" ] }, - "(resource) beta.threads.runs.steps > (model) tool_call > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RunStepDetailsToolCall", - "ident": "ToolCall", - "type": { - "kind": "HttpTypeUnion", - "types": [ - { - "kind": "HttpTypeReference", - "ident": "CodeInterpreterToolCall", - "$ref": "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema)" - }, - { - "kind": "HttpTypeReference", - "ident": "FileSearchToolCall", - "$ref": "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema)" - }, - { - "kind": "HttpTypeReference", - "ident": "FunctionToolCall", - "$ref": "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema)" - } - ], - "oasRef": "#/components/schemas/RunStepDetailsToolCall" - }, - "docstring": "Details of the Code Interpreter tool call the run step was involved in.", - "childrenParentSchema": "union", - "children": [ - "(resource) beta.threads.runs.steps > (model) tool_call > (schema) > (variant) 0", - "(resource) beta.threads.runs.steps > (model) tool_call > (schema) > (variant) 1", - "(resource) beta.threads.runs.steps > (model) tool_call > (schema) > (variant) 2" - ] - }, - "(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) type > (member) 0": { - "kind": "HttpDeclReference", - "type": { - "kind": "HttpTypeLiteral", - "literal": "tool_calls" - } - }, - "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) id": { - "kind": "HttpDeclProperty", - "docstring": "The ID of the tool call.", - "key": "id", - "optional": false, - "nullable": false, - "type": { - "kind": "HttpTypeString" - }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/id", - "deprecated": false, - "schemaType": "string", - "children": [] - }, - "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter": { - "kind": "HttpDeclProperty", - "docstring": "The Code Interpreter tool call definition.", - "key": "code_interpreter", - "optional": false, - "nullable": false, - "type": { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "input" - }, - { - "ident": "outputs" - } - ] - }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter", - "deprecated": false, - "schemaType": "object", - "childrenParentSchema": "object", - "children": [ - "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) input", - "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs" - ] - }, - "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) type": { - "kind": "HttpDeclProperty", - "docstring": "The type of tool call. This is always going to be `code_interpreter` for this type of tool call.", - "key": "type", - "optional": false, - "nullable": false, - "type": { - "kind": "HttpTypeUnion", - "types": [ - { - "kind": "HttpTypeLiteral", - "literal": "code_interpreter" - } - ], - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/type" - }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/type", - "deprecated": false, - "schemaType": "enum", - "childrenParentSchema": "enum", - "children": [ - "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) type > (member) 0" - ] - }, "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject", @@ -25533,70 +25035,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) type" ] }, - "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) id": { - "kind": "HttpDeclProperty", - "docstring": "The ID of the tool call object.", - "key": "id", - "optional": false, - "nullable": false, - "type": { - "kind": "HttpTypeString" - }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/id", - "deprecated": false, - "schemaType": "string", - "children": [] - }, - "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search": { - "kind": "HttpDeclProperty", - "docstring": "For now, this is always going to be an empty object.", - "key": "file_search", - "optional": false, - "nullable": false, - "type": { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "ranking_options" - }, - { - "ident": "results" - } - ] - }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/file_search", - "deprecated": false, - "schemaType": "object", - "childrenParentSchema": "object", - "children": [ - "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) ranking_options", - "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) results" - ] - }, - "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) type": { - "kind": "HttpDeclProperty", - "docstring": "The type of tool call. This is always going to be `file_search` for this type of tool call.", - "key": "type", - "optional": false, - "nullable": false, - "type": { - "kind": "HttpTypeUnion", - "types": [ - { - "kind": "HttpTypeLiteral", - "literal": "file_search" - } - ], - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/type" - }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/type", - "deprecated": false, - "schemaType": "enum", - "childrenParentSchema": "enum", - "children": [ - "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) type > (member) 0" - ] - }, "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject", @@ -25622,74 +25060,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) type" ] }, - "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) id": { - "kind": "HttpDeclProperty", - "docstring": "The ID of the tool call object.", - "key": "id", - "optional": false, - "nullable": false, - "type": { - "kind": "HttpTypeString" - }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/id", - "deprecated": false, - "schemaType": "string", - "children": [] - }, - "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) function": { - "kind": "HttpDeclProperty", - "docstring": "The definition of the function that was called.", - "key": "function", - "optional": false, - "nullable": false, - "type": { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "arguments" - }, - { - "ident": "name" - }, - { - "ident": "output" - } - ] - }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/function", - "deprecated": false, - "schemaType": "object", - "childrenParentSchema": "object", - "children": [ - "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) function > (property) arguments", - "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) function > (property) name", - "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) function > (property) output" - ] - }, - "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) type": { - "kind": "HttpDeclProperty", - "docstring": "The type of tool call. This is always going to be `function` for this type of tool call.", - "key": "type", - "optional": false, - "nullable": false, - "type": { - "kind": "HttpTypeUnion", - "types": [ - { - "kind": "HttpTypeLiteral", - "literal": "function" - } - ], - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/type" - }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/type", - "deprecated": false, - "schemaType": "enum", - "childrenParentSchema": "enum", - "children": [ - "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) type > (member) 0" - ] - }, "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject", @@ -25715,6 +25085,209 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) type" ] }, + "(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) type > (member) 0": { + "kind": "HttpDeclReference", + "type": { + "kind": "HttpTypeLiteral", + "literal": "tool_calls" + } + }, + "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) id": { + "kind": "HttpDeclProperty", + "docstring": "The ID of the tool call.", + "key": "id", + "optional": false, + "nullable": false, + "type": { + "kind": "HttpTypeString" + }, + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/id", + "deprecated": false, + "schemaType": "string", + "children": [] + }, + "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter": { + "kind": "HttpDeclProperty", + "docstring": "The Code Interpreter tool call definition.", + "key": "code_interpreter", + "optional": false, + "nullable": false, + "type": { + "kind": "HttpTypeObject", + "members": [ + { + "ident": "input" + }, + { + "ident": "outputs" + } + ] + }, + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter", + "deprecated": false, + "schemaType": "object", + "childrenParentSchema": "object", + "children": [ + "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) input", + "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs" + ] + }, + "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) type": { + "kind": "HttpDeclProperty", + "docstring": "The type of tool call. This is always going to be `code_interpreter` for this type of tool call.", + "key": "type", + "optional": false, + "nullable": false, + "type": { + "kind": "HttpTypeUnion", + "types": [ + { + "kind": "HttpTypeLiteral", + "literal": "code_interpreter" + } + ], + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/type" + }, + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/type", + "deprecated": false, + "schemaType": "enum", + "childrenParentSchema": "enum", + "children": [ + "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) type > (member) 0" + ] + }, + "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) id": { + "kind": "HttpDeclProperty", + "docstring": "The ID of the tool call object.", + "key": "id", + "optional": false, + "nullable": false, + "type": { + "kind": "HttpTypeString" + }, + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/id", + "deprecated": false, + "schemaType": "string", + "children": [] + }, + "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search": { + "kind": "HttpDeclProperty", + "docstring": "For now, this is always going to be an empty object.", + "key": "file_search", + "optional": false, + "nullable": false, + "type": { + "kind": "HttpTypeObject", + "members": [ + { + "ident": "ranking_options" + }, + { + "ident": "results" + } + ] + }, + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/file_search", + "deprecated": false, + "schemaType": "object", + "childrenParentSchema": "object", + "children": [ + "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) ranking_options", + "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) results" + ] + }, + "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) type": { + "kind": "HttpDeclProperty", + "docstring": "The type of tool call. This is always going to be `file_search` for this type of tool call.", + "key": "type", + "optional": false, + "nullable": false, + "type": { + "kind": "HttpTypeUnion", + "types": [ + { + "kind": "HttpTypeLiteral", + "literal": "file_search" + } + ], + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/type" + }, + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/type", + "deprecated": false, + "schemaType": "enum", + "childrenParentSchema": "enum", + "children": [ + "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) type > (member) 0" + ] + }, + "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) id": { + "kind": "HttpDeclProperty", + "docstring": "The ID of the tool call object.", + "key": "id", + "optional": false, + "nullable": false, + "type": { + "kind": "HttpTypeString" + }, + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/id", + "deprecated": false, + "schemaType": "string", + "children": [] + }, + "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) function": { + "kind": "HttpDeclProperty", + "docstring": "The definition of the function that was called.", + "key": "function", + "optional": false, + "nullable": false, + "type": { + "kind": "HttpTypeObject", + "members": [ + { + "ident": "arguments" + }, + { + "ident": "name" + }, + { + "ident": "output" + } + ] + }, + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/function", + "deprecated": false, + "schemaType": "object", + "childrenParentSchema": "object", + "children": [ + "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) function > (property) arguments", + "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) function > (property) name", + "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) function > (property) output" + ] + }, + "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) type": { + "kind": "HttpDeclProperty", + "docstring": "The type of tool call. This is always going to be `function` for this type of tool call.", + "key": "type", + "optional": false, + "nullable": false, + "type": { + "kind": "HttpTypeUnion", + "types": [ + { + "kind": "HttpTypeLiteral", + "literal": "function" + } + ], + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/type" + }, + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/type", + "deprecated": false, + "schemaType": "enum", + "childrenParentSchema": "enum", + "children": [ + "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) type > (member) 0" + ] + }, "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) input": { "kind": "HttpDeclProperty", "docstring": "The input to the Code Interpreter tool call.", @@ -25885,7 +25458,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) function > (property) output": { "kind": "HttpDeclProperty", - "docstring": "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.", + "docstring": "The output of the function. This will be `null` if the outputs have not been [submitted](/docs/api-reference/runs/submitToolOutputs) yet.", "key": "output", "optional": false, "nullable": true, @@ -25906,8 +25479,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 0": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter/properties/outputs/items/anyOf/0", - "ident": "Logs", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter/properties/outputs/items/oneOf/0", + "ident": "CodeInterpreterLogOutput", "type": { "kind": "HttpTypeObject", "members": [ @@ -25928,8 +25501,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 1": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter/properties/outputs/items/anyOf/1", - "ident": "Image", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter/properties/outputs/items/oneOf/1", + "ident": "CodeInterpreterImageOutput", "type": { "kind": "HttpTypeObject", "members": [ @@ -26214,7 +25787,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 1 > (property) image > (property) file_id": { "kind": "HttpDeclProperty", - "docstring": "The [file](https://platform.openai.com/docs/api-reference/files) ID of the image.", + "docstring": "The [file](/docs/api-reference/files) ID of the image.", "key": "file_id", "optional": false, "nullable": false, @@ -26251,7 +25824,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch ## event -Occurs when a [run step](https://platform.openai.com/docs/api-reference/run-steps/step-object) moves to an `in_progress` state. +Occurs when a [run step](https://developers.openai.com/docs/api-reference/run-steps/step-object) moves to an `in_progress` state. ### Schema @@ -26261,8 +25834,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch { "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 12": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RunStepStreamEvent/anyOf/1", - "ident": "ThreadRunStepInProgress", + "oasRef": "#/components/schemas/RunStepStreamEvent/oneOf/1", + "ident": "UnionMember12", "type": { "kind": "HttpTypeObject", "members": [ @@ -26274,7 +25847,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Occurs when a [run step](https://platform.openai.com/docs/api-reference/run-steps/step-object) moves to an `in_progress` state.", + "docstring": "Occurs when a [run step](/docs/api-reference/run-steps/step-object) moves to an `in_progress` state.", "childrenParentSchema": "object", "children": [ "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 12 > (property) data", @@ -26293,7 +25866,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "ident": "RunStep", "$ref": "(resource) beta.threads.runs.steps > (model) run_step > (schema)" }, - "oasRef": "#/components/schemas/RunStepStreamEvent/anyOf/1/properties/data", + "oasRef": "#/components/schemas/RunStepStreamEvent/oneOf/1/properties/data", "deprecated": false, "schemaType": "object", "modelImplicit": false, @@ -26331,9 +25904,9 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "literal": "thread.run.step.in_progress" } ], - "oasRef": "#/components/schemas/RunStepStreamEvent/anyOf/1/properties/event" + "oasRef": "#/components/schemas/RunStepStreamEvent/oneOf/1/properties/event" }, - "oasRef": "#/components/schemas/RunStepStreamEvent/anyOf/1/properties/event", + "oasRef": "#/components/schemas/RunStepStreamEvent/oneOf/1/properties/event", "deprecated": false, "schemaType": "enum", "childrenParentSchema": "enum", @@ -26357,7 +25930,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) assistant_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the [assistant](https://platform.openai.com/docs/api-reference/assistants) associated with the run step.", + "docstring": "The ID of the [assistant](/docs/api-reference/assistants) associated with the run step.", "key": "assistant_id", "optional": false, "nullable": false, @@ -26524,7 +26097,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) run_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the [run](https://platform.openai.com/docs/api-reference/runs) that this run step is a part of.", + "docstring": "The ID of the [run](/docs/api-reference/runs) that this run step is a part of.", "key": "run_id", "optional": false, "nullable": false, @@ -26613,7 +26186,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) thread_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the [thread](https://platform.openai.com/docs/api-reference/threads) that was run.", + "docstring": "The ID of the [thread](/docs/api-reference/threads) that was run.", "key": "thread_id", "optional": false, "nullable": false, @@ -27068,9 +26641,25 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "type": { "kind": "HttpTypeArray", "elementType": { + "kind": "HttpTypeUnion", + "types": [ + { + "kind": "HttpTypeReference", + "ident": "CodeInterpreterToolCall", + "$ref": "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema)" + }, + { + "kind": "HttpTypeReference", + "ident": "FileSearchToolCall", + "$ref": "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema)" + }, + { "kind": "HttpTypeReference", - "ident": "ToolCall", - "$ref": "(resource) beta.threads.runs.steps > (model) tool_call > (schema)" + "ident": "FunctionToolCall", + "$ref": "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema)" + } + ], + "oasRef": "#/components/schemas/RunStepDetailsToolCallsObject/properties/tool_calls/items" }, "oasRef": "#/components/schemas/RunStepDetailsToolCallsObject/properties/tool_calls" }, @@ -27079,9 +26668,9 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "schemaType": "array", "childrenParentSchema": "union", "children": [ - "(resource) beta.threads.runs.steps > (model) tool_call > (schema) > (variant) 0", - "(resource) beta.threads.runs.steps > (model) tool_call > (schema) > (variant) 1", - "(resource) beta.threads.runs.steps > (model) tool_call > (schema) > (variant) 2" + "(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) tool_calls > (items) > (variant) 0", + "(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) tool_calls > (items) > (variant) 1", + "(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) tool_calls > (items) > (variant) 2" ] }, "(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) type": { @@ -27129,7 +26718,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "literal": "message_creation" } }, - "(resource) beta.threads.runs.steps > (model) tool_call > (schema) > (variant) 0": { + "(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) tool_calls > (items) > (variant) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", @@ -27143,7 +26732,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) type" ] }, - "(resource) beta.threads.runs.steps > (model) tool_call > (schema) > (variant) 1": { + "(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) tool_calls > (items) > (variant) 1": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", @@ -27157,7 +26746,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) type" ] }, - "(resource) beta.threads.runs.steps > (model) tool_call > (schema) > (variant) 2": { + "(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) tool_calls > (items) > (variant) 2": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", @@ -27171,37 +26760,80 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) type" ] }, - "(resource) beta.threads.runs.steps > (model) tool_call > (schema)": { + "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema)": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RunStepDetailsToolCall", - "ident": "ToolCall", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject", + "ident": "CodeInterpreterToolCall", "type": { - "kind": "HttpTypeUnion", - "types": [ + "kind": "HttpTypeObject", + "members": [ { - "kind": "HttpTypeReference", - "ident": "CodeInterpreterToolCall", - "$ref": "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema)" + "ident": "id" }, { - "kind": "HttpTypeReference", + "ident": "code_interpreter" + }, + { + "ident": "type" + } + ] + }, + "docstring": "Details of the Code Interpreter tool call the run step was involved in.", + "childrenParentSchema": "object", + "children": [ + "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) id", + "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter", + "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) type" + ] + }, + "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema)": { + "kind": "HttpDeclTypeAlias", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject", "ident": "FileSearchToolCall", - "$ref": "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema)" + "type": { + "kind": "HttpTypeObject", + "members": [ + { + "ident": "id" }, { - "kind": "HttpTypeReference", + "ident": "file_search" + }, + { + "ident": "type" + } + ] + }, + "childrenParentSchema": "object", + "children": [ + "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) id", + "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search", + "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) type" + ] + }, + "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema)": { + "kind": "HttpDeclTypeAlias", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject", "ident": "FunctionToolCall", - "$ref": "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema)" + "type": { + "kind": "HttpTypeObject", + "members": [ + { + "ident": "id" + }, + { + "ident": "function" + }, + { + "ident": "type" } - ], - "oasRef": "#/components/schemas/RunStepDetailsToolCall" + ] }, - "docstring": "Details of the Code Interpreter tool call the run step was involved in.", - "childrenParentSchema": "union", + "childrenParentSchema": "object", "children": [ - "(resource) beta.threads.runs.steps > (model) tool_call > (schema) > (variant) 0", - "(resource) beta.threads.runs.steps > (model) tool_call > (schema) > (variant) 1", - "(resource) beta.threads.runs.steps > (model) tool_call > (schema) > (variant) 2" + "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) id", + "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) function", + "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) type" ] }, "(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) type > (member) 0": { @@ -27275,32 +26907,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) type > (member) 0" ] }, - "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject", - "ident": "CodeInterpreterToolCall", - "type": { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "id" - }, - { - "ident": "code_interpreter" - }, - { - "ident": "type" - } - ] - }, - "docstring": "Details of the Code Interpreter tool call the run step was involved in.", - "childrenParentSchema": "object", - "children": [ - "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) id", - "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter", - "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) type" - ] - }, "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) id": { "kind": "HttpDeclProperty", "docstring": "The ID of the tool call object.", @@ -27365,31 +26971,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) type > (member) 0" ] }, - "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject", - "ident": "FileSearchToolCall", - "type": { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "id" - }, - { - "ident": "file_search" - }, - { - "ident": "type" - } - ] - }, - "childrenParentSchema": "object", - "children": [ - "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) id", - "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search", - "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) type" - ] - }, "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) id": { "kind": "HttpDeclProperty", "docstring": "The ID of the tool call object.", @@ -27458,31 +27039,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) type > (member) 0" ] }, - "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject", - "ident": "FunctionToolCall", - "type": { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "id" - }, - { - "ident": "function" - }, - { - "ident": "type" - } - ] - }, - "childrenParentSchema": "object", - "children": [ - "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) id", - "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) function", - "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) type" - ] - }, "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) input": { "kind": "HttpDeclProperty", "docstring": "The input to the Code Interpreter tool call.", @@ -27653,7 +27209,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) function > (property) output": { "kind": "HttpDeclProperty", - "docstring": "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.", + "docstring": "The output of the function. This will be `null` if the outputs have not been [submitted](/docs/api-reference/runs/submitToolOutputs) yet.", "key": "output", "optional": false, "nullable": true, @@ -27674,8 +27230,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 0": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter/properties/outputs/items/anyOf/0", - "ident": "Logs", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter/properties/outputs/items/oneOf/0", + "ident": "CodeInterpreterLogOutput", "type": { "kind": "HttpTypeObject", "members": [ @@ -27696,8 +27252,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 1": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter/properties/outputs/items/anyOf/1", - "ident": "Image", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter/properties/outputs/items/oneOf/1", + "ident": "CodeInterpreterImageOutput", "type": { "kind": "HttpTypeObject", "members": [ @@ -27982,7 +27538,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 1 > (property) image > (property) file_id": { "kind": "HttpDeclProperty", - "docstring": "The [file](https://platform.openai.com/docs/api-reference/files) ID of the image.", + "docstring": "The [file](/docs/api-reference/files) ID of the image.", "key": "file_id", "optional": false, "nullable": false, @@ -28019,7 +27575,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch ## event -Occurs when parts of a [run step](https://platform.openai.com/docs/api-reference/run-steps/step-object) are being streamed. +Occurs when parts of a [run step](https://developers.openai.com/docs/api-reference/run-steps/step-object) are being streamed. ### Schema @@ -28029,8 +27585,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch { "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 13": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RunStepStreamEvent/anyOf/2", - "ident": "ThreadRunStepDelta", + "oasRef": "#/components/schemas/RunStepStreamEvent/oneOf/2", + "ident": "UnionMember13", "type": { "kind": "HttpTypeObject", "members": [ @@ -28042,7 +27598,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Occurs when parts of a [run step](https://platform.openai.com/docs/api-reference/run-steps/step-object) are being streamed.", + "docstring": "Occurs when parts of a [run step](/docs/api-reference/run-steps/step-object) are being streamed.", "childrenParentSchema": "object", "children": [ "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 13 > (property) data", @@ -28061,7 +27617,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "ident": "RunStepDeltaEvent", "$ref": "(resource) beta.threads.runs.steps > (model) run_step_delta_event > (schema)" }, - "oasRef": "#/components/schemas/RunStepStreamEvent/anyOf/2/properties/data", + "oasRef": "#/components/schemas/RunStepStreamEvent/oneOf/2/properties/data", "deprecated": false, "schemaType": "object", "modelImplicit": false, @@ -28086,9 +27642,9 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "literal": "thread.run.step.delta" } ], - "oasRef": "#/components/schemas/RunStepStreamEvent/anyOf/2/properties/event" + "oasRef": "#/components/schemas/RunStepStreamEvent/oneOf/2/properties/event" }, - "oasRef": "#/components/schemas/RunStepStreamEvent/anyOf/2/properties/event", + "oasRef": "#/components/schemas/RunStepStreamEvent/oneOf/2/properties/event", "deprecated": false, "schemaType": "enum", "childrenParentSchema": "enum", @@ -28117,18 +27673,19 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "optional": false, "nullable": false, "type": { - "kind": "HttpTypeReference", - "ident": "RunStepDelta", - "$ref": "(resource) beta.threads.runs.steps > (model) run_step_delta > (schema)" + "kind": "HttpTypeObject", + "members": [ + { + "ident": "step_details" + } + ] }, "oasRef": "#/components/schemas/RunStepDeltaObject/properties/delta", "deprecated": false, "schemaType": "object", - "modelImplicit": false, - "modelPath": "(resource) beta.threads.runs.steps > (model) run_step_delta", "childrenParentSchema": "object", "children": [ - "(resource) beta.threads.runs.steps > (model) run_step_delta > (schema) > (property) step_details" + "(resource) beta.threads.runs.steps > (model) run_step_delta_event > (schema) > (property) delta > (property) step_details" ] }, "(resource) beta.threads.runs.steps > (model) run_step_delta_event > (schema) > (property) object": { @@ -28188,7 +27745,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "literal": "thread.run.step.delta" } }, - "(resource) beta.threads.runs.steps > (model) run_step_delta > (schema) > (property) step_details": { + "(resource) beta.threads.runs.steps > (model) run_step_delta_event > (schema) > (property) delta > (property) step_details": { "kind": "HttpDeclProperty", "docstring": "The details of the run step.", "key": "step_details", @@ -28208,33 +27765,15 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "$ref": "(resource) beta.threads.runs.steps > (model) tool_call_delta_object > (schema)" } ], - "oasRef": "#/components/schemas/RunStepDeltaObjectDelta/properties/step_details" + "oasRef": "#/components/schemas/RunStepDeltaObject/properties/delta/properties/step_details" }, - "oasRef": "#/components/schemas/RunStepDeltaObjectDelta/properties/step_details", + "oasRef": "#/components/schemas/RunStepDeltaObject/properties/delta/properties/step_details", "deprecated": false, "schemaType": "union", "childrenParentSchema": "union", "children": [ - "(resource) beta.threads.runs.steps > (model) run_step_delta > (schema) > (property) step_details > (variant) 0", - "(resource) beta.threads.runs.steps > (model) run_step_delta > (schema) > (property) step_details > (variant) 1" - ] - }, - "(resource) beta.threads.runs.steps > (model) run_step_delta > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RunStepDeltaObjectDelta", - "ident": "RunStepDelta", - "type": { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "step_details" - } - ] - }, - "docstring": "The delta containing the fields that have changed on the run step.", - "childrenParentSchema": "object", - "children": [ - "(resource) beta.threads.runs.steps > (model) run_step_delta > (schema) > (property) step_details" + "(resource) beta.threads.runs.steps > (model) run_step_delta_event > (schema) > (property) delta > (property) step_details > (variant) 0", + "(resource) beta.threads.runs.steps > (model) run_step_delta_event > (schema) > (property) delta > (property) step_details > (variant) 1" ] }, "(resource) beta.threads.runs.steps > (model) run_step_delta_event > (schema) > (property) object > (member) 0": { @@ -28244,7 +27783,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "literal": "thread.run.step.delta" } }, - "(resource) beta.threads.runs.steps > (model) run_step_delta > (schema) > (property) step_details > (variant) 0": { + "(resource) beta.threads.runs.steps > (model) run_step_delta_event > (schema) > (property) delta > (property) step_details > (variant) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", @@ -28257,7 +27796,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.runs.steps > (model) run_step_delta_message_delta > (schema) > (property) message_creation" ] }, - "(resource) beta.threads.runs.steps > (model) run_step_delta > (schema) > (property) step_details > (variant) 1": { + "(resource) beta.threads.runs.steps > (model) run_step_delta_event > (schema) > (property) delta > (property) step_details > (variant) 1": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", @@ -28392,9 +27931,25 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "type": { "kind": "HttpTypeArray", "elementType": { + "kind": "HttpTypeUnion", + "types": [ + { + "kind": "HttpTypeReference", + "ident": "CodeInterpreterToolCallDelta", + "$ref": "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call_delta > (schema)" + }, + { "kind": "HttpTypeReference", - "ident": "ToolCallDelta", - "$ref": "(resource) beta.threads.runs.steps > (model) tool_call_delta > (schema)" + "ident": "FileSearchToolCallDelta", + "$ref": "(resource) beta.threads.runs.steps > (model) file_search_tool_call_delta > (schema)" + }, + { + "kind": "HttpTypeReference", + "ident": "FunctionToolCallDelta", + "$ref": "(resource) beta.threads.runs.steps > (model) function_tool_call_delta > (schema)" + } + ], + "oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsObject/properties/tool_calls/items" }, "oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsObject/properties/tool_calls" }, @@ -28403,9 +27958,9 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "schemaType": "array", "childrenParentSchema": "union", "children": [ - "(resource) beta.threads.runs.steps > (model) tool_call_delta > (schema) > (variant) 0", - "(resource) beta.threads.runs.steps > (model) tool_call_delta > (schema) > (variant) 1", - "(resource) beta.threads.runs.steps > (model) tool_call_delta > (schema) > (variant) 2" + "(resource) beta.threads.runs.steps > (model) tool_call_delta_object > (schema) > (property) tool_calls > (items) > (variant) 0", + "(resource) beta.threads.runs.steps > (model) tool_call_delta_object > (schema) > (property) tool_calls > (items) > (variant) 1", + "(resource) beta.threads.runs.steps > (model) tool_call_delta_object > (schema) > (property) tool_calls > (items) > (variant) 2" ] }, "(resource) beta.threads.runs.steps > (model) run_step_delta_message_delta > (schema) > (property) type > (member) 0": { @@ -28436,7 +27991,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "literal": "tool_calls" } }, - "(resource) beta.threads.runs.steps > (model) tool_call_delta > (schema) > (variant) 0": { + "(resource) beta.threads.runs.steps > (model) tool_call_delta_object > (schema) > (property) tool_calls > (items) > (variant) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", @@ -28451,7 +28006,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call_delta > (schema) > (property) code_interpreter" ] }, - "(resource) beta.threads.runs.steps > (model) tool_call_delta > (schema) > (variant) 1": { + "(resource) beta.threads.runs.steps > (model) tool_call_delta_object > (schema) > (property) tool_calls > (items) > (variant) 1": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", @@ -28466,7 +28021,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.runs.steps > (model) file_search_tool_call_delta > (schema) > (property) id" ] }, - "(resource) beta.threads.runs.steps > (model) tool_call_delta > (schema) > (variant) 2": { + "(resource) beta.threads.runs.steps > (model) tool_call_delta_object > (schema) > (property) tool_calls > (items) > (variant) 2": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", @@ -28481,37 +28036,92 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.runs.steps > (model) function_tool_call_delta > (schema) > (property) function" ] }, - "(resource) beta.threads.runs.steps > (model) tool_call_delta > (schema)": { + "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call_delta > (schema)": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCall", - "ident": "ToolCallDelta", + "oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsCodeObject", + "ident": "CodeInterpreterToolCallDelta", "type": { - "kind": "HttpTypeUnion", - "types": [ + "kind": "HttpTypeObject", + "members": [ { - "kind": "HttpTypeReference", - "ident": "CodeInterpreterToolCallDelta", - "$ref": "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call_delta > (schema)" + "ident": "index" }, { - "kind": "HttpTypeReference", + "ident": "type" + }, + { + "ident": "id" + }, + { + "ident": "code_interpreter" + } + ] + }, + "docstring": "Details of the Code Interpreter tool call the run step was involved in.", + "childrenParentSchema": "object", + "children": [ + "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call_delta > (schema) > (property) index", + "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call_delta > (schema) > (property) type", + "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call_delta > (schema) > (property) id", + "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call_delta > (schema) > (property) code_interpreter" + ] + }, + "(resource) beta.threads.runs.steps > (model) file_search_tool_call_delta > (schema)": { + "kind": "HttpDeclTypeAlias", + "oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsFileSearchObject", "ident": "FileSearchToolCallDelta", - "$ref": "(resource) beta.threads.runs.steps > (model) file_search_tool_call_delta > (schema)" + "type": { + "kind": "HttpTypeObject", + "members": [ + { + "ident": "file_search" }, { - "kind": "HttpTypeReference", + "ident": "index" + }, + { + "ident": "type" + }, + { + "ident": "id" + } + ] + }, + "childrenParentSchema": "object", + "children": [ + "(resource) beta.threads.runs.steps > (model) file_search_tool_call_delta > (schema) > (property) file_search", + "(resource) beta.threads.runs.steps > (model) file_search_tool_call_delta > (schema) > (property) index", + "(resource) beta.threads.runs.steps > (model) file_search_tool_call_delta > (schema) > (property) type", + "(resource) beta.threads.runs.steps > (model) file_search_tool_call_delta > (schema) > (property) id" + ] + }, + "(resource) beta.threads.runs.steps > (model) function_tool_call_delta > (schema)": { + "kind": "HttpDeclTypeAlias", + "oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsFunctionObject", "ident": "FunctionToolCallDelta", - "$ref": "(resource) beta.threads.runs.steps > (model) function_tool_call_delta > (schema)" + "type": { + "kind": "HttpTypeObject", + "members": [ + { + "ident": "index" + }, + { + "ident": "type" + }, + { + "ident": "id" + }, + { + "ident": "function" } - ], - "oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCall" + ] }, - "docstring": "Details of the Code Interpreter tool call the run step was involved in.", - "childrenParentSchema": "union", + "childrenParentSchema": "object", "children": [ - "(resource) beta.threads.runs.steps > (model) tool_call_delta > (schema) > (variant) 0", - "(resource) beta.threads.runs.steps > (model) tool_call_delta > (schema) > (variant) 1", - "(resource) beta.threads.runs.steps > (model) tool_call_delta > (schema) > (variant) 2" + "(resource) beta.threads.runs.steps > (model) function_tool_call_delta > (schema) > (property) index", + "(resource) beta.threads.runs.steps > (model) function_tool_call_delta > (schema) > (property) type", + "(resource) beta.threads.runs.steps > (model) function_tool_call_delta > (schema) > (property) id", + "(resource) beta.threads.runs.steps > (model) function_tool_call_delta > (schema) > (property) function" ] }, "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call_delta > (schema) > (property) index": { @@ -28592,36 +28202,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call_delta > (schema) > (property) code_interpreter > (property) outputs" ] }, - "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call_delta > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsCodeObject", - "ident": "CodeInterpreterToolCallDelta", - "type": { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "index" - }, - { - "ident": "type" - }, - { - "ident": "id" - }, - { - "ident": "code_interpreter" - } - ] - }, - "docstring": "Details of the Code Interpreter tool call the run step was involved in.", - "childrenParentSchema": "object", - "children": [ - "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call_delta > (schema) > (property) index", - "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call_delta > (schema) > (property) type", - "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call_delta > (schema) > (property) id", - "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call_delta > (schema) > (property) code_interpreter" - ] - }, "(resource) beta.threads.runs.steps > (model) file_search_tool_call_delta > (schema) > (property) file_search": { "kind": "HttpDeclProperty", "docstring": "For now, this is always going to be an empty object.", @@ -28688,35 +28268,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "schemaType": "string", "children": [] }, - "(resource) beta.threads.runs.steps > (model) file_search_tool_call_delta > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsFileSearchObject", - "ident": "FileSearchToolCallDelta", - "type": { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "file_search" - }, - { - "ident": "index" - }, - { - "ident": "type" - }, - { - "ident": "id" - } - ] - }, - "childrenParentSchema": "object", - "children": [ - "(resource) beta.threads.runs.steps > (model) file_search_tool_call_delta > (schema) > (property) file_search", - "(resource) beta.threads.runs.steps > (model) file_search_tool_call_delta > (schema) > (property) index", - "(resource) beta.threads.runs.steps > (model) file_search_tool_call_delta > (schema) > (property) type", - "(resource) beta.threads.runs.steps > (model) file_search_tool_call_delta > (schema) > (property) id" - ] - }, "(resource) beta.threads.runs.steps > (model) function_tool_call_delta > (schema) > (property) index": { "kind": "HttpDeclProperty", "docstring": "The index of the tool call in the tool calls array.", @@ -28799,35 +28350,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.runs.steps > (model) function_tool_call_delta > (schema) > (property) function > (property) output" ] }, - "(resource) beta.threads.runs.steps > (model) function_tool_call_delta > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsFunctionObject", - "ident": "FunctionToolCallDelta", - "type": { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "index" - }, - { - "ident": "type" - }, - { - "ident": "id" - }, - { - "ident": "function" - } - ] - }, - "childrenParentSchema": "object", - "children": [ - "(resource) beta.threads.runs.steps > (model) function_tool_call_delta > (schema) > (property) index", - "(resource) beta.threads.runs.steps > (model) function_tool_call_delta > (schema) > (property) type", - "(resource) beta.threads.runs.steps > (model) function_tool_call_delta > (schema) > (property) id", - "(resource) beta.threads.runs.steps > (model) function_tool_call_delta > (schema) > (property) function" - ] - }, "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call_delta > (schema) > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { @@ -28928,7 +28450,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) function_tool_call_delta > (schema) > (property) function > (property) output": { "kind": "HttpDeclProperty", - "docstring": "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.", + "docstring": "The output of the function. This will be `null` if the outputs have not been [submitted](/docs/api-reference/runs/submitToolOutputs) yet.", "key": "output", "optional": true, "nullable": true, @@ -29146,7 +28668,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) code_interpreter_output_image > (schema) > (property) image > (property) file_id": { "kind": "HttpDeclProperty", - "docstring": "The [file](https://platform.openai.com/docs/api-reference/files) ID of the image.", + "docstring": "The [file](/docs/api-reference/files) ID of the image.", "key": "file_id", "optional": true, "nullable": false, @@ -29169,7 +28691,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch ## event -Occurs when a [run step](https://platform.openai.com/docs/api-reference/run-steps/step-object) is completed. +Occurs when a [run step](https://developers.openai.com/docs/api-reference/run-steps/step-object) is completed. ### Schema @@ -29179,8 +28701,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch { "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 14": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RunStepStreamEvent/anyOf/3", - "ident": "ThreadRunStepCompleted", + "oasRef": "#/components/schemas/RunStepStreamEvent/oneOf/3", + "ident": "UnionMember14", "type": { "kind": "HttpTypeObject", "members": [ @@ -29192,7 +28714,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Occurs when a [run step](https://platform.openai.com/docs/api-reference/run-steps/step-object) is completed.", + "docstring": "Occurs when a [run step](/docs/api-reference/run-steps/step-object) is completed.", "childrenParentSchema": "object", "children": [ "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 14 > (property) data", @@ -29211,7 +28733,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "ident": "RunStep", "$ref": "(resource) beta.threads.runs.steps > (model) run_step > (schema)" }, - "oasRef": "#/components/schemas/RunStepStreamEvent/anyOf/3/properties/data", + "oasRef": "#/components/schemas/RunStepStreamEvent/oneOf/3/properties/data", "deprecated": false, "schemaType": "object", "modelImplicit": false, @@ -29249,9 +28771,9 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "literal": "thread.run.step.completed" } ], - "oasRef": "#/components/schemas/RunStepStreamEvent/anyOf/3/properties/event" + "oasRef": "#/components/schemas/RunStepStreamEvent/oneOf/3/properties/event" }, - "oasRef": "#/components/schemas/RunStepStreamEvent/anyOf/3/properties/event", + "oasRef": "#/components/schemas/RunStepStreamEvent/oneOf/3/properties/event", "deprecated": false, "schemaType": "enum", "childrenParentSchema": "enum", @@ -29275,7 +28797,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) assistant_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the [assistant](https://platform.openai.com/docs/api-reference/assistants) associated with the run step.", + "docstring": "The ID of the [assistant](/docs/api-reference/assistants) associated with the run step.", "key": "assistant_id", "optional": false, "nullable": false, @@ -29442,7 +28964,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) run_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the [run](https://platform.openai.com/docs/api-reference/runs) that this run step is a part of.", + "docstring": "The ID of the [run](/docs/api-reference/runs) that this run step is a part of.", "key": "run_id", "optional": false, "nullable": false, @@ -29531,7 +29053,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) thread_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the [thread](https://platform.openai.com/docs/api-reference/threads) that was run.", + "docstring": "The ID of the [thread](/docs/api-reference/threads) that was run.", "key": "thread_id", "optional": false, "nullable": false, @@ -29986,9 +29508,25 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "type": { "kind": "HttpTypeArray", "elementType": { + "kind": "HttpTypeUnion", + "types": [ + { "kind": "HttpTypeReference", - "ident": "ToolCall", - "$ref": "(resource) beta.threads.runs.steps > (model) tool_call > (schema)" + "ident": "CodeInterpreterToolCall", + "$ref": "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema)" + }, + { + "kind": "HttpTypeReference", + "ident": "FileSearchToolCall", + "$ref": "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema)" + }, + { + "kind": "HttpTypeReference", + "ident": "FunctionToolCall", + "$ref": "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema)" + } + ], + "oasRef": "#/components/schemas/RunStepDetailsToolCallsObject/properties/tool_calls/items" }, "oasRef": "#/components/schemas/RunStepDetailsToolCallsObject/properties/tool_calls" }, @@ -29997,9 +29535,9 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "schemaType": "array", "childrenParentSchema": "union", "children": [ - "(resource) beta.threads.runs.steps > (model) tool_call > (schema) > (variant) 0", - "(resource) beta.threads.runs.steps > (model) tool_call > (schema) > (variant) 1", - "(resource) beta.threads.runs.steps > (model) tool_call > (schema) > (variant) 2" + "(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) tool_calls > (items) > (variant) 0", + "(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) tool_calls > (items) > (variant) 1", + "(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) tool_calls > (items) > (variant) 2" ] }, "(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) type": { @@ -30047,7 +29585,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "literal": "message_creation" } }, - "(resource) beta.threads.runs.steps > (model) tool_call > (schema) > (variant) 0": { + "(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) tool_calls > (items) > (variant) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", @@ -30061,7 +29599,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) type" ] }, - "(resource) beta.threads.runs.steps > (model) tool_call > (schema) > (variant) 1": { + "(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) tool_calls > (items) > (variant) 1": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", @@ -30075,7 +29613,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) type" ] }, - "(resource) beta.threads.runs.steps > (model) tool_call > (schema) > (variant) 2": { + "(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) tool_calls > (items) > (variant) 2": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", @@ -30089,110 +29627,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) type" ] }, - "(resource) beta.threads.runs.steps > (model) tool_call > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RunStepDetailsToolCall", - "ident": "ToolCall", - "type": { - "kind": "HttpTypeUnion", - "types": [ - { - "kind": "HttpTypeReference", - "ident": "CodeInterpreterToolCall", - "$ref": "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema)" - }, - { - "kind": "HttpTypeReference", - "ident": "FileSearchToolCall", - "$ref": "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema)" - }, - { - "kind": "HttpTypeReference", - "ident": "FunctionToolCall", - "$ref": "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema)" - } - ], - "oasRef": "#/components/schemas/RunStepDetailsToolCall" - }, - "docstring": "Details of the Code Interpreter tool call the run step was involved in.", - "childrenParentSchema": "union", - "children": [ - "(resource) beta.threads.runs.steps > (model) tool_call > (schema) > (variant) 0", - "(resource) beta.threads.runs.steps > (model) tool_call > (schema) > (variant) 1", - "(resource) beta.threads.runs.steps > (model) tool_call > (schema) > (variant) 2" - ] - }, - "(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) type > (member) 0": { - "kind": "HttpDeclReference", - "type": { - "kind": "HttpTypeLiteral", - "literal": "tool_calls" - } - }, - "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) id": { - "kind": "HttpDeclProperty", - "docstring": "The ID of the tool call.", - "key": "id", - "optional": false, - "nullable": false, - "type": { - "kind": "HttpTypeString" - }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/id", - "deprecated": false, - "schemaType": "string", - "children": [] - }, - "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter": { - "kind": "HttpDeclProperty", - "docstring": "The Code Interpreter tool call definition.", - "key": "code_interpreter", - "optional": false, - "nullable": false, - "type": { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "input" - }, - { - "ident": "outputs" - } - ] - }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter", - "deprecated": false, - "schemaType": "object", - "childrenParentSchema": "object", - "children": [ - "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) input", - "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs" - ] - }, - "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) type": { - "kind": "HttpDeclProperty", - "docstring": "The type of tool call. This is always going to be `code_interpreter` for this type of tool call.", - "key": "type", - "optional": false, - "nullable": false, - "type": { - "kind": "HttpTypeUnion", - "types": [ - { - "kind": "HttpTypeLiteral", - "literal": "code_interpreter" - } - ], - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/type" - }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/type", - "deprecated": false, - "schemaType": "enum", - "childrenParentSchema": "enum", - "children": [ - "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) type > (member) 0" - ] - }, "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject", @@ -30219,70 +29653,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) type" ] }, - "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) id": { - "kind": "HttpDeclProperty", - "docstring": "The ID of the tool call object.", - "key": "id", - "optional": false, - "nullable": false, - "type": { - "kind": "HttpTypeString" - }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/id", - "deprecated": false, - "schemaType": "string", - "children": [] - }, - "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search": { - "kind": "HttpDeclProperty", - "docstring": "For now, this is always going to be an empty object.", - "key": "file_search", - "optional": false, - "nullable": false, - "type": { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "ranking_options" - }, - { - "ident": "results" - } - ] - }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/file_search", - "deprecated": false, - "schemaType": "object", - "childrenParentSchema": "object", - "children": [ - "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) ranking_options", - "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) results" - ] - }, - "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) type": { - "kind": "HttpDeclProperty", - "docstring": "The type of tool call. This is always going to be `file_search` for this type of tool call.", - "key": "type", - "optional": false, - "nullable": false, - "type": { - "kind": "HttpTypeUnion", - "types": [ - { - "kind": "HttpTypeLiteral", - "literal": "file_search" - } - ], - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/type" - }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/type", - "deprecated": false, - "schemaType": "enum", - "childrenParentSchema": "enum", - "children": [ - "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) type > (member) 0" - ] - }, "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject", @@ -30308,74 +29678,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) type" ] }, - "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) id": { - "kind": "HttpDeclProperty", - "docstring": "The ID of the tool call object.", - "key": "id", - "optional": false, - "nullable": false, - "type": { - "kind": "HttpTypeString" - }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/id", - "deprecated": false, - "schemaType": "string", - "children": [] - }, - "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) function": { - "kind": "HttpDeclProperty", - "docstring": "The definition of the function that was called.", - "key": "function", - "optional": false, - "nullable": false, - "type": { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "arguments" - }, - { - "ident": "name" - }, - { - "ident": "output" - } - ] - }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/function", - "deprecated": false, - "schemaType": "object", - "childrenParentSchema": "object", - "children": [ - "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) function > (property) arguments", - "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) function > (property) name", - "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) function > (property) output" - ] - }, - "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) type": { - "kind": "HttpDeclProperty", - "docstring": "The type of tool call. This is always going to be `function` for this type of tool call.", - "key": "type", - "optional": false, - "nullable": false, - "type": { - "kind": "HttpTypeUnion", - "types": [ - { - "kind": "HttpTypeLiteral", - "literal": "function" - } - ], - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/type" - }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/type", - "deprecated": false, - "schemaType": "enum", - "childrenParentSchema": "enum", - "children": [ - "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) type > (member) 0" - ] - }, "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject", @@ -30401,6 +29703,209 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) type" ] }, + "(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) type > (member) 0": { + "kind": "HttpDeclReference", + "type": { + "kind": "HttpTypeLiteral", + "literal": "tool_calls" + } + }, + "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) id": { + "kind": "HttpDeclProperty", + "docstring": "The ID of the tool call.", + "key": "id", + "optional": false, + "nullable": false, + "type": { + "kind": "HttpTypeString" + }, + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/id", + "deprecated": false, + "schemaType": "string", + "children": [] + }, + "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter": { + "kind": "HttpDeclProperty", + "docstring": "The Code Interpreter tool call definition.", + "key": "code_interpreter", + "optional": false, + "nullable": false, + "type": { + "kind": "HttpTypeObject", + "members": [ + { + "ident": "input" + }, + { + "ident": "outputs" + } + ] + }, + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter", + "deprecated": false, + "schemaType": "object", + "childrenParentSchema": "object", + "children": [ + "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) input", + "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs" + ] + }, + "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) type": { + "kind": "HttpDeclProperty", + "docstring": "The type of tool call. This is always going to be `code_interpreter` for this type of tool call.", + "key": "type", + "optional": false, + "nullable": false, + "type": { + "kind": "HttpTypeUnion", + "types": [ + { + "kind": "HttpTypeLiteral", + "literal": "code_interpreter" + } + ], + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/type" + }, + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/type", + "deprecated": false, + "schemaType": "enum", + "childrenParentSchema": "enum", + "children": [ + "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) type > (member) 0" + ] + }, + "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) id": { + "kind": "HttpDeclProperty", + "docstring": "The ID of the tool call object.", + "key": "id", + "optional": false, + "nullable": false, + "type": { + "kind": "HttpTypeString" + }, + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/id", + "deprecated": false, + "schemaType": "string", + "children": [] + }, + "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search": { + "kind": "HttpDeclProperty", + "docstring": "For now, this is always going to be an empty object.", + "key": "file_search", + "optional": false, + "nullable": false, + "type": { + "kind": "HttpTypeObject", + "members": [ + { + "ident": "ranking_options" + }, + { + "ident": "results" + } + ] + }, + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/file_search", + "deprecated": false, + "schemaType": "object", + "childrenParentSchema": "object", + "children": [ + "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) ranking_options", + "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) results" + ] + }, + "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) type": { + "kind": "HttpDeclProperty", + "docstring": "The type of tool call. This is always going to be `file_search` for this type of tool call.", + "key": "type", + "optional": false, + "nullable": false, + "type": { + "kind": "HttpTypeUnion", + "types": [ + { + "kind": "HttpTypeLiteral", + "literal": "file_search" + } + ], + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/type" + }, + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/type", + "deprecated": false, + "schemaType": "enum", + "childrenParentSchema": "enum", + "children": [ + "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) type > (member) 0" + ] + }, + "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) id": { + "kind": "HttpDeclProperty", + "docstring": "The ID of the tool call object.", + "key": "id", + "optional": false, + "nullable": false, + "type": { + "kind": "HttpTypeString" + }, + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/id", + "deprecated": false, + "schemaType": "string", + "children": [] + }, + "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) function": { + "kind": "HttpDeclProperty", + "docstring": "The definition of the function that was called.", + "key": "function", + "optional": false, + "nullable": false, + "type": { + "kind": "HttpTypeObject", + "members": [ + { + "ident": "arguments" + }, + { + "ident": "name" + }, + { + "ident": "output" + } + ] + }, + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/function", + "deprecated": false, + "schemaType": "object", + "childrenParentSchema": "object", + "children": [ + "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) function > (property) arguments", + "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) function > (property) name", + "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) function > (property) output" + ] + }, + "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) type": { + "kind": "HttpDeclProperty", + "docstring": "The type of tool call. This is always going to be `function` for this type of tool call.", + "key": "type", + "optional": false, + "nullable": false, + "type": { + "kind": "HttpTypeUnion", + "types": [ + { + "kind": "HttpTypeLiteral", + "literal": "function" + } + ], + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/type" + }, + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/type", + "deprecated": false, + "schemaType": "enum", + "childrenParentSchema": "enum", + "children": [ + "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) type > (member) 0" + ] + }, "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) input": { "kind": "HttpDeclProperty", "docstring": "The input to the Code Interpreter tool call.", @@ -30571,7 +30076,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) function > (property) output": { "kind": "HttpDeclProperty", - "docstring": "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.", + "docstring": "The output of the function. This will be `null` if the outputs have not been [submitted](/docs/api-reference/runs/submitToolOutputs) yet.", "key": "output", "optional": false, "nullable": true, @@ -30592,8 +30097,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 0": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter/properties/outputs/items/anyOf/0", - "ident": "Logs", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter/properties/outputs/items/oneOf/0", + "ident": "CodeInterpreterLogOutput", "type": { "kind": "HttpTypeObject", "members": [ @@ -30614,8 +30119,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 1": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter/properties/outputs/items/anyOf/1", - "ident": "Image", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter/properties/outputs/items/oneOf/1", + "ident": "CodeInterpreterImageOutput", "type": { "kind": "HttpTypeObject", "members": [ @@ -30900,7 +30405,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 1 > (property) image > (property) file_id": { "kind": "HttpDeclProperty", - "docstring": "The [file](https://platform.openai.com/docs/api-reference/files) ID of the image.", + "docstring": "The [file](/docs/api-reference/files) ID of the image.", "key": "file_id", "optional": false, "nullable": false, @@ -30937,7 +30442,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch ## event -Occurs when a [run step](https://platform.openai.com/docs/api-reference/run-steps/step-object) fails. +Occurs when a [run step](https://developers.openai.com/docs/api-reference/run-steps/step-object) fails. ### Schema @@ -30947,8 +30452,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch { "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 15": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RunStepStreamEvent/anyOf/4", - "ident": "ThreadRunStepFailed", + "oasRef": "#/components/schemas/RunStepStreamEvent/oneOf/4", + "ident": "UnionMember15", "type": { "kind": "HttpTypeObject", "members": [ @@ -30960,7 +30465,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Occurs when a [run step](https://platform.openai.com/docs/api-reference/run-steps/step-object) fails.", + "docstring": "Occurs when a [run step](/docs/api-reference/run-steps/step-object) fails.", "childrenParentSchema": "object", "children": [ "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 15 > (property) data", @@ -30979,7 +30484,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "ident": "RunStep", "$ref": "(resource) beta.threads.runs.steps > (model) run_step > (schema)" }, - "oasRef": "#/components/schemas/RunStepStreamEvent/anyOf/4/properties/data", + "oasRef": "#/components/schemas/RunStepStreamEvent/oneOf/4/properties/data", "deprecated": false, "schemaType": "object", "modelImplicit": false, @@ -31017,9 +30522,9 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "literal": "thread.run.step.failed" } ], - "oasRef": "#/components/schemas/RunStepStreamEvent/anyOf/4/properties/event" + "oasRef": "#/components/schemas/RunStepStreamEvent/oneOf/4/properties/event" }, - "oasRef": "#/components/schemas/RunStepStreamEvent/anyOf/4/properties/event", + "oasRef": "#/components/schemas/RunStepStreamEvent/oneOf/4/properties/event", "deprecated": false, "schemaType": "enum", "childrenParentSchema": "enum", @@ -31043,7 +30548,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) assistant_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the [assistant](https://platform.openai.com/docs/api-reference/assistants) associated with the run step.", + "docstring": "The ID of the [assistant](/docs/api-reference/assistants) associated with the run step.", "key": "assistant_id", "optional": false, "nullable": false, @@ -31210,7 +30715,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) run_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the [run](https://platform.openai.com/docs/api-reference/runs) that this run step is a part of.", + "docstring": "The ID of the [run](/docs/api-reference/runs) that this run step is a part of.", "key": "run_id", "optional": false, "nullable": false, @@ -31299,7 +30804,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) thread_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the [thread](https://platform.openai.com/docs/api-reference/threads) that was run.", + "docstring": "The ID of the [thread](/docs/api-reference/threads) that was run.", "key": "thread_id", "optional": false, "nullable": false, @@ -31754,9 +31259,25 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "type": { "kind": "HttpTypeArray", "elementType": { + "kind": "HttpTypeUnion", + "types": [ + { + "kind": "HttpTypeReference", + "ident": "CodeInterpreterToolCall", + "$ref": "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema)" + }, + { + "kind": "HttpTypeReference", + "ident": "FileSearchToolCall", + "$ref": "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema)" + }, + { "kind": "HttpTypeReference", - "ident": "ToolCall", - "$ref": "(resource) beta.threads.runs.steps > (model) tool_call > (schema)" + "ident": "FunctionToolCall", + "$ref": "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema)" + } + ], + "oasRef": "#/components/schemas/RunStepDetailsToolCallsObject/properties/tool_calls/items" }, "oasRef": "#/components/schemas/RunStepDetailsToolCallsObject/properties/tool_calls" }, @@ -31765,9 +31286,9 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "schemaType": "array", "childrenParentSchema": "union", "children": [ - "(resource) beta.threads.runs.steps > (model) tool_call > (schema) > (variant) 0", - "(resource) beta.threads.runs.steps > (model) tool_call > (schema) > (variant) 1", - "(resource) beta.threads.runs.steps > (model) tool_call > (schema) > (variant) 2" + "(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) tool_calls > (items) > (variant) 0", + "(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) tool_calls > (items) > (variant) 1", + "(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) tool_calls > (items) > (variant) 2" ] }, "(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) type": { @@ -31815,7 +31336,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "literal": "message_creation" } }, - "(resource) beta.threads.runs.steps > (model) tool_call > (schema) > (variant) 0": { + "(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) tool_calls > (items) > (variant) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", @@ -31829,7 +31350,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) type" ] }, - "(resource) beta.threads.runs.steps > (model) tool_call > (schema) > (variant) 1": { + "(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) tool_calls > (items) > (variant) 1": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", @@ -31843,7 +31364,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) type" ] }, - "(resource) beta.threads.runs.steps > (model) tool_call > (schema) > (variant) 2": { + "(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) tool_calls > (items) > (variant) 2": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", @@ -31857,37 +31378,80 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) type" ] }, - "(resource) beta.threads.runs.steps > (model) tool_call > (schema)": { + "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema)": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RunStepDetailsToolCall", - "ident": "ToolCall", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject", + "ident": "CodeInterpreterToolCall", "type": { - "kind": "HttpTypeUnion", - "types": [ + "kind": "HttpTypeObject", + "members": [ { - "kind": "HttpTypeReference", - "ident": "CodeInterpreterToolCall", - "$ref": "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema)" + "ident": "id" }, { - "kind": "HttpTypeReference", + "ident": "code_interpreter" + }, + { + "ident": "type" + } + ] + }, + "docstring": "Details of the Code Interpreter tool call the run step was involved in.", + "childrenParentSchema": "object", + "children": [ + "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) id", + "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter", + "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) type" + ] + }, + "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema)": { + "kind": "HttpDeclTypeAlias", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject", "ident": "FileSearchToolCall", - "$ref": "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema)" + "type": { + "kind": "HttpTypeObject", + "members": [ + { + "ident": "id" }, { - "kind": "HttpTypeReference", + "ident": "file_search" + }, + { + "ident": "type" + } + ] + }, + "childrenParentSchema": "object", + "children": [ + "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) id", + "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search", + "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) type" + ] + }, + "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema)": { + "kind": "HttpDeclTypeAlias", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject", "ident": "FunctionToolCall", - "$ref": "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema)" + "type": { + "kind": "HttpTypeObject", + "members": [ + { + "ident": "id" + }, + { + "ident": "function" + }, + { + "ident": "type" } - ], - "oasRef": "#/components/schemas/RunStepDetailsToolCall" + ] }, - "docstring": "Details of the Code Interpreter tool call the run step was involved in.", - "childrenParentSchema": "union", + "childrenParentSchema": "object", "children": [ - "(resource) beta.threads.runs.steps > (model) tool_call > (schema) > (variant) 0", - "(resource) beta.threads.runs.steps > (model) tool_call > (schema) > (variant) 1", - "(resource) beta.threads.runs.steps > (model) tool_call > (schema) > (variant) 2" + "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) id", + "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) function", + "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) type" ] }, "(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) type > (member) 0": { @@ -31961,32 +31525,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) type > (member) 0" ] }, - "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject", - "ident": "CodeInterpreterToolCall", - "type": { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "id" - }, - { - "ident": "code_interpreter" - }, - { - "ident": "type" - } - ] - }, - "docstring": "Details of the Code Interpreter tool call the run step was involved in.", - "childrenParentSchema": "object", - "children": [ - "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) id", - "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter", - "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) type" - ] - }, "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) id": { "kind": "HttpDeclProperty", "docstring": "The ID of the tool call object.", @@ -32051,31 +31589,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) type > (member) 0" ] }, - "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject", - "ident": "FileSearchToolCall", - "type": { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "id" - }, - { - "ident": "file_search" - }, - { - "ident": "type" - } - ] - }, - "childrenParentSchema": "object", - "children": [ - "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) id", - "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search", - "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) type" - ] - }, "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) id": { "kind": "HttpDeclProperty", "docstring": "The ID of the tool call object.", @@ -32144,31 +31657,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) type > (member) 0" ] }, - "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject", - "ident": "FunctionToolCall", - "type": { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "id" - }, - { - "ident": "function" - }, - { - "ident": "type" - } - ] - }, - "childrenParentSchema": "object", - "children": [ - "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) id", - "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) function", - "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) type" - ] - }, "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) input": { "kind": "HttpDeclProperty", "docstring": "The input to the Code Interpreter tool call.", @@ -32339,7 +31827,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) function > (property) output": { "kind": "HttpDeclProperty", - "docstring": "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.", + "docstring": "The output of the function. This will be `null` if the outputs have not been [submitted](/docs/api-reference/runs/submitToolOutputs) yet.", "key": "output", "optional": false, "nullable": true, @@ -32360,8 +31848,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 0": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter/properties/outputs/items/anyOf/0", - "ident": "Logs", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter/properties/outputs/items/oneOf/0", + "ident": "CodeInterpreterLogOutput", "type": { "kind": "HttpTypeObject", "members": [ @@ -32382,8 +31870,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 1": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter/properties/outputs/items/anyOf/1", - "ident": "Image", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter/properties/outputs/items/oneOf/1", + "ident": "CodeInterpreterImageOutput", "type": { "kind": "HttpTypeObject", "members": [ @@ -32668,7 +32156,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 1 > (property) image > (property) file_id": { "kind": "HttpDeclProperty", - "docstring": "The [file](https://platform.openai.com/docs/api-reference/files) ID of the image.", + "docstring": "The [file](/docs/api-reference/files) ID of the image.", "key": "file_id", "optional": false, "nullable": false, @@ -32705,7 +32193,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch ## event -Occurs when a [run step](https://platform.openai.com/docs/api-reference/run-steps/step-object) is cancelled. +Occurs when a [run step](https://developers.openai.com/docs/api-reference/run-steps/step-object) is cancelled. ### Schema @@ -32715,8 +32203,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch { "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 16": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RunStepStreamEvent/anyOf/5", - "ident": "ThreadRunStepCancelled", + "oasRef": "#/components/schemas/RunStepStreamEvent/oneOf/5", + "ident": "UnionMember16", "type": { "kind": "HttpTypeObject", "members": [ @@ -32728,7 +32216,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Occurs when a [run step](https://platform.openai.com/docs/api-reference/run-steps/step-object) is cancelled.", + "docstring": "Occurs when a [run step](/docs/api-reference/run-steps/step-object) is cancelled.", "childrenParentSchema": "object", "children": [ "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 16 > (property) data", @@ -32747,7 +32235,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "ident": "RunStep", "$ref": "(resource) beta.threads.runs.steps > (model) run_step > (schema)" }, - "oasRef": "#/components/schemas/RunStepStreamEvent/anyOf/5/properties/data", + "oasRef": "#/components/schemas/RunStepStreamEvent/oneOf/5/properties/data", "deprecated": false, "schemaType": "object", "modelImplicit": false, @@ -32785,9 +32273,9 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "literal": "thread.run.step.cancelled" } ], - "oasRef": "#/components/schemas/RunStepStreamEvent/anyOf/5/properties/event" + "oasRef": "#/components/schemas/RunStepStreamEvent/oneOf/5/properties/event" }, - "oasRef": "#/components/schemas/RunStepStreamEvent/anyOf/5/properties/event", + "oasRef": "#/components/schemas/RunStepStreamEvent/oneOf/5/properties/event", "deprecated": false, "schemaType": "enum", "childrenParentSchema": "enum", @@ -32811,7 +32299,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) assistant_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the [assistant](https://platform.openai.com/docs/api-reference/assistants) associated with the run step.", + "docstring": "The ID of the [assistant](/docs/api-reference/assistants) associated with the run step.", "key": "assistant_id", "optional": false, "nullable": false, @@ -32978,7 +32466,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) run_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the [run](https://platform.openai.com/docs/api-reference/runs) that this run step is a part of.", + "docstring": "The ID of the [run](/docs/api-reference/runs) that this run step is a part of.", "key": "run_id", "optional": false, "nullable": false, @@ -33067,7 +32555,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) thread_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the [thread](https://platform.openai.com/docs/api-reference/threads) that was run.", + "docstring": "The ID of the [thread](/docs/api-reference/threads) that was run.", "key": "thread_id", "optional": false, "nullable": false, @@ -33522,9 +33010,25 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "type": { "kind": "HttpTypeArray", "elementType": { + "kind": "HttpTypeUnion", + "types": [ + { "kind": "HttpTypeReference", - "ident": "ToolCall", - "$ref": "(resource) beta.threads.runs.steps > (model) tool_call > (schema)" + "ident": "CodeInterpreterToolCall", + "$ref": "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema)" + }, + { + "kind": "HttpTypeReference", + "ident": "FileSearchToolCall", + "$ref": "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema)" + }, + { + "kind": "HttpTypeReference", + "ident": "FunctionToolCall", + "$ref": "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema)" + } + ], + "oasRef": "#/components/schemas/RunStepDetailsToolCallsObject/properties/tool_calls/items" }, "oasRef": "#/components/schemas/RunStepDetailsToolCallsObject/properties/tool_calls" }, @@ -33533,9 +33037,9 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "schemaType": "array", "childrenParentSchema": "union", "children": [ - "(resource) beta.threads.runs.steps > (model) tool_call > (schema) > (variant) 0", - "(resource) beta.threads.runs.steps > (model) tool_call > (schema) > (variant) 1", - "(resource) beta.threads.runs.steps > (model) tool_call > (schema) > (variant) 2" + "(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) tool_calls > (items) > (variant) 0", + "(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) tool_calls > (items) > (variant) 1", + "(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) tool_calls > (items) > (variant) 2" ] }, "(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) type": { @@ -33583,7 +33087,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "literal": "message_creation" } }, - "(resource) beta.threads.runs.steps > (model) tool_call > (schema) > (variant) 0": { + "(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) tool_calls > (items) > (variant) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", @@ -33597,7 +33101,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) type" ] }, - "(resource) beta.threads.runs.steps > (model) tool_call > (schema) > (variant) 1": { + "(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) tool_calls > (items) > (variant) 1": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", @@ -33611,7 +33115,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) type" ] }, - "(resource) beta.threads.runs.steps > (model) tool_call > (schema) > (variant) 2": { + "(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) tool_calls > (items) > (variant) 2": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", @@ -33625,37 +33129,80 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) type" ] }, - "(resource) beta.threads.runs.steps > (model) tool_call > (schema)": { + "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema)": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RunStepDetailsToolCall", - "ident": "ToolCall", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject", + "ident": "CodeInterpreterToolCall", "type": { - "kind": "HttpTypeUnion", - "types": [ + "kind": "HttpTypeObject", + "members": [ { - "kind": "HttpTypeReference", - "ident": "CodeInterpreterToolCall", - "$ref": "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema)" + "ident": "id" }, { - "kind": "HttpTypeReference", + "ident": "code_interpreter" + }, + { + "ident": "type" + } + ] + }, + "docstring": "Details of the Code Interpreter tool call the run step was involved in.", + "childrenParentSchema": "object", + "children": [ + "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) id", + "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter", + "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) type" + ] + }, + "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema)": { + "kind": "HttpDeclTypeAlias", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject", "ident": "FileSearchToolCall", - "$ref": "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema)" + "type": { + "kind": "HttpTypeObject", + "members": [ + { + "ident": "id" }, { - "kind": "HttpTypeReference", + "ident": "file_search" + }, + { + "ident": "type" + } + ] + }, + "childrenParentSchema": "object", + "children": [ + "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) id", + "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search", + "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) type" + ] + }, + "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema)": { + "kind": "HttpDeclTypeAlias", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject", "ident": "FunctionToolCall", - "$ref": "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema)" + "type": { + "kind": "HttpTypeObject", + "members": [ + { + "ident": "id" + }, + { + "ident": "function" + }, + { + "ident": "type" } - ], - "oasRef": "#/components/schemas/RunStepDetailsToolCall" + ] }, - "docstring": "Details of the Code Interpreter tool call the run step was involved in.", - "childrenParentSchema": "union", + "childrenParentSchema": "object", "children": [ - "(resource) beta.threads.runs.steps > (model) tool_call > (schema) > (variant) 0", - "(resource) beta.threads.runs.steps > (model) tool_call > (schema) > (variant) 1", - "(resource) beta.threads.runs.steps > (model) tool_call > (schema) > (variant) 2" + "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) id", + "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) function", + "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) type" ] }, "(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) type > (member) 0": { @@ -33729,32 +33276,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) type > (member) 0" ] }, - "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject", - "ident": "CodeInterpreterToolCall", - "type": { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "id" - }, - { - "ident": "code_interpreter" - }, - { - "ident": "type" - } - ] - }, - "docstring": "Details of the Code Interpreter tool call the run step was involved in.", - "childrenParentSchema": "object", - "children": [ - "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) id", - "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter", - "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) type" - ] - }, "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) id": { "kind": "HttpDeclProperty", "docstring": "The ID of the tool call object.", @@ -33819,31 +33340,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) type > (member) 0" ] }, - "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject", - "ident": "FileSearchToolCall", - "type": { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "id" - }, - { - "ident": "file_search" - }, - { - "ident": "type" - } - ] - }, - "childrenParentSchema": "object", - "children": [ - "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) id", - "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search", - "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) type" - ] - }, "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) id": { "kind": "HttpDeclProperty", "docstring": "The ID of the tool call object.", @@ -33912,31 +33408,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) type > (member) 0" ] }, - "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject", - "ident": "FunctionToolCall", - "type": { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "id" - }, - { - "ident": "function" - }, - { - "ident": "type" - } - ] - }, - "childrenParentSchema": "object", - "children": [ - "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) id", - "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) function", - "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) type" - ] - }, "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) input": { "kind": "HttpDeclProperty", "docstring": "The input to the Code Interpreter tool call.", @@ -34107,7 +33578,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) function > (property) output": { "kind": "HttpDeclProperty", - "docstring": "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.", + "docstring": "The output of the function. This will be `null` if the outputs have not been [submitted](/docs/api-reference/runs/submitToolOutputs) yet.", "key": "output", "optional": false, "nullable": true, @@ -34128,8 +33599,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 0": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter/properties/outputs/items/anyOf/0", - "ident": "Logs", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter/properties/outputs/items/oneOf/0", + "ident": "CodeInterpreterLogOutput", "type": { "kind": "HttpTypeObject", "members": [ @@ -34150,8 +33621,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 1": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter/properties/outputs/items/anyOf/1", - "ident": "Image", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter/properties/outputs/items/oneOf/1", + "ident": "CodeInterpreterImageOutput", "type": { "kind": "HttpTypeObject", "members": [ @@ -34436,7 +33907,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 1 > (property) image > (property) file_id": { "kind": "HttpDeclProperty", - "docstring": "The [file](https://platform.openai.com/docs/api-reference/files) ID of the image.", + "docstring": "The [file](/docs/api-reference/files) ID of the image.", "key": "file_id", "optional": false, "nullable": false, @@ -34473,7 +33944,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch ## event -Occurs when a [run step](https://platform.openai.com/docs/api-reference/run-steps/step-object) expires. +Occurs when a [run step](https://developers.openai.com/docs/api-reference/run-steps/step-object) expires. ### Schema @@ -34483,8 +33954,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch { "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 17": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RunStepStreamEvent/anyOf/6", - "ident": "ThreadRunStepExpired", + "oasRef": "#/components/schemas/RunStepStreamEvent/oneOf/6", + "ident": "UnionMember17", "type": { "kind": "HttpTypeObject", "members": [ @@ -34496,7 +33967,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Occurs when a [run step](https://platform.openai.com/docs/api-reference/run-steps/step-object) expires.", + "docstring": "Occurs when a [run step](/docs/api-reference/run-steps/step-object) expires.", "childrenParentSchema": "object", "children": [ "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 17 > (property) data", @@ -34515,7 +33986,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "ident": "RunStep", "$ref": "(resource) beta.threads.runs.steps > (model) run_step > (schema)" }, - "oasRef": "#/components/schemas/RunStepStreamEvent/anyOf/6/properties/data", + "oasRef": "#/components/schemas/RunStepStreamEvent/oneOf/6/properties/data", "deprecated": false, "schemaType": "object", "modelImplicit": false, @@ -34553,9 +34024,9 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "literal": "thread.run.step.expired" } ], - "oasRef": "#/components/schemas/RunStepStreamEvent/anyOf/6/properties/event" + "oasRef": "#/components/schemas/RunStepStreamEvent/oneOf/6/properties/event" }, - "oasRef": "#/components/schemas/RunStepStreamEvent/anyOf/6/properties/event", + "oasRef": "#/components/schemas/RunStepStreamEvent/oneOf/6/properties/event", "deprecated": false, "schemaType": "enum", "childrenParentSchema": "enum", @@ -34579,7 +34050,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) assistant_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the [assistant](https://platform.openai.com/docs/api-reference/assistants) associated with the run step.", + "docstring": "The ID of the [assistant](/docs/api-reference/assistants) associated with the run step.", "key": "assistant_id", "optional": false, "nullable": false, @@ -34746,7 +34217,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) run_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the [run](https://platform.openai.com/docs/api-reference/runs) that this run step is a part of.", + "docstring": "The ID of the [run](/docs/api-reference/runs) that this run step is a part of.", "key": "run_id", "optional": false, "nullable": false, @@ -34835,7 +34306,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) thread_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the [thread](https://platform.openai.com/docs/api-reference/threads) that was run.", + "docstring": "The ID of the [thread](/docs/api-reference/threads) that was run.", "key": "thread_id", "optional": false, "nullable": false, @@ -35290,9 +34761,25 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "type": { "kind": "HttpTypeArray", "elementType": { + "kind": "HttpTypeUnion", + "types": [ + { + "kind": "HttpTypeReference", + "ident": "CodeInterpreterToolCall", + "$ref": "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema)" + }, + { + "kind": "HttpTypeReference", + "ident": "FileSearchToolCall", + "$ref": "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema)" + }, + { "kind": "HttpTypeReference", - "ident": "ToolCall", - "$ref": "(resource) beta.threads.runs.steps > (model) tool_call > (schema)" + "ident": "FunctionToolCall", + "$ref": "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema)" + } + ], + "oasRef": "#/components/schemas/RunStepDetailsToolCallsObject/properties/tool_calls/items" }, "oasRef": "#/components/schemas/RunStepDetailsToolCallsObject/properties/tool_calls" }, @@ -35301,9 +34788,9 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "schemaType": "array", "childrenParentSchema": "union", "children": [ - "(resource) beta.threads.runs.steps > (model) tool_call > (schema) > (variant) 0", - "(resource) beta.threads.runs.steps > (model) tool_call > (schema) > (variant) 1", - "(resource) beta.threads.runs.steps > (model) tool_call > (schema) > (variant) 2" + "(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) tool_calls > (items) > (variant) 0", + "(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) tool_calls > (items) > (variant) 1", + "(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) tool_calls > (items) > (variant) 2" ] }, "(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) type": { @@ -35351,7 +34838,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "literal": "message_creation" } }, - "(resource) beta.threads.runs.steps > (model) tool_call > (schema) > (variant) 0": { + "(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) tool_calls > (items) > (variant) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", @@ -35365,7 +34852,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) type" ] }, - "(resource) beta.threads.runs.steps > (model) tool_call > (schema) > (variant) 1": { + "(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) tool_calls > (items) > (variant) 1": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", @@ -35379,7 +34866,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) type" ] }, - "(resource) beta.threads.runs.steps > (model) tool_call > (schema) > (variant) 2": { + "(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) tool_calls > (items) > (variant) 2": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", @@ -35393,37 +34880,80 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) type" ] }, - "(resource) beta.threads.runs.steps > (model) tool_call > (schema)": { + "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema)": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RunStepDetailsToolCall", - "ident": "ToolCall", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject", + "ident": "CodeInterpreterToolCall", "type": { - "kind": "HttpTypeUnion", - "types": [ + "kind": "HttpTypeObject", + "members": [ { - "kind": "HttpTypeReference", - "ident": "CodeInterpreterToolCall", - "$ref": "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema)" + "ident": "id" }, { - "kind": "HttpTypeReference", + "ident": "code_interpreter" + }, + { + "ident": "type" + } + ] + }, + "docstring": "Details of the Code Interpreter tool call the run step was involved in.", + "childrenParentSchema": "object", + "children": [ + "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) id", + "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter", + "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) type" + ] + }, + "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema)": { + "kind": "HttpDeclTypeAlias", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject", "ident": "FileSearchToolCall", - "$ref": "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema)" + "type": { + "kind": "HttpTypeObject", + "members": [ + { + "ident": "id" }, { - "kind": "HttpTypeReference", + "ident": "file_search" + }, + { + "ident": "type" + } + ] + }, + "childrenParentSchema": "object", + "children": [ + "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) id", + "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search", + "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) type" + ] + }, + "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema)": { + "kind": "HttpDeclTypeAlias", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject", "ident": "FunctionToolCall", - "$ref": "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema)" + "type": { + "kind": "HttpTypeObject", + "members": [ + { + "ident": "id" + }, + { + "ident": "function" + }, + { + "ident": "type" } - ], - "oasRef": "#/components/schemas/RunStepDetailsToolCall" + ] }, - "docstring": "Details of the Code Interpreter tool call the run step was involved in.", - "childrenParentSchema": "union", + "childrenParentSchema": "object", "children": [ - "(resource) beta.threads.runs.steps > (model) tool_call > (schema) > (variant) 0", - "(resource) beta.threads.runs.steps > (model) tool_call > (schema) > (variant) 1", - "(resource) beta.threads.runs.steps > (model) tool_call > (schema) > (variant) 2" + "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) id", + "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) function", + "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) type" ] }, "(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) type > (member) 0": { @@ -35497,32 +35027,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) type > (member) 0" ] }, - "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject", - "ident": "CodeInterpreterToolCall", - "type": { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "id" - }, - { - "ident": "code_interpreter" - }, - { - "ident": "type" - } - ] - }, - "docstring": "Details of the Code Interpreter tool call the run step was involved in.", - "childrenParentSchema": "object", - "children": [ - "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) id", - "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter", - "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) type" - ] - }, "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) id": { "kind": "HttpDeclProperty", "docstring": "The ID of the tool call object.", @@ -35587,31 +35091,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) type > (member) 0" ] }, - "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject", - "ident": "FileSearchToolCall", - "type": { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "id" - }, - { - "ident": "file_search" - }, - { - "ident": "type" - } - ] - }, - "childrenParentSchema": "object", - "children": [ - "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) id", - "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search", - "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) type" - ] - }, "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) id": { "kind": "HttpDeclProperty", "docstring": "The ID of the tool call object.", @@ -35680,31 +35159,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) type > (member) 0" ] }, - "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject", - "ident": "FunctionToolCall", - "type": { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "id" - }, - { - "ident": "function" - }, - { - "ident": "type" - } - ] - }, - "childrenParentSchema": "object", - "children": [ - "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) id", - "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) function", - "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) type" - ] - }, "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) input": { "kind": "HttpDeclProperty", "docstring": "The input to the Code Interpreter tool call.", @@ -35875,7 +35329,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) function > (property) output": { "kind": "HttpDeclProperty", - "docstring": "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.", + "docstring": "The output of the function. This will be `null` if the outputs have not been [submitted](/docs/api-reference/runs/submitToolOutputs) yet.", "key": "output", "optional": false, "nullable": true, @@ -35896,8 +35350,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 0": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter/properties/outputs/items/anyOf/0", - "ident": "Logs", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter/properties/outputs/items/oneOf/0", + "ident": "CodeInterpreterLogOutput", "type": { "kind": "HttpTypeObject", "members": [ @@ -35918,8 +35372,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 1": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter/properties/outputs/items/anyOf/1", - "ident": "Image", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter/properties/outputs/items/oneOf/1", + "ident": "CodeInterpreterImageOutput", "type": { "kind": "HttpTypeObject", "members": [ @@ -36204,7 +35658,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 1 > (property) image > (property) file_id": { "kind": "HttpDeclProperty", - "docstring": "The [file](https://platform.openai.com/docs/api-reference/files) ID of the image.", + "docstring": "The [file](/docs/api-reference/files) ID of the image.", "key": "file_id", "optional": false, "nullable": false, @@ -36241,7 +35695,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch ## event -Occurs when a [message](https://platform.openai.com/docs/api-reference/messages/object) is created. +Occurs when a [message](https://developers.openai.com/docs/api-reference/messages/object) is created. ### Schema @@ -36251,8 +35705,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch { "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 18": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/MessageStreamEvent/anyOf/0", - "ident": "ThreadMessageCreated", + "oasRef": "#/components/schemas/MessageStreamEvent/oneOf/0", + "ident": "UnionMember18", "type": { "kind": "HttpTypeObject", "members": [ @@ -36264,7 +35718,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Occurs when a [message](https://platform.openai.com/docs/api-reference/messages/object) is created.", + "docstring": "Occurs when a [message](/docs/api-reference/messages/object) is created.", "childrenParentSchema": "object", "children": [ "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 18 > (property) data", @@ -36274,7 +35728,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 18 > (property) data": { "kind": "HttpDeclProperty", "title": "The message object", - "docstring": "Represents a message within a [thread](https://platform.openai.com/docs/api-reference/threads).", + "docstring": "Represents a message within a [thread](/docs/api-reference/threads).", "key": "data", "optional": false, "nullable": false, @@ -36283,7 +35737,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "ident": "Message", "$ref": "(resource) beta.threads.messages > (model) message > (schema)" }, - "oasRef": "#/components/schemas/MessageStreamEvent/anyOf/0/properties/data", + "oasRef": "#/components/schemas/MessageStreamEvent/oneOf/0/properties/data", "deprecated": false, "schemaType": "object", "modelImplicit": false, @@ -36319,9 +35773,9 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "literal": "thread.message.created" } ], - "oasRef": "#/components/schemas/MessageStreamEvent/anyOf/0/properties/event" + "oasRef": "#/components/schemas/MessageStreamEvent/oneOf/0/properties/event" }, - "oasRef": "#/components/schemas/MessageStreamEvent/anyOf/0/properties/event", + "oasRef": "#/components/schemas/MessageStreamEvent/oneOf/0/properties/event", "deprecated": false, "schemaType": "enum", "childrenParentSchema": "enum", @@ -36345,7 +35799,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) message > (schema) > (property) assistant_id": { "kind": "HttpDeclProperty", - "docstring": "If applicable, the ID of the [assistant](https://platform.openai.com/docs/api-reference/assistants) that authored this message.", + "docstring": "If applicable, the ID of the [assistant](/docs/api-reference/assistants) that authored this message.", "key": "assistant_id", "optional": false, "nullable": true, @@ -36413,9 +35867,30 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "type": { "kind": "HttpTypeArray", "elementType": { + "kind": "HttpTypeUnion", + "types": [ + { "kind": "HttpTypeReference", - "ident": "MessageContent", - "$ref": "(resource) beta.threads.messages > (model) message_content > (schema)" + "ident": "ImageFileContentBlock", + "$ref": "(resource) beta.threads.messages > (model) image_file_content_block > (schema)" + }, + { + "kind": "HttpTypeReference", + "ident": "ImageURLContentBlock", + "$ref": "(resource) beta.threads.messages > (model) image_url_content_block > (schema)" + }, + { + "kind": "HttpTypeReference", + "ident": "TextContentBlock", + "$ref": "(resource) beta.threads.messages > (model) text_content_block > (schema)" + }, + { + "kind": "HttpTypeReference", + "ident": "RefusalContentBlock", + "$ref": "(resource) beta.threads.messages > (model) refusal_content_block > (schema)" + } + ], + "oasRef": "#/components/schemas/MessageObject/properties/content/items" }, "oasRef": "#/components/schemas/MessageObject/properties/content" }, @@ -36424,10 +35899,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "schemaType": "array", "childrenParentSchema": "union", "children": [ - "(resource) beta.threads.messages > (model) message_content > (schema) > (variant) 0", - "(resource) beta.threads.messages > (model) message_content > (schema) > (variant) 1", - "(resource) beta.threads.messages > (model) message_content > (schema) > (variant) 2", - "(resource) beta.threads.messages > (model) message_content > (schema) > (variant) 3" + "(resource) beta.threads.messages > (model) message > (schema) > (property) content > (items) > (variant) 0", + "(resource) beta.threads.messages > (model) message > (schema) > (property) content > (items) > (variant) 1", + "(resource) beta.threads.messages > (model) message > (schema) > (property) content > (items) > (variant) 2", + "(resource) beta.threads.messages > (model) message > (schema) > (property) content > (items) > (variant) 3" ] }, "(resource) beta.threads.messages > (model) message > (schema) > (property) created_at": { @@ -36559,7 +36034,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) message > (schema) > (property) run_id": { "kind": "HttpDeclProperty", - "docstring": "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.", + "docstring": "The ID of the [run](/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.", "key": "run_id", "optional": false, "nullable": true, @@ -36607,7 +36082,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) message > (schema) > (property) thread_id": { "kind": "HttpDeclProperty", - "docstring": "The [thread](https://platform.openai.com/docs/api-reference/threads) ID that this message belongs to.", + "docstring": "The [thread](/docs/api-reference/threads) ID that this message belongs to.", "key": "thread_id", "optional": false, "nullable": false, @@ -36670,7 +36145,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Represents a message within a [thread](https://platform.openai.com/docs/api-reference/threads).", + "docstring": "Represents a message within a [thread](/docs/api-reference/threads).", "childrenParentSchema": "object", "children": [ "(resource) beta.threads.messages > (model) message > (schema) > (property) id", @@ -36748,7 +36223,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.messages > (model) message > (schema) > (property) attachments > (items) > (property) tools > (items) > (variant) 1" ] }, - "(resource) beta.threads.messages > (model) message_content > (schema) > (variant) 0": { + "(resource) beta.threads.messages > (model) message > (schema) > (property) content > (items) > (variant) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", @@ -36761,7 +36236,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.messages > (model) image_file_content_block > (schema) > (property) type" ] }, - "(resource) beta.threads.messages > (model) message_content > (schema) > (variant) 1": { + "(resource) beta.threads.messages > (model) message > (schema) > (property) content > (items) > (variant) 1": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", @@ -36774,7 +36249,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.messages > (model) image_url_content_block > (schema) > (property) type" ] }, - "(resource) beta.threads.messages > (model) message_content > (schema) > (variant) 2": { + "(resource) beta.threads.messages > (model) message > (schema) > (property) content > (items) > (variant) 2": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", @@ -36787,7 +36262,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.messages > (model) text_content_block > (schema) > (property) type" ] }, - "(resource) beta.threads.messages > (model) message_content > (schema) > (variant) 3": { + "(resource) beta.threads.messages > (model) message > (schema) > (property) content > (items) > (variant) 3": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", @@ -36800,43 +36275,92 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.messages > (model) refusal_content_block > (schema) > (property) type" ] }, - "(resource) beta.threads.messages > (model) message_content > (schema)": { + "(resource) beta.threads.messages > (model) image_file_content_block > (schema)": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/MessageContent", - "ident": "MessageContent", + "oasRef": "#/components/schemas/MessageContentImageFileObject", + "ident": "ImageFileContentBlock", "type": { - "kind": "HttpTypeUnion", - "types": [ + "kind": "HttpTypeObject", + "members": [ { - "kind": "HttpTypeReference", - "ident": "ImageFileContentBlock", - "$ref": "(resource) beta.threads.messages > (model) image_file_content_block > (schema)" + "ident": "image_file" }, { - "kind": "HttpTypeReference", + "ident": "type" + } + ] + }, + "docstring": "References an image [File](/docs/api-reference/files) in the content of a message.", + "childrenParentSchema": "object", + "children": [ + "(resource) beta.threads.messages > (model) image_file_content_block > (schema) > (property) image_file", + "(resource) beta.threads.messages > (model) image_file_content_block > (schema) > (property) type" + ] + }, + "(resource) beta.threads.messages > (model) image_url_content_block > (schema)": { + "kind": "HttpDeclTypeAlias", + "oasRef": "#/components/schemas/MessageContentImageUrlObject", "ident": "ImageURLContentBlock", - "$ref": "(resource) beta.threads.messages > (model) image_url_content_block > (schema)" + "type": { + "kind": "HttpTypeObject", + "members": [ + { + "ident": "image_url" }, { - "kind": "HttpTypeReference", + "ident": "type" + } + ] + }, + "docstring": "References an image URL in the content of a message.", + "childrenParentSchema": "object", + "children": [ + "(resource) beta.threads.messages > (model) image_url_content_block > (schema) > (property) image_url", + "(resource) beta.threads.messages > (model) image_url_content_block > (schema) > (property) type" + ] + }, + "(resource) beta.threads.messages > (model) text_content_block > (schema)": { + "kind": "HttpDeclTypeAlias", + "oasRef": "#/components/schemas/MessageContentTextObject", "ident": "TextContentBlock", - "$ref": "(resource) beta.threads.messages > (model) text_content_block > (schema)" + "type": { + "kind": "HttpTypeObject", + "members": [ + { + "ident": "text" }, { - "kind": "HttpTypeReference", + "ident": "type" + } + ] + }, + "docstring": "The text content that is part of a message.", + "childrenParentSchema": "object", + "children": [ + "(resource) beta.threads.messages > (model) text_content_block > (schema) > (property) text", + "(resource) beta.threads.messages > (model) text_content_block > (schema) > (property) type" + ] + }, + "(resource) beta.threads.messages > (model) refusal_content_block > (schema)": { + "kind": "HttpDeclTypeAlias", + "oasRef": "#/components/schemas/MessageContentRefusalObject", "ident": "RefusalContentBlock", - "$ref": "(resource) beta.threads.messages > (model) refusal_content_block > (schema)" + "type": { + "kind": "HttpTypeObject", + "members": [ + { + "ident": "refusal" + }, + { + "ident": "type" } - ], - "oasRef": "#/components/schemas/MessageContent" + ] }, - "docstring": "References an image [File](https://platform.openai.com/docs/api-reference/files) in the content of a message.", - "childrenParentSchema": "union", + "docstring": "The refusal content generated by the assistant.", + "childrenParentSchema": "object", "children": [ - "(resource) beta.threads.messages > (model) message_content > (schema) > (variant) 0", - "(resource) beta.threads.messages > (model) message_content > (schema) > (variant) 1", - "(resource) beta.threads.messages > (model) message_content > (schema) > (variant) 2", - "(resource) beta.threads.messages > (model) message_content > (schema) > (variant) 3" + "(resource) beta.threads.messages > (model) refusal_content_block > (schema) > (property) refusal", + "(resource) beta.threads.messages > (model) refusal_content_block > (schema) > (property) type" ] }, "(resource) beta.threads.messages > (model) message > (schema) > (property) incomplete_details > (property) reason": { @@ -36959,8 +36483,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) message > (schema) > (property) attachments > (items) > (property) tools > (items) > (variant) 1": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/MessageObject/properties/attachments/anyOf/0/items/properties/tools/items/anyOf/1", - "ident": "AssistantToolsFileSearchTypeOnly", + "oasRef": "#/components/schemas/MessageObject/properties/attachments/anyOf/0/items/properties/tools/items/oneOf/1", + "ident": "FileSearchTool", "type": { "kind": "HttpTypeObject", "members": [ @@ -37036,28 +36560,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.messages > (model) image_file_content_block > (schema) > (property) type > (member) 0" ] }, - "(resource) beta.threads.messages > (model) image_file_content_block > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/MessageContentImageFileObject", - "ident": "ImageFileContentBlock", - "type": { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "image_file" - }, - { - "ident": "type" - } - ] - }, - "docstring": "References an image [File](https://platform.openai.com/docs/api-reference/files) in the content of a message.", - "childrenParentSchema": "object", - "children": [ - "(resource) beta.threads.messages > (model) image_file_content_block > (schema) > (property) image_file", - "(resource) beta.threads.messages > (model) image_file_content_block > (schema) > (property) type" - ] - }, "(resource) beta.threads.messages > (model) image_url_content_block > (schema) > (property) image_url": { "kind": "HttpDeclProperty", "key": "image_url", @@ -37103,28 +36605,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.messages > (model) image_url_content_block > (schema) > (property) type > (member) 0" ] }, - "(resource) beta.threads.messages > (model) image_url_content_block > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/MessageContentImageUrlObject", - "ident": "ImageURLContentBlock", - "type": { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "image_url" - }, - { - "ident": "type" - } - ] - }, - "docstring": "References an image URL in the content of a message.", - "childrenParentSchema": "object", - "children": [ - "(resource) beta.threads.messages > (model) image_url_content_block > (schema) > (property) image_url", - "(resource) beta.threads.messages > (model) image_url_content_block > (schema) > (property) type" - ] - }, "(resource) beta.threads.messages > (model) text_content_block > (schema) > (property) text": { "kind": "HttpDeclProperty", "key": "text", @@ -37170,28 +36650,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.messages > (model) text_content_block > (schema) > (property) type > (member) 0" ] }, - "(resource) beta.threads.messages > (model) text_content_block > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/MessageContentTextObject", - "ident": "TextContentBlock", - "type": { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "text" - }, - { - "ident": "type" - } - ] - }, - "docstring": "The text content that is part of a message.", - "childrenParentSchema": "object", - "children": [ - "(resource) beta.threads.messages > (model) text_content_block > (schema) > (property) text", - "(resource) beta.threads.messages > (model) text_content_block > (schema) > (property) type" - ] - }, "(resource) beta.threads.messages > (model) refusal_content_block > (schema) > (property) refusal": { "kind": "HttpDeclProperty", "key": "refusal", @@ -37229,28 +36687,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.messages > (model) refusal_content_block > (schema) > (property) type > (member) 0" ] }, - "(resource) beta.threads.messages > (model) refusal_content_block > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/MessageContentRefusalObject", - "ident": "RefusalContentBlock", - "type": { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "refusal" - }, - { - "ident": "type" - } - ] - }, - "docstring": "The refusal content generated by the assistant.", - "childrenParentSchema": "object", - "children": [ - "(resource) beta.threads.messages > (model) refusal_content_block > (schema) > (property) refusal", - "(resource) beta.threads.messages > (model) refusal_content_block > (schema) > (property) type" - ] - }, "(resource) beta.threads.messages > (model) message > (schema) > (property) incomplete_details > (property) reason > (member) 0": { "kind": "HttpDeclReference", "type": { @@ -37336,7 +36772,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) image_file > (schema) > (property) file_id": { "kind": "HttpDeclProperty", - "docstring": "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.", + "docstring": "The [File](/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.", "key": "file_id", "optional": false, "nullable": false, @@ -37499,9 +36935,20 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "type": { "kind": "HttpTypeArray", "elementType": { + "kind": "HttpTypeUnion", + "types": [ + { "kind": "HttpTypeReference", - "ident": "Annotation", - "$ref": "(resource) beta.threads.messages > (model) annotation > (schema)" + "ident": "FileCitationAnnotation", + "$ref": "(resource) beta.threads.messages > (model) file_citation_annotation > (schema)" + }, + { + "kind": "HttpTypeReference", + "ident": "FilePathAnnotation", + "$ref": "(resource) beta.threads.messages > (model) file_path_annotation > (schema)" + } + ], + "oasRef": "#/components/schemas/MessageContentTextObject/properties/text/properties/annotations/items" }, "oasRef": "#/components/schemas/MessageContentTextObject/properties/text/properties/annotations" }, @@ -37510,8 +36957,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "schemaType": "array", "childrenParentSchema": "union", "children": [ - "(resource) beta.threads.messages > (model) annotation > (schema) > (variant) 0", - "(resource) beta.threads.messages > (model) annotation > (schema) > (variant) 1" + "(resource) beta.threads.messages > (model) text > (schema) > (property) annotations > (items) > (variant) 0", + "(resource) beta.threads.messages > (model) text > (schema) > (property) annotations > (items) > (variant) 1" ] }, "(resource) beta.threads.messages > (model) text > (schema) > (property) value": { @@ -37619,7 +37066,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "literal": "high" } }, - "(resource) beta.threads.messages > (model) annotation > (schema) > (variant) 0": { + "(resource) beta.threads.messages > (model) text > (schema) > (property) annotations > (items) > (variant) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", @@ -37635,7 +37082,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) type" ] }, - "(resource) beta.threads.messages > (model) annotation > (schema) > (variant) 1": { + "(resource) beta.threads.messages > (model) text > (schema) > (property) annotations > (items) > (variant) 1": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", @@ -37651,124 +37098,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) type" ] }, - "(resource) beta.threads.messages > (model) annotation > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/TextAnnotation", - "ident": "Annotation", - "type": { - "kind": "HttpTypeUnion", - "types": [ - { - "kind": "HttpTypeReference", - "ident": "FileCitationAnnotation", - "$ref": "(resource) beta.threads.messages > (model) file_citation_annotation > (schema)" - }, - { - "kind": "HttpTypeReference", - "ident": "FilePathAnnotation", - "$ref": "(resource) beta.threads.messages > (model) file_path_annotation > (schema)" - } - ], - "oasRef": "#/components/schemas/TextAnnotation" - }, - "docstring": "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.", - "childrenParentSchema": "union", - "children": [ - "(resource) beta.threads.messages > (model) annotation > (schema) > (variant) 0", - "(resource) beta.threads.messages > (model) annotation > (schema) > (variant) 1" - ] - }, - "(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) end_index": { - "kind": "HttpDeclProperty", - "key": "end_index", - "optional": false, - "nullable": false, - "type": { - "kind": "HttpTypeNumber" - }, - "constraints": { - "minimum": 0 - }, - "oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject/properties/end_index", - "deprecated": false, - "schemaType": "integer", - "children": [] - }, - "(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) file_citation": { - "kind": "HttpDeclProperty", - "key": "file_citation", - "optional": false, - "nullable": false, - "type": { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "file_id" - } - ] - }, - "oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject/properties/file_citation", - "deprecated": false, - "schemaType": "object", - "childrenParentSchema": "object", - "children": [ - "(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) file_citation > (property) file_id" - ] - }, - "(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) start_index": { - "kind": "HttpDeclProperty", - "key": "start_index", - "optional": false, - "nullable": false, - "type": { - "kind": "HttpTypeNumber" - }, - "constraints": { - "minimum": 0 - }, - "oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject/properties/start_index", - "deprecated": false, - "schemaType": "integer", - "children": [] - }, - "(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) text": { - "kind": "HttpDeclProperty", - "docstring": "The text in the message content that needs to be replaced.", - "key": "text", - "optional": false, - "nullable": false, - "type": { - "kind": "HttpTypeString" - }, - "oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject/properties/text", - "deprecated": false, - "schemaType": "string", - "children": [] - }, - "(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) type": { - "kind": "HttpDeclProperty", - "docstring": "Always `file_citation`.", - "key": "type", - "optional": false, - "nullable": false, - "type": { - "kind": "HttpTypeUnion", - "types": [ - { - "kind": "HttpTypeLiteral", - "literal": "file_citation" - } - ], - "oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject/properties/type" - }, - "oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject/properties/type", - "deprecated": false, - "schemaType": "enum", - "childrenParentSchema": "enum", - "children": [ - "(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) type > (member) 0" - ] - }, "(resource) beta.threads.messages > (model) file_citation_annotation > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject", @@ -37803,6 +37132,131 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) type" ] }, + "(resource) beta.threads.messages > (model) file_path_annotation > (schema)": { + "kind": "HttpDeclTypeAlias", + "oasRef": "#/components/schemas/MessageContentTextAnnotationsFilePathObject", + "ident": "FilePathAnnotation", + "type": { + "kind": "HttpTypeObject", + "members": [ + { + "ident": "end_index" + }, + { + "ident": "file_path" + }, + { + "ident": "start_index" + }, + { + "ident": "text" + }, + { + "ident": "type" + } + ] + }, + "docstring": "A URL for the file that's generated when the assistant used the `code_interpreter` tool to generate a file.", + "childrenParentSchema": "object", + "children": [ + "(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) end_index", + "(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) file_path", + "(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) start_index", + "(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) text", + "(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) type" + ] + }, + "(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) end_index": { + "kind": "HttpDeclProperty", + "key": "end_index", + "optional": false, + "nullable": false, + "type": { + "kind": "HttpTypeNumber" + }, + "constraints": { + "minimum": 0 + }, + "oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject/properties/end_index", + "deprecated": false, + "schemaType": "integer", + "children": [] + }, + "(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) file_citation": { + "kind": "HttpDeclProperty", + "key": "file_citation", + "optional": false, + "nullable": false, + "type": { + "kind": "HttpTypeObject", + "members": [ + { + "ident": "file_id" + } + ] + }, + "oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject/properties/file_citation", + "deprecated": false, + "schemaType": "object", + "childrenParentSchema": "object", + "children": [ + "(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) file_citation > (property) file_id" + ] + }, + "(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) start_index": { + "kind": "HttpDeclProperty", + "key": "start_index", + "optional": false, + "nullable": false, + "type": { + "kind": "HttpTypeNumber" + }, + "constraints": { + "minimum": 0 + }, + "oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject/properties/start_index", + "deprecated": false, + "schemaType": "integer", + "children": [] + }, + "(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) text": { + "kind": "HttpDeclProperty", + "docstring": "The text in the message content that needs to be replaced.", + "key": "text", + "optional": false, + "nullable": false, + "type": { + "kind": "HttpTypeString" + }, + "oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject/properties/text", + "deprecated": false, + "schemaType": "string", + "children": [] + }, + "(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) type": { + "kind": "HttpDeclProperty", + "docstring": "Always `file_citation`.", + "key": "type", + "optional": false, + "nullable": false, + "type": { + "kind": "HttpTypeUnion", + "types": [ + { + "kind": "HttpTypeLiteral", + "literal": "file_citation" + } + ], + "oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject/properties/type" + }, + "oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject/properties/type", + "deprecated": false, + "schemaType": "enum", + "childrenParentSchema": "enum", + "children": [ + "(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) type > (member) 0" + ] + }, "(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) end_index": { "kind": "HttpDeclProperty", "key": "end_index", @@ -37894,40 +37348,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) type > (member) 0" ] }, - "(resource) beta.threads.messages > (model) file_path_annotation > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/MessageContentTextAnnotationsFilePathObject", - "ident": "FilePathAnnotation", - "type": { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "end_index" - }, - { - "ident": "file_path" - }, - { - "ident": "start_index" - }, - { - "ident": "text" - }, - { - "ident": "type" - } - ] - }, - "docstring": "A URL for the file that's generated when the assistant used the `code_interpreter` tool to generate a file.", - "childrenParentSchema": "object", - "children": [ - "(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) end_index", - "(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) file_path", - "(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) start_index", - "(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) text", - "(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) type" - ] - }, "(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) file_citation > (property) file_id": { "kind": "HttpDeclProperty", "docstring": "The ID of the specific File the citation is from.", @@ -37981,7 +37401,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch ## event -Occurs when a [message](https://platform.openai.com/docs/api-reference/messages/object) moves to an `in_progress` state. +Occurs when a [message](https://developers.openai.com/docs/api-reference/messages/object) moves to an `in_progress` state. ### Schema @@ -37991,8 +37411,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch { "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 19": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/MessageStreamEvent/anyOf/1", - "ident": "ThreadMessageInProgress", + "oasRef": "#/components/schemas/MessageStreamEvent/oneOf/1", + "ident": "UnionMember19", "type": { "kind": "HttpTypeObject", "members": [ @@ -38004,7 +37424,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Occurs when a [message](https://platform.openai.com/docs/api-reference/messages/object) moves to an `in_progress` state.", + "docstring": "Occurs when a [message](/docs/api-reference/messages/object) moves to an `in_progress` state.", "childrenParentSchema": "object", "children": [ "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 19 > (property) data", @@ -38014,7 +37434,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 19 > (property) data": { "kind": "HttpDeclProperty", "title": "The message object", - "docstring": "Represents a message within a [thread](https://platform.openai.com/docs/api-reference/threads).", + "docstring": "Represents a message within a [thread](/docs/api-reference/threads).", "key": "data", "optional": false, "nullable": false, @@ -38023,7 +37443,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "ident": "Message", "$ref": "(resource) beta.threads.messages > (model) message > (schema)" }, - "oasRef": "#/components/schemas/MessageStreamEvent/anyOf/1/properties/data", + "oasRef": "#/components/schemas/MessageStreamEvent/oneOf/1/properties/data", "deprecated": false, "schemaType": "object", "modelImplicit": false, @@ -38059,9 +37479,9 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "literal": "thread.message.in_progress" } ], - "oasRef": "#/components/schemas/MessageStreamEvent/anyOf/1/properties/event" + "oasRef": "#/components/schemas/MessageStreamEvent/oneOf/1/properties/event" }, - "oasRef": "#/components/schemas/MessageStreamEvent/anyOf/1/properties/event", + "oasRef": "#/components/schemas/MessageStreamEvent/oneOf/1/properties/event", "deprecated": false, "schemaType": "enum", "childrenParentSchema": "enum", @@ -38085,7 +37505,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) message > (schema) > (property) assistant_id": { "kind": "HttpDeclProperty", - "docstring": "If applicable, the ID of the [assistant](https://platform.openai.com/docs/api-reference/assistants) that authored this message.", + "docstring": "If applicable, the ID of the [assistant](/docs/api-reference/assistants) that authored this message.", "key": "assistant_id", "optional": false, "nullable": true, @@ -38153,9 +37573,30 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "type": { "kind": "HttpTypeArray", "elementType": { + "kind": "HttpTypeUnion", + "types": [ + { + "kind": "HttpTypeReference", + "ident": "ImageFileContentBlock", + "$ref": "(resource) beta.threads.messages > (model) image_file_content_block > (schema)" + }, + { "kind": "HttpTypeReference", - "ident": "MessageContent", - "$ref": "(resource) beta.threads.messages > (model) message_content > (schema)" + "ident": "ImageURLContentBlock", + "$ref": "(resource) beta.threads.messages > (model) image_url_content_block > (schema)" + }, + { + "kind": "HttpTypeReference", + "ident": "TextContentBlock", + "$ref": "(resource) beta.threads.messages > (model) text_content_block > (schema)" + }, + { + "kind": "HttpTypeReference", + "ident": "RefusalContentBlock", + "$ref": "(resource) beta.threads.messages > (model) refusal_content_block > (schema)" + } + ], + "oasRef": "#/components/schemas/MessageObject/properties/content/items" }, "oasRef": "#/components/schemas/MessageObject/properties/content" }, @@ -38164,10 +37605,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "schemaType": "array", "childrenParentSchema": "union", "children": [ - "(resource) beta.threads.messages > (model) message_content > (schema) > (variant) 0", - "(resource) beta.threads.messages > (model) message_content > (schema) > (variant) 1", - "(resource) beta.threads.messages > (model) message_content > (schema) > (variant) 2", - "(resource) beta.threads.messages > (model) message_content > (schema) > (variant) 3" + "(resource) beta.threads.messages > (model) message > (schema) > (property) content > (items) > (variant) 0", + "(resource) beta.threads.messages > (model) message > (schema) > (property) content > (items) > (variant) 1", + "(resource) beta.threads.messages > (model) message > (schema) > (property) content > (items) > (variant) 2", + "(resource) beta.threads.messages > (model) message > (schema) > (property) content > (items) > (variant) 3" ] }, "(resource) beta.threads.messages > (model) message > (schema) > (property) created_at": { @@ -38299,7 +37740,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) message > (schema) > (property) run_id": { "kind": "HttpDeclProperty", - "docstring": "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.", + "docstring": "The ID of the [run](/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.", "key": "run_id", "optional": false, "nullable": true, @@ -38347,7 +37788,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) message > (schema) > (property) thread_id": { "kind": "HttpDeclProperty", - "docstring": "The [thread](https://platform.openai.com/docs/api-reference/threads) ID that this message belongs to.", + "docstring": "The [thread](/docs/api-reference/threads) ID that this message belongs to.", "key": "thread_id", "optional": false, "nullable": false, @@ -38410,7 +37851,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Represents a message within a [thread](https://platform.openai.com/docs/api-reference/threads).", + "docstring": "Represents a message within a [thread](/docs/api-reference/threads).", "childrenParentSchema": "object", "children": [ "(resource) beta.threads.messages > (model) message > (schema) > (property) id", @@ -38488,7 +37929,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.messages > (model) message > (schema) > (property) attachments > (items) > (property) tools > (items) > (variant) 1" ] }, - "(resource) beta.threads.messages > (model) message_content > (schema) > (variant) 0": { + "(resource) beta.threads.messages > (model) message > (schema) > (property) content > (items) > (variant) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", @@ -38501,7 +37942,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.messages > (model) image_file_content_block > (schema) > (property) type" ] }, - "(resource) beta.threads.messages > (model) message_content > (schema) > (variant) 1": { + "(resource) beta.threads.messages > (model) message > (schema) > (property) content > (items) > (variant) 1": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", @@ -38514,7 +37955,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.messages > (model) image_url_content_block > (schema) > (property) type" ] }, - "(resource) beta.threads.messages > (model) message_content > (schema) > (variant) 2": { + "(resource) beta.threads.messages > (model) message > (schema) > (property) content > (items) > (variant) 2": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", @@ -38527,7 +37968,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.messages > (model) text_content_block > (schema) > (property) type" ] }, - "(resource) beta.threads.messages > (model) message_content > (schema) > (variant) 3": { + "(resource) beta.threads.messages > (model) message > (schema) > (property) content > (items) > (variant) 3": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", @@ -38540,43 +37981,92 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.messages > (model) refusal_content_block > (schema) > (property) type" ] }, - "(resource) beta.threads.messages > (model) message_content > (schema)": { + "(resource) beta.threads.messages > (model) image_file_content_block > (schema)": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/MessageContent", - "ident": "MessageContent", + "oasRef": "#/components/schemas/MessageContentImageFileObject", + "ident": "ImageFileContentBlock", "type": { - "kind": "HttpTypeUnion", - "types": [ + "kind": "HttpTypeObject", + "members": [ { - "kind": "HttpTypeReference", - "ident": "ImageFileContentBlock", - "$ref": "(resource) beta.threads.messages > (model) image_file_content_block > (schema)" + "ident": "image_file" }, { - "kind": "HttpTypeReference", + "ident": "type" + } + ] + }, + "docstring": "References an image [File](/docs/api-reference/files) in the content of a message.", + "childrenParentSchema": "object", + "children": [ + "(resource) beta.threads.messages > (model) image_file_content_block > (schema) > (property) image_file", + "(resource) beta.threads.messages > (model) image_file_content_block > (schema) > (property) type" + ] + }, + "(resource) beta.threads.messages > (model) image_url_content_block > (schema)": { + "kind": "HttpDeclTypeAlias", + "oasRef": "#/components/schemas/MessageContentImageUrlObject", "ident": "ImageURLContentBlock", - "$ref": "(resource) beta.threads.messages > (model) image_url_content_block > (schema)" + "type": { + "kind": "HttpTypeObject", + "members": [ + { + "ident": "image_url" }, { - "kind": "HttpTypeReference", + "ident": "type" + } + ] + }, + "docstring": "References an image URL in the content of a message.", + "childrenParentSchema": "object", + "children": [ + "(resource) beta.threads.messages > (model) image_url_content_block > (schema) > (property) image_url", + "(resource) beta.threads.messages > (model) image_url_content_block > (schema) > (property) type" + ] + }, + "(resource) beta.threads.messages > (model) text_content_block > (schema)": { + "kind": "HttpDeclTypeAlias", + "oasRef": "#/components/schemas/MessageContentTextObject", "ident": "TextContentBlock", - "$ref": "(resource) beta.threads.messages > (model) text_content_block > (schema)" + "type": { + "kind": "HttpTypeObject", + "members": [ + { + "ident": "text" }, { - "kind": "HttpTypeReference", + "ident": "type" + } + ] + }, + "docstring": "The text content that is part of a message.", + "childrenParentSchema": "object", + "children": [ + "(resource) beta.threads.messages > (model) text_content_block > (schema) > (property) text", + "(resource) beta.threads.messages > (model) text_content_block > (schema) > (property) type" + ] + }, + "(resource) beta.threads.messages > (model) refusal_content_block > (schema)": { + "kind": "HttpDeclTypeAlias", + "oasRef": "#/components/schemas/MessageContentRefusalObject", "ident": "RefusalContentBlock", - "$ref": "(resource) beta.threads.messages > (model) refusal_content_block > (schema)" + "type": { + "kind": "HttpTypeObject", + "members": [ + { + "ident": "refusal" + }, + { + "ident": "type" } - ], - "oasRef": "#/components/schemas/MessageContent" + ] }, - "docstring": "References an image [File](https://platform.openai.com/docs/api-reference/files) in the content of a message.", - "childrenParentSchema": "union", + "docstring": "The refusal content generated by the assistant.", + "childrenParentSchema": "object", "children": [ - "(resource) beta.threads.messages > (model) message_content > (schema) > (variant) 0", - "(resource) beta.threads.messages > (model) message_content > (schema) > (variant) 1", - "(resource) beta.threads.messages > (model) message_content > (schema) > (variant) 2", - "(resource) beta.threads.messages > (model) message_content > (schema) > (variant) 3" + "(resource) beta.threads.messages > (model) refusal_content_block > (schema) > (property) refusal", + "(resource) beta.threads.messages > (model) refusal_content_block > (schema) > (property) type" ] }, "(resource) beta.threads.messages > (model) message > (schema) > (property) incomplete_details > (property) reason": { @@ -38699,8 +38189,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) message > (schema) > (property) attachments > (items) > (property) tools > (items) > (variant) 1": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/MessageObject/properties/attachments/anyOf/0/items/properties/tools/items/anyOf/1", - "ident": "AssistantToolsFileSearchTypeOnly", + "oasRef": "#/components/schemas/MessageObject/properties/attachments/anyOf/0/items/properties/tools/items/oneOf/1", + "ident": "FileSearchTool", "type": { "kind": "HttpTypeObject", "members": [ @@ -38776,28 +38266,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.messages > (model) image_file_content_block > (schema) > (property) type > (member) 0" ] }, - "(resource) beta.threads.messages > (model) image_file_content_block > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/MessageContentImageFileObject", - "ident": "ImageFileContentBlock", - "type": { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "image_file" - }, - { - "ident": "type" - } - ] - }, - "docstring": "References an image [File](https://platform.openai.com/docs/api-reference/files) in the content of a message.", - "childrenParentSchema": "object", - "children": [ - "(resource) beta.threads.messages > (model) image_file_content_block > (schema) > (property) image_file", - "(resource) beta.threads.messages > (model) image_file_content_block > (schema) > (property) type" - ] - }, "(resource) beta.threads.messages > (model) image_url_content_block > (schema) > (property) image_url": { "kind": "HttpDeclProperty", "key": "image_url", @@ -38843,28 +38311,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.messages > (model) image_url_content_block > (schema) > (property) type > (member) 0" ] }, - "(resource) beta.threads.messages > (model) image_url_content_block > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/MessageContentImageUrlObject", - "ident": "ImageURLContentBlock", - "type": { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "image_url" - }, - { - "ident": "type" - } - ] - }, - "docstring": "References an image URL in the content of a message.", - "childrenParentSchema": "object", - "children": [ - "(resource) beta.threads.messages > (model) image_url_content_block > (schema) > (property) image_url", - "(resource) beta.threads.messages > (model) image_url_content_block > (schema) > (property) type" - ] - }, "(resource) beta.threads.messages > (model) text_content_block > (schema) > (property) text": { "kind": "HttpDeclProperty", "key": "text", @@ -38910,28 +38356,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.messages > (model) text_content_block > (schema) > (property) type > (member) 0" ] }, - "(resource) beta.threads.messages > (model) text_content_block > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/MessageContentTextObject", - "ident": "TextContentBlock", - "type": { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "text" - }, - { - "ident": "type" - } - ] - }, - "docstring": "The text content that is part of a message.", - "childrenParentSchema": "object", - "children": [ - "(resource) beta.threads.messages > (model) text_content_block > (schema) > (property) text", - "(resource) beta.threads.messages > (model) text_content_block > (schema) > (property) type" - ] - }, "(resource) beta.threads.messages > (model) refusal_content_block > (schema) > (property) refusal": { "kind": "HttpDeclProperty", "key": "refusal", @@ -38969,28 +38393,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.messages > (model) refusal_content_block > (schema) > (property) type > (member) 0" ] }, - "(resource) beta.threads.messages > (model) refusal_content_block > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/MessageContentRefusalObject", - "ident": "RefusalContentBlock", - "type": { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "refusal" - }, - { - "ident": "type" - } - ] - }, - "docstring": "The refusal content generated by the assistant.", - "childrenParentSchema": "object", - "children": [ - "(resource) beta.threads.messages > (model) refusal_content_block > (schema) > (property) refusal", - "(resource) beta.threads.messages > (model) refusal_content_block > (schema) > (property) type" - ] - }, "(resource) beta.threads.messages > (model) message > (schema) > (property) incomplete_details > (property) reason > (member) 0": { "kind": "HttpDeclReference", "type": { @@ -39076,7 +38478,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) image_file > (schema) > (property) file_id": { "kind": "HttpDeclProperty", - "docstring": "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.", + "docstring": "The [File](/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.", "key": "file_id", "optional": false, "nullable": false, @@ -39239,9 +38641,20 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "type": { "kind": "HttpTypeArray", "elementType": { + "kind": "HttpTypeUnion", + "types": [ + { + "kind": "HttpTypeReference", + "ident": "FileCitationAnnotation", + "$ref": "(resource) beta.threads.messages > (model) file_citation_annotation > (schema)" + }, + { "kind": "HttpTypeReference", - "ident": "Annotation", - "$ref": "(resource) beta.threads.messages > (model) annotation > (schema)" + "ident": "FilePathAnnotation", + "$ref": "(resource) beta.threads.messages > (model) file_path_annotation > (schema)" + } + ], + "oasRef": "#/components/schemas/MessageContentTextObject/properties/text/properties/annotations/items" }, "oasRef": "#/components/schemas/MessageContentTextObject/properties/text/properties/annotations" }, @@ -39250,8 +38663,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "schemaType": "array", "childrenParentSchema": "union", "children": [ - "(resource) beta.threads.messages > (model) annotation > (schema) > (variant) 0", - "(resource) beta.threads.messages > (model) annotation > (schema) > (variant) 1" + "(resource) beta.threads.messages > (model) text > (schema) > (property) annotations > (items) > (variant) 0", + "(resource) beta.threads.messages > (model) text > (schema) > (property) annotations > (items) > (variant) 1" ] }, "(resource) beta.threads.messages > (model) text > (schema) > (property) value": { @@ -39359,7 +38772,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "literal": "high" } }, - "(resource) beta.threads.messages > (model) annotation > (schema) > (variant) 0": { + "(resource) beta.threads.messages > (model) text > (schema) > (property) annotations > (items) > (variant) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", @@ -39375,7 +38788,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) type" ] }, - "(resource) beta.threads.messages > (model) annotation > (schema) > (variant) 1": { + "(resource) beta.threads.messages > (model) text > (schema) > (property) annotations > (items) > (variant) 1": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", @@ -39391,31 +38804,72 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) type" ] }, - "(resource) beta.threads.messages > (model) annotation > (schema)": { + "(resource) beta.threads.messages > (model) file_citation_annotation > (schema)": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/TextAnnotation", - "ident": "Annotation", + "oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject", + "ident": "FileCitationAnnotation", "type": { - "kind": "HttpTypeUnion", - "types": [ + "kind": "HttpTypeObject", + "members": [ { - "kind": "HttpTypeReference", - "ident": "FileCitationAnnotation", - "$ref": "(resource) beta.threads.messages > (model) file_citation_annotation > (schema)" + "ident": "end_index" }, { - "kind": "HttpTypeReference", - "ident": "FilePathAnnotation", - "$ref": "(resource) beta.threads.messages > (model) file_path_annotation > (schema)" + "ident": "file_citation" + }, + { + "ident": "start_index" + }, + { + "ident": "text" + }, + { + "ident": "type" } - ], - "oasRef": "#/components/schemas/TextAnnotation" + ] }, "docstring": "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.", - "childrenParentSchema": "union", + "childrenParentSchema": "object", "children": [ - "(resource) beta.threads.messages > (model) annotation > (schema) > (variant) 0", - "(resource) beta.threads.messages > (model) annotation > (schema) > (variant) 1" + "(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) end_index", + "(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) file_citation", + "(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) start_index", + "(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) text", + "(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) type" + ] + }, + "(resource) beta.threads.messages > (model) file_path_annotation > (schema)": { + "kind": "HttpDeclTypeAlias", + "oasRef": "#/components/schemas/MessageContentTextAnnotationsFilePathObject", + "ident": "FilePathAnnotation", + "type": { + "kind": "HttpTypeObject", + "members": [ + { + "ident": "end_index" + }, + { + "ident": "file_path" + }, + { + "ident": "start_index" + }, + { + "ident": "text" + }, + { + "ident": "type" + } + ] + }, + "docstring": "A URL for the file that's generated when the assistant used the `code_interpreter` tool to generate a file.", + "childrenParentSchema": "object", + "children": [ + "(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) end_index", + "(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) file_path", + "(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) start_index", + "(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) text", + "(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) type" ] }, "(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) end_index": { @@ -39509,40 +38963,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) type > (member) 0" ] }, - "(resource) beta.threads.messages > (model) file_citation_annotation > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject", - "ident": "FileCitationAnnotation", - "type": { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "end_index" - }, - { - "ident": "file_citation" - }, - { - "ident": "start_index" - }, - { - "ident": "text" - }, - { - "ident": "type" - } - ] - }, - "docstring": "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.", - "childrenParentSchema": "object", - "children": [ - "(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) end_index", - "(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) file_citation", - "(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) start_index", - "(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) text", - "(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) type" - ] - }, "(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) end_index": { "kind": "HttpDeclProperty", "key": "end_index", @@ -39634,40 +39054,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) type > (member) 0" ] }, - "(resource) beta.threads.messages > (model) file_path_annotation > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/MessageContentTextAnnotationsFilePathObject", - "ident": "FilePathAnnotation", - "type": { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "end_index" - }, - { - "ident": "file_path" - }, - { - "ident": "start_index" - }, - { - "ident": "text" - }, - { - "ident": "type" - } - ] - }, - "docstring": "A URL for the file that's generated when the assistant used the `code_interpreter` tool to generate a file.", - "childrenParentSchema": "object", - "children": [ - "(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) end_index", - "(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) file_path", - "(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) start_index", - "(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) text", - "(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) type" - ] - }, "(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) file_citation > (property) file_id": { "kind": "HttpDeclProperty", "docstring": "The ID of the specific File the citation is from.", @@ -39721,7 +39107,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch ## event -Occurs when parts of a [Message](https://platform.openai.com/docs/api-reference/messages/object) are being streamed. +Occurs when parts of a [Message](https://developers.openai.com/docs/api-reference/messages/object) are being streamed. ### Schema @@ -39731,8 +39117,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch { "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 20": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/MessageStreamEvent/anyOf/2", - "ident": "ThreadMessageDelta", + "oasRef": "#/components/schemas/MessageStreamEvent/oneOf/2", + "ident": "UnionMember20", "type": { "kind": "HttpTypeObject", "members": [ @@ -39744,7 +39130,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Occurs when parts of a [Message](https://platform.openai.com/docs/api-reference/messages/object) are being streamed.", + "docstring": "Occurs when parts of a [Message](/docs/api-reference/messages/object) are being streamed.", "childrenParentSchema": "object", "children": [ "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 20 > (property) data", @@ -39763,7 +39149,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "ident": "MessageDeltaEvent", "$ref": "(resource) beta.threads.messages > (model) message_delta_event > (schema)" }, - "oasRef": "#/components/schemas/MessageStreamEvent/anyOf/2/properties/data", + "oasRef": "#/components/schemas/MessageStreamEvent/oneOf/2/properties/data", "deprecated": false, "schemaType": "object", "modelImplicit": false, @@ -39788,9 +39174,9 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "literal": "thread.message.delta" } ], - "oasRef": "#/components/schemas/MessageStreamEvent/anyOf/2/properties/event" + "oasRef": "#/components/schemas/MessageStreamEvent/oneOf/2/properties/event" }, - "oasRef": "#/components/schemas/MessageStreamEvent/anyOf/2/properties/event", + "oasRef": "#/components/schemas/MessageStreamEvent/oneOf/2/properties/event", "deprecated": false, "schemaType": "enum", "childrenParentSchema": "enum", @@ -39900,9 +39286,30 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "type": { "kind": "HttpTypeArray", "elementType": { + "kind": "HttpTypeUnion", + "types": [ + { + "kind": "HttpTypeReference", + "ident": "ImageFileDeltaBlock", + "$ref": "(resource) beta.threads.messages > (model) image_file_delta_block > (schema)" + }, + { + "kind": "HttpTypeReference", + "ident": "TextDeltaBlock", + "$ref": "(resource) beta.threads.messages > (model) text_delta_block > (schema)" + }, + { + "kind": "HttpTypeReference", + "ident": "RefusalDeltaBlock", + "$ref": "(resource) beta.threads.messages > (model) refusal_delta_block > (schema)" + }, + { "kind": "HttpTypeReference", - "ident": "MessageContentDelta", - "$ref": "(resource) beta.threads.messages > (model) message_content_delta > (schema)" + "ident": "ImageURLDeltaBlock", + "$ref": "(resource) beta.threads.messages > (model) image_url_delta_block > (schema)" + } + ], + "oasRef": "#/components/schemas/MessageDeltaObject/properties/delta/properties/content/items" }, "oasRef": "#/components/schemas/MessageDeltaObject/properties/delta/properties/content" }, @@ -39911,10 +39318,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "schemaType": "array", "childrenParentSchema": "union", "children": [ - "(resource) beta.threads.messages > (model) message_content_delta > (schema) > (variant) 0", - "(resource) beta.threads.messages > (model) message_content_delta > (schema) > (variant) 1", - "(resource) beta.threads.messages > (model) message_content_delta > (schema) > (variant) 2", - "(resource) beta.threads.messages > (model) message_content_delta > (schema) > (variant) 3" + "(resource) beta.threads.messages > (model) message_delta > (schema) > (property) content > (items) > (variant) 0", + "(resource) beta.threads.messages > (model) message_delta > (schema) > (property) content > (items) > (variant) 1", + "(resource) beta.threads.messages > (model) message_delta > (schema) > (property) content > (items) > (variant) 2", + "(resource) beta.threads.messages > (model) message_delta > (schema) > (property) content > (items) > (variant) 3" ] }, "(resource) beta.threads.messages > (model) message_delta > (schema) > (property) role": { @@ -39975,7 +39382,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "literal": "thread.message.delta" } }, - "(resource) beta.threads.messages > (model) message_content_delta > (schema) > (variant) 0": { + "(resource) beta.threads.messages > (model) message_delta > (schema) > (property) content > (items) > (variant) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", @@ -39989,7 +39396,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.messages > (model) image_file_delta_block > (schema) > (property) image_file" ] }, - "(resource) beta.threads.messages > (model) message_content_delta > (schema) > (variant) 1": { + "(resource) beta.threads.messages > (model) message_delta > (schema) > (property) content > (items) > (variant) 1": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", @@ -40003,7 +39410,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.messages > (model) text_delta_block > (schema) > (property) text" ] }, - "(resource) beta.threads.messages > (model) message_content_delta > (schema) > (variant) 2": { + "(resource) beta.threads.messages > (model) message_delta > (schema) > (property) content > (items) > (variant) 2": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", @@ -40017,7 +39424,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.messages > (model) refusal_delta_block > (schema) > (property) refusal" ] }, - "(resource) beta.threads.messages > (model) message_content_delta > (schema) > (variant) 3": { + "(resource) beta.threads.messages > (model) message_delta > (schema) > (property) content > (items) > (variant) 3": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", @@ -40031,43 +39438,108 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.messages > (model) image_url_delta_block > (schema) > (property) image_url" ] }, - "(resource) beta.threads.messages > (model) message_content_delta > (schema)": { + "(resource) beta.threads.messages > (model) image_file_delta_block > (schema)": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/MessageContentDelta", - "ident": "MessageContentDelta", + "oasRef": "#/components/schemas/MessageDeltaContentImageFileObject", + "ident": "ImageFileDeltaBlock", "type": { - "kind": "HttpTypeUnion", - "types": [ + "kind": "HttpTypeObject", + "members": [ { - "kind": "HttpTypeReference", - "ident": "ImageFileDeltaBlock", - "$ref": "(resource) beta.threads.messages > (model) image_file_delta_block > (schema)" + "ident": "index" }, { - "kind": "HttpTypeReference", + "ident": "type" + }, + { + "ident": "image_file" + } + ] + }, + "docstring": "References an image [File](/docs/api-reference/files) in the content of a message.", + "childrenParentSchema": "object", + "children": [ + "(resource) beta.threads.messages > (model) image_file_delta_block > (schema) > (property) index", + "(resource) beta.threads.messages > (model) image_file_delta_block > (schema) > (property) type", + "(resource) beta.threads.messages > (model) image_file_delta_block > (schema) > (property) image_file" + ] + }, + "(resource) beta.threads.messages > (model) text_delta_block > (schema)": { + "kind": "HttpDeclTypeAlias", + "oasRef": "#/components/schemas/MessageDeltaContentTextObject", "ident": "TextDeltaBlock", - "$ref": "(resource) beta.threads.messages > (model) text_delta_block > (schema)" + "type": { + "kind": "HttpTypeObject", + "members": [ + { + "ident": "index" }, { - "kind": "HttpTypeReference", + "ident": "type" + }, + { + "ident": "text" + } + ] + }, + "docstring": "The text content that is part of a message.", + "childrenParentSchema": "object", + "children": [ + "(resource) beta.threads.messages > (model) text_delta_block > (schema) > (property) index", + "(resource) beta.threads.messages > (model) text_delta_block > (schema) > (property) type", + "(resource) beta.threads.messages > (model) text_delta_block > (schema) > (property) text" + ] + }, + "(resource) beta.threads.messages > (model) refusal_delta_block > (schema)": { + "kind": "HttpDeclTypeAlias", + "oasRef": "#/components/schemas/MessageDeltaContentRefusalObject", "ident": "RefusalDeltaBlock", - "$ref": "(resource) beta.threads.messages > (model) refusal_delta_block > (schema)" + "type": { + "kind": "HttpTypeObject", + "members": [ + { + "ident": "index" }, { - "kind": "HttpTypeReference", + "ident": "type" + }, + { + "ident": "refusal" + } + ] + }, + "docstring": "The refusal content that is part of a message.", + "childrenParentSchema": "object", + "children": [ + "(resource) beta.threads.messages > (model) refusal_delta_block > (schema) > (property) index", + "(resource) beta.threads.messages > (model) refusal_delta_block > (schema) > (property) type", + "(resource) beta.threads.messages > (model) refusal_delta_block > (schema) > (property) refusal" + ] + }, + "(resource) beta.threads.messages > (model) image_url_delta_block > (schema)": { + "kind": "HttpDeclTypeAlias", + "oasRef": "#/components/schemas/MessageDeltaContentImageUrlObject", "ident": "ImageURLDeltaBlock", - "$ref": "(resource) beta.threads.messages > (model) image_url_delta_block > (schema)" + "type": { + "kind": "HttpTypeObject", + "members": [ + { + "ident": "index" + }, + { + "ident": "type" + }, + { + "ident": "image_url" } - ], - "oasRef": "#/components/schemas/MessageContentDelta" + ] }, - "docstring": "References an image [File](https://platform.openai.com/docs/api-reference/files) in the content of a message.", - "childrenParentSchema": "union", + "docstring": "References an image URL in the content of a message.", + "childrenParentSchema": "object", "children": [ - "(resource) beta.threads.messages > (model) message_content_delta > (schema) > (variant) 0", - "(resource) beta.threads.messages > (model) message_content_delta > (schema) > (variant) 1", - "(resource) beta.threads.messages > (model) message_content_delta > (schema) > (variant) 2", - "(resource) beta.threads.messages > (model) message_content_delta > (schema) > (variant) 3" + "(resource) beta.threads.messages > (model) image_url_delta_block > (schema) > (property) index", + "(resource) beta.threads.messages > (model) image_url_delta_block > (schema) > (property) type", + "(resource) beta.threads.messages > (model) image_url_delta_block > (schema) > (property) image_url" ] }, "(resource) beta.threads.messages > (model) message_delta > (schema) > (property) role > (member) 0": { @@ -40143,32 +39615,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.messages > (model) image_file_delta > (schema) > (property) file_id" ] }, - "(resource) beta.threads.messages > (model) image_file_delta_block > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/MessageDeltaContentImageFileObject", - "ident": "ImageFileDeltaBlock", - "type": { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "index" - }, - { - "ident": "type" - }, - { - "ident": "image_file" - } - ] - }, - "docstring": "References an image [File](https://platform.openai.com/docs/api-reference/files) in the content of a message.", - "childrenParentSchema": "object", - "children": [ - "(resource) beta.threads.messages > (model) image_file_delta_block > (schema) > (property) index", - "(resource) beta.threads.messages > (model) image_file_delta_block > (schema) > (property) type", - "(resource) beta.threads.messages > (model) image_file_delta_block > (schema) > (property) image_file" - ] - }, "(resource) beta.threads.messages > (model) text_delta_block > (schema) > (property) index": { "kind": "HttpDeclProperty", "docstring": "The index of the content part in the message.", @@ -40228,32 +39674,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.messages > (model) text_delta > (schema) > (property) value" ] }, - "(resource) beta.threads.messages > (model) text_delta_block > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/MessageDeltaContentTextObject", - "ident": "TextDeltaBlock", - "type": { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "index" - }, - { - "ident": "type" - }, - { - "ident": "text" - } - ] - }, - "docstring": "The text content that is part of a message.", - "childrenParentSchema": "object", - "children": [ - "(resource) beta.threads.messages > (model) text_delta_block > (schema) > (property) index", - "(resource) beta.threads.messages > (model) text_delta_block > (schema) > (property) type", - "(resource) beta.threads.messages > (model) text_delta_block > (schema) > (property) text" - ] - }, "(resource) beta.threads.messages > (model) refusal_delta_block > (schema) > (property) index": { "kind": "HttpDeclProperty", "docstring": "The index of the refusal part in the message.", @@ -40305,32 +39725,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "schemaType": "string", "children": [] }, - "(resource) beta.threads.messages > (model) refusal_delta_block > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/MessageDeltaContentRefusalObject", - "ident": "RefusalDeltaBlock", - "type": { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "index" - }, - { - "ident": "type" - }, - { - "ident": "refusal" - } - ] - }, - "docstring": "The refusal content that is part of a message.", - "childrenParentSchema": "object", - "children": [ - "(resource) beta.threads.messages > (model) refusal_delta_block > (schema) > (property) index", - "(resource) beta.threads.messages > (model) refusal_delta_block > (schema) > (property) type", - "(resource) beta.threads.messages > (model) refusal_delta_block > (schema) > (property) refusal" - ] - }, "(resource) beta.threads.messages > (model) image_url_delta_block > (schema) > (property) index": { "kind": "HttpDeclProperty", "docstring": "The index of the content part in the message.", @@ -40390,32 +39784,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.messages > (model) image_url_delta > (schema) > (property) url" ] }, - "(resource) beta.threads.messages > (model) image_url_delta_block > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/MessageDeltaContentImageUrlObject", - "ident": "ImageURLDeltaBlock", - "type": { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "index" - }, - { - "ident": "type" - }, - { - "ident": "image_url" - } - ] - }, - "docstring": "References an image URL in the content of a message.", - "childrenParentSchema": "object", - "children": [ - "(resource) beta.threads.messages > (model) image_url_delta_block > (schema) > (property) index", - "(resource) beta.threads.messages > (model) image_url_delta_block > (schema) > (property) type", - "(resource) beta.threads.messages > (model) image_url_delta_block > (schema) > (property) image_url" - ] - }, "(resource) beta.threads.messages > (model) image_file_delta_block > (schema) > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { @@ -40460,7 +39828,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) image_file_delta > (schema) > (property) file_id": { "kind": "HttpDeclProperty", - "docstring": "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.", + "docstring": "The [File](/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.", "key": "file_id", "optional": true, "nullable": false, @@ -40508,9 +39876,20 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "type": { "kind": "HttpTypeArray", "elementType": { + "kind": "HttpTypeUnion", + "types": [ + { + "kind": "HttpTypeReference", + "ident": "FileCitationDeltaAnnotation", + "$ref": "(resource) beta.threads.messages > (model) file_citation_delta_annotation > (schema)" + }, + { "kind": "HttpTypeReference", - "ident": "AnnotationDelta", - "$ref": "(resource) beta.threads.messages > (model) annotation_delta > (schema)" + "ident": "FilePathDeltaAnnotation", + "$ref": "(resource) beta.threads.messages > (model) file_path_delta_annotation > (schema)" + } + ], + "oasRef": "#/components/schemas/MessageDeltaContentTextObject/properties/text/properties/annotations/items" }, "oasRef": "#/components/schemas/MessageDeltaContentTextObject/properties/text/properties/annotations" }, @@ -40519,8 +39898,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "schemaType": "array", "childrenParentSchema": "union", "children": [ - "(resource) beta.threads.messages > (model) annotation_delta > (schema) > (variant) 0", - "(resource) beta.threads.messages > (model) annotation_delta > (schema) > (variant) 1" + "(resource) beta.threads.messages > (model) text_delta > (schema) > (property) annotations > (items) > (variant) 0", + "(resource) beta.threads.messages > (model) text_delta > (schema) > (property) annotations > (items) > (variant) 1" ] }, "(resource) beta.threads.messages > (model) text_delta > (schema) > (property) value": { @@ -40666,7 +40045,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "literal": "high" } }, - "(resource) beta.threads.messages > (model) annotation_delta > (schema) > (variant) 0": { + "(resource) beta.threads.messages > (model) text_delta > (schema) > (property) annotations > (items) > (variant) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", @@ -40683,7 +40062,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.messages > (model) file_citation_delta_annotation > (schema) > (property) text" ] }, - "(resource) beta.threads.messages > (model) annotation_delta > (schema) > (variant) 1": { + "(resource) beta.threads.messages > (model) text_delta > (schema) > (property) annotations > (items) > (variant) 1": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", @@ -40700,31 +40079,80 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.messages > (model) file_path_delta_annotation > (schema) > (property) text" ] }, - "(resource) beta.threads.messages > (model) annotation_delta > (schema)": { + "(resource) beta.threads.messages > (model) file_citation_delta_annotation > (schema)": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/TextAnnotationDelta", - "ident": "AnnotationDelta", + "oasRef": "#/components/schemas/MessageDeltaContentTextAnnotationsFileCitationObject", + "ident": "FileCitationDeltaAnnotation", "type": { - "kind": "HttpTypeUnion", - "types": [ + "kind": "HttpTypeObject", + "members": [ { - "kind": "HttpTypeReference", - "ident": "FileCitationDeltaAnnotation", - "$ref": "(resource) beta.threads.messages > (model) file_citation_delta_annotation > (schema)" + "ident": "index" }, { - "kind": "HttpTypeReference", - "ident": "FilePathDeltaAnnotation", - "$ref": "(resource) beta.threads.messages > (model) file_path_delta_annotation > (schema)" + "ident": "type" + }, + { + "ident": "end_index" + }, + { + "ident": "file_citation" + }, + { + "ident": "start_index" + }, + { + "ident": "text" } - ], - "oasRef": "#/components/schemas/TextAnnotationDelta" + ] }, "docstring": "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.", - "childrenParentSchema": "union", + "childrenParentSchema": "object", + "children": [ + "(resource) beta.threads.messages > (model) file_citation_delta_annotation > (schema) > (property) index", + "(resource) beta.threads.messages > (model) file_citation_delta_annotation > (schema) > (property) type", + "(resource) beta.threads.messages > (model) file_citation_delta_annotation > (schema) > (property) end_index", + "(resource) beta.threads.messages > (model) file_citation_delta_annotation > (schema) > (property) file_citation", + "(resource) beta.threads.messages > (model) file_citation_delta_annotation > (schema) > (property) start_index", + "(resource) beta.threads.messages > (model) file_citation_delta_annotation > (schema) > (property) text" + ] + }, + "(resource) beta.threads.messages > (model) file_path_delta_annotation > (schema)": { + "kind": "HttpDeclTypeAlias", + "oasRef": "#/components/schemas/MessageDeltaContentTextAnnotationsFilePathObject", + "ident": "FilePathDeltaAnnotation", + "type": { + "kind": "HttpTypeObject", + "members": [ + { + "ident": "index" + }, + { + "ident": "type" + }, + { + "ident": "end_index" + }, + { + "ident": "file_path" + }, + { + "ident": "start_index" + }, + { + "ident": "text" + } + ] + }, + "docstring": "A URL for the file that's generated when the assistant used the `code_interpreter` tool to generate a file.", + "childrenParentSchema": "object", "children": [ - "(resource) beta.threads.messages > (model) annotation_delta > (schema) > (variant) 0", - "(resource) beta.threads.messages > (model) annotation_delta > (schema) > (variant) 1" + "(resource) beta.threads.messages > (model) file_path_delta_annotation > (schema) > (property) index", + "(resource) beta.threads.messages > (model) file_path_delta_annotation > (schema) > (property) type", + "(resource) beta.threads.messages > (model) file_path_delta_annotation > (schema) > (property) end_index", + "(resource) beta.threads.messages > (model) file_path_delta_annotation > (schema) > (property) file_path", + "(resource) beta.threads.messages > (model) file_path_delta_annotation > (schema) > (property) start_index", + "(resource) beta.threads.messages > (model) file_path_delta_annotation > (schema) > (property) text" ] }, "(resource) beta.threads.messages > (model) image_url_delta > (schema) > (property) detail > (member) 0": { @@ -40857,44 +40285,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "schemaType": "string", "children": [] }, - "(resource) beta.threads.messages > (model) file_citation_delta_annotation > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/MessageDeltaContentTextAnnotationsFileCitationObject", - "ident": "FileCitationDeltaAnnotation", - "type": { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "index" - }, - { - "ident": "type" - }, - { - "ident": "end_index" - }, - { - "ident": "file_citation" - }, - { - "ident": "start_index" - }, - { - "ident": "text" - } - ] - }, - "docstring": "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.", - "childrenParentSchema": "object", - "children": [ - "(resource) beta.threads.messages > (model) file_citation_delta_annotation > (schema) > (property) index", - "(resource) beta.threads.messages > (model) file_citation_delta_annotation > (schema) > (property) type", - "(resource) beta.threads.messages > (model) file_citation_delta_annotation > (schema) > (property) end_index", - "(resource) beta.threads.messages > (model) file_citation_delta_annotation > (schema) > (property) file_citation", - "(resource) beta.threads.messages > (model) file_citation_delta_annotation > (schema) > (property) start_index", - "(resource) beta.threads.messages > (model) file_citation_delta_annotation > (schema) > (property) text" - ] - }, "(resource) beta.threads.messages > (model) file_path_delta_annotation > (schema) > (property) index": { "kind": "HttpDeclProperty", "docstring": "The index of the annotation in the text content part.", @@ -41000,44 +40390,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "schemaType": "string", "children": [] }, - "(resource) beta.threads.messages > (model) file_path_delta_annotation > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/MessageDeltaContentTextAnnotationsFilePathObject", - "ident": "FilePathDeltaAnnotation", - "type": { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "index" - }, - { - "ident": "type" - }, - { - "ident": "end_index" - }, - { - "ident": "file_path" - }, - { - "ident": "start_index" - }, - { - "ident": "text" - } - ] - }, - "docstring": "A URL for the file that's generated when the assistant used the `code_interpreter` tool to generate a file.", - "childrenParentSchema": "object", - "children": [ - "(resource) beta.threads.messages > (model) file_path_delta_annotation > (schema) > (property) index", - "(resource) beta.threads.messages > (model) file_path_delta_annotation > (schema) > (property) type", - "(resource) beta.threads.messages > (model) file_path_delta_annotation > (schema) > (property) end_index", - "(resource) beta.threads.messages > (model) file_path_delta_annotation > (schema) > (property) file_path", - "(resource) beta.threads.messages > (model) file_path_delta_annotation > (schema) > (property) start_index", - "(resource) beta.threads.messages > (model) file_path_delta_annotation > (schema) > (property) text" - ] - }, "(resource) beta.threads.messages > (model) file_citation_delta_annotation > (schema) > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { @@ -41105,7 +40457,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch ## event -Occurs when a [message](https://platform.openai.com/docs/api-reference/messages/object) is completed. +Occurs when a [message](https://developers.openai.com/docs/api-reference/messages/object) is completed. ### Schema @@ -41115,8 +40467,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch { "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 21": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/MessageStreamEvent/anyOf/3", - "ident": "ThreadMessageCompleted", + "oasRef": "#/components/schemas/MessageStreamEvent/oneOf/3", + "ident": "UnionMember21", "type": { "kind": "HttpTypeObject", "members": [ @@ -41128,7 +40480,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Occurs when a [message](https://platform.openai.com/docs/api-reference/messages/object) is completed.", + "docstring": "Occurs when a [message](/docs/api-reference/messages/object) is completed.", "childrenParentSchema": "object", "children": [ "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 21 > (property) data", @@ -41138,7 +40490,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 21 > (property) data": { "kind": "HttpDeclProperty", "title": "The message object", - "docstring": "Represents a message within a [thread](https://platform.openai.com/docs/api-reference/threads).", + "docstring": "Represents a message within a [thread](/docs/api-reference/threads).", "key": "data", "optional": false, "nullable": false, @@ -41147,7 +40499,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "ident": "Message", "$ref": "(resource) beta.threads.messages > (model) message > (schema)" }, - "oasRef": "#/components/schemas/MessageStreamEvent/anyOf/3/properties/data", + "oasRef": "#/components/schemas/MessageStreamEvent/oneOf/3/properties/data", "deprecated": false, "schemaType": "object", "modelImplicit": false, @@ -41183,9 +40535,9 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "literal": "thread.message.completed" } ], - "oasRef": "#/components/schemas/MessageStreamEvent/anyOf/3/properties/event" + "oasRef": "#/components/schemas/MessageStreamEvent/oneOf/3/properties/event" }, - "oasRef": "#/components/schemas/MessageStreamEvent/anyOf/3/properties/event", + "oasRef": "#/components/schemas/MessageStreamEvent/oneOf/3/properties/event", "deprecated": false, "schemaType": "enum", "childrenParentSchema": "enum", @@ -41209,7 +40561,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) message > (schema) > (property) assistant_id": { "kind": "HttpDeclProperty", - "docstring": "If applicable, the ID of the [assistant](https://platform.openai.com/docs/api-reference/assistants) that authored this message.", + "docstring": "If applicable, the ID of the [assistant](/docs/api-reference/assistants) that authored this message.", "key": "assistant_id", "optional": false, "nullable": true, @@ -41277,9 +40629,30 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "type": { "kind": "HttpTypeArray", "elementType": { + "kind": "HttpTypeUnion", + "types": [ + { + "kind": "HttpTypeReference", + "ident": "ImageFileContentBlock", + "$ref": "(resource) beta.threads.messages > (model) image_file_content_block > (schema)" + }, + { "kind": "HttpTypeReference", - "ident": "MessageContent", - "$ref": "(resource) beta.threads.messages > (model) message_content > (schema)" + "ident": "ImageURLContentBlock", + "$ref": "(resource) beta.threads.messages > (model) image_url_content_block > (schema)" + }, + { + "kind": "HttpTypeReference", + "ident": "TextContentBlock", + "$ref": "(resource) beta.threads.messages > (model) text_content_block > (schema)" + }, + { + "kind": "HttpTypeReference", + "ident": "RefusalContentBlock", + "$ref": "(resource) beta.threads.messages > (model) refusal_content_block > (schema)" + } + ], + "oasRef": "#/components/schemas/MessageObject/properties/content/items" }, "oasRef": "#/components/schemas/MessageObject/properties/content" }, @@ -41288,10 +40661,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "schemaType": "array", "childrenParentSchema": "union", "children": [ - "(resource) beta.threads.messages > (model) message_content > (schema) > (variant) 0", - "(resource) beta.threads.messages > (model) message_content > (schema) > (variant) 1", - "(resource) beta.threads.messages > (model) message_content > (schema) > (variant) 2", - "(resource) beta.threads.messages > (model) message_content > (schema) > (variant) 3" + "(resource) beta.threads.messages > (model) message > (schema) > (property) content > (items) > (variant) 0", + "(resource) beta.threads.messages > (model) message > (schema) > (property) content > (items) > (variant) 1", + "(resource) beta.threads.messages > (model) message > (schema) > (property) content > (items) > (variant) 2", + "(resource) beta.threads.messages > (model) message > (schema) > (property) content > (items) > (variant) 3" ] }, "(resource) beta.threads.messages > (model) message > (schema) > (property) created_at": { @@ -41423,7 +40796,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) message > (schema) > (property) run_id": { "kind": "HttpDeclProperty", - "docstring": "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.", + "docstring": "The ID of the [run](/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.", "key": "run_id", "optional": false, "nullable": true, @@ -41471,7 +40844,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) message > (schema) > (property) thread_id": { "kind": "HttpDeclProperty", - "docstring": "The [thread](https://platform.openai.com/docs/api-reference/threads) ID that this message belongs to.", + "docstring": "The [thread](/docs/api-reference/threads) ID that this message belongs to.", "key": "thread_id", "optional": false, "nullable": false, @@ -41534,7 +40907,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Represents a message within a [thread](https://platform.openai.com/docs/api-reference/threads).", + "docstring": "Represents a message within a [thread](/docs/api-reference/threads).", "childrenParentSchema": "object", "children": [ "(resource) beta.threads.messages > (model) message > (schema) > (property) id", @@ -41612,7 +40985,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.messages > (model) message > (schema) > (property) attachments > (items) > (property) tools > (items) > (variant) 1" ] }, - "(resource) beta.threads.messages > (model) message_content > (schema) > (variant) 0": { + "(resource) beta.threads.messages > (model) message > (schema) > (property) content > (items) > (variant) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", @@ -41625,7 +40998,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.messages > (model) image_file_content_block > (schema) > (property) type" ] }, - "(resource) beta.threads.messages > (model) message_content > (schema) > (variant) 1": { + "(resource) beta.threads.messages > (model) message > (schema) > (property) content > (items) > (variant) 1": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", @@ -41638,7 +41011,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.messages > (model) image_url_content_block > (schema) > (property) type" ] }, - "(resource) beta.threads.messages > (model) message_content > (schema) > (variant) 2": { + "(resource) beta.threads.messages > (model) message > (schema) > (property) content > (items) > (variant) 2": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", @@ -41651,7 +41024,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.messages > (model) text_content_block > (schema) > (property) type" ] }, - "(resource) beta.threads.messages > (model) message_content > (schema) > (variant) 3": { + "(resource) beta.threads.messages > (model) message > (schema) > (property) content > (items) > (variant) 3": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", @@ -41664,43 +41037,92 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.messages > (model) refusal_content_block > (schema) > (property) type" ] }, - "(resource) beta.threads.messages > (model) message_content > (schema)": { + "(resource) beta.threads.messages > (model) image_file_content_block > (schema)": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/MessageContent", - "ident": "MessageContent", + "oasRef": "#/components/schemas/MessageContentImageFileObject", + "ident": "ImageFileContentBlock", "type": { - "kind": "HttpTypeUnion", - "types": [ + "kind": "HttpTypeObject", + "members": [ { - "kind": "HttpTypeReference", - "ident": "ImageFileContentBlock", - "$ref": "(resource) beta.threads.messages > (model) image_file_content_block > (schema)" + "ident": "image_file" }, { - "kind": "HttpTypeReference", + "ident": "type" + } + ] + }, + "docstring": "References an image [File](/docs/api-reference/files) in the content of a message.", + "childrenParentSchema": "object", + "children": [ + "(resource) beta.threads.messages > (model) image_file_content_block > (schema) > (property) image_file", + "(resource) beta.threads.messages > (model) image_file_content_block > (schema) > (property) type" + ] + }, + "(resource) beta.threads.messages > (model) image_url_content_block > (schema)": { + "kind": "HttpDeclTypeAlias", + "oasRef": "#/components/schemas/MessageContentImageUrlObject", "ident": "ImageURLContentBlock", - "$ref": "(resource) beta.threads.messages > (model) image_url_content_block > (schema)" + "type": { + "kind": "HttpTypeObject", + "members": [ + { + "ident": "image_url" }, { - "kind": "HttpTypeReference", + "ident": "type" + } + ] + }, + "docstring": "References an image URL in the content of a message.", + "childrenParentSchema": "object", + "children": [ + "(resource) beta.threads.messages > (model) image_url_content_block > (schema) > (property) image_url", + "(resource) beta.threads.messages > (model) image_url_content_block > (schema) > (property) type" + ] + }, + "(resource) beta.threads.messages > (model) text_content_block > (schema)": { + "kind": "HttpDeclTypeAlias", + "oasRef": "#/components/schemas/MessageContentTextObject", "ident": "TextContentBlock", - "$ref": "(resource) beta.threads.messages > (model) text_content_block > (schema)" + "type": { + "kind": "HttpTypeObject", + "members": [ + { + "ident": "text" }, { - "kind": "HttpTypeReference", + "ident": "type" + } + ] + }, + "docstring": "The text content that is part of a message.", + "childrenParentSchema": "object", + "children": [ + "(resource) beta.threads.messages > (model) text_content_block > (schema) > (property) text", + "(resource) beta.threads.messages > (model) text_content_block > (schema) > (property) type" + ] + }, + "(resource) beta.threads.messages > (model) refusal_content_block > (schema)": { + "kind": "HttpDeclTypeAlias", + "oasRef": "#/components/schemas/MessageContentRefusalObject", "ident": "RefusalContentBlock", - "$ref": "(resource) beta.threads.messages > (model) refusal_content_block > (schema)" + "type": { + "kind": "HttpTypeObject", + "members": [ + { + "ident": "refusal" + }, + { + "ident": "type" } - ], - "oasRef": "#/components/schemas/MessageContent" + ] }, - "docstring": "References an image [File](https://platform.openai.com/docs/api-reference/files) in the content of a message.", - "childrenParentSchema": "union", + "docstring": "The refusal content generated by the assistant.", + "childrenParentSchema": "object", "children": [ - "(resource) beta.threads.messages > (model) message_content > (schema) > (variant) 0", - "(resource) beta.threads.messages > (model) message_content > (schema) > (variant) 1", - "(resource) beta.threads.messages > (model) message_content > (schema) > (variant) 2", - "(resource) beta.threads.messages > (model) message_content > (schema) > (variant) 3" + "(resource) beta.threads.messages > (model) refusal_content_block > (schema) > (property) refusal", + "(resource) beta.threads.messages > (model) refusal_content_block > (schema) > (property) type" ] }, "(resource) beta.threads.messages > (model) message > (schema) > (property) incomplete_details > (property) reason": { @@ -41823,8 +41245,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) message > (schema) > (property) attachments > (items) > (property) tools > (items) > (variant) 1": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/MessageObject/properties/attachments/anyOf/0/items/properties/tools/items/anyOf/1", - "ident": "AssistantToolsFileSearchTypeOnly", + "oasRef": "#/components/schemas/MessageObject/properties/attachments/anyOf/0/items/properties/tools/items/oneOf/1", + "ident": "FileSearchTool", "type": { "kind": "HttpTypeObject", "members": [ @@ -41900,28 +41322,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.messages > (model) image_file_content_block > (schema) > (property) type > (member) 0" ] }, - "(resource) beta.threads.messages > (model) image_file_content_block > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/MessageContentImageFileObject", - "ident": "ImageFileContentBlock", - "type": { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "image_file" - }, - { - "ident": "type" - } - ] - }, - "docstring": "References an image [File](https://platform.openai.com/docs/api-reference/files) in the content of a message.", - "childrenParentSchema": "object", - "children": [ - "(resource) beta.threads.messages > (model) image_file_content_block > (schema) > (property) image_file", - "(resource) beta.threads.messages > (model) image_file_content_block > (schema) > (property) type" - ] - }, "(resource) beta.threads.messages > (model) image_url_content_block > (schema) > (property) image_url": { "kind": "HttpDeclProperty", "key": "image_url", @@ -41967,28 +41367,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.messages > (model) image_url_content_block > (schema) > (property) type > (member) 0" ] }, - "(resource) beta.threads.messages > (model) image_url_content_block > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/MessageContentImageUrlObject", - "ident": "ImageURLContentBlock", - "type": { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "image_url" - }, - { - "ident": "type" - } - ] - }, - "docstring": "References an image URL in the content of a message.", - "childrenParentSchema": "object", - "children": [ - "(resource) beta.threads.messages > (model) image_url_content_block > (schema) > (property) image_url", - "(resource) beta.threads.messages > (model) image_url_content_block > (schema) > (property) type" - ] - }, "(resource) beta.threads.messages > (model) text_content_block > (schema) > (property) text": { "kind": "HttpDeclProperty", "key": "text", @@ -42034,28 +41412,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.messages > (model) text_content_block > (schema) > (property) type > (member) 0" ] }, - "(resource) beta.threads.messages > (model) text_content_block > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/MessageContentTextObject", - "ident": "TextContentBlock", - "type": { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "text" - }, - { - "ident": "type" - } - ] - }, - "docstring": "The text content that is part of a message.", - "childrenParentSchema": "object", - "children": [ - "(resource) beta.threads.messages > (model) text_content_block > (schema) > (property) text", - "(resource) beta.threads.messages > (model) text_content_block > (schema) > (property) type" - ] - }, "(resource) beta.threads.messages > (model) refusal_content_block > (schema) > (property) refusal": { "kind": "HttpDeclProperty", "key": "refusal", @@ -42093,28 +41449,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.messages > (model) refusal_content_block > (schema) > (property) type > (member) 0" ] }, - "(resource) beta.threads.messages > (model) refusal_content_block > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/MessageContentRefusalObject", - "ident": "RefusalContentBlock", - "type": { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "refusal" - }, - { - "ident": "type" - } - ] - }, - "docstring": "The refusal content generated by the assistant.", - "childrenParentSchema": "object", - "children": [ - "(resource) beta.threads.messages > (model) refusal_content_block > (schema) > (property) refusal", - "(resource) beta.threads.messages > (model) refusal_content_block > (schema) > (property) type" - ] - }, "(resource) beta.threads.messages > (model) message > (schema) > (property) incomplete_details > (property) reason > (member) 0": { "kind": "HttpDeclReference", "type": { @@ -42200,7 +41534,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) image_file > (schema) > (property) file_id": { "kind": "HttpDeclProperty", - "docstring": "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.", + "docstring": "The [File](/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.", "key": "file_id", "optional": false, "nullable": false, @@ -42363,9 +41697,20 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "type": { "kind": "HttpTypeArray", "elementType": { + "kind": "HttpTypeUnion", + "types": [ + { "kind": "HttpTypeReference", - "ident": "Annotation", - "$ref": "(resource) beta.threads.messages > (model) annotation > (schema)" + "ident": "FileCitationAnnotation", + "$ref": "(resource) beta.threads.messages > (model) file_citation_annotation > (schema)" + }, + { + "kind": "HttpTypeReference", + "ident": "FilePathAnnotation", + "$ref": "(resource) beta.threads.messages > (model) file_path_annotation > (schema)" + } + ], + "oasRef": "#/components/schemas/MessageContentTextObject/properties/text/properties/annotations/items" }, "oasRef": "#/components/schemas/MessageContentTextObject/properties/text/properties/annotations" }, @@ -42374,8 +41719,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "schemaType": "array", "childrenParentSchema": "union", "children": [ - "(resource) beta.threads.messages > (model) annotation > (schema) > (variant) 0", - "(resource) beta.threads.messages > (model) annotation > (schema) > (variant) 1" + "(resource) beta.threads.messages > (model) text > (schema) > (property) annotations > (items) > (variant) 0", + "(resource) beta.threads.messages > (model) text > (schema) > (property) annotations > (items) > (variant) 1" ] }, "(resource) beta.threads.messages > (model) text > (schema) > (property) value": { @@ -42483,7 +41828,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "literal": "high" } }, - "(resource) beta.threads.messages > (model) annotation > (schema) > (variant) 0": { + "(resource) beta.threads.messages > (model) text > (schema) > (property) annotations > (items) > (variant) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", @@ -42499,7 +41844,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) type" ] }, - "(resource) beta.threads.messages > (model) annotation > (schema) > (variant) 1": { + "(resource) beta.threads.messages > (model) text > (schema) > (property) annotations > (items) > (variant) 1": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", @@ -42515,31 +41860,72 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) type" ] }, - "(resource) beta.threads.messages > (model) annotation > (schema)": { + "(resource) beta.threads.messages > (model) file_citation_annotation > (schema)": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/TextAnnotation", - "ident": "Annotation", + "oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject", + "ident": "FileCitationAnnotation", "type": { - "kind": "HttpTypeUnion", - "types": [ + "kind": "HttpTypeObject", + "members": [ { - "kind": "HttpTypeReference", - "ident": "FileCitationAnnotation", - "$ref": "(resource) beta.threads.messages > (model) file_citation_annotation > (schema)" + "ident": "end_index" }, { - "kind": "HttpTypeReference", - "ident": "FilePathAnnotation", - "$ref": "(resource) beta.threads.messages > (model) file_path_annotation > (schema)" + "ident": "file_citation" + }, + { + "ident": "start_index" + }, + { + "ident": "text" + }, + { + "ident": "type" } - ], - "oasRef": "#/components/schemas/TextAnnotation" + ] }, "docstring": "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.", - "childrenParentSchema": "union", + "childrenParentSchema": "object", "children": [ - "(resource) beta.threads.messages > (model) annotation > (schema) > (variant) 0", - "(resource) beta.threads.messages > (model) annotation > (schema) > (variant) 1" + "(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) end_index", + "(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) file_citation", + "(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) start_index", + "(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) text", + "(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) type" + ] + }, + "(resource) beta.threads.messages > (model) file_path_annotation > (schema)": { + "kind": "HttpDeclTypeAlias", + "oasRef": "#/components/schemas/MessageContentTextAnnotationsFilePathObject", + "ident": "FilePathAnnotation", + "type": { + "kind": "HttpTypeObject", + "members": [ + { + "ident": "end_index" + }, + { + "ident": "file_path" + }, + { + "ident": "start_index" + }, + { + "ident": "text" + }, + { + "ident": "type" + } + ] + }, + "docstring": "A URL for the file that's generated when the assistant used the `code_interpreter` tool to generate a file.", + "childrenParentSchema": "object", + "children": [ + "(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) end_index", + "(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) file_path", + "(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) start_index", + "(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) text", + "(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) type" ] }, "(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) end_index": { @@ -42633,40 +42019,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) type > (member) 0" ] }, - "(resource) beta.threads.messages > (model) file_citation_annotation > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject", - "ident": "FileCitationAnnotation", - "type": { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "end_index" - }, - { - "ident": "file_citation" - }, - { - "ident": "start_index" - }, - { - "ident": "text" - }, - { - "ident": "type" - } - ] - }, - "docstring": "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.", - "childrenParentSchema": "object", - "children": [ - "(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) end_index", - "(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) file_citation", - "(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) start_index", - "(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) text", - "(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) type" - ] - }, "(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) end_index": { "kind": "HttpDeclProperty", "key": "end_index", @@ -42758,40 +42110,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) type > (member) 0" ] }, - "(resource) beta.threads.messages > (model) file_path_annotation > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/MessageContentTextAnnotationsFilePathObject", - "ident": "FilePathAnnotation", - "type": { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "end_index" - }, - { - "ident": "file_path" - }, - { - "ident": "start_index" - }, - { - "ident": "text" - }, - { - "ident": "type" - } - ] - }, - "docstring": "A URL for the file that's generated when the assistant used the `code_interpreter` tool to generate a file.", - "childrenParentSchema": "object", - "children": [ - "(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) end_index", - "(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) file_path", - "(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) start_index", - "(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) text", - "(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) type" - ] - }, "(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) file_citation > (property) file_id": { "kind": "HttpDeclProperty", "docstring": "The ID of the specific File the citation is from.", @@ -42845,7 +42163,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch ## event -Occurs when a [message](https://platform.openai.com/docs/api-reference/messages/object) ends before it is completed. +Occurs when a [message](https://developers.openai.com/docs/api-reference/messages/object) ends before it is completed. ### Schema @@ -42855,8 +42173,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch { "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 22": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/MessageStreamEvent/anyOf/4", - "ident": "ThreadMessageIncomplete", + "oasRef": "#/components/schemas/MessageStreamEvent/oneOf/4", + "ident": "UnionMember22", "type": { "kind": "HttpTypeObject", "members": [ @@ -42868,7 +42186,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Occurs when a [message](https://platform.openai.com/docs/api-reference/messages/object) ends before it is completed.", + "docstring": "Occurs when a [message](/docs/api-reference/messages/object) ends before it is completed.", "childrenParentSchema": "object", "children": [ "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 22 > (property) data", @@ -42878,7 +42196,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 22 > (property) data": { "kind": "HttpDeclProperty", "title": "The message object", - "docstring": "Represents a message within a [thread](https://platform.openai.com/docs/api-reference/threads).", + "docstring": "Represents a message within a [thread](/docs/api-reference/threads).", "key": "data", "optional": false, "nullable": false, @@ -42887,7 +42205,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "ident": "Message", "$ref": "(resource) beta.threads.messages > (model) message > (schema)" }, - "oasRef": "#/components/schemas/MessageStreamEvent/anyOf/4/properties/data", + "oasRef": "#/components/schemas/MessageStreamEvent/oneOf/4/properties/data", "deprecated": false, "schemaType": "object", "modelImplicit": false, @@ -42923,9 +42241,9 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "literal": "thread.message.incomplete" } ], - "oasRef": "#/components/schemas/MessageStreamEvent/anyOf/4/properties/event" + "oasRef": "#/components/schemas/MessageStreamEvent/oneOf/4/properties/event" }, - "oasRef": "#/components/schemas/MessageStreamEvent/anyOf/4/properties/event", + "oasRef": "#/components/schemas/MessageStreamEvent/oneOf/4/properties/event", "deprecated": false, "schemaType": "enum", "childrenParentSchema": "enum", @@ -42949,7 +42267,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) message > (schema) > (property) assistant_id": { "kind": "HttpDeclProperty", - "docstring": "If applicable, the ID of the [assistant](https://platform.openai.com/docs/api-reference/assistants) that authored this message.", + "docstring": "If applicable, the ID of the [assistant](/docs/api-reference/assistants) that authored this message.", "key": "assistant_id", "optional": false, "nullable": true, @@ -43017,9 +42335,30 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "type": { "kind": "HttpTypeArray", "elementType": { + "kind": "HttpTypeUnion", + "types": [ + { + "kind": "HttpTypeReference", + "ident": "ImageFileContentBlock", + "$ref": "(resource) beta.threads.messages > (model) image_file_content_block > (schema)" + }, + { + "kind": "HttpTypeReference", + "ident": "ImageURLContentBlock", + "$ref": "(resource) beta.threads.messages > (model) image_url_content_block > (schema)" + }, + { + "kind": "HttpTypeReference", + "ident": "TextContentBlock", + "$ref": "(resource) beta.threads.messages > (model) text_content_block > (schema)" + }, + { "kind": "HttpTypeReference", - "ident": "MessageContent", - "$ref": "(resource) beta.threads.messages > (model) message_content > (schema)" + "ident": "RefusalContentBlock", + "$ref": "(resource) beta.threads.messages > (model) refusal_content_block > (schema)" + } + ], + "oasRef": "#/components/schemas/MessageObject/properties/content/items" }, "oasRef": "#/components/schemas/MessageObject/properties/content" }, @@ -43028,10 +42367,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "schemaType": "array", "childrenParentSchema": "union", "children": [ - "(resource) beta.threads.messages > (model) message_content > (schema) > (variant) 0", - "(resource) beta.threads.messages > (model) message_content > (schema) > (variant) 1", - "(resource) beta.threads.messages > (model) message_content > (schema) > (variant) 2", - "(resource) beta.threads.messages > (model) message_content > (schema) > (variant) 3" + "(resource) beta.threads.messages > (model) message > (schema) > (property) content > (items) > (variant) 0", + "(resource) beta.threads.messages > (model) message > (schema) > (property) content > (items) > (variant) 1", + "(resource) beta.threads.messages > (model) message > (schema) > (property) content > (items) > (variant) 2", + "(resource) beta.threads.messages > (model) message > (schema) > (property) content > (items) > (variant) 3" ] }, "(resource) beta.threads.messages > (model) message > (schema) > (property) created_at": { @@ -43163,7 +42502,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) message > (schema) > (property) run_id": { "kind": "HttpDeclProperty", - "docstring": "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.", + "docstring": "The ID of the [run](/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.", "key": "run_id", "optional": false, "nullable": true, @@ -43211,7 +42550,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) message > (schema) > (property) thread_id": { "kind": "HttpDeclProperty", - "docstring": "The [thread](https://platform.openai.com/docs/api-reference/threads) ID that this message belongs to.", + "docstring": "The [thread](/docs/api-reference/threads) ID that this message belongs to.", "key": "thread_id", "optional": false, "nullable": false, @@ -43274,7 +42613,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Represents a message within a [thread](https://platform.openai.com/docs/api-reference/threads).", + "docstring": "Represents a message within a [thread](/docs/api-reference/threads).", "childrenParentSchema": "object", "children": [ "(resource) beta.threads.messages > (model) message > (schema) > (property) id", @@ -43352,7 +42691,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.messages > (model) message > (schema) > (property) attachments > (items) > (property) tools > (items) > (variant) 1" ] }, - "(resource) beta.threads.messages > (model) message_content > (schema) > (variant) 0": { + "(resource) beta.threads.messages > (model) message > (schema) > (property) content > (items) > (variant) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", @@ -43365,7 +42704,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.messages > (model) image_file_content_block > (schema) > (property) type" ] }, - "(resource) beta.threads.messages > (model) message_content > (schema) > (variant) 1": { + "(resource) beta.threads.messages > (model) message > (schema) > (property) content > (items) > (variant) 1": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", @@ -43378,7 +42717,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.messages > (model) image_url_content_block > (schema) > (property) type" ] }, - "(resource) beta.threads.messages > (model) message_content > (schema) > (variant) 2": { + "(resource) beta.threads.messages > (model) message > (schema) > (property) content > (items) > (variant) 2": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", @@ -43391,7 +42730,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.messages > (model) text_content_block > (schema) > (property) type" ] }, - "(resource) beta.threads.messages > (model) message_content > (schema) > (variant) 3": { + "(resource) beta.threads.messages > (model) message > (schema) > (property) content > (items) > (variant) 3": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", @@ -43404,43 +42743,92 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.messages > (model) refusal_content_block > (schema) > (property) type" ] }, - "(resource) beta.threads.messages > (model) message_content > (schema)": { + "(resource) beta.threads.messages > (model) image_file_content_block > (schema)": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/MessageContent", - "ident": "MessageContent", + "oasRef": "#/components/schemas/MessageContentImageFileObject", + "ident": "ImageFileContentBlock", "type": { - "kind": "HttpTypeUnion", - "types": [ + "kind": "HttpTypeObject", + "members": [ { - "kind": "HttpTypeReference", - "ident": "ImageFileContentBlock", - "$ref": "(resource) beta.threads.messages > (model) image_file_content_block > (schema)" + "ident": "image_file" }, { - "kind": "HttpTypeReference", + "ident": "type" + } + ] + }, + "docstring": "References an image [File](/docs/api-reference/files) in the content of a message.", + "childrenParentSchema": "object", + "children": [ + "(resource) beta.threads.messages > (model) image_file_content_block > (schema) > (property) image_file", + "(resource) beta.threads.messages > (model) image_file_content_block > (schema) > (property) type" + ] + }, + "(resource) beta.threads.messages > (model) image_url_content_block > (schema)": { + "kind": "HttpDeclTypeAlias", + "oasRef": "#/components/schemas/MessageContentImageUrlObject", "ident": "ImageURLContentBlock", - "$ref": "(resource) beta.threads.messages > (model) image_url_content_block > (schema)" + "type": { + "kind": "HttpTypeObject", + "members": [ + { + "ident": "image_url" }, { - "kind": "HttpTypeReference", + "ident": "type" + } + ] + }, + "docstring": "References an image URL in the content of a message.", + "childrenParentSchema": "object", + "children": [ + "(resource) beta.threads.messages > (model) image_url_content_block > (schema) > (property) image_url", + "(resource) beta.threads.messages > (model) image_url_content_block > (schema) > (property) type" + ] + }, + "(resource) beta.threads.messages > (model) text_content_block > (schema)": { + "kind": "HttpDeclTypeAlias", + "oasRef": "#/components/schemas/MessageContentTextObject", "ident": "TextContentBlock", - "$ref": "(resource) beta.threads.messages > (model) text_content_block > (schema)" + "type": { + "kind": "HttpTypeObject", + "members": [ + { + "ident": "text" }, { - "kind": "HttpTypeReference", + "ident": "type" + } + ] + }, + "docstring": "The text content that is part of a message.", + "childrenParentSchema": "object", + "children": [ + "(resource) beta.threads.messages > (model) text_content_block > (schema) > (property) text", + "(resource) beta.threads.messages > (model) text_content_block > (schema) > (property) type" + ] + }, + "(resource) beta.threads.messages > (model) refusal_content_block > (schema)": { + "kind": "HttpDeclTypeAlias", + "oasRef": "#/components/schemas/MessageContentRefusalObject", "ident": "RefusalContentBlock", - "$ref": "(resource) beta.threads.messages > (model) refusal_content_block > (schema)" + "type": { + "kind": "HttpTypeObject", + "members": [ + { + "ident": "refusal" + }, + { + "ident": "type" } - ], - "oasRef": "#/components/schemas/MessageContent" + ] }, - "docstring": "References an image [File](https://platform.openai.com/docs/api-reference/files) in the content of a message.", - "childrenParentSchema": "union", + "docstring": "The refusal content generated by the assistant.", + "childrenParentSchema": "object", "children": [ - "(resource) beta.threads.messages > (model) message_content > (schema) > (variant) 0", - "(resource) beta.threads.messages > (model) message_content > (schema) > (variant) 1", - "(resource) beta.threads.messages > (model) message_content > (schema) > (variant) 2", - "(resource) beta.threads.messages > (model) message_content > (schema) > (variant) 3" + "(resource) beta.threads.messages > (model) refusal_content_block > (schema) > (property) refusal", + "(resource) beta.threads.messages > (model) refusal_content_block > (schema) > (property) type" ] }, "(resource) beta.threads.messages > (model) message > (schema) > (property) incomplete_details > (property) reason": { @@ -43563,8 +42951,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) message > (schema) > (property) attachments > (items) > (property) tools > (items) > (variant) 1": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/MessageObject/properties/attachments/anyOf/0/items/properties/tools/items/anyOf/1", - "ident": "AssistantToolsFileSearchTypeOnly", + "oasRef": "#/components/schemas/MessageObject/properties/attachments/anyOf/0/items/properties/tools/items/oneOf/1", + "ident": "FileSearchTool", "type": { "kind": "HttpTypeObject", "members": [ @@ -43640,28 +43028,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.messages > (model) image_file_content_block > (schema) > (property) type > (member) 0" ] }, - "(resource) beta.threads.messages > (model) image_file_content_block > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/MessageContentImageFileObject", - "ident": "ImageFileContentBlock", - "type": { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "image_file" - }, - { - "ident": "type" - } - ] - }, - "docstring": "References an image [File](https://platform.openai.com/docs/api-reference/files) in the content of a message.", - "childrenParentSchema": "object", - "children": [ - "(resource) beta.threads.messages > (model) image_file_content_block > (schema) > (property) image_file", - "(resource) beta.threads.messages > (model) image_file_content_block > (schema) > (property) type" - ] - }, "(resource) beta.threads.messages > (model) image_url_content_block > (schema) > (property) image_url": { "kind": "HttpDeclProperty", "key": "image_url", @@ -43707,28 +43073,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.messages > (model) image_url_content_block > (schema) > (property) type > (member) 0" ] }, - "(resource) beta.threads.messages > (model) image_url_content_block > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/MessageContentImageUrlObject", - "ident": "ImageURLContentBlock", - "type": { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "image_url" - }, - { - "ident": "type" - } - ] - }, - "docstring": "References an image URL in the content of a message.", - "childrenParentSchema": "object", - "children": [ - "(resource) beta.threads.messages > (model) image_url_content_block > (schema) > (property) image_url", - "(resource) beta.threads.messages > (model) image_url_content_block > (schema) > (property) type" - ] - }, "(resource) beta.threads.messages > (model) text_content_block > (schema) > (property) text": { "kind": "HttpDeclProperty", "key": "text", @@ -43774,28 +43118,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.messages > (model) text_content_block > (schema) > (property) type > (member) 0" ] }, - "(resource) beta.threads.messages > (model) text_content_block > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/MessageContentTextObject", - "ident": "TextContentBlock", - "type": { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "text" - }, - { - "ident": "type" - } - ] - }, - "docstring": "The text content that is part of a message.", - "childrenParentSchema": "object", - "children": [ - "(resource) beta.threads.messages > (model) text_content_block > (schema) > (property) text", - "(resource) beta.threads.messages > (model) text_content_block > (schema) > (property) type" - ] - }, "(resource) beta.threads.messages > (model) refusal_content_block > (schema) > (property) refusal": { "kind": "HttpDeclProperty", "key": "refusal", @@ -43833,28 +43155,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.messages > (model) refusal_content_block > (schema) > (property) type > (member) 0" ] }, - "(resource) beta.threads.messages > (model) refusal_content_block > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/MessageContentRefusalObject", - "ident": "RefusalContentBlock", - "type": { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "refusal" - }, - { - "ident": "type" - } - ] - }, - "docstring": "The refusal content generated by the assistant.", - "childrenParentSchema": "object", - "children": [ - "(resource) beta.threads.messages > (model) refusal_content_block > (schema) > (property) refusal", - "(resource) beta.threads.messages > (model) refusal_content_block > (schema) > (property) type" - ] - }, "(resource) beta.threads.messages > (model) message > (schema) > (property) incomplete_details > (property) reason > (member) 0": { "kind": "HttpDeclReference", "type": { @@ -43940,7 +43240,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) image_file > (schema) > (property) file_id": { "kind": "HttpDeclProperty", - "docstring": "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.", + "docstring": "The [File](/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.", "key": "file_id", "optional": false, "nullable": false, @@ -44103,9 +43403,20 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "type": { "kind": "HttpTypeArray", "elementType": { + "kind": "HttpTypeUnion", + "types": [ + { + "kind": "HttpTypeReference", + "ident": "FileCitationAnnotation", + "$ref": "(resource) beta.threads.messages > (model) file_citation_annotation > (schema)" + }, + { "kind": "HttpTypeReference", - "ident": "Annotation", - "$ref": "(resource) beta.threads.messages > (model) annotation > (schema)" + "ident": "FilePathAnnotation", + "$ref": "(resource) beta.threads.messages > (model) file_path_annotation > (schema)" + } + ], + "oasRef": "#/components/schemas/MessageContentTextObject/properties/text/properties/annotations/items" }, "oasRef": "#/components/schemas/MessageContentTextObject/properties/text/properties/annotations" }, @@ -44114,8 +43425,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "schemaType": "array", "childrenParentSchema": "union", "children": [ - "(resource) beta.threads.messages > (model) annotation > (schema) > (variant) 0", - "(resource) beta.threads.messages > (model) annotation > (schema) > (variant) 1" + "(resource) beta.threads.messages > (model) text > (schema) > (property) annotations > (items) > (variant) 0", + "(resource) beta.threads.messages > (model) text > (schema) > (property) annotations > (items) > (variant) 1" ] }, "(resource) beta.threads.messages > (model) text > (schema) > (property) value": { @@ -44223,7 +43534,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "literal": "high" } }, - "(resource) beta.threads.messages > (model) annotation > (schema) > (variant) 0": { + "(resource) beta.threads.messages > (model) text > (schema) > (property) annotations > (items) > (variant) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", @@ -44239,7 +43550,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) type" ] }, - "(resource) beta.threads.messages > (model) annotation > (schema) > (variant) 1": { + "(resource) beta.threads.messages > (model) text > (schema) > (property) annotations > (items) > (variant) 1": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", @@ -44255,31 +43566,72 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) type" ] }, - "(resource) beta.threads.messages > (model) annotation > (schema)": { + "(resource) beta.threads.messages > (model) file_citation_annotation > (schema)": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/TextAnnotation", - "ident": "Annotation", + "oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject", + "ident": "FileCitationAnnotation", "type": { - "kind": "HttpTypeUnion", - "types": [ + "kind": "HttpTypeObject", + "members": [ { - "kind": "HttpTypeReference", - "ident": "FileCitationAnnotation", - "$ref": "(resource) beta.threads.messages > (model) file_citation_annotation > (schema)" + "ident": "end_index" }, { - "kind": "HttpTypeReference", - "ident": "FilePathAnnotation", - "$ref": "(resource) beta.threads.messages > (model) file_path_annotation > (schema)" + "ident": "file_citation" + }, + { + "ident": "start_index" + }, + { + "ident": "text" + }, + { + "ident": "type" } - ], - "oasRef": "#/components/schemas/TextAnnotation" + ] }, "docstring": "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.", - "childrenParentSchema": "union", + "childrenParentSchema": "object", "children": [ - "(resource) beta.threads.messages > (model) annotation > (schema) > (variant) 0", - "(resource) beta.threads.messages > (model) annotation > (schema) > (variant) 1" + "(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) end_index", + "(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) file_citation", + "(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) start_index", + "(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) text", + "(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) type" + ] + }, + "(resource) beta.threads.messages > (model) file_path_annotation > (schema)": { + "kind": "HttpDeclTypeAlias", + "oasRef": "#/components/schemas/MessageContentTextAnnotationsFilePathObject", + "ident": "FilePathAnnotation", + "type": { + "kind": "HttpTypeObject", + "members": [ + { + "ident": "end_index" + }, + { + "ident": "file_path" + }, + { + "ident": "start_index" + }, + { + "ident": "text" + }, + { + "ident": "type" + } + ] + }, + "docstring": "A URL for the file that's generated when the assistant used the `code_interpreter` tool to generate a file.", + "childrenParentSchema": "object", + "children": [ + "(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) end_index", + "(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) file_path", + "(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) start_index", + "(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) text", + "(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) type" ] }, "(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) end_index": { @@ -44373,40 +43725,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) type > (member) 0" ] }, - "(resource) beta.threads.messages > (model) file_citation_annotation > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject", - "ident": "FileCitationAnnotation", - "type": { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "end_index" - }, - { - "ident": "file_citation" - }, - { - "ident": "start_index" - }, - { - "ident": "text" - }, - { - "ident": "type" - } - ] - }, - "docstring": "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.", - "childrenParentSchema": "object", - "children": [ - "(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) end_index", - "(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) file_citation", - "(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) start_index", - "(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) text", - "(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) type" - ] - }, "(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) end_index": { "kind": "HttpDeclProperty", "key": "end_index", @@ -44498,40 +43816,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) type > (member) 0" ] }, - "(resource) beta.threads.messages > (model) file_path_annotation > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/MessageContentTextAnnotationsFilePathObject", - "ident": "FilePathAnnotation", - "type": { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "end_index" - }, - { - "ident": "file_path" - }, - { - "ident": "start_index" - }, - { - "ident": "text" - }, - { - "ident": "type" - } - ] - }, - "docstring": "A URL for the file that's generated when the assistant used the `code_interpreter` tool to generate a file.", - "childrenParentSchema": "object", - "children": [ - "(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) end_index", - "(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) file_path", - "(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) start_index", - "(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) text", - "(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) type" - ] - }, "(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) file_citation > (property) file_id": { "kind": "HttpDeclProperty", "docstring": "The ID of the specific File the citation is from.", @@ -44585,7 +43869,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch ## event -Occurs when an [error](https://platform.openai.com/docs/guides/error-codes#api-errors) occurs. This can happen due to an internal server error or a timeout. +Occurs when an [error](https://developers.openai.com/docs/guides/error-codes#api-errors) occurs. This can happen due to an internal server error or a timeout. ### Schema @@ -44595,7 +43879,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch { "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 23": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/AssistantStreamEvent/anyOf/4", + "oasRef": "#/components/schemas/AssistantStreamEvent/oneOf/4", "ident": "ErrorEvent", "type": { "kind": "HttpTypeObject", @@ -44608,7 +43892,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Occurs when an [error](https://platform.openai.com/docs/guides/error-codes#api-errors) occurs. This can happen due to an internal server error or a timeout.", + "docstring": "Occurs when an [error](/docs/guides/error-codes#api-errors) occurs. This can happen due to an internal server error or a timeout.", "childrenParentSchema": "object", "children": [ "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 23 > (property) data", @@ -44757,3 +44041,104 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch ```json {} ``` + +## event + +Occurs when a stream ends. + +### Schema + +Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 24` + +```json +{ + "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 24": { + "kind": "HttpDeclTypeAlias", + "oasRef": "#/components/schemas/AssistantStreamEvent/oneOf/5", + "ident": "DoneEvent", + "type": { + "kind": "HttpTypeObject", + "members": [ + { + "ident": "data" + }, + { + "ident": "event" + } + ] + }, + "docstring": "Occurs when a stream ends.", + "childrenParentSchema": "object", + "children": [ + "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 24 > (property) data", + "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 24 > (property) event" + ] + }, + "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 24 > (property) data": { + "kind": "HttpDeclProperty", + "key": "data", + "optional": false, + "nullable": false, + "type": { + "kind": "HttpTypeUnion", + "types": [ + { + "kind": "HttpTypeLiteral", + "literal": "[DONE]" + } + ], + "oasRef": "#/components/schemas/DoneEvent/properties/data" + }, + "oasRef": "#/components/schemas/DoneEvent/properties/data", + "deprecated": false, + "schemaType": "enum", + "childrenParentSchema": "enum", + "children": [ + "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 24 > (property) data > (member) 0" + ] + }, + "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 24 > (property) event": { + "kind": "HttpDeclProperty", + "key": "event", + "optional": false, + "nullable": false, + "type": { + "kind": "HttpTypeUnion", + "types": [ + { + "kind": "HttpTypeLiteral", + "literal": "done" + } + ], + "oasRef": "#/components/schemas/DoneEvent/properties/event" + }, + "oasRef": "#/components/schemas/DoneEvent/properties/event", + "deprecated": false, + "schemaType": "enum", + "childrenParentSchema": "enum", + "children": [ + "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 24 > (property) event > (member) 0" + ] + }, + "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 24 > (property) data > (member) 0": { + "kind": "HttpDeclReference", + "type": { + "kind": "HttpTypeLiteral", + "literal": "[DONE]" + } + }, + "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 24 > (property) event > (member) 0": { + "kind": "HttpDeclReference", + "type": { + "kind": "HttpTypeLiteral", + "literal": "done" + } + } +} +``` + +### Example + +```json +{} +```