diff --git a/en/resources/beta/subresources/assistants/streaming-events.md b/en/resources/beta/subresources/assistants/streaming-events.md index 0bd132aa..7781f227 100644 --- a/en/resources/beta/subresources/assistants/streaming-events.md +++ b/en/resources/beta/subresources/assistants/streaming-events.md @@ -1,5 +1,7 @@ # Assistants streaming events +> For the complete documentation index, see [llms.txt](/llms.txt). Markdown versions of documentation pages are available by appending `.md` to the page URL. + 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://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) @@ -20,7 +22,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/oneOf/0", - "ident": "UnionMember0", + "docstring": "Occurs when a new [thread](/docs/api-reference/threads/object) is created.", + "ident": "ThreadCreated", "type": { "kind": "HttpTypeObject", "members": [ @@ -35,7 +38,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "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", @@ -45,20 +47,20 @@ 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](/docs/api-reference/messages).", + "oasRef": "#/components/schemas/ThreadStreamEvent/oneOf/0/properties/data", + "deprecated": false, "key": "data", - "optional": false, - "nullable": false, + "docstring": "Represents a thread that contains [messages](/docs/api-reference/messages).", + "title": "Thread", "type": { "kind": "HttpTypeReference", "ident": "Thread", "$ref": "(resource) beta.threads > (model) thread > (schema)" }, - "oasRef": "#/components/schemas/ThreadStreamEvent/oneOf/0/properties/data", - "deprecated": false, - "schemaType": "object", + "optional": false, + "nullable": false, "modelImplicit": false, + "schemaType": "object", "modelPath": "(resource) beta.threads > (model) thread", "childrenParentSchema": "object", "children": [ @@ -71,21 +73,21 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 0 > (property) event": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/ThreadStreamEvent/oneOf/0/properties/event", + "deprecated": false, "key": "event", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/ThreadStreamEvent/oneOf/0/properties/event", "types": [ { "kind": "HttpTypeLiteral", "literal": "thread.created" } - ], - "oasRef": "#/components/schemas/ThreadStreamEvent/oneOf/0/properties/event" + ] }, - "oasRef": "#/components/schemas/ThreadStreamEvent/oneOf/0/properties/event", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -94,85 +96,85 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 0 > (property) enabled": { "kind": "HttpDeclProperty", - "docstring": "Whether to enable input audio transcription.", + "oasRef": "#/components/schemas/ThreadStreamEvent/oneOf/0/properties/enabled", + "deprecated": false, "key": "enabled", - "optional": true, - "nullable": false, + "docstring": "Whether to enable input audio transcription.", "type": { "kind": "HttpTypeBoolean" }, - "oasRef": "#/components/schemas/ThreadStreamEvent/oneOf/0/properties/enabled", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "boolean", "children": [] }, "(resource) beta.threads > (model) thread > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The identifier, which can be referenced in API endpoints.", + "oasRef": "#/components/schemas/ThreadObject/properties/id", + "deprecated": false, "key": "id", - "optional": false, - "nullable": false, + "docstring": "The identifier, which can be referenced in API endpoints.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/ThreadObject/properties/id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads > (model) thread > (schema) > (property) created_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the thread was created.", + "oasRef": "#/components/schemas/ThreadObject/properties/created_at", + "deprecated": false, "key": "created_at", - "optional": false, - "nullable": false, + "docstring": "The Unix timestamp (in seconds) for when the thread was created.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/ThreadObject/properties/created_at", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.threads > (model) thread > (schema) > (property) metadata": { "kind": "HttpDeclProperty", - "docstring": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.\n", + "oasRef": "#/components/schemas/ThreadObject/properties/metadata", + "deprecated": false, "key": "metadata", - "optional": false, - "nullable": true, + "docstring": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.\n", "type": { "kind": "HttpTypeReference", "ident": "Metadata", "$ref": "(resource) $shared > (model) metadata > (schema)" }, - "oasRef": "#/components/schemas/ThreadObject/properties/metadata", - "deprecated": false, - "schemaType": "map", + "optional": false, + "nullable": true, "modelImplicit": false, + "schemaType": "map", "modelPath": "(resource) $shared > (model) metadata", "children": [] }, "(resource) beta.threads > (model) thread > (schema) > (property) object": { "kind": "HttpDeclProperty", - "docstring": "The object type, which is always `thread`.", + "oasRef": "#/components/schemas/ThreadObject/properties/object", + "deprecated": false, "key": "object", - "optional": false, - "nullable": false, + "docstring": "The object type, which is always `thread`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/ThreadObject/properties/object", "types": [ { "kind": "HttpTypeLiteral", "literal": "thread" } - ], - "oasRef": "#/components/schemas/ThreadObject/properties/object" + ] }, - "oasRef": "#/components/schemas/ThreadObject/properties/object", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -181,10 +183,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads > (model) thread > (schema) > (property) tool_resources": { "kind": "HttpDeclProperty", - "docstring": "A set of resources that are made available to the assistant's tools in this thread. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs.\n", + "oasRef": "#/components/schemas/ThreadObject/properties/tool_resources", + "deprecated": false, "key": "tool_resources", - "optional": false, - "nullable": true, + "docstring": "A set of resources that are made available to the assistant's tools in this thread. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs.\n", "type": { "kind": "HttpTypeObject", "members": [ @@ -196,8 +198,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/ThreadObject/properties/tool_resources", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -208,6 +210,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads > (model) thread > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/ThreadObject", + "docstring": "Represents a thread that contains [messages](/docs/api-reference/messages).", "ident": "Thread", "type": { "kind": "HttpTypeObject", @@ -229,7 +232,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Represents a thread that contains [messages](/docs/api-reference/messages).", "childrenParentSchema": "object", "children": [ "(resource) beta.threads > (model) thread > (schema) > (property) id", @@ -249,9 +251,11 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) $shared > (model) metadata > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/Metadata", + "docstring": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.\n", "ident": "Metadata", "type": { "kind": "HttpTypeReference", + "oasRef": "#/components/schemas/Metadata", "ident": "Record", "typeParameters": [ { @@ -260,10 +264,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch { "kind": "HttpTypeString" } - ], - "oasRef": "#/components/schemas/Metadata" + ] }, - "docstring": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.\n", "children": [] }, "(resource) beta.threads > (model) thread > (schema) > (property) object > (member) 0": { @@ -275,9 +277,9 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads > (model) thread > (schema) > (property) tool_resources > (property) code_interpreter": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/ThreadObject/properties/tool_resources/anyOf/0/properties/code_interpreter", + "deprecated": false, "key": "code_interpreter", - "optional": true, - "nullable": false, "type": { "kind": "HttpTypeObject", "members": [ @@ -286,8 +288,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/ThreadObject/properties/tool_resources/anyOf/0/properties/code_interpreter", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -296,9 +298,9 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads > (model) thread > (schema) > (property) tool_resources > (property) file_search": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/ThreadObject/properties/tool_resources/anyOf/0/properties/file_search", + "deprecated": false, "key": "file_search", - "optional": true, - "nullable": false, "type": { "kind": "HttpTypeObject", "members": [ @@ -307,8 +309,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/ThreadObject/properties/tool_resources/anyOf/0/properties/file_search", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -317,38 +319,38 @@ 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](/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", + "oasRef": "#/components/schemas/ThreadObject/properties/tool_resources/anyOf/0/properties/code_interpreter/properties/file_ids", + "deprecated": false, "key": "file_ids", - "optional": true, - "nullable": false, - "default": [], + "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", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/ThreadObject/properties/tool_resources/anyOf/0/properties/code_interpreter/properties/file_ids", "elementType": { "kind": "HttpTypeString" + } }, - "oasRef": "#/components/schemas/ThreadObject/properties/tool_resources/anyOf/0/properties/code_interpreter/properties/file_ids" - }, - "oasRef": "#/components/schemas/ThreadObject/properties/tool_resources/anyOf/0/properties/code_interpreter/properties/file_ids", - "deprecated": false, + "default": [], + "optional": true, + "nullable": false, "schemaType": "array", "children": [] }, "(resource) beta.threads > (model) thread > (schema) > (property) tool_resources > (property) file_search > (property) vector_store_ids": { "kind": "HttpDeclProperty", - "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", + "oasRef": "#/components/schemas/ThreadObject/properties/tool_resources/anyOf/0/properties/file_search/properties/vector_store_ids", + "deprecated": false, "key": "vector_store_ids", - "optional": true, - "nullable": false, + "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", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/ThreadObject/properties/tool_resources/anyOf/0/properties/file_search/properties/vector_store_ids", "elementType": { "kind": "HttpTypeString" + } }, - "oasRef": "#/components/schemas/ThreadObject/properties/tool_resources/anyOf/0/properties/file_search/properties/vector_store_ids" - }, - "oasRef": "#/components/schemas/ThreadObject/properties/tool_resources/anyOf/0/properties/file_search/properties/vector_store_ids", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "array", "children": [] } @@ -374,7 +376,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/oneOf/0", - "ident": "UnionMember1", + "docstring": "Occurs when a new [run](/docs/api-reference/runs/object) is created.", + "ident": "ThreadRunCreated", "type": { "kind": "HttpTypeObject", "members": [ @@ -386,7 +389,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "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", @@ -395,20 +397,20 @@ 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](/docs/api-reference/threads).", + "oasRef": "#/components/schemas/RunStreamEvent/oneOf/0/properties/data", + "deprecated": false, "key": "data", - "optional": false, - "nullable": false, + "docstring": "Represents an execution run on a [thread](/docs/api-reference/threads).", + "title": "A run on a thread", "type": { "kind": "HttpTypeReference", "ident": "Run", "$ref": "(resource) beta.threads.runs > (model) run > (schema)" }, - "oasRef": "#/components/schemas/RunStreamEvent/oneOf/0/properties/data", - "deprecated": false, - "schemaType": "object", + "optional": false, + "nullable": false, "modelImplicit": false, + "schemaType": "object", "modelPath": "(resource) beta.threads.runs > (model) run", "childrenParentSchema": "object", "children": [ @@ -443,21 +445,21 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 1 > (property) event": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RunStreamEvent/oneOf/0/properties/event", + "deprecated": false, "key": "event", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStreamEvent/oneOf/0/properties/event", "types": [ { "kind": "HttpTypeLiteral", "literal": "thread.run.created" } - ], - "oasRef": "#/components/schemas/RunStreamEvent/oneOf/0/properties/event" + ] }, - "oasRef": "#/components/schemas/RunStreamEvent/oneOf/0/properties/event", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -466,123 +468,123 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The identifier, which can be referenced in API endpoints.", + "oasRef": "#/components/schemas/RunObject/properties/id", + "deprecated": false, "key": "id", - "optional": false, - "nullable": false, + "docstring": "The identifier, which can be referenced in API endpoints.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunObject/properties/id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) assistant_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the [assistant](/docs/api-reference/assistants) used for execution of this run.", + "oasRef": "#/components/schemas/RunObject/properties/assistant_id", + "deprecated": false, "key": "assistant_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the [assistant](/docs/api-reference/assistants) used for execution of this run.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunObject/properties/assistant_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) cancelled_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the run was cancelled.", + "oasRef": "#/components/schemas/RunObject/properties/cancelled_at", + "deprecated": false, "key": "cancelled_at", - "optional": false, - "nullable": true, + "docstring": "The Unix timestamp (in seconds) for when the run was cancelled.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/RunObject/properties/cancelled_at", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) completed_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the run was completed.", + "oasRef": "#/components/schemas/RunObject/properties/completed_at", + "deprecated": false, "key": "completed_at", - "optional": false, - "nullable": true, + "docstring": "The Unix timestamp (in seconds) for when the run was completed.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/RunObject/properties/completed_at", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) created_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the run was created.", + "oasRef": "#/components/schemas/RunObject/properties/created_at", + "deprecated": false, "key": "created_at", - "optional": false, - "nullable": false, + "docstring": "The Unix timestamp (in seconds) for when the run was created.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/RunObject/properties/created_at", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) expires_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the run will expire.", + "oasRef": "#/components/schemas/RunObject/properties/expires_at", + "deprecated": false, "key": "expires_at", - "optional": false, - "nullable": true, + "docstring": "The Unix timestamp (in seconds) for when the run will expire.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/RunObject/properties/expires_at", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) failed_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the run failed.", + "oasRef": "#/components/schemas/RunObject/properties/failed_at", + "deprecated": false, "key": "failed_at", - "optional": false, - "nullable": true, + "docstring": "The Unix timestamp (in seconds) for when the run failed.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/RunObject/properties/failed_at", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) incomplete_details": { "kind": "HttpDeclProperty", - "docstring": "Details on why the run is incomplete. Will be `null` if the run is not incomplete.", + "oasRef": "#/components/schemas/RunObject/properties/incomplete_details", + "deprecated": false, "key": "incomplete_details", - "optional": false, - "nullable": true, + "docstring": "Details on why the run is incomplete. Will be `null` if the run is not incomplete.", "type": { "kind": "HttpTypeObject", "members": [ @@ -591,8 +593,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunObject/properties/incomplete_details", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -601,24 +603,24 @@ 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](/docs/api-reference/assistants) used for this run.", + "oasRef": "#/components/schemas/RunObject/properties/instructions", + "deprecated": false, "key": "instructions", - "optional": false, - "nullable": false, + "docstring": "The instructions that the [assistant](/docs/api-reference/assistants) used for this run.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunObject/properties/instructions", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) last_error": { "kind": "HttpDeclProperty", - "docstring": "The last error associated with this run. Will be `null` if there are no errors.", + "oasRef": "#/components/schemas/RunObject/properties/last_error", + "deprecated": false, "key": "last_error", - "optional": false, - "nullable": true, + "docstring": "The last error associated with this run. Will be `null` if there are no errors.", "type": { "kind": "HttpTypeObject", "members": [ @@ -630,8 +632,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunObject/properties/last_error", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -641,88 +643,88 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) max_completion_tokens": { "kind": "HttpDeclProperty", - "docstring": "The maximum number of completion tokens specified to have been used over the course of the run.\n", + "oasRef": "#/components/schemas/RunObject/properties/max_completion_tokens", + "deprecated": false, "key": "max_completion_tokens", - "optional": false, - "nullable": true, + "docstring": "The maximum number of completion tokens specified to have been used over the course of the run.\n", "type": { "kind": "HttpTypeNumber" }, "constraints": { "minimum": 256 }, - "oasRef": "#/components/schemas/RunObject/properties/max_completion_tokens", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) max_prompt_tokens": { "kind": "HttpDeclProperty", - "docstring": "The maximum number of prompt tokens specified to have been used over the course of the run.\n", + "oasRef": "#/components/schemas/RunObject/properties/max_prompt_tokens", + "deprecated": false, "key": "max_prompt_tokens", - "optional": false, - "nullable": true, + "docstring": "The maximum number of prompt tokens specified to have been used over the course of the run.\n", "type": { "kind": "HttpTypeNumber" }, "constraints": { "minimum": 256 }, - "oasRef": "#/components/schemas/RunObject/properties/max_prompt_tokens", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) metadata": { "kind": "HttpDeclProperty", - "docstring": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.\n", + "oasRef": "#/components/schemas/RunObject/properties/metadata", + "deprecated": false, "key": "metadata", - "optional": false, - "nullable": true, + "docstring": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.\n", "type": { "kind": "HttpTypeReference", "ident": "Metadata", "$ref": "(resource) $shared > (model) metadata > (schema)" }, - "oasRef": "#/components/schemas/RunObject/properties/metadata", - "deprecated": false, - "schemaType": "map", + "optional": false, + "nullable": true, "modelImplicit": false, + "schemaType": "map", "modelPath": "(resource) $shared > (model) metadata", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) model": { "kind": "HttpDeclProperty", - "docstring": "The model that the [assistant](/docs/api-reference/assistants) used for this run.", + "oasRef": "#/components/schemas/RunObject/properties/model", + "deprecated": false, "key": "model", - "optional": false, - "nullable": false, + "docstring": "The model that the [assistant](/docs/api-reference/assistants) used for this run.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunObject/properties/model", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) object": { "kind": "HttpDeclProperty", - "docstring": "The object type, which is always `thread.run`.", + "oasRef": "#/components/schemas/RunObject/properties/object", + "deprecated": false, "key": "object", - "optional": false, - "nullable": false, + "docstring": "The object type, which is always `thread.run`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunObject/properties/object", "types": [ { "kind": "HttpTypeLiteral", "literal": "thread.run" } - ], - "oasRef": "#/components/schemas/RunObject/properties/object" + ] }, - "oasRef": "#/components/schemas/RunObject/properties/object", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -731,25 +733,25 @@ 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](/docs/guides/function-calling#configuring-parallel-function-calling) during tool use.", + "oasRef": "#/components/schemas/RunObject/properties/parallel_tool_calls", + "deprecated": false, "key": "parallel_tool_calls", - "optional": false, - "nullable": false, - "default": true, + "docstring": "Whether to enable [parallel function calling](/docs/guides/function-calling#configuring-parallel-function-calling) during tool use.", "type": { "kind": "HttpTypeBoolean" }, - "oasRef": "#/components/schemas/RunObject/properties/parallel_tool_calls", - "deprecated": false, + "default": true, + "optional": false, + "nullable": false, "schemaType": "boolean", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) required_action": { "kind": "HttpDeclProperty", - "docstring": "Details on the action required to continue the run. Will be `null` if no action is required.", + "oasRef": "#/components/schemas/RunObject/properties/required_action", + "deprecated": false, "key": "required_action", - "optional": false, - "nullable": true, + "docstring": "Details on the action required to continue the run. Will be `null` if no action is required.", "type": { "kind": "HttpTypeObject", "members": [ @@ -761,8 +763,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunObject/properties/required_action", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -772,19 +774,19 @@ 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](/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", + "oasRef": "#/components/schemas/RunObject/properties/response_format", + "deprecated": false, "key": "response_format", - "optional": false, - "nullable": true, + "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", "type": { "kind": "HttpTypeReference", "ident": "AssistantResponseFormatOption", "$ref": "(resource) beta.threads > (model) assistant_response_format_option > (schema)" }, - "oasRef": "#/components/schemas/RunObject/properties/response_format", - "deprecated": false, - "schemaType": "union", + "optional": false, + "nullable": true, "modelImplicit": false, + "schemaType": "union", "modelPath": "(resource) beta.threads > (model) assistant_response_format_option", "childrenParentSchema": "union", "children": [ @@ -796,29 +798,30 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) started_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the run was started.", + "oasRef": "#/components/schemas/RunObject/properties/started_at", + "deprecated": false, "key": "started_at", - "optional": false, - "nullable": true, + "docstring": "The Unix timestamp (in seconds) for when the run was started.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/RunObject/properties/started_at", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) status": { "kind": "HttpDeclProperty", - "docstring": "The status of the run, which can be either `queued`, `in_progress`, `requires_action`, `cancelling`, `cancelled`, `failed`, `completed`, `incomplete`, or `expired`.", + "oasRef": "#/components/schemas/RunObject/properties/status", + "deprecated": false, "key": "status", - "optional": false, - "nullable": false, + "docstring": "The status of the run, which can be either `queued`, `in_progress`, `requires_action`, `cancelling`, `cancelled`, `failed`, `completed`, `incomplete`, or `expired`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunObject/properties/status", "types": [ { "kind": "HttpTypeLiteral", @@ -856,11 +859,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "expired" } - ], - "oasRef": "#/components/schemas/RunObject/properties/status" + ] }, - "oasRef": "#/components/schemas/RunObject/properties/status", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -877,33 +879,33 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) thread_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the [thread](/docs/api-reference/threads) that was executed on as a part of this run.", + "oasRef": "#/components/schemas/RunObject/properties/thread_id", + "deprecated": false, "key": "thread_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the [thread](/docs/api-reference/threads) that was executed on as a part of this run.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunObject/properties/thread_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) tool_choice": { "kind": "HttpDeclProperty", - "docstring": "Controls which (if any) tool is called by the model.\n`none` means the model will not call any tools and instead generates a message.\n`auto` is the default value and means the model can pick between generating a message or calling one or more tools.\n`required` means the model must call one or more tools before responding to the user.\nSpecifying a particular tool like `{\"type\": \"file_search\"}` or `{\"type\": \"function\", \"function\": {\"name\": \"my_function\"}}` forces the model to call that tool.\n", + "oasRef": "#/components/schemas/RunObject/properties/tool_choice", + "deprecated": false, "key": "tool_choice", - "optional": false, - "nullable": true, + "docstring": "Controls which (if any) tool is called by the model.\n`none` means the model will not call any tools and instead generates a message.\n`auto` is the default value and means the model can pick between generating a message or calling one or more tools.\n`required` means the model must call one or more tools before responding to the user.\nSpecifying a particular tool like `{\"type\": \"file_search\"}` or `{\"type\": \"function\", \"function\": {\"name\": \"my_function\"}}` forces the model to call that tool.\n", "type": { "kind": "HttpTypeReference", "ident": "AssistantToolChoiceOption", "$ref": "(resource) beta.threads > (model) assistant_tool_choice_option > (schema)" }, - "oasRef": "#/components/schemas/RunObject/properties/tool_choice", - "deprecated": false, - "schemaType": "union", + "optional": false, + "nullable": true, "modelImplicit": false, + "schemaType": "union", "modelPath": "(resource) beta.threads > (model) assistant_tool_choice_option", "childrenParentSchema": "union", "children": [ @@ -913,15 +915,16 @@ 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](/docs/api-reference/assistants) used for this run.", + "oasRef": "#/components/schemas/RunObject/properties/tools", + "deprecated": false, "key": "tools", - "optional": false, - "nullable": false, - "default": [], + "docstring": "The list of tools that the [assistant](/docs/api-reference/assistants) used for this run.", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RunObject/properties/tools", "elementType": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunObject/properties/tools/items", "types": [ { "kind": "HttpTypeReference", @@ -938,13 +941,12 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "ident": "FunctionTool", "$ref": "(resource) beta.assistants > (model) function_tool > (schema)" } - ], - "oasRef": "#/components/schemas/RunObject/properties/tools/items" - }, - "oasRef": "#/components/schemas/RunObject/properties/tools" + ] + } }, - "oasRef": "#/components/schemas/RunObject/properties/tools", - "deprecated": false, + "default": [], + "optional": false, + "nullable": false, "schemaType": "array", "childrenParentSchema": "union", "children": [ @@ -955,11 +957,11 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy": { "kind": "HttpDeclProperty", - "title": "Thread Truncation Controls", - "docstring": "Controls for how a thread will be truncated prior to the run. Use this to control the initial context window of the run.", + "oasRef": "#/components/schemas/RunObject/properties/truncation_strategy", + "deprecated": false, "key": "truncation_strategy", - "optional": false, - "nullable": true, + "docstring": "Controls for how a thread will be truncated prior to the run. Use this to control the initial context window of the run.", + "title": "Thread Truncation Controls", "type": { "kind": "HttpTypeObject", "members": [ @@ -971,8 +973,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunObject/properties/truncation_strategy", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -982,10 +984,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) usage": { "kind": "HttpDeclProperty", - "docstring": "Usage statistics related to the run. This value will be `null` if the run is not in a terminal state (i.e. `in_progress`, `queued`, etc.).", + "oasRef": "#/components/schemas/RunObject/properties/usage", + "deprecated": false, "key": "usage", - "optional": false, - "nullable": true, + "docstring": "Usage statistics related to the run. This value will be `null` if the run is not in a terminal state (i.e. `in_progress`, `queued`, etc.).", "type": { "kind": "HttpTypeObject", "members": [ @@ -1000,8 +1002,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunObject/properties/usage", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -1012,35 +1014,36 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) temperature": { "kind": "HttpDeclProperty", - "docstring": "The sampling temperature used for this run. If not set, defaults to 1.", + "oasRef": "#/components/schemas/RunObject/properties/temperature", + "deprecated": false, "key": "temperature", - "optional": true, - "nullable": true, + "docstring": "The sampling temperature used for this run. If not set, defaults to 1.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RunObject/properties/temperature", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "number", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) top_p": { "kind": "HttpDeclProperty", - "docstring": "The nucleus sampling value used for this run. If not set, defaults to 1.", + "oasRef": "#/components/schemas/RunObject/properties/top_p", + "deprecated": false, "key": "top_p", - "optional": true, - "nullable": true, + "docstring": "The nucleus sampling value used for this run. If not set, defaults to 1.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RunObject/properties/top_p", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "number", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RunObject", + "docstring": "Represents an execution run on a [thread](/docs/api-reference/threads).", "ident": "Run", "type": { "kind": "HttpTypeObject", @@ -1128,7 +1131,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Represents an execution run on a [thread](/docs/api-reference/threads).", "childrenParentSchema": "object", "children": [ "(resource) beta.threads.runs > (model) run > (schema) > (property) id", @@ -1169,12 +1171,13 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) incomplete_details > (property) reason": { "kind": "HttpDeclProperty", - "docstring": "The reason why the run is incomplete. This will point to which specific token limit was reached over the course of the run.", + "oasRef": "#/components/schemas/RunObject/properties/incomplete_details/properties/reason", + "deprecated": false, "key": "reason", - "optional": true, - "nullable": false, + "docstring": "The reason why the run is incomplete. This will point to which specific token limit was reached over the course of the run.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunObject/properties/incomplete_details/properties/reason", "types": [ { "kind": "HttpTypeLiteral", @@ -1184,11 +1187,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "max_prompt_tokens" } - ], - "oasRef": "#/components/schemas/RunObject/properties/incomplete_details/properties/reason" + ] }, - "oasRef": "#/components/schemas/RunObject/properties/incomplete_details/properties/reason", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -1198,12 +1200,13 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) code": { "kind": "HttpDeclProperty", - "docstring": "One of `server_error`, `rate_limit_exceeded`, or `invalid_prompt`.", + "oasRef": "#/components/schemas/RunObject/properties/last_error/properties/code", + "deprecated": false, "key": "code", - "optional": false, - "nullable": false, + "docstring": "One of `server_error`, `rate_limit_exceeded`, or `invalid_prompt`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunObject/properties/last_error/properties/code", "types": [ { "kind": "HttpTypeLiteral", @@ -1217,11 +1220,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "invalid_prompt" } - ], - "oasRef": "#/components/schemas/RunObject/properties/last_error/properties/code" + ] }, - "oasRef": "#/components/schemas/RunObject/properties/last_error/properties/code", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -1232,24 +1234,26 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) message": { "kind": "HttpDeclProperty", - "docstring": "A human-readable description of the error.", + "oasRef": "#/components/schemas/RunObject/properties/last_error/properties/message", + "deprecated": false, "key": "message", - "optional": false, - "nullable": false, + "docstring": "A human-readable description of the error.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunObject/properties/last_error/properties/message", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) $shared > (model) metadata > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/Metadata", + "docstring": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.\n", "ident": "Metadata", "type": { "kind": "HttpTypeReference", + "oasRef": "#/components/schemas/Metadata", "ident": "Record", "typeParameters": [ { @@ -1258,10 +1262,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch { "kind": "HttpTypeString" } - ], - "oasRef": "#/components/schemas/Metadata" + ] }, - "docstring": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.\n", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) object > (member) 0": { @@ -1273,10 +1275,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) required_action > (property) submit_tool_outputs": { "kind": "HttpDeclProperty", - "docstring": "Details on the tool outputs needed for this run to continue.", + "oasRef": "#/components/schemas/RunObject/properties/required_action/properties/submit_tool_outputs", + "deprecated": false, "key": "submit_tool_outputs", - "optional": false, - "nullable": false, + "docstring": "Details on the tool outputs needed for this run to continue.", "type": { "kind": "HttpTypeObject", "members": [ @@ -1285,8 +1287,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunObject/properties/required_action/properties/submit_tool_outputs", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -1295,22 +1297,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) required_action > (property) type": { "kind": "HttpDeclProperty", - "docstring": "For now, this is always `submit_tool_outputs`.", + "oasRef": "#/components/schemas/RunObject/properties/required_action/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "For now, this is always `submit_tool_outputs`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunObject/properties/required_action/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "submit_tool_outputs" } - ], - "oasRef": "#/components/schemas/RunObject/properties/required_action/properties/type" + ] }, - "oasRef": "#/components/schemas/RunObject/properties/required_action/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -1320,18 +1322,18 @@ 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/oneOf/0", + "docstring": "`auto` is the default value\n", "ident": "UnionMember0", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/oneOf/0", "types": [ { "kind": "HttpTypeLiteral", "literal": "auto" } - ], - "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/oneOf/0" + ] }, - "docstring": "`auto` is the default value\n", "childrenParentSchema": "enum", "children": [ "(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 0 > (member) 0" @@ -1377,19 +1379,21 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads > (model) assistant_response_format_option > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption", + "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", "ident": "AssistantResponseFormatOption", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption", "types": [ { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/oneOf/0", "types": [ { "kind": "HttpTypeLiteral", "literal": "auto" } - ], - "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/oneOf/0" + ] }, { "kind": "HttpTypeReference", @@ -1406,10 +1410,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "ident": "ResponseFormatJSONSchema", "$ref": "(resource) $shared > (model) response_format_json_schema > (schema)" } - ], - "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption" + ] }, - "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", @@ -1484,9 +1486,11 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0": { "kind": "HttpDeclTypeAlias", "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", "ident": "UnionMember0", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption/oneOf/0", "types": [ { "kind": "HttpTypeLiteral", @@ -1500,10 +1504,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "required" } - ], - "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", "children": [ "(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0 > (member) 0", @@ -1527,12 +1529,15 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads > (model) assistant_tool_choice_option > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption", + "docstring": "Controls which (if any) tool is called by the model.\n`none` means the model will not call any tools and instead generates a message.\n`auto` is the default value and means the model can pick between generating a message or calling one or more tools.\n`required` means the model must call one or more tools before responding to the user.\nSpecifying a particular tool like `{\"type\": \"file_search\"}` or `{\"type\": \"function\", \"function\": {\"name\": \"my_function\"}}` forces the model to call that tool.\n", "ident": "AssistantToolChoiceOption", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption", "types": [ { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption/oneOf/0", "types": [ { "kind": "HttpTypeLiteral", @@ -1546,18 +1551,15 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "required" } - ], - "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption/oneOf/0" + ] }, { "kind": "HttpTypeReference", "ident": "AssistantToolChoice", "$ref": "(resource) beta.threads > (model) assistant_tool_choice > (schema)" } - ], - "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption" + ] }, - "docstring": "Controls which (if any) tool is called by the model.\n`none` means the model will not call any tools and instead generates a message.\n`auto` is the default value and means the model can pick between generating a message or calling one or more tools.\n`required` means the model must call one or more tools before responding to the user.\nSpecifying a particular tool like `{\"type\": \"file_search\"}` or `{\"type\": \"function\", \"function\": {\"name\": \"my_function\"}}` forces the model to call that tool.\n", "childrenParentSchema": "union", "children": [ "(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0", @@ -1663,12 +1665,13 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The truncation strategy to use for the thread. The default is `auto`. If set to `last_messages`, the thread will be truncated to the n most recent messages in the thread. When set to `auto`, messages in the middle of the thread will be dropped to fit the context length of the model, `max_prompt_tokens`.", + "oasRef": "#/components/schemas/TruncationObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The truncation strategy to use for the thread. The default is `auto`. If set to `last_messages`, the thread will be truncated to the n most recent messages in the thread. When set to `auto`, messages in the middle of the thread will be dropped to fit the context length of the model, `max_prompt_tokens`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/TruncationObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", @@ -1678,11 +1681,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "last_messages" } - ], - "oasRef": "#/components/schemas/TruncationObject/properties/type" + ] }, - "oasRef": "#/components/schemas/TruncationObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -1692,60 +1694,60 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) last_messages": { "kind": "HttpDeclProperty", - "docstring": "The number of most recent messages from the thread when constructing the context for the run.", + "oasRef": "#/components/schemas/TruncationObject/properties/last_messages", + "deprecated": false, "key": "last_messages", - "optional": true, - "nullable": true, + "docstring": "The number of most recent messages from the thread when constructing the context for the run.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "minimum": 1 }, - "oasRef": "#/components/schemas/TruncationObject/properties/last_messages", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) usage > (property) completion_tokens": { "kind": "HttpDeclProperty", - "docstring": "Number of completion tokens used over the course of the run.", + "oasRef": "#/components/schemas/RunCompletionUsage/anyOf/0/properties/completion_tokens", + "deprecated": false, "key": "completion_tokens", - "optional": false, - "nullable": false, + "docstring": "Number of completion tokens used over the course of the run.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RunCompletionUsage/anyOf/0/properties/completion_tokens", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) usage > (property) prompt_tokens": { "kind": "HttpDeclProperty", - "docstring": "Number of prompt tokens used over the course of the run.", + "oasRef": "#/components/schemas/RunCompletionUsage/anyOf/0/properties/prompt_tokens", + "deprecated": false, "key": "prompt_tokens", - "optional": false, - "nullable": false, + "docstring": "Number of prompt tokens used over the course of the run.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RunCompletionUsage/anyOf/0/properties/prompt_tokens", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) usage > (property) total_tokens": { "kind": "HttpDeclProperty", - "docstring": "Total number of tokens used (prompt + completion).", + "oasRef": "#/components/schemas/RunCompletionUsage/anyOf/0/properties/total_tokens", + "deprecated": false, "key": "total_tokens", - "optional": false, - "nullable": false, + "docstring": "Total number of tokens used (prompt + completion).", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RunCompletionUsage/anyOf/0/properties/total_tokens", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, @@ -1786,21 +1788,21 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) required_action > (property) submit_tool_outputs > (property) tool_calls": { "kind": "HttpDeclProperty", - "docstring": "A list of the relevant tool calls.", + "oasRef": "#/components/schemas/RunObject/properties/required_action/properties/submit_tool_outputs/properties/tool_calls", + "deprecated": false, "key": "tool_calls", - "optional": false, - "nullable": false, + "docstring": "A list of the relevant tool calls.", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RunObject/properties/required_action/properties/submit_tool_outputs/properties/tool_calls", "elementType": { "kind": "HttpTypeReference", "ident": "RequiredActionFunctionToolCall", "$ref": "(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema)" + } }, - "oasRef": "#/components/schemas/RunObject/properties/required_action/properties/submit_tool_outputs/properties/tool_calls" - }, - "oasRef": "#/components/schemas/RunObject/properties/required_action/properties/submit_tool_outputs/properties/tool_calls", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "array", "childrenParentSchema": "object", "children": [ @@ -1825,22 +1827,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) $shared > (model) response_format_text > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of response format being defined. Always `text`.", + "oasRef": "#/components/schemas/ResponseFormatText/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of response format being defined. Always `text`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/ResponseFormatText/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "text" } - ], - "oasRef": "#/components/schemas/ResponseFormatText/properties/type" + ] }, - "oasRef": "#/components/schemas/ResponseFormatText/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -1850,6 +1852,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) $shared > (model) response_format_text > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/ResponseFormatText", + "docstring": "Default response format. Used to generate text responses.\n", "ident": "ResponseFormatText", "type": { "kind": "HttpTypeObject", @@ -1859,7 +1862,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Default response format. Used to generate text responses.\n", "childrenParentSchema": "object", "children": [ "(resource) $shared > (model) response_format_text > (schema) > (property) type" @@ -1867,22 +1869,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) $shared > (model) response_format_json_object > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of response format being defined. Always `json_object`.", + "oasRef": "#/components/schemas/ResponseFormatJsonObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of response format being defined. Always `json_object`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/ResponseFormatJsonObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "json_object" } - ], - "oasRef": "#/components/schemas/ResponseFormatJsonObject/properties/type" + ] }, - "oasRef": "#/components/schemas/ResponseFormatJsonObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -1892,6 +1894,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) $shared > (model) response_format_json_object > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/ResponseFormatJsonObject", + "docstring": "JSON object response format. An older method of generating JSON responses.\nUsing `json_schema` is recommended for models that support it. Note that the\nmodel will not generate JSON without a system or user message instructing it\nto do so.\n", "ident": "ResponseFormatJSONObject", "type": { "kind": "HttpTypeObject", @@ -1901,7 +1904,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "JSON object response format. An older method of generating JSON responses.\nUsing `json_schema` is recommended for models that support it. Note that the\nmodel will not generate JSON without a system or user message instructing it\nto do so.\n", "childrenParentSchema": "object", "children": [ "(resource) $shared > (model) response_format_json_object > (schema) > (property) type" @@ -1909,11 +1911,11 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema": { "kind": "HttpDeclProperty", - "title": "JSON schema", - "docstring": "Structured Outputs configuration options, including a JSON Schema.\n", + "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema", + "deprecated": false, "key": "json_schema", - "optional": false, - "nullable": false, + "docstring": "Structured Outputs configuration options, including a JSON Schema.\n", + "title": "JSON schema", "type": { "kind": "HttpTypeObject", "members": [ @@ -1931,8 +1933,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -1944,22 +1946,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) $shared > (model) response_format_json_schema > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of response format being defined. Always `json_schema`.", + "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of response format being defined. Always `json_schema`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "json_schema" } - ], - "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/type" + ] }, - "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -1969,6 +1971,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) $shared > (model) response_format_json_schema > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/ResponseFormatJsonSchema", + "docstring": "JSON Schema response format. Used to generate structured JSON responses.\nLearn more about [Structured Outputs](/docs/guides/structured-outputs).\n", "ident": "ResponseFormatJSONSchema", "type": { "kind": "HttpTypeObject", @@ -1981,7 +1984,6 @@ 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](/docs/guides/structured-outputs).\n", "childrenParentSchema": "object", "children": [ "(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema", @@ -2011,12 +2013,13 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the tool. If type is `function`, the function name must be set", + "oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the tool. If type is `function`, the function name must be set", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/type", "types": [ { "kind": "HttpTypeLiteral", @@ -2030,11 +2033,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "file_search" } - ], - "oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/type" + ] }, - "oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -2045,18 +2047,18 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) function": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/function", + "deprecated": false, "key": "function", - "optional": true, - "nullable": false, "type": { "kind": "HttpTypeReference", "ident": "AssistantToolChoiceFunction", "$ref": "(resource) beta.threads > (model) assistant_tool_choice_function > (schema)" }, - "oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/function", - "deprecated": false, - "schemaType": "object", + "optional": true, + "nullable": false, "modelImplicit": false, + "schemaType": "object", "modelPath": "(resource) beta.threads > (model) assistant_tool_choice_function", "childrenParentSchema": "object", "children": [ @@ -2066,6 +2068,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads > (model) assistant_tool_choice > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/AssistantsNamedToolChoice", + "docstring": "Specifies a tool the model should use. Use to force the model to call a specific tool.", "ident": "AssistantToolChoice", "type": { "kind": "HttpTypeObject", @@ -2078,7 +2081,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Specifies a tool the model should use. Use to force the model to call a specific tool.", "childrenParentSchema": "object", "children": [ "(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) type", @@ -2087,22 +2089,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of tool being defined: `code_interpreter`", + "oasRef": "#/components/schemas/AssistantToolsCode/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of tool being defined: `code_interpreter`", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantToolsCode/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "code_interpreter" } - ], - "oasRef": "#/components/schemas/AssistantToolsCode/properties/type" + ] }, - "oasRef": "#/components/schemas/AssistantToolsCode/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -2111,22 +2113,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of tool being defined: `file_search`", + "oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of tool being defined: `file_search`", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "file_search" } - ], - "oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/type" + ] }, - "oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -2135,10 +2137,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search": { "kind": "HttpDeclProperty", - "docstring": "Overrides for the file search tool.", + "oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/file_search", + "deprecated": false, "key": "file_search", - "optional": true, - "nullable": false, + "docstring": "Overrides for the file search tool.", "type": { "kind": "HttpTypeObject", "members": [ @@ -2150,8 +2152,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/file_search", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -2161,18 +2163,18 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) function_tool > (schema) > (property) function": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/AssistantToolsFunction/properties/function", + "deprecated": false, "key": "function", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeReference", "ident": "FunctionDefinition", "$ref": "(resource) $shared > (model) function_definition > (schema)" }, - "oasRef": "#/components/schemas/AssistantToolsFunction/properties/function", - "deprecated": false, - "schemaType": "object", + "optional": false, + "nullable": false, "modelImplicit": false, + "schemaType": "object", "modelPath": "(resource) $shared > (model) function_definition", "childrenParentSchema": "object", "children": [ @@ -2184,22 +2186,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) function_tool > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of tool being defined: `function`", + "oasRef": "#/components/schemas/AssistantToolsFunction/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of tool being defined: `function`", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantToolsFunction/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "function" } - ], - "oasRef": "#/components/schemas/AssistantToolsFunction/properties/type" + ] }, - "oasRef": "#/components/schemas/AssistantToolsFunction/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -2222,24 +2224,24 @@ 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](/docs/api-reference/runs/submitToolOutputs) endpoint.", + "oasRef": "#/components/schemas/RunToolCallObject/properties/id", + "deprecated": false, "key": "id", - "optional": false, - "nullable": false, + "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.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunToolCallObject/properties/id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) function": { "kind": "HttpDeclProperty", - "docstring": "The function definition.", + "oasRef": "#/components/schemas/RunToolCallObject/properties/function", + "deprecated": false, "key": "function", - "optional": false, - "nullable": false, + "docstring": "The function definition.", "type": { "kind": "HttpTypeObject", "members": [ @@ -2251,8 +2253,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunToolCallObject/properties/function", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -2262,22 +2264,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of tool call the output is required for. For now, this is always `function`.", + "oasRef": "#/components/schemas/RunToolCallObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of tool call the output is required for. For now, this is always `function`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunToolCallObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "function" } - ], - "oasRef": "#/components/schemas/RunToolCallObject/properties/type" + ] }, - "oasRef": "#/components/schemas/RunToolCallObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -2287,6 +2289,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RunToolCallObject", + "docstring": "Tool call objects", "ident": "RequiredActionFunctionToolCall", "type": { "kind": "HttpTypeObject", @@ -2302,7 +2305,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Tool call objects", "childrenParentSchema": "object", "children": [ "(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) id", @@ -2326,41 +2328,42 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the response format. Must be a-z, A-Z, 0-9, or contain\nunderscores and dashes, with a maximum length of 64.\n", + "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/name", + "deprecated": false, "key": "name", - "optional": false, - "nullable": false, + "docstring": "The name of the response format. Must be a-z, A-Z, 0-9, or contain\nunderscores and dashes, with a maximum length of 64.\n", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/name", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema > (property) description": { "kind": "HttpDeclProperty", - "docstring": "A description of what the response format is for, used by the model to\ndetermine how to respond in the format.\n", + "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/description", + "deprecated": false, "key": "description", - "optional": true, - "nullable": false, + "docstring": "A description of what the response format is for, used by the model to\ndetermine how to respond in the format.\n", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/description", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema > (property) schema": { "kind": "HttpDeclProperty", - "title": "JSON schema", - "docstring": "The schema for the response format, described as a JSON Schema object.\nLearn how to build JSON schemas [here](https://json-schema.org/).\n", + "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/schema", + "deprecated": false, "key": "schema", - "optional": true, - "nullable": false, + "docstring": "The schema for the response format, described as a JSON Schema object.\nLearn how to build JSON schemas [here](https://json-schema.org/).\n", + "title": "JSON schema", "type": { "kind": "HttpTypeReference", + "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/schema", "ident": "Record", "typeParameters": [ { @@ -2369,26 +2372,25 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch { "kind": "HttpTypeUnknown" } - ], - "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/schema" + ] }, - "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/schema", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "map", "children": [] }, "(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](/docs/guides/structured-outputs).\n", + "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/strict", + "deprecated": false, "key": "strict", - "optional": true, - "nullable": true, - "default": false, + "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", "type": { "kind": "HttpTypeBoolean" }, - "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/strict", - "deprecated": false, + "default": false, + "optional": true, + "nullable": true, "schemaType": "boolean", "children": [] }, @@ -2422,15 +2424,15 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads > (model) assistant_tool_choice_function > (schema) > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the function to call.", + "oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/function/properties/name", + "deprecated": false, "key": "name", - "optional": false, - "nullable": false, + "docstring": "The name of the function to call.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/function/properties/name", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, @@ -2467,10 +2469,10 @@ 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](/docs/assistants/tools/file-search#customizing-file-search-settings) for more information.\n", + "oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/file_search/properties/max_num_results", + "deprecated": false, "key": "max_num_results", - "optional": true, - "nullable": false, + "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", "type": { "kind": "HttpTypeNumber" }, @@ -2478,18 +2480,18 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "minimum": 1, "maximum": 50 }, - "oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/file_search/properties/max_num_results", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "integer", "children": [] }, "(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](/docs/assistants/tools/file-search#customizing-file-search-settings) for more information.\n", + "oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/file_search/properties/ranking_options", + "deprecated": false, "key": "ranking_options", - "optional": true, - "nullable": false, + "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", + "title": "File search tool call ranking options", "type": { "kind": "HttpTypeObject", "members": [ @@ -2501,8 +2503,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/file_search/properties/ranking_options", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -2512,62 +2514,62 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) $shared > (model) function_definition > (schema) > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.", + "oasRef": "#/components/schemas/FunctionObject/properties/name", + "deprecated": false, "key": "name", - "optional": false, - "nullable": false, + "docstring": "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/FunctionObject/properties/name", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) $shared > (model) function_definition > (schema) > (property) description": { "kind": "HttpDeclProperty", - "docstring": "A description of what the function does, used by the model to choose when and how to call the function.", + "oasRef": "#/components/schemas/FunctionObject/properties/description", + "deprecated": false, "key": "description", - "optional": true, - "nullable": false, + "docstring": "A description of what the function does, used by the model to choose when and how to call the function.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/FunctionObject/properties/description", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(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](/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.", + "oasRef": "#/components/schemas/FunctionObject/properties/parameters", + "deprecated": false, "key": "parameters", - "optional": true, - "nullable": false, + "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.", "type": { "kind": "HttpTypeReference", "ident": "FunctionParameters", "$ref": "(resource) $shared > (model) function_parameters > (schema)" }, - "oasRef": "#/components/schemas/FunctionObject/properties/parameters", - "deprecated": false, - "schemaType": "map", + "optional": true, + "nullable": false, "modelImplicit": false, + "schemaType": "map", "modelPath": "(resource) $shared > (model) function_parameters", "children": [] }, "(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](/docs/guides/function-calling).", + "oasRef": "#/components/schemas/FunctionObject/properties/strict", + "deprecated": false, "key": "strict", - "optional": true, - "nullable": true, - "default": false, + "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).", "type": { "kind": "HttpTypeBoolean" }, - "oasRef": "#/components/schemas/FunctionObject/properties/strict", - "deprecated": false, + "default": false, + "optional": true, + "nullable": true, "schemaType": "boolean", "children": [] }, @@ -2609,29 +2611,29 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) function > (property) arguments": { "kind": "HttpDeclProperty", - "docstring": "The arguments that the model expects you to pass to the function.", + "oasRef": "#/components/schemas/RunToolCallObject/properties/function/properties/arguments", + "deprecated": false, "key": "arguments", - "optional": false, - "nullable": false, + "docstring": "The arguments that the model expects you to pass to the function.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunToolCallObject/properties/function/properties/arguments", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) function > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the function.", + "oasRef": "#/components/schemas/RunToolCallObject/properties/function/properties/name", + "deprecated": false, "key": "name", - "optional": false, - "nullable": false, + "docstring": "The name of the function.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunToolCallObject/properties/function/properties/name", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, @@ -2644,10 +2646,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options > (property) score_threshold": { "kind": "HttpDeclProperty", - "docstring": "The score threshold for the file search. All values must be a floating point number between 0 and 1.", + "oasRef": "#/components/schemas/FileSearchRankingOptions/properties/score_threshold", + "deprecated": false, "key": "score_threshold", - "optional": false, - "nullable": false, + "docstring": "The score threshold for the file search. All values must be a floating point number between 0 and 1.", "type": { "kind": "HttpTypeNumber" }, @@ -2655,19 +2657,20 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "minimum": 0, "maximum": 1 }, - "oasRef": "#/components/schemas/FileSearchRankingOptions/properties/score_threshold", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "number", "children": [] }, "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options > (property) ranker": { "kind": "HttpDeclProperty", - "docstring": "The ranker to use for the file search. If not specified will use the `auto` ranker.", + "oasRef": "#/components/schemas/FileSearchRankingOptions/properties/ranker", + "deprecated": false, "key": "ranker", - "optional": true, - "nullable": false, + "docstring": "The ranker to use for the file search. If not specified will use the `auto` ranker.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/FileSearchRankingOptions/properties/ranker", "types": [ { "kind": "HttpTypeLiteral", @@ -2677,11 +2680,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "default_2024_08_21" } - ], - "oasRef": "#/components/schemas/FileSearchRankingOptions/properties/ranker" + ] }, - "oasRef": "#/components/schemas/FileSearchRankingOptions/properties/ranker", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -2692,9 +2694,11 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) $shared > (model) function_parameters > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/FunctionParameters", + "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.", "ident": "FunctionParameters", "type": { "kind": "HttpTypeReference", + "oasRef": "#/components/schemas/FunctionParameters", "ident": "Record", "typeParameters": [ { @@ -2703,10 +2707,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch { "kind": "HttpTypeUnknown" } - ], - "oasRef": "#/components/schemas/FunctionParameters" + ] }, - "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": { @@ -2745,7 +2747,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/oneOf/1", - "ident": "UnionMember2", + "docstring": "Occurs when a [run](/docs/api-reference/runs/object) moves to a `queued` status.", + "ident": "ThreadRunQueued", "type": { "kind": "HttpTypeObject", "members": [ @@ -2757,7 +2760,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "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", @@ -2766,20 +2768,20 @@ 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](/docs/api-reference/threads).", + "oasRef": "#/components/schemas/RunStreamEvent/oneOf/1/properties/data", + "deprecated": false, "key": "data", - "optional": false, - "nullable": false, + "docstring": "Represents an execution run on a [thread](/docs/api-reference/threads).", + "title": "A run on a thread", "type": { "kind": "HttpTypeReference", "ident": "Run", "$ref": "(resource) beta.threads.runs > (model) run > (schema)" }, - "oasRef": "#/components/schemas/RunStreamEvent/oneOf/1/properties/data", - "deprecated": false, - "schemaType": "object", + "optional": false, + "nullable": false, "modelImplicit": false, + "schemaType": "object", "modelPath": "(resource) beta.threads.runs > (model) run", "childrenParentSchema": "object", "children": [ @@ -2814,21 +2816,21 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 2 > (property) event": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RunStreamEvent/oneOf/1/properties/event", + "deprecated": false, "key": "event", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStreamEvent/oneOf/1/properties/event", "types": [ { "kind": "HttpTypeLiteral", "literal": "thread.run.queued" } - ], - "oasRef": "#/components/schemas/RunStreamEvent/oneOf/1/properties/event" + ] }, - "oasRef": "#/components/schemas/RunStreamEvent/oneOf/1/properties/event", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -2837,123 +2839,123 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The identifier, which can be referenced in API endpoints.", + "oasRef": "#/components/schemas/RunObject/properties/id", + "deprecated": false, "key": "id", - "optional": false, - "nullable": false, + "docstring": "The identifier, which can be referenced in API endpoints.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunObject/properties/id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) assistant_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the [assistant](/docs/api-reference/assistants) used for execution of this run.", + "oasRef": "#/components/schemas/RunObject/properties/assistant_id", + "deprecated": false, "key": "assistant_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the [assistant](/docs/api-reference/assistants) used for execution of this run.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunObject/properties/assistant_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) cancelled_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the run was cancelled.", + "oasRef": "#/components/schemas/RunObject/properties/cancelled_at", + "deprecated": false, "key": "cancelled_at", - "optional": false, - "nullable": true, + "docstring": "The Unix timestamp (in seconds) for when the run was cancelled.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/RunObject/properties/cancelled_at", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) completed_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the run was completed.", + "oasRef": "#/components/schemas/RunObject/properties/completed_at", + "deprecated": false, "key": "completed_at", - "optional": false, - "nullable": true, + "docstring": "The Unix timestamp (in seconds) for when the run was completed.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/RunObject/properties/completed_at", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) created_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the run was created.", + "oasRef": "#/components/schemas/RunObject/properties/created_at", + "deprecated": false, "key": "created_at", - "optional": false, - "nullable": false, + "docstring": "The Unix timestamp (in seconds) for when the run was created.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/RunObject/properties/created_at", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) expires_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the run will expire.", + "oasRef": "#/components/schemas/RunObject/properties/expires_at", + "deprecated": false, "key": "expires_at", - "optional": false, - "nullable": true, + "docstring": "The Unix timestamp (in seconds) for when the run will expire.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/RunObject/properties/expires_at", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) failed_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the run failed.", + "oasRef": "#/components/schemas/RunObject/properties/failed_at", + "deprecated": false, "key": "failed_at", - "optional": false, - "nullable": true, + "docstring": "The Unix timestamp (in seconds) for when the run failed.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/RunObject/properties/failed_at", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) incomplete_details": { "kind": "HttpDeclProperty", - "docstring": "Details on why the run is incomplete. Will be `null` if the run is not incomplete.", + "oasRef": "#/components/schemas/RunObject/properties/incomplete_details", + "deprecated": false, "key": "incomplete_details", - "optional": false, - "nullable": true, + "docstring": "Details on why the run is incomplete. Will be `null` if the run is not incomplete.", "type": { "kind": "HttpTypeObject", "members": [ @@ -2962,8 +2964,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunObject/properties/incomplete_details", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -2972,24 +2974,24 @@ 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](/docs/api-reference/assistants) used for this run.", + "oasRef": "#/components/schemas/RunObject/properties/instructions", + "deprecated": false, "key": "instructions", - "optional": false, - "nullable": false, + "docstring": "The instructions that the [assistant](/docs/api-reference/assistants) used for this run.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunObject/properties/instructions", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) last_error": { "kind": "HttpDeclProperty", - "docstring": "The last error associated with this run. Will be `null` if there are no errors.", + "oasRef": "#/components/schemas/RunObject/properties/last_error", + "deprecated": false, "key": "last_error", - "optional": false, - "nullable": true, + "docstring": "The last error associated with this run. Will be `null` if there are no errors.", "type": { "kind": "HttpTypeObject", "members": [ @@ -3001,8 +3003,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunObject/properties/last_error", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -3012,88 +3014,88 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) max_completion_tokens": { "kind": "HttpDeclProperty", - "docstring": "The maximum number of completion tokens specified to have been used over the course of the run.\n", + "oasRef": "#/components/schemas/RunObject/properties/max_completion_tokens", + "deprecated": false, "key": "max_completion_tokens", - "optional": false, - "nullable": true, + "docstring": "The maximum number of completion tokens specified to have been used over the course of the run.\n", "type": { "kind": "HttpTypeNumber" }, "constraints": { "minimum": 256 }, - "oasRef": "#/components/schemas/RunObject/properties/max_completion_tokens", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) max_prompt_tokens": { "kind": "HttpDeclProperty", - "docstring": "The maximum number of prompt tokens specified to have been used over the course of the run.\n", + "oasRef": "#/components/schemas/RunObject/properties/max_prompt_tokens", + "deprecated": false, "key": "max_prompt_tokens", - "optional": false, - "nullable": true, + "docstring": "The maximum number of prompt tokens specified to have been used over the course of the run.\n", "type": { "kind": "HttpTypeNumber" }, "constraints": { "minimum": 256 }, - "oasRef": "#/components/schemas/RunObject/properties/max_prompt_tokens", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) metadata": { "kind": "HttpDeclProperty", - "docstring": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.\n", + "oasRef": "#/components/schemas/RunObject/properties/metadata", + "deprecated": false, "key": "metadata", - "optional": false, - "nullable": true, + "docstring": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.\n", "type": { "kind": "HttpTypeReference", "ident": "Metadata", "$ref": "(resource) $shared > (model) metadata > (schema)" }, - "oasRef": "#/components/schemas/RunObject/properties/metadata", - "deprecated": false, - "schemaType": "map", + "optional": false, + "nullable": true, "modelImplicit": false, + "schemaType": "map", "modelPath": "(resource) $shared > (model) metadata", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) model": { "kind": "HttpDeclProperty", - "docstring": "The model that the [assistant](/docs/api-reference/assistants) used for this run.", + "oasRef": "#/components/schemas/RunObject/properties/model", + "deprecated": false, "key": "model", - "optional": false, - "nullable": false, + "docstring": "The model that the [assistant](/docs/api-reference/assistants) used for this run.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunObject/properties/model", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) object": { "kind": "HttpDeclProperty", - "docstring": "The object type, which is always `thread.run`.", + "oasRef": "#/components/schemas/RunObject/properties/object", + "deprecated": false, "key": "object", - "optional": false, - "nullable": false, + "docstring": "The object type, which is always `thread.run`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunObject/properties/object", "types": [ { "kind": "HttpTypeLiteral", "literal": "thread.run" } - ], - "oasRef": "#/components/schemas/RunObject/properties/object" + ] }, - "oasRef": "#/components/schemas/RunObject/properties/object", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -3102,25 +3104,25 @@ 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](/docs/guides/function-calling#configuring-parallel-function-calling) during tool use.", + "oasRef": "#/components/schemas/RunObject/properties/parallel_tool_calls", + "deprecated": false, "key": "parallel_tool_calls", - "optional": false, - "nullable": false, - "default": true, + "docstring": "Whether to enable [parallel function calling](/docs/guides/function-calling#configuring-parallel-function-calling) during tool use.", "type": { "kind": "HttpTypeBoolean" }, - "oasRef": "#/components/schemas/RunObject/properties/parallel_tool_calls", - "deprecated": false, + "default": true, + "optional": false, + "nullable": false, "schemaType": "boolean", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) required_action": { "kind": "HttpDeclProperty", - "docstring": "Details on the action required to continue the run. Will be `null` if no action is required.", + "oasRef": "#/components/schemas/RunObject/properties/required_action", + "deprecated": false, "key": "required_action", - "optional": false, - "nullable": true, + "docstring": "Details on the action required to continue the run. Will be `null` if no action is required.", "type": { "kind": "HttpTypeObject", "members": [ @@ -3132,8 +3134,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunObject/properties/required_action", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -3143,19 +3145,19 @@ 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](/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", + "oasRef": "#/components/schemas/RunObject/properties/response_format", + "deprecated": false, "key": "response_format", - "optional": false, - "nullable": true, + "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", "type": { "kind": "HttpTypeReference", "ident": "AssistantResponseFormatOption", "$ref": "(resource) beta.threads > (model) assistant_response_format_option > (schema)" }, - "oasRef": "#/components/schemas/RunObject/properties/response_format", - "deprecated": false, - "schemaType": "union", + "optional": false, + "nullable": true, "modelImplicit": false, + "schemaType": "union", "modelPath": "(resource) beta.threads > (model) assistant_response_format_option", "childrenParentSchema": "union", "children": [ @@ -3167,29 +3169,30 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) started_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the run was started.", + "oasRef": "#/components/schemas/RunObject/properties/started_at", + "deprecated": false, "key": "started_at", - "optional": false, - "nullable": true, + "docstring": "The Unix timestamp (in seconds) for when the run was started.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/RunObject/properties/started_at", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) status": { "kind": "HttpDeclProperty", - "docstring": "The status of the run, which can be either `queued`, `in_progress`, `requires_action`, `cancelling`, `cancelled`, `failed`, `completed`, `incomplete`, or `expired`.", + "oasRef": "#/components/schemas/RunObject/properties/status", + "deprecated": false, "key": "status", - "optional": false, - "nullable": false, + "docstring": "The status of the run, which can be either `queued`, `in_progress`, `requires_action`, `cancelling`, `cancelled`, `failed`, `completed`, `incomplete`, or `expired`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunObject/properties/status", "types": [ { "kind": "HttpTypeLiteral", @@ -3227,11 +3230,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "expired" } - ], - "oasRef": "#/components/schemas/RunObject/properties/status" + ] }, - "oasRef": "#/components/schemas/RunObject/properties/status", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -3248,33 +3250,33 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) thread_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the [thread](/docs/api-reference/threads) that was executed on as a part of this run.", + "oasRef": "#/components/schemas/RunObject/properties/thread_id", + "deprecated": false, "key": "thread_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the [thread](/docs/api-reference/threads) that was executed on as a part of this run.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunObject/properties/thread_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) tool_choice": { "kind": "HttpDeclProperty", - "docstring": "Controls which (if any) tool is called by the model.\n`none` means the model will not call any tools and instead generates a message.\n`auto` is the default value and means the model can pick between generating a message or calling one or more tools.\n`required` means the model must call one or more tools before responding to the user.\nSpecifying a particular tool like `{\"type\": \"file_search\"}` or `{\"type\": \"function\", \"function\": {\"name\": \"my_function\"}}` forces the model to call that tool.\n", + "oasRef": "#/components/schemas/RunObject/properties/tool_choice", + "deprecated": false, "key": "tool_choice", - "optional": false, - "nullable": true, + "docstring": "Controls which (if any) tool is called by the model.\n`none` means the model will not call any tools and instead generates a message.\n`auto` is the default value and means the model can pick between generating a message or calling one or more tools.\n`required` means the model must call one or more tools before responding to the user.\nSpecifying a particular tool like `{\"type\": \"file_search\"}` or `{\"type\": \"function\", \"function\": {\"name\": \"my_function\"}}` forces the model to call that tool.\n", "type": { "kind": "HttpTypeReference", "ident": "AssistantToolChoiceOption", "$ref": "(resource) beta.threads > (model) assistant_tool_choice_option > (schema)" }, - "oasRef": "#/components/schemas/RunObject/properties/tool_choice", - "deprecated": false, - "schemaType": "union", + "optional": false, + "nullable": true, "modelImplicit": false, + "schemaType": "union", "modelPath": "(resource) beta.threads > (model) assistant_tool_choice_option", "childrenParentSchema": "union", "children": [ @@ -3284,15 +3286,16 @@ 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](/docs/api-reference/assistants) used for this run.", + "oasRef": "#/components/schemas/RunObject/properties/tools", + "deprecated": false, "key": "tools", - "optional": false, - "nullable": false, - "default": [], + "docstring": "The list of tools that the [assistant](/docs/api-reference/assistants) used for this run.", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RunObject/properties/tools", "elementType": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunObject/properties/tools/items", "types": [ { "kind": "HttpTypeReference", @@ -3309,13 +3312,12 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "ident": "FunctionTool", "$ref": "(resource) beta.assistants > (model) function_tool > (schema)" } - ], - "oasRef": "#/components/schemas/RunObject/properties/tools/items" - }, - "oasRef": "#/components/schemas/RunObject/properties/tools" + ] + } }, - "oasRef": "#/components/schemas/RunObject/properties/tools", - "deprecated": false, + "default": [], + "optional": false, + "nullable": false, "schemaType": "array", "childrenParentSchema": "union", "children": [ @@ -3326,11 +3328,11 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy": { "kind": "HttpDeclProperty", - "title": "Thread Truncation Controls", - "docstring": "Controls for how a thread will be truncated prior to the run. Use this to control the initial context window of the run.", + "oasRef": "#/components/schemas/RunObject/properties/truncation_strategy", + "deprecated": false, "key": "truncation_strategy", - "optional": false, - "nullable": true, + "docstring": "Controls for how a thread will be truncated prior to the run. Use this to control the initial context window of the run.", + "title": "Thread Truncation Controls", "type": { "kind": "HttpTypeObject", "members": [ @@ -3342,8 +3344,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunObject/properties/truncation_strategy", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -3353,10 +3355,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) usage": { "kind": "HttpDeclProperty", - "docstring": "Usage statistics related to the run. This value will be `null` if the run is not in a terminal state (i.e. `in_progress`, `queued`, etc.).", + "oasRef": "#/components/schemas/RunObject/properties/usage", + "deprecated": false, "key": "usage", - "optional": false, - "nullable": true, + "docstring": "Usage statistics related to the run. This value will be `null` if the run is not in a terminal state (i.e. `in_progress`, `queued`, etc.).", "type": { "kind": "HttpTypeObject", "members": [ @@ -3371,8 +3373,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunObject/properties/usage", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -3383,35 +3385,36 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) temperature": { "kind": "HttpDeclProperty", - "docstring": "The sampling temperature used for this run. If not set, defaults to 1.", + "oasRef": "#/components/schemas/RunObject/properties/temperature", + "deprecated": false, "key": "temperature", - "optional": true, - "nullable": true, + "docstring": "The sampling temperature used for this run. If not set, defaults to 1.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RunObject/properties/temperature", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "number", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) top_p": { "kind": "HttpDeclProperty", - "docstring": "The nucleus sampling value used for this run. If not set, defaults to 1.", + "oasRef": "#/components/schemas/RunObject/properties/top_p", + "deprecated": false, "key": "top_p", - "optional": true, - "nullable": true, + "docstring": "The nucleus sampling value used for this run. If not set, defaults to 1.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RunObject/properties/top_p", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "number", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RunObject", + "docstring": "Represents an execution run on a [thread](/docs/api-reference/threads).", "ident": "Run", "type": { "kind": "HttpTypeObject", @@ -3499,7 +3502,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Represents an execution run on a [thread](/docs/api-reference/threads).", "childrenParentSchema": "object", "children": [ "(resource) beta.threads.runs > (model) run > (schema) > (property) id", @@ -3540,12 +3542,13 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) incomplete_details > (property) reason": { "kind": "HttpDeclProperty", - "docstring": "The reason why the run is incomplete. This will point to which specific token limit was reached over the course of the run.", + "oasRef": "#/components/schemas/RunObject/properties/incomplete_details/properties/reason", + "deprecated": false, "key": "reason", - "optional": true, - "nullable": false, + "docstring": "The reason why the run is incomplete. This will point to which specific token limit was reached over the course of the run.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunObject/properties/incomplete_details/properties/reason", "types": [ { "kind": "HttpTypeLiteral", @@ -3555,11 +3558,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "max_prompt_tokens" } - ], - "oasRef": "#/components/schemas/RunObject/properties/incomplete_details/properties/reason" + ] }, - "oasRef": "#/components/schemas/RunObject/properties/incomplete_details/properties/reason", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -3569,12 +3571,13 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) code": { "kind": "HttpDeclProperty", - "docstring": "One of `server_error`, `rate_limit_exceeded`, or `invalid_prompt`.", + "oasRef": "#/components/schemas/RunObject/properties/last_error/properties/code", + "deprecated": false, "key": "code", - "optional": false, - "nullable": false, + "docstring": "One of `server_error`, `rate_limit_exceeded`, or `invalid_prompt`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunObject/properties/last_error/properties/code", "types": [ { "kind": "HttpTypeLiteral", @@ -3588,11 +3591,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "invalid_prompt" } - ], - "oasRef": "#/components/schemas/RunObject/properties/last_error/properties/code" + ] }, - "oasRef": "#/components/schemas/RunObject/properties/last_error/properties/code", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -3603,24 +3605,26 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) message": { "kind": "HttpDeclProperty", - "docstring": "A human-readable description of the error.", + "oasRef": "#/components/schemas/RunObject/properties/last_error/properties/message", + "deprecated": false, "key": "message", - "optional": false, - "nullable": false, + "docstring": "A human-readable description of the error.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunObject/properties/last_error/properties/message", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) $shared > (model) metadata > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/Metadata", + "docstring": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.\n", "ident": "Metadata", "type": { "kind": "HttpTypeReference", + "oasRef": "#/components/schemas/Metadata", "ident": "Record", "typeParameters": [ { @@ -3629,10 +3633,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch { "kind": "HttpTypeString" } - ], - "oasRef": "#/components/schemas/Metadata" + ] }, - "docstring": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.\n", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) object > (member) 0": { @@ -3644,10 +3646,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) required_action > (property) submit_tool_outputs": { "kind": "HttpDeclProperty", - "docstring": "Details on the tool outputs needed for this run to continue.", + "oasRef": "#/components/schemas/RunObject/properties/required_action/properties/submit_tool_outputs", + "deprecated": false, "key": "submit_tool_outputs", - "optional": false, - "nullable": false, + "docstring": "Details on the tool outputs needed for this run to continue.", "type": { "kind": "HttpTypeObject", "members": [ @@ -3656,8 +3658,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunObject/properties/required_action/properties/submit_tool_outputs", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -3666,22 +3668,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) required_action > (property) type": { "kind": "HttpDeclProperty", - "docstring": "For now, this is always `submit_tool_outputs`.", + "oasRef": "#/components/schemas/RunObject/properties/required_action/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "For now, this is always `submit_tool_outputs`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunObject/properties/required_action/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "submit_tool_outputs" } - ], - "oasRef": "#/components/schemas/RunObject/properties/required_action/properties/type" + ] }, - "oasRef": "#/components/schemas/RunObject/properties/required_action/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -3691,18 +3693,18 @@ 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/oneOf/0", + "docstring": "`auto` is the default value\n", "ident": "UnionMember0", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/oneOf/0", "types": [ { "kind": "HttpTypeLiteral", "literal": "auto" } - ], - "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/oneOf/0" + ] }, - "docstring": "`auto` is the default value\n", "childrenParentSchema": "enum", "children": [ "(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 0 > (member) 0" @@ -3748,19 +3750,21 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads > (model) assistant_response_format_option > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption", + "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", "ident": "AssistantResponseFormatOption", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption", "types": [ { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/oneOf/0", "types": [ { "kind": "HttpTypeLiteral", "literal": "auto" } - ], - "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/oneOf/0" + ] }, { "kind": "HttpTypeReference", @@ -3777,10 +3781,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "ident": "ResponseFormatJSONSchema", "$ref": "(resource) $shared > (model) response_format_json_schema > (schema)" } - ], - "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption" + ] }, - "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", @@ -3855,9 +3857,11 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0": { "kind": "HttpDeclTypeAlias", "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", "ident": "UnionMember0", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption/oneOf/0", "types": [ { "kind": "HttpTypeLiteral", @@ -3871,10 +3875,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "required" } - ], - "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", "children": [ "(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0 > (member) 0", @@ -3898,12 +3900,15 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads > (model) assistant_tool_choice_option > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption", + "docstring": "Controls which (if any) tool is called by the model.\n`none` means the model will not call any tools and instead generates a message.\n`auto` is the default value and means the model can pick between generating a message or calling one or more tools.\n`required` means the model must call one or more tools before responding to the user.\nSpecifying a particular tool like `{\"type\": \"file_search\"}` or `{\"type\": \"function\", \"function\": {\"name\": \"my_function\"}}` forces the model to call that tool.\n", "ident": "AssistantToolChoiceOption", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption", "types": [ { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption/oneOf/0", "types": [ { "kind": "HttpTypeLiteral", @@ -3917,18 +3922,15 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "required" } - ], - "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption/oneOf/0" + ] }, { "kind": "HttpTypeReference", "ident": "AssistantToolChoice", "$ref": "(resource) beta.threads > (model) assistant_tool_choice > (schema)" } - ], - "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption" + ] }, - "docstring": "Controls which (if any) tool is called by the model.\n`none` means the model will not call any tools and instead generates a message.\n`auto` is the default value and means the model can pick between generating a message or calling one or more tools.\n`required` means the model must call one or more tools before responding to the user.\nSpecifying a particular tool like `{\"type\": \"file_search\"}` or `{\"type\": \"function\", \"function\": {\"name\": \"my_function\"}}` forces the model to call that tool.\n", "childrenParentSchema": "union", "children": [ "(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0", @@ -4034,12 +4036,13 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The truncation strategy to use for the thread. The default is `auto`. If set to `last_messages`, the thread will be truncated to the n most recent messages in the thread. When set to `auto`, messages in the middle of the thread will be dropped to fit the context length of the model, `max_prompt_tokens`.", + "oasRef": "#/components/schemas/TruncationObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The truncation strategy to use for the thread. The default is `auto`. If set to `last_messages`, the thread will be truncated to the n most recent messages in the thread. When set to `auto`, messages in the middle of the thread will be dropped to fit the context length of the model, `max_prompt_tokens`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/TruncationObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", @@ -4049,11 +4052,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "last_messages" } - ], - "oasRef": "#/components/schemas/TruncationObject/properties/type" + ] }, - "oasRef": "#/components/schemas/TruncationObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -4063,60 +4065,60 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) last_messages": { "kind": "HttpDeclProperty", - "docstring": "The number of most recent messages from the thread when constructing the context for the run.", + "oasRef": "#/components/schemas/TruncationObject/properties/last_messages", + "deprecated": false, "key": "last_messages", - "optional": true, - "nullable": true, + "docstring": "The number of most recent messages from the thread when constructing the context for the run.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "minimum": 1 }, - "oasRef": "#/components/schemas/TruncationObject/properties/last_messages", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) usage > (property) completion_tokens": { "kind": "HttpDeclProperty", - "docstring": "Number of completion tokens used over the course of the run.", + "oasRef": "#/components/schemas/RunCompletionUsage/anyOf/0/properties/completion_tokens", + "deprecated": false, "key": "completion_tokens", - "optional": false, - "nullable": false, + "docstring": "Number of completion tokens used over the course of the run.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RunCompletionUsage/anyOf/0/properties/completion_tokens", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) usage > (property) prompt_tokens": { "kind": "HttpDeclProperty", - "docstring": "Number of prompt tokens used over the course of the run.", + "oasRef": "#/components/schemas/RunCompletionUsage/anyOf/0/properties/prompt_tokens", + "deprecated": false, "key": "prompt_tokens", - "optional": false, - "nullable": false, + "docstring": "Number of prompt tokens used over the course of the run.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RunCompletionUsage/anyOf/0/properties/prompt_tokens", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) usage > (property) total_tokens": { "kind": "HttpDeclProperty", - "docstring": "Total number of tokens used (prompt + completion).", + "oasRef": "#/components/schemas/RunCompletionUsage/anyOf/0/properties/total_tokens", + "deprecated": false, "key": "total_tokens", - "optional": false, - "nullable": false, + "docstring": "Total number of tokens used (prompt + completion).", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RunCompletionUsage/anyOf/0/properties/total_tokens", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, @@ -4157,21 +4159,21 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) required_action > (property) submit_tool_outputs > (property) tool_calls": { "kind": "HttpDeclProperty", - "docstring": "A list of the relevant tool calls.", + "oasRef": "#/components/schemas/RunObject/properties/required_action/properties/submit_tool_outputs/properties/tool_calls", + "deprecated": false, "key": "tool_calls", - "optional": false, - "nullable": false, + "docstring": "A list of the relevant tool calls.", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RunObject/properties/required_action/properties/submit_tool_outputs/properties/tool_calls", "elementType": { "kind": "HttpTypeReference", "ident": "RequiredActionFunctionToolCall", "$ref": "(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema)" + } }, - "oasRef": "#/components/schemas/RunObject/properties/required_action/properties/submit_tool_outputs/properties/tool_calls" - }, - "oasRef": "#/components/schemas/RunObject/properties/required_action/properties/submit_tool_outputs/properties/tool_calls", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "array", "childrenParentSchema": "object", "children": [ @@ -4196,22 +4198,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) $shared > (model) response_format_text > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of response format being defined. Always `text`.", + "oasRef": "#/components/schemas/ResponseFormatText/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of response format being defined. Always `text`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/ResponseFormatText/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "text" } - ], - "oasRef": "#/components/schemas/ResponseFormatText/properties/type" + ] }, - "oasRef": "#/components/schemas/ResponseFormatText/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -4221,6 +4223,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) $shared > (model) response_format_text > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/ResponseFormatText", + "docstring": "Default response format. Used to generate text responses.\n", "ident": "ResponseFormatText", "type": { "kind": "HttpTypeObject", @@ -4230,7 +4233,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Default response format. Used to generate text responses.\n", "childrenParentSchema": "object", "children": [ "(resource) $shared > (model) response_format_text > (schema) > (property) type" @@ -4238,22 +4240,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) $shared > (model) response_format_json_object > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of response format being defined. Always `json_object`.", + "oasRef": "#/components/schemas/ResponseFormatJsonObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of response format being defined. Always `json_object`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/ResponseFormatJsonObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "json_object" } - ], - "oasRef": "#/components/schemas/ResponseFormatJsonObject/properties/type" + ] }, - "oasRef": "#/components/schemas/ResponseFormatJsonObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -4263,6 +4265,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) $shared > (model) response_format_json_object > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/ResponseFormatJsonObject", + "docstring": "JSON object response format. An older method of generating JSON responses.\nUsing `json_schema` is recommended for models that support it. Note that the\nmodel will not generate JSON without a system or user message instructing it\nto do so.\n", "ident": "ResponseFormatJSONObject", "type": { "kind": "HttpTypeObject", @@ -4272,7 +4275,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "JSON object response format. An older method of generating JSON responses.\nUsing `json_schema` is recommended for models that support it. Note that the\nmodel will not generate JSON without a system or user message instructing it\nto do so.\n", "childrenParentSchema": "object", "children": [ "(resource) $shared > (model) response_format_json_object > (schema) > (property) type" @@ -4280,11 +4282,11 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema": { "kind": "HttpDeclProperty", - "title": "JSON schema", - "docstring": "Structured Outputs configuration options, including a JSON Schema.\n", + "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema", + "deprecated": false, "key": "json_schema", - "optional": false, - "nullable": false, + "docstring": "Structured Outputs configuration options, including a JSON Schema.\n", + "title": "JSON schema", "type": { "kind": "HttpTypeObject", "members": [ @@ -4302,8 +4304,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -4315,22 +4317,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) $shared > (model) response_format_json_schema > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of response format being defined. Always `json_schema`.", + "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of response format being defined. Always `json_schema`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "json_schema" } - ], - "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/type" + ] }, - "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -4340,6 +4342,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) $shared > (model) response_format_json_schema > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/ResponseFormatJsonSchema", + "docstring": "JSON Schema response format. Used to generate structured JSON responses.\nLearn more about [Structured Outputs](/docs/guides/structured-outputs).\n", "ident": "ResponseFormatJSONSchema", "type": { "kind": "HttpTypeObject", @@ -4352,7 +4355,6 @@ 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](/docs/guides/structured-outputs).\n", "childrenParentSchema": "object", "children": [ "(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema", @@ -4382,12 +4384,13 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the tool. If type is `function`, the function name must be set", + "oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the tool. If type is `function`, the function name must be set", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/type", "types": [ { "kind": "HttpTypeLiteral", @@ -4401,11 +4404,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "file_search" } - ], - "oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/type" + ] }, - "oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -4416,18 +4418,18 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) function": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/function", + "deprecated": false, "key": "function", - "optional": true, - "nullable": false, "type": { "kind": "HttpTypeReference", "ident": "AssistantToolChoiceFunction", "$ref": "(resource) beta.threads > (model) assistant_tool_choice_function > (schema)" }, - "oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/function", - "deprecated": false, - "schemaType": "object", + "optional": true, + "nullable": false, "modelImplicit": false, + "schemaType": "object", "modelPath": "(resource) beta.threads > (model) assistant_tool_choice_function", "childrenParentSchema": "object", "children": [ @@ -4437,6 +4439,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads > (model) assistant_tool_choice > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/AssistantsNamedToolChoice", + "docstring": "Specifies a tool the model should use. Use to force the model to call a specific tool.", "ident": "AssistantToolChoice", "type": { "kind": "HttpTypeObject", @@ -4449,7 +4452,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Specifies a tool the model should use. Use to force the model to call a specific tool.", "childrenParentSchema": "object", "children": [ "(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) type", @@ -4458,22 +4460,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of tool being defined: `code_interpreter`", + "oasRef": "#/components/schemas/AssistantToolsCode/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of tool being defined: `code_interpreter`", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantToolsCode/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "code_interpreter" } - ], - "oasRef": "#/components/schemas/AssistantToolsCode/properties/type" + ] }, - "oasRef": "#/components/schemas/AssistantToolsCode/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -4482,22 +4484,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of tool being defined: `file_search`", + "oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of tool being defined: `file_search`", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "file_search" } - ], - "oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/type" + ] }, - "oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -4506,10 +4508,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search": { "kind": "HttpDeclProperty", - "docstring": "Overrides for the file search tool.", + "oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/file_search", + "deprecated": false, "key": "file_search", - "optional": true, - "nullable": false, + "docstring": "Overrides for the file search tool.", "type": { "kind": "HttpTypeObject", "members": [ @@ -4521,8 +4523,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/file_search", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -4532,18 +4534,18 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) function_tool > (schema) > (property) function": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/AssistantToolsFunction/properties/function", + "deprecated": false, "key": "function", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeReference", "ident": "FunctionDefinition", "$ref": "(resource) $shared > (model) function_definition > (schema)" }, - "oasRef": "#/components/schemas/AssistantToolsFunction/properties/function", - "deprecated": false, - "schemaType": "object", + "optional": false, + "nullable": false, "modelImplicit": false, + "schemaType": "object", "modelPath": "(resource) $shared > (model) function_definition", "childrenParentSchema": "object", "children": [ @@ -4555,22 +4557,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) function_tool > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of tool being defined: `function`", + "oasRef": "#/components/schemas/AssistantToolsFunction/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of tool being defined: `function`", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantToolsFunction/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "function" } - ], - "oasRef": "#/components/schemas/AssistantToolsFunction/properties/type" + ] }, - "oasRef": "#/components/schemas/AssistantToolsFunction/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -4593,24 +4595,24 @@ 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](/docs/api-reference/runs/submitToolOutputs) endpoint.", + "oasRef": "#/components/schemas/RunToolCallObject/properties/id", + "deprecated": false, "key": "id", - "optional": false, - "nullable": false, + "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.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunToolCallObject/properties/id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) function": { "kind": "HttpDeclProperty", - "docstring": "The function definition.", + "oasRef": "#/components/schemas/RunToolCallObject/properties/function", + "deprecated": false, "key": "function", - "optional": false, - "nullable": false, + "docstring": "The function definition.", "type": { "kind": "HttpTypeObject", "members": [ @@ -4622,8 +4624,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunToolCallObject/properties/function", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -4633,22 +4635,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of tool call the output is required for. For now, this is always `function`.", + "oasRef": "#/components/schemas/RunToolCallObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of tool call the output is required for. For now, this is always `function`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunToolCallObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "function" } - ], - "oasRef": "#/components/schemas/RunToolCallObject/properties/type" + ] }, - "oasRef": "#/components/schemas/RunToolCallObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -4658,6 +4660,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RunToolCallObject", + "docstring": "Tool call objects", "ident": "RequiredActionFunctionToolCall", "type": { "kind": "HttpTypeObject", @@ -4673,7 +4676,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Tool call objects", "childrenParentSchema": "object", "children": [ "(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) id", @@ -4697,41 +4699,42 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the response format. Must be a-z, A-Z, 0-9, or contain\nunderscores and dashes, with a maximum length of 64.\n", + "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/name", + "deprecated": false, "key": "name", - "optional": false, - "nullable": false, + "docstring": "The name of the response format. Must be a-z, A-Z, 0-9, or contain\nunderscores and dashes, with a maximum length of 64.\n", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/name", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema > (property) description": { "kind": "HttpDeclProperty", - "docstring": "A description of what the response format is for, used by the model to\ndetermine how to respond in the format.\n", + "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/description", + "deprecated": false, "key": "description", - "optional": true, - "nullable": false, + "docstring": "A description of what the response format is for, used by the model to\ndetermine how to respond in the format.\n", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/description", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema > (property) schema": { "kind": "HttpDeclProperty", - "title": "JSON schema", - "docstring": "The schema for the response format, described as a JSON Schema object.\nLearn how to build JSON schemas [here](https://json-schema.org/).\n", + "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/schema", + "deprecated": false, "key": "schema", - "optional": true, - "nullable": false, + "docstring": "The schema for the response format, described as a JSON Schema object.\nLearn how to build JSON schemas [here](https://json-schema.org/).\n", + "title": "JSON schema", "type": { "kind": "HttpTypeReference", + "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/schema", "ident": "Record", "typeParameters": [ { @@ -4740,26 +4743,25 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch { "kind": "HttpTypeUnknown" } - ], - "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/schema" + ] }, - "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/schema", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "map", "children": [] }, "(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](/docs/guides/structured-outputs).\n", + "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/strict", + "deprecated": false, "key": "strict", - "optional": true, - "nullable": true, - "default": false, + "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", "type": { "kind": "HttpTypeBoolean" }, - "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/strict", - "deprecated": false, + "default": false, + "optional": true, + "nullable": true, "schemaType": "boolean", "children": [] }, @@ -4793,15 +4795,15 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads > (model) assistant_tool_choice_function > (schema) > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the function to call.", + "oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/function/properties/name", + "deprecated": false, "key": "name", - "optional": false, - "nullable": false, + "docstring": "The name of the function to call.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/function/properties/name", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, @@ -4838,10 +4840,10 @@ 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](/docs/assistants/tools/file-search#customizing-file-search-settings) for more information.\n", + "oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/file_search/properties/max_num_results", + "deprecated": false, "key": "max_num_results", - "optional": true, - "nullable": false, + "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", "type": { "kind": "HttpTypeNumber" }, @@ -4849,18 +4851,18 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "minimum": 1, "maximum": 50 }, - "oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/file_search/properties/max_num_results", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "integer", "children": [] }, "(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](/docs/assistants/tools/file-search#customizing-file-search-settings) for more information.\n", + "oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/file_search/properties/ranking_options", + "deprecated": false, "key": "ranking_options", - "optional": true, - "nullable": false, + "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", + "title": "File search tool call ranking options", "type": { "kind": "HttpTypeObject", "members": [ @@ -4872,8 +4874,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/file_search/properties/ranking_options", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -4883,62 +4885,62 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) $shared > (model) function_definition > (schema) > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.", + "oasRef": "#/components/schemas/FunctionObject/properties/name", + "deprecated": false, "key": "name", - "optional": false, - "nullable": false, + "docstring": "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/FunctionObject/properties/name", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) $shared > (model) function_definition > (schema) > (property) description": { "kind": "HttpDeclProperty", - "docstring": "A description of what the function does, used by the model to choose when and how to call the function.", + "oasRef": "#/components/schemas/FunctionObject/properties/description", + "deprecated": false, "key": "description", - "optional": true, - "nullable": false, + "docstring": "A description of what the function does, used by the model to choose when and how to call the function.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/FunctionObject/properties/description", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(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](/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.", + "oasRef": "#/components/schemas/FunctionObject/properties/parameters", + "deprecated": false, "key": "parameters", - "optional": true, - "nullable": false, + "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.", "type": { "kind": "HttpTypeReference", "ident": "FunctionParameters", "$ref": "(resource) $shared > (model) function_parameters > (schema)" }, - "oasRef": "#/components/schemas/FunctionObject/properties/parameters", - "deprecated": false, - "schemaType": "map", + "optional": true, + "nullable": false, "modelImplicit": false, + "schemaType": "map", "modelPath": "(resource) $shared > (model) function_parameters", "children": [] }, "(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](/docs/guides/function-calling).", + "oasRef": "#/components/schemas/FunctionObject/properties/strict", + "deprecated": false, "key": "strict", - "optional": true, - "nullable": true, - "default": false, + "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).", "type": { "kind": "HttpTypeBoolean" }, - "oasRef": "#/components/schemas/FunctionObject/properties/strict", - "deprecated": false, + "default": false, + "optional": true, + "nullable": true, "schemaType": "boolean", "children": [] }, @@ -4980,29 +4982,29 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) function > (property) arguments": { "kind": "HttpDeclProperty", - "docstring": "The arguments that the model expects you to pass to the function.", + "oasRef": "#/components/schemas/RunToolCallObject/properties/function/properties/arguments", + "deprecated": false, "key": "arguments", - "optional": false, - "nullable": false, + "docstring": "The arguments that the model expects you to pass to the function.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunToolCallObject/properties/function/properties/arguments", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) function > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the function.", + "oasRef": "#/components/schemas/RunToolCallObject/properties/function/properties/name", + "deprecated": false, "key": "name", - "optional": false, - "nullable": false, + "docstring": "The name of the function.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunToolCallObject/properties/function/properties/name", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, @@ -5015,10 +5017,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options > (property) score_threshold": { "kind": "HttpDeclProperty", - "docstring": "The score threshold for the file search. All values must be a floating point number between 0 and 1.", + "oasRef": "#/components/schemas/FileSearchRankingOptions/properties/score_threshold", + "deprecated": false, "key": "score_threshold", - "optional": false, - "nullable": false, + "docstring": "The score threshold for the file search. All values must be a floating point number between 0 and 1.", "type": { "kind": "HttpTypeNumber" }, @@ -5026,19 +5028,20 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "minimum": 0, "maximum": 1 }, - "oasRef": "#/components/schemas/FileSearchRankingOptions/properties/score_threshold", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "number", "children": [] }, "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options > (property) ranker": { "kind": "HttpDeclProperty", - "docstring": "The ranker to use for the file search. If not specified will use the `auto` ranker.", + "oasRef": "#/components/schemas/FileSearchRankingOptions/properties/ranker", + "deprecated": false, "key": "ranker", - "optional": true, - "nullable": false, + "docstring": "The ranker to use for the file search. If not specified will use the `auto` ranker.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/FileSearchRankingOptions/properties/ranker", "types": [ { "kind": "HttpTypeLiteral", @@ -5048,11 +5051,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "default_2024_08_21" } - ], - "oasRef": "#/components/schemas/FileSearchRankingOptions/properties/ranker" + ] }, - "oasRef": "#/components/schemas/FileSearchRankingOptions/properties/ranker", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -5063,9 +5065,11 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) $shared > (model) function_parameters > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/FunctionParameters", + "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.", "ident": "FunctionParameters", "type": { "kind": "HttpTypeReference", + "oasRef": "#/components/schemas/FunctionParameters", "ident": "Record", "typeParameters": [ { @@ -5074,10 +5078,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch { "kind": "HttpTypeUnknown" } - ], - "oasRef": "#/components/schemas/FunctionParameters" + ] }, - "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": { @@ -5116,7 +5118,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/oneOf/2", - "ident": "UnionMember3", + "docstring": "Occurs when a [run](/docs/api-reference/runs/object) moves to an `in_progress` status.", + "ident": "ThreadRunInProgress", "type": { "kind": "HttpTypeObject", "members": [ @@ -5128,7 +5131,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "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", @@ -5137,20 +5139,20 @@ 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](/docs/api-reference/threads).", + "oasRef": "#/components/schemas/RunStreamEvent/oneOf/2/properties/data", + "deprecated": false, "key": "data", - "optional": false, - "nullable": false, + "docstring": "Represents an execution run on a [thread](/docs/api-reference/threads).", + "title": "A run on a thread", "type": { "kind": "HttpTypeReference", "ident": "Run", "$ref": "(resource) beta.threads.runs > (model) run > (schema)" }, - "oasRef": "#/components/schemas/RunStreamEvent/oneOf/2/properties/data", - "deprecated": false, - "schemaType": "object", + "optional": false, + "nullable": false, "modelImplicit": false, + "schemaType": "object", "modelPath": "(resource) beta.threads.runs > (model) run", "childrenParentSchema": "object", "children": [ @@ -5185,21 +5187,21 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 3 > (property) event": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RunStreamEvent/oneOf/2/properties/event", + "deprecated": false, "key": "event", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStreamEvent/oneOf/2/properties/event", "types": [ { "kind": "HttpTypeLiteral", "literal": "thread.run.in_progress" } - ], - "oasRef": "#/components/schemas/RunStreamEvent/oneOf/2/properties/event" + ] }, - "oasRef": "#/components/schemas/RunStreamEvent/oneOf/2/properties/event", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -5208,123 +5210,123 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The identifier, which can be referenced in API endpoints.", + "oasRef": "#/components/schemas/RunObject/properties/id", + "deprecated": false, "key": "id", - "optional": false, - "nullable": false, + "docstring": "The identifier, which can be referenced in API endpoints.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunObject/properties/id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) assistant_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the [assistant](/docs/api-reference/assistants) used for execution of this run.", + "oasRef": "#/components/schemas/RunObject/properties/assistant_id", + "deprecated": false, "key": "assistant_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the [assistant](/docs/api-reference/assistants) used for execution of this run.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunObject/properties/assistant_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) cancelled_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the run was cancelled.", + "oasRef": "#/components/schemas/RunObject/properties/cancelled_at", + "deprecated": false, "key": "cancelled_at", - "optional": false, - "nullable": true, + "docstring": "The Unix timestamp (in seconds) for when the run was cancelled.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/RunObject/properties/cancelled_at", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) completed_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the run was completed.", + "oasRef": "#/components/schemas/RunObject/properties/completed_at", + "deprecated": false, "key": "completed_at", - "optional": false, - "nullable": true, + "docstring": "The Unix timestamp (in seconds) for when the run was completed.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/RunObject/properties/completed_at", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) created_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the run was created.", + "oasRef": "#/components/schemas/RunObject/properties/created_at", + "deprecated": false, "key": "created_at", - "optional": false, - "nullable": false, + "docstring": "The Unix timestamp (in seconds) for when the run was created.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/RunObject/properties/created_at", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) expires_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the run will expire.", + "oasRef": "#/components/schemas/RunObject/properties/expires_at", + "deprecated": false, "key": "expires_at", - "optional": false, - "nullable": true, + "docstring": "The Unix timestamp (in seconds) for when the run will expire.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/RunObject/properties/expires_at", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) failed_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the run failed.", + "oasRef": "#/components/schemas/RunObject/properties/failed_at", + "deprecated": false, "key": "failed_at", - "optional": false, - "nullable": true, + "docstring": "The Unix timestamp (in seconds) for when the run failed.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/RunObject/properties/failed_at", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) incomplete_details": { "kind": "HttpDeclProperty", - "docstring": "Details on why the run is incomplete. Will be `null` if the run is not incomplete.", + "oasRef": "#/components/schemas/RunObject/properties/incomplete_details", + "deprecated": false, "key": "incomplete_details", - "optional": false, - "nullable": true, + "docstring": "Details on why the run is incomplete. Will be `null` if the run is not incomplete.", "type": { "kind": "HttpTypeObject", "members": [ @@ -5333,8 +5335,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunObject/properties/incomplete_details", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -5343,24 +5345,24 @@ 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](/docs/api-reference/assistants) used for this run.", + "oasRef": "#/components/schemas/RunObject/properties/instructions", + "deprecated": false, "key": "instructions", - "optional": false, - "nullable": false, + "docstring": "The instructions that the [assistant](/docs/api-reference/assistants) used for this run.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunObject/properties/instructions", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) last_error": { "kind": "HttpDeclProperty", - "docstring": "The last error associated with this run. Will be `null` if there are no errors.", + "oasRef": "#/components/schemas/RunObject/properties/last_error", + "deprecated": false, "key": "last_error", - "optional": false, - "nullable": true, + "docstring": "The last error associated with this run. Will be `null` if there are no errors.", "type": { "kind": "HttpTypeObject", "members": [ @@ -5372,8 +5374,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunObject/properties/last_error", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -5383,88 +5385,88 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) max_completion_tokens": { "kind": "HttpDeclProperty", - "docstring": "The maximum number of completion tokens specified to have been used over the course of the run.\n", + "oasRef": "#/components/schemas/RunObject/properties/max_completion_tokens", + "deprecated": false, "key": "max_completion_tokens", - "optional": false, - "nullable": true, + "docstring": "The maximum number of completion tokens specified to have been used over the course of the run.\n", "type": { "kind": "HttpTypeNumber" }, "constraints": { "minimum": 256 }, - "oasRef": "#/components/schemas/RunObject/properties/max_completion_tokens", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) max_prompt_tokens": { "kind": "HttpDeclProperty", - "docstring": "The maximum number of prompt tokens specified to have been used over the course of the run.\n", + "oasRef": "#/components/schemas/RunObject/properties/max_prompt_tokens", + "deprecated": false, "key": "max_prompt_tokens", - "optional": false, - "nullable": true, + "docstring": "The maximum number of prompt tokens specified to have been used over the course of the run.\n", "type": { "kind": "HttpTypeNumber" }, "constraints": { "minimum": 256 }, - "oasRef": "#/components/schemas/RunObject/properties/max_prompt_tokens", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) metadata": { "kind": "HttpDeclProperty", - "docstring": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.\n", + "oasRef": "#/components/schemas/RunObject/properties/metadata", + "deprecated": false, "key": "metadata", - "optional": false, - "nullable": true, + "docstring": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.\n", "type": { "kind": "HttpTypeReference", "ident": "Metadata", "$ref": "(resource) $shared > (model) metadata > (schema)" }, - "oasRef": "#/components/schemas/RunObject/properties/metadata", - "deprecated": false, - "schemaType": "map", + "optional": false, + "nullable": true, "modelImplicit": false, + "schemaType": "map", "modelPath": "(resource) $shared > (model) metadata", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) model": { "kind": "HttpDeclProperty", - "docstring": "The model that the [assistant](/docs/api-reference/assistants) used for this run.", + "oasRef": "#/components/schemas/RunObject/properties/model", + "deprecated": false, "key": "model", - "optional": false, - "nullable": false, + "docstring": "The model that the [assistant](/docs/api-reference/assistants) used for this run.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunObject/properties/model", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) object": { "kind": "HttpDeclProperty", - "docstring": "The object type, which is always `thread.run`.", + "oasRef": "#/components/schemas/RunObject/properties/object", + "deprecated": false, "key": "object", - "optional": false, - "nullable": false, + "docstring": "The object type, which is always `thread.run`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunObject/properties/object", "types": [ { "kind": "HttpTypeLiteral", "literal": "thread.run" } - ], - "oasRef": "#/components/schemas/RunObject/properties/object" + ] }, - "oasRef": "#/components/schemas/RunObject/properties/object", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -5473,25 +5475,25 @@ 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](/docs/guides/function-calling#configuring-parallel-function-calling) during tool use.", + "oasRef": "#/components/schemas/RunObject/properties/parallel_tool_calls", + "deprecated": false, "key": "parallel_tool_calls", - "optional": false, - "nullable": false, - "default": true, + "docstring": "Whether to enable [parallel function calling](/docs/guides/function-calling#configuring-parallel-function-calling) during tool use.", "type": { "kind": "HttpTypeBoolean" }, - "oasRef": "#/components/schemas/RunObject/properties/parallel_tool_calls", - "deprecated": false, + "default": true, + "optional": false, + "nullable": false, "schemaType": "boolean", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) required_action": { "kind": "HttpDeclProperty", - "docstring": "Details on the action required to continue the run. Will be `null` if no action is required.", + "oasRef": "#/components/schemas/RunObject/properties/required_action", + "deprecated": false, "key": "required_action", - "optional": false, - "nullable": true, + "docstring": "Details on the action required to continue the run. Will be `null` if no action is required.", "type": { "kind": "HttpTypeObject", "members": [ @@ -5503,8 +5505,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunObject/properties/required_action", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -5514,19 +5516,19 @@ 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](/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", + "oasRef": "#/components/schemas/RunObject/properties/response_format", + "deprecated": false, "key": "response_format", - "optional": false, - "nullable": true, + "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", "type": { "kind": "HttpTypeReference", "ident": "AssistantResponseFormatOption", "$ref": "(resource) beta.threads > (model) assistant_response_format_option > (schema)" }, - "oasRef": "#/components/schemas/RunObject/properties/response_format", - "deprecated": false, - "schemaType": "union", + "optional": false, + "nullable": true, "modelImplicit": false, + "schemaType": "union", "modelPath": "(resource) beta.threads > (model) assistant_response_format_option", "childrenParentSchema": "union", "children": [ @@ -5538,29 +5540,30 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) started_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the run was started.", + "oasRef": "#/components/schemas/RunObject/properties/started_at", + "deprecated": false, "key": "started_at", - "optional": false, - "nullable": true, + "docstring": "The Unix timestamp (in seconds) for when the run was started.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/RunObject/properties/started_at", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) status": { "kind": "HttpDeclProperty", - "docstring": "The status of the run, which can be either `queued`, `in_progress`, `requires_action`, `cancelling`, `cancelled`, `failed`, `completed`, `incomplete`, or `expired`.", + "oasRef": "#/components/schemas/RunObject/properties/status", + "deprecated": false, "key": "status", - "optional": false, - "nullable": false, + "docstring": "The status of the run, which can be either `queued`, `in_progress`, `requires_action`, `cancelling`, `cancelled`, `failed`, `completed`, `incomplete`, or `expired`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunObject/properties/status", "types": [ { "kind": "HttpTypeLiteral", @@ -5598,11 +5601,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "expired" } - ], - "oasRef": "#/components/schemas/RunObject/properties/status" + ] }, - "oasRef": "#/components/schemas/RunObject/properties/status", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -5619,33 +5621,33 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) thread_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the [thread](/docs/api-reference/threads) that was executed on as a part of this run.", + "oasRef": "#/components/schemas/RunObject/properties/thread_id", + "deprecated": false, "key": "thread_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the [thread](/docs/api-reference/threads) that was executed on as a part of this run.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunObject/properties/thread_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) tool_choice": { "kind": "HttpDeclProperty", - "docstring": "Controls which (if any) tool is called by the model.\n`none` means the model will not call any tools and instead generates a message.\n`auto` is the default value and means the model can pick between generating a message or calling one or more tools.\n`required` means the model must call one or more tools before responding to the user.\nSpecifying a particular tool like `{\"type\": \"file_search\"}` or `{\"type\": \"function\", \"function\": {\"name\": \"my_function\"}}` forces the model to call that tool.\n", + "oasRef": "#/components/schemas/RunObject/properties/tool_choice", + "deprecated": false, "key": "tool_choice", - "optional": false, - "nullable": true, + "docstring": "Controls which (if any) tool is called by the model.\n`none` means the model will not call any tools and instead generates a message.\n`auto` is the default value and means the model can pick between generating a message or calling one or more tools.\n`required` means the model must call one or more tools before responding to the user.\nSpecifying a particular tool like `{\"type\": \"file_search\"}` or `{\"type\": \"function\", \"function\": {\"name\": \"my_function\"}}` forces the model to call that tool.\n", "type": { "kind": "HttpTypeReference", "ident": "AssistantToolChoiceOption", "$ref": "(resource) beta.threads > (model) assistant_tool_choice_option > (schema)" }, - "oasRef": "#/components/schemas/RunObject/properties/tool_choice", - "deprecated": false, - "schemaType": "union", + "optional": false, + "nullable": true, "modelImplicit": false, + "schemaType": "union", "modelPath": "(resource) beta.threads > (model) assistant_tool_choice_option", "childrenParentSchema": "union", "children": [ @@ -5655,15 +5657,16 @@ 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](/docs/api-reference/assistants) used for this run.", + "oasRef": "#/components/schemas/RunObject/properties/tools", + "deprecated": false, "key": "tools", - "optional": false, - "nullable": false, - "default": [], + "docstring": "The list of tools that the [assistant](/docs/api-reference/assistants) used for this run.", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RunObject/properties/tools", "elementType": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunObject/properties/tools/items", "types": [ { "kind": "HttpTypeReference", @@ -5680,13 +5683,12 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "ident": "FunctionTool", "$ref": "(resource) beta.assistants > (model) function_tool > (schema)" } - ], - "oasRef": "#/components/schemas/RunObject/properties/tools/items" - }, - "oasRef": "#/components/schemas/RunObject/properties/tools" + ] + } }, - "oasRef": "#/components/schemas/RunObject/properties/tools", - "deprecated": false, + "default": [], + "optional": false, + "nullable": false, "schemaType": "array", "childrenParentSchema": "union", "children": [ @@ -5697,11 +5699,11 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy": { "kind": "HttpDeclProperty", - "title": "Thread Truncation Controls", - "docstring": "Controls for how a thread will be truncated prior to the run. Use this to control the initial context window of the run.", + "oasRef": "#/components/schemas/RunObject/properties/truncation_strategy", + "deprecated": false, "key": "truncation_strategy", - "optional": false, - "nullable": true, + "docstring": "Controls for how a thread will be truncated prior to the run. Use this to control the initial context window of the run.", + "title": "Thread Truncation Controls", "type": { "kind": "HttpTypeObject", "members": [ @@ -5713,8 +5715,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunObject/properties/truncation_strategy", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -5724,10 +5726,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) usage": { "kind": "HttpDeclProperty", - "docstring": "Usage statistics related to the run. This value will be `null` if the run is not in a terminal state (i.e. `in_progress`, `queued`, etc.).", + "oasRef": "#/components/schemas/RunObject/properties/usage", + "deprecated": false, "key": "usage", - "optional": false, - "nullable": true, + "docstring": "Usage statistics related to the run. This value will be `null` if the run is not in a terminal state (i.e. `in_progress`, `queued`, etc.).", "type": { "kind": "HttpTypeObject", "members": [ @@ -5742,8 +5744,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunObject/properties/usage", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -5754,35 +5756,36 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) temperature": { "kind": "HttpDeclProperty", - "docstring": "The sampling temperature used for this run. If not set, defaults to 1.", + "oasRef": "#/components/schemas/RunObject/properties/temperature", + "deprecated": false, "key": "temperature", - "optional": true, - "nullable": true, + "docstring": "The sampling temperature used for this run. If not set, defaults to 1.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RunObject/properties/temperature", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "number", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) top_p": { "kind": "HttpDeclProperty", - "docstring": "The nucleus sampling value used for this run. If not set, defaults to 1.", + "oasRef": "#/components/schemas/RunObject/properties/top_p", + "deprecated": false, "key": "top_p", - "optional": true, - "nullable": true, + "docstring": "The nucleus sampling value used for this run. If not set, defaults to 1.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RunObject/properties/top_p", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "number", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RunObject", + "docstring": "Represents an execution run on a [thread](/docs/api-reference/threads).", "ident": "Run", "type": { "kind": "HttpTypeObject", @@ -5870,7 +5873,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Represents an execution run on a [thread](/docs/api-reference/threads).", "childrenParentSchema": "object", "children": [ "(resource) beta.threads.runs > (model) run > (schema) > (property) id", @@ -5911,12 +5913,13 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) incomplete_details > (property) reason": { "kind": "HttpDeclProperty", - "docstring": "The reason why the run is incomplete. This will point to which specific token limit was reached over the course of the run.", + "oasRef": "#/components/schemas/RunObject/properties/incomplete_details/properties/reason", + "deprecated": false, "key": "reason", - "optional": true, - "nullable": false, + "docstring": "The reason why the run is incomplete. This will point to which specific token limit was reached over the course of the run.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunObject/properties/incomplete_details/properties/reason", "types": [ { "kind": "HttpTypeLiteral", @@ -5926,11 +5929,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "max_prompt_tokens" } - ], - "oasRef": "#/components/schemas/RunObject/properties/incomplete_details/properties/reason" + ] }, - "oasRef": "#/components/schemas/RunObject/properties/incomplete_details/properties/reason", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -5940,12 +5942,13 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) code": { "kind": "HttpDeclProperty", - "docstring": "One of `server_error`, `rate_limit_exceeded`, or `invalid_prompt`.", + "oasRef": "#/components/schemas/RunObject/properties/last_error/properties/code", + "deprecated": false, "key": "code", - "optional": false, - "nullable": false, + "docstring": "One of `server_error`, `rate_limit_exceeded`, or `invalid_prompt`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunObject/properties/last_error/properties/code", "types": [ { "kind": "HttpTypeLiteral", @@ -5959,11 +5962,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "invalid_prompt" } - ], - "oasRef": "#/components/schemas/RunObject/properties/last_error/properties/code" + ] }, - "oasRef": "#/components/schemas/RunObject/properties/last_error/properties/code", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -5974,24 +5976,26 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) message": { "kind": "HttpDeclProperty", - "docstring": "A human-readable description of the error.", + "oasRef": "#/components/schemas/RunObject/properties/last_error/properties/message", + "deprecated": false, "key": "message", - "optional": false, - "nullable": false, + "docstring": "A human-readable description of the error.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunObject/properties/last_error/properties/message", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) $shared > (model) metadata > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/Metadata", + "docstring": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.\n", "ident": "Metadata", "type": { "kind": "HttpTypeReference", + "oasRef": "#/components/schemas/Metadata", "ident": "Record", "typeParameters": [ { @@ -6000,10 +6004,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch { "kind": "HttpTypeString" } - ], - "oasRef": "#/components/schemas/Metadata" + ] }, - "docstring": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.\n", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) object > (member) 0": { @@ -6015,10 +6017,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) required_action > (property) submit_tool_outputs": { "kind": "HttpDeclProperty", - "docstring": "Details on the tool outputs needed for this run to continue.", + "oasRef": "#/components/schemas/RunObject/properties/required_action/properties/submit_tool_outputs", + "deprecated": false, "key": "submit_tool_outputs", - "optional": false, - "nullable": false, + "docstring": "Details on the tool outputs needed for this run to continue.", "type": { "kind": "HttpTypeObject", "members": [ @@ -6027,8 +6029,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunObject/properties/required_action/properties/submit_tool_outputs", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -6037,22 +6039,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) required_action > (property) type": { "kind": "HttpDeclProperty", - "docstring": "For now, this is always `submit_tool_outputs`.", + "oasRef": "#/components/schemas/RunObject/properties/required_action/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "For now, this is always `submit_tool_outputs`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunObject/properties/required_action/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "submit_tool_outputs" } - ], - "oasRef": "#/components/schemas/RunObject/properties/required_action/properties/type" + ] }, - "oasRef": "#/components/schemas/RunObject/properties/required_action/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -6062,18 +6064,18 @@ 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/oneOf/0", + "docstring": "`auto` is the default value\n", "ident": "UnionMember0", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/oneOf/0", "types": [ { "kind": "HttpTypeLiteral", "literal": "auto" } - ], - "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/oneOf/0" + ] }, - "docstring": "`auto` is the default value\n", "childrenParentSchema": "enum", "children": [ "(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 0 > (member) 0" @@ -6119,19 +6121,21 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads > (model) assistant_response_format_option > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption", + "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", "ident": "AssistantResponseFormatOption", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption", "types": [ { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/oneOf/0", "types": [ { "kind": "HttpTypeLiteral", "literal": "auto" } - ], - "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/oneOf/0" + ] }, { "kind": "HttpTypeReference", @@ -6148,10 +6152,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "ident": "ResponseFormatJSONSchema", "$ref": "(resource) $shared > (model) response_format_json_schema > (schema)" } - ], - "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption" + ] }, - "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", @@ -6226,9 +6228,11 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0": { "kind": "HttpDeclTypeAlias", "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", "ident": "UnionMember0", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption/oneOf/0", "types": [ { "kind": "HttpTypeLiteral", @@ -6242,10 +6246,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "required" } - ], - "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", "children": [ "(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0 > (member) 0", @@ -6269,12 +6271,15 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads > (model) assistant_tool_choice_option > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption", + "docstring": "Controls which (if any) tool is called by the model.\n`none` means the model will not call any tools and instead generates a message.\n`auto` is the default value and means the model can pick between generating a message or calling one or more tools.\n`required` means the model must call one or more tools before responding to the user.\nSpecifying a particular tool like `{\"type\": \"file_search\"}` or `{\"type\": \"function\", \"function\": {\"name\": \"my_function\"}}` forces the model to call that tool.\n", "ident": "AssistantToolChoiceOption", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption", "types": [ { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption/oneOf/0", "types": [ { "kind": "HttpTypeLiteral", @@ -6288,18 +6293,15 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "required" } - ], - "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption/oneOf/0" + ] }, { "kind": "HttpTypeReference", "ident": "AssistantToolChoice", "$ref": "(resource) beta.threads > (model) assistant_tool_choice > (schema)" } - ], - "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption" + ] }, - "docstring": "Controls which (if any) tool is called by the model.\n`none` means the model will not call any tools and instead generates a message.\n`auto` is the default value and means the model can pick between generating a message or calling one or more tools.\n`required` means the model must call one or more tools before responding to the user.\nSpecifying a particular tool like `{\"type\": \"file_search\"}` or `{\"type\": \"function\", \"function\": {\"name\": \"my_function\"}}` forces the model to call that tool.\n", "childrenParentSchema": "union", "children": [ "(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0", @@ -6405,12 +6407,13 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The truncation strategy to use for the thread. The default is `auto`. If set to `last_messages`, the thread will be truncated to the n most recent messages in the thread. When set to `auto`, messages in the middle of the thread will be dropped to fit the context length of the model, `max_prompt_tokens`.", + "oasRef": "#/components/schemas/TruncationObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The truncation strategy to use for the thread. The default is `auto`. If set to `last_messages`, the thread will be truncated to the n most recent messages in the thread. When set to `auto`, messages in the middle of the thread will be dropped to fit the context length of the model, `max_prompt_tokens`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/TruncationObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", @@ -6420,11 +6423,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "last_messages" } - ], - "oasRef": "#/components/schemas/TruncationObject/properties/type" + ] }, - "oasRef": "#/components/schemas/TruncationObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -6434,60 +6436,60 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) last_messages": { "kind": "HttpDeclProperty", - "docstring": "The number of most recent messages from the thread when constructing the context for the run.", + "oasRef": "#/components/schemas/TruncationObject/properties/last_messages", + "deprecated": false, "key": "last_messages", - "optional": true, - "nullable": true, + "docstring": "The number of most recent messages from the thread when constructing the context for the run.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "minimum": 1 }, - "oasRef": "#/components/schemas/TruncationObject/properties/last_messages", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) usage > (property) completion_tokens": { "kind": "HttpDeclProperty", - "docstring": "Number of completion tokens used over the course of the run.", + "oasRef": "#/components/schemas/RunCompletionUsage/anyOf/0/properties/completion_tokens", + "deprecated": false, "key": "completion_tokens", - "optional": false, - "nullable": false, + "docstring": "Number of completion tokens used over the course of the run.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RunCompletionUsage/anyOf/0/properties/completion_tokens", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) usage > (property) prompt_tokens": { "kind": "HttpDeclProperty", - "docstring": "Number of prompt tokens used over the course of the run.", + "oasRef": "#/components/schemas/RunCompletionUsage/anyOf/0/properties/prompt_tokens", + "deprecated": false, "key": "prompt_tokens", - "optional": false, - "nullable": false, + "docstring": "Number of prompt tokens used over the course of the run.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RunCompletionUsage/anyOf/0/properties/prompt_tokens", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) usage > (property) total_tokens": { "kind": "HttpDeclProperty", - "docstring": "Total number of tokens used (prompt + completion).", + "oasRef": "#/components/schemas/RunCompletionUsage/anyOf/0/properties/total_tokens", + "deprecated": false, "key": "total_tokens", - "optional": false, - "nullable": false, + "docstring": "Total number of tokens used (prompt + completion).", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RunCompletionUsage/anyOf/0/properties/total_tokens", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, @@ -6528,21 +6530,21 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) required_action > (property) submit_tool_outputs > (property) tool_calls": { "kind": "HttpDeclProperty", - "docstring": "A list of the relevant tool calls.", + "oasRef": "#/components/schemas/RunObject/properties/required_action/properties/submit_tool_outputs/properties/tool_calls", + "deprecated": false, "key": "tool_calls", - "optional": false, - "nullable": false, + "docstring": "A list of the relevant tool calls.", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RunObject/properties/required_action/properties/submit_tool_outputs/properties/tool_calls", "elementType": { "kind": "HttpTypeReference", "ident": "RequiredActionFunctionToolCall", "$ref": "(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema)" + } }, - "oasRef": "#/components/schemas/RunObject/properties/required_action/properties/submit_tool_outputs/properties/tool_calls" - }, - "oasRef": "#/components/schemas/RunObject/properties/required_action/properties/submit_tool_outputs/properties/tool_calls", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "array", "childrenParentSchema": "object", "children": [ @@ -6567,22 +6569,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) $shared > (model) response_format_text > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of response format being defined. Always `text`.", + "oasRef": "#/components/schemas/ResponseFormatText/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of response format being defined. Always `text`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/ResponseFormatText/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "text" } - ], - "oasRef": "#/components/schemas/ResponseFormatText/properties/type" + ] }, - "oasRef": "#/components/schemas/ResponseFormatText/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -6592,6 +6594,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) $shared > (model) response_format_text > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/ResponseFormatText", + "docstring": "Default response format. Used to generate text responses.\n", "ident": "ResponseFormatText", "type": { "kind": "HttpTypeObject", @@ -6601,7 +6604,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Default response format. Used to generate text responses.\n", "childrenParentSchema": "object", "children": [ "(resource) $shared > (model) response_format_text > (schema) > (property) type" @@ -6609,22 +6611,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) $shared > (model) response_format_json_object > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of response format being defined. Always `json_object`.", + "oasRef": "#/components/schemas/ResponseFormatJsonObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of response format being defined. Always `json_object`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/ResponseFormatJsonObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "json_object" } - ], - "oasRef": "#/components/schemas/ResponseFormatJsonObject/properties/type" + ] }, - "oasRef": "#/components/schemas/ResponseFormatJsonObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -6634,6 +6636,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) $shared > (model) response_format_json_object > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/ResponseFormatJsonObject", + "docstring": "JSON object response format. An older method of generating JSON responses.\nUsing `json_schema` is recommended for models that support it. Note that the\nmodel will not generate JSON without a system or user message instructing it\nto do so.\n", "ident": "ResponseFormatJSONObject", "type": { "kind": "HttpTypeObject", @@ -6643,7 +6646,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "JSON object response format. An older method of generating JSON responses.\nUsing `json_schema` is recommended for models that support it. Note that the\nmodel will not generate JSON without a system or user message instructing it\nto do so.\n", "childrenParentSchema": "object", "children": [ "(resource) $shared > (model) response_format_json_object > (schema) > (property) type" @@ -6651,11 +6653,11 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema": { "kind": "HttpDeclProperty", - "title": "JSON schema", - "docstring": "Structured Outputs configuration options, including a JSON Schema.\n", + "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema", + "deprecated": false, "key": "json_schema", - "optional": false, - "nullable": false, + "docstring": "Structured Outputs configuration options, including a JSON Schema.\n", + "title": "JSON schema", "type": { "kind": "HttpTypeObject", "members": [ @@ -6673,8 +6675,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -6686,22 +6688,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) $shared > (model) response_format_json_schema > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of response format being defined. Always `json_schema`.", + "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of response format being defined. Always `json_schema`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "json_schema" } - ], - "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/type" + ] }, - "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -6711,6 +6713,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) $shared > (model) response_format_json_schema > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/ResponseFormatJsonSchema", + "docstring": "JSON Schema response format. Used to generate structured JSON responses.\nLearn more about [Structured Outputs](/docs/guides/structured-outputs).\n", "ident": "ResponseFormatJSONSchema", "type": { "kind": "HttpTypeObject", @@ -6723,7 +6726,6 @@ 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](/docs/guides/structured-outputs).\n", "childrenParentSchema": "object", "children": [ "(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema", @@ -6753,12 +6755,13 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the tool. If type is `function`, the function name must be set", + "oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the tool. If type is `function`, the function name must be set", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/type", "types": [ { "kind": "HttpTypeLiteral", @@ -6772,11 +6775,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "file_search" } - ], - "oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/type" + ] }, - "oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -6787,18 +6789,18 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) function": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/function", + "deprecated": false, "key": "function", - "optional": true, - "nullable": false, "type": { "kind": "HttpTypeReference", "ident": "AssistantToolChoiceFunction", "$ref": "(resource) beta.threads > (model) assistant_tool_choice_function > (schema)" }, - "oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/function", - "deprecated": false, - "schemaType": "object", + "optional": true, + "nullable": false, "modelImplicit": false, + "schemaType": "object", "modelPath": "(resource) beta.threads > (model) assistant_tool_choice_function", "childrenParentSchema": "object", "children": [ @@ -6808,6 +6810,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads > (model) assistant_tool_choice > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/AssistantsNamedToolChoice", + "docstring": "Specifies a tool the model should use. Use to force the model to call a specific tool.", "ident": "AssistantToolChoice", "type": { "kind": "HttpTypeObject", @@ -6820,7 +6823,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Specifies a tool the model should use. Use to force the model to call a specific tool.", "childrenParentSchema": "object", "children": [ "(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) type", @@ -6829,22 +6831,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of tool being defined: `code_interpreter`", + "oasRef": "#/components/schemas/AssistantToolsCode/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of tool being defined: `code_interpreter`", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantToolsCode/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "code_interpreter" } - ], - "oasRef": "#/components/schemas/AssistantToolsCode/properties/type" + ] }, - "oasRef": "#/components/schemas/AssistantToolsCode/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -6853,22 +6855,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of tool being defined: `file_search`", + "oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of tool being defined: `file_search`", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "file_search" } - ], - "oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/type" + ] }, - "oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -6877,10 +6879,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search": { "kind": "HttpDeclProperty", - "docstring": "Overrides for the file search tool.", + "oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/file_search", + "deprecated": false, "key": "file_search", - "optional": true, - "nullable": false, + "docstring": "Overrides for the file search tool.", "type": { "kind": "HttpTypeObject", "members": [ @@ -6892,8 +6894,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/file_search", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -6903,18 +6905,18 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) function_tool > (schema) > (property) function": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/AssistantToolsFunction/properties/function", + "deprecated": false, "key": "function", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeReference", "ident": "FunctionDefinition", "$ref": "(resource) $shared > (model) function_definition > (schema)" }, - "oasRef": "#/components/schemas/AssistantToolsFunction/properties/function", - "deprecated": false, - "schemaType": "object", + "optional": false, + "nullable": false, "modelImplicit": false, + "schemaType": "object", "modelPath": "(resource) $shared > (model) function_definition", "childrenParentSchema": "object", "children": [ @@ -6926,22 +6928,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) function_tool > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of tool being defined: `function`", + "oasRef": "#/components/schemas/AssistantToolsFunction/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of tool being defined: `function`", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantToolsFunction/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "function" } - ], - "oasRef": "#/components/schemas/AssistantToolsFunction/properties/type" + ] }, - "oasRef": "#/components/schemas/AssistantToolsFunction/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -6964,24 +6966,24 @@ 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](/docs/api-reference/runs/submitToolOutputs) endpoint.", + "oasRef": "#/components/schemas/RunToolCallObject/properties/id", + "deprecated": false, "key": "id", - "optional": false, - "nullable": false, + "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.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunToolCallObject/properties/id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) function": { "kind": "HttpDeclProperty", - "docstring": "The function definition.", + "oasRef": "#/components/schemas/RunToolCallObject/properties/function", + "deprecated": false, "key": "function", - "optional": false, - "nullable": false, + "docstring": "The function definition.", "type": { "kind": "HttpTypeObject", "members": [ @@ -6993,8 +6995,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunToolCallObject/properties/function", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -7004,22 +7006,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of tool call the output is required for. For now, this is always `function`.", + "oasRef": "#/components/schemas/RunToolCallObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of tool call the output is required for. For now, this is always `function`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunToolCallObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "function" } - ], - "oasRef": "#/components/schemas/RunToolCallObject/properties/type" + ] }, - "oasRef": "#/components/schemas/RunToolCallObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -7029,6 +7031,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RunToolCallObject", + "docstring": "Tool call objects", "ident": "RequiredActionFunctionToolCall", "type": { "kind": "HttpTypeObject", @@ -7044,7 +7047,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Tool call objects", "childrenParentSchema": "object", "children": [ "(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) id", @@ -7068,41 +7070,42 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the response format. Must be a-z, A-Z, 0-9, or contain\nunderscores and dashes, with a maximum length of 64.\n", + "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/name", + "deprecated": false, "key": "name", - "optional": false, - "nullable": false, + "docstring": "The name of the response format. Must be a-z, A-Z, 0-9, or contain\nunderscores and dashes, with a maximum length of 64.\n", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/name", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema > (property) description": { "kind": "HttpDeclProperty", - "docstring": "A description of what the response format is for, used by the model to\ndetermine how to respond in the format.\n", + "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/description", + "deprecated": false, "key": "description", - "optional": true, - "nullable": false, + "docstring": "A description of what the response format is for, used by the model to\ndetermine how to respond in the format.\n", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/description", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema > (property) schema": { "kind": "HttpDeclProperty", - "title": "JSON schema", - "docstring": "The schema for the response format, described as a JSON Schema object.\nLearn how to build JSON schemas [here](https://json-schema.org/).\n", + "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/schema", + "deprecated": false, "key": "schema", - "optional": true, - "nullable": false, + "docstring": "The schema for the response format, described as a JSON Schema object.\nLearn how to build JSON schemas [here](https://json-schema.org/).\n", + "title": "JSON schema", "type": { "kind": "HttpTypeReference", + "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/schema", "ident": "Record", "typeParameters": [ { @@ -7111,26 +7114,25 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch { "kind": "HttpTypeUnknown" } - ], - "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/schema" + ] }, - "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/schema", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "map", "children": [] }, "(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](/docs/guides/structured-outputs).\n", + "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/strict", + "deprecated": false, "key": "strict", - "optional": true, - "nullable": true, - "default": false, + "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", "type": { "kind": "HttpTypeBoolean" }, - "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/strict", - "deprecated": false, + "default": false, + "optional": true, + "nullable": true, "schemaType": "boolean", "children": [] }, @@ -7164,15 +7166,15 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads > (model) assistant_tool_choice_function > (schema) > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the function to call.", + "oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/function/properties/name", + "deprecated": false, "key": "name", - "optional": false, - "nullable": false, + "docstring": "The name of the function to call.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/function/properties/name", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, @@ -7209,10 +7211,10 @@ 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](/docs/assistants/tools/file-search#customizing-file-search-settings) for more information.\n", + "oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/file_search/properties/max_num_results", + "deprecated": false, "key": "max_num_results", - "optional": true, - "nullable": false, + "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", "type": { "kind": "HttpTypeNumber" }, @@ -7220,18 +7222,18 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "minimum": 1, "maximum": 50 }, - "oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/file_search/properties/max_num_results", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "integer", "children": [] }, "(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](/docs/assistants/tools/file-search#customizing-file-search-settings) for more information.\n", + "oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/file_search/properties/ranking_options", + "deprecated": false, "key": "ranking_options", - "optional": true, - "nullable": false, + "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", + "title": "File search tool call ranking options", "type": { "kind": "HttpTypeObject", "members": [ @@ -7243,8 +7245,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/file_search/properties/ranking_options", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -7254,62 +7256,62 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) $shared > (model) function_definition > (schema) > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.", + "oasRef": "#/components/schemas/FunctionObject/properties/name", + "deprecated": false, "key": "name", - "optional": false, - "nullable": false, + "docstring": "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/FunctionObject/properties/name", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) $shared > (model) function_definition > (schema) > (property) description": { "kind": "HttpDeclProperty", - "docstring": "A description of what the function does, used by the model to choose when and how to call the function.", + "oasRef": "#/components/schemas/FunctionObject/properties/description", + "deprecated": false, "key": "description", - "optional": true, - "nullable": false, + "docstring": "A description of what the function does, used by the model to choose when and how to call the function.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/FunctionObject/properties/description", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(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](/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.", + "oasRef": "#/components/schemas/FunctionObject/properties/parameters", + "deprecated": false, "key": "parameters", - "optional": true, - "nullable": false, + "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.", "type": { "kind": "HttpTypeReference", "ident": "FunctionParameters", "$ref": "(resource) $shared > (model) function_parameters > (schema)" }, - "oasRef": "#/components/schemas/FunctionObject/properties/parameters", - "deprecated": false, - "schemaType": "map", + "optional": true, + "nullable": false, "modelImplicit": false, + "schemaType": "map", "modelPath": "(resource) $shared > (model) function_parameters", "children": [] }, "(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](/docs/guides/function-calling).", + "oasRef": "#/components/schemas/FunctionObject/properties/strict", + "deprecated": false, "key": "strict", - "optional": true, - "nullable": true, - "default": false, + "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).", "type": { "kind": "HttpTypeBoolean" }, - "oasRef": "#/components/schemas/FunctionObject/properties/strict", - "deprecated": false, + "default": false, + "optional": true, + "nullable": true, "schemaType": "boolean", "children": [] }, @@ -7351,29 +7353,29 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) function > (property) arguments": { "kind": "HttpDeclProperty", - "docstring": "The arguments that the model expects you to pass to the function.", + "oasRef": "#/components/schemas/RunToolCallObject/properties/function/properties/arguments", + "deprecated": false, "key": "arguments", - "optional": false, - "nullable": false, + "docstring": "The arguments that the model expects you to pass to the function.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunToolCallObject/properties/function/properties/arguments", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) function > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the function.", + "oasRef": "#/components/schemas/RunToolCallObject/properties/function/properties/name", + "deprecated": false, "key": "name", - "optional": false, - "nullable": false, + "docstring": "The name of the function.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunToolCallObject/properties/function/properties/name", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, @@ -7386,10 +7388,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options > (property) score_threshold": { "kind": "HttpDeclProperty", - "docstring": "The score threshold for the file search. All values must be a floating point number between 0 and 1.", + "oasRef": "#/components/schemas/FileSearchRankingOptions/properties/score_threshold", + "deprecated": false, "key": "score_threshold", - "optional": false, - "nullable": false, + "docstring": "The score threshold for the file search. All values must be a floating point number between 0 and 1.", "type": { "kind": "HttpTypeNumber" }, @@ -7397,19 +7399,20 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "minimum": 0, "maximum": 1 }, - "oasRef": "#/components/schemas/FileSearchRankingOptions/properties/score_threshold", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "number", "children": [] }, "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options > (property) ranker": { "kind": "HttpDeclProperty", - "docstring": "The ranker to use for the file search. If not specified will use the `auto` ranker.", + "oasRef": "#/components/schemas/FileSearchRankingOptions/properties/ranker", + "deprecated": false, "key": "ranker", - "optional": true, - "nullable": false, + "docstring": "The ranker to use for the file search. If not specified will use the `auto` ranker.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/FileSearchRankingOptions/properties/ranker", "types": [ { "kind": "HttpTypeLiteral", @@ -7419,11 +7422,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "default_2024_08_21" } - ], - "oasRef": "#/components/schemas/FileSearchRankingOptions/properties/ranker" + ] }, - "oasRef": "#/components/schemas/FileSearchRankingOptions/properties/ranker", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -7434,9 +7436,11 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) $shared > (model) function_parameters > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/FunctionParameters", + "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.", "ident": "FunctionParameters", "type": { "kind": "HttpTypeReference", + "oasRef": "#/components/schemas/FunctionParameters", "ident": "Record", "typeParameters": [ { @@ -7445,10 +7449,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch { "kind": "HttpTypeUnknown" } - ], - "oasRef": "#/components/schemas/FunctionParameters" + ] }, - "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": { @@ -7487,7 +7489,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/oneOf/3", - "ident": "UnionMember4", + "docstring": "Occurs when a [run](/docs/api-reference/runs/object) moves to a `requires_action` status.", + "ident": "ThreadRunRequiresAction", "type": { "kind": "HttpTypeObject", "members": [ @@ -7499,7 +7502,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "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", @@ -7508,20 +7510,20 @@ 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](/docs/api-reference/threads).", + "oasRef": "#/components/schemas/RunStreamEvent/oneOf/3/properties/data", + "deprecated": false, "key": "data", - "optional": false, - "nullable": false, + "docstring": "Represents an execution run on a [thread](/docs/api-reference/threads).", + "title": "A run on a thread", "type": { "kind": "HttpTypeReference", "ident": "Run", "$ref": "(resource) beta.threads.runs > (model) run > (schema)" }, - "oasRef": "#/components/schemas/RunStreamEvent/oneOf/3/properties/data", - "deprecated": false, - "schemaType": "object", + "optional": false, + "nullable": false, "modelImplicit": false, + "schemaType": "object", "modelPath": "(resource) beta.threads.runs > (model) run", "childrenParentSchema": "object", "children": [ @@ -7556,21 +7558,21 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 4 > (property) event": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RunStreamEvent/oneOf/3/properties/event", + "deprecated": false, "key": "event", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStreamEvent/oneOf/3/properties/event", "types": [ { "kind": "HttpTypeLiteral", "literal": "thread.run.requires_action" } - ], - "oasRef": "#/components/schemas/RunStreamEvent/oneOf/3/properties/event" + ] }, - "oasRef": "#/components/schemas/RunStreamEvent/oneOf/3/properties/event", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -7579,123 +7581,123 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The identifier, which can be referenced in API endpoints.", + "oasRef": "#/components/schemas/RunObject/properties/id", + "deprecated": false, "key": "id", - "optional": false, - "nullable": false, + "docstring": "The identifier, which can be referenced in API endpoints.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunObject/properties/id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) assistant_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the [assistant](/docs/api-reference/assistants) used for execution of this run.", + "oasRef": "#/components/schemas/RunObject/properties/assistant_id", + "deprecated": false, "key": "assistant_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the [assistant](/docs/api-reference/assistants) used for execution of this run.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunObject/properties/assistant_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) cancelled_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the run was cancelled.", + "oasRef": "#/components/schemas/RunObject/properties/cancelled_at", + "deprecated": false, "key": "cancelled_at", - "optional": false, - "nullable": true, + "docstring": "The Unix timestamp (in seconds) for when the run was cancelled.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/RunObject/properties/cancelled_at", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) completed_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the run was completed.", + "oasRef": "#/components/schemas/RunObject/properties/completed_at", + "deprecated": false, "key": "completed_at", - "optional": false, - "nullable": true, + "docstring": "The Unix timestamp (in seconds) for when the run was completed.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/RunObject/properties/completed_at", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) created_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the run was created.", + "oasRef": "#/components/schemas/RunObject/properties/created_at", + "deprecated": false, "key": "created_at", - "optional": false, - "nullable": false, + "docstring": "The Unix timestamp (in seconds) for when the run was created.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/RunObject/properties/created_at", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) expires_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the run will expire.", + "oasRef": "#/components/schemas/RunObject/properties/expires_at", + "deprecated": false, "key": "expires_at", - "optional": false, - "nullable": true, + "docstring": "The Unix timestamp (in seconds) for when the run will expire.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/RunObject/properties/expires_at", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) failed_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the run failed.", + "oasRef": "#/components/schemas/RunObject/properties/failed_at", + "deprecated": false, "key": "failed_at", - "optional": false, - "nullable": true, + "docstring": "The Unix timestamp (in seconds) for when the run failed.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/RunObject/properties/failed_at", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) incomplete_details": { "kind": "HttpDeclProperty", - "docstring": "Details on why the run is incomplete. Will be `null` if the run is not incomplete.", + "oasRef": "#/components/schemas/RunObject/properties/incomplete_details", + "deprecated": false, "key": "incomplete_details", - "optional": false, - "nullable": true, + "docstring": "Details on why the run is incomplete. Will be `null` if the run is not incomplete.", "type": { "kind": "HttpTypeObject", "members": [ @@ -7704,8 +7706,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunObject/properties/incomplete_details", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -7714,24 +7716,24 @@ 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](/docs/api-reference/assistants) used for this run.", + "oasRef": "#/components/schemas/RunObject/properties/instructions", + "deprecated": false, "key": "instructions", - "optional": false, - "nullable": false, + "docstring": "The instructions that the [assistant](/docs/api-reference/assistants) used for this run.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunObject/properties/instructions", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) last_error": { "kind": "HttpDeclProperty", - "docstring": "The last error associated with this run. Will be `null` if there are no errors.", + "oasRef": "#/components/schemas/RunObject/properties/last_error", + "deprecated": false, "key": "last_error", - "optional": false, - "nullable": true, + "docstring": "The last error associated with this run. Will be `null` if there are no errors.", "type": { "kind": "HttpTypeObject", "members": [ @@ -7743,8 +7745,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunObject/properties/last_error", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -7754,88 +7756,88 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) max_completion_tokens": { "kind": "HttpDeclProperty", - "docstring": "The maximum number of completion tokens specified to have been used over the course of the run.\n", + "oasRef": "#/components/schemas/RunObject/properties/max_completion_tokens", + "deprecated": false, "key": "max_completion_tokens", - "optional": false, - "nullable": true, + "docstring": "The maximum number of completion tokens specified to have been used over the course of the run.\n", "type": { "kind": "HttpTypeNumber" }, "constraints": { "minimum": 256 }, - "oasRef": "#/components/schemas/RunObject/properties/max_completion_tokens", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) max_prompt_tokens": { "kind": "HttpDeclProperty", - "docstring": "The maximum number of prompt tokens specified to have been used over the course of the run.\n", + "oasRef": "#/components/schemas/RunObject/properties/max_prompt_tokens", + "deprecated": false, "key": "max_prompt_tokens", - "optional": false, - "nullable": true, + "docstring": "The maximum number of prompt tokens specified to have been used over the course of the run.\n", "type": { "kind": "HttpTypeNumber" }, "constraints": { "minimum": 256 }, - "oasRef": "#/components/schemas/RunObject/properties/max_prompt_tokens", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) metadata": { "kind": "HttpDeclProperty", - "docstring": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.\n", + "oasRef": "#/components/schemas/RunObject/properties/metadata", + "deprecated": false, "key": "metadata", - "optional": false, - "nullable": true, + "docstring": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.\n", "type": { "kind": "HttpTypeReference", "ident": "Metadata", "$ref": "(resource) $shared > (model) metadata > (schema)" }, - "oasRef": "#/components/schemas/RunObject/properties/metadata", - "deprecated": false, - "schemaType": "map", + "optional": false, + "nullable": true, "modelImplicit": false, + "schemaType": "map", "modelPath": "(resource) $shared > (model) metadata", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) model": { "kind": "HttpDeclProperty", - "docstring": "The model that the [assistant](/docs/api-reference/assistants) used for this run.", + "oasRef": "#/components/schemas/RunObject/properties/model", + "deprecated": false, "key": "model", - "optional": false, - "nullable": false, + "docstring": "The model that the [assistant](/docs/api-reference/assistants) used for this run.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunObject/properties/model", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) object": { "kind": "HttpDeclProperty", - "docstring": "The object type, which is always `thread.run`.", + "oasRef": "#/components/schemas/RunObject/properties/object", + "deprecated": false, "key": "object", - "optional": false, - "nullable": false, + "docstring": "The object type, which is always `thread.run`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunObject/properties/object", "types": [ { "kind": "HttpTypeLiteral", "literal": "thread.run" } - ], - "oasRef": "#/components/schemas/RunObject/properties/object" + ] }, - "oasRef": "#/components/schemas/RunObject/properties/object", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -7844,25 +7846,25 @@ 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](/docs/guides/function-calling#configuring-parallel-function-calling) during tool use.", + "oasRef": "#/components/schemas/RunObject/properties/parallel_tool_calls", + "deprecated": false, "key": "parallel_tool_calls", - "optional": false, - "nullable": false, - "default": true, + "docstring": "Whether to enable [parallel function calling](/docs/guides/function-calling#configuring-parallel-function-calling) during tool use.", "type": { "kind": "HttpTypeBoolean" }, - "oasRef": "#/components/schemas/RunObject/properties/parallel_tool_calls", - "deprecated": false, + "default": true, + "optional": false, + "nullable": false, "schemaType": "boolean", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) required_action": { "kind": "HttpDeclProperty", - "docstring": "Details on the action required to continue the run. Will be `null` if no action is required.", + "oasRef": "#/components/schemas/RunObject/properties/required_action", + "deprecated": false, "key": "required_action", - "optional": false, - "nullable": true, + "docstring": "Details on the action required to continue the run. Will be `null` if no action is required.", "type": { "kind": "HttpTypeObject", "members": [ @@ -7874,8 +7876,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunObject/properties/required_action", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -7885,19 +7887,19 @@ 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](/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", + "oasRef": "#/components/schemas/RunObject/properties/response_format", + "deprecated": false, "key": "response_format", - "optional": false, - "nullable": true, + "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", "type": { "kind": "HttpTypeReference", "ident": "AssistantResponseFormatOption", "$ref": "(resource) beta.threads > (model) assistant_response_format_option > (schema)" }, - "oasRef": "#/components/schemas/RunObject/properties/response_format", - "deprecated": false, - "schemaType": "union", + "optional": false, + "nullable": true, "modelImplicit": false, + "schemaType": "union", "modelPath": "(resource) beta.threads > (model) assistant_response_format_option", "childrenParentSchema": "union", "children": [ @@ -7909,29 +7911,30 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) started_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the run was started.", + "oasRef": "#/components/schemas/RunObject/properties/started_at", + "deprecated": false, "key": "started_at", - "optional": false, - "nullable": true, + "docstring": "The Unix timestamp (in seconds) for when the run was started.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/RunObject/properties/started_at", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) status": { "kind": "HttpDeclProperty", - "docstring": "The status of the run, which can be either `queued`, `in_progress`, `requires_action`, `cancelling`, `cancelled`, `failed`, `completed`, `incomplete`, or `expired`.", + "oasRef": "#/components/schemas/RunObject/properties/status", + "deprecated": false, "key": "status", - "optional": false, - "nullable": false, + "docstring": "The status of the run, which can be either `queued`, `in_progress`, `requires_action`, `cancelling`, `cancelled`, `failed`, `completed`, `incomplete`, or `expired`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunObject/properties/status", "types": [ { "kind": "HttpTypeLiteral", @@ -7969,11 +7972,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "expired" } - ], - "oasRef": "#/components/schemas/RunObject/properties/status" + ] }, - "oasRef": "#/components/schemas/RunObject/properties/status", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -7990,33 +7992,33 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) thread_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the [thread](/docs/api-reference/threads) that was executed on as a part of this run.", + "oasRef": "#/components/schemas/RunObject/properties/thread_id", + "deprecated": false, "key": "thread_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the [thread](/docs/api-reference/threads) that was executed on as a part of this run.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunObject/properties/thread_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) tool_choice": { "kind": "HttpDeclProperty", - "docstring": "Controls which (if any) tool is called by the model.\n`none` means the model will not call any tools and instead generates a message.\n`auto` is the default value and means the model can pick between generating a message or calling one or more tools.\n`required` means the model must call one or more tools before responding to the user.\nSpecifying a particular tool like `{\"type\": \"file_search\"}` or `{\"type\": \"function\", \"function\": {\"name\": \"my_function\"}}` forces the model to call that tool.\n", + "oasRef": "#/components/schemas/RunObject/properties/tool_choice", + "deprecated": false, "key": "tool_choice", - "optional": false, - "nullable": true, + "docstring": "Controls which (if any) tool is called by the model.\n`none` means the model will not call any tools and instead generates a message.\n`auto` is the default value and means the model can pick between generating a message or calling one or more tools.\n`required` means the model must call one or more tools before responding to the user.\nSpecifying a particular tool like `{\"type\": \"file_search\"}` or `{\"type\": \"function\", \"function\": {\"name\": \"my_function\"}}` forces the model to call that tool.\n", "type": { "kind": "HttpTypeReference", "ident": "AssistantToolChoiceOption", "$ref": "(resource) beta.threads > (model) assistant_tool_choice_option > (schema)" }, - "oasRef": "#/components/schemas/RunObject/properties/tool_choice", - "deprecated": false, - "schemaType": "union", + "optional": false, + "nullable": true, "modelImplicit": false, + "schemaType": "union", "modelPath": "(resource) beta.threads > (model) assistant_tool_choice_option", "childrenParentSchema": "union", "children": [ @@ -8026,15 +8028,16 @@ 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](/docs/api-reference/assistants) used for this run.", + "oasRef": "#/components/schemas/RunObject/properties/tools", + "deprecated": false, "key": "tools", - "optional": false, - "nullable": false, - "default": [], + "docstring": "The list of tools that the [assistant](/docs/api-reference/assistants) used for this run.", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RunObject/properties/tools", "elementType": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunObject/properties/tools/items", "types": [ { "kind": "HttpTypeReference", @@ -8051,13 +8054,12 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "ident": "FunctionTool", "$ref": "(resource) beta.assistants > (model) function_tool > (schema)" } - ], - "oasRef": "#/components/schemas/RunObject/properties/tools/items" - }, - "oasRef": "#/components/schemas/RunObject/properties/tools" + ] + } }, - "oasRef": "#/components/schemas/RunObject/properties/tools", - "deprecated": false, + "default": [], + "optional": false, + "nullable": false, "schemaType": "array", "childrenParentSchema": "union", "children": [ @@ -8068,11 +8070,11 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy": { "kind": "HttpDeclProperty", - "title": "Thread Truncation Controls", - "docstring": "Controls for how a thread will be truncated prior to the run. Use this to control the initial context window of the run.", + "oasRef": "#/components/schemas/RunObject/properties/truncation_strategy", + "deprecated": false, "key": "truncation_strategy", - "optional": false, - "nullable": true, + "docstring": "Controls for how a thread will be truncated prior to the run. Use this to control the initial context window of the run.", + "title": "Thread Truncation Controls", "type": { "kind": "HttpTypeObject", "members": [ @@ -8084,8 +8086,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunObject/properties/truncation_strategy", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -8095,10 +8097,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) usage": { "kind": "HttpDeclProperty", - "docstring": "Usage statistics related to the run. This value will be `null` if the run is not in a terminal state (i.e. `in_progress`, `queued`, etc.).", + "oasRef": "#/components/schemas/RunObject/properties/usage", + "deprecated": false, "key": "usage", - "optional": false, - "nullable": true, + "docstring": "Usage statistics related to the run. This value will be `null` if the run is not in a terminal state (i.e. `in_progress`, `queued`, etc.).", "type": { "kind": "HttpTypeObject", "members": [ @@ -8113,8 +8115,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunObject/properties/usage", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -8125,35 +8127,36 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) temperature": { "kind": "HttpDeclProperty", - "docstring": "The sampling temperature used for this run. If not set, defaults to 1.", + "oasRef": "#/components/schemas/RunObject/properties/temperature", + "deprecated": false, "key": "temperature", - "optional": true, - "nullable": true, + "docstring": "The sampling temperature used for this run. If not set, defaults to 1.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RunObject/properties/temperature", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "number", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) top_p": { "kind": "HttpDeclProperty", - "docstring": "The nucleus sampling value used for this run. If not set, defaults to 1.", + "oasRef": "#/components/schemas/RunObject/properties/top_p", + "deprecated": false, "key": "top_p", - "optional": true, - "nullable": true, + "docstring": "The nucleus sampling value used for this run. If not set, defaults to 1.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RunObject/properties/top_p", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "number", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RunObject", + "docstring": "Represents an execution run on a [thread](/docs/api-reference/threads).", "ident": "Run", "type": { "kind": "HttpTypeObject", @@ -8241,7 +8244,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Represents an execution run on a [thread](/docs/api-reference/threads).", "childrenParentSchema": "object", "children": [ "(resource) beta.threads.runs > (model) run > (schema) > (property) id", @@ -8282,12 +8284,13 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) incomplete_details > (property) reason": { "kind": "HttpDeclProperty", - "docstring": "The reason why the run is incomplete. This will point to which specific token limit was reached over the course of the run.", + "oasRef": "#/components/schemas/RunObject/properties/incomplete_details/properties/reason", + "deprecated": false, "key": "reason", - "optional": true, - "nullable": false, + "docstring": "The reason why the run is incomplete. This will point to which specific token limit was reached over the course of the run.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunObject/properties/incomplete_details/properties/reason", "types": [ { "kind": "HttpTypeLiteral", @@ -8297,11 +8300,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "max_prompt_tokens" } - ], - "oasRef": "#/components/schemas/RunObject/properties/incomplete_details/properties/reason" + ] }, - "oasRef": "#/components/schemas/RunObject/properties/incomplete_details/properties/reason", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -8311,12 +8313,13 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) code": { "kind": "HttpDeclProperty", - "docstring": "One of `server_error`, `rate_limit_exceeded`, or `invalid_prompt`.", + "oasRef": "#/components/schemas/RunObject/properties/last_error/properties/code", + "deprecated": false, "key": "code", - "optional": false, - "nullable": false, + "docstring": "One of `server_error`, `rate_limit_exceeded`, or `invalid_prompt`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunObject/properties/last_error/properties/code", "types": [ { "kind": "HttpTypeLiteral", @@ -8330,11 +8333,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "invalid_prompt" } - ], - "oasRef": "#/components/schemas/RunObject/properties/last_error/properties/code" + ] }, - "oasRef": "#/components/schemas/RunObject/properties/last_error/properties/code", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -8345,24 +8347,26 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) message": { "kind": "HttpDeclProperty", - "docstring": "A human-readable description of the error.", + "oasRef": "#/components/schemas/RunObject/properties/last_error/properties/message", + "deprecated": false, "key": "message", - "optional": false, - "nullable": false, + "docstring": "A human-readable description of the error.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunObject/properties/last_error/properties/message", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) $shared > (model) metadata > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/Metadata", + "docstring": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.\n", "ident": "Metadata", "type": { "kind": "HttpTypeReference", + "oasRef": "#/components/schemas/Metadata", "ident": "Record", "typeParameters": [ { @@ -8371,10 +8375,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch { "kind": "HttpTypeString" } - ], - "oasRef": "#/components/schemas/Metadata" + ] }, - "docstring": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.\n", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) object > (member) 0": { @@ -8386,10 +8388,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) required_action > (property) submit_tool_outputs": { "kind": "HttpDeclProperty", - "docstring": "Details on the tool outputs needed for this run to continue.", + "oasRef": "#/components/schemas/RunObject/properties/required_action/properties/submit_tool_outputs", + "deprecated": false, "key": "submit_tool_outputs", - "optional": false, - "nullable": false, + "docstring": "Details on the tool outputs needed for this run to continue.", "type": { "kind": "HttpTypeObject", "members": [ @@ -8398,8 +8400,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunObject/properties/required_action/properties/submit_tool_outputs", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -8408,22 +8410,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) required_action > (property) type": { "kind": "HttpDeclProperty", - "docstring": "For now, this is always `submit_tool_outputs`.", + "oasRef": "#/components/schemas/RunObject/properties/required_action/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "For now, this is always `submit_tool_outputs`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunObject/properties/required_action/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "submit_tool_outputs" } - ], - "oasRef": "#/components/schemas/RunObject/properties/required_action/properties/type" + ] }, - "oasRef": "#/components/schemas/RunObject/properties/required_action/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -8433,18 +8435,18 @@ 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/oneOf/0", + "docstring": "`auto` is the default value\n", "ident": "UnionMember0", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/oneOf/0", "types": [ { "kind": "HttpTypeLiteral", "literal": "auto" } - ], - "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/oneOf/0" + ] }, - "docstring": "`auto` is the default value\n", "childrenParentSchema": "enum", "children": [ "(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 0 > (member) 0" @@ -8490,19 +8492,21 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads > (model) assistant_response_format_option > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption", + "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", "ident": "AssistantResponseFormatOption", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption", "types": [ { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/oneOf/0", "types": [ { "kind": "HttpTypeLiteral", "literal": "auto" } - ], - "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/oneOf/0" + ] }, { "kind": "HttpTypeReference", @@ -8519,10 +8523,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "ident": "ResponseFormatJSONSchema", "$ref": "(resource) $shared > (model) response_format_json_schema > (schema)" } - ], - "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption" + ] }, - "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", @@ -8597,9 +8599,11 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0": { "kind": "HttpDeclTypeAlias", "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", "ident": "UnionMember0", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption/oneOf/0", "types": [ { "kind": "HttpTypeLiteral", @@ -8613,10 +8617,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "required" } - ], - "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", "children": [ "(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0 > (member) 0", @@ -8640,12 +8642,15 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads > (model) assistant_tool_choice_option > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption", + "docstring": "Controls which (if any) tool is called by the model.\n`none` means the model will not call any tools and instead generates a message.\n`auto` is the default value and means the model can pick between generating a message or calling one or more tools.\n`required` means the model must call one or more tools before responding to the user.\nSpecifying a particular tool like `{\"type\": \"file_search\"}` or `{\"type\": \"function\", \"function\": {\"name\": \"my_function\"}}` forces the model to call that tool.\n", "ident": "AssistantToolChoiceOption", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption", "types": [ { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption/oneOf/0", "types": [ { "kind": "HttpTypeLiteral", @@ -8659,18 +8664,15 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "required" } - ], - "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption/oneOf/0" + ] }, { "kind": "HttpTypeReference", "ident": "AssistantToolChoice", "$ref": "(resource) beta.threads > (model) assistant_tool_choice > (schema)" } - ], - "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption" + ] }, - "docstring": "Controls which (if any) tool is called by the model.\n`none` means the model will not call any tools and instead generates a message.\n`auto` is the default value and means the model can pick between generating a message or calling one or more tools.\n`required` means the model must call one or more tools before responding to the user.\nSpecifying a particular tool like `{\"type\": \"file_search\"}` or `{\"type\": \"function\", \"function\": {\"name\": \"my_function\"}}` forces the model to call that tool.\n", "childrenParentSchema": "union", "children": [ "(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0", @@ -8776,12 +8778,13 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The truncation strategy to use for the thread. The default is `auto`. If set to `last_messages`, the thread will be truncated to the n most recent messages in the thread. When set to `auto`, messages in the middle of the thread will be dropped to fit the context length of the model, `max_prompt_tokens`.", + "oasRef": "#/components/schemas/TruncationObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The truncation strategy to use for the thread. The default is `auto`. If set to `last_messages`, the thread will be truncated to the n most recent messages in the thread. When set to `auto`, messages in the middle of the thread will be dropped to fit the context length of the model, `max_prompt_tokens`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/TruncationObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", @@ -8791,11 +8794,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "last_messages" } - ], - "oasRef": "#/components/schemas/TruncationObject/properties/type" + ] }, - "oasRef": "#/components/schemas/TruncationObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -8805,60 +8807,60 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) last_messages": { "kind": "HttpDeclProperty", - "docstring": "The number of most recent messages from the thread when constructing the context for the run.", + "oasRef": "#/components/schemas/TruncationObject/properties/last_messages", + "deprecated": false, "key": "last_messages", - "optional": true, - "nullable": true, + "docstring": "The number of most recent messages from the thread when constructing the context for the run.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "minimum": 1 }, - "oasRef": "#/components/schemas/TruncationObject/properties/last_messages", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) usage > (property) completion_tokens": { "kind": "HttpDeclProperty", - "docstring": "Number of completion tokens used over the course of the run.", + "oasRef": "#/components/schemas/RunCompletionUsage/anyOf/0/properties/completion_tokens", + "deprecated": false, "key": "completion_tokens", - "optional": false, - "nullable": false, + "docstring": "Number of completion tokens used over the course of the run.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RunCompletionUsage/anyOf/0/properties/completion_tokens", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) usage > (property) prompt_tokens": { "kind": "HttpDeclProperty", - "docstring": "Number of prompt tokens used over the course of the run.", + "oasRef": "#/components/schemas/RunCompletionUsage/anyOf/0/properties/prompt_tokens", + "deprecated": false, "key": "prompt_tokens", - "optional": false, - "nullable": false, + "docstring": "Number of prompt tokens used over the course of the run.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RunCompletionUsage/anyOf/0/properties/prompt_tokens", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) usage > (property) total_tokens": { "kind": "HttpDeclProperty", - "docstring": "Total number of tokens used (prompt + completion).", + "oasRef": "#/components/schemas/RunCompletionUsage/anyOf/0/properties/total_tokens", + "deprecated": false, "key": "total_tokens", - "optional": false, - "nullable": false, + "docstring": "Total number of tokens used (prompt + completion).", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RunCompletionUsage/anyOf/0/properties/total_tokens", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, @@ -8899,21 +8901,21 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) required_action > (property) submit_tool_outputs > (property) tool_calls": { "kind": "HttpDeclProperty", - "docstring": "A list of the relevant tool calls.", + "oasRef": "#/components/schemas/RunObject/properties/required_action/properties/submit_tool_outputs/properties/tool_calls", + "deprecated": false, "key": "tool_calls", - "optional": false, - "nullable": false, + "docstring": "A list of the relevant tool calls.", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RunObject/properties/required_action/properties/submit_tool_outputs/properties/tool_calls", "elementType": { "kind": "HttpTypeReference", "ident": "RequiredActionFunctionToolCall", "$ref": "(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema)" + } }, - "oasRef": "#/components/schemas/RunObject/properties/required_action/properties/submit_tool_outputs/properties/tool_calls" - }, - "oasRef": "#/components/schemas/RunObject/properties/required_action/properties/submit_tool_outputs/properties/tool_calls", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "array", "childrenParentSchema": "object", "children": [ @@ -8938,22 +8940,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) $shared > (model) response_format_text > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of response format being defined. Always `text`.", + "oasRef": "#/components/schemas/ResponseFormatText/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of response format being defined. Always `text`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/ResponseFormatText/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "text" } - ], - "oasRef": "#/components/schemas/ResponseFormatText/properties/type" + ] }, - "oasRef": "#/components/schemas/ResponseFormatText/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -8963,6 +8965,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) $shared > (model) response_format_text > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/ResponseFormatText", + "docstring": "Default response format. Used to generate text responses.\n", "ident": "ResponseFormatText", "type": { "kind": "HttpTypeObject", @@ -8972,7 +8975,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Default response format. Used to generate text responses.\n", "childrenParentSchema": "object", "children": [ "(resource) $shared > (model) response_format_text > (schema) > (property) type" @@ -8980,22 +8982,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) $shared > (model) response_format_json_object > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of response format being defined. Always `json_object`.", + "oasRef": "#/components/schemas/ResponseFormatJsonObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of response format being defined. Always `json_object`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/ResponseFormatJsonObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "json_object" } - ], - "oasRef": "#/components/schemas/ResponseFormatJsonObject/properties/type" + ] }, - "oasRef": "#/components/schemas/ResponseFormatJsonObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -9005,6 +9007,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) $shared > (model) response_format_json_object > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/ResponseFormatJsonObject", + "docstring": "JSON object response format. An older method of generating JSON responses.\nUsing `json_schema` is recommended for models that support it. Note that the\nmodel will not generate JSON without a system or user message instructing it\nto do so.\n", "ident": "ResponseFormatJSONObject", "type": { "kind": "HttpTypeObject", @@ -9014,7 +9017,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "JSON object response format. An older method of generating JSON responses.\nUsing `json_schema` is recommended for models that support it. Note that the\nmodel will not generate JSON without a system or user message instructing it\nto do so.\n", "childrenParentSchema": "object", "children": [ "(resource) $shared > (model) response_format_json_object > (schema) > (property) type" @@ -9022,11 +9024,11 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema": { "kind": "HttpDeclProperty", - "title": "JSON schema", - "docstring": "Structured Outputs configuration options, including a JSON Schema.\n", + "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema", + "deprecated": false, "key": "json_schema", - "optional": false, - "nullable": false, + "docstring": "Structured Outputs configuration options, including a JSON Schema.\n", + "title": "JSON schema", "type": { "kind": "HttpTypeObject", "members": [ @@ -9044,8 +9046,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -9057,22 +9059,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) $shared > (model) response_format_json_schema > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of response format being defined. Always `json_schema`.", + "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of response format being defined. Always `json_schema`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "json_schema" } - ], - "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/type" + ] }, - "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -9082,6 +9084,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) $shared > (model) response_format_json_schema > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/ResponseFormatJsonSchema", + "docstring": "JSON Schema response format. Used to generate structured JSON responses.\nLearn more about [Structured Outputs](/docs/guides/structured-outputs).\n", "ident": "ResponseFormatJSONSchema", "type": { "kind": "HttpTypeObject", @@ -9094,7 +9097,6 @@ 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](/docs/guides/structured-outputs).\n", "childrenParentSchema": "object", "children": [ "(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema", @@ -9124,12 +9126,13 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the tool. If type is `function`, the function name must be set", + "oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the tool. If type is `function`, the function name must be set", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/type", "types": [ { "kind": "HttpTypeLiteral", @@ -9143,11 +9146,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "file_search" } - ], - "oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/type" + ] }, - "oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -9158,18 +9160,18 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) function": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/function", + "deprecated": false, "key": "function", - "optional": true, - "nullable": false, "type": { "kind": "HttpTypeReference", "ident": "AssistantToolChoiceFunction", "$ref": "(resource) beta.threads > (model) assistant_tool_choice_function > (schema)" }, - "oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/function", - "deprecated": false, - "schemaType": "object", + "optional": true, + "nullable": false, "modelImplicit": false, + "schemaType": "object", "modelPath": "(resource) beta.threads > (model) assistant_tool_choice_function", "childrenParentSchema": "object", "children": [ @@ -9179,6 +9181,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads > (model) assistant_tool_choice > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/AssistantsNamedToolChoice", + "docstring": "Specifies a tool the model should use. Use to force the model to call a specific tool.", "ident": "AssistantToolChoice", "type": { "kind": "HttpTypeObject", @@ -9191,7 +9194,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Specifies a tool the model should use. Use to force the model to call a specific tool.", "childrenParentSchema": "object", "children": [ "(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) type", @@ -9200,22 +9202,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of tool being defined: `code_interpreter`", + "oasRef": "#/components/schemas/AssistantToolsCode/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of tool being defined: `code_interpreter`", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantToolsCode/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "code_interpreter" } - ], - "oasRef": "#/components/schemas/AssistantToolsCode/properties/type" + ] }, - "oasRef": "#/components/schemas/AssistantToolsCode/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -9224,22 +9226,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of tool being defined: `file_search`", + "oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of tool being defined: `file_search`", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "file_search" } - ], - "oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/type" + ] }, - "oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -9248,10 +9250,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search": { "kind": "HttpDeclProperty", - "docstring": "Overrides for the file search tool.", + "oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/file_search", + "deprecated": false, "key": "file_search", - "optional": true, - "nullable": false, + "docstring": "Overrides for the file search tool.", "type": { "kind": "HttpTypeObject", "members": [ @@ -9263,8 +9265,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/file_search", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -9274,18 +9276,18 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) function_tool > (schema) > (property) function": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/AssistantToolsFunction/properties/function", + "deprecated": false, "key": "function", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeReference", "ident": "FunctionDefinition", "$ref": "(resource) $shared > (model) function_definition > (schema)" }, - "oasRef": "#/components/schemas/AssistantToolsFunction/properties/function", - "deprecated": false, - "schemaType": "object", + "optional": false, + "nullable": false, "modelImplicit": false, + "schemaType": "object", "modelPath": "(resource) $shared > (model) function_definition", "childrenParentSchema": "object", "children": [ @@ -9297,22 +9299,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) function_tool > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of tool being defined: `function`", + "oasRef": "#/components/schemas/AssistantToolsFunction/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of tool being defined: `function`", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantToolsFunction/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "function" } - ], - "oasRef": "#/components/schemas/AssistantToolsFunction/properties/type" + ] }, - "oasRef": "#/components/schemas/AssistantToolsFunction/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -9335,24 +9337,24 @@ 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](/docs/api-reference/runs/submitToolOutputs) endpoint.", + "oasRef": "#/components/schemas/RunToolCallObject/properties/id", + "deprecated": false, "key": "id", - "optional": false, - "nullable": false, + "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.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunToolCallObject/properties/id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) function": { "kind": "HttpDeclProperty", - "docstring": "The function definition.", + "oasRef": "#/components/schemas/RunToolCallObject/properties/function", + "deprecated": false, "key": "function", - "optional": false, - "nullable": false, + "docstring": "The function definition.", "type": { "kind": "HttpTypeObject", "members": [ @@ -9364,8 +9366,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunToolCallObject/properties/function", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -9375,22 +9377,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of tool call the output is required for. For now, this is always `function`.", + "oasRef": "#/components/schemas/RunToolCallObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of tool call the output is required for. For now, this is always `function`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunToolCallObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "function" } - ], - "oasRef": "#/components/schemas/RunToolCallObject/properties/type" + ] }, - "oasRef": "#/components/schemas/RunToolCallObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -9400,6 +9402,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RunToolCallObject", + "docstring": "Tool call objects", "ident": "RequiredActionFunctionToolCall", "type": { "kind": "HttpTypeObject", @@ -9415,7 +9418,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Tool call objects", "childrenParentSchema": "object", "children": [ "(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) id", @@ -9439,41 +9441,42 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the response format. Must be a-z, A-Z, 0-9, or contain\nunderscores and dashes, with a maximum length of 64.\n", + "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/name", + "deprecated": false, "key": "name", - "optional": false, - "nullable": false, + "docstring": "The name of the response format. Must be a-z, A-Z, 0-9, or contain\nunderscores and dashes, with a maximum length of 64.\n", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/name", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema > (property) description": { "kind": "HttpDeclProperty", - "docstring": "A description of what the response format is for, used by the model to\ndetermine how to respond in the format.\n", + "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/description", + "deprecated": false, "key": "description", - "optional": true, - "nullable": false, + "docstring": "A description of what the response format is for, used by the model to\ndetermine how to respond in the format.\n", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/description", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema > (property) schema": { "kind": "HttpDeclProperty", - "title": "JSON schema", - "docstring": "The schema for the response format, described as a JSON Schema object.\nLearn how to build JSON schemas [here](https://json-schema.org/).\n", + "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/schema", + "deprecated": false, "key": "schema", - "optional": true, - "nullable": false, + "docstring": "The schema for the response format, described as a JSON Schema object.\nLearn how to build JSON schemas [here](https://json-schema.org/).\n", + "title": "JSON schema", "type": { "kind": "HttpTypeReference", + "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/schema", "ident": "Record", "typeParameters": [ { @@ -9482,26 +9485,25 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch { "kind": "HttpTypeUnknown" } - ], - "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/schema" + ] }, - "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/schema", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "map", "children": [] }, "(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](/docs/guides/structured-outputs).\n", + "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/strict", + "deprecated": false, "key": "strict", - "optional": true, - "nullable": true, - "default": false, + "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", "type": { "kind": "HttpTypeBoolean" }, - "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/strict", - "deprecated": false, + "default": false, + "optional": true, + "nullable": true, "schemaType": "boolean", "children": [] }, @@ -9535,15 +9537,15 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads > (model) assistant_tool_choice_function > (schema) > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the function to call.", + "oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/function/properties/name", + "deprecated": false, "key": "name", - "optional": false, - "nullable": false, + "docstring": "The name of the function to call.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/function/properties/name", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, @@ -9580,10 +9582,10 @@ 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](/docs/assistants/tools/file-search#customizing-file-search-settings) for more information.\n", + "oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/file_search/properties/max_num_results", + "deprecated": false, "key": "max_num_results", - "optional": true, - "nullable": false, + "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", "type": { "kind": "HttpTypeNumber" }, @@ -9591,18 +9593,18 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "minimum": 1, "maximum": 50 }, - "oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/file_search/properties/max_num_results", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "integer", "children": [] }, "(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](/docs/assistants/tools/file-search#customizing-file-search-settings) for more information.\n", + "oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/file_search/properties/ranking_options", + "deprecated": false, "key": "ranking_options", - "optional": true, - "nullable": false, + "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", + "title": "File search tool call ranking options", "type": { "kind": "HttpTypeObject", "members": [ @@ -9614,8 +9616,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/file_search/properties/ranking_options", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -9625,62 +9627,62 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) $shared > (model) function_definition > (schema) > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.", + "oasRef": "#/components/schemas/FunctionObject/properties/name", + "deprecated": false, "key": "name", - "optional": false, - "nullable": false, + "docstring": "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/FunctionObject/properties/name", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) $shared > (model) function_definition > (schema) > (property) description": { "kind": "HttpDeclProperty", - "docstring": "A description of what the function does, used by the model to choose when and how to call the function.", + "oasRef": "#/components/schemas/FunctionObject/properties/description", + "deprecated": false, "key": "description", - "optional": true, - "nullable": false, + "docstring": "A description of what the function does, used by the model to choose when and how to call the function.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/FunctionObject/properties/description", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(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](/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.", + "oasRef": "#/components/schemas/FunctionObject/properties/parameters", + "deprecated": false, "key": "parameters", - "optional": true, - "nullable": false, + "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.", "type": { "kind": "HttpTypeReference", "ident": "FunctionParameters", "$ref": "(resource) $shared > (model) function_parameters > (schema)" }, - "oasRef": "#/components/schemas/FunctionObject/properties/parameters", - "deprecated": false, - "schemaType": "map", + "optional": true, + "nullable": false, "modelImplicit": false, + "schemaType": "map", "modelPath": "(resource) $shared > (model) function_parameters", "children": [] }, "(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](/docs/guides/function-calling).", + "oasRef": "#/components/schemas/FunctionObject/properties/strict", + "deprecated": false, "key": "strict", - "optional": true, - "nullable": true, - "default": false, + "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).", "type": { "kind": "HttpTypeBoolean" }, - "oasRef": "#/components/schemas/FunctionObject/properties/strict", - "deprecated": false, + "default": false, + "optional": true, + "nullable": true, "schemaType": "boolean", "children": [] }, @@ -9722,29 +9724,29 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) function > (property) arguments": { "kind": "HttpDeclProperty", - "docstring": "The arguments that the model expects you to pass to the function.", + "oasRef": "#/components/schemas/RunToolCallObject/properties/function/properties/arguments", + "deprecated": false, "key": "arguments", - "optional": false, - "nullable": false, + "docstring": "The arguments that the model expects you to pass to the function.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunToolCallObject/properties/function/properties/arguments", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) function > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the function.", + "oasRef": "#/components/schemas/RunToolCallObject/properties/function/properties/name", + "deprecated": false, "key": "name", - "optional": false, - "nullable": false, + "docstring": "The name of the function.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunToolCallObject/properties/function/properties/name", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, @@ -9757,10 +9759,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options > (property) score_threshold": { "kind": "HttpDeclProperty", - "docstring": "The score threshold for the file search. All values must be a floating point number between 0 and 1.", + "oasRef": "#/components/schemas/FileSearchRankingOptions/properties/score_threshold", + "deprecated": false, "key": "score_threshold", - "optional": false, - "nullable": false, + "docstring": "The score threshold for the file search. All values must be a floating point number between 0 and 1.", "type": { "kind": "HttpTypeNumber" }, @@ -9768,19 +9770,20 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "minimum": 0, "maximum": 1 }, - "oasRef": "#/components/schemas/FileSearchRankingOptions/properties/score_threshold", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "number", "children": [] }, "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options > (property) ranker": { "kind": "HttpDeclProperty", - "docstring": "The ranker to use for the file search. If not specified will use the `auto` ranker.", + "oasRef": "#/components/schemas/FileSearchRankingOptions/properties/ranker", + "deprecated": false, "key": "ranker", - "optional": true, - "nullable": false, + "docstring": "The ranker to use for the file search. If not specified will use the `auto` ranker.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/FileSearchRankingOptions/properties/ranker", "types": [ { "kind": "HttpTypeLiteral", @@ -9790,11 +9793,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "default_2024_08_21" } - ], - "oasRef": "#/components/schemas/FileSearchRankingOptions/properties/ranker" + ] }, - "oasRef": "#/components/schemas/FileSearchRankingOptions/properties/ranker", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -9805,9 +9807,11 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) $shared > (model) function_parameters > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/FunctionParameters", + "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.", "ident": "FunctionParameters", "type": { "kind": "HttpTypeReference", + "oasRef": "#/components/schemas/FunctionParameters", "ident": "Record", "typeParameters": [ { @@ -9816,10 +9820,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch { "kind": "HttpTypeUnknown" } - ], - "oasRef": "#/components/schemas/FunctionParameters" + ] }, - "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": { @@ -9858,7 +9860,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/oneOf/4", - "ident": "UnionMember5", + "docstring": "Occurs when a [run](/docs/api-reference/runs/object) is completed.", + "ident": "ThreadRunCompleted", "type": { "kind": "HttpTypeObject", "members": [ @@ -9870,7 +9873,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "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", @@ -9879,20 +9881,20 @@ 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](/docs/api-reference/threads).", + "oasRef": "#/components/schemas/RunStreamEvent/oneOf/4/properties/data", + "deprecated": false, "key": "data", - "optional": false, - "nullable": false, + "docstring": "Represents an execution run on a [thread](/docs/api-reference/threads).", + "title": "A run on a thread", "type": { "kind": "HttpTypeReference", "ident": "Run", "$ref": "(resource) beta.threads.runs > (model) run > (schema)" }, - "oasRef": "#/components/schemas/RunStreamEvent/oneOf/4/properties/data", - "deprecated": false, - "schemaType": "object", + "optional": false, + "nullable": false, "modelImplicit": false, + "schemaType": "object", "modelPath": "(resource) beta.threads.runs > (model) run", "childrenParentSchema": "object", "children": [ @@ -9927,21 +9929,21 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 5 > (property) event": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RunStreamEvent/oneOf/4/properties/event", + "deprecated": false, "key": "event", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStreamEvent/oneOf/4/properties/event", "types": [ { "kind": "HttpTypeLiteral", "literal": "thread.run.completed" } - ], - "oasRef": "#/components/schemas/RunStreamEvent/oneOf/4/properties/event" + ] }, - "oasRef": "#/components/schemas/RunStreamEvent/oneOf/4/properties/event", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -9950,123 +9952,123 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The identifier, which can be referenced in API endpoints.", + "oasRef": "#/components/schemas/RunObject/properties/id", + "deprecated": false, "key": "id", - "optional": false, - "nullable": false, + "docstring": "The identifier, which can be referenced in API endpoints.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunObject/properties/id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) assistant_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the [assistant](/docs/api-reference/assistants) used for execution of this run.", + "oasRef": "#/components/schemas/RunObject/properties/assistant_id", + "deprecated": false, "key": "assistant_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the [assistant](/docs/api-reference/assistants) used for execution of this run.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunObject/properties/assistant_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) cancelled_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the run was cancelled.", + "oasRef": "#/components/schemas/RunObject/properties/cancelled_at", + "deprecated": false, "key": "cancelled_at", - "optional": false, - "nullable": true, + "docstring": "The Unix timestamp (in seconds) for when the run was cancelled.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/RunObject/properties/cancelled_at", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) completed_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the run was completed.", + "oasRef": "#/components/schemas/RunObject/properties/completed_at", + "deprecated": false, "key": "completed_at", - "optional": false, - "nullable": true, + "docstring": "The Unix timestamp (in seconds) for when the run was completed.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/RunObject/properties/completed_at", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) created_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the run was created.", + "oasRef": "#/components/schemas/RunObject/properties/created_at", + "deprecated": false, "key": "created_at", - "optional": false, - "nullable": false, + "docstring": "The Unix timestamp (in seconds) for when the run was created.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/RunObject/properties/created_at", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) expires_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the run will expire.", + "oasRef": "#/components/schemas/RunObject/properties/expires_at", + "deprecated": false, "key": "expires_at", - "optional": false, - "nullable": true, + "docstring": "The Unix timestamp (in seconds) for when the run will expire.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/RunObject/properties/expires_at", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) failed_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the run failed.", + "oasRef": "#/components/schemas/RunObject/properties/failed_at", + "deprecated": false, "key": "failed_at", - "optional": false, - "nullable": true, + "docstring": "The Unix timestamp (in seconds) for when the run failed.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/RunObject/properties/failed_at", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) incomplete_details": { "kind": "HttpDeclProperty", - "docstring": "Details on why the run is incomplete. Will be `null` if the run is not incomplete.", + "oasRef": "#/components/schemas/RunObject/properties/incomplete_details", + "deprecated": false, "key": "incomplete_details", - "optional": false, - "nullable": true, + "docstring": "Details on why the run is incomplete. Will be `null` if the run is not incomplete.", "type": { "kind": "HttpTypeObject", "members": [ @@ -10075,8 +10077,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunObject/properties/incomplete_details", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -10085,24 +10087,24 @@ 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](/docs/api-reference/assistants) used for this run.", + "oasRef": "#/components/schemas/RunObject/properties/instructions", + "deprecated": false, "key": "instructions", - "optional": false, - "nullable": false, + "docstring": "The instructions that the [assistant](/docs/api-reference/assistants) used for this run.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunObject/properties/instructions", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) last_error": { "kind": "HttpDeclProperty", - "docstring": "The last error associated with this run. Will be `null` if there are no errors.", + "oasRef": "#/components/schemas/RunObject/properties/last_error", + "deprecated": false, "key": "last_error", - "optional": false, - "nullable": true, + "docstring": "The last error associated with this run. Will be `null` if there are no errors.", "type": { "kind": "HttpTypeObject", "members": [ @@ -10114,8 +10116,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunObject/properties/last_error", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -10125,88 +10127,88 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) max_completion_tokens": { "kind": "HttpDeclProperty", - "docstring": "The maximum number of completion tokens specified to have been used over the course of the run.\n", + "oasRef": "#/components/schemas/RunObject/properties/max_completion_tokens", + "deprecated": false, "key": "max_completion_tokens", - "optional": false, - "nullable": true, + "docstring": "The maximum number of completion tokens specified to have been used over the course of the run.\n", "type": { "kind": "HttpTypeNumber" }, "constraints": { "minimum": 256 }, - "oasRef": "#/components/schemas/RunObject/properties/max_completion_tokens", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) max_prompt_tokens": { "kind": "HttpDeclProperty", - "docstring": "The maximum number of prompt tokens specified to have been used over the course of the run.\n", + "oasRef": "#/components/schemas/RunObject/properties/max_prompt_tokens", + "deprecated": false, "key": "max_prompt_tokens", - "optional": false, - "nullable": true, + "docstring": "The maximum number of prompt tokens specified to have been used over the course of the run.\n", "type": { "kind": "HttpTypeNumber" }, "constraints": { "minimum": 256 }, - "oasRef": "#/components/schemas/RunObject/properties/max_prompt_tokens", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) metadata": { "kind": "HttpDeclProperty", - "docstring": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.\n", + "oasRef": "#/components/schemas/RunObject/properties/metadata", + "deprecated": false, "key": "metadata", - "optional": false, - "nullable": true, + "docstring": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.\n", "type": { "kind": "HttpTypeReference", "ident": "Metadata", "$ref": "(resource) $shared > (model) metadata > (schema)" }, - "oasRef": "#/components/schemas/RunObject/properties/metadata", - "deprecated": false, - "schemaType": "map", + "optional": false, + "nullable": true, "modelImplicit": false, + "schemaType": "map", "modelPath": "(resource) $shared > (model) metadata", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) model": { "kind": "HttpDeclProperty", - "docstring": "The model that the [assistant](/docs/api-reference/assistants) used for this run.", + "oasRef": "#/components/schemas/RunObject/properties/model", + "deprecated": false, "key": "model", - "optional": false, - "nullable": false, + "docstring": "The model that the [assistant](/docs/api-reference/assistants) used for this run.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunObject/properties/model", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) object": { "kind": "HttpDeclProperty", - "docstring": "The object type, which is always `thread.run`.", + "oasRef": "#/components/schemas/RunObject/properties/object", + "deprecated": false, "key": "object", - "optional": false, - "nullable": false, + "docstring": "The object type, which is always `thread.run`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunObject/properties/object", "types": [ { "kind": "HttpTypeLiteral", "literal": "thread.run" } - ], - "oasRef": "#/components/schemas/RunObject/properties/object" + ] }, - "oasRef": "#/components/schemas/RunObject/properties/object", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -10215,25 +10217,25 @@ 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](/docs/guides/function-calling#configuring-parallel-function-calling) during tool use.", + "oasRef": "#/components/schemas/RunObject/properties/parallel_tool_calls", + "deprecated": false, "key": "parallel_tool_calls", - "optional": false, - "nullable": false, - "default": true, + "docstring": "Whether to enable [parallel function calling](/docs/guides/function-calling#configuring-parallel-function-calling) during tool use.", "type": { "kind": "HttpTypeBoolean" }, - "oasRef": "#/components/schemas/RunObject/properties/parallel_tool_calls", - "deprecated": false, + "default": true, + "optional": false, + "nullable": false, "schemaType": "boolean", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) required_action": { "kind": "HttpDeclProperty", - "docstring": "Details on the action required to continue the run. Will be `null` if no action is required.", + "oasRef": "#/components/schemas/RunObject/properties/required_action", + "deprecated": false, "key": "required_action", - "optional": false, - "nullable": true, + "docstring": "Details on the action required to continue the run. Will be `null` if no action is required.", "type": { "kind": "HttpTypeObject", "members": [ @@ -10245,8 +10247,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunObject/properties/required_action", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -10256,19 +10258,19 @@ 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](/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", + "oasRef": "#/components/schemas/RunObject/properties/response_format", + "deprecated": false, "key": "response_format", - "optional": false, - "nullable": true, + "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", "type": { "kind": "HttpTypeReference", "ident": "AssistantResponseFormatOption", "$ref": "(resource) beta.threads > (model) assistant_response_format_option > (schema)" }, - "oasRef": "#/components/schemas/RunObject/properties/response_format", - "deprecated": false, - "schemaType": "union", + "optional": false, + "nullable": true, "modelImplicit": false, + "schemaType": "union", "modelPath": "(resource) beta.threads > (model) assistant_response_format_option", "childrenParentSchema": "union", "children": [ @@ -10280,29 +10282,30 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) started_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the run was started.", + "oasRef": "#/components/schemas/RunObject/properties/started_at", + "deprecated": false, "key": "started_at", - "optional": false, - "nullable": true, + "docstring": "The Unix timestamp (in seconds) for when the run was started.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/RunObject/properties/started_at", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) status": { "kind": "HttpDeclProperty", - "docstring": "The status of the run, which can be either `queued`, `in_progress`, `requires_action`, `cancelling`, `cancelled`, `failed`, `completed`, `incomplete`, or `expired`.", + "oasRef": "#/components/schemas/RunObject/properties/status", + "deprecated": false, "key": "status", - "optional": false, - "nullable": false, + "docstring": "The status of the run, which can be either `queued`, `in_progress`, `requires_action`, `cancelling`, `cancelled`, `failed`, `completed`, `incomplete`, or `expired`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunObject/properties/status", "types": [ { "kind": "HttpTypeLiteral", @@ -10340,11 +10343,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "expired" } - ], - "oasRef": "#/components/schemas/RunObject/properties/status" + ] }, - "oasRef": "#/components/schemas/RunObject/properties/status", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -10361,33 +10363,33 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) thread_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the [thread](/docs/api-reference/threads) that was executed on as a part of this run.", + "oasRef": "#/components/schemas/RunObject/properties/thread_id", + "deprecated": false, "key": "thread_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the [thread](/docs/api-reference/threads) that was executed on as a part of this run.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunObject/properties/thread_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) tool_choice": { "kind": "HttpDeclProperty", - "docstring": "Controls which (if any) tool is called by the model.\n`none` means the model will not call any tools and instead generates a message.\n`auto` is the default value and means the model can pick between generating a message or calling one or more tools.\n`required` means the model must call one or more tools before responding to the user.\nSpecifying a particular tool like `{\"type\": \"file_search\"}` or `{\"type\": \"function\", \"function\": {\"name\": \"my_function\"}}` forces the model to call that tool.\n", + "oasRef": "#/components/schemas/RunObject/properties/tool_choice", + "deprecated": false, "key": "tool_choice", - "optional": false, - "nullable": true, + "docstring": "Controls which (if any) tool is called by the model.\n`none` means the model will not call any tools and instead generates a message.\n`auto` is the default value and means the model can pick between generating a message or calling one or more tools.\n`required` means the model must call one or more tools before responding to the user.\nSpecifying a particular tool like `{\"type\": \"file_search\"}` or `{\"type\": \"function\", \"function\": {\"name\": \"my_function\"}}` forces the model to call that tool.\n", "type": { "kind": "HttpTypeReference", "ident": "AssistantToolChoiceOption", "$ref": "(resource) beta.threads > (model) assistant_tool_choice_option > (schema)" }, - "oasRef": "#/components/schemas/RunObject/properties/tool_choice", - "deprecated": false, - "schemaType": "union", + "optional": false, + "nullable": true, "modelImplicit": false, + "schemaType": "union", "modelPath": "(resource) beta.threads > (model) assistant_tool_choice_option", "childrenParentSchema": "union", "children": [ @@ -10397,15 +10399,16 @@ 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](/docs/api-reference/assistants) used for this run.", + "oasRef": "#/components/schemas/RunObject/properties/tools", + "deprecated": false, "key": "tools", - "optional": false, - "nullable": false, - "default": [], + "docstring": "The list of tools that the [assistant](/docs/api-reference/assistants) used for this run.", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RunObject/properties/tools", "elementType": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunObject/properties/tools/items", "types": [ { "kind": "HttpTypeReference", @@ -10422,13 +10425,12 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "ident": "FunctionTool", "$ref": "(resource) beta.assistants > (model) function_tool > (schema)" } - ], - "oasRef": "#/components/schemas/RunObject/properties/tools/items" - }, - "oasRef": "#/components/schemas/RunObject/properties/tools" + ] + } }, - "oasRef": "#/components/schemas/RunObject/properties/tools", - "deprecated": false, + "default": [], + "optional": false, + "nullable": false, "schemaType": "array", "childrenParentSchema": "union", "children": [ @@ -10439,11 +10441,11 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy": { "kind": "HttpDeclProperty", - "title": "Thread Truncation Controls", - "docstring": "Controls for how a thread will be truncated prior to the run. Use this to control the initial context window of the run.", + "oasRef": "#/components/schemas/RunObject/properties/truncation_strategy", + "deprecated": false, "key": "truncation_strategy", - "optional": false, - "nullable": true, + "docstring": "Controls for how a thread will be truncated prior to the run. Use this to control the initial context window of the run.", + "title": "Thread Truncation Controls", "type": { "kind": "HttpTypeObject", "members": [ @@ -10455,8 +10457,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunObject/properties/truncation_strategy", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -10466,10 +10468,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) usage": { "kind": "HttpDeclProperty", - "docstring": "Usage statistics related to the run. This value will be `null` if the run is not in a terminal state (i.e. `in_progress`, `queued`, etc.).", + "oasRef": "#/components/schemas/RunObject/properties/usage", + "deprecated": false, "key": "usage", - "optional": false, - "nullable": true, + "docstring": "Usage statistics related to the run. This value will be `null` if the run is not in a terminal state (i.e. `in_progress`, `queued`, etc.).", "type": { "kind": "HttpTypeObject", "members": [ @@ -10484,8 +10486,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunObject/properties/usage", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -10496,35 +10498,36 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) temperature": { "kind": "HttpDeclProperty", - "docstring": "The sampling temperature used for this run. If not set, defaults to 1.", + "oasRef": "#/components/schemas/RunObject/properties/temperature", + "deprecated": false, "key": "temperature", - "optional": true, - "nullable": true, + "docstring": "The sampling temperature used for this run. If not set, defaults to 1.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RunObject/properties/temperature", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "number", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) top_p": { "kind": "HttpDeclProperty", - "docstring": "The nucleus sampling value used for this run. If not set, defaults to 1.", + "oasRef": "#/components/schemas/RunObject/properties/top_p", + "deprecated": false, "key": "top_p", - "optional": true, - "nullable": true, + "docstring": "The nucleus sampling value used for this run. If not set, defaults to 1.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RunObject/properties/top_p", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "number", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RunObject", + "docstring": "Represents an execution run on a [thread](/docs/api-reference/threads).", "ident": "Run", "type": { "kind": "HttpTypeObject", @@ -10612,7 +10615,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Represents an execution run on a [thread](/docs/api-reference/threads).", "childrenParentSchema": "object", "children": [ "(resource) beta.threads.runs > (model) run > (schema) > (property) id", @@ -10653,12 +10655,13 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) incomplete_details > (property) reason": { "kind": "HttpDeclProperty", - "docstring": "The reason why the run is incomplete. This will point to which specific token limit was reached over the course of the run.", + "oasRef": "#/components/schemas/RunObject/properties/incomplete_details/properties/reason", + "deprecated": false, "key": "reason", - "optional": true, - "nullable": false, + "docstring": "The reason why the run is incomplete. This will point to which specific token limit was reached over the course of the run.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunObject/properties/incomplete_details/properties/reason", "types": [ { "kind": "HttpTypeLiteral", @@ -10668,11 +10671,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "max_prompt_tokens" } - ], - "oasRef": "#/components/schemas/RunObject/properties/incomplete_details/properties/reason" + ] }, - "oasRef": "#/components/schemas/RunObject/properties/incomplete_details/properties/reason", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -10682,12 +10684,13 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) code": { "kind": "HttpDeclProperty", - "docstring": "One of `server_error`, `rate_limit_exceeded`, or `invalid_prompt`.", + "oasRef": "#/components/schemas/RunObject/properties/last_error/properties/code", + "deprecated": false, "key": "code", - "optional": false, - "nullable": false, + "docstring": "One of `server_error`, `rate_limit_exceeded`, or `invalid_prompt`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunObject/properties/last_error/properties/code", "types": [ { "kind": "HttpTypeLiteral", @@ -10701,11 +10704,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "invalid_prompt" } - ], - "oasRef": "#/components/schemas/RunObject/properties/last_error/properties/code" + ] }, - "oasRef": "#/components/schemas/RunObject/properties/last_error/properties/code", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -10716,24 +10718,26 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) message": { "kind": "HttpDeclProperty", - "docstring": "A human-readable description of the error.", + "oasRef": "#/components/schemas/RunObject/properties/last_error/properties/message", + "deprecated": false, "key": "message", - "optional": false, - "nullable": false, + "docstring": "A human-readable description of the error.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunObject/properties/last_error/properties/message", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) $shared > (model) metadata > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/Metadata", + "docstring": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.\n", "ident": "Metadata", "type": { "kind": "HttpTypeReference", + "oasRef": "#/components/schemas/Metadata", "ident": "Record", "typeParameters": [ { @@ -10742,10 +10746,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch { "kind": "HttpTypeString" } - ], - "oasRef": "#/components/schemas/Metadata" + ] }, - "docstring": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.\n", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) object > (member) 0": { @@ -10757,10 +10759,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) required_action > (property) submit_tool_outputs": { "kind": "HttpDeclProperty", - "docstring": "Details on the tool outputs needed for this run to continue.", + "oasRef": "#/components/schemas/RunObject/properties/required_action/properties/submit_tool_outputs", + "deprecated": false, "key": "submit_tool_outputs", - "optional": false, - "nullable": false, + "docstring": "Details on the tool outputs needed for this run to continue.", "type": { "kind": "HttpTypeObject", "members": [ @@ -10769,8 +10771,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunObject/properties/required_action/properties/submit_tool_outputs", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -10779,22 +10781,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) required_action > (property) type": { "kind": "HttpDeclProperty", - "docstring": "For now, this is always `submit_tool_outputs`.", + "oasRef": "#/components/schemas/RunObject/properties/required_action/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "For now, this is always `submit_tool_outputs`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunObject/properties/required_action/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "submit_tool_outputs" } - ], - "oasRef": "#/components/schemas/RunObject/properties/required_action/properties/type" + ] }, - "oasRef": "#/components/schemas/RunObject/properties/required_action/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -10804,18 +10806,18 @@ 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/oneOf/0", + "docstring": "`auto` is the default value\n", "ident": "UnionMember0", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/oneOf/0", "types": [ { "kind": "HttpTypeLiteral", "literal": "auto" } - ], - "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/oneOf/0" + ] }, - "docstring": "`auto` is the default value\n", "childrenParentSchema": "enum", "children": [ "(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 0 > (member) 0" @@ -10861,19 +10863,21 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads > (model) assistant_response_format_option > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption", + "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", "ident": "AssistantResponseFormatOption", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption", "types": [ { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/oneOf/0", "types": [ { "kind": "HttpTypeLiteral", "literal": "auto" } - ], - "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/oneOf/0" + ] }, { "kind": "HttpTypeReference", @@ -10890,10 +10894,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "ident": "ResponseFormatJSONSchema", "$ref": "(resource) $shared > (model) response_format_json_schema > (schema)" } - ], - "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption" + ] }, - "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", @@ -10968,9 +10970,11 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0": { "kind": "HttpDeclTypeAlias", "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", "ident": "UnionMember0", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption/oneOf/0", "types": [ { "kind": "HttpTypeLiteral", @@ -10984,10 +10988,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "required" } - ], - "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", "children": [ "(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0 > (member) 0", @@ -11011,12 +11013,15 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads > (model) assistant_tool_choice_option > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption", + "docstring": "Controls which (if any) tool is called by the model.\n`none` means the model will not call any tools and instead generates a message.\n`auto` is the default value and means the model can pick between generating a message or calling one or more tools.\n`required` means the model must call one or more tools before responding to the user.\nSpecifying a particular tool like `{\"type\": \"file_search\"}` or `{\"type\": \"function\", \"function\": {\"name\": \"my_function\"}}` forces the model to call that tool.\n", "ident": "AssistantToolChoiceOption", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption", "types": [ { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption/oneOf/0", "types": [ { "kind": "HttpTypeLiteral", @@ -11030,18 +11035,15 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "required" } - ], - "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption/oneOf/0" + ] }, { "kind": "HttpTypeReference", "ident": "AssistantToolChoice", "$ref": "(resource) beta.threads > (model) assistant_tool_choice > (schema)" } - ], - "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption" + ] }, - "docstring": "Controls which (if any) tool is called by the model.\n`none` means the model will not call any tools and instead generates a message.\n`auto` is the default value and means the model can pick between generating a message or calling one or more tools.\n`required` means the model must call one or more tools before responding to the user.\nSpecifying a particular tool like `{\"type\": \"file_search\"}` or `{\"type\": \"function\", \"function\": {\"name\": \"my_function\"}}` forces the model to call that tool.\n", "childrenParentSchema": "union", "children": [ "(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0", @@ -11147,12 +11149,13 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The truncation strategy to use for the thread. The default is `auto`. If set to `last_messages`, the thread will be truncated to the n most recent messages in the thread. When set to `auto`, messages in the middle of the thread will be dropped to fit the context length of the model, `max_prompt_tokens`.", + "oasRef": "#/components/schemas/TruncationObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The truncation strategy to use for the thread. The default is `auto`. If set to `last_messages`, the thread will be truncated to the n most recent messages in the thread. When set to `auto`, messages in the middle of the thread will be dropped to fit the context length of the model, `max_prompt_tokens`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/TruncationObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", @@ -11162,11 +11165,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "last_messages" } - ], - "oasRef": "#/components/schemas/TruncationObject/properties/type" + ] }, - "oasRef": "#/components/schemas/TruncationObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -11176,60 +11178,60 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) last_messages": { "kind": "HttpDeclProperty", - "docstring": "The number of most recent messages from the thread when constructing the context for the run.", + "oasRef": "#/components/schemas/TruncationObject/properties/last_messages", + "deprecated": false, "key": "last_messages", - "optional": true, - "nullable": true, + "docstring": "The number of most recent messages from the thread when constructing the context for the run.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "minimum": 1 }, - "oasRef": "#/components/schemas/TruncationObject/properties/last_messages", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) usage > (property) completion_tokens": { "kind": "HttpDeclProperty", - "docstring": "Number of completion tokens used over the course of the run.", + "oasRef": "#/components/schemas/RunCompletionUsage/anyOf/0/properties/completion_tokens", + "deprecated": false, "key": "completion_tokens", - "optional": false, - "nullable": false, + "docstring": "Number of completion tokens used over the course of the run.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RunCompletionUsage/anyOf/0/properties/completion_tokens", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) usage > (property) prompt_tokens": { "kind": "HttpDeclProperty", - "docstring": "Number of prompt tokens used over the course of the run.", + "oasRef": "#/components/schemas/RunCompletionUsage/anyOf/0/properties/prompt_tokens", + "deprecated": false, "key": "prompt_tokens", - "optional": false, - "nullable": false, + "docstring": "Number of prompt tokens used over the course of the run.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RunCompletionUsage/anyOf/0/properties/prompt_tokens", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) usage > (property) total_tokens": { "kind": "HttpDeclProperty", - "docstring": "Total number of tokens used (prompt + completion).", + "oasRef": "#/components/schemas/RunCompletionUsage/anyOf/0/properties/total_tokens", + "deprecated": false, "key": "total_tokens", - "optional": false, - "nullable": false, + "docstring": "Total number of tokens used (prompt + completion).", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RunCompletionUsage/anyOf/0/properties/total_tokens", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, @@ -11270,21 +11272,21 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) required_action > (property) submit_tool_outputs > (property) tool_calls": { "kind": "HttpDeclProperty", - "docstring": "A list of the relevant tool calls.", + "oasRef": "#/components/schemas/RunObject/properties/required_action/properties/submit_tool_outputs/properties/tool_calls", + "deprecated": false, "key": "tool_calls", - "optional": false, - "nullable": false, + "docstring": "A list of the relevant tool calls.", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RunObject/properties/required_action/properties/submit_tool_outputs/properties/tool_calls", "elementType": { "kind": "HttpTypeReference", "ident": "RequiredActionFunctionToolCall", "$ref": "(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema)" + } }, - "oasRef": "#/components/schemas/RunObject/properties/required_action/properties/submit_tool_outputs/properties/tool_calls" - }, - "oasRef": "#/components/schemas/RunObject/properties/required_action/properties/submit_tool_outputs/properties/tool_calls", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "array", "childrenParentSchema": "object", "children": [ @@ -11309,22 +11311,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) $shared > (model) response_format_text > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of response format being defined. Always `text`.", + "oasRef": "#/components/schemas/ResponseFormatText/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of response format being defined. Always `text`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/ResponseFormatText/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "text" } - ], - "oasRef": "#/components/schemas/ResponseFormatText/properties/type" + ] }, - "oasRef": "#/components/schemas/ResponseFormatText/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -11334,6 +11336,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) $shared > (model) response_format_text > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/ResponseFormatText", + "docstring": "Default response format. Used to generate text responses.\n", "ident": "ResponseFormatText", "type": { "kind": "HttpTypeObject", @@ -11343,7 +11346,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Default response format. Used to generate text responses.\n", "childrenParentSchema": "object", "children": [ "(resource) $shared > (model) response_format_text > (schema) > (property) type" @@ -11351,22 +11353,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) $shared > (model) response_format_json_object > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of response format being defined. Always `json_object`.", + "oasRef": "#/components/schemas/ResponseFormatJsonObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of response format being defined. Always `json_object`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/ResponseFormatJsonObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "json_object" } - ], - "oasRef": "#/components/schemas/ResponseFormatJsonObject/properties/type" + ] }, - "oasRef": "#/components/schemas/ResponseFormatJsonObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -11376,6 +11378,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) $shared > (model) response_format_json_object > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/ResponseFormatJsonObject", + "docstring": "JSON object response format. An older method of generating JSON responses.\nUsing `json_schema` is recommended for models that support it. Note that the\nmodel will not generate JSON without a system or user message instructing it\nto do so.\n", "ident": "ResponseFormatJSONObject", "type": { "kind": "HttpTypeObject", @@ -11385,7 +11388,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "JSON object response format. An older method of generating JSON responses.\nUsing `json_schema` is recommended for models that support it. Note that the\nmodel will not generate JSON without a system or user message instructing it\nto do so.\n", "childrenParentSchema": "object", "children": [ "(resource) $shared > (model) response_format_json_object > (schema) > (property) type" @@ -11393,11 +11395,11 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema": { "kind": "HttpDeclProperty", - "title": "JSON schema", - "docstring": "Structured Outputs configuration options, including a JSON Schema.\n", + "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema", + "deprecated": false, "key": "json_schema", - "optional": false, - "nullable": false, + "docstring": "Structured Outputs configuration options, including a JSON Schema.\n", + "title": "JSON schema", "type": { "kind": "HttpTypeObject", "members": [ @@ -11415,8 +11417,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -11428,22 +11430,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) $shared > (model) response_format_json_schema > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of response format being defined. Always `json_schema`.", + "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of response format being defined. Always `json_schema`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "json_schema" } - ], - "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/type" + ] }, - "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -11453,6 +11455,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) $shared > (model) response_format_json_schema > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/ResponseFormatJsonSchema", + "docstring": "JSON Schema response format. Used to generate structured JSON responses.\nLearn more about [Structured Outputs](/docs/guides/structured-outputs).\n", "ident": "ResponseFormatJSONSchema", "type": { "kind": "HttpTypeObject", @@ -11465,7 +11468,6 @@ 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](/docs/guides/structured-outputs).\n", "childrenParentSchema": "object", "children": [ "(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema", @@ -11495,12 +11497,13 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the tool. If type is `function`, the function name must be set", + "oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the tool. If type is `function`, the function name must be set", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/type", "types": [ { "kind": "HttpTypeLiteral", @@ -11514,11 +11517,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "file_search" } - ], - "oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/type" + ] }, - "oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -11529,18 +11531,18 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) function": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/function", + "deprecated": false, "key": "function", - "optional": true, - "nullable": false, "type": { "kind": "HttpTypeReference", "ident": "AssistantToolChoiceFunction", "$ref": "(resource) beta.threads > (model) assistant_tool_choice_function > (schema)" }, - "oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/function", - "deprecated": false, - "schemaType": "object", + "optional": true, + "nullable": false, "modelImplicit": false, + "schemaType": "object", "modelPath": "(resource) beta.threads > (model) assistant_tool_choice_function", "childrenParentSchema": "object", "children": [ @@ -11550,6 +11552,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads > (model) assistant_tool_choice > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/AssistantsNamedToolChoice", + "docstring": "Specifies a tool the model should use. Use to force the model to call a specific tool.", "ident": "AssistantToolChoice", "type": { "kind": "HttpTypeObject", @@ -11562,7 +11565,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Specifies a tool the model should use. Use to force the model to call a specific tool.", "childrenParentSchema": "object", "children": [ "(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) type", @@ -11571,22 +11573,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of tool being defined: `code_interpreter`", + "oasRef": "#/components/schemas/AssistantToolsCode/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of tool being defined: `code_interpreter`", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantToolsCode/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "code_interpreter" } - ], - "oasRef": "#/components/schemas/AssistantToolsCode/properties/type" + ] }, - "oasRef": "#/components/schemas/AssistantToolsCode/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -11595,22 +11597,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of tool being defined: `file_search`", + "oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of tool being defined: `file_search`", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "file_search" } - ], - "oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/type" + ] }, - "oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -11619,10 +11621,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search": { "kind": "HttpDeclProperty", - "docstring": "Overrides for the file search tool.", + "oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/file_search", + "deprecated": false, "key": "file_search", - "optional": true, - "nullable": false, + "docstring": "Overrides for the file search tool.", "type": { "kind": "HttpTypeObject", "members": [ @@ -11634,8 +11636,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/file_search", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -11645,18 +11647,18 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) function_tool > (schema) > (property) function": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/AssistantToolsFunction/properties/function", + "deprecated": false, "key": "function", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeReference", "ident": "FunctionDefinition", "$ref": "(resource) $shared > (model) function_definition > (schema)" }, - "oasRef": "#/components/schemas/AssistantToolsFunction/properties/function", - "deprecated": false, - "schemaType": "object", + "optional": false, + "nullable": false, "modelImplicit": false, + "schemaType": "object", "modelPath": "(resource) $shared > (model) function_definition", "childrenParentSchema": "object", "children": [ @@ -11668,22 +11670,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) function_tool > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of tool being defined: `function`", + "oasRef": "#/components/schemas/AssistantToolsFunction/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of tool being defined: `function`", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantToolsFunction/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "function" } - ], - "oasRef": "#/components/schemas/AssistantToolsFunction/properties/type" + ] }, - "oasRef": "#/components/schemas/AssistantToolsFunction/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -11706,24 +11708,24 @@ 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](/docs/api-reference/runs/submitToolOutputs) endpoint.", + "oasRef": "#/components/schemas/RunToolCallObject/properties/id", + "deprecated": false, "key": "id", - "optional": false, - "nullable": false, + "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.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunToolCallObject/properties/id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) function": { "kind": "HttpDeclProperty", - "docstring": "The function definition.", + "oasRef": "#/components/schemas/RunToolCallObject/properties/function", + "deprecated": false, "key": "function", - "optional": false, - "nullable": false, + "docstring": "The function definition.", "type": { "kind": "HttpTypeObject", "members": [ @@ -11735,8 +11737,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunToolCallObject/properties/function", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -11746,22 +11748,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of tool call the output is required for. For now, this is always `function`.", + "oasRef": "#/components/schemas/RunToolCallObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of tool call the output is required for. For now, this is always `function`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunToolCallObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "function" } - ], - "oasRef": "#/components/schemas/RunToolCallObject/properties/type" + ] }, - "oasRef": "#/components/schemas/RunToolCallObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -11771,6 +11773,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RunToolCallObject", + "docstring": "Tool call objects", "ident": "RequiredActionFunctionToolCall", "type": { "kind": "HttpTypeObject", @@ -11786,7 +11789,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Tool call objects", "childrenParentSchema": "object", "children": [ "(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) id", @@ -11810,41 +11812,42 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the response format. Must be a-z, A-Z, 0-9, or contain\nunderscores and dashes, with a maximum length of 64.\n", + "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/name", + "deprecated": false, "key": "name", - "optional": false, - "nullable": false, + "docstring": "The name of the response format. Must be a-z, A-Z, 0-9, or contain\nunderscores and dashes, with a maximum length of 64.\n", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/name", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema > (property) description": { "kind": "HttpDeclProperty", - "docstring": "A description of what the response format is for, used by the model to\ndetermine how to respond in the format.\n", + "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/description", + "deprecated": false, "key": "description", - "optional": true, - "nullable": false, + "docstring": "A description of what the response format is for, used by the model to\ndetermine how to respond in the format.\n", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/description", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema > (property) schema": { "kind": "HttpDeclProperty", - "title": "JSON schema", - "docstring": "The schema for the response format, described as a JSON Schema object.\nLearn how to build JSON schemas [here](https://json-schema.org/).\n", + "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/schema", + "deprecated": false, "key": "schema", - "optional": true, - "nullable": false, + "docstring": "The schema for the response format, described as a JSON Schema object.\nLearn how to build JSON schemas [here](https://json-schema.org/).\n", + "title": "JSON schema", "type": { "kind": "HttpTypeReference", + "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/schema", "ident": "Record", "typeParameters": [ { @@ -11853,26 +11856,25 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch { "kind": "HttpTypeUnknown" } - ], - "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/schema" + ] }, - "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/schema", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "map", "children": [] }, "(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](/docs/guides/structured-outputs).\n", + "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/strict", + "deprecated": false, "key": "strict", - "optional": true, - "nullable": true, - "default": false, + "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", "type": { "kind": "HttpTypeBoolean" }, - "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/strict", - "deprecated": false, + "default": false, + "optional": true, + "nullable": true, "schemaType": "boolean", "children": [] }, @@ -11906,15 +11908,15 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads > (model) assistant_tool_choice_function > (schema) > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the function to call.", + "oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/function/properties/name", + "deprecated": false, "key": "name", - "optional": false, - "nullable": false, + "docstring": "The name of the function to call.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/function/properties/name", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, @@ -11951,10 +11953,10 @@ 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](/docs/assistants/tools/file-search#customizing-file-search-settings) for more information.\n", + "oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/file_search/properties/max_num_results", + "deprecated": false, "key": "max_num_results", - "optional": true, - "nullable": false, + "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", "type": { "kind": "HttpTypeNumber" }, @@ -11962,18 +11964,18 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "minimum": 1, "maximum": 50 }, - "oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/file_search/properties/max_num_results", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "integer", "children": [] }, "(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](/docs/assistants/tools/file-search#customizing-file-search-settings) for more information.\n", + "oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/file_search/properties/ranking_options", + "deprecated": false, "key": "ranking_options", - "optional": true, - "nullable": false, + "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", + "title": "File search tool call ranking options", "type": { "kind": "HttpTypeObject", "members": [ @@ -11985,8 +11987,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/file_search/properties/ranking_options", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -11996,62 +11998,62 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) $shared > (model) function_definition > (schema) > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.", + "oasRef": "#/components/schemas/FunctionObject/properties/name", + "deprecated": false, "key": "name", - "optional": false, - "nullable": false, + "docstring": "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/FunctionObject/properties/name", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) $shared > (model) function_definition > (schema) > (property) description": { "kind": "HttpDeclProperty", - "docstring": "A description of what the function does, used by the model to choose when and how to call the function.", + "oasRef": "#/components/schemas/FunctionObject/properties/description", + "deprecated": false, "key": "description", - "optional": true, - "nullable": false, + "docstring": "A description of what the function does, used by the model to choose when and how to call the function.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/FunctionObject/properties/description", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(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](/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.", + "oasRef": "#/components/schemas/FunctionObject/properties/parameters", + "deprecated": false, "key": "parameters", - "optional": true, - "nullable": false, + "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.", "type": { "kind": "HttpTypeReference", "ident": "FunctionParameters", "$ref": "(resource) $shared > (model) function_parameters > (schema)" }, - "oasRef": "#/components/schemas/FunctionObject/properties/parameters", - "deprecated": false, - "schemaType": "map", + "optional": true, + "nullable": false, "modelImplicit": false, + "schemaType": "map", "modelPath": "(resource) $shared > (model) function_parameters", "children": [] }, "(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](/docs/guides/function-calling).", + "oasRef": "#/components/schemas/FunctionObject/properties/strict", + "deprecated": false, "key": "strict", - "optional": true, - "nullable": true, - "default": false, + "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).", "type": { "kind": "HttpTypeBoolean" }, - "oasRef": "#/components/schemas/FunctionObject/properties/strict", - "deprecated": false, + "default": false, + "optional": true, + "nullable": true, "schemaType": "boolean", "children": [] }, @@ -12093,29 +12095,29 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) function > (property) arguments": { "kind": "HttpDeclProperty", - "docstring": "The arguments that the model expects you to pass to the function.", + "oasRef": "#/components/schemas/RunToolCallObject/properties/function/properties/arguments", + "deprecated": false, "key": "arguments", - "optional": false, - "nullable": false, + "docstring": "The arguments that the model expects you to pass to the function.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunToolCallObject/properties/function/properties/arguments", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) function > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the function.", + "oasRef": "#/components/schemas/RunToolCallObject/properties/function/properties/name", + "deprecated": false, "key": "name", - "optional": false, - "nullable": false, + "docstring": "The name of the function.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunToolCallObject/properties/function/properties/name", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, @@ -12128,10 +12130,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options > (property) score_threshold": { "kind": "HttpDeclProperty", - "docstring": "The score threshold for the file search. All values must be a floating point number between 0 and 1.", + "oasRef": "#/components/schemas/FileSearchRankingOptions/properties/score_threshold", + "deprecated": false, "key": "score_threshold", - "optional": false, - "nullable": false, + "docstring": "The score threshold for the file search. All values must be a floating point number between 0 and 1.", "type": { "kind": "HttpTypeNumber" }, @@ -12139,19 +12141,20 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "minimum": 0, "maximum": 1 }, - "oasRef": "#/components/schemas/FileSearchRankingOptions/properties/score_threshold", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "number", "children": [] }, "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options > (property) ranker": { "kind": "HttpDeclProperty", - "docstring": "The ranker to use for the file search. If not specified will use the `auto` ranker.", + "oasRef": "#/components/schemas/FileSearchRankingOptions/properties/ranker", + "deprecated": false, "key": "ranker", - "optional": true, - "nullable": false, + "docstring": "The ranker to use for the file search. If not specified will use the `auto` ranker.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/FileSearchRankingOptions/properties/ranker", "types": [ { "kind": "HttpTypeLiteral", @@ -12161,11 +12164,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "default_2024_08_21" } - ], - "oasRef": "#/components/schemas/FileSearchRankingOptions/properties/ranker" + ] }, - "oasRef": "#/components/schemas/FileSearchRankingOptions/properties/ranker", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -12176,9 +12178,11 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) $shared > (model) function_parameters > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/FunctionParameters", + "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.", "ident": "FunctionParameters", "type": { "kind": "HttpTypeReference", + "oasRef": "#/components/schemas/FunctionParameters", "ident": "Record", "typeParameters": [ { @@ -12187,10 +12191,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch { "kind": "HttpTypeUnknown" } - ], - "oasRef": "#/components/schemas/FunctionParameters" + ] }, - "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": { @@ -12229,7 +12231,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/oneOf/5", - "ident": "UnionMember6", + "docstring": "Occurs when a [run](/docs/api-reference/runs/object) ends with status `incomplete`.", + "ident": "ThreadRunIncomplete", "type": { "kind": "HttpTypeObject", "members": [ @@ -12241,7 +12244,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "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", @@ -12250,20 +12252,20 @@ 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](/docs/api-reference/threads).", + "oasRef": "#/components/schemas/RunStreamEvent/oneOf/5/properties/data", + "deprecated": false, "key": "data", - "optional": false, - "nullable": false, + "docstring": "Represents an execution run on a [thread](/docs/api-reference/threads).", + "title": "A run on a thread", "type": { "kind": "HttpTypeReference", "ident": "Run", "$ref": "(resource) beta.threads.runs > (model) run > (schema)" }, - "oasRef": "#/components/schemas/RunStreamEvent/oneOf/5/properties/data", - "deprecated": false, - "schemaType": "object", + "optional": false, + "nullable": false, "modelImplicit": false, + "schemaType": "object", "modelPath": "(resource) beta.threads.runs > (model) run", "childrenParentSchema": "object", "children": [ @@ -12298,21 +12300,21 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 6 > (property) event": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RunStreamEvent/oneOf/5/properties/event", + "deprecated": false, "key": "event", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStreamEvent/oneOf/5/properties/event", "types": [ { "kind": "HttpTypeLiteral", "literal": "thread.run.incomplete" } - ], - "oasRef": "#/components/schemas/RunStreamEvent/oneOf/5/properties/event" + ] }, - "oasRef": "#/components/schemas/RunStreamEvent/oneOf/5/properties/event", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -12321,123 +12323,123 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The identifier, which can be referenced in API endpoints.", + "oasRef": "#/components/schemas/RunObject/properties/id", + "deprecated": false, "key": "id", - "optional": false, - "nullable": false, + "docstring": "The identifier, which can be referenced in API endpoints.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunObject/properties/id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) assistant_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the [assistant](/docs/api-reference/assistants) used for execution of this run.", + "oasRef": "#/components/schemas/RunObject/properties/assistant_id", + "deprecated": false, "key": "assistant_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the [assistant](/docs/api-reference/assistants) used for execution of this run.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunObject/properties/assistant_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) cancelled_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the run was cancelled.", + "oasRef": "#/components/schemas/RunObject/properties/cancelled_at", + "deprecated": false, "key": "cancelled_at", - "optional": false, - "nullable": true, + "docstring": "The Unix timestamp (in seconds) for when the run was cancelled.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/RunObject/properties/cancelled_at", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) completed_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the run was completed.", + "oasRef": "#/components/schemas/RunObject/properties/completed_at", + "deprecated": false, "key": "completed_at", - "optional": false, - "nullable": true, + "docstring": "The Unix timestamp (in seconds) for when the run was completed.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/RunObject/properties/completed_at", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) created_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the run was created.", + "oasRef": "#/components/schemas/RunObject/properties/created_at", + "deprecated": false, "key": "created_at", - "optional": false, - "nullable": false, + "docstring": "The Unix timestamp (in seconds) for when the run was created.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/RunObject/properties/created_at", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) expires_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the run will expire.", + "oasRef": "#/components/schemas/RunObject/properties/expires_at", + "deprecated": false, "key": "expires_at", - "optional": false, - "nullable": true, + "docstring": "The Unix timestamp (in seconds) for when the run will expire.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/RunObject/properties/expires_at", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) failed_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the run failed.", + "oasRef": "#/components/schemas/RunObject/properties/failed_at", + "deprecated": false, "key": "failed_at", - "optional": false, - "nullable": true, + "docstring": "The Unix timestamp (in seconds) for when the run failed.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/RunObject/properties/failed_at", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) incomplete_details": { "kind": "HttpDeclProperty", - "docstring": "Details on why the run is incomplete. Will be `null` if the run is not incomplete.", + "oasRef": "#/components/schemas/RunObject/properties/incomplete_details", + "deprecated": false, "key": "incomplete_details", - "optional": false, - "nullable": true, + "docstring": "Details on why the run is incomplete. Will be `null` if the run is not incomplete.", "type": { "kind": "HttpTypeObject", "members": [ @@ -12446,8 +12448,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunObject/properties/incomplete_details", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -12456,24 +12458,24 @@ 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](/docs/api-reference/assistants) used for this run.", + "oasRef": "#/components/schemas/RunObject/properties/instructions", + "deprecated": false, "key": "instructions", - "optional": false, - "nullable": false, + "docstring": "The instructions that the [assistant](/docs/api-reference/assistants) used for this run.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunObject/properties/instructions", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) last_error": { "kind": "HttpDeclProperty", - "docstring": "The last error associated with this run. Will be `null` if there are no errors.", + "oasRef": "#/components/schemas/RunObject/properties/last_error", + "deprecated": false, "key": "last_error", - "optional": false, - "nullable": true, + "docstring": "The last error associated with this run. Will be `null` if there are no errors.", "type": { "kind": "HttpTypeObject", "members": [ @@ -12485,8 +12487,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunObject/properties/last_error", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -12496,88 +12498,88 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) max_completion_tokens": { "kind": "HttpDeclProperty", - "docstring": "The maximum number of completion tokens specified to have been used over the course of the run.\n", + "oasRef": "#/components/schemas/RunObject/properties/max_completion_tokens", + "deprecated": false, "key": "max_completion_tokens", - "optional": false, - "nullable": true, + "docstring": "The maximum number of completion tokens specified to have been used over the course of the run.\n", "type": { "kind": "HttpTypeNumber" }, "constraints": { "minimum": 256 }, - "oasRef": "#/components/schemas/RunObject/properties/max_completion_tokens", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) max_prompt_tokens": { "kind": "HttpDeclProperty", - "docstring": "The maximum number of prompt tokens specified to have been used over the course of the run.\n", + "oasRef": "#/components/schemas/RunObject/properties/max_prompt_tokens", + "deprecated": false, "key": "max_prompt_tokens", - "optional": false, - "nullable": true, + "docstring": "The maximum number of prompt tokens specified to have been used over the course of the run.\n", "type": { "kind": "HttpTypeNumber" }, "constraints": { "minimum": 256 }, - "oasRef": "#/components/schemas/RunObject/properties/max_prompt_tokens", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) metadata": { "kind": "HttpDeclProperty", - "docstring": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.\n", + "oasRef": "#/components/schemas/RunObject/properties/metadata", + "deprecated": false, "key": "metadata", - "optional": false, - "nullable": true, + "docstring": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.\n", "type": { "kind": "HttpTypeReference", "ident": "Metadata", "$ref": "(resource) $shared > (model) metadata > (schema)" }, - "oasRef": "#/components/schemas/RunObject/properties/metadata", - "deprecated": false, - "schemaType": "map", + "optional": false, + "nullable": true, "modelImplicit": false, + "schemaType": "map", "modelPath": "(resource) $shared > (model) metadata", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) model": { "kind": "HttpDeclProperty", - "docstring": "The model that the [assistant](/docs/api-reference/assistants) used for this run.", + "oasRef": "#/components/schemas/RunObject/properties/model", + "deprecated": false, "key": "model", - "optional": false, - "nullable": false, + "docstring": "The model that the [assistant](/docs/api-reference/assistants) used for this run.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunObject/properties/model", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) object": { "kind": "HttpDeclProperty", - "docstring": "The object type, which is always `thread.run`.", + "oasRef": "#/components/schemas/RunObject/properties/object", + "deprecated": false, "key": "object", - "optional": false, - "nullable": false, + "docstring": "The object type, which is always `thread.run`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunObject/properties/object", "types": [ { "kind": "HttpTypeLiteral", "literal": "thread.run" } - ], - "oasRef": "#/components/schemas/RunObject/properties/object" + ] }, - "oasRef": "#/components/schemas/RunObject/properties/object", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -12586,25 +12588,25 @@ 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](/docs/guides/function-calling#configuring-parallel-function-calling) during tool use.", + "oasRef": "#/components/schemas/RunObject/properties/parallel_tool_calls", + "deprecated": false, "key": "parallel_tool_calls", - "optional": false, - "nullable": false, - "default": true, + "docstring": "Whether to enable [parallel function calling](/docs/guides/function-calling#configuring-parallel-function-calling) during tool use.", "type": { "kind": "HttpTypeBoolean" }, - "oasRef": "#/components/schemas/RunObject/properties/parallel_tool_calls", - "deprecated": false, + "default": true, + "optional": false, + "nullable": false, "schemaType": "boolean", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) required_action": { "kind": "HttpDeclProperty", - "docstring": "Details on the action required to continue the run. Will be `null` if no action is required.", + "oasRef": "#/components/schemas/RunObject/properties/required_action", + "deprecated": false, "key": "required_action", - "optional": false, - "nullable": true, + "docstring": "Details on the action required to continue the run. Will be `null` if no action is required.", "type": { "kind": "HttpTypeObject", "members": [ @@ -12616,8 +12618,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunObject/properties/required_action", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -12627,19 +12629,19 @@ 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](/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", + "oasRef": "#/components/schemas/RunObject/properties/response_format", + "deprecated": false, "key": "response_format", - "optional": false, - "nullable": true, + "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", "type": { "kind": "HttpTypeReference", "ident": "AssistantResponseFormatOption", "$ref": "(resource) beta.threads > (model) assistant_response_format_option > (schema)" }, - "oasRef": "#/components/schemas/RunObject/properties/response_format", - "deprecated": false, - "schemaType": "union", + "optional": false, + "nullable": true, "modelImplicit": false, + "schemaType": "union", "modelPath": "(resource) beta.threads > (model) assistant_response_format_option", "childrenParentSchema": "union", "children": [ @@ -12651,29 +12653,30 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) started_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the run was started.", + "oasRef": "#/components/schemas/RunObject/properties/started_at", + "deprecated": false, "key": "started_at", - "optional": false, - "nullable": true, + "docstring": "The Unix timestamp (in seconds) for when the run was started.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/RunObject/properties/started_at", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) status": { "kind": "HttpDeclProperty", - "docstring": "The status of the run, which can be either `queued`, `in_progress`, `requires_action`, `cancelling`, `cancelled`, `failed`, `completed`, `incomplete`, or `expired`.", + "oasRef": "#/components/schemas/RunObject/properties/status", + "deprecated": false, "key": "status", - "optional": false, - "nullable": false, + "docstring": "The status of the run, which can be either `queued`, `in_progress`, `requires_action`, `cancelling`, `cancelled`, `failed`, `completed`, `incomplete`, or `expired`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunObject/properties/status", "types": [ { "kind": "HttpTypeLiteral", @@ -12711,11 +12714,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "expired" } - ], - "oasRef": "#/components/schemas/RunObject/properties/status" + ] }, - "oasRef": "#/components/schemas/RunObject/properties/status", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -12732,33 +12734,33 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) thread_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the [thread](/docs/api-reference/threads) that was executed on as a part of this run.", + "oasRef": "#/components/schemas/RunObject/properties/thread_id", + "deprecated": false, "key": "thread_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the [thread](/docs/api-reference/threads) that was executed on as a part of this run.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunObject/properties/thread_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) tool_choice": { "kind": "HttpDeclProperty", - "docstring": "Controls which (if any) tool is called by the model.\n`none` means the model will not call any tools and instead generates a message.\n`auto` is the default value and means the model can pick between generating a message or calling one or more tools.\n`required` means the model must call one or more tools before responding to the user.\nSpecifying a particular tool like `{\"type\": \"file_search\"}` or `{\"type\": \"function\", \"function\": {\"name\": \"my_function\"}}` forces the model to call that tool.\n", + "oasRef": "#/components/schemas/RunObject/properties/tool_choice", + "deprecated": false, "key": "tool_choice", - "optional": false, - "nullable": true, + "docstring": "Controls which (if any) tool is called by the model.\n`none` means the model will not call any tools and instead generates a message.\n`auto` is the default value and means the model can pick between generating a message or calling one or more tools.\n`required` means the model must call one or more tools before responding to the user.\nSpecifying a particular tool like `{\"type\": \"file_search\"}` or `{\"type\": \"function\", \"function\": {\"name\": \"my_function\"}}` forces the model to call that tool.\n", "type": { "kind": "HttpTypeReference", "ident": "AssistantToolChoiceOption", "$ref": "(resource) beta.threads > (model) assistant_tool_choice_option > (schema)" }, - "oasRef": "#/components/schemas/RunObject/properties/tool_choice", - "deprecated": false, - "schemaType": "union", + "optional": false, + "nullable": true, "modelImplicit": false, + "schemaType": "union", "modelPath": "(resource) beta.threads > (model) assistant_tool_choice_option", "childrenParentSchema": "union", "children": [ @@ -12768,15 +12770,16 @@ 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](/docs/api-reference/assistants) used for this run.", + "oasRef": "#/components/schemas/RunObject/properties/tools", + "deprecated": false, "key": "tools", - "optional": false, - "nullable": false, - "default": [], + "docstring": "The list of tools that the [assistant](/docs/api-reference/assistants) used for this run.", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RunObject/properties/tools", "elementType": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunObject/properties/tools/items", "types": [ { "kind": "HttpTypeReference", @@ -12793,13 +12796,12 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "ident": "FunctionTool", "$ref": "(resource) beta.assistants > (model) function_tool > (schema)" } - ], - "oasRef": "#/components/schemas/RunObject/properties/tools/items" - }, - "oasRef": "#/components/schemas/RunObject/properties/tools" + ] + } }, - "oasRef": "#/components/schemas/RunObject/properties/tools", - "deprecated": false, + "default": [], + "optional": false, + "nullable": false, "schemaType": "array", "childrenParentSchema": "union", "children": [ @@ -12810,11 +12812,11 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy": { "kind": "HttpDeclProperty", - "title": "Thread Truncation Controls", - "docstring": "Controls for how a thread will be truncated prior to the run. Use this to control the initial context window of the run.", + "oasRef": "#/components/schemas/RunObject/properties/truncation_strategy", + "deprecated": false, "key": "truncation_strategy", - "optional": false, - "nullable": true, + "docstring": "Controls for how a thread will be truncated prior to the run. Use this to control the initial context window of the run.", + "title": "Thread Truncation Controls", "type": { "kind": "HttpTypeObject", "members": [ @@ -12826,8 +12828,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunObject/properties/truncation_strategy", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -12837,10 +12839,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) usage": { "kind": "HttpDeclProperty", - "docstring": "Usage statistics related to the run. This value will be `null` if the run is not in a terminal state (i.e. `in_progress`, `queued`, etc.).", + "oasRef": "#/components/schemas/RunObject/properties/usage", + "deprecated": false, "key": "usage", - "optional": false, - "nullable": true, + "docstring": "Usage statistics related to the run. This value will be `null` if the run is not in a terminal state (i.e. `in_progress`, `queued`, etc.).", "type": { "kind": "HttpTypeObject", "members": [ @@ -12855,8 +12857,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunObject/properties/usage", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -12867,35 +12869,36 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) temperature": { "kind": "HttpDeclProperty", - "docstring": "The sampling temperature used for this run. If not set, defaults to 1.", + "oasRef": "#/components/schemas/RunObject/properties/temperature", + "deprecated": false, "key": "temperature", - "optional": true, - "nullable": true, + "docstring": "The sampling temperature used for this run. If not set, defaults to 1.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RunObject/properties/temperature", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "number", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) top_p": { "kind": "HttpDeclProperty", - "docstring": "The nucleus sampling value used for this run. If not set, defaults to 1.", + "oasRef": "#/components/schemas/RunObject/properties/top_p", + "deprecated": false, "key": "top_p", - "optional": true, - "nullable": true, + "docstring": "The nucleus sampling value used for this run. If not set, defaults to 1.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RunObject/properties/top_p", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "number", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RunObject", + "docstring": "Represents an execution run on a [thread](/docs/api-reference/threads).", "ident": "Run", "type": { "kind": "HttpTypeObject", @@ -12983,7 +12986,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Represents an execution run on a [thread](/docs/api-reference/threads).", "childrenParentSchema": "object", "children": [ "(resource) beta.threads.runs > (model) run > (schema) > (property) id", @@ -13024,12 +13026,13 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) incomplete_details > (property) reason": { "kind": "HttpDeclProperty", - "docstring": "The reason why the run is incomplete. This will point to which specific token limit was reached over the course of the run.", + "oasRef": "#/components/schemas/RunObject/properties/incomplete_details/properties/reason", + "deprecated": false, "key": "reason", - "optional": true, - "nullable": false, + "docstring": "The reason why the run is incomplete. This will point to which specific token limit was reached over the course of the run.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunObject/properties/incomplete_details/properties/reason", "types": [ { "kind": "HttpTypeLiteral", @@ -13039,11 +13042,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "max_prompt_tokens" } - ], - "oasRef": "#/components/schemas/RunObject/properties/incomplete_details/properties/reason" + ] }, - "oasRef": "#/components/schemas/RunObject/properties/incomplete_details/properties/reason", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -13053,12 +13055,13 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) code": { "kind": "HttpDeclProperty", - "docstring": "One of `server_error`, `rate_limit_exceeded`, or `invalid_prompt`.", + "oasRef": "#/components/schemas/RunObject/properties/last_error/properties/code", + "deprecated": false, "key": "code", - "optional": false, - "nullable": false, + "docstring": "One of `server_error`, `rate_limit_exceeded`, or `invalid_prompt`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunObject/properties/last_error/properties/code", "types": [ { "kind": "HttpTypeLiteral", @@ -13072,11 +13075,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "invalid_prompt" } - ], - "oasRef": "#/components/schemas/RunObject/properties/last_error/properties/code" + ] }, - "oasRef": "#/components/schemas/RunObject/properties/last_error/properties/code", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -13087,24 +13089,26 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) message": { "kind": "HttpDeclProperty", - "docstring": "A human-readable description of the error.", + "oasRef": "#/components/schemas/RunObject/properties/last_error/properties/message", + "deprecated": false, "key": "message", - "optional": false, - "nullable": false, + "docstring": "A human-readable description of the error.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunObject/properties/last_error/properties/message", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) $shared > (model) metadata > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/Metadata", + "docstring": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.\n", "ident": "Metadata", "type": { "kind": "HttpTypeReference", + "oasRef": "#/components/schemas/Metadata", "ident": "Record", "typeParameters": [ { @@ -13113,10 +13117,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch { "kind": "HttpTypeString" } - ], - "oasRef": "#/components/schemas/Metadata" + ] }, - "docstring": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.\n", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) object > (member) 0": { @@ -13128,10 +13130,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) required_action > (property) submit_tool_outputs": { "kind": "HttpDeclProperty", - "docstring": "Details on the tool outputs needed for this run to continue.", + "oasRef": "#/components/schemas/RunObject/properties/required_action/properties/submit_tool_outputs", + "deprecated": false, "key": "submit_tool_outputs", - "optional": false, - "nullable": false, + "docstring": "Details on the tool outputs needed for this run to continue.", "type": { "kind": "HttpTypeObject", "members": [ @@ -13140,8 +13142,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunObject/properties/required_action/properties/submit_tool_outputs", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -13150,22 +13152,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) required_action > (property) type": { "kind": "HttpDeclProperty", - "docstring": "For now, this is always `submit_tool_outputs`.", + "oasRef": "#/components/schemas/RunObject/properties/required_action/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "For now, this is always `submit_tool_outputs`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunObject/properties/required_action/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "submit_tool_outputs" } - ], - "oasRef": "#/components/schemas/RunObject/properties/required_action/properties/type" + ] }, - "oasRef": "#/components/schemas/RunObject/properties/required_action/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -13175,18 +13177,18 @@ 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/oneOf/0", + "docstring": "`auto` is the default value\n", "ident": "UnionMember0", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/oneOf/0", "types": [ { "kind": "HttpTypeLiteral", "literal": "auto" } - ], - "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/oneOf/0" + ] }, - "docstring": "`auto` is the default value\n", "childrenParentSchema": "enum", "children": [ "(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 0 > (member) 0" @@ -13232,19 +13234,21 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads > (model) assistant_response_format_option > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption", + "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", "ident": "AssistantResponseFormatOption", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption", "types": [ { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/oneOf/0", "types": [ { "kind": "HttpTypeLiteral", "literal": "auto" } - ], - "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/oneOf/0" + ] }, { "kind": "HttpTypeReference", @@ -13261,10 +13265,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "ident": "ResponseFormatJSONSchema", "$ref": "(resource) $shared > (model) response_format_json_schema > (schema)" } - ], - "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption" + ] }, - "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", @@ -13339,9 +13341,11 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0": { "kind": "HttpDeclTypeAlias", "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", "ident": "UnionMember0", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption/oneOf/0", "types": [ { "kind": "HttpTypeLiteral", @@ -13355,10 +13359,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "required" } - ], - "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", "children": [ "(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0 > (member) 0", @@ -13382,12 +13384,15 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads > (model) assistant_tool_choice_option > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption", + "docstring": "Controls which (if any) tool is called by the model.\n`none` means the model will not call any tools and instead generates a message.\n`auto` is the default value and means the model can pick between generating a message or calling one or more tools.\n`required` means the model must call one or more tools before responding to the user.\nSpecifying a particular tool like `{\"type\": \"file_search\"}` or `{\"type\": \"function\", \"function\": {\"name\": \"my_function\"}}` forces the model to call that tool.\n", "ident": "AssistantToolChoiceOption", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption", "types": [ { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption/oneOf/0", "types": [ { "kind": "HttpTypeLiteral", @@ -13401,18 +13406,15 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "required" } - ], - "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption/oneOf/0" + ] }, { "kind": "HttpTypeReference", "ident": "AssistantToolChoice", "$ref": "(resource) beta.threads > (model) assistant_tool_choice > (schema)" } - ], - "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption" + ] }, - "docstring": "Controls which (if any) tool is called by the model.\n`none` means the model will not call any tools and instead generates a message.\n`auto` is the default value and means the model can pick between generating a message or calling one or more tools.\n`required` means the model must call one or more tools before responding to the user.\nSpecifying a particular tool like `{\"type\": \"file_search\"}` or `{\"type\": \"function\", \"function\": {\"name\": \"my_function\"}}` forces the model to call that tool.\n", "childrenParentSchema": "union", "children": [ "(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0", @@ -13518,12 +13520,13 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The truncation strategy to use for the thread. The default is `auto`. If set to `last_messages`, the thread will be truncated to the n most recent messages in the thread. When set to `auto`, messages in the middle of the thread will be dropped to fit the context length of the model, `max_prompt_tokens`.", + "oasRef": "#/components/schemas/TruncationObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The truncation strategy to use for the thread. The default is `auto`. If set to `last_messages`, the thread will be truncated to the n most recent messages in the thread. When set to `auto`, messages in the middle of the thread will be dropped to fit the context length of the model, `max_prompt_tokens`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/TruncationObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", @@ -13533,11 +13536,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "last_messages" } - ], - "oasRef": "#/components/schemas/TruncationObject/properties/type" + ] }, - "oasRef": "#/components/schemas/TruncationObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -13547,60 +13549,60 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) last_messages": { "kind": "HttpDeclProperty", - "docstring": "The number of most recent messages from the thread when constructing the context for the run.", + "oasRef": "#/components/schemas/TruncationObject/properties/last_messages", + "deprecated": false, "key": "last_messages", - "optional": true, - "nullable": true, + "docstring": "The number of most recent messages from the thread when constructing the context for the run.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "minimum": 1 }, - "oasRef": "#/components/schemas/TruncationObject/properties/last_messages", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) usage > (property) completion_tokens": { "kind": "HttpDeclProperty", - "docstring": "Number of completion tokens used over the course of the run.", + "oasRef": "#/components/schemas/RunCompletionUsage/anyOf/0/properties/completion_tokens", + "deprecated": false, "key": "completion_tokens", - "optional": false, - "nullable": false, + "docstring": "Number of completion tokens used over the course of the run.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RunCompletionUsage/anyOf/0/properties/completion_tokens", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) usage > (property) prompt_tokens": { "kind": "HttpDeclProperty", - "docstring": "Number of prompt tokens used over the course of the run.", + "oasRef": "#/components/schemas/RunCompletionUsage/anyOf/0/properties/prompt_tokens", + "deprecated": false, "key": "prompt_tokens", - "optional": false, - "nullable": false, + "docstring": "Number of prompt tokens used over the course of the run.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RunCompletionUsage/anyOf/0/properties/prompt_tokens", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) usage > (property) total_tokens": { "kind": "HttpDeclProperty", - "docstring": "Total number of tokens used (prompt + completion).", + "oasRef": "#/components/schemas/RunCompletionUsage/anyOf/0/properties/total_tokens", + "deprecated": false, "key": "total_tokens", - "optional": false, - "nullable": false, + "docstring": "Total number of tokens used (prompt + completion).", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RunCompletionUsage/anyOf/0/properties/total_tokens", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, @@ -13641,21 +13643,21 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) required_action > (property) submit_tool_outputs > (property) tool_calls": { "kind": "HttpDeclProperty", - "docstring": "A list of the relevant tool calls.", + "oasRef": "#/components/schemas/RunObject/properties/required_action/properties/submit_tool_outputs/properties/tool_calls", + "deprecated": false, "key": "tool_calls", - "optional": false, - "nullable": false, + "docstring": "A list of the relevant tool calls.", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RunObject/properties/required_action/properties/submit_tool_outputs/properties/tool_calls", "elementType": { "kind": "HttpTypeReference", "ident": "RequiredActionFunctionToolCall", "$ref": "(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema)" + } }, - "oasRef": "#/components/schemas/RunObject/properties/required_action/properties/submit_tool_outputs/properties/tool_calls" - }, - "oasRef": "#/components/schemas/RunObject/properties/required_action/properties/submit_tool_outputs/properties/tool_calls", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "array", "childrenParentSchema": "object", "children": [ @@ -13680,22 +13682,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) $shared > (model) response_format_text > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of response format being defined. Always `text`.", + "oasRef": "#/components/schemas/ResponseFormatText/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of response format being defined. Always `text`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/ResponseFormatText/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "text" } - ], - "oasRef": "#/components/schemas/ResponseFormatText/properties/type" + ] }, - "oasRef": "#/components/schemas/ResponseFormatText/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -13705,6 +13707,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) $shared > (model) response_format_text > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/ResponseFormatText", + "docstring": "Default response format. Used to generate text responses.\n", "ident": "ResponseFormatText", "type": { "kind": "HttpTypeObject", @@ -13714,7 +13717,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Default response format. Used to generate text responses.\n", "childrenParentSchema": "object", "children": [ "(resource) $shared > (model) response_format_text > (schema) > (property) type" @@ -13722,22 +13724,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) $shared > (model) response_format_json_object > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of response format being defined. Always `json_object`.", + "oasRef": "#/components/schemas/ResponseFormatJsonObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of response format being defined. Always `json_object`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/ResponseFormatJsonObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "json_object" } - ], - "oasRef": "#/components/schemas/ResponseFormatJsonObject/properties/type" + ] }, - "oasRef": "#/components/schemas/ResponseFormatJsonObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -13747,6 +13749,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) $shared > (model) response_format_json_object > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/ResponseFormatJsonObject", + "docstring": "JSON object response format. An older method of generating JSON responses.\nUsing `json_schema` is recommended for models that support it. Note that the\nmodel will not generate JSON without a system or user message instructing it\nto do so.\n", "ident": "ResponseFormatJSONObject", "type": { "kind": "HttpTypeObject", @@ -13756,7 +13759,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "JSON object response format. An older method of generating JSON responses.\nUsing `json_schema` is recommended for models that support it. Note that the\nmodel will not generate JSON without a system or user message instructing it\nto do so.\n", "childrenParentSchema": "object", "children": [ "(resource) $shared > (model) response_format_json_object > (schema) > (property) type" @@ -13764,11 +13766,11 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema": { "kind": "HttpDeclProperty", - "title": "JSON schema", - "docstring": "Structured Outputs configuration options, including a JSON Schema.\n", + "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema", + "deprecated": false, "key": "json_schema", - "optional": false, - "nullable": false, + "docstring": "Structured Outputs configuration options, including a JSON Schema.\n", + "title": "JSON schema", "type": { "kind": "HttpTypeObject", "members": [ @@ -13786,8 +13788,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -13799,22 +13801,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) $shared > (model) response_format_json_schema > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of response format being defined. Always `json_schema`.", + "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of response format being defined. Always `json_schema`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "json_schema" } - ], - "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/type" + ] }, - "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -13824,6 +13826,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) $shared > (model) response_format_json_schema > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/ResponseFormatJsonSchema", + "docstring": "JSON Schema response format. Used to generate structured JSON responses.\nLearn more about [Structured Outputs](/docs/guides/structured-outputs).\n", "ident": "ResponseFormatJSONSchema", "type": { "kind": "HttpTypeObject", @@ -13836,7 +13839,6 @@ 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](/docs/guides/structured-outputs).\n", "childrenParentSchema": "object", "children": [ "(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema", @@ -13866,12 +13868,13 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the tool. If type is `function`, the function name must be set", + "oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the tool. If type is `function`, the function name must be set", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/type", "types": [ { "kind": "HttpTypeLiteral", @@ -13885,11 +13888,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "file_search" } - ], - "oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/type" + ] }, - "oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -13900,18 +13902,18 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) function": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/function", + "deprecated": false, "key": "function", - "optional": true, - "nullable": false, "type": { "kind": "HttpTypeReference", "ident": "AssistantToolChoiceFunction", "$ref": "(resource) beta.threads > (model) assistant_tool_choice_function > (schema)" }, - "oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/function", - "deprecated": false, - "schemaType": "object", + "optional": true, + "nullable": false, "modelImplicit": false, + "schemaType": "object", "modelPath": "(resource) beta.threads > (model) assistant_tool_choice_function", "childrenParentSchema": "object", "children": [ @@ -13921,6 +13923,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads > (model) assistant_tool_choice > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/AssistantsNamedToolChoice", + "docstring": "Specifies a tool the model should use. Use to force the model to call a specific tool.", "ident": "AssistantToolChoice", "type": { "kind": "HttpTypeObject", @@ -13933,7 +13936,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Specifies a tool the model should use. Use to force the model to call a specific tool.", "childrenParentSchema": "object", "children": [ "(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) type", @@ -13942,22 +13944,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of tool being defined: `code_interpreter`", + "oasRef": "#/components/schemas/AssistantToolsCode/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of tool being defined: `code_interpreter`", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantToolsCode/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "code_interpreter" } - ], - "oasRef": "#/components/schemas/AssistantToolsCode/properties/type" + ] }, - "oasRef": "#/components/schemas/AssistantToolsCode/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -13966,22 +13968,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of tool being defined: `file_search`", + "oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of tool being defined: `file_search`", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "file_search" } - ], - "oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/type" + ] }, - "oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -13990,10 +13992,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search": { "kind": "HttpDeclProperty", - "docstring": "Overrides for the file search tool.", + "oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/file_search", + "deprecated": false, "key": "file_search", - "optional": true, - "nullable": false, + "docstring": "Overrides for the file search tool.", "type": { "kind": "HttpTypeObject", "members": [ @@ -14005,8 +14007,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/file_search", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -14016,18 +14018,18 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) function_tool > (schema) > (property) function": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/AssistantToolsFunction/properties/function", + "deprecated": false, "key": "function", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeReference", "ident": "FunctionDefinition", "$ref": "(resource) $shared > (model) function_definition > (schema)" }, - "oasRef": "#/components/schemas/AssistantToolsFunction/properties/function", - "deprecated": false, - "schemaType": "object", + "optional": false, + "nullable": false, "modelImplicit": false, + "schemaType": "object", "modelPath": "(resource) $shared > (model) function_definition", "childrenParentSchema": "object", "children": [ @@ -14039,22 +14041,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) function_tool > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of tool being defined: `function`", + "oasRef": "#/components/schemas/AssistantToolsFunction/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of tool being defined: `function`", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantToolsFunction/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "function" } - ], - "oasRef": "#/components/schemas/AssistantToolsFunction/properties/type" + ] }, - "oasRef": "#/components/schemas/AssistantToolsFunction/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -14077,24 +14079,24 @@ 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](/docs/api-reference/runs/submitToolOutputs) endpoint.", + "oasRef": "#/components/schemas/RunToolCallObject/properties/id", + "deprecated": false, "key": "id", - "optional": false, - "nullable": false, + "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.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunToolCallObject/properties/id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) function": { "kind": "HttpDeclProperty", - "docstring": "The function definition.", + "oasRef": "#/components/schemas/RunToolCallObject/properties/function", + "deprecated": false, "key": "function", - "optional": false, - "nullable": false, + "docstring": "The function definition.", "type": { "kind": "HttpTypeObject", "members": [ @@ -14106,8 +14108,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunToolCallObject/properties/function", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -14117,22 +14119,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of tool call the output is required for. For now, this is always `function`.", + "oasRef": "#/components/schemas/RunToolCallObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of tool call the output is required for. For now, this is always `function`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunToolCallObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "function" } - ], - "oasRef": "#/components/schemas/RunToolCallObject/properties/type" + ] }, - "oasRef": "#/components/schemas/RunToolCallObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -14142,6 +14144,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RunToolCallObject", + "docstring": "Tool call objects", "ident": "RequiredActionFunctionToolCall", "type": { "kind": "HttpTypeObject", @@ -14157,7 +14160,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Tool call objects", "childrenParentSchema": "object", "children": [ "(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) id", @@ -14181,41 +14183,42 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the response format. Must be a-z, A-Z, 0-9, or contain\nunderscores and dashes, with a maximum length of 64.\n", + "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/name", + "deprecated": false, "key": "name", - "optional": false, - "nullable": false, + "docstring": "The name of the response format. Must be a-z, A-Z, 0-9, or contain\nunderscores and dashes, with a maximum length of 64.\n", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/name", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema > (property) description": { "kind": "HttpDeclProperty", - "docstring": "A description of what the response format is for, used by the model to\ndetermine how to respond in the format.\n", + "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/description", + "deprecated": false, "key": "description", - "optional": true, - "nullable": false, + "docstring": "A description of what the response format is for, used by the model to\ndetermine how to respond in the format.\n", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/description", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema > (property) schema": { "kind": "HttpDeclProperty", - "title": "JSON schema", - "docstring": "The schema for the response format, described as a JSON Schema object.\nLearn how to build JSON schemas [here](https://json-schema.org/).\n", + "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/schema", + "deprecated": false, "key": "schema", - "optional": true, - "nullable": false, + "docstring": "The schema for the response format, described as a JSON Schema object.\nLearn how to build JSON schemas [here](https://json-schema.org/).\n", + "title": "JSON schema", "type": { "kind": "HttpTypeReference", + "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/schema", "ident": "Record", "typeParameters": [ { @@ -14224,26 +14227,25 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch { "kind": "HttpTypeUnknown" } - ], - "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/schema" + ] }, - "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/schema", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "map", "children": [] }, "(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](/docs/guides/structured-outputs).\n", + "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/strict", + "deprecated": false, "key": "strict", - "optional": true, - "nullable": true, - "default": false, + "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", "type": { "kind": "HttpTypeBoolean" }, - "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/strict", - "deprecated": false, + "default": false, + "optional": true, + "nullable": true, "schemaType": "boolean", "children": [] }, @@ -14277,15 +14279,15 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads > (model) assistant_tool_choice_function > (schema) > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the function to call.", + "oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/function/properties/name", + "deprecated": false, "key": "name", - "optional": false, - "nullable": false, + "docstring": "The name of the function to call.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/function/properties/name", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, @@ -14322,10 +14324,10 @@ 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](/docs/assistants/tools/file-search#customizing-file-search-settings) for more information.\n", + "oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/file_search/properties/max_num_results", + "deprecated": false, "key": "max_num_results", - "optional": true, - "nullable": false, + "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", "type": { "kind": "HttpTypeNumber" }, @@ -14333,18 +14335,18 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "minimum": 1, "maximum": 50 }, - "oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/file_search/properties/max_num_results", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "integer", "children": [] }, "(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](/docs/assistants/tools/file-search#customizing-file-search-settings) for more information.\n", + "oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/file_search/properties/ranking_options", + "deprecated": false, "key": "ranking_options", - "optional": true, - "nullable": false, + "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", + "title": "File search tool call ranking options", "type": { "kind": "HttpTypeObject", "members": [ @@ -14356,8 +14358,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/file_search/properties/ranking_options", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -14367,62 +14369,62 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) $shared > (model) function_definition > (schema) > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.", + "oasRef": "#/components/schemas/FunctionObject/properties/name", + "deprecated": false, "key": "name", - "optional": false, - "nullable": false, + "docstring": "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/FunctionObject/properties/name", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) $shared > (model) function_definition > (schema) > (property) description": { "kind": "HttpDeclProperty", - "docstring": "A description of what the function does, used by the model to choose when and how to call the function.", + "oasRef": "#/components/schemas/FunctionObject/properties/description", + "deprecated": false, "key": "description", - "optional": true, - "nullable": false, + "docstring": "A description of what the function does, used by the model to choose when and how to call the function.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/FunctionObject/properties/description", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(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](/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.", + "oasRef": "#/components/schemas/FunctionObject/properties/parameters", + "deprecated": false, "key": "parameters", - "optional": true, - "nullable": false, + "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.", "type": { "kind": "HttpTypeReference", "ident": "FunctionParameters", "$ref": "(resource) $shared > (model) function_parameters > (schema)" }, - "oasRef": "#/components/schemas/FunctionObject/properties/parameters", - "deprecated": false, - "schemaType": "map", + "optional": true, + "nullable": false, "modelImplicit": false, + "schemaType": "map", "modelPath": "(resource) $shared > (model) function_parameters", "children": [] }, "(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](/docs/guides/function-calling).", + "oasRef": "#/components/schemas/FunctionObject/properties/strict", + "deprecated": false, "key": "strict", - "optional": true, - "nullable": true, - "default": false, + "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).", "type": { "kind": "HttpTypeBoolean" }, - "oasRef": "#/components/schemas/FunctionObject/properties/strict", - "deprecated": false, + "default": false, + "optional": true, + "nullable": true, "schemaType": "boolean", "children": [] }, @@ -14464,29 +14466,29 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) function > (property) arguments": { "kind": "HttpDeclProperty", - "docstring": "The arguments that the model expects you to pass to the function.", + "oasRef": "#/components/schemas/RunToolCallObject/properties/function/properties/arguments", + "deprecated": false, "key": "arguments", - "optional": false, - "nullable": false, + "docstring": "The arguments that the model expects you to pass to the function.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunToolCallObject/properties/function/properties/arguments", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) function > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the function.", + "oasRef": "#/components/schemas/RunToolCallObject/properties/function/properties/name", + "deprecated": false, "key": "name", - "optional": false, - "nullable": false, + "docstring": "The name of the function.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunToolCallObject/properties/function/properties/name", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, @@ -14499,10 +14501,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options > (property) score_threshold": { "kind": "HttpDeclProperty", - "docstring": "The score threshold for the file search. All values must be a floating point number between 0 and 1.", + "oasRef": "#/components/schemas/FileSearchRankingOptions/properties/score_threshold", + "deprecated": false, "key": "score_threshold", - "optional": false, - "nullable": false, + "docstring": "The score threshold for the file search. All values must be a floating point number between 0 and 1.", "type": { "kind": "HttpTypeNumber" }, @@ -14510,19 +14512,20 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "minimum": 0, "maximum": 1 }, - "oasRef": "#/components/schemas/FileSearchRankingOptions/properties/score_threshold", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "number", "children": [] }, "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options > (property) ranker": { "kind": "HttpDeclProperty", - "docstring": "The ranker to use for the file search. If not specified will use the `auto` ranker.", + "oasRef": "#/components/schemas/FileSearchRankingOptions/properties/ranker", + "deprecated": false, "key": "ranker", - "optional": true, - "nullable": false, + "docstring": "The ranker to use for the file search. If not specified will use the `auto` ranker.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/FileSearchRankingOptions/properties/ranker", "types": [ { "kind": "HttpTypeLiteral", @@ -14532,11 +14535,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "default_2024_08_21" } - ], - "oasRef": "#/components/schemas/FileSearchRankingOptions/properties/ranker" + ] }, - "oasRef": "#/components/schemas/FileSearchRankingOptions/properties/ranker", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -14547,9 +14549,11 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) $shared > (model) function_parameters > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/FunctionParameters", + "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.", "ident": "FunctionParameters", "type": { "kind": "HttpTypeReference", + "oasRef": "#/components/schemas/FunctionParameters", "ident": "Record", "typeParameters": [ { @@ -14558,10 +14562,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch { "kind": "HttpTypeUnknown" } - ], - "oasRef": "#/components/schemas/FunctionParameters" + ] }, - "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": { @@ -14600,7 +14602,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/oneOf/6", - "ident": "UnionMember7", + "docstring": "Occurs when a [run](/docs/api-reference/runs/object) fails.", + "ident": "ThreadRunFailed", "type": { "kind": "HttpTypeObject", "members": [ @@ -14612,7 +14615,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "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", @@ -14621,20 +14623,20 @@ 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](/docs/api-reference/threads).", + "oasRef": "#/components/schemas/RunStreamEvent/oneOf/6/properties/data", + "deprecated": false, "key": "data", - "optional": false, - "nullable": false, + "docstring": "Represents an execution run on a [thread](/docs/api-reference/threads).", + "title": "A run on a thread", "type": { "kind": "HttpTypeReference", "ident": "Run", "$ref": "(resource) beta.threads.runs > (model) run > (schema)" }, - "oasRef": "#/components/schemas/RunStreamEvent/oneOf/6/properties/data", - "deprecated": false, - "schemaType": "object", + "optional": false, + "nullable": false, "modelImplicit": false, + "schemaType": "object", "modelPath": "(resource) beta.threads.runs > (model) run", "childrenParentSchema": "object", "children": [ @@ -14669,21 +14671,21 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 7 > (property) event": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RunStreamEvent/oneOf/6/properties/event", + "deprecated": false, "key": "event", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStreamEvent/oneOf/6/properties/event", "types": [ { "kind": "HttpTypeLiteral", "literal": "thread.run.failed" } - ], - "oasRef": "#/components/schemas/RunStreamEvent/oneOf/6/properties/event" + ] }, - "oasRef": "#/components/schemas/RunStreamEvent/oneOf/6/properties/event", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -14692,123 +14694,123 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The identifier, which can be referenced in API endpoints.", + "oasRef": "#/components/schemas/RunObject/properties/id", + "deprecated": false, "key": "id", - "optional": false, - "nullable": false, + "docstring": "The identifier, which can be referenced in API endpoints.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunObject/properties/id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) assistant_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the [assistant](/docs/api-reference/assistants) used for execution of this run.", + "oasRef": "#/components/schemas/RunObject/properties/assistant_id", + "deprecated": false, "key": "assistant_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the [assistant](/docs/api-reference/assistants) used for execution of this run.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunObject/properties/assistant_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) cancelled_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the run was cancelled.", + "oasRef": "#/components/schemas/RunObject/properties/cancelled_at", + "deprecated": false, "key": "cancelled_at", - "optional": false, - "nullable": true, + "docstring": "The Unix timestamp (in seconds) for when the run was cancelled.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/RunObject/properties/cancelled_at", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) completed_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the run was completed.", + "oasRef": "#/components/schemas/RunObject/properties/completed_at", + "deprecated": false, "key": "completed_at", - "optional": false, - "nullable": true, + "docstring": "The Unix timestamp (in seconds) for when the run was completed.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/RunObject/properties/completed_at", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) created_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the run was created.", + "oasRef": "#/components/schemas/RunObject/properties/created_at", + "deprecated": false, "key": "created_at", - "optional": false, - "nullable": false, + "docstring": "The Unix timestamp (in seconds) for when the run was created.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/RunObject/properties/created_at", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) expires_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the run will expire.", + "oasRef": "#/components/schemas/RunObject/properties/expires_at", + "deprecated": false, "key": "expires_at", - "optional": false, - "nullable": true, + "docstring": "The Unix timestamp (in seconds) for when the run will expire.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/RunObject/properties/expires_at", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) failed_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the run failed.", + "oasRef": "#/components/schemas/RunObject/properties/failed_at", + "deprecated": false, "key": "failed_at", - "optional": false, - "nullable": true, + "docstring": "The Unix timestamp (in seconds) for when the run failed.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/RunObject/properties/failed_at", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) incomplete_details": { "kind": "HttpDeclProperty", - "docstring": "Details on why the run is incomplete. Will be `null` if the run is not incomplete.", + "oasRef": "#/components/schemas/RunObject/properties/incomplete_details", + "deprecated": false, "key": "incomplete_details", - "optional": false, - "nullable": true, + "docstring": "Details on why the run is incomplete. Will be `null` if the run is not incomplete.", "type": { "kind": "HttpTypeObject", "members": [ @@ -14817,8 +14819,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunObject/properties/incomplete_details", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -14827,24 +14829,24 @@ 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](/docs/api-reference/assistants) used for this run.", + "oasRef": "#/components/schemas/RunObject/properties/instructions", + "deprecated": false, "key": "instructions", - "optional": false, - "nullable": false, + "docstring": "The instructions that the [assistant](/docs/api-reference/assistants) used for this run.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunObject/properties/instructions", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) last_error": { "kind": "HttpDeclProperty", - "docstring": "The last error associated with this run. Will be `null` if there are no errors.", + "oasRef": "#/components/schemas/RunObject/properties/last_error", + "deprecated": false, "key": "last_error", - "optional": false, - "nullable": true, + "docstring": "The last error associated with this run. Will be `null` if there are no errors.", "type": { "kind": "HttpTypeObject", "members": [ @@ -14856,8 +14858,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunObject/properties/last_error", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -14867,88 +14869,88 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) max_completion_tokens": { "kind": "HttpDeclProperty", - "docstring": "The maximum number of completion tokens specified to have been used over the course of the run.\n", + "oasRef": "#/components/schemas/RunObject/properties/max_completion_tokens", + "deprecated": false, "key": "max_completion_tokens", - "optional": false, - "nullable": true, + "docstring": "The maximum number of completion tokens specified to have been used over the course of the run.\n", "type": { "kind": "HttpTypeNumber" }, "constraints": { "minimum": 256 }, - "oasRef": "#/components/schemas/RunObject/properties/max_completion_tokens", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) max_prompt_tokens": { "kind": "HttpDeclProperty", - "docstring": "The maximum number of prompt tokens specified to have been used over the course of the run.\n", + "oasRef": "#/components/schemas/RunObject/properties/max_prompt_tokens", + "deprecated": false, "key": "max_prompt_tokens", - "optional": false, - "nullable": true, + "docstring": "The maximum number of prompt tokens specified to have been used over the course of the run.\n", "type": { "kind": "HttpTypeNumber" }, "constraints": { "minimum": 256 }, - "oasRef": "#/components/schemas/RunObject/properties/max_prompt_tokens", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) metadata": { "kind": "HttpDeclProperty", - "docstring": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.\n", + "oasRef": "#/components/schemas/RunObject/properties/metadata", + "deprecated": false, "key": "metadata", - "optional": false, - "nullable": true, + "docstring": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.\n", "type": { "kind": "HttpTypeReference", "ident": "Metadata", "$ref": "(resource) $shared > (model) metadata > (schema)" }, - "oasRef": "#/components/schemas/RunObject/properties/metadata", - "deprecated": false, - "schemaType": "map", + "optional": false, + "nullable": true, "modelImplicit": false, + "schemaType": "map", "modelPath": "(resource) $shared > (model) metadata", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) model": { "kind": "HttpDeclProperty", - "docstring": "The model that the [assistant](/docs/api-reference/assistants) used for this run.", + "oasRef": "#/components/schemas/RunObject/properties/model", + "deprecated": false, "key": "model", - "optional": false, - "nullable": false, + "docstring": "The model that the [assistant](/docs/api-reference/assistants) used for this run.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunObject/properties/model", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) object": { "kind": "HttpDeclProperty", - "docstring": "The object type, which is always `thread.run`.", + "oasRef": "#/components/schemas/RunObject/properties/object", + "deprecated": false, "key": "object", - "optional": false, - "nullable": false, + "docstring": "The object type, which is always `thread.run`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunObject/properties/object", "types": [ { "kind": "HttpTypeLiteral", "literal": "thread.run" } - ], - "oasRef": "#/components/schemas/RunObject/properties/object" + ] }, - "oasRef": "#/components/schemas/RunObject/properties/object", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -14957,25 +14959,25 @@ 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](/docs/guides/function-calling#configuring-parallel-function-calling) during tool use.", + "oasRef": "#/components/schemas/RunObject/properties/parallel_tool_calls", + "deprecated": false, "key": "parallel_tool_calls", - "optional": false, - "nullable": false, - "default": true, + "docstring": "Whether to enable [parallel function calling](/docs/guides/function-calling#configuring-parallel-function-calling) during tool use.", "type": { "kind": "HttpTypeBoolean" }, - "oasRef": "#/components/schemas/RunObject/properties/parallel_tool_calls", - "deprecated": false, + "default": true, + "optional": false, + "nullable": false, "schemaType": "boolean", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) required_action": { "kind": "HttpDeclProperty", - "docstring": "Details on the action required to continue the run. Will be `null` if no action is required.", + "oasRef": "#/components/schemas/RunObject/properties/required_action", + "deprecated": false, "key": "required_action", - "optional": false, - "nullable": true, + "docstring": "Details on the action required to continue the run. Will be `null` if no action is required.", "type": { "kind": "HttpTypeObject", "members": [ @@ -14987,8 +14989,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunObject/properties/required_action", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -14998,19 +15000,19 @@ 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](/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", + "oasRef": "#/components/schemas/RunObject/properties/response_format", + "deprecated": false, "key": "response_format", - "optional": false, - "nullable": true, + "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", "type": { "kind": "HttpTypeReference", "ident": "AssistantResponseFormatOption", "$ref": "(resource) beta.threads > (model) assistant_response_format_option > (schema)" }, - "oasRef": "#/components/schemas/RunObject/properties/response_format", - "deprecated": false, - "schemaType": "union", + "optional": false, + "nullable": true, "modelImplicit": false, + "schemaType": "union", "modelPath": "(resource) beta.threads > (model) assistant_response_format_option", "childrenParentSchema": "union", "children": [ @@ -15022,29 +15024,30 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) started_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the run was started.", + "oasRef": "#/components/schemas/RunObject/properties/started_at", + "deprecated": false, "key": "started_at", - "optional": false, - "nullable": true, + "docstring": "The Unix timestamp (in seconds) for when the run was started.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/RunObject/properties/started_at", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) status": { "kind": "HttpDeclProperty", - "docstring": "The status of the run, which can be either `queued`, `in_progress`, `requires_action`, `cancelling`, `cancelled`, `failed`, `completed`, `incomplete`, or `expired`.", + "oasRef": "#/components/schemas/RunObject/properties/status", + "deprecated": false, "key": "status", - "optional": false, - "nullable": false, + "docstring": "The status of the run, which can be either `queued`, `in_progress`, `requires_action`, `cancelling`, `cancelled`, `failed`, `completed`, `incomplete`, or `expired`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunObject/properties/status", "types": [ { "kind": "HttpTypeLiteral", @@ -15082,11 +15085,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "expired" } - ], - "oasRef": "#/components/schemas/RunObject/properties/status" + ] }, - "oasRef": "#/components/schemas/RunObject/properties/status", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -15103,33 +15105,33 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) thread_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the [thread](/docs/api-reference/threads) that was executed on as a part of this run.", + "oasRef": "#/components/schemas/RunObject/properties/thread_id", + "deprecated": false, "key": "thread_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the [thread](/docs/api-reference/threads) that was executed on as a part of this run.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunObject/properties/thread_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) tool_choice": { "kind": "HttpDeclProperty", - "docstring": "Controls which (if any) tool is called by the model.\n`none` means the model will not call any tools and instead generates a message.\n`auto` is the default value and means the model can pick between generating a message or calling one or more tools.\n`required` means the model must call one or more tools before responding to the user.\nSpecifying a particular tool like `{\"type\": \"file_search\"}` or `{\"type\": \"function\", \"function\": {\"name\": \"my_function\"}}` forces the model to call that tool.\n", + "oasRef": "#/components/schemas/RunObject/properties/tool_choice", + "deprecated": false, "key": "tool_choice", - "optional": false, - "nullable": true, + "docstring": "Controls which (if any) tool is called by the model.\n`none` means the model will not call any tools and instead generates a message.\n`auto` is the default value and means the model can pick between generating a message or calling one or more tools.\n`required` means the model must call one or more tools before responding to the user.\nSpecifying a particular tool like `{\"type\": \"file_search\"}` or `{\"type\": \"function\", \"function\": {\"name\": \"my_function\"}}` forces the model to call that tool.\n", "type": { "kind": "HttpTypeReference", "ident": "AssistantToolChoiceOption", "$ref": "(resource) beta.threads > (model) assistant_tool_choice_option > (schema)" }, - "oasRef": "#/components/schemas/RunObject/properties/tool_choice", - "deprecated": false, - "schemaType": "union", + "optional": false, + "nullable": true, "modelImplicit": false, + "schemaType": "union", "modelPath": "(resource) beta.threads > (model) assistant_tool_choice_option", "childrenParentSchema": "union", "children": [ @@ -15139,15 +15141,16 @@ 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](/docs/api-reference/assistants) used for this run.", + "oasRef": "#/components/schemas/RunObject/properties/tools", + "deprecated": false, "key": "tools", - "optional": false, - "nullable": false, - "default": [], + "docstring": "The list of tools that the [assistant](/docs/api-reference/assistants) used for this run.", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RunObject/properties/tools", "elementType": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunObject/properties/tools/items", "types": [ { "kind": "HttpTypeReference", @@ -15164,13 +15167,12 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "ident": "FunctionTool", "$ref": "(resource) beta.assistants > (model) function_tool > (schema)" } - ], - "oasRef": "#/components/schemas/RunObject/properties/tools/items" - }, - "oasRef": "#/components/schemas/RunObject/properties/tools" + ] + } }, - "oasRef": "#/components/schemas/RunObject/properties/tools", - "deprecated": false, + "default": [], + "optional": false, + "nullable": false, "schemaType": "array", "childrenParentSchema": "union", "children": [ @@ -15181,11 +15183,11 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy": { "kind": "HttpDeclProperty", - "title": "Thread Truncation Controls", - "docstring": "Controls for how a thread will be truncated prior to the run. Use this to control the initial context window of the run.", + "oasRef": "#/components/schemas/RunObject/properties/truncation_strategy", + "deprecated": false, "key": "truncation_strategy", - "optional": false, - "nullable": true, + "docstring": "Controls for how a thread will be truncated prior to the run. Use this to control the initial context window of the run.", + "title": "Thread Truncation Controls", "type": { "kind": "HttpTypeObject", "members": [ @@ -15197,8 +15199,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunObject/properties/truncation_strategy", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -15208,10 +15210,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) usage": { "kind": "HttpDeclProperty", - "docstring": "Usage statistics related to the run. This value will be `null` if the run is not in a terminal state (i.e. `in_progress`, `queued`, etc.).", + "oasRef": "#/components/schemas/RunObject/properties/usage", + "deprecated": false, "key": "usage", - "optional": false, - "nullable": true, + "docstring": "Usage statistics related to the run. This value will be `null` if the run is not in a terminal state (i.e. `in_progress`, `queued`, etc.).", "type": { "kind": "HttpTypeObject", "members": [ @@ -15226,8 +15228,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunObject/properties/usage", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -15238,35 +15240,36 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) temperature": { "kind": "HttpDeclProperty", - "docstring": "The sampling temperature used for this run. If not set, defaults to 1.", + "oasRef": "#/components/schemas/RunObject/properties/temperature", + "deprecated": false, "key": "temperature", - "optional": true, - "nullable": true, + "docstring": "The sampling temperature used for this run. If not set, defaults to 1.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RunObject/properties/temperature", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "number", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) top_p": { "kind": "HttpDeclProperty", - "docstring": "The nucleus sampling value used for this run. If not set, defaults to 1.", + "oasRef": "#/components/schemas/RunObject/properties/top_p", + "deprecated": false, "key": "top_p", - "optional": true, - "nullable": true, + "docstring": "The nucleus sampling value used for this run. If not set, defaults to 1.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RunObject/properties/top_p", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "number", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RunObject", + "docstring": "Represents an execution run on a [thread](/docs/api-reference/threads).", "ident": "Run", "type": { "kind": "HttpTypeObject", @@ -15354,7 +15357,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Represents an execution run on a [thread](/docs/api-reference/threads).", "childrenParentSchema": "object", "children": [ "(resource) beta.threads.runs > (model) run > (schema) > (property) id", @@ -15395,12 +15397,13 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) incomplete_details > (property) reason": { "kind": "HttpDeclProperty", - "docstring": "The reason why the run is incomplete. This will point to which specific token limit was reached over the course of the run.", + "oasRef": "#/components/schemas/RunObject/properties/incomplete_details/properties/reason", + "deprecated": false, "key": "reason", - "optional": true, - "nullable": false, + "docstring": "The reason why the run is incomplete. This will point to which specific token limit was reached over the course of the run.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunObject/properties/incomplete_details/properties/reason", "types": [ { "kind": "HttpTypeLiteral", @@ -15410,11 +15413,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "max_prompt_tokens" } - ], - "oasRef": "#/components/schemas/RunObject/properties/incomplete_details/properties/reason" + ] }, - "oasRef": "#/components/schemas/RunObject/properties/incomplete_details/properties/reason", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -15424,12 +15426,13 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) code": { "kind": "HttpDeclProperty", - "docstring": "One of `server_error`, `rate_limit_exceeded`, or `invalid_prompt`.", + "oasRef": "#/components/schemas/RunObject/properties/last_error/properties/code", + "deprecated": false, "key": "code", - "optional": false, - "nullable": false, + "docstring": "One of `server_error`, `rate_limit_exceeded`, or `invalid_prompt`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunObject/properties/last_error/properties/code", "types": [ { "kind": "HttpTypeLiteral", @@ -15443,11 +15446,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "invalid_prompt" } - ], - "oasRef": "#/components/schemas/RunObject/properties/last_error/properties/code" + ] }, - "oasRef": "#/components/schemas/RunObject/properties/last_error/properties/code", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -15458,24 +15460,26 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) message": { "kind": "HttpDeclProperty", - "docstring": "A human-readable description of the error.", + "oasRef": "#/components/schemas/RunObject/properties/last_error/properties/message", + "deprecated": false, "key": "message", - "optional": false, - "nullable": false, + "docstring": "A human-readable description of the error.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunObject/properties/last_error/properties/message", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) $shared > (model) metadata > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/Metadata", + "docstring": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.\n", "ident": "Metadata", "type": { "kind": "HttpTypeReference", + "oasRef": "#/components/schemas/Metadata", "ident": "Record", "typeParameters": [ { @@ -15484,10 +15488,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch { "kind": "HttpTypeString" } - ], - "oasRef": "#/components/schemas/Metadata" + ] }, - "docstring": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.\n", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) object > (member) 0": { @@ -15499,10 +15501,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) required_action > (property) submit_tool_outputs": { "kind": "HttpDeclProperty", - "docstring": "Details on the tool outputs needed for this run to continue.", + "oasRef": "#/components/schemas/RunObject/properties/required_action/properties/submit_tool_outputs", + "deprecated": false, "key": "submit_tool_outputs", - "optional": false, - "nullable": false, + "docstring": "Details on the tool outputs needed for this run to continue.", "type": { "kind": "HttpTypeObject", "members": [ @@ -15511,8 +15513,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunObject/properties/required_action/properties/submit_tool_outputs", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -15521,22 +15523,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) required_action > (property) type": { "kind": "HttpDeclProperty", - "docstring": "For now, this is always `submit_tool_outputs`.", + "oasRef": "#/components/schemas/RunObject/properties/required_action/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "For now, this is always `submit_tool_outputs`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunObject/properties/required_action/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "submit_tool_outputs" } - ], - "oasRef": "#/components/schemas/RunObject/properties/required_action/properties/type" + ] }, - "oasRef": "#/components/schemas/RunObject/properties/required_action/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -15546,18 +15548,18 @@ 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/oneOf/0", + "docstring": "`auto` is the default value\n", "ident": "UnionMember0", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/oneOf/0", "types": [ { "kind": "HttpTypeLiteral", "literal": "auto" } - ], - "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/oneOf/0" + ] }, - "docstring": "`auto` is the default value\n", "childrenParentSchema": "enum", "children": [ "(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 0 > (member) 0" @@ -15603,19 +15605,21 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads > (model) assistant_response_format_option > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption", + "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", "ident": "AssistantResponseFormatOption", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption", "types": [ { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/oneOf/0", "types": [ { "kind": "HttpTypeLiteral", "literal": "auto" } - ], - "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/oneOf/0" + ] }, { "kind": "HttpTypeReference", @@ -15632,10 +15636,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "ident": "ResponseFormatJSONSchema", "$ref": "(resource) $shared > (model) response_format_json_schema > (schema)" } - ], - "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption" + ] }, - "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", @@ -15710,9 +15712,11 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0": { "kind": "HttpDeclTypeAlias", "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", "ident": "UnionMember0", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption/oneOf/0", "types": [ { "kind": "HttpTypeLiteral", @@ -15726,10 +15730,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "required" } - ], - "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", "children": [ "(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0 > (member) 0", @@ -15753,12 +15755,15 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads > (model) assistant_tool_choice_option > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption", + "docstring": "Controls which (if any) tool is called by the model.\n`none` means the model will not call any tools and instead generates a message.\n`auto` is the default value and means the model can pick between generating a message or calling one or more tools.\n`required` means the model must call one or more tools before responding to the user.\nSpecifying a particular tool like `{\"type\": \"file_search\"}` or `{\"type\": \"function\", \"function\": {\"name\": \"my_function\"}}` forces the model to call that tool.\n", "ident": "AssistantToolChoiceOption", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption", "types": [ { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption/oneOf/0", "types": [ { "kind": "HttpTypeLiteral", @@ -15772,18 +15777,15 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "required" } - ], - "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption/oneOf/0" + ] }, { "kind": "HttpTypeReference", "ident": "AssistantToolChoice", "$ref": "(resource) beta.threads > (model) assistant_tool_choice > (schema)" } - ], - "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption" + ] }, - "docstring": "Controls which (if any) tool is called by the model.\n`none` means the model will not call any tools and instead generates a message.\n`auto` is the default value and means the model can pick between generating a message or calling one or more tools.\n`required` means the model must call one or more tools before responding to the user.\nSpecifying a particular tool like `{\"type\": \"file_search\"}` or `{\"type\": \"function\", \"function\": {\"name\": \"my_function\"}}` forces the model to call that tool.\n", "childrenParentSchema": "union", "children": [ "(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0", @@ -15889,12 +15891,13 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The truncation strategy to use for the thread. The default is `auto`. If set to `last_messages`, the thread will be truncated to the n most recent messages in the thread. When set to `auto`, messages in the middle of the thread will be dropped to fit the context length of the model, `max_prompt_tokens`.", + "oasRef": "#/components/schemas/TruncationObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The truncation strategy to use for the thread. The default is `auto`. If set to `last_messages`, the thread will be truncated to the n most recent messages in the thread. When set to `auto`, messages in the middle of the thread will be dropped to fit the context length of the model, `max_prompt_tokens`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/TruncationObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", @@ -15904,11 +15907,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "last_messages" } - ], - "oasRef": "#/components/schemas/TruncationObject/properties/type" + ] }, - "oasRef": "#/components/schemas/TruncationObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -15918,60 +15920,60 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) last_messages": { "kind": "HttpDeclProperty", - "docstring": "The number of most recent messages from the thread when constructing the context for the run.", + "oasRef": "#/components/schemas/TruncationObject/properties/last_messages", + "deprecated": false, "key": "last_messages", - "optional": true, - "nullable": true, + "docstring": "The number of most recent messages from the thread when constructing the context for the run.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "minimum": 1 }, - "oasRef": "#/components/schemas/TruncationObject/properties/last_messages", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) usage > (property) completion_tokens": { "kind": "HttpDeclProperty", - "docstring": "Number of completion tokens used over the course of the run.", + "oasRef": "#/components/schemas/RunCompletionUsage/anyOf/0/properties/completion_tokens", + "deprecated": false, "key": "completion_tokens", - "optional": false, - "nullable": false, + "docstring": "Number of completion tokens used over the course of the run.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RunCompletionUsage/anyOf/0/properties/completion_tokens", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) usage > (property) prompt_tokens": { "kind": "HttpDeclProperty", - "docstring": "Number of prompt tokens used over the course of the run.", + "oasRef": "#/components/schemas/RunCompletionUsage/anyOf/0/properties/prompt_tokens", + "deprecated": false, "key": "prompt_tokens", - "optional": false, - "nullable": false, + "docstring": "Number of prompt tokens used over the course of the run.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RunCompletionUsage/anyOf/0/properties/prompt_tokens", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) usage > (property) total_tokens": { "kind": "HttpDeclProperty", - "docstring": "Total number of tokens used (prompt + completion).", + "oasRef": "#/components/schemas/RunCompletionUsage/anyOf/0/properties/total_tokens", + "deprecated": false, "key": "total_tokens", - "optional": false, - "nullable": false, + "docstring": "Total number of tokens used (prompt + completion).", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RunCompletionUsage/anyOf/0/properties/total_tokens", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, @@ -16012,21 +16014,21 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) required_action > (property) submit_tool_outputs > (property) tool_calls": { "kind": "HttpDeclProperty", - "docstring": "A list of the relevant tool calls.", + "oasRef": "#/components/schemas/RunObject/properties/required_action/properties/submit_tool_outputs/properties/tool_calls", + "deprecated": false, "key": "tool_calls", - "optional": false, - "nullable": false, + "docstring": "A list of the relevant tool calls.", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RunObject/properties/required_action/properties/submit_tool_outputs/properties/tool_calls", "elementType": { "kind": "HttpTypeReference", "ident": "RequiredActionFunctionToolCall", "$ref": "(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema)" + } }, - "oasRef": "#/components/schemas/RunObject/properties/required_action/properties/submit_tool_outputs/properties/tool_calls" - }, - "oasRef": "#/components/schemas/RunObject/properties/required_action/properties/submit_tool_outputs/properties/tool_calls", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "array", "childrenParentSchema": "object", "children": [ @@ -16051,22 +16053,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) $shared > (model) response_format_text > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of response format being defined. Always `text`.", + "oasRef": "#/components/schemas/ResponseFormatText/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of response format being defined. Always `text`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/ResponseFormatText/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "text" } - ], - "oasRef": "#/components/schemas/ResponseFormatText/properties/type" + ] }, - "oasRef": "#/components/schemas/ResponseFormatText/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -16076,6 +16078,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) $shared > (model) response_format_text > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/ResponseFormatText", + "docstring": "Default response format. Used to generate text responses.\n", "ident": "ResponseFormatText", "type": { "kind": "HttpTypeObject", @@ -16085,7 +16088,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Default response format. Used to generate text responses.\n", "childrenParentSchema": "object", "children": [ "(resource) $shared > (model) response_format_text > (schema) > (property) type" @@ -16093,22 +16095,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) $shared > (model) response_format_json_object > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of response format being defined. Always `json_object`.", + "oasRef": "#/components/schemas/ResponseFormatJsonObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of response format being defined. Always `json_object`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/ResponseFormatJsonObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "json_object" } - ], - "oasRef": "#/components/schemas/ResponseFormatJsonObject/properties/type" + ] }, - "oasRef": "#/components/schemas/ResponseFormatJsonObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -16118,6 +16120,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) $shared > (model) response_format_json_object > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/ResponseFormatJsonObject", + "docstring": "JSON object response format. An older method of generating JSON responses.\nUsing `json_schema` is recommended for models that support it. Note that the\nmodel will not generate JSON without a system or user message instructing it\nto do so.\n", "ident": "ResponseFormatJSONObject", "type": { "kind": "HttpTypeObject", @@ -16127,7 +16130,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "JSON object response format. An older method of generating JSON responses.\nUsing `json_schema` is recommended for models that support it. Note that the\nmodel will not generate JSON without a system or user message instructing it\nto do so.\n", "childrenParentSchema": "object", "children": [ "(resource) $shared > (model) response_format_json_object > (schema) > (property) type" @@ -16135,11 +16137,11 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema": { "kind": "HttpDeclProperty", - "title": "JSON schema", - "docstring": "Structured Outputs configuration options, including a JSON Schema.\n", + "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema", + "deprecated": false, "key": "json_schema", - "optional": false, - "nullable": false, + "docstring": "Structured Outputs configuration options, including a JSON Schema.\n", + "title": "JSON schema", "type": { "kind": "HttpTypeObject", "members": [ @@ -16157,8 +16159,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -16170,22 +16172,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) $shared > (model) response_format_json_schema > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of response format being defined. Always `json_schema`.", + "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of response format being defined. Always `json_schema`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "json_schema" } - ], - "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/type" + ] }, - "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -16195,6 +16197,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) $shared > (model) response_format_json_schema > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/ResponseFormatJsonSchema", + "docstring": "JSON Schema response format. Used to generate structured JSON responses.\nLearn more about [Structured Outputs](/docs/guides/structured-outputs).\n", "ident": "ResponseFormatJSONSchema", "type": { "kind": "HttpTypeObject", @@ -16207,7 +16210,6 @@ 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](/docs/guides/structured-outputs).\n", "childrenParentSchema": "object", "children": [ "(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema", @@ -16237,12 +16239,13 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the tool. If type is `function`, the function name must be set", + "oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the tool. If type is `function`, the function name must be set", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/type", "types": [ { "kind": "HttpTypeLiteral", @@ -16256,11 +16259,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "file_search" } - ], - "oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/type" + ] }, - "oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -16271,18 +16273,18 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) function": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/function", + "deprecated": false, "key": "function", - "optional": true, - "nullable": false, "type": { "kind": "HttpTypeReference", "ident": "AssistantToolChoiceFunction", "$ref": "(resource) beta.threads > (model) assistant_tool_choice_function > (schema)" }, - "oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/function", - "deprecated": false, - "schemaType": "object", + "optional": true, + "nullable": false, "modelImplicit": false, + "schemaType": "object", "modelPath": "(resource) beta.threads > (model) assistant_tool_choice_function", "childrenParentSchema": "object", "children": [ @@ -16292,6 +16294,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads > (model) assistant_tool_choice > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/AssistantsNamedToolChoice", + "docstring": "Specifies a tool the model should use. Use to force the model to call a specific tool.", "ident": "AssistantToolChoice", "type": { "kind": "HttpTypeObject", @@ -16304,7 +16307,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Specifies a tool the model should use. Use to force the model to call a specific tool.", "childrenParentSchema": "object", "children": [ "(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) type", @@ -16313,22 +16315,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of tool being defined: `code_interpreter`", + "oasRef": "#/components/schemas/AssistantToolsCode/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of tool being defined: `code_interpreter`", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantToolsCode/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "code_interpreter" } - ], - "oasRef": "#/components/schemas/AssistantToolsCode/properties/type" + ] }, - "oasRef": "#/components/schemas/AssistantToolsCode/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -16337,22 +16339,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of tool being defined: `file_search`", + "oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of tool being defined: `file_search`", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "file_search" } - ], - "oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/type" + ] }, - "oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -16361,10 +16363,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search": { "kind": "HttpDeclProperty", - "docstring": "Overrides for the file search tool.", + "oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/file_search", + "deprecated": false, "key": "file_search", - "optional": true, - "nullable": false, + "docstring": "Overrides for the file search tool.", "type": { "kind": "HttpTypeObject", "members": [ @@ -16376,8 +16378,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/file_search", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -16387,18 +16389,18 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) function_tool > (schema) > (property) function": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/AssistantToolsFunction/properties/function", + "deprecated": false, "key": "function", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeReference", "ident": "FunctionDefinition", "$ref": "(resource) $shared > (model) function_definition > (schema)" }, - "oasRef": "#/components/schemas/AssistantToolsFunction/properties/function", - "deprecated": false, - "schemaType": "object", + "optional": false, + "nullable": false, "modelImplicit": false, + "schemaType": "object", "modelPath": "(resource) $shared > (model) function_definition", "childrenParentSchema": "object", "children": [ @@ -16410,22 +16412,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) function_tool > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of tool being defined: `function`", + "oasRef": "#/components/schemas/AssistantToolsFunction/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of tool being defined: `function`", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantToolsFunction/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "function" } - ], - "oasRef": "#/components/schemas/AssistantToolsFunction/properties/type" + ] }, - "oasRef": "#/components/schemas/AssistantToolsFunction/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -16448,24 +16450,24 @@ 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](/docs/api-reference/runs/submitToolOutputs) endpoint.", + "oasRef": "#/components/schemas/RunToolCallObject/properties/id", + "deprecated": false, "key": "id", - "optional": false, - "nullable": false, + "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.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunToolCallObject/properties/id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) function": { "kind": "HttpDeclProperty", - "docstring": "The function definition.", + "oasRef": "#/components/schemas/RunToolCallObject/properties/function", + "deprecated": false, "key": "function", - "optional": false, - "nullable": false, + "docstring": "The function definition.", "type": { "kind": "HttpTypeObject", "members": [ @@ -16477,8 +16479,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunToolCallObject/properties/function", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -16488,22 +16490,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of tool call the output is required for. For now, this is always `function`.", + "oasRef": "#/components/schemas/RunToolCallObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of tool call the output is required for. For now, this is always `function`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunToolCallObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "function" } - ], - "oasRef": "#/components/schemas/RunToolCallObject/properties/type" + ] }, - "oasRef": "#/components/schemas/RunToolCallObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -16513,6 +16515,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RunToolCallObject", + "docstring": "Tool call objects", "ident": "RequiredActionFunctionToolCall", "type": { "kind": "HttpTypeObject", @@ -16528,7 +16531,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Tool call objects", "childrenParentSchema": "object", "children": [ "(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) id", @@ -16552,41 +16554,42 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the response format. Must be a-z, A-Z, 0-9, or contain\nunderscores and dashes, with a maximum length of 64.\n", + "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/name", + "deprecated": false, "key": "name", - "optional": false, - "nullable": false, + "docstring": "The name of the response format. Must be a-z, A-Z, 0-9, or contain\nunderscores and dashes, with a maximum length of 64.\n", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/name", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema > (property) description": { "kind": "HttpDeclProperty", - "docstring": "A description of what the response format is for, used by the model to\ndetermine how to respond in the format.\n", + "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/description", + "deprecated": false, "key": "description", - "optional": true, - "nullable": false, + "docstring": "A description of what the response format is for, used by the model to\ndetermine how to respond in the format.\n", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/description", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema > (property) schema": { "kind": "HttpDeclProperty", - "title": "JSON schema", - "docstring": "The schema for the response format, described as a JSON Schema object.\nLearn how to build JSON schemas [here](https://json-schema.org/).\n", + "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/schema", + "deprecated": false, "key": "schema", - "optional": true, - "nullable": false, + "docstring": "The schema for the response format, described as a JSON Schema object.\nLearn how to build JSON schemas [here](https://json-schema.org/).\n", + "title": "JSON schema", "type": { "kind": "HttpTypeReference", + "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/schema", "ident": "Record", "typeParameters": [ { @@ -16595,26 +16598,25 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch { "kind": "HttpTypeUnknown" } - ], - "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/schema" + ] }, - "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/schema", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "map", "children": [] }, "(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](/docs/guides/structured-outputs).\n", + "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/strict", + "deprecated": false, "key": "strict", - "optional": true, - "nullable": true, - "default": false, + "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", "type": { "kind": "HttpTypeBoolean" }, - "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/strict", - "deprecated": false, + "default": false, + "optional": true, + "nullable": true, "schemaType": "boolean", "children": [] }, @@ -16648,15 +16650,15 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads > (model) assistant_tool_choice_function > (schema) > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the function to call.", + "oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/function/properties/name", + "deprecated": false, "key": "name", - "optional": false, - "nullable": false, + "docstring": "The name of the function to call.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/function/properties/name", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, @@ -16693,10 +16695,10 @@ 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](/docs/assistants/tools/file-search#customizing-file-search-settings) for more information.\n", + "oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/file_search/properties/max_num_results", + "deprecated": false, "key": "max_num_results", - "optional": true, - "nullable": false, + "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", "type": { "kind": "HttpTypeNumber" }, @@ -16704,18 +16706,18 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "minimum": 1, "maximum": 50 }, - "oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/file_search/properties/max_num_results", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "integer", "children": [] }, "(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](/docs/assistants/tools/file-search#customizing-file-search-settings) for more information.\n", + "oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/file_search/properties/ranking_options", + "deprecated": false, "key": "ranking_options", - "optional": true, - "nullable": false, + "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", + "title": "File search tool call ranking options", "type": { "kind": "HttpTypeObject", "members": [ @@ -16727,8 +16729,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/file_search/properties/ranking_options", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -16738,62 +16740,62 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) $shared > (model) function_definition > (schema) > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.", + "oasRef": "#/components/schemas/FunctionObject/properties/name", + "deprecated": false, "key": "name", - "optional": false, - "nullable": false, + "docstring": "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/FunctionObject/properties/name", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) $shared > (model) function_definition > (schema) > (property) description": { "kind": "HttpDeclProperty", - "docstring": "A description of what the function does, used by the model to choose when and how to call the function.", + "oasRef": "#/components/schemas/FunctionObject/properties/description", + "deprecated": false, "key": "description", - "optional": true, - "nullable": false, + "docstring": "A description of what the function does, used by the model to choose when and how to call the function.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/FunctionObject/properties/description", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(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](/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.", + "oasRef": "#/components/schemas/FunctionObject/properties/parameters", + "deprecated": false, "key": "parameters", - "optional": true, - "nullable": false, + "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.", "type": { "kind": "HttpTypeReference", "ident": "FunctionParameters", "$ref": "(resource) $shared > (model) function_parameters > (schema)" }, - "oasRef": "#/components/schemas/FunctionObject/properties/parameters", - "deprecated": false, - "schemaType": "map", + "optional": true, + "nullable": false, "modelImplicit": false, + "schemaType": "map", "modelPath": "(resource) $shared > (model) function_parameters", "children": [] }, "(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](/docs/guides/function-calling).", + "oasRef": "#/components/schemas/FunctionObject/properties/strict", + "deprecated": false, "key": "strict", - "optional": true, - "nullable": true, - "default": false, + "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).", "type": { "kind": "HttpTypeBoolean" }, - "oasRef": "#/components/schemas/FunctionObject/properties/strict", - "deprecated": false, + "default": false, + "optional": true, + "nullable": true, "schemaType": "boolean", "children": [] }, @@ -16835,29 +16837,29 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) function > (property) arguments": { "kind": "HttpDeclProperty", - "docstring": "The arguments that the model expects you to pass to the function.", + "oasRef": "#/components/schemas/RunToolCallObject/properties/function/properties/arguments", + "deprecated": false, "key": "arguments", - "optional": false, - "nullable": false, + "docstring": "The arguments that the model expects you to pass to the function.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunToolCallObject/properties/function/properties/arguments", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) function > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the function.", + "oasRef": "#/components/schemas/RunToolCallObject/properties/function/properties/name", + "deprecated": false, "key": "name", - "optional": false, - "nullable": false, + "docstring": "The name of the function.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunToolCallObject/properties/function/properties/name", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, @@ -16870,10 +16872,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options > (property) score_threshold": { "kind": "HttpDeclProperty", - "docstring": "The score threshold for the file search. All values must be a floating point number between 0 and 1.", + "oasRef": "#/components/schemas/FileSearchRankingOptions/properties/score_threshold", + "deprecated": false, "key": "score_threshold", - "optional": false, - "nullable": false, + "docstring": "The score threshold for the file search. All values must be a floating point number between 0 and 1.", "type": { "kind": "HttpTypeNumber" }, @@ -16881,19 +16883,20 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "minimum": 0, "maximum": 1 }, - "oasRef": "#/components/schemas/FileSearchRankingOptions/properties/score_threshold", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "number", "children": [] }, "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options > (property) ranker": { "kind": "HttpDeclProperty", - "docstring": "The ranker to use for the file search. If not specified will use the `auto` ranker.", + "oasRef": "#/components/schemas/FileSearchRankingOptions/properties/ranker", + "deprecated": false, "key": "ranker", - "optional": true, - "nullable": false, + "docstring": "The ranker to use for the file search. If not specified will use the `auto` ranker.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/FileSearchRankingOptions/properties/ranker", "types": [ { "kind": "HttpTypeLiteral", @@ -16903,11 +16906,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "default_2024_08_21" } - ], - "oasRef": "#/components/schemas/FileSearchRankingOptions/properties/ranker" + ] }, - "oasRef": "#/components/schemas/FileSearchRankingOptions/properties/ranker", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -16918,9 +16920,11 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) $shared > (model) function_parameters > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/FunctionParameters", + "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.", "ident": "FunctionParameters", "type": { "kind": "HttpTypeReference", + "oasRef": "#/components/schemas/FunctionParameters", "ident": "Record", "typeParameters": [ { @@ -16929,10 +16933,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch { "kind": "HttpTypeUnknown" } - ], - "oasRef": "#/components/schemas/FunctionParameters" + ] }, - "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": { @@ -16971,7 +16973,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/oneOf/7", - "ident": "UnionMember8", + "docstring": "Occurs when a [run](/docs/api-reference/runs/object) moves to a `cancelling` status.", + "ident": "ThreadRunCancelling", "type": { "kind": "HttpTypeObject", "members": [ @@ -16983,7 +16986,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "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", @@ -16992,20 +16994,20 @@ 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](/docs/api-reference/threads).", + "oasRef": "#/components/schemas/RunStreamEvent/oneOf/7/properties/data", + "deprecated": false, "key": "data", - "optional": false, - "nullable": false, + "docstring": "Represents an execution run on a [thread](/docs/api-reference/threads).", + "title": "A run on a thread", "type": { "kind": "HttpTypeReference", "ident": "Run", "$ref": "(resource) beta.threads.runs > (model) run > (schema)" }, - "oasRef": "#/components/schemas/RunStreamEvent/oneOf/7/properties/data", - "deprecated": false, - "schemaType": "object", + "optional": false, + "nullable": false, "modelImplicit": false, + "schemaType": "object", "modelPath": "(resource) beta.threads.runs > (model) run", "childrenParentSchema": "object", "children": [ @@ -17040,21 +17042,21 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 8 > (property) event": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RunStreamEvent/oneOf/7/properties/event", + "deprecated": false, "key": "event", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStreamEvent/oneOf/7/properties/event", "types": [ { "kind": "HttpTypeLiteral", "literal": "thread.run.cancelling" } - ], - "oasRef": "#/components/schemas/RunStreamEvent/oneOf/7/properties/event" + ] }, - "oasRef": "#/components/schemas/RunStreamEvent/oneOf/7/properties/event", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -17063,123 +17065,123 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The identifier, which can be referenced in API endpoints.", + "oasRef": "#/components/schemas/RunObject/properties/id", + "deprecated": false, "key": "id", - "optional": false, - "nullable": false, + "docstring": "The identifier, which can be referenced in API endpoints.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunObject/properties/id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) assistant_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the [assistant](/docs/api-reference/assistants) used for execution of this run.", + "oasRef": "#/components/schemas/RunObject/properties/assistant_id", + "deprecated": false, "key": "assistant_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the [assistant](/docs/api-reference/assistants) used for execution of this run.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunObject/properties/assistant_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) cancelled_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the run was cancelled.", + "oasRef": "#/components/schemas/RunObject/properties/cancelled_at", + "deprecated": false, "key": "cancelled_at", - "optional": false, - "nullable": true, + "docstring": "The Unix timestamp (in seconds) for when the run was cancelled.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/RunObject/properties/cancelled_at", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) completed_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the run was completed.", + "oasRef": "#/components/schemas/RunObject/properties/completed_at", + "deprecated": false, "key": "completed_at", - "optional": false, - "nullable": true, + "docstring": "The Unix timestamp (in seconds) for when the run was completed.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/RunObject/properties/completed_at", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) created_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the run was created.", + "oasRef": "#/components/schemas/RunObject/properties/created_at", + "deprecated": false, "key": "created_at", - "optional": false, - "nullable": false, + "docstring": "The Unix timestamp (in seconds) for when the run was created.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/RunObject/properties/created_at", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) expires_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the run will expire.", + "oasRef": "#/components/schemas/RunObject/properties/expires_at", + "deprecated": false, "key": "expires_at", - "optional": false, - "nullable": true, + "docstring": "The Unix timestamp (in seconds) for when the run will expire.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/RunObject/properties/expires_at", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) failed_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the run failed.", + "oasRef": "#/components/schemas/RunObject/properties/failed_at", + "deprecated": false, "key": "failed_at", - "optional": false, - "nullable": true, + "docstring": "The Unix timestamp (in seconds) for when the run failed.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/RunObject/properties/failed_at", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) incomplete_details": { "kind": "HttpDeclProperty", - "docstring": "Details on why the run is incomplete. Will be `null` if the run is not incomplete.", + "oasRef": "#/components/schemas/RunObject/properties/incomplete_details", + "deprecated": false, "key": "incomplete_details", - "optional": false, - "nullable": true, + "docstring": "Details on why the run is incomplete. Will be `null` if the run is not incomplete.", "type": { "kind": "HttpTypeObject", "members": [ @@ -17188,8 +17190,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunObject/properties/incomplete_details", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -17198,24 +17200,24 @@ 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](/docs/api-reference/assistants) used for this run.", + "oasRef": "#/components/schemas/RunObject/properties/instructions", + "deprecated": false, "key": "instructions", - "optional": false, - "nullable": false, + "docstring": "The instructions that the [assistant](/docs/api-reference/assistants) used for this run.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunObject/properties/instructions", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) last_error": { "kind": "HttpDeclProperty", - "docstring": "The last error associated with this run. Will be `null` if there are no errors.", + "oasRef": "#/components/schemas/RunObject/properties/last_error", + "deprecated": false, "key": "last_error", - "optional": false, - "nullable": true, + "docstring": "The last error associated with this run. Will be `null` if there are no errors.", "type": { "kind": "HttpTypeObject", "members": [ @@ -17227,8 +17229,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunObject/properties/last_error", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -17238,88 +17240,88 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) max_completion_tokens": { "kind": "HttpDeclProperty", - "docstring": "The maximum number of completion tokens specified to have been used over the course of the run.\n", + "oasRef": "#/components/schemas/RunObject/properties/max_completion_tokens", + "deprecated": false, "key": "max_completion_tokens", - "optional": false, - "nullable": true, + "docstring": "The maximum number of completion tokens specified to have been used over the course of the run.\n", "type": { "kind": "HttpTypeNumber" }, "constraints": { "minimum": 256 }, - "oasRef": "#/components/schemas/RunObject/properties/max_completion_tokens", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) max_prompt_tokens": { "kind": "HttpDeclProperty", - "docstring": "The maximum number of prompt tokens specified to have been used over the course of the run.\n", + "oasRef": "#/components/schemas/RunObject/properties/max_prompt_tokens", + "deprecated": false, "key": "max_prompt_tokens", - "optional": false, - "nullable": true, + "docstring": "The maximum number of prompt tokens specified to have been used over the course of the run.\n", "type": { "kind": "HttpTypeNumber" }, "constraints": { "minimum": 256 }, - "oasRef": "#/components/schemas/RunObject/properties/max_prompt_tokens", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) metadata": { "kind": "HttpDeclProperty", - "docstring": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.\n", + "oasRef": "#/components/schemas/RunObject/properties/metadata", + "deprecated": false, "key": "metadata", - "optional": false, - "nullable": true, + "docstring": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.\n", "type": { "kind": "HttpTypeReference", "ident": "Metadata", "$ref": "(resource) $shared > (model) metadata > (schema)" }, - "oasRef": "#/components/schemas/RunObject/properties/metadata", - "deprecated": false, - "schemaType": "map", + "optional": false, + "nullable": true, "modelImplicit": false, + "schemaType": "map", "modelPath": "(resource) $shared > (model) metadata", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) model": { "kind": "HttpDeclProperty", - "docstring": "The model that the [assistant](/docs/api-reference/assistants) used for this run.", + "oasRef": "#/components/schemas/RunObject/properties/model", + "deprecated": false, "key": "model", - "optional": false, - "nullable": false, + "docstring": "The model that the [assistant](/docs/api-reference/assistants) used for this run.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunObject/properties/model", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) object": { "kind": "HttpDeclProperty", - "docstring": "The object type, which is always `thread.run`.", + "oasRef": "#/components/schemas/RunObject/properties/object", + "deprecated": false, "key": "object", - "optional": false, - "nullable": false, + "docstring": "The object type, which is always `thread.run`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunObject/properties/object", "types": [ { "kind": "HttpTypeLiteral", "literal": "thread.run" } - ], - "oasRef": "#/components/schemas/RunObject/properties/object" + ] }, - "oasRef": "#/components/schemas/RunObject/properties/object", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -17328,25 +17330,25 @@ 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](/docs/guides/function-calling#configuring-parallel-function-calling) during tool use.", + "oasRef": "#/components/schemas/RunObject/properties/parallel_tool_calls", + "deprecated": false, "key": "parallel_tool_calls", - "optional": false, - "nullable": false, - "default": true, + "docstring": "Whether to enable [parallel function calling](/docs/guides/function-calling#configuring-parallel-function-calling) during tool use.", "type": { "kind": "HttpTypeBoolean" }, - "oasRef": "#/components/schemas/RunObject/properties/parallel_tool_calls", - "deprecated": false, + "default": true, + "optional": false, + "nullable": false, "schemaType": "boolean", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) required_action": { "kind": "HttpDeclProperty", - "docstring": "Details on the action required to continue the run. Will be `null` if no action is required.", + "oasRef": "#/components/schemas/RunObject/properties/required_action", + "deprecated": false, "key": "required_action", - "optional": false, - "nullable": true, + "docstring": "Details on the action required to continue the run. Will be `null` if no action is required.", "type": { "kind": "HttpTypeObject", "members": [ @@ -17358,8 +17360,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunObject/properties/required_action", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -17369,19 +17371,19 @@ 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](/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", + "oasRef": "#/components/schemas/RunObject/properties/response_format", + "deprecated": false, "key": "response_format", - "optional": false, - "nullable": true, + "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", "type": { "kind": "HttpTypeReference", "ident": "AssistantResponseFormatOption", "$ref": "(resource) beta.threads > (model) assistant_response_format_option > (schema)" }, - "oasRef": "#/components/schemas/RunObject/properties/response_format", - "deprecated": false, - "schemaType": "union", + "optional": false, + "nullable": true, "modelImplicit": false, + "schemaType": "union", "modelPath": "(resource) beta.threads > (model) assistant_response_format_option", "childrenParentSchema": "union", "children": [ @@ -17393,29 +17395,30 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) started_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the run was started.", + "oasRef": "#/components/schemas/RunObject/properties/started_at", + "deprecated": false, "key": "started_at", - "optional": false, - "nullable": true, + "docstring": "The Unix timestamp (in seconds) for when the run was started.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/RunObject/properties/started_at", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) status": { "kind": "HttpDeclProperty", - "docstring": "The status of the run, which can be either `queued`, `in_progress`, `requires_action`, `cancelling`, `cancelled`, `failed`, `completed`, `incomplete`, or `expired`.", + "oasRef": "#/components/schemas/RunObject/properties/status", + "deprecated": false, "key": "status", - "optional": false, - "nullable": false, + "docstring": "The status of the run, which can be either `queued`, `in_progress`, `requires_action`, `cancelling`, `cancelled`, `failed`, `completed`, `incomplete`, or `expired`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunObject/properties/status", "types": [ { "kind": "HttpTypeLiteral", @@ -17453,11 +17456,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "expired" } - ], - "oasRef": "#/components/schemas/RunObject/properties/status" + ] }, - "oasRef": "#/components/schemas/RunObject/properties/status", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -17474,33 +17476,33 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) thread_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the [thread](/docs/api-reference/threads) that was executed on as a part of this run.", + "oasRef": "#/components/schemas/RunObject/properties/thread_id", + "deprecated": false, "key": "thread_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the [thread](/docs/api-reference/threads) that was executed on as a part of this run.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunObject/properties/thread_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) tool_choice": { "kind": "HttpDeclProperty", - "docstring": "Controls which (if any) tool is called by the model.\n`none` means the model will not call any tools and instead generates a message.\n`auto` is the default value and means the model can pick between generating a message or calling one or more tools.\n`required` means the model must call one or more tools before responding to the user.\nSpecifying a particular tool like `{\"type\": \"file_search\"}` or `{\"type\": \"function\", \"function\": {\"name\": \"my_function\"}}` forces the model to call that tool.\n", + "oasRef": "#/components/schemas/RunObject/properties/tool_choice", + "deprecated": false, "key": "tool_choice", - "optional": false, - "nullable": true, + "docstring": "Controls which (if any) tool is called by the model.\n`none` means the model will not call any tools and instead generates a message.\n`auto` is the default value and means the model can pick between generating a message or calling one or more tools.\n`required` means the model must call one or more tools before responding to the user.\nSpecifying a particular tool like `{\"type\": \"file_search\"}` or `{\"type\": \"function\", \"function\": {\"name\": \"my_function\"}}` forces the model to call that tool.\n", "type": { "kind": "HttpTypeReference", "ident": "AssistantToolChoiceOption", "$ref": "(resource) beta.threads > (model) assistant_tool_choice_option > (schema)" }, - "oasRef": "#/components/schemas/RunObject/properties/tool_choice", - "deprecated": false, - "schemaType": "union", + "optional": false, + "nullable": true, "modelImplicit": false, + "schemaType": "union", "modelPath": "(resource) beta.threads > (model) assistant_tool_choice_option", "childrenParentSchema": "union", "children": [ @@ -17510,15 +17512,16 @@ 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](/docs/api-reference/assistants) used for this run.", + "oasRef": "#/components/schemas/RunObject/properties/tools", + "deprecated": false, "key": "tools", - "optional": false, - "nullable": false, - "default": [], + "docstring": "The list of tools that the [assistant](/docs/api-reference/assistants) used for this run.", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RunObject/properties/tools", "elementType": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunObject/properties/tools/items", "types": [ { "kind": "HttpTypeReference", @@ -17535,13 +17538,12 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "ident": "FunctionTool", "$ref": "(resource) beta.assistants > (model) function_tool > (schema)" } - ], - "oasRef": "#/components/schemas/RunObject/properties/tools/items" - }, - "oasRef": "#/components/schemas/RunObject/properties/tools" + ] + } }, - "oasRef": "#/components/schemas/RunObject/properties/tools", - "deprecated": false, + "default": [], + "optional": false, + "nullable": false, "schemaType": "array", "childrenParentSchema": "union", "children": [ @@ -17552,11 +17554,11 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy": { "kind": "HttpDeclProperty", - "title": "Thread Truncation Controls", - "docstring": "Controls for how a thread will be truncated prior to the run. Use this to control the initial context window of the run.", + "oasRef": "#/components/schemas/RunObject/properties/truncation_strategy", + "deprecated": false, "key": "truncation_strategy", - "optional": false, - "nullable": true, + "docstring": "Controls for how a thread will be truncated prior to the run. Use this to control the initial context window of the run.", + "title": "Thread Truncation Controls", "type": { "kind": "HttpTypeObject", "members": [ @@ -17568,8 +17570,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunObject/properties/truncation_strategy", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -17579,10 +17581,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) usage": { "kind": "HttpDeclProperty", - "docstring": "Usage statistics related to the run. This value will be `null` if the run is not in a terminal state (i.e. `in_progress`, `queued`, etc.).", + "oasRef": "#/components/schemas/RunObject/properties/usage", + "deprecated": false, "key": "usage", - "optional": false, - "nullable": true, + "docstring": "Usage statistics related to the run. This value will be `null` if the run is not in a terminal state (i.e. `in_progress`, `queued`, etc.).", "type": { "kind": "HttpTypeObject", "members": [ @@ -17597,8 +17599,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunObject/properties/usage", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -17609,35 +17611,36 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) temperature": { "kind": "HttpDeclProperty", - "docstring": "The sampling temperature used for this run. If not set, defaults to 1.", + "oasRef": "#/components/schemas/RunObject/properties/temperature", + "deprecated": false, "key": "temperature", - "optional": true, - "nullable": true, + "docstring": "The sampling temperature used for this run. If not set, defaults to 1.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RunObject/properties/temperature", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "number", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) top_p": { "kind": "HttpDeclProperty", - "docstring": "The nucleus sampling value used for this run. If not set, defaults to 1.", + "oasRef": "#/components/schemas/RunObject/properties/top_p", + "deprecated": false, "key": "top_p", - "optional": true, - "nullable": true, + "docstring": "The nucleus sampling value used for this run. If not set, defaults to 1.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RunObject/properties/top_p", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "number", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RunObject", + "docstring": "Represents an execution run on a [thread](/docs/api-reference/threads).", "ident": "Run", "type": { "kind": "HttpTypeObject", @@ -17725,7 +17728,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Represents an execution run on a [thread](/docs/api-reference/threads).", "childrenParentSchema": "object", "children": [ "(resource) beta.threads.runs > (model) run > (schema) > (property) id", @@ -17766,12 +17768,13 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) incomplete_details > (property) reason": { "kind": "HttpDeclProperty", - "docstring": "The reason why the run is incomplete. This will point to which specific token limit was reached over the course of the run.", + "oasRef": "#/components/schemas/RunObject/properties/incomplete_details/properties/reason", + "deprecated": false, "key": "reason", - "optional": true, - "nullable": false, + "docstring": "The reason why the run is incomplete. This will point to which specific token limit was reached over the course of the run.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunObject/properties/incomplete_details/properties/reason", "types": [ { "kind": "HttpTypeLiteral", @@ -17781,11 +17784,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "max_prompt_tokens" } - ], - "oasRef": "#/components/schemas/RunObject/properties/incomplete_details/properties/reason" + ] }, - "oasRef": "#/components/schemas/RunObject/properties/incomplete_details/properties/reason", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -17795,12 +17797,13 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) code": { "kind": "HttpDeclProperty", - "docstring": "One of `server_error`, `rate_limit_exceeded`, or `invalid_prompt`.", + "oasRef": "#/components/schemas/RunObject/properties/last_error/properties/code", + "deprecated": false, "key": "code", - "optional": false, - "nullable": false, + "docstring": "One of `server_error`, `rate_limit_exceeded`, or `invalid_prompt`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunObject/properties/last_error/properties/code", "types": [ { "kind": "HttpTypeLiteral", @@ -17814,11 +17817,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "invalid_prompt" } - ], - "oasRef": "#/components/schemas/RunObject/properties/last_error/properties/code" + ] }, - "oasRef": "#/components/schemas/RunObject/properties/last_error/properties/code", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -17829,24 +17831,26 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) message": { "kind": "HttpDeclProperty", - "docstring": "A human-readable description of the error.", + "oasRef": "#/components/schemas/RunObject/properties/last_error/properties/message", + "deprecated": false, "key": "message", - "optional": false, - "nullable": false, + "docstring": "A human-readable description of the error.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunObject/properties/last_error/properties/message", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) $shared > (model) metadata > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/Metadata", + "docstring": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.\n", "ident": "Metadata", "type": { "kind": "HttpTypeReference", + "oasRef": "#/components/schemas/Metadata", "ident": "Record", "typeParameters": [ { @@ -17855,10 +17859,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch { "kind": "HttpTypeString" } - ], - "oasRef": "#/components/schemas/Metadata" + ] }, - "docstring": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.\n", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) object > (member) 0": { @@ -17870,10 +17872,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) required_action > (property) submit_tool_outputs": { "kind": "HttpDeclProperty", - "docstring": "Details on the tool outputs needed for this run to continue.", + "oasRef": "#/components/schemas/RunObject/properties/required_action/properties/submit_tool_outputs", + "deprecated": false, "key": "submit_tool_outputs", - "optional": false, - "nullable": false, + "docstring": "Details on the tool outputs needed for this run to continue.", "type": { "kind": "HttpTypeObject", "members": [ @@ -17882,8 +17884,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunObject/properties/required_action/properties/submit_tool_outputs", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -17892,22 +17894,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) required_action > (property) type": { "kind": "HttpDeclProperty", - "docstring": "For now, this is always `submit_tool_outputs`.", + "oasRef": "#/components/schemas/RunObject/properties/required_action/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "For now, this is always `submit_tool_outputs`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunObject/properties/required_action/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "submit_tool_outputs" } - ], - "oasRef": "#/components/schemas/RunObject/properties/required_action/properties/type" + ] }, - "oasRef": "#/components/schemas/RunObject/properties/required_action/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -17917,18 +17919,18 @@ 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/oneOf/0", + "docstring": "`auto` is the default value\n", "ident": "UnionMember0", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/oneOf/0", "types": [ { "kind": "HttpTypeLiteral", "literal": "auto" } - ], - "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/oneOf/0" + ] }, - "docstring": "`auto` is the default value\n", "childrenParentSchema": "enum", "children": [ "(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 0 > (member) 0" @@ -17974,19 +17976,21 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads > (model) assistant_response_format_option > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption", + "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", "ident": "AssistantResponseFormatOption", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption", "types": [ { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/oneOf/0", "types": [ { "kind": "HttpTypeLiteral", "literal": "auto" } - ], - "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/oneOf/0" + ] }, { "kind": "HttpTypeReference", @@ -18003,10 +18007,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "ident": "ResponseFormatJSONSchema", "$ref": "(resource) $shared > (model) response_format_json_schema > (schema)" } - ], - "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption" + ] }, - "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", @@ -18081,9 +18083,11 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0": { "kind": "HttpDeclTypeAlias", "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", "ident": "UnionMember0", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption/oneOf/0", "types": [ { "kind": "HttpTypeLiteral", @@ -18097,10 +18101,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "required" } - ], - "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", "children": [ "(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0 > (member) 0", @@ -18124,12 +18126,15 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads > (model) assistant_tool_choice_option > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption", + "docstring": "Controls which (if any) tool is called by the model.\n`none` means the model will not call any tools and instead generates a message.\n`auto` is the default value and means the model can pick between generating a message or calling one or more tools.\n`required` means the model must call one or more tools before responding to the user.\nSpecifying a particular tool like `{\"type\": \"file_search\"}` or `{\"type\": \"function\", \"function\": {\"name\": \"my_function\"}}` forces the model to call that tool.\n", "ident": "AssistantToolChoiceOption", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption", "types": [ { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption/oneOf/0", "types": [ { "kind": "HttpTypeLiteral", @@ -18143,18 +18148,15 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "required" } - ], - "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption/oneOf/0" + ] }, { "kind": "HttpTypeReference", "ident": "AssistantToolChoice", "$ref": "(resource) beta.threads > (model) assistant_tool_choice > (schema)" } - ], - "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption" + ] }, - "docstring": "Controls which (if any) tool is called by the model.\n`none` means the model will not call any tools and instead generates a message.\n`auto` is the default value and means the model can pick between generating a message or calling one or more tools.\n`required` means the model must call one or more tools before responding to the user.\nSpecifying a particular tool like `{\"type\": \"file_search\"}` or `{\"type\": \"function\", \"function\": {\"name\": \"my_function\"}}` forces the model to call that tool.\n", "childrenParentSchema": "union", "children": [ "(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0", @@ -18260,12 +18262,13 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The truncation strategy to use for the thread. The default is `auto`. If set to `last_messages`, the thread will be truncated to the n most recent messages in the thread. When set to `auto`, messages in the middle of the thread will be dropped to fit the context length of the model, `max_prompt_tokens`.", + "oasRef": "#/components/schemas/TruncationObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The truncation strategy to use for the thread. The default is `auto`. If set to `last_messages`, the thread will be truncated to the n most recent messages in the thread. When set to `auto`, messages in the middle of the thread will be dropped to fit the context length of the model, `max_prompt_tokens`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/TruncationObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", @@ -18275,11 +18278,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "last_messages" } - ], - "oasRef": "#/components/schemas/TruncationObject/properties/type" + ] }, - "oasRef": "#/components/schemas/TruncationObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -18289,60 +18291,60 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) last_messages": { "kind": "HttpDeclProperty", - "docstring": "The number of most recent messages from the thread when constructing the context for the run.", + "oasRef": "#/components/schemas/TruncationObject/properties/last_messages", + "deprecated": false, "key": "last_messages", - "optional": true, - "nullable": true, + "docstring": "The number of most recent messages from the thread when constructing the context for the run.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "minimum": 1 }, - "oasRef": "#/components/schemas/TruncationObject/properties/last_messages", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) usage > (property) completion_tokens": { "kind": "HttpDeclProperty", - "docstring": "Number of completion tokens used over the course of the run.", + "oasRef": "#/components/schemas/RunCompletionUsage/anyOf/0/properties/completion_tokens", + "deprecated": false, "key": "completion_tokens", - "optional": false, - "nullable": false, + "docstring": "Number of completion tokens used over the course of the run.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RunCompletionUsage/anyOf/0/properties/completion_tokens", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) usage > (property) prompt_tokens": { "kind": "HttpDeclProperty", - "docstring": "Number of prompt tokens used over the course of the run.", + "oasRef": "#/components/schemas/RunCompletionUsage/anyOf/0/properties/prompt_tokens", + "deprecated": false, "key": "prompt_tokens", - "optional": false, - "nullable": false, + "docstring": "Number of prompt tokens used over the course of the run.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RunCompletionUsage/anyOf/0/properties/prompt_tokens", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) usage > (property) total_tokens": { "kind": "HttpDeclProperty", - "docstring": "Total number of tokens used (prompt + completion).", + "oasRef": "#/components/schemas/RunCompletionUsage/anyOf/0/properties/total_tokens", + "deprecated": false, "key": "total_tokens", - "optional": false, - "nullable": false, + "docstring": "Total number of tokens used (prompt + completion).", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RunCompletionUsage/anyOf/0/properties/total_tokens", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, @@ -18383,21 +18385,21 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) required_action > (property) submit_tool_outputs > (property) tool_calls": { "kind": "HttpDeclProperty", - "docstring": "A list of the relevant tool calls.", + "oasRef": "#/components/schemas/RunObject/properties/required_action/properties/submit_tool_outputs/properties/tool_calls", + "deprecated": false, "key": "tool_calls", - "optional": false, - "nullable": false, + "docstring": "A list of the relevant tool calls.", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RunObject/properties/required_action/properties/submit_tool_outputs/properties/tool_calls", "elementType": { "kind": "HttpTypeReference", "ident": "RequiredActionFunctionToolCall", "$ref": "(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema)" + } }, - "oasRef": "#/components/schemas/RunObject/properties/required_action/properties/submit_tool_outputs/properties/tool_calls" - }, - "oasRef": "#/components/schemas/RunObject/properties/required_action/properties/submit_tool_outputs/properties/tool_calls", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "array", "childrenParentSchema": "object", "children": [ @@ -18422,22 +18424,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) $shared > (model) response_format_text > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of response format being defined. Always `text`.", + "oasRef": "#/components/schemas/ResponseFormatText/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of response format being defined. Always `text`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/ResponseFormatText/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "text" } - ], - "oasRef": "#/components/schemas/ResponseFormatText/properties/type" + ] }, - "oasRef": "#/components/schemas/ResponseFormatText/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -18447,6 +18449,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) $shared > (model) response_format_text > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/ResponseFormatText", + "docstring": "Default response format. Used to generate text responses.\n", "ident": "ResponseFormatText", "type": { "kind": "HttpTypeObject", @@ -18456,7 +18459,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Default response format. Used to generate text responses.\n", "childrenParentSchema": "object", "children": [ "(resource) $shared > (model) response_format_text > (schema) > (property) type" @@ -18464,22 +18466,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) $shared > (model) response_format_json_object > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of response format being defined. Always `json_object`.", + "oasRef": "#/components/schemas/ResponseFormatJsonObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of response format being defined. Always `json_object`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/ResponseFormatJsonObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "json_object" } - ], - "oasRef": "#/components/schemas/ResponseFormatJsonObject/properties/type" + ] }, - "oasRef": "#/components/schemas/ResponseFormatJsonObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -18489,6 +18491,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) $shared > (model) response_format_json_object > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/ResponseFormatJsonObject", + "docstring": "JSON object response format. An older method of generating JSON responses.\nUsing `json_schema` is recommended for models that support it. Note that the\nmodel will not generate JSON without a system or user message instructing it\nto do so.\n", "ident": "ResponseFormatJSONObject", "type": { "kind": "HttpTypeObject", @@ -18498,7 +18501,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "JSON object response format. An older method of generating JSON responses.\nUsing `json_schema` is recommended for models that support it. Note that the\nmodel will not generate JSON without a system or user message instructing it\nto do so.\n", "childrenParentSchema": "object", "children": [ "(resource) $shared > (model) response_format_json_object > (schema) > (property) type" @@ -18506,11 +18508,11 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema": { "kind": "HttpDeclProperty", - "title": "JSON schema", - "docstring": "Structured Outputs configuration options, including a JSON Schema.\n", + "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema", + "deprecated": false, "key": "json_schema", - "optional": false, - "nullable": false, + "docstring": "Structured Outputs configuration options, including a JSON Schema.\n", + "title": "JSON schema", "type": { "kind": "HttpTypeObject", "members": [ @@ -18528,8 +18530,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -18541,22 +18543,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) $shared > (model) response_format_json_schema > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of response format being defined. Always `json_schema`.", + "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of response format being defined. Always `json_schema`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "json_schema" } - ], - "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/type" + ] }, - "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -18566,6 +18568,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) $shared > (model) response_format_json_schema > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/ResponseFormatJsonSchema", + "docstring": "JSON Schema response format. Used to generate structured JSON responses.\nLearn more about [Structured Outputs](/docs/guides/structured-outputs).\n", "ident": "ResponseFormatJSONSchema", "type": { "kind": "HttpTypeObject", @@ -18578,7 +18581,6 @@ 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](/docs/guides/structured-outputs).\n", "childrenParentSchema": "object", "children": [ "(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema", @@ -18608,12 +18610,13 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the tool. If type is `function`, the function name must be set", + "oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the tool. If type is `function`, the function name must be set", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/type", "types": [ { "kind": "HttpTypeLiteral", @@ -18627,11 +18630,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "file_search" } - ], - "oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/type" + ] }, - "oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -18642,18 +18644,18 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) function": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/function", + "deprecated": false, "key": "function", - "optional": true, - "nullable": false, "type": { "kind": "HttpTypeReference", "ident": "AssistantToolChoiceFunction", "$ref": "(resource) beta.threads > (model) assistant_tool_choice_function > (schema)" }, - "oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/function", - "deprecated": false, - "schemaType": "object", + "optional": true, + "nullable": false, "modelImplicit": false, + "schemaType": "object", "modelPath": "(resource) beta.threads > (model) assistant_tool_choice_function", "childrenParentSchema": "object", "children": [ @@ -18663,6 +18665,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads > (model) assistant_tool_choice > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/AssistantsNamedToolChoice", + "docstring": "Specifies a tool the model should use. Use to force the model to call a specific tool.", "ident": "AssistantToolChoice", "type": { "kind": "HttpTypeObject", @@ -18675,7 +18678,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Specifies a tool the model should use. Use to force the model to call a specific tool.", "childrenParentSchema": "object", "children": [ "(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) type", @@ -18684,22 +18686,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of tool being defined: `code_interpreter`", + "oasRef": "#/components/schemas/AssistantToolsCode/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of tool being defined: `code_interpreter`", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantToolsCode/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "code_interpreter" } - ], - "oasRef": "#/components/schemas/AssistantToolsCode/properties/type" + ] }, - "oasRef": "#/components/schemas/AssistantToolsCode/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -18708,22 +18710,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of tool being defined: `file_search`", + "oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of tool being defined: `file_search`", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "file_search" } - ], - "oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/type" + ] }, - "oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -18732,10 +18734,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search": { "kind": "HttpDeclProperty", - "docstring": "Overrides for the file search tool.", + "oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/file_search", + "deprecated": false, "key": "file_search", - "optional": true, - "nullable": false, + "docstring": "Overrides for the file search tool.", "type": { "kind": "HttpTypeObject", "members": [ @@ -18747,8 +18749,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/file_search", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -18758,18 +18760,18 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) function_tool > (schema) > (property) function": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/AssistantToolsFunction/properties/function", + "deprecated": false, "key": "function", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeReference", "ident": "FunctionDefinition", "$ref": "(resource) $shared > (model) function_definition > (schema)" }, - "oasRef": "#/components/schemas/AssistantToolsFunction/properties/function", - "deprecated": false, - "schemaType": "object", + "optional": false, + "nullable": false, "modelImplicit": false, + "schemaType": "object", "modelPath": "(resource) $shared > (model) function_definition", "childrenParentSchema": "object", "children": [ @@ -18781,22 +18783,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) function_tool > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of tool being defined: `function`", + "oasRef": "#/components/schemas/AssistantToolsFunction/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of tool being defined: `function`", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantToolsFunction/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "function" } - ], - "oasRef": "#/components/schemas/AssistantToolsFunction/properties/type" + ] }, - "oasRef": "#/components/schemas/AssistantToolsFunction/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -18819,24 +18821,24 @@ 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](/docs/api-reference/runs/submitToolOutputs) endpoint.", + "oasRef": "#/components/schemas/RunToolCallObject/properties/id", + "deprecated": false, "key": "id", - "optional": false, - "nullable": false, + "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.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunToolCallObject/properties/id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) function": { "kind": "HttpDeclProperty", - "docstring": "The function definition.", + "oasRef": "#/components/schemas/RunToolCallObject/properties/function", + "deprecated": false, "key": "function", - "optional": false, - "nullable": false, + "docstring": "The function definition.", "type": { "kind": "HttpTypeObject", "members": [ @@ -18848,8 +18850,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunToolCallObject/properties/function", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -18859,22 +18861,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of tool call the output is required for. For now, this is always `function`.", + "oasRef": "#/components/schemas/RunToolCallObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of tool call the output is required for. For now, this is always `function`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunToolCallObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "function" } - ], - "oasRef": "#/components/schemas/RunToolCallObject/properties/type" + ] }, - "oasRef": "#/components/schemas/RunToolCallObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -18884,6 +18886,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RunToolCallObject", + "docstring": "Tool call objects", "ident": "RequiredActionFunctionToolCall", "type": { "kind": "HttpTypeObject", @@ -18899,7 +18902,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Tool call objects", "childrenParentSchema": "object", "children": [ "(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) id", @@ -18923,41 +18925,42 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the response format. Must be a-z, A-Z, 0-9, or contain\nunderscores and dashes, with a maximum length of 64.\n", + "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/name", + "deprecated": false, "key": "name", - "optional": false, - "nullable": false, + "docstring": "The name of the response format. Must be a-z, A-Z, 0-9, or contain\nunderscores and dashes, with a maximum length of 64.\n", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/name", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema > (property) description": { "kind": "HttpDeclProperty", - "docstring": "A description of what the response format is for, used by the model to\ndetermine how to respond in the format.\n", + "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/description", + "deprecated": false, "key": "description", - "optional": true, - "nullable": false, + "docstring": "A description of what the response format is for, used by the model to\ndetermine how to respond in the format.\n", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/description", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema > (property) schema": { "kind": "HttpDeclProperty", - "title": "JSON schema", - "docstring": "The schema for the response format, described as a JSON Schema object.\nLearn how to build JSON schemas [here](https://json-schema.org/).\n", + "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/schema", + "deprecated": false, "key": "schema", - "optional": true, - "nullable": false, + "docstring": "The schema for the response format, described as a JSON Schema object.\nLearn how to build JSON schemas [here](https://json-schema.org/).\n", + "title": "JSON schema", "type": { "kind": "HttpTypeReference", + "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/schema", "ident": "Record", "typeParameters": [ { @@ -18966,26 +18969,25 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch { "kind": "HttpTypeUnknown" } - ], - "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/schema" + ] }, - "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/schema", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "map", "children": [] }, "(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](/docs/guides/structured-outputs).\n", + "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/strict", + "deprecated": false, "key": "strict", - "optional": true, - "nullable": true, - "default": false, + "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", "type": { "kind": "HttpTypeBoolean" }, - "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/strict", - "deprecated": false, + "default": false, + "optional": true, + "nullable": true, "schemaType": "boolean", "children": [] }, @@ -19019,15 +19021,15 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads > (model) assistant_tool_choice_function > (schema) > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the function to call.", + "oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/function/properties/name", + "deprecated": false, "key": "name", - "optional": false, - "nullable": false, + "docstring": "The name of the function to call.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/function/properties/name", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, @@ -19064,10 +19066,10 @@ 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](/docs/assistants/tools/file-search#customizing-file-search-settings) for more information.\n", + "oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/file_search/properties/max_num_results", + "deprecated": false, "key": "max_num_results", - "optional": true, - "nullable": false, + "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", "type": { "kind": "HttpTypeNumber" }, @@ -19075,18 +19077,18 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "minimum": 1, "maximum": 50 }, - "oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/file_search/properties/max_num_results", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "integer", "children": [] }, "(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](/docs/assistants/tools/file-search#customizing-file-search-settings) for more information.\n", + "oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/file_search/properties/ranking_options", + "deprecated": false, "key": "ranking_options", - "optional": true, - "nullable": false, + "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", + "title": "File search tool call ranking options", "type": { "kind": "HttpTypeObject", "members": [ @@ -19098,8 +19100,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/file_search/properties/ranking_options", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -19109,62 +19111,62 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) $shared > (model) function_definition > (schema) > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.", + "oasRef": "#/components/schemas/FunctionObject/properties/name", + "deprecated": false, "key": "name", - "optional": false, - "nullable": false, + "docstring": "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/FunctionObject/properties/name", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) $shared > (model) function_definition > (schema) > (property) description": { "kind": "HttpDeclProperty", - "docstring": "A description of what the function does, used by the model to choose when and how to call the function.", + "oasRef": "#/components/schemas/FunctionObject/properties/description", + "deprecated": false, "key": "description", - "optional": true, - "nullable": false, + "docstring": "A description of what the function does, used by the model to choose when and how to call the function.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/FunctionObject/properties/description", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(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](/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.", + "oasRef": "#/components/schemas/FunctionObject/properties/parameters", + "deprecated": false, "key": "parameters", - "optional": true, - "nullable": false, + "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.", "type": { "kind": "HttpTypeReference", "ident": "FunctionParameters", "$ref": "(resource) $shared > (model) function_parameters > (schema)" }, - "oasRef": "#/components/schemas/FunctionObject/properties/parameters", - "deprecated": false, - "schemaType": "map", + "optional": true, + "nullable": false, "modelImplicit": false, + "schemaType": "map", "modelPath": "(resource) $shared > (model) function_parameters", "children": [] }, "(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](/docs/guides/function-calling).", + "oasRef": "#/components/schemas/FunctionObject/properties/strict", + "deprecated": false, "key": "strict", - "optional": true, - "nullable": true, - "default": false, + "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).", "type": { "kind": "HttpTypeBoolean" }, - "oasRef": "#/components/schemas/FunctionObject/properties/strict", - "deprecated": false, + "default": false, + "optional": true, + "nullable": true, "schemaType": "boolean", "children": [] }, @@ -19206,29 +19208,29 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) function > (property) arguments": { "kind": "HttpDeclProperty", - "docstring": "The arguments that the model expects you to pass to the function.", + "oasRef": "#/components/schemas/RunToolCallObject/properties/function/properties/arguments", + "deprecated": false, "key": "arguments", - "optional": false, - "nullable": false, + "docstring": "The arguments that the model expects you to pass to the function.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunToolCallObject/properties/function/properties/arguments", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) function > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the function.", + "oasRef": "#/components/schemas/RunToolCallObject/properties/function/properties/name", + "deprecated": false, "key": "name", - "optional": false, - "nullable": false, + "docstring": "The name of the function.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunToolCallObject/properties/function/properties/name", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, @@ -19241,10 +19243,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options > (property) score_threshold": { "kind": "HttpDeclProperty", - "docstring": "The score threshold for the file search. All values must be a floating point number between 0 and 1.", + "oasRef": "#/components/schemas/FileSearchRankingOptions/properties/score_threshold", + "deprecated": false, "key": "score_threshold", - "optional": false, - "nullable": false, + "docstring": "The score threshold for the file search. All values must be a floating point number between 0 and 1.", "type": { "kind": "HttpTypeNumber" }, @@ -19252,19 +19254,20 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "minimum": 0, "maximum": 1 }, - "oasRef": "#/components/schemas/FileSearchRankingOptions/properties/score_threshold", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "number", "children": [] }, "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options > (property) ranker": { "kind": "HttpDeclProperty", - "docstring": "The ranker to use for the file search. If not specified will use the `auto` ranker.", + "oasRef": "#/components/schemas/FileSearchRankingOptions/properties/ranker", + "deprecated": false, "key": "ranker", - "optional": true, - "nullable": false, + "docstring": "The ranker to use for the file search. If not specified will use the `auto` ranker.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/FileSearchRankingOptions/properties/ranker", "types": [ { "kind": "HttpTypeLiteral", @@ -19274,11 +19277,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "default_2024_08_21" } - ], - "oasRef": "#/components/schemas/FileSearchRankingOptions/properties/ranker" + ] }, - "oasRef": "#/components/schemas/FileSearchRankingOptions/properties/ranker", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -19289,9 +19291,11 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) $shared > (model) function_parameters > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/FunctionParameters", + "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.", "ident": "FunctionParameters", "type": { "kind": "HttpTypeReference", + "oasRef": "#/components/schemas/FunctionParameters", "ident": "Record", "typeParameters": [ { @@ -19300,10 +19304,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch { "kind": "HttpTypeUnknown" } - ], - "oasRef": "#/components/schemas/FunctionParameters" + ] }, - "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": { @@ -19342,7 +19344,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/oneOf/8", - "ident": "UnionMember9", + "docstring": "Occurs when a [run](/docs/api-reference/runs/object) is cancelled.", + "ident": "ThreadRunCancelled", "type": { "kind": "HttpTypeObject", "members": [ @@ -19354,7 +19357,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "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", @@ -19363,20 +19365,20 @@ 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](/docs/api-reference/threads).", + "oasRef": "#/components/schemas/RunStreamEvent/oneOf/8/properties/data", + "deprecated": false, "key": "data", - "optional": false, - "nullable": false, + "docstring": "Represents an execution run on a [thread](/docs/api-reference/threads).", + "title": "A run on a thread", "type": { "kind": "HttpTypeReference", "ident": "Run", "$ref": "(resource) beta.threads.runs > (model) run > (schema)" }, - "oasRef": "#/components/schemas/RunStreamEvent/oneOf/8/properties/data", - "deprecated": false, - "schemaType": "object", + "optional": false, + "nullable": false, "modelImplicit": false, + "schemaType": "object", "modelPath": "(resource) beta.threads.runs > (model) run", "childrenParentSchema": "object", "children": [ @@ -19411,21 +19413,21 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 9 > (property) event": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RunStreamEvent/oneOf/8/properties/event", + "deprecated": false, "key": "event", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStreamEvent/oneOf/8/properties/event", "types": [ { "kind": "HttpTypeLiteral", "literal": "thread.run.cancelled" } - ], - "oasRef": "#/components/schemas/RunStreamEvent/oneOf/8/properties/event" + ] }, - "oasRef": "#/components/schemas/RunStreamEvent/oneOf/8/properties/event", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -19434,123 +19436,123 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The identifier, which can be referenced in API endpoints.", + "oasRef": "#/components/schemas/RunObject/properties/id", + "deprecated": false, "key": "id", - "optional": false, - "nullable": false, + "docstring": "The identifier, which can be referenced in API endpoints.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunObject/properties/id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) assistant_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the [assistant](/docs/api-reference/assistants) used for execution of this run.", + "oasRef": "#/components/schemas/RunObject/properties/assistant_id", + "deprecated": false, "key": "assistant_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the [assistant](/docs/api-reference/assistants) used for execution of this run.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunObject/properties/assistant_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) cancelled_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the run was cancelled.", + "oasRef": "#/components/schemas/RunObject/properties/cancelled_at", + "deprecated": false, "key": "cancelled_at", - "optional": false, - "nullable": true, + "docstring": "The Unix timestamp (in seconds) for when the run was cancelled.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/RunObject/properties/cancelled_at", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) completed_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the run was completed.", + "oasRef": "#/components/schemas/RunObject/properties/completed_at", + "deprecated": false, "key": "completed_at", - "optional": false, - "nullable": true, + "docstring": "The Unix timestamp (in seconds) for when the run was completed.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/RunObject/properties/completed_at", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) created_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the run was created.", + "oasRef": "#/components/schemas/RunObject/properties/created_at", + "deprecated": false, "key": "created_at", - "optional": false, - "nullable": false, + "docstring": "The Unix timestamp (in seconds) for when the run was created.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/RunObject/properties/created_at", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) expires_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the run will expire.", + "oasRef": "#/components/schemas/RunObject/properties/expires_at", + "deprecated": false, "key": "expires_at", - "optional": false, - "nullable": true, + "docstring": "The Unix timestamp (in seconds) for when the run will expire.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/RunObject/properties/expires_at", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) failed_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the run failed.", + "oasRef": "#/components/schemas/RunObject/properties/failed_at", + "deprecated": false, "key": "failed_at", - "optional": false, - "nullable": true, + "docstring": "The Unix timestamp (in seconds) for when the run failed.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/RunObject/properties/failed_at", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) incomplete_details": { "kind": "HttpDeclProperty", - "docstring": "Details on why the run is incomplete. Will be `null` if the run is not incomplete.", + "oasRef": "#/components/schemas/RunObject/properties/incomplete_details", + "deprecated": false, "key": "incomplete_details", - "optional": false, - "nullable": true, + "docstring": "Details on why the run is incomplete. Will be `null` if the run is not incomplete.", "type": { "kind": "HttpTypeObject", "members": [ @@ -19559,8 +19561,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunObject/properties/incomplete_details", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -19569,24 +19571,24 @@ 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](/docs/api-reference/assistants) used for this run.", + "oasRef": "#/components/schemas/RunObject/properties/instructions", + "deprecated": false, "key": "instructions", - "optional": false, - "nullable": false, + "docstring": "The instructions that the [assistant](/docs/api-reference/assistants) used for this run.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunObject/properties/instructions", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) last_error": { "kind": "HttpDeclProperty", - "docstring": "The last error associated with this run. Will be `null` if there are no errors.", + "oasRef": "#/components/schemas/RunObject/properties/last_error", + "deprecated": false, "key": "last_error", - "optional": false, - "nullable": true, + "docstring": "The last error associated with this run. Will be `null` if there are no errors.", "type": { "kind": "HttpTypeObject", "members": [ @@ -19598,8 +19600,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunObject/properties/last_error", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -19609,88 +19611,88 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) max_completion_tokens": { "kind": "HttpDeclProperty", - "docstring": "The maximum number of completion tokens specified to have been used over the course of the run.\n", + "oasRef": "#/components/schemas/RunObject/properties/max_completion_tokens", + "deprecated": false, "key": "max_completion_tokens", - "optional": false, - "nullable": true, + "docstring": "The maximum number of completion tokens specified to have been used over the course of the run.\n", "type": { "kind": "HttpTypeNumber" }, "constraints": { "minimum": 256 }, - "oasRef": "#/components/schemas/RunObject/properties/max_completion_tokens", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) max_prompt_tokens": { "kind": "HttpDeclProperty", - "docstring": "The maximum number of prompt tokens specified to have been used over the course of the run.\n", + "oasRef": "#/components/schemas/RunObject/properties/max_prompt_tokens", + "deprecated": false, "key": "max_prompt_tokens", - "optional": false, - "nullable": true, + "docstring": "The maximum number of prompt tokens specified to have been used over the course of the run.\n", "type": { "kind": "HttpTypeNumber" }, "constraints": { "minimum": 256 }, - "oasRef": "#/components/schemas/RunObject/properties/max_prompt_tokens", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) metadata": { "kind": "HttpDeclProperty", - "docstring": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.\n", + "oasRef": "#/components/schemas/RunObject/properties/metadata", + "deprecated": false, "key": "metadata", - "optional": false, - "nullable": true, + "docstring": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.\n", "type": { "kind": "HttpTypeReference", "ident": "Metadata", "$ref": "(resource) $shared > (model) metadata > (schema)" }, - "oasRef": "#/components/schemas/RunObject/properties/metadata", - "deprecated": false, - "schemaType": "map", + "optional": false, + "nullable": true, "modelImplicit": false, + "schemaType": "map", "modelPath": "(resource) $shared > (model) metadata", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) model": { "kind": "HttpDeclProperty", - "docstring": "The model that the [assistant](/docs/api-reference/assistants) used for this run.", + "oasRef": "#/components/schemas/RunObject/properties/model", + "deprecated": false, "key": "model", - "optional": false, - "nullable": false, + "docstring": "The model that the [assistant](/docs/api-reference/assistants) used for this run.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunObject/properties/model", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) object": { "kind": "HttpDeclProperty", - "docstring": "The object type, which is always `thread.run`.", + "oasRef": "#/components/schemas/RunObject/properties/object", + "deprecated": false, "key": "object", - "optional": false, - "nullable": false, + "docstring": "The object type, which is always `thread.run`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunObject/properties/object", "types": [ { "kind": "HttpTypeLiteral", "literal": "thread.run" } - ], - "oasRef": "#/components/schemas/RunObject/properties/object" + ] }, - "oasRef": "#/components/schemas/RunObject/properties/object", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -19699,25 +19701,25 @@ 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](/docs/guides/function-calling#configuring-parallel-function-calling) during tool use.", + "oasRef": "#/components/schemas/RunObject/properties/parallel_tool_calls", + "deprecated": false, "key": "parallel_tool_calls", - "optional": false, - "nullable": false, - "default": true, + "docstring": "Whether to enable [parallel function calling](/docs/guides/function-calling#configuring-parallel-function-calling) during tool use.", "type": { "kind": "HttpTypeBoolean" }, - "oasRef": "#/components/schemas/RunObject/properties/parallel_tool_calls", - "deprecated": false, + "default": true, + "optional": false, + "nullable": false, "schemaType": "boolean", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) required_action": { "kind": "HttpDeclProperty", - "docstring": "Details on the action required to continue the run. Will be `null` if no action is required.", + "oasRef": "#/components/schemas/RunObject/properties/required_action", + "deprecated": false, "key": "required_action", - "optional": false, - "nullable": true, + "docstring": "Details on the action required to continue the run. Will be `null` if no action is required.", "type": { "kind": "HttpTypeObject", "members": [ @@ -19729,8 +19731,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunObject/properties/required_action", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -19740,19 +19742,19 @@ 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](/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", + "oasRef": "#/components/schemas/RunObject/properties/response_format", + "deprecated": false, "key": "response_format", - "optional": false, - "nullable": true, + "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", "type": { "kind": "HttpTypeReference", "ident": "AssistantResponseFormatOption", "$ref": "(resource) beta.threads > (model) assistant_response_format_option > (schema)" }, - "oasRef": "#/components/schemas/RunObject/properties/response_format", - "deprecated": false, - "schemaType": "union", + "optional": false, + "nullable": true, "modelImplicit": false, + "schemaType": "union", "modelPath": "(resource) beta.threads > (model) assistant_response_format_option", "childrenParentSchema": "union", "children": [ @@ -19764,29 +19766,30 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) started_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the run was started.", + "oasRef": "#/components/schemas/RunObject/properties/started_at", + "deprecated": false, "key": "started_at", - "optional": false, - "nullable": true, + "docstring": "The Unix timestamp (in seconds) for when the run was started.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/RunObject/properties/started_at", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) status": { "kind": "HttpDeclProperty", - "docstring": "The status of the run, which can be either `queued`, `in_progress`, `requires_action`, `cancelling`, `cancelled`, `failed`, `completed`, `incomplete`, or `expired`.", + "oasRef": "#/components/schemas/RunObject/properties/status", + "deprecated": false, "key": "status", - "optional": false, - "nullable": false, + "docstring": "The status of the run, which can be either `queued`, `in_progress`, `requires_action`, `cancelling`, `cancelled`, `failed`, `completed`, `incomplete`, or `expired`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunObject/properties/status", "types": [ { "kind": "HttpTypeLiteral", @@ -19824,11 +19827,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "expired" } - ], - "oasRef": "#/components/schemas/RunObject/properties/status" + ] }, - "oasRef": "#/components/schemas/RunObject/properties/status", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -19845,33 +19847,33 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) thread_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the [thread](/docs/api-reference/threads) that was executed on as a part of this run.", + "oasRef": "#/components/schemas/RunObject/properties/thread_id", + "deprecated": false, "key": "thread_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the [thread](/docs/api-reference/threads) that was executed on as a part of this run.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunObject/properties/thread_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) tool_choice": { "kind": "HttpDeclProperty", - "docstring": "Controls which (if any) tool is called by the model.\n`none` means the model will not call any tools and instead generates a message.\n`auto` is the default value and means the model can pick between generating a message or calling one or more tools.\n`required` means the model must call one or more tools before responding to the user.\nSpecifying a particular tool like `{\"type\": \"file_search\"}` or `{\"type\": \"function\", \"function\": {\"name\": \"my_function\"}}` forces the model to call that tool.\n", + "oasRef": "#/components/schemas/RunObject/properties/tool_choice", + "deprecated": false, "key": "tool_choice", - "optional": false, - "nullable": true, + "docstring": "Controls which (if any) tool is called by the model.\n`none` means the model will not call any tools and instead generates a message.\n`auto` is the default value and means the model can pick between generating a message or calling one or more tools.\n`required` means the model must call one or more tools before responding to the user.\nSpecifying a particular tool like `{\"type\": \"file_search\"}` or `{\"type\": \"function\", \"function\": {\"name\": \"my_function\"}}` forces the model to call that tool.\n", "type": { "kind": "HttpTypeReference", "ident": "AssistantToolChoiceOption", "$ref": "(resource) beta.threads > (model) assistant_tool_choice_option > (schema)" }, - "oasRef": "#/components/schemas/RunObject/properties/tool_choice", - "deprecated": false, - "schemaType": "union", + "optional": false, + "nullable": true, "modelImplicit": false, + "schemaType": "union", "modelPath": "(resource) beta.threads > (model) assistant_tool_choice_option", "childrenParentSchema": "union", "children": [ @@ -19881,15 +19883,16 @@ 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](/docs/api-reference/assistants) used for this run.", + "oasRef": "#/components/schemas/RunObject/properties/tools", + "deprecated": false, "key": "tools", - "optional": false, - "nullable": false, - "default": [], + "docstring": "The list of tools that the [assistant](/docs/api-reference/assistants) used for this run.", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RunObject/properties/tools", "elementType": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunObject/properties/tools/items", "types": [ { "kind": "HttpTypeReference", @@ -19906,13 +19909,12 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "ident": "FunctionTool", "$ref": "(resource) beta.assistants > (model) function_tool > (schema)" } - ], - "oasRef": "#/components/schemas/RunObject/properties/tools/items" - }, - "oasRef": "#/components/schemas/RunObject/properties/tools" + ] + } }, - "oasRef": "#/components/schemas/RunObject/properties/tools", - "deprecated": false, + "default": [], + "optional": false, + "nullable": false, "schemaType": "array", "childrenParentSchema": "union", "children": [ @@ -19923,11 +19925,11 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy": { "kind": "HttpDeclProperty", - "title": "Thread Truncation Controls", - "docstring": "Controls for how a thread will be truncated prior to the run. Use this to control the initial context window of the run.", + "oasRef": "#/components/schemas/RunObject/properties/truncation_strategy", + "deprecated": false, "key": "truncation_strategy", - "optional": false, - "nullable": true, + "docstring": "Controls for how a thread will be truncated prior to the run. Use this to control the initial context window of the run.", + "title": "Thread Truncation Controls", "type": { "kind": "HttpTypeObject", "members": [ @@ -19939,8 +19941,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunObject/properties/truncation_strategy", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -19950,10 +19952,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) usage": { "kind": "HttpDeclProperty", - "docstring": "Usage statistics related to the run. This value will be `null` if the run is not in a terminal state (i.e. `in_progress`, `queued`, etc.).", + "oasRef": "#/components/schemas/RunObject/properties/usage", + "deprecated": false, "key": "usage", - "optional": false, - "nullable": true, + "docstring": "Usage statistics related to the run. This value will be `null` if the run is not in a terminal state (i.e. `in_progress`, `queued`, etc.).", "type": { "kind": "HttpTypeObject", "members": [ @@ -19968,8 +19970,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunObject/properties/usage", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -19980,35 +19982,36 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) temperature": { "kind": "HttpDeclProperty", - "docstring": "The sampling temperature used for this run. If not set, defaults to 1.", + "oasRef": "#/components/schemas/RunObject/properties/temperature", + "deprecated": false, "key": "temperature", - "optional": true, - "nullable": true, + "docstring": "The sampling temperature used for this run. If not set, defaults to 1.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RunObject/properties/temperature", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "number", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) top_p": { "kind": "HttpDeclProperty", - "docstring": "The nucleus sampling value used for this run. If not set, defaults to 1.", + "oasRef": "#/components/schemas/RunObject/properties/top_p", + "deprecated": false, "key": "top_p", - "optional": true, - "nullable": true, + "docstring": "The nucleus sampling value used for this run. If not set, defaults to 1.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RunObject/properties/top_p", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "number", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RunObject", + "docstring": "Represents an execution run on a [thread](/docs/api-reference/threads).", "ident": "Run", "type": { "kind": "HttpTypeObject", @@ -20096,7 +20099,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Represents an execution run on a [thread](/docs/api-reference/threads).", "childrenParentSchema": "object", "children": [ "(resource) beta.threads.runs > (model) run > (schema) > (property) id", @@ -20137,12 +20139,13 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) incomplete_details > (property) reason": { "kind": "HttpDeclProperty", - "docstring": "The reason why the run is incomplete. This will point to which specific token limit was reached over the course of the run.", + "oasRef": "#/components/schemas/RunObject/properties/incomplete_details/properties/reason", + "deprecated": false, "key": "reason", - "optional": true, - "nullable": false, + "docstring": "The reason why the run is incomplete. This will point to which specific token limit was reached over the course of the run.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunObject/properties/incomplete_details/properties/reason", "types": [ { "kind": "HttpTypeLiteral", @@ -20152,11 +20155,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "max_prompt_tokens" } - ], - "oasRef": "#/components/schemas/RunObject/properties/incomplete_details/properties/reason" + ] }, - "oasRef": "#/components/schemas/RunObject/properties/incomplete_details/properties/reason", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -20166,12 +20168,13 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) code": { "kind": "HttpDeclProperty", - "docstring": "One of `server_error`, `rate_limit_exceeded`, or `invalid_prompt`.", + "oasRef": "#/components/schemas/RunObject/properties/last_error/properties/code", + "deprecated": false, "key": "code", - "optional": false, - "nullable": false, + "docstring": "One of `server_error`, `rate_limit_exceeded`, or `invalid_prompt`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunObject/properties/last_error/properties/code", "types": [ { "kind": "HttpTypeLiteral", @@ -20185,11 +20188,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "invalid_prompt" } - ], - "oasRef": "#/components/schemas/RunObject/properties/last_error/properties/code" + ] }, - "oasRef": "#/components/schemas/RunObject/properties/last_error/properties/code", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -20200,24 +20202,26 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) message": { "kind": "HttpDeclProperty", - "docstring": "A human-readable description of the error.", + "oasRef": "#/components/schemas/RunObject/properties/last_error/properties/message", + "deprecated": false, "key": "message", - "optional": false, - "nullable": false, + "docstring": "A human-readable description of the error.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunObject/properties/last_error/properties/message", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) $shared > (model) metadata > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/Metadata", + "docstring": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.\n", "ident": "Metadata", "type": { "kind": "HttpTypeReference", + "oasRef": "#/components/schemas/Metadata", "ident": "Record", "typeParameters": [ { @@ -20226,10 +20230,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch { "kind": "HttpTypeString" } - ], - "oasRef": "#/components/schemas/Metadata" + ] }, - "docstring": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.\n", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) object > (member) 0": { @@ -20241,10 +20243,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) required_action > (property) submit_tool_outputs": { "kind": "HttpDeclProperty", - "docstring": "Details on the tool outputs needed for this run to continue.", + "oasRef": "#/components/schemas/RunObject/properties/required_action/properties/submit_tool_outputs", + "deprecated": false, "key": "submit_tool_outputs", - "optional": false, - "nullable": false, + "docstring": "Details on the tool outputs needed for this run to continue.", "type": { "kind": "HttpTypeObject", "members": [ @@ -20253,8 +20255,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunObject/properties/required_action/properties/submit_tool_outputs", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -20263,22 +20265,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) required_action > (property) type": { "kind": "HttpDeclProperty", - "docstring": "For now, this is always `submit_tool_outputs`.", + "oasRef": "#/components/schemas/RunObject/properties/required_action/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "For now, this is always `submit_tool_outputs`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunObject/properties/required_action/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "submit_tool_outputs" } - ], - "oasRef": "#/components/schemas/RunObject/properties/required_action/properties/type" + ] }, - "oasRef": "#/components/schemas/RunObject/properties/required_action/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -20288,18 +20290,18 @@ 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/oneOf/0", + "docstring": "`auto` is the default value\n", "ident": "UnionMember0", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/oneOf/0", "types": [ { "kind": "HttpTypeLiteral", "literal": "auto" } - ], - "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/oneOf/0" + ] }, - "docstring": "`auto` is the default value\n", "childrenParentSchema": "enum", "children": [ "(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 0 > (member) 0" @@ -20345,19 +20347,21 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads > (model) assistant_response_format_option > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption", + "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", "ident": "AssistantResponseFormatOption", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption", "types": [ { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/oneOf/0", "types": [ { "kind": "HttpTypeLiteral", "literal": "auto" } - ], - "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/oneOf/0" + ] }, { "kind": "HttpTypeReference", @@ -20374,10 +20378,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "ident": "ResponseFormatJSONSchema", "$ref": "(resource) $shared > (model) response_format_json_schema > (schema)" } - ], - "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption" + ] }, - "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", @@ -20452,9 +20454,11 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0": { "kind": "HttpDeclTypeAlias", "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", "ident": "UnionMember0", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption/oneOf/0", "types": [ { "kind": "HttpTypeLiteral", @@ -20468,10 +20472,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "required" } - ], - "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", "children": [ "(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0 > (member) 0", @@ -20495,12 +20497,15 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads > (model) assistant_tool_choice_option > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption", + "docstring": "Controls which (if any) tool is called by the model.\n`none` means the model will not call any tools and instead generates a message.\n`auto` is the default value and means the model can pick between generating a message or calling one or more tools.\n`required` means the model must call one or more tools before responding to the user.\nSpecifying a particular tool like `{\"type\": \"file_search\"}` or `{\"type\": \"function\", \"function\": {\"name\": \"my_function\"}}` forces the model to call that tool.\n", "ident": "AssistantToolChoiceOption", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption", "types": [ { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption/oneOf/0", "types": [ { "kind": "HttpTypeLiteral", @@ -20514,18 +20519,15 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "required" } - ], - "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption/oneOf/0" + ] }, { "kind": "HttpTypeReference", "ident": "AssistantToolChoice", "$ref": "(resource) beta.threads > (model) assistant_tool_choice > (schema)" } - ], - "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption" + ] }, - "docstring": "Controls which (if any) tool is called by the model.\n`none` means the model will not call any tools and instead generates a message.\n`auto` is the default value and means the model can pick between generating a message or calling one or more tools.\n`required` means the model must call one or more tools before responding to the user.\nSpecifying a particular tool like `{\"type\": \"file_search\"}` or `{\"type\": \"function\", \"function\": {\"name\": \"my_function\"}}` forces the model to call that tool.\n", "childrenParentSchema": "union", "children": [ "(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0", @@ -20631,12 +20633,13 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The truncation strategy to use for the thread. The default is `auto`. If set to `last_messages`, the thread will be truncated to the n most recent messages in the thread. When set to `auto`, messages in the middle of the thread will be dropped to fit the context length of the model, `max_prompt_tokens`.", + "oasRef": "#/components/schemas/TruncationObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The truncation strategy to use for the thread. The default is `auto`. If set to `last_messages`, the thread will be truncated to the n most recent messages in the thread. When set to `auto`, messages in the middle of the thread will be dropped to fit the context length of the model, `max_prompt_tokens`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/TruncationObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", @@ -20646,11 +20649,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "last_messages" } - ], - "oasRef": "#/components/schemas/TruncationObject/properties/type" + ] }, - "oasRef": "#/components/schemas/TruncationObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -20660,60 +20662,60 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) last_messages": { "kind": "HttpDeclProperty", - "docstring": "The number of most recent messages from the thread when constructing the context for the run.", + "oasRef": "#/components/schemas/TruncationObject/properties/last_messages", + "deprecated": false, "key": "last_messages", - "optional": true, - "nullable": true, + "docstring": "The number of most recent messages from the thread when constructing the context for the run.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "minimum": 1 }, - "oasRef": "#/components/schemas/TruncationObject/properties/last_messages", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) usage > (property) completion_tokens": { "kind": "HttpDeclProperty", - "docstring": "Number of completion tokens used over the course of the run.", + "oasRef": "#/components/schemas/RunCompletionUsage/anyOf/0/properties/completion_tokens", + "deprecated": false, "key": "completion_tokens", - "optional": false, - "nullable": false, + "docstring": "Number of completion tokens used over the course of the run.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RunCompletionUsage/anyOf/0/properties/completion_tokens", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) usage > (property) prompt_tokens": { "kind": "HttpDeclProperty", - "docstring": "Number of prompt tokens used over the course of the run.", + "oasRef": "#/components/schemas/RunCompletionUsage/anyOf/0/properties/prompt_tokens", + "deprecated": false, "key": "prompt_tokens", - "optional": false, - "nullable": false, + "docstring": "Number of prompt tokens used over the course of the run.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RunCompletionUsage/anyOf/0/properties/prompt_tokens", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) usage > (property) total_tokens": { "kind": "HttpDeclProperty", - "docstring": "Total number of tokens used (prompt + completion).", + "oasRef": "#/components/schemas/RunCompletionUsage/anyOf/0/properties/total_tokens", + "deprecated": false, "key": "total_tokens", - "optional": false, - "nullable": false, + "docstring": "Total number of tokens used (prompt + completion).", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RunCompletionUsage/anyOf/0/properties/total_tokens", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, @@ -20754,21 +20756,21 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) required_action > (property) submit_tool_outputs > (property) tool_calls": { "kind": "HttpDeclProperty", - "docstring": "A list of the relevant tool calls.", + "oasRef": "#/components/schemas/RunObject/properties/required_action/properties/submit_tool_outputs/properties/tool_calls", + "deprecated": false, "key": "tool_calls", - "optional": false, - "nullable": false, + "docstring": "A list of the relevant tool calls.", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RunObject/properties/required_action/properties/submit_tool_outputs/properties/tool_calls", "elementType": { "kind": "HttpTypeReference", "ident": "RequiredActionFunctionToolCall", "$ref": "(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema)" + } }, - "oasRef": "#/components/schemas/RunObject/properties/required_action/properties/submit_tool_outputs/properties/tool_calls" - }, - "oasRef": "#/components/schemas/RunObject/properties/required_action/properties/submit_tool_outputs/properties/tool_calls", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "array", "childrenParentSchema": "object", "children": [ @@ -20793,22 +20795,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) $shared > (model) response_format_text > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of response format being defined. Always `text`.", + "oasRef": "#/components/schemas/ResponseFormatText/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of response format being defined. Always `text`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/ResponseFormatText/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "text" } - ], - "oasRef": "#/components/schemas/ResponseFormatText/properties/type" + ] }, - "oasRef": "#/components/schemas/ResponseFormatText/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -20818,6 +20820,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) $shared > (model) response_format_text > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/ResponseFormatText", + "docstring": "Default response format. Used to generate text responses.\n", "ident": "ResponseFormatText", "type": { "kind": "HttpTypeObject", @@ -20827,7 +20830,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Default response format. Used to generate text responses.\n", "childrenParentSchema": "object", "children": [ "(resource) $shared > (model) response_format_text > (schema) > (property) type" @@ -20835,22 +20837,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) $shared > (model) response_format_json_object > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of response format being defined. Always `json_object`.", + "oasRef": "#/components/schemas/ResponseFormatJsonObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of response format being defined. Always `json_object`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/ResponseFormatJsonObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "json_object" } - ], - "oasRef": "#/components/schemas/ResponseFormatJsonObject/properties/type" + ] }, - "oasRef": "#/components/schemas/ResponseFormatJsonObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -20860,6 +20862,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) $shared > (model) response_format_json_object > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/ResponseFormatJsonObject", + "docstring": "JSON object response format. An older method of generating JSON responses.\nUsing `json_schema` is recommended for models that support it. Note that the\nmodel will not generate JSON without a system or user message instructing it\nto do so.\n", "ident": "ResponseFormatJSONObject", "type": { "kind": "HttpTypeObject", @@ -20869,7 +20872,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "JSON object response format. An older method of generating JSON responses.\nUsing `json_schema` is recommended for models that support it. Note that the\nmodel will not generate JSON without a system or user message instructing it\nto do so.\n", "childrenParentSchema": "object", "children": [ "(resource) $shared > (model) response_format_json_object > (schema) > (property) type" @@ -20877,11 +20879,11 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema": { "kind": "HttpDeclProperty", - "title": "JSON schema", - "docstring": "Structured Outputs configuration options, including a JSON Schema.\n", + "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema", + "deprecated": false, "key": "json_schema", - "optional": false, - "nullable": false, + "docstring": "Structured Outputs configuration options, including a JSON Schema.\n", + "title": "JSON schema", "type": { "kind": "HttpTypeObject", "members": [ @@ -20899,8 +20901,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -20912,22 +20914,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) $shared > (model) response_format_json_schema > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of response format being defined. Always `json_schema`.", + "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of response format being defined. Always `json_schema`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "json_schema" } - ], - "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/type" + ] }, - "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -20937,6 +20939,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) $shared > (model) response_format_json_schema > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/ResponseFormatJsonSchema", + "docstring": "JSON Schema response format. Used to generate structured JSON responses.\nLearn more about [Structured Outputs](/docs/guides/structured-outputs).\n", "ident": "ResponseFormatJSONSchema", "type": { "kind": "HttpTypeObject", @@ -20949,7 +20952,6 @@ 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](/docs/guides/structured-outputs).\n", "childrenParentSchema": "object", "children": [ "(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema", @@ -20979,12 +20981,13 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the tool. If type is `function`, the function name must be set", + "oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the tool. If type is `function`, the function name must be set", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/type", "types": [ { "kind": "HttpTypeLiteral", @@ -20998,11 +21001,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "file_search" } - ], - "oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/type" + ] }, - "oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -21013,18 +21015,18 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) function": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/function", + "deprecated": false, "key": "function", - "optional": true, - "nullable": false, "type": { "kind": "HttpTypeReference", "ident": "AssistantToolChoiceFunction", "$ref": "(resource) beta.threads > (model) assistant_tool_choice_function > (schema)" }, - "oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/function", - "deprecated": false, - "schemaType": "object", + "optional": true, + "nullable": false, "modelImplicit": false, + "schemaType": "object", "modelPath": "(resource) beta.threads > (model) assistant_tool_choice_function", "childrenParentSchema": "object", "children": [ @@ -21034,6 +21036,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads > (model) assistant_tool_choice > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/AssistantsNamedToolChoice", + "docstring": "Specifies a tool the model should use. Use to force the model to call a specific tool.", "ident": "AssistantToolChoice", "type": { "kind": "HttpTypeObject", @@ -21046,7 +21049,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Specifies a tool the model should use. Use to force the model to call a specific tool.", "childrenParentSchema": "object", "children": [ "(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) type", @@ -21055,22 +21057,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of tool being defined: `code_interpreter`", + "oasRef": "#/components/schemas/AssistantToolsCode/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of tool being defined: `code_interpreter`", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantToolsCode/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "code_interpreter" } - ], - "oasRef": "#/components/schemas/AssistantToolsCode/properties/type" + ] }, - "oasRef": "#/components/schemas/AssistantToolsCode/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -21079,22 +21081,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of tool being defined: `file_search`", + "oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of tool being defined: `file_search`", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "file_search" } - ], - "oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/type" + ] }, - "oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -21103,10 +21105,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search": { "kind": "HttpDeclProperty", - "docstring": "Overrides for the file search tool.", + "oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/file_search", + "deprecated": false, "key": "file_search", - "optional": true, - "nullable": false, + "docstring": "Overrides for the file search tool.", "type": { "kind": "HttpTypeObject", "members": [ @@ -21118,8 +21120,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/file_search", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -21129,18 +21131,18 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) function_tool > (schema) > (property) function": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/AssistantToolsFunction/properties/function", + "deprecated": false, "key": "function", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeReference", "ident": "FunctionDefinition", "$ref": "(resource) $shared > (model) function_definition > (schema)" }, - "oasRef": "#/components/schemas/AssistantToolsFunction/properties/function", - "deprecated": false, - "schemaType": "object", + "optional": false, + "nullable": false, "modelImplicit": false, + "schemaType": "object", "modelPath": "(resource) $shared > (model) function_definition", "childrenParentSchema": "object", "children": [ @@ -21152,22 +21154,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) function_tool > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of tool being defined: `function`", + "oasRef": "#/components/schemas/AssistantToolsFunction/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of tool being defined: `function`", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantToolsFunction/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "function" } - ], - "oasRef": "#/components/schemas/AssistantToolsFunction/properties/type" + ] }, - "oasRef": "#/components/schemas/AssistantToolsFunction/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -21190,24 +21192,24 @@ 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](/docs/api-reference/runs/submitToolOutputs) endpoint.", + "oasRef": "#/components/schemas/RunToolCallObject/properties/id", + "deprecated": false, "key": "id", - "optional": false, - "nullable": false, + "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.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunToolCallObject/properties/id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) function": { "kind": "HttpDeclProperty", - "docstring": "The function definition.", + "oasRef": "#/components/schemas/RunToolCallObject/properties/function", + "deprecated": false, "key": "function", - "optional": false, - "nullable": false, + "docstring": "The function definition.", "type": { "kind": "HttpTypeObject", "members": [ @@ -21219,8 +21221,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunToolCallObject/properties/function", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -21230,22 +21232,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of tool call the output is required for. For now, this is always `function`.", + "oasRef": "#/components/schemas/RunToolCallObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of tool call the output is required for. For now, this is always `function`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunToolCallObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "function" } - ], - "oasRef": "#/components/schemas/RunToolCallObject/properties/type" + ] }, - "oasRef": "#/components/schemas/RunToolCallObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -21255,6 +21257,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RunToolCallObject", + "docstring": "Tool call objects", "ident": "RequiredActionFunctionToolCall", "type": { "kind": "HttpTypeObject", @@ -21270,7 +21273,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Tool call objects", "childrenParentSchema": "object", "children": [ "(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) id", @@ -21294,41 +21296,42 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the response format. Must be a-z, A-Z, 0-9, or contain\nunderscores and dashes, with a maximum length of 64.\n", + "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/name", + "deprecated": false, "key": "name", - "optional": false, - "nullable": false, + "docstring": "The name of the response format. Must be a-z, A-Z, 0-9, or contain\nunderscores and dashes, with a maximum length of 64.\n", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/name", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema > (property) description": { "kind": "HttpDeclProperty", - "docstring": "A description of what the response format is for, used by the model to\ndetermine how to respond in the format.\n", + "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/description", + "deprecated": false, "key": "description", - "optional": true, - "nullable": false, + "docstring": "A description of what the response format is for, used by the model to\ndetermine how to respond in the format.\n", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/description", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema > (property) schema": { "kind": "HttpDeclProperty", - "title": "JSON schema", - "docstring": "The schema for the response format, described as a JSON Schema object.\nLearn how to build JSON schemas [here](https://json-schema.org/).\n", + "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/schema", + "deprecated": false, "key": "schema", - "optional": true, - "nullable": false, + "docstring": "The schema for the response format, described as a JSON Schema object.\nLearn how to build JSON schemas [here](https://json-schema.org/).\n", + "title": "JSON schema", "type": { "kind": "HttpTypeReference", + "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/schema", "ident": "Record", "typeParameters": [ { @@ -21337,26 +21340,25 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch { "kind": "HttpTypeUnknown" } - ], - "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/schema" + ] }, - "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/schema", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "map", "children": [] }, "(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](/docs/guides/structured-outputs).\n", + "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/strict", + "deprecated": false, "key": "strict", - "optional": true, - "nullable": true, - "default": false, + "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", "type": { "kind": "HttpTypeBoolean" }, - "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/strict", - "deprecated": false, + "default": false, + "optional": true, + "nullable": true, "schemaType": "boolean", "children": [] }, @@ -21390,15 +21392,15 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads > (model) assistant_tool_choice_function > (schema) > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the function to call.", + "oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/function/properties/name", + "deprecated": false, "key": "name", - "optional": false, - "nullable": false, + "docstring": "The name of the function to call.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/function/properties/name", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, @@ -21435,10 +21437,10 @@ 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](/docs/assistants/tools/file-search#customizing-file-search-settings) for more information.\n", + "oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/file_search/properties/max_num_results", + "deprecated": false, "key": "max_num_results", - "optional": true, - "nullable": false, + "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", "type": { "kind": "HttpTypeNumber" }, @@ -21446,18 +21448,18 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "minimum": 1, "maximum": 50 }, - "oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/file_search/properties/max_num_results", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "integer", "children": [] }, "(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](/docs/assistants/tools/file-search#customizing-file-search-settings) for more information.\n", + "oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/file_search/properties/ranking_options", + "deprecated": false, "key": "ranking_options", - "optional": true, - "nullable": false, + "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", + "title": "File search tool call ranking options", "type": { "kind": "HttpTypeObject", "members": [ @@ -21469,8 +21471,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/file_search/properties/ranking_options", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -21480,62 +21482,62 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) $shared > (model) function_definition > (schema) > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.", + "oasRef": "#/components/schemas/FunctionObject/properties/name", + "deprecated": false, "key": "name", - "optional": false, - "nullable": false, + "docstring": "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/FunctionObject/properties/name", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) $shared > (model) function_definition > (schema) > (property) description": { "kind": "HttpDeclProperty", - "docstring": "A description of what the function does, used by the model to choose when and how to call the function.", + "oasRef": "#/components/schemas/FunctionObject/properties/description", + "deprecated": false, "key": "description", - "optional": true, - "nullable": false, + "docstring": "A description of what the function does, used by the model to choose when and how to call the function.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/FunctionObject/properties/description", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(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](/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.", + "oasRef": "#/components/schemas/FunctionObject/properties/parameters", + "deprecated": false, "key": "parameters", - "optional": true, - "nullable": false, + "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.", "type": { "kind": "HttpTypeReference", "ident": "FunctionParameters", "$ref": "(resource) $shared > (model) function_parameters > (schema)" }, - "oasRef": "#/components/schemas/FunctionObject/properties/parameters", - "deprecated": false, - "schemaType": "map", + "optional": true, + "nullable": false, "modelImplicit": false, + "schemaType": "map", "modelPath": "(resource) $shared > (model) function_parameters", "children": [] }, "(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](/docs/guides/function-calling).", + "oasRef": "#/components/schemas/FunctionObject/properties/strict", + "deprecated": false, "key": "strict", - "optional": true, - "nullable": true, - "default": false, + "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).", "type": { "kind": "HttpTypeBoolean" }, - "oasRef": "#/components/schemas/FunctionObject/properties/strict", - "deprecated": false, + "default": false, + "optional": true, + "nullable": true, "schemaType": "boolean", "children": [] }, @@ -21577,29 +21579,29 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) function > (property) arguments": { "kind": "HttpDeclProperty", - "docstring": "The arguments that the model expects you to pass to the function.", + "oasRef": "#/components/schemas/RunToolCallObject/properties/function/properties/arguments", + "deprecated": false, "key": "arguments", - "optional": false, - "nullable": false, + "docstring": "The arguments that the model expects you to pass to the function.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunToolCallObject/properties/function/properties/arguments", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) function > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the function.", + "oasRef": "#/components/schemas/RunToolCallObject/properties/function/properties/name", + "deprecated": false, "key": "name", - "optional": false, - "nullable": false, + "docstring": "The name of the function.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunToolCallObject/properties/function/properties/name", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, @@ -21612,10 +21614,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options > (property) score_threshold": { "kind": "HttpDeclProperty", - "docstring": "The score threshold for the file search. All values must be a floating point number between 0 and 1.", + "oasRef": "#/components/schemas/FileSearchRankingOptions/properties/score_threshold", + "deprecated": false, "key": "score_threshold", - "optional": false, - "nullable": false, + "docstring": "The score threshold for the file search. All values must be a floating point number between 0 and 1.", "type": { "kind": "HttpTypeNumber" }, @@ -21623,19 +21625,20 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "minimum": 0, "maximum": 1 }, - "oasRef": "#/components/schemas/FileSearchRankingOptions/properties/score_threshold", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "number", "children": [] }, "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options > (property) ranker": { "kind": "HttpDeclProperty", - "docstring": "The ranker to use for the file search. If not specified will use the `auto` ranker.", + "oasRef": "#/components/schemas/FileSearchRankingOptions/properties/ranker", + "deprecated": false, "key": "ranker", - "optional": true, - "nullable": false, + "docstring": "The ranker to use for the file search. If not specified will use the `auto` ranker.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/FileSearchRankingOptions/properties/ranker", "types": [ { "kind": "HttpTypeLiteral", @@ -21645,11 +21648,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "default_2024_08_21" } - ], - "oasRef": "#/components/schemas/FileSearchRankingOptions/properties/ranker" + ] }, - "oasRef": "#/components/schemas/FileSearchRankingOptions/properties/ranker", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -21660,9 +21662,11 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) $shared > (model) function_parameters > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/FunctionParameters", + "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.", "ident": "FunctionParameters", "type": { "kind": "HttpTypeReference", + "oasRef": "#/components/schemas/FunctionParameters", "ident": "Record", "typeParameters": [ { @@ -21671,10 +21675,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch { "kind": "HttpTypeUnknown" } - ], - "oasRef": "#/components/schemas/FunctionParameters" + ] }, - "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": { @@ -21713,7 +21715,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/oneOf/9", - "ident": "UnionMember10", + "docstring": "Occurs when a [run](/docs/api-reference/runs/object) expires.", + "ident": "ThreadRunExpired", "type": { "kind": "HttpTypeObject", "members": [ @@ -21725,7 +21728,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "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", @@ -21734,20 +21736,20 @@ 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](/docs/api-reference/threads).", + "oasRef": "#/components/schemas/RunStreamEvent/oneOf/9/properties/data", + "deprecated": false, "key": "data", - "optional": false, - "nullable": false, + "docstring": "Represents an execution run on a [thread](/docs/api-reference/threads).", + "title": "A run on a thread", "type": { "kind": "HttpTypeReference", "ident": "Run", "$ref": "(resource) beta.threads.runs > (model) run > (schema)" }, - "oasRef": "#/components/schemas/RunStreamEvent/oneOf/9/properties/data", - "deprecated": false, - "schemaType": "object", + "optional": false, + "nullable": false, "modelImplicit": false, + "schemaType": "object", "modelPath": "(resource) beta.threads.runs > (model) run", "childrenParentSchema": "object", "children": [ @@ -21782,21 +21784,21 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 10 > (property) event": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RunStreamEvent/oneOf/9/properties/event", + "deprecated": false, "key": "event", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStreamEvent/oneOf/9/properties/event", "types": [ { "kind": "HttpTypeLiteral", "literal": "thread.run.expired" } - ], - "oasRef": "#/components/schemas/RunStreamEvent/oneOf/9/properties/event" + ] }, - "oasRef": "#/components/schemas/RunStreamEvent/oneOf/9/properties/event", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -21805,123 +21807,123 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The identifier, which can be referenced in API endpoints.", + "oasRef": "#/components/schemas/RunObject/properties/id", + "deprecated": false, "key": "id", - "optional": false, - "nullable": false, + "docstring": "The identifier, which can be referenced in API endpoints.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunObject/properties/id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) assistant_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the [assistant](/docs/api-reference/assistants) used for execution of this run.", + "oasRef": "#/components/schemas/RunObject/properties/assistant_id", + "deprecated": false, "key": "assistant_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the [assistant](/docs/api-reference/assistants) used for execution of this run.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunObject/properties/assistant_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) cancelled_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the run was cancelled.", + "oasRef": "#/components/schemas/RunObject/properties/cancelled_at", + "deprecated": false, "key": "cancelled_at", - "optional": false, - "nullable": true, + "docstring": "The Unix timestamp (in seconds) for when the run was cancelled.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/RunObject/properties/cancelled_at", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) completed_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the run was completed.", + "oasRef": "#/components/schemas/RunObject/properties/completed_at", + "deprecated": false, "key": "completed_at", - "optional": false, - "nullable": true, + "docstring": "The Unix timestamp (in seconds) for when the run was completed.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/RunObject/properties/completed_at", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) created_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the run was created.", + "oasRef": "#/components/schemas/RunObject/properties/created_at", + "deprecated": false, "key": "created_at", - "optional": false, - "nullable": false, + "docstring": "The Unix timestamp (in seconds) for when the run was created.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/RunObject/properties/created_at", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) expires_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the run will expire.", + "oasRef": "#/components/schemas/RunObject/properties/expires_at", + "deprecated": false, "key": "expires_at", - "optional": false, - "nullable": true, + "docstring": "The Unix timestamp (in seconds) for when the run will expire.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/RunObject/properties/expires_at", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) failed_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the run failed.", + "oasRef": "#/components/schemas/RunObject/properties/failed_at", + "deprecated": false, "key": "failed_at", - "optional": false, - "nullable": true, + "docstring": "The Unix timestamp (in seconds) for when the run failed.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/RunObject/properties/failed_at", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) incomplete_details": { "kind": "HttpDeclProperty", - "docstring": "Details on why the run is incomplete. Will be `null` if the run is not incomplete.", + "oasRef": "#/components/schemas/RunObject/properties/incomplete_details", + "deprecated": false, "key": "incomplete_details", - "optional": false, - "nullable": true, + "docstring": "Details on why the run is incomplete. Will be `null` if the run is not incomplete.", "type": { "kind": "HttpTypeObject", "members": [ @@ -21930,8 +21932,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunObject/properties/incomplete_details", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -21940,24 +21942,24 @@ 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](/docs/api-reference/assistants) used for this run.", + "oasRef": "#/components/schemas/RunObject/properties/instructions", + "deprecated": false, "key": "instructions", - "optional": false, - "nullable": false, + "docstring": "The instructions that the [assistant](/docs/api-reference/assistants) used for this run.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunObject/properties/instructions", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) last_error": { "kind": "HttpDeclProperty", - "docstring": "The last error associated with this run. Will be `null` if there are no errors.", + "oasRef": "#/components/schemas/RunObject/properties/last_error", + "deprecated": false, "key": "last_error", - "optional": false, - "nullable": true, + "docstring": "The last error associated with this run. Will be `null` if there are no errors.", "type": { "kind": "HttpTypeObject", "members": [ @@ -21969,8 +21971,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunObject/properties/last_error", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -21980,88 +21982,88 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) max_completion_tokens": { "kind": "HttpDeclProperty", - "docstring": "The maximum number of completion tokens specified to have been used over the course of the run.\n", + "oasRef": "#/components/schemas/RunObject/properties/max_completion_tokens", + "deprecated": false, "key": "max_completion_tokens", - "optional": false, - "nullable": true, + "docstring": "The maximum number of completion tokens specified to have been used over the course of the run.\n", "type": { "kind": "HttpTypeNumber" }, "constraints": { "minimum": 256 }, - "oasRef": "#/components/schemas/RunObject/properties/max_completion_tokens", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) max_prompt_tokens": { "kind": "HttpDeclProperty", - "docstring": "The maximum number of prompt tokens specified to have been used over the course of the run.\n", + "oasRef": "#/components/schemas/RunObject/properties/max_prompt_tokens", + "deprecated": false, "key": "max_prompt_tokens", - "optional": false, - "nullable": true, + "docstring": "The maximum number of prompt tokens specified to have been used over the course of the run.\n", "type": { "kind": "HttpTypeNumber" }, "constraints": { "minimum": 256 }, - "oasRef": "#/components/schemas/RunObject/properties/max_prompt_tokens", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) metadata": { "kind": "HttpDeclProperty", - "docstring": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.\n", + "oasRef": "#/components/schemas/RunObject/properties/metadata", + "deprecated": false, "key": "metadata", - "optional": false, - "nullable": true, + "docstring": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.\n", "type": { "kind": "HttpTypeReference", "ident": "Metadata", "$ref": "(resource) $shared > (model) metadata > (schema)" }, - "oasRef": "#/components/schemas/RunObject/properties/metadata", - "deprecated": false, - "schemaType": "map", + "optional": false, + "nullable": true, "modelImplicit": false, + "schemaType": "map", "modelPath": "(resource) $shared > (model) metadata", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) model": { "kind": "HttpDeclProperty", - "docstring": "The model that the [assistant](/docs/api-reference/assistants) used for this run.", + "oasRef": "#/components/schemas/RunObject/properties/model", + "deprecated": false, "key": "model", - "optional": false, - "nullable": false, + "docstring": "The model that the [assistant](/docs/api-reference/assistants) used for this run.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunObject/properties/model", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) object": { "kind": "HttpDeclProperty", - "docstring": "The object type, which is always `thread.run`.", + "oasRef": "#/components/schemas/RunObject/properties/object", + "deprecated": false, "key": "object", - "optional": false, - "nullable": false, + "docstring": "The object type, which is always `thread.run`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunObject/properties/object", "types": [ { "kind": "HttpTypeLiteral", "literal": "thread.run" } - ], - "oasRef": "#/components/schemas/RunObject/properties/object" + ] }, - "oasRef": "#/components/schemas/RunObject/properties/object", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -22070,25 +22072,25 @@ 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](/docs/guides/function-calling#configuring-parallel-function-calling) during tool use.", + "oasRef": "#/components/schemas/RunObject/properties/parallel_tool_calls", + "deprecated": false, "key": "parallel_tool_calls", - "optional": false, - "nullable": false, - "default": true, + "docstring": "Whether to enable [parallel function calling](/docs/guides/function-calling#configuring-parallel-function-calling) during tool use.", "type": { "kind": "HttpTypeBoolean" }, - "oasRef": "#/components/schemas/RunObject/properties/parallel_tool_calls", - "deprecated": false, + "default": true, + "optional": false, + "nullable": false, "schemaType": "boolean", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) required_action": { "kind": "HttpDeclProperty", - "docstring": "Details on the action required to continue the run. Will be `null` if no action is required.", + "oasRef": "#/components/schemas/RunObject/properties/required_action", + "deprecated": false, "key": "required_action", - "optional": false, - "nullable": true, + "docstring": "Details on the action required to continue the run. Will be `null` if no action is required.", "type": { "kind": "HttpTypeObject", "members": [ @@ -22100,8 +22102,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunObject/properties/required_action", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -22111,19 +22113,19 @@ 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](/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", + "oasRef": "#/components/schemas/RunObject/properties/response_format", + "deprecated": false, "key": "response_format", - "optional": false, - "nullable": true, + "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", "type": { "kind": "HttpTypeReference", "ident": "AssistantResponseFormatOption", "$ref": "(resource) beta.threads > (model) assistant_response_format_option > (schema)" }, - "oasRef": "#/components/schemas/RunObject/properties/response_format", - "deprecated": false, - "schemaType": "union", + "optional": false, + "nullable": true, "modelImplicit": false, + "schemaType": "union", "modelPath": "(resource) beta.threads > (model) assistant_response_format_option", "childrenParentSchema": "union", "children": [ @@ -22135,29 +22137,30 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) started_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the run was started.", + "oasRef": "#/components/schemas/RunObject/properties/started_at", + "deprecated": false, "key": "started_at", - "optional": false, - "nullable": true, + "docstring": "The Unix timestamp (in seconds) for when the run was started.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/RunObject/properties/started_at", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) status": { "kind": "HttpDeclProperty", - "docstring": "The status of the run, which can be either `queued`, `in_progress`, `requires_action`, `cancelling`, `cancelled`, `failed`, `completed`, `incomplete`, or `expired`.", + "oasRef": "#/components/schemas/RunObject/properties/status", + "deprecated": false, "key": "status", - "optional": false, - "nullable": false, + "docstring": "The status of the run, which can be either `queued`, `in_progress`, `requires_action`, `cancelling`, `cancelled`, `failed`, `completed`, `incomplete`, or `expired`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunObject/properties/status", "types": [ { "kind": "HttpTypeLiteral", @@ -22195,11 +22198,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "expired" } - ], - "oasRef": "#/components/schemas/RunObject/properties/status" + ] }, - "oasRef": "#/components/schemas/RunObject/properties/status", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -22216,33 +22218,33 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) thread_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the [thread](/docs/api-reference/threads) that was executed on as a part of this run.", + "oasRef": "#/components/schemas/RunObject/properties/thread_id", + "deprecated": false, "key": "thread_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the [thread](/docs/api-reference/threads) that was executed on as a part of this run.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunObject/properties/thread_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) tool_choice": { "kind": "HttpDeclProperty", - "docstring": "Controls which (if any) tool is called by the model.\n`none` means the model will not call any tools and instead generates a message.\n`auto` is the default value and means the model can pick between generating a message or calling one or more tools.\n`required` means the model must call one or more tools before responding to the user.\nSpecifying a particular tool like `{\"type\": \"file_search\"}` or `{\"type\": \"function\", \"function\": {\"name\": \"my_function\"}}` forces the model to call that tool.\n", + "oasRef": "#/components/schemas/RunObject/properties/tool_choice", + "deprecated": false, "key": "tool_choice", - "optional": false, - "nullable": true, + "docstring": "Controls which (if any) tool is called by the model.\n`none` means the model will not call any tools and instead generates a message.\n`auto` is the default value and means the model can pick between generating a message or calling one or more tools.\n`required` means the model must call one or more tools before responding to the user.\nSpecifying a particular tool like `{\"type\": \"file_search\"}` or `{\"type\": \"function\", \"function\": {\"name\": \"my_function\"}}` forces the model to call that tool.\n", "type": { "kind": "HttpTypeReference", "ident": "AssistantToolChoiceOption", "$ref": "(resource) beta.threads > (model) assistant_tool_choice_option > (schema)" }, - "oasRef": "#/components/schemas/RunObject/properties/tool_choice", - "deprecated": false, - "schemaType": "union", + "optional": false, + "nullable": true, "modelImplicit": false, + "schemaType": "union", "modelPath": "(resource) beta.threads > (model) assistant_tool_choice_option", "childrenParentSchema": "union", "children": [ @@ -22252,15 +22254,16 @@ 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](/docs/api-reference/assistants) used for this run.", + "oasRef": "#/components/schemas/RunObject/properties/tools", + "deprecated": false, "key": "tools", - "optional": false, - "nullable": false, - "default": [], + "docstring": "The list of tools that the [assistant](/docs/api-reference/assistants) used for this run.", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RunObject/properties/tools", "elementType": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunObject/properties/tools/items", "types": [ { "kind": "HttpTypeReference", @@ -22277,13 +22280,12 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "ident": "FunctionTool", "$ref": "(resource) beta.assistants > (model) function_tool > (schema)" } - ], - "oasRef": "#/components/schemas/RunObject/properties/tools/items" - }, - "oasRef": "#/components/schemas/RunObject/properties/tools" + ] + } }, - "oasRef": "#/components/schemas/RunObject/properties/tools", - "deprecated": false, + "default": [], + "optional": false, + "nullable": false, "schemaType": "array", "childrenParentSchema": "union", "children": [ @@ -22294,11 +22296,11 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy": { "kind": "HttpDeclProperty", - "title": "Thread Truncation Controls", - "docstring": "Controls for how a thread will be truncated prior to the run. Use this to control the initial context window of the run.", + "oasRef": "#/components/schemas/RunObject/properties/truncation_strategy", + "deprecated": false, "key": "truncation_strategy", - "optional": false, - "nullable": true, + "docstring": "Controls for how a thread will be truncated prior to the run. Use this to control the initial context window of the run.", + "title": "Thread Truncation Controls", "type": { "kind": "HttpTypeObject", "members": [ @@ -22310,8 +22312,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunObject/properties/truncation_strategy", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -22321,10 +22323,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) usage": { "kind": "HttpDeclProperty", - "docstring": "Usage statistics related to the run. This value will be `null` if the run is not in a terminal state (i.e. `in_progress`, `queued`, etc.).", + "oasRef": "#/components/schemas/RunObject/properties/usage", + "deprecated": false, "key": "usage", - "optional": false, - "nullable": true, + "docstring": "Usage statistics related to the run. This value will be `null` if the run is not in a terminal state (i.e. `in_progress`, `queued`, etc.).", "type": { "kind": "HttpTypeObject", "members": [ @@ -22339,8 +22341,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunObject/properties/usage", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -22351,35 +22353,36 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) temperature": { "kind": "HttpDeclProperty", - "docstring": "The sampling temperature used for this run. If not set, defaults to 1.", + "oasRef": "#/components/schemas/RunObject/properties/temperature", + "deprecated": false, "key": "temperature", - "optional": true, - "nullable": true, + "docstring": "The sampling temperature used for this run. If not set, defaults to 1.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RunObject/properties/temperature", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "number", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) top_p": { "kind": "HttpDeclProperty", - "docstring": "The nucleus sampling value used for this run. If not set, defaults to 1.", + "oasRef": "#/components/schemas/RunObject/properties/top_p", + "deprecated": false, "key": "top_p", - "optional": true, - "nullable": true, + "docstring": "The nucleus sampling value used for this run. If not set, defaults to 1.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RunObject/properties/top_p", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "number", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RunObject", + "docstring": "Represents an execution run on a [thread](/docs/api-reference/threads).", "ident": "Run", "type": { "kind": "HttpTypeObject", @@ -22467,7 +22470,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Represents an execution run on a [thread](/docs/api-reference/threads).", "childrenParentSchema": "object", "children": [ "(resource) beta.threads.runs > (model) run > (schema) > (property) id", @@ -22508,12 +22510,13 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) incomplete_details > (property) reason": { "kind": "HttpDeclProperty", - "docstring": "The reason why the run is incomplete. This will point to which specific token limit was reached over the course of the run.", + "oasRef": "#/components/schemas/RunObject/properties/incomplete_details/properties/reason", + "deprecated": false, "key": "reason", - "optional": true, - "nullable": false, + "docstring": "The reason why the run is incomplete. This will point to which specific token limit was reached over the course of the run.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunObject/properties/incomplete_details/properties/reason", "types": [ { "kind": "HttpTypeLiteral", @@ -22523,11 +22526,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "max_prompt_tokens" } - ], - "oasRef": "#/components/schemas/RunObject/properties/incomplete_details/properties/reason" + ] }, - "oasRef": "#/components/schemas/RunObject/properties/incomplete_details/properties/reason", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -22537,12 +22539,13 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) code": { "kind": "HttpDeclProperty", - "docstring": "One of `server_error`, `rate_limit_exceeded`, or `invalid_prompt`.", + "oasRef": "#/components/schemas/RunObject/properties/last_error/properties/code", + "deprecated": false, "key": "code", - "optional": false, - "nullable": false, + "docstring": "One of `server_error`, `rate_limit_exceeded`, or `invalid_prompt`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunObject/properties/last_error/properties/code", "types": [ { "kind": "HttpTypeLiteral", @@ -22556,11 +22559,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "invalid_prompt" } - ], - "oasRef": "#/components/schemas/RunObject/properties/last_error/properties/code" + ] }, - "oasRef": "#/components/schemas/RunObject/properties/last_error/properties/code", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -22571,24 +22573,26 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) message": { "kind": "HttpDeclProperty", - "docstring": "A human-readable description of the error.", + "oasRef": "#/components/schemas/RunObject/properties/last_error/properties/message", + "deprecated": false, "key": "message", - "optional": false, - "nullable": false, + "docstring": "A human-readable description of the error.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunObject/properties/last_error/properties/message", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) $shared > (model) metadata > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/Metadata", + "docstring": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.\n", "ident": "Metadata", "type": { "kind": "HttpTypeReference", + "oasRef": "#/components/schemas/Metadata", "ident": "Record", "typeParameters": [ { @@ -22597,10 +22601,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch { "kind": "HttpTypeString" } - ], - "oasRef": "#/components/schemas/Metadata" + ] }, - "docstring": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.\n", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) object > (member) 0": { @@ -22612,10 +22614,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) required_action > (property) submit_tool_outputs": { "kind": "HttpDeclProperty", - "docstring": "Details on the tool outputs needed for this run to continue.", + "oasRef": "#/components/schemas/RunObject/properties/required_action/properties/submit_tool_outputs", + "deprecated": false, "key": "submit_tool_outputs", - "optional": false, - "nullable": false, + "docstring": "Details on the tool outputs needed for this run to continue.", "type": { "kind": "HttpTypeObject", "members": [ @@ -22624,8 +22626,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunObject/properties/required_action/properties/submit_tool_outputs", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -22634,22 +22636,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) required_action > (property) type": { "kind": "HttpDeclProperty", - "docstring": "For now, this is always `submit_tool_outputs`.", + "oasRef": "#/components/schemas/RunObject/properties/required_action/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "For now, this is always `submit_tool_outputs`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunObject/properties/required_action/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "submit_tool_outputs" } - ], - "oasRef": "#/components/schemas/RunObject/properties/required_action/properties/type" + ] }, - "oasRef": "#/components/schemas/RunObject/properties/required_action/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -22659,18 +22661,18 @@ 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/oneOf/0", + "docstring": "`auto` is the default value\n", "ident": "UnionMember0", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/oneOf/0", "types": [ { "kind": "HttpTypeLiteral", "literal": "auto" } - ], - "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/oneOf/0" + ] }, - "docstring": "`auto` is the default value\n", "childrenParentSchema": "enum", "children": [ "(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 0 > (member) 0" @@ -22716,19 +22718,21 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads > (model) assistant_response_format_option > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption", + "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", "ident": "AssistantResponseFormatOption", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption", "types": [ { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/oneOf/0", "types": [ { "kind": "HttpTypeLiteral", "literal": "auto" } - ], - "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/oneOf/0" + ] }, { "kind": "HttpTypeReference", @@ -22745,10 +22749,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "ident": "ResponseFormatJSONSchema", "$ref": "(resource) $shared > (model) response_format_json_schema > (schema)" } - ], - "oasRef": "#/components/schemas/AssistantsApiResponseFormatOption" + ] }, - "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", @@ -22823,9 +22825,11 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0": { "kind": "HttpDeclTypeAlias", "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", "ident": "UnionMember0", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption/oneOf/0", "types": [ { "kind": "HttpTypeLiteral", @@ -22839,10 +22843,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "required" } - ], - "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", "children": [ "(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0 > (member) 0", @@ -22866,12 +22868,15 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads > (model) assistant_tool_choice_option > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption", + "docstring": "Controls which (if any) tool is called by the model.\n`none` means the model will not call any tools and instead generates a message.\n`auto` is the default value and means the model can pick between generating a message or calling one or more tools.\n`required` means the model must call one or more tools before responding to the user.\nSpecifying a particular tool like `{\"type\": \"file_search\"}` or `{\"type\": \"function\", \"function\": {\"name\": \"my_function\"}}` forces the model to call that tool.\n", "ident": "AssistantToolChoiceOption", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption", "types": [ { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption/oneOf/0", "types": [ { "kind": "HttpTypeLiteral", @@ -22885,18 +22890,15 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "required" } - ], - "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption/oneOf/0" + ] }, { "kind": "HttpTypeReference", "ident": "AssistantToolChoice", "$ref": "(resource) beta.threads > (model) assistant_tool_choice > (schema)" } - ], - "oasRef": "#/components/schemas/AssistantsApiToolChoiceOption" + ] }, - "docstring": "Controls which (if any) tool is called by the model.\n`none` means the model will not call any tools and instead generates a message.\n`auto` is the default value and means the model can pick between generating a message or calling one or more tools.\n`required` means the model must call one or more tools before responding to the user.\nSpecifying a particular tool like `{\"type\": \"file_search\"}` or `{\"type\": \"function\", \"function\": {\"name\": \"my_function\"}}` forces the model to call that tool.\n", "childrenParentSchema": "union", "children": [ "(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0", @@ -23002,12 +23004,13 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The truncation strategy to use for the thread. The default is `auto`. If set to `last_messages`, the thread will be truncated to the n most recent messages in the thread. When set to `auto`, messages in the middle of the thread will be dropped to fit the context length of the model, `max_prompt_tokens`.", + "oasRef": "#/components/schemas/TruncationObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The truncation strategy to use for the thread. The default is `auto`. If set to `last_messages`, the thread will be truncated to the n most recent messages in the thread. When set to `auto`, messages in the middle of the thread will be dropped to fit the context length of the model, `max_prompt_tokens`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/TruncationObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", @@ -23017,11 +23020,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "last_messages" } - ], - "oasRef": "#/components/schemas/TruncationObject/properties/type" + ] }, - "oasRef": "#/components/schemas/TruncationObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -23031,60 +23033,60 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) last_messages": { "kind": "HttpDeclProperty", - "docstring": "The number of most recent messages from the thread when constructing the context for the run.", + "oasRef": "#/components/schemas/TruncationObject/properties/last_messages", + "deprecated": false, "key": "last_messages", - "optional": true, - "nullable": true, + "docstring": "The number of most recent messages from the thread when constructing the context for the run.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "minimum": 1 }, - "oasRef": "#/components/schemas/TruncationObject/properties/last_messages", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) usage > (property) completion_tokens": { "kind": "HttpDeclProperty", - "docstring": "Number of completion tokens used over the course of the run.", + "oasRef": "#/components/schemas/RunCompletionUsage/anyOf/0/properties/completion_tokens", + "deprecated": false, "key": "completion_tokens", - "optional": false, - "nullable": false, + "docstring": "Number of completion tokens used over the course of the run.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RunCompletionUsage/anyOf/0/properties/completion_tokens", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) usage > (property) prompt_tokens": { "kind": "HttpDeclProperty", - "docstring": "Number of prompt tokens used over the course of the run.", + "oasRef": "#/components/schemas/RunCompletionUsage/anyOf/0/properties/prompt_tokens", + "deprecated": false, "key": "prompt_tokens", - "optional": false, - "nullable": false, + "docstring": "Number of prompt tokens used over the course of the run.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RunCompletionUsage/anyOf/0/properties/prompt_tokens", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs > (model) run > (schema) > (property) usage > (property) total_tokens": { "kind": "HttpDeclProperty", - "docstring": "Total number of tokens used (prompt + completion).", + "oasRef": "#/components/schemas/RunCompletionUsage/anyOf/0/properties/total_tokens", + "deprecated": false, "key": "total_tokens", - "optional": false, - "nullable": false, + "docstring": "Total number of tokens used (prompt + completion).", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RunCompletionUsage/anyOf/0/properties/total_tokens", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, @@ -23125,21 +23127,21 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) run > (schema) > (property) required_action > (property) submit_tool_outputs > (property) tool_calls": { "kind": "HttpDeclProperty", - "docstring": "A list of the relevant tool calls.", + "oasRef": "#/components/schemas/RunObject/properties/required_action/properties/submit_tool_outputs/properties/tool_calls", + "deprecated": false, "key": "tool_calls", - "optional": false, - "nullable": false, + "docstring": "A list of the relevant tool calls.", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RunObject/properties/required_action/properties/submit_tool_outputs/properties/tool_calls", "elementType": { "kind": "HttpTypeReference", "ident": "RequiredActionFunctionToolCall", "$ref": "(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema)" + } }, - "oasRef": "#/components/schemas/RunObject/properties/required_action/properties/submit_tool_outputs/properties/tool_calls" - }, - "oasRef": "#/components/schemas/RunObject/properties/required_action/properties/submit_tool_outputs/properties/tool_calls", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "array", "childrenParentSchema": "object", "children": [ @@ -23164,22 +23166,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) $shared > (model) response_format_text > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of response format being defined. Always `text`.", + "oasRef": "#/components/schemas/ResponseFormatText/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of response format being defined. Always `text`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/ResponseFormatText/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "text" } - ], - "oasRef": "#/components/schemas/ResponseFormatText/properties/type" + ] }, - "oasRef": "#/components/schemas/ResponseFormatText/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -23189,6 +23191,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) $shared > (model) response_format_text > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/ResponseFormatText", + "docstring": "Default response format. Used to generate text responses.\n", "ident": "ResponseFormatText", "type": { "kind": "HttpTypeObject", @@ -23198,7 +23201,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Default response format. Used to generate text responses.\n", "childrenParentSchema": "object", "children": [ "(resource) $shared > (model) response_format_text > (schema) > (property) type" @@ -23206,22 +23208,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) $shared > (model) response_format_json_object > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of response format being defined. Always `json_object`.", + "oasRef": "#/components/schemas/ResponseFormatJsonObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of response format being defined. Always `json_object`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/ResponseFormatJsonObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "json_object" } - ], - "oasRef": "#/components/schemas/ResponseFormatJsonObject/properties/type" + ] }, - "oasRef": "#/components/schemas/ResponseFormatJsonObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -23231,6 +23233,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) $shared > (model) response_format_json_object > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/ResponseFormatJsonObject", + "docstring": "JSON object response format. An older method of generating JSON responses.\nUsing `json_schema` is recommended for models that support it. Note that the\nmodel will not generate JSON without a system or user message instructing it\nto do so.\n", "ident": "ResponseFormatJSONObject", "type": { "kind": "HttpTypeObject", @@ -23240,7 +23243,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "JSON object response format. An older method of generating JSON responses.\nUsing `json_schema` is recommended for models that support it. Note that the\nmodel will not generate JSON without a system or user message instructing it\nto do so.\n", "childrenParentSchema": "object", "children": [ "(resource) $shared > (model) response_format_json_object > (schema) > (property) type" @@ -23248,11 +23250,11 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema": { "kind": "HttpDeclProperty", - "title": "JSON schema", - "docstring": "Structured Outputs configuration options, including a JSON Schema.\n", + "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema", + "deprecated": false, "key": "json_schema", - "optional": false, - "nullable": false, + "docstring": "Structured Outputs configuration options, including a JSON Schema.\n", + "title": "JSON schema", "type": { "kind": "HttpTypeObject", "members": [ @@ -23270,8 +23272,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -23283,22 +23285,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) $shared > (model) response_format_json_schema > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of response format being defined. Always `json_schema`.", + "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of response format being defined. Always `json_schema`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "json_schema" } - ], - "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/type" + ] }, - "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -23308,6 +23310,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) $shared > (model) response_format_json_schema > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/ResponseFormatJsonSchema", + "docstring": "JSON Schema response format. Used to generate structured JSON responses.\nLearn more about [Structured Outputs](/docs/guides/structured-outputs).\n", "ident": "ResponseFormatJSONSchema", "type": { "kind": "HttpTypeObject", @@ -23320,7 +23323,6 @@ 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](/docs/guides/structured-outputs).\n", "childrenParentSchema": "object", "children": [ "(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema", @@ -23350,12 +23352,13 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the tool. If type is `function`, the function name must be set", + "oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the tool. If type is `function`, the function name must be set", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/type", "types": [ { "kind": "HttpTypeLiteral", @@ -23369,11 +23372,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "file_search" } - ], - "oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/type" + ] }, - "oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -23384,18 +23386,18 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) function": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/function", + "deprecated": false, "key": "function", - "optional": true, - "nullable": false, "type": { "kind": "HttpTypeReference", "ident": "AssistantToolChoiceFunction", "$ref": "(resource) beta.threads > (model) assistant_tool_choice_function > (schema)" }, - "oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/function", - "deprecated": false, - "schemaType": "object", + "optional": true, + "nullable": false, "modelImplicit": false, + "schemaType": "object", "modelPath": "(resource) beta.threads > (model) assistant_tool_choice_function", "childrenParentSchema": "object", "children": [ @@ -23405,6 +23407,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads > (model) assistant_tool_choice > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/AssistantsNamedToolChoice", + "docstring": "Specifies a tool the model should use. Use to force the model to call a specific tool.", "ident": "AssistantToolChoice", "type": { "kind": "HttpTypeObject", @@ -23417,7 +23420,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Specifies a tool the model should use. Use to force the model to call a specific tool.", "childrenParentSchema": "object", "children": [ "(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) type", @@ -23426,22 +23428,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of tool being defined: `code_interpreter`", + "oasRef": "#/components/schemas/AssistantToolsCode/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of tool being defined: `code_interpreter`", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantToolsCode/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "code_interpreter" } - ], - "oasRef": "#/components/schemas/AssistantToolsCode/properties/type" + ] }, - "oasRef": "#/components/schemas/AssistantToolsCode/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -23450,22 +23452,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of tool being defined: `file_search`", + "oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of tool being defined: `file_search`", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "file_search" } - ], - "oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/type" + ] }, - "oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -23474,10 +23476,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search": { "kind": "HttpDeclProperty", - "docstring": "Overrides for the file search tool.", + "oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/file_search", + "deprecated": false, "key": "file_search", - "optional": true, - "nullable": false, + "docstring": "Overrides for the file search tool.", "type": { "kind": "HttpTypeObject", "members": [ @@ -23489,8 +23491,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/file_search", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -23500,18 +23502,18 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) function_tool > (schema) > (property) function": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/AssistantToolsFunction/properties/function", + "deprecated": false, "key": "function", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeReference", "ident": "FunctionDefinition", "$ref": "(resource) $shared > (model) function_definition > (schema)" }, - "oasRef": "#/components/schemas/AssistantToolsFunction/properties/function", - "deprecated": false, - "schemaType": "object", + "optional": false, + "nullable": false, "modelImplicit": false, + "schemaType": "object", "modelPath": "(resource) $shared > (model) function_definition", "childrenParentSchema": "object", "children": [ @@ -23523,22 +23525,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) function_tool > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of tool being defined: `function`", + "oasRef": "#/components/schemas/AssistantToolsFunction/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of tool being defined: `function`", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantToolsFunction/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "function" } - ], - "oasRef": "#/components/schemas/AssistantToolsFunction/properties/type" + ] }, - "oasRef": "#/components/schemas/AssistantToolsFunction/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -23561,24 +23563,24 @@ 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](/docs/api-reference/runs/submitToolOutputs) endpoint.", + "oasRef": "#/components/schemas/RunToolCallObject/properties/id", + "deprecated": false, "key": "id", - "optional": false, - "nullable": false, + "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.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunToolCallObject/properties/id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) function": { "kind": "HttpDeclProperty", - "docstring": "The function definition.", + "oasRef": "#/components/schemas/RunToolCallObject/properties/function", + "deprecated": false, "key": "function", - "optional": false, - "nullable": false, + "docstring": "The function definition.", "type": { "kind": "HttpTypeObject", "members": [ @@ -23590,8 +23592,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunToolCallObject/properties/function", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -23601,22 +23603,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of tool call the output is required for. For now, this is always `function`.", + "oasRef": "#/components/schemas/RunToolCallObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of tool call the output is required for. For now, this is always `function`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunToolCallObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "function" } - ], - "oasRef": "#/components/schemas/RunToolCallObject/properties/type" + ] }, - "oasRef": "#/components/schemas/RunToolCallObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -23626,6 +23628,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RunToolCallObject", + "docstring": "Tool call objects", "ident": "RequiredActionFunctionToolCall", "type": { "kind": "HttpTypeObject", @@ -23641,7 +23644,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Tool call objects", "childrenParentSchema": "object", "children": [ "(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) id", @@ -23665,41 +23667,42 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the response format. Must be a-z, A-Z, 0-9, or contain\nunderscores and dashes, with a maximum length of 64.\n", + "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/name", + "deprecated": false, "key": "name", - "optional": false, - "nullable": false, + "docstring": "The name of the response format. Must be a-z, A-Z, 0-9, or contain\nunderscores and dashes, with a maximum length of 64.\n", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/name", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema > (property) description": { "kind": "HttpDeclProperty", - "docstring": "A description of what the response format is for, used by the model to\ndetermine how to respond in the format.\n", + "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/description", + "deprecated": false, "key": "description", - "optional": true, - "nullable": false, + "docstring": "A description of what the response format is for, used by the model to\ndetermine how to respond in the format.\n", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/description", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema > (property) schema": { "kind": "HttpDeclProperty", - "title": "JSON schema", - "docstring": "The schema for the response format, described as a JSON Schema object.\nLearn how to build JSON schemas [here](https://json-schema.org/).\n", + "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/schema", + "deprecated": false, "key": "schema", - "optional": true, - "nullable": false, + "docstring": "The schema for the response format, described as a JSON Schema object.\nLearn how to build JSON schemas [here](https://json-schema.org/).\n", + "title": "JSON schema", "type": { "kind": "HttpTypeReference", + "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/schema", "ident": "Record", "typeParameters": [ { @@ -23708,26 +23711,25 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch { "kind": "HttpTypeUnknown" } - ], - "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/schema" + ] }, - "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/schema", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "map", "children": [] }, "(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](/docs/guides/structured-outputs).\n", + "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/strict", + "deprecated": false, "key": "strict", - "optional": true, - "nullable": true, - "default": false, + "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", "type": { "kind": "HttpTypeBoolean" }, - "oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/strict", - "deprecated": false, + "default": false, + "optional": true, + "nullable": true, "schemaType": "boolean", "children": [] }, @@ -23761,15 +23763,15 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads > (model) assistant_tool_choice_function > (schema) > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the function to call.", + "oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/function/properties/name", + "deprecated": false, "key": "name", - "optional": false, - "nullable": false, + "docstring": "The name of the function to call.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/function/properties/name", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, @@ -23806,10 +23808,10 @@ 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](/docs/assistants/tools/file-search#customizing-file-search-settings) for more information.\n", + "oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/file_search/properties/max_num_results", + "deprecated": false, "key": "max_num_results", - "optional": true, - "nullable": false, + "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", "type": { "kind": "HttpTypeNumber" }, @@ -23817,18 +23819,18 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "minimum": 1, "maximum": 50 }, - "oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/file_search/properties/max_num_results", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "integer", "children": [] }, "(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](/docs/assistants/tools/file-search#customizing-file-search-settings) for more information.\n", + "oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/file_search/properties/ranking_options", + "deprecated": false, "key": "ranking_options", - "optional": true, - "nullable": false, + "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", + "title": "File search tool call ranking options", "type": { "kind": "HttpTypeObject", "members": [ @@ -23840,8 +23842,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/file_search/properties/ranking_options", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -23851,62 +23853,62 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) $shared > (model) function_definition > (schema) > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.", + "oasRef": "#/components/schemas/FunctionObject/properties/name", + "deprecated": false, "key": "name", - "optional": false, - "nullable": false, + "docstring": "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/FunctionObject/properties/name", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) $shared > (model) function_definition > (schema) > (property) description": { "kind": "HttpDeclProperty", - "docstring": "A description of what the function does, used by the model to choose when and how to call the function.", + "oasRef": "#/components/schemas/FunctionObject/properties/description", + "deprecated": false, "key": "description", - "optional": true, - "nullable": false, + "docstring": "A description of what the function does, used by the model to choose when and how to call the function.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/FunctionObject/properties/description", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(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](/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.", + "oasRef": "#/components/schemas/FunctionObject/properties/parameters", + "deprecated": false, "key": "parameters", - "optional": true, - "nullable": false, + "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.", "type": { "kind": "HttpTypeReference", "ident": "FunctionParameters", "$ref": "(resource) $shared > (model) function_parameters > (schema)" }, - "oasRef": "#/components/schemas/FunctionObject/properties/parameters", - "deprecated": false, - "schemaType": "map", + "optional": true, + "nullable": false, "modelImplicit": false, + "schemaType": "map", "modelPath": "(resource) $shared > (model) function_parameters", "children": [] }, "(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](/docs/guides/function-calling).", + "oasRef": "#/components/schemas/FunctionObject/properties/strict", + "deprecated": false, "key": "strict", - "optional": true, - "nullable": true, - "default": false, + "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).", "type": { "kind": "HttpTypeBoolean" }, - "oasRef": "#/components/schemas/FunctionObject/properties/strict", - "deprecated": false, + "default": false, + "optional": true, + "nullable": true, "schemaType": "boolean", "children": [] }, @@ -23948,29 +23950,29 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) function > (property) arguments": { "kind": "HttpDeclProperty", - "docstring": "The arguments that the model expects you to pass to the function.", + "oasRef": "#/components/schemas/RunToolCallObject/properties/function/properties/arguments", + "deprecated": false, "key": "arguments", - "optional": false, - "nullable": false, + "docstring": "The arguments that the model expects you to pass to the function.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunToolCallObject/properties/function/properties/arguments", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) function > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the function.", + "oasRef": "#/components/schemas/RunToolCallObject/properties/function/properties/name", + "deprecated": false, "key": "name", - "optional": false, - "nullable": false, + "docstring": "The name of the function.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunToolCallObject/properties/function/properties/name", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, @@ -23983,10 +23985,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options > (property) score_threshold": { "kind": "HttpDeclProperty", - "docstring": "The score threshold for the file search. All values must be a floating point number between 0 and 1.", + "oasRef": "#/components/schemas/FileSearchRankingOptions/properties/score_threshold", + "deprecated": false, "key": "score_threshold", - "optional": false, - "nullable": false, + "docstring": "The score threshold for the file search. All values must be a floating point number between 0 and 1.", "type": { "kind": "HttpTypeNumber" }, @@ -23994,19 +23996,20 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "minimum": 0, "maximum": 1 }, - "oasRef": "#/components/schemas/FileSearchRankingOptions/properties/score_threshold", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "number", "children": [] }, "(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options > (property) ranker": { "kind": "HttpDeclProperty", - "docstring": "The ranker to use for the file search. If not specified will use the `auto` ranker.", + "oasRef": "#/components/schemas/FileSearchRankingOptions/properties/ranker", + "deprecated": false, "key": "ranker", - "optional": true, - "nullable": false, + "docstring": "The ranker to use for the file search. If not specified will use the `auto` ranker.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/FileSearchRankingOptions/properties/ranker", "types": [ { "kind": "HttpTypeLiteral", @@ -24016,11 +24019,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "default_2024_08_21" } - ], - "oasRef": "#/components/schemas/FileSearchRankingOptions/properties/ranker" + ] }, - "oasRef": "#/components/schemas/FileSearchRankingOptions/properties/ranker", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -24031,9 +24033,11 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) $shared > (model) function_parameters > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/FunctionParameters", + "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.", "ident": "FunctionParameters", "type": { "kind": "HttpTypeReference", + "oasRef": "#/components/schemas/FunctionParameters", "ident": "Record", "typeParameters": [ { @@ -24042,10 +24046,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch { "kind": "HttpTypeUnknown" } - ], - "oasRef": "#/components/schemas/FunctionParameters" + ] }, - "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": { @@ -24084,7 +24086,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/oneOf/0", - "ident": "UnionMember11", + "docstring": "Occurs when a [run step](/docs/api-reference/run-steps/step-object) is created.", + "ident": "ThreadRunStepCreated", "type": { "kind": "HttpTypeObject", "members": [ @@ -24096,7 +24099,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "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", @@ -24105,20 +24107,20 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 11 > (property) data": { "kind": "HttpDeclProperty", - "title": "Run steps", - "docstring": "Represents a step in execution of a run.\n", + "oasRef": "#/components/schemas/RunStepStreamEvent/oneOf/0/properties/data", + "deprecated": false, "key": "data", - "optional": false, - "nullable": false, + "docstring": "Represents a step in execution of a run.\n", + "title": "Run steps", "type": { "kind": "HttpTypeReference", "ident": "RunStep", "$ref": "(resource) beta.threads.runs.steps > (model) run_step > (schema)" }, - "oasRef": "#/components/schemas/RunStepStreamEvent/oneOf/0/properties/data", - "deprecated": false, - "schemaType": "object", + "optional": false, + "nullable": false, "modelImplicit": false, + "schemaType": "object", "modelPath": "(resource) beta.threads.runs.steps > (model) run_step", "childrenParentSchema": "object", "children": [ @@ -24142,21 +24144,21 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 11 > (property) event": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RunStepStreamEvent/oneOf/0/properties/event", + "deprecated": false, "key": "event", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepStreamEvent/oneOf/0/properties/event", "types": [ { "kind": "HttpTypeLiteral", "literal": "thread.run.step.created" } - ], - "oasRef": "#/components/schemas/RunStepStreamEvent/oneOf/0/properties/event" + ] }, - "oasRef": "#/components/schemas/RunStepStreamEvent/oneOf/0/properties/event", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -24165,123 +24167,123 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The identifier of the run step, which can be referenced in API endpoints.", + "oasRef": "#/components/schemas/RunStepObject/properties/id", + "deprecated": false, "key": "id", - "optional": false, - "nullable": false, + "docstring": "The identifier of the run step, which can be referenced in API endpoints.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepObject/properties/id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) assistant_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the [assistant](/docs/api-reference/assistants) associated with the run step.", + "oasRef": "#/components/schemas/RunStepObject/properties/assistant_id", + "deprecated": false, "key": "assistant_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the [assistant](/docs/api-reference/assistants) associated with the run step.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepObject/properties/assistant_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) cancelled_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the run step was cancelled.", + "oasRef": "#/components/schemas/RunStepObject/properties/cancelled_at", + "deprecated": false, "key": "cancelled_at", - "optional": false, - "nullable": true, + "docstring": "The Unix timestamp (in seconds) for when the run step was cancelled.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/RunStepObject/properties/cancelled_at", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) completed_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the run step completed.", + "oasRef": "#/components/schemas/RunStepObject/properties/completed_at", + "deprecated": false, "key": "completed_at", - "optional": false, - "nullable": true, + "docstring": "The Unix timestamp (in seconds) for when the run step completed.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/RunStepObject/properties/completed_at", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) created_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the run step was created.", + "oasRef": "#/components/schemas/RunStepObject/properties/created_at", + "deprecated": false, "key": "created_at", - "optional": false, - "nullable": false, + "docstring": "The Unix timestamp (in seconds) for when the run step was created.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/RunStepObject/properties/created_at", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) expired_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the run step expired. A step is considered expired if the parent run is expired.", + "oasRef": "#/components/schemas/RunStepObject/properties/expired_at", + "deprecated": false, "key": "expired_at", - "optional": false, - "nullable": true, + "docstring": "The Unix timestamp (in seconds) for when the run step expired. A step is considered expired if the parent run is expired.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/RunStepObject/properties/expired_at", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) failed_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the run step failed.", + "oasRef": "#/components/schemas/RunStepObject/properties/failed_at", + "deprecated": false, "key": "failed_at", - "optional": false, - "nullable": true, + "docstring": "The Unix timestamp (in seconds) for when the run step failed.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/RunStepObject/properties/failed_at", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) last_error": { "kind": "HttpDeclProperty", - "docstring": "The last error associated with this run step. Will be `null` if there are no errors.", + "oasRef": "#/components/schemas/RunStepObject/properties/last_error", + "deprecated": false, "key": "last_error", - "optional": false, - "nullable": true, + "docstring": "The last error associated with this run step. Will be `null` if there are no errors.", "type": { "kind": "HttpTypeObject", "members": [ @@ -24293,8 +24295,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunStepObject/properties/last_error", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -24304,40 +24306,40 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) metadata": { "kind": "HttpDeclProperty", - "docstring": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.\n", + "oasRef": "#/components/schemas/RunStepObject/properties/metadata", + "deprecated": false, "key": "metadata", - "optional": false, - "nullable": true, + "docstring": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.\n", "type": { "kind": "HttpTypeReference", "ident": "Metadata", "$ref": "(resource) $shared > (model) metadata > (schema)" }, - "oasRef": "#/components/schemas/RunStepObject/properties/metadata", - "deprecated": false, - "schemaType": "map", + "optional": false, + "nullable": true, "modelImplicit": false, + "schemaType": "map", "modelPath": "(resource) $shared > (model) metadata", "children": [] }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) object": { "kind": "HttpDeclProperty", - "docstring": "The object type, which is always `thread.run.step`.", + "oasRef": "#/components/schemas/RunStepObject/properties/object", + "deprecated": false, "key": "object", - "optional": false, - "nullable": false, + "docstring": "The object type, which is always `thread.run.step`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepObject/properties/object", "types": [ { "kind": "HttpTypeLiteral", "literal": "thread.run.step" } - ], - "oasRef": "#/components/schemas/RunStepObject/properties/object" + ] }, - "oasRef": "#/components/schemas/RunStepObject/properties/object", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -24346,26 +24348,27 @@ 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](/docs/api-reference/runs) that this run step is a part of.", + "oasRef": "#/components/schemas/RunStepObject/properties/run_id", + "deprecated": false, "key": "run_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the [run](/docs/api-reference/runs) that this run step is a part of.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepObject/properties/run_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) status": { "kind": "HttpDeclProperty", - "docstring": "The status of the run step, which can be either `in_progress`, `cancelled`, `failed`, `completed`, or `expired`.", + "oasRef": "#/components/schemas/RunStepObject/properties/status", + "deprecated": false, "key": "status", - "optional": false, - "nullable": false, + "docstring": "The status of the run step, which can be either `in_progress`, `cancelled`, `failed`, `completed`, or `expired`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepObject/properties/status", "types": [ { "kind": "HttpTypeLiteral", @@ -24387,11 +24390,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "expired" } - ], - "oasRef": "#/components/schemas/RunStepObject/properties/status" + ] }, - "oasRef": "#/components/schemas/RunStepObject/properties/status", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -24404,12 +24406,13 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) step_details": { "kind": "HttpDeclProperty", - "docstring": "The details of the run step.", + "oasRef": "#/components/schemas/RunStepObject/properties/step_details", + "deprecated": false, "key": "step_details", - "optional": false, - "nullable": false, + "docstring": "The details of the run step.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepObject/properties/step_details", "types": [ { "kind": "HttpTypeReference", @@ -24421,11 +24424,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "ident": "ToolCallsStepDetails", "$ref": "(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema)" } - ], - "oasRef": "#/components/schemas/RunStepObject/properties/step_details" + ] }, - "oasRef": "#/components/schemas/RunStepObject/properties/step_details", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "union", "childrenParentSchema": "union", "children": [ @@ -24435,26 +24437,27 @@ 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](/docs/api-reference/threads) that was run.", + "oasRef": "#/components/schemas/RunStepObject/properties/thread_id", + "deprecated": false, "key": "thread_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the [thread](/docs/api-reference/threads) that was run.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepObject/properties/thread_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of run step, which can be either `message_creation` or `tool_calls`.", + "oasRef": "#/components/schemas/RunStepObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of run step, which can be either `message_creation` or `tool_calls`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", @@ -24464,11 +24467,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "tool_calls" } - ], - "oasRef": "#/components/schemas/RunStepObject/properties/type" + ] }, - "oasRef": "#/components/schemas/RunStepObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -24478,10 +24480,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) usage": { "kind": "HttpDeclProperty", - "docstring": "Usage statistics related to the run step. This value will be `null` while the run step's status is `in_progress`.", + "oasRef": "#/components/schemas/RunStepObject/properties/usage", + "deprecated": false, "key": "usage", - "optional": false, - "nullable": true, + "docstring": "Usage statistics related to the run step. This value will be `null` while the run step's status is `in_progress`.", "type": { "kind": "HttpTypeObject", "members": [ @@ -24496,8 +24498,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunStepObject/properties/usage", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -24509,6 +24511,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.runs.steps > (model) run_step > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RunStepObject", + "docstring": "Represents a step in execution of a run.\n", "ident": "RunStep", "type": { "kind": "HttpTypeObject", @@ -24563,7 +24566,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Represents a step in execution of a run.\n", "childrenParentSchema": "object", "children": [ "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) id", @@ -24593,12 +24595,13 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) last_error > (property) code": { "kind": "HttpDeclProperty", - "docstring": "One of `server_error` or `rate_limit_exceeded`.", + "oasRef": "#/components/schemas/RunStepObject/properties/last_error/anyOf/0/properties/code", + "deprecated": false, "key": "code", - "optional": false, - "nullable": false, + "docstring": "One of `server_error` or `rate_limit_exceeded`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepObject/properties/last_error/anyOf/0/properties/code", "types": [ { "kind": "HttpTypeLiteral", @@ -24608,11 +24611,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "rate_limit_exceeded" } - ], - "oasRef": "#/components/schemas/RunStepObject/properties/last_error/anyOf/0/properties/code" + ] }, - "oasRef": "#/components/schemas/RunStepObject/properties/last_error/anyOf/0/properties/code", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -24622,24 +24624,26 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) last_error > (property) message": { "kind": "HttpDeclProperty", - "docstring": "A human-readable description of the error.", + "oasRef": "#/components/schemas/RunStepObject/properties/last_error/anyOf/0/properties/message", + "deprecated": false, "key": "message", - "optional": false, - "nullable": false, + "docstring": "A human-readable description of the error.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepObject/properties/last_error/anyOf/0/properties/message", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) $shared > (model) metadata > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/Metadata", + "docstring": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.\n", "ident": "Metadata", "type": { "kind": "HttpTypeReference", + "oasRef": "#/components/schemas/Metadata", "ident": "Record", "typeParameters": [ { @@ -24648,10 +24652,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch { "kind": "HttpTypeString" } - ], - "oasRef": "#/components/schemas/Metadata" + ] }, - "docstring": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.\n", "children": [] }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) object > (member) 0": { @@ -24725,6 +24727,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.runs.steps > (model) message_creation_step_details > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RunStepDetailsMessageCreationObject", + "docstring": "Details of the message creation by the run step.", "ident": "MessageCreationStepDetails", "type": { "kind": "HttpTypeObject", @@ -24737,7 +24740,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Details of the message creation by the run step.", "childrenParentSchema": "object", "children": [ "(resource) beta.threads.runs.steps > (model) message_creation_step_details > (schema) > (property) message_creation", @@ -24747,6 +24749,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RunStepDetailsToolCallsObject", + "docstring": "Details of the tool call.", "ident": "ToolCallsStepDetails", "type": { "kind": "HttpTypeObject", @@ -24759,7 +24762,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Details of the tool call.", "childrenParentSchema": "object", "children": [ "(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) tool_calls", @@ -24782,43 +24784,43 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) usage > (property) completion_tokens": { "kind": "HttpDeclProperty", - "docstring": "Number of completion tokens used over the course of the run step.", + "oasRef": "#/components/schemas/RunStepCompletionUsage/anyOf/0/properties/completion_tokens", + "deprecated": false, "key": "completion_tokens", - "optional": false, - "nullable": false, + "docstring": "Number of completion tokens used over the course of the run step.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RunStepCompletionUsage/anyOf/0/properties/completion_tokens", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) usage > (property) prompt_tokens": { "kind": "HttpDeclProperty", - "docstring": "Number of prompt tokens used over the course of the run step.", + "oasRef": "#/components/schemas/RunStepCompletionUsage/anyOf/0/properties/prompt_tokens", + "deprecated": false, "key": "prompt_tokens", - "optional": false, - "nullable": false, + "docstring": "Number of prompt tokens used over the course of the run step.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RunStepCompletionUsage/anyOf/0/properties/prompt_tokens", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) usage > (property) total_tokens": { "kind": "HttpDeclProperty", - "docstring": "Total number of tokens used (prompt + completion).", + "oasRef": "#/components/schemas/RunStepCompletionUsage/anyOf/0/properties/total_tokens", + "deprecated": false, "key": "total_tokens", - "optional": false, - "nullable": false, + "docstring": "Total number of tokens used (prompt + completion).", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RunStepCompletionUsage/anyOf/0/properties/total_tokens", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, @@ -24838,9 +24840,9 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) message_creation_step_details > (schema) > (property) message_creation": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RunStepDetailsMessageCreationObject/properties/message_creation", + "deprecated": false, "key": "message_creation", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeObject", "members": [ @@ -24849,8 +24851,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunStepDetailsMessageCreationObject/properties/message_creation", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -24859,22 +24861,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) message_creation_step_details > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "Always `message_creation`.", + "oasRef": "#/components/schemas/RunStepDetailsMessageCreationObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "Always `message_creation`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepDetailsMessageCreationObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "message_creation" } - ], - "oasRef": "#/components/schemas/RunStepDetailsMessageCreationObject/properties/type" + ] }, - "oasRef": "#/components/schemas/RunStepDetailsMessageCreationObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -24883,14 +24885,16 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) tool_calls": { "kind": "HttpDeclProperty", - "docstring": "An array of tool calls the run step was involved in. These can be associated with one of three types of tools: `code_interpreter`, `file_search`, or `function`.\n", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsObject/properties/tool_calls", + "deprecated": false, "key": "tool_calls", - "optional": false, - "nullable": false, + "docstring": "An array of tool calls the run step was involved in. These can be associated with one of three types of tools: `code_interpreter`, `file_search`, or `function`.\n", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsObject/properties/tool_calls", "elementType": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsObject/properties/tool_calls/items", "types": [ { "kind": "HttpTypeReference", @@ -24907,13 +24911,11 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "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" + ] + } }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsObject/properties/tool_calls", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "array", "childrenParentSchema": "union", "children": [ @@ -24924,22 +24926,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "Always `tool_calls`.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "Always `tool_calls`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "tool_calls" } - ], - "oasRef": "#/components/schemas/RunStepDetailsToolCallsObject/properties/type" + ] }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -24948,15 +24950,15 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) message_creation_step_details > (schema) > (property) message_creation > (property) message_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the message that was created by this run step.", + "oasRef": "#/components/schemas/RunStepDetailsMessageCreationObject/properties/message_creation/properties/message_id", + "deprecated": false, "key": "message_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the message that was created by this run step.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepDetailsMessageCreationObject/properties/message_creation/properties/message_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, @@ -25012,6 +25014,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject", + "docstring": "Details of the Code Interpreter tool call the run step was involved in.", "ident": "CodeInterpreterToolCall", "type": { "kind": "HttpTypeObject", @@ -25027,7 +25030,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "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", @@ -25094,24 +25096,24 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the tool call.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/id", + "deprecated": false, "key": "id", - "optional": false, - "nullable": false, + "docstring": "The ID of the tool call.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/id", - "deprecated": false, + "optional": false, + "nullable": 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.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter", + "deprecated": false, "key": "code_interpreter", - "optional": false, - "nullable": false, + "docstring": "The Code Interpreter tool call definition.", "type": { "kind": "HttpTypeObject", "members": [ @@ -25123,8 +25125,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -25134,22 +25136,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(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.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of tool call. This is always going to be `code_interpreter` for this type of tool call.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "code_interpreter" } - ], - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/type" + ] }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -25158,24 +25160,24 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the tool call object.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/id", + "deprecated": false, "key": "id", - "optional": false, - "nullable": false, + "docstring": "The ID of the tool call object.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/id", - "deprecated": false, + "optional": false, + "nullable": 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.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/file_search", + "deprecated": false, "key": "file_search", - "optional": false, - "nullable": false, + "docstring": "For now, this is always going to be an empty object.", "type": { "kind": "HttpTypeObject", "members": [ @@ -25187,8 +25189,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/file_search", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -25198,22 +25200,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(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.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of tool call. This is always going to be `file_search` for this type of tool call.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "file_search" } - ], - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/type" + ] }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -25222,24 +25224,24 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the tool call object.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/id", + "deprecated": false, "key": "id", - "optional": false, - "nullable": false, + "docstring": "The ID of the tool call object.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/id", - "deprecated": false, + "optional": false, + "nullable": 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.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/function", + "deprecated": false, "key": "function", - "optional": false, - "nullable": false, + "docstring": "The definition of the function that was called.", "type": { "kind": "HttpTypeObject", "members": [ @@ -25254,8 +25256,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/function", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -25266,22 +25268,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(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.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of tool call. This is always going to be `function` for this type of tool call.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "function" } - ], - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/type" + ] }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -25290,28 +25292,30 @@ 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) input": { "kind": "HttpDeclProperty", - "docstring": "The input to the Code Interpreter tool call.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter/properties/input", + "deprecated": false, "key": "input", - "optional": false, - "nullable": false, + "docstring": "The input to the Code Interpreter tool call.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter/properties/input", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs": { "kind": "HttpDeclProperty", - "docstring": "The outputs from the Code Interpreter tool call. Code Interpreter can output one or more items, including text (`logs`) or images (`image`). Each of these are represented by a different object type.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter/properties/outputs", + "deprecated": false, "key": "outputs", - "optional": false, - "nullable": false, + "docstring": "The outputs from the Code Interpreter tool call. Code Interpreter can output one or more items, including text (`logs`) or images (`image`). Each of these are represented by a different object type.", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter/properties/outputs", "elementType": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter/properties/outputs/items", "types": [ { "kind": "HttpTypeObject", @@ -25335,13 +25339,11 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] } - ], - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter/properties/outputs/items" - }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter/properties/outputs" + ] + } }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter/properties/outputs", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "array", "childrenParentSchema": "union", "children": [ @@ -25358,11 +25360,11 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) ranking_options": { "kind": "HttpDeclProperty", - "title": "File search tool call ranking options", - "docstring": "The ranking options for the file search.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/file_search/properties/ranking_options", + "deprecated": false, "key": "ranking_options", - "optional": true, - "nullable": false, + "docstring": "The ranking options for the file search.", + "title": "File search tool call ranking options", "type": { "kind": "HttpTypeObject", "members": [ @@ -25374,8 +25376,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/file_search/properties/ranking_options", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -25385,12 +25387,13 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) results": { "kind": "HttpDeclProperty", - "docstring": "The results of the file search.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/file_search/properties/results", + "deprecated": false, "key": "results", - "optional": true, - "nullable": false, + "docstring": "The results of the file search.", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/file_search/properties/results", "elementType": { "kind": "HttpTypeObject", "members": [ @@ -25407,11 +25410,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "ident": "content" } ] + } }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/file_search/properties/results" - }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/file_search/properties/results", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "array", "childrenParentSchema": "object", "children": [ @@ -25430,43 +25432,43 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) function > (property) arguments": { "kind": "HttpDeclProperty", - "docstring": "The arguments passed to the function.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/function/properties/arguments", + "deprecated": false, "key": "arguments", - "optional": false, - "nullable": false, + "docstring": "The arguments passed to the function.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/function/properties/arguments", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) function > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the function.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/function/properties/name", + "deprecated": false, "key": "name", - "optional": false, - "nullable": false, + "docstring": "The name of the function.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/function/properties/name", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(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](/docs/api-reference/runs/submitToolOutputs) yet.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/function/properties/output", + "deprecated": false, "key": "output", - "optional": false, - "nullable": true, + "docstring": "The output of the function. This will be `null` if the outputs have not been [submitted](/docs/api-reference/runs/submitToolOutputs) yet.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/function/properties/output", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "string", "children": [] }, @@ -25480,6 +25482,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) 0": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter/properties/outputs/items/oneOf/0", + "docstring": "Text output from the Code Interpreter tool call as part of a run step.", "ident": "CodeInterpreterLogOutput", "type": { "kind": "HttpTypeObject", @@ -25492,7 +25495,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Text output from the Code Interpreter tool call as part of a run step.", "childrenParentSchema": "object", "children": [ "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 0 > (property) logs", @@ -25522,12 +25524,13 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) ranking_options > (property) ranker": { "kind": "HttpDeclProperty", - "docstring": "The ranker to use for the file search. If not specified will use the `auto` ranker.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchRankingOptionsObject/properties/ranker", + "deprecated": false, "key": "ranker", - "optional": false, - "nullable": false, + "docstring": "The ranker to use for the file search. If not specified will use the `auto` ranker.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchRankingOptionsObject/properties/ranker", "types": [ { "kind": "HttpTypeLiteral", @@ -25537,11 +25540,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "default_2024_08_21" } - ], - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchRankingOptionsObject/properties/ranker" + ] }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchRankingOptionsObject/properties/ranker", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -25551,10 +25553,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) ranking_options > (property) score_threshold": { "kind": "HttpDeclProperty", - "docstring": "The score threshold for the file search. All values must be a floating point number between 0 and 1.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchRankingOptionsObject/properties/score_threshold", + "deprecated": false, "key": "score_threshold", - "optional": false, - "nullable": false, + "docstring": "The score threshold for the file search. All values must be a floating point number between 0 and 1.", "type": { "kind": "HttpTypeNumber" }, @@ -25562,45 +25564,45 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "minimum": 0, "maximum": 1 }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchRankingOptionsObject/properties/score_threshold", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "number", "children": [] }, "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) results > (items) > (property) file_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the file that result was found in.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/file_id", + "deprecated": false, "key": "file_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the file that result was found in.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/file_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) results > (items) > (property) file_name": { "kind": "HttpDeclProperty", - "docstring": "The name of the file that result was found in.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/file_name", + "deprecated": false, "key": "file_name", - "optional": false, - "nullable": false, + "docstring": "The name of the file that result was found in.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/file_name", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) results > (items) > (property) score": { "kind": "HttpDeclProperty", - "docstring": "The score of the result. All values must be a floating point number between 0 and 1.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/score", + "deprecated": false, "key": "score", - "optional": false, - "nullable": false, + "docstring": "The score of the result. All values must be a floating point number between 0 and 1.", "type": { "kind": "HttpTypeNumber" }, @@ -25608,19 +25610,20 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "minimum": 0, "maximum": 1 }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/score", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "number", "children": [] }, "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) results > (items) > (property) content": { "kind": "HttpDeclProperty", - "docstring": "The content of the result that was found. The content is only included if requested via the include query parameter.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/content", + "deprecated": false, "key": "content", - "optional": true, - "nullable": false, + "docstring": "The content of the result that was found. The content is only included if requested via the include query parameter.", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/content", "elementType": { "kind": "HttpTypeObject", "members": [ @@ -25631,11 +25634,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "ident": "type" } ] + } }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/content" - }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/content", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "array", "childrenParentSchema": "object", "children": [ @@ -25645,36 +25647,36 @@ 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 > (property) logs": { "kind": "HttpDeclProperty", - "docstring": "The text output from the Code Interpreter tool call.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputLogsObject/properties/logs", + "deprecated": false, "key": "logs", - "optional": false, - "nullable": false, + "docstring": "The text output from the Code Interpreter tool call.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputLogsObject/properties/logs", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 0 > (property) type": { "kind": "HttpDeclProperty", - "docstring": "Always `logs`.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputLogsObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "Always `logs`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputLogsObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "logs" } - ], - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputLogsObject/properties/type" + ] }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputLogsObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -25683,9 +25685,9 @@ 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": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputImageObject/properties/image", + "deprecated": false, "key": "image", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeObject", "members": [ @@ -25694,8 +25696,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputImageObject/properties/image", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -25704,22 +25706,22 @@ 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) type": { "kind": "HttpDeclProperty", - "docstring": "Always `image`.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputImageObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "Always `image`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputImageObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "image" } - ], - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputImageObject/properties/type" + ] }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputImageObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -25742,36 +25744,36 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) results > (items) > (property) content > (items) > (property) text": { "kind": "HttpDeclProperty", - "docstring": "The text content of the file.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/content/items/properties/text", + "deprecated": false, "key": "text", - "optional": true, - "nullable": false, + "docstring": "The text content of the file.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/content/items/properties/text", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) results > (items) > (property) content > (items) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the content.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/content/items/properties/type", + "deprecated": false, "key": "type", - "optional": true, - "nullable": false, + "docstring": "The type of the content.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/content/items/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "text" } - ], - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/content/items/properties/type" + ] }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/content/items/properties/type", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -25787,15 +25789,15 @@ 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](/docs/api-reference/files) ID of the image.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputImageObject/properties/image/properties/file_id", + "deprecated": false, "key": "file_id", - "optional": false, - "nullable": false, + "docstring": "The [file](/docs/api-reference/files) ID of the image.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputImageObject/properties/image/properties/file_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, @@ -25835,7 +25837,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/oneOf/1", - "ident": "UnionMember12", + "docstring": "Occurs when a [run step](/docs/api-reference/run-steps/step-object) moves to an `in_progress` state.", + "ident": "ThreadRunStepInProgress", "type": { "kind": "HttpTypeObject", "members": [ @@ -25847,7 +25850,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "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", @@ -25856,20 +25858,20 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 12 > (property) data": { "kind": "HttpDeclProperty", - "title": "Run steps", - "docstring": "Represents a step in execution of a run.\n", + "oasRef": "#/components/schemas/RunStepStreamEvent/oneOf/1/properties/data", + "deprecated": false, "key": "data", - "optional": false, - "nullable": false, + "docstring": "Represents a step in execution of a run.\n", + "title": "Run steps", "type": { "kind": "HttpTypeReference", "ident": "RunStep", "$ref": "(resource) beta.threads.runs.steps > (model) run_step > (schema)" }, - "oasRef": "#/components/schemas/RunStepStreamEvent/oneOf/1/properties/data", - "deprecated": false, - "schemaType": "object", + "optional": false, + "nullable": false, "modelImplicit": false, + "schemaType": "object", "modelPath": "(resource) beta.threads.runs.steps > (model) run_step", "childrenParentSchema": "object", "children": [ @@ -25893,21 +25895,21 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 12 > (property) event": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RunStepStreamEvent/oneOf/1/properties/event", + "deprecated": false, "key": "event", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepStreamEvent/oneOf/1/properties/event", "types": [ { "kind": "HttpTypeLiteral", "literal": "thread.run.step.in_progress" } - ], - "oasRef": "#/components/schemas/RunStepStreamEvent/oneOf/1/properties/event" + ] }, - "oasRef": "#/components/schemas/RunStepStreamEvent/oneOf/1/properties/event", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -25916,123 +25918,123 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The identifier of the run step, which can be referenced in API endpoints.", + "oasRef": "#/components/schemas/RunStepObject/properties/id", + "deprecated": false, "key": "id", - "optional": false, - "nullable": false, + "docstring": "The identifier of the run step, which can be referenced in API endpoints.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepObject/properties/id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) assistant_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the [assistant](/docs/api-reference/assistants) associated with the run step.", + "oasRef": "#/components/schemas/RunStepObject/properties/assistant_id", + "deprecated": false, "key": "assistant_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the [assistant](/docs/api-reference/assistants) associated with the run step.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepObject/properties/assistant_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) cancelled_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the run step was cancelled.", + "oasRef": "#/components/schemas/RunStepObject/properties/cancelled_at", + "deprecated": false, "key": "cancelled_at", - "optional": false, - "nullable": true, + "docstring": "The Unix timestamp (in seconds) for when the run step was cancelled.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/RunStepObject/properties/cancelled_at", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) completed_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the run step completed.", + "oasRef": "#/components/schemas/RunStepObject/properties/completed_at", + "deprecated": false, "key": "completed_at", - "optional": false, - "nullable": true, + "docstring": "The Unix timestamp (in seconds) for when the run step completed.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/RunStepObject/properties/completed_at", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) created_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the run step was created.", + "oasRef": "#/components/schemas/RunStepObject/properties/created_at", + "deprecated": false, "key": "created_at", - "optional": false, - "nullable": false, + "docstring": "The Unix timestamp (in seconds) for when the run step was created.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/RunStepObject/properties/created_at", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) expired_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the run step expired. A step is considered expired if the parent run is expired.", + "oasRef": "#/components/schemas/RunStepObject/properties/expired_at", + "deprecated": false, "key": "expired_at", - "optional": false, - "nullable": true, + "docstring": "The Unix timestamp (in seconds) for when the run step expired. A step is considered expired if the parent run is expired.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/RunStepObject/properties/expired_at", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) failed_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the run step failed.", + "oasRef": "#/components/schemas/RunStepObject/properties/failed_at", + "deprecated": false, "key": "failed_at", - "optional": false, - "nullable": true, + "docstring": "The Unix timestamp (in seconds) for when the run step failed.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/RunStepObject/properties/failed_at", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) last_error": { "kind": "HttpDeclProperty", - "docstring": "The last error associated with this run step. Will be `null` if there are no errors.", + "oasRef": "#/components/schemas/RunStepObject/properties/last_error", + "deprecated": false, "key": "last_error", - "optional": false, - "nullable": true, + "docstring": "The last error associated with this run step. Will be `null` if there are no errors.", "type": { "kind": "HttpTypeObject", "members": [ @@ -26044,8 +26046,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunStepObject/properties/last_error", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -26055,40 +26057,40 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) metadata": { "kind": "HttpDeclProperty", - "docstring": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.\n", + "oasRef": "#/components/schemas/RunStepObject/properties/metadata", + "deprecated": false, "key": "metadata", - "optional": false, - "nullable": true, + "docstring": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.\n", "type": { "kind": "HttpTypeReference", "ident": "Metadata", "$ref": "(resource) $shared > (model) metadata > (schema)" }, - "oasRef": "#/components/schemas/RunStepObject/properties/metadata", - "deprecated": false, - "schemaType": "map", + "optional": false, + "nullable": true, "modelImplicit": false, + "schemaType": "map", "modelPath": "(resource) $shared > (model) metadata", "children": [] }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) object": { "kind": "HttpDeclProperty", - "docstring": "The object type, which is always `thread.run.step`.", + "oasRef": "#/components/schemas/RunStepObject/properties/object", + "deprecated": false, "key": "object", - "optional": false, - "nullable": false, + "docstring": "The object type, which is always `thread.run.step`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepObject/properties/object", "types": [ { "kind": "HttpTypeLiteral", "literal": "thread.run.step" } - ], - "oasRef": "#/components/schemas/RunStepObject/properties/object" + ] }, - "oasRef": "#/components/schemas/RunStepObject/properties/object", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -26097,26 +26099,27 @@ 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](/docs/api-reference/runs) that this run step is a part of.", + "oasRef": "#/components/schemas/RunStepObject/properties/run_id", + "deprecated": false, "key": "run_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the [run](/docs/api-reference/runs) that this run step is a part of.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepObject/properties/run_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) status": { "kind": "HttpDeclProperty", - "docstring": "The status of the run step, which can be either `in_progress`, `cancelled`, `failed`, `completed`, or `expired`.", + "oasRef": "#/components/schemas/RunStepObject/properties/status", + "deprecated": false, "key": "status", - "optional": false, - "nullable": false, + "docstring": "The status of the run step, which can be either `in_progress`, `cancelled`, `failed`, `completed`, or `expired`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepObject/properties/status", "types": [ { "kind": "HttpTypeLiteral", @@ -26138,11 +26141,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "expired" } - ], - "oasRef": "#/components/schemas/RunStepObject/properties/status" + ] }, - "oasRef": "#/components/schemas/RunStepObject/properties/status", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -26155,12 +26157,13 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) step_details": { "kind": "HttpDeclProperty", - "docstring": "The details of the run step.", + "oasRef": "#/components/schemas/RunStepObject/properties/step_details", + "deprecated": false, "key": "step_details", - "optional": false, - "nullable": false, + "docstring": "The details of the run step.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepObject/properties/step_details", "types": [ { "kind": "HttpTypeReference", @@ -26172,11 +26175,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "ident": "ToolCallsStepDetails", "$ref": "(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema)" } - ], - "oasRef": "#/components/schemas/RunStepObject/properties/step_details" + ] }, - "oasRef": "#/components/schemas/RunStepObject/properties/step_details", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "union", "childrenParentSchema": "union", "children": [ @@ -26186,26 +26188,27 @@ 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](/docs/api-reference/threads) that was run.", + "oasRef": "#/components/schemas/RunStepObject/properties/thread_id", + "deprecated": false, "key": "thread_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the [thread](/docs/api-reference/threads) that was run.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepObject/properties/thread_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of run step, which can be either `message_creation` or `tool_calls`.", + "oasRef": "#/components/schemas/RunStepObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of run step, which can be either `message_creation` or `tool_calls`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", @@ -26215,11 +26218,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "tool_calls" } - ], - "oasRef": "#/components/schemas/RunStepObject/properties/type" + ] }, - "oasRef": "#/components/schemas/RunStepObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -26229,10 +26231,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) usage": { "kind": "HttpDeclProperty", - "docstring": "Usage statistics related to the run step. This value will be `null` while the run step's status is `in_progress`.", + "oasRef": "#/components/schemas/RunStepObject/properties/usage", + "deprecated": false, "key": "usage", - "optional": false, - "nullable": true, + "docstring": "Usage statistics related to the run step. This value will be `null` while the run step's status is `in_progress`.", "type": { "kind": "HttpTypeObject", "members": [ @@ -26247,8 +26249,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunStepObject/properties/usage", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -26260,6 +26262,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.runs.steps > (model) run_step > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RunStepObject", + "docstring": "Represents a step in execution of a run.\n", "ident": "RunStep", "type": { "kind": "HttpTypeObject", @@ -26314,7 +26317,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Represents a step in execution of a run.\n", "childrenParentSchema": "object", "children": [ "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) id", @@ -26344,12 +26346,13 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) last_error > (property) code": { "kind": "HttpDeclProperty", - "docstring": "One of `server_error` or `rate_limit_exceeded`.", + "oasRef": "#/components/schemas/RunStepObject/properties/last_error/anyOf/0/properties/code", + "deprecated": false, "key": "code", - "optional": false, - "nullable": false, + "docstring": "One of `server_error` or `rate_limit_exceeded`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepObject/properties/last_error/anyOf/0/properties/code", "types": [ { "kind": "HttpTypeLiteral", @@ -26359,11 +26362,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "rate_limit_exceeded" } - ], - "oasRef": "#/components/schemas/RunStepObject/properties/last_error/anyOf/0/properties/code" + ] }, - "oasRef": "#/components/schemas/RunStepObject/properties/last_error/anyOf/0/properties/code", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -26373,24 +26375,26 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) last_error > (property) message": { "kind": "HttpDeclProperty", - "docstring": "A human-readable description of the error.", + "oasRef": "#/components/schemas/RunStepObject/properties/last_error/anyOf/0/properties/message", + "deprecated": false, "key": "message", - "optional": false, - "nullable": false, + "docstring": "A human-readable description of the error.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepObject/properties/last_error/anyOf/0/properties/message", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) $shared > (model) metadata > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/Metadata", + "docstring": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.\n", "ident": "Metadata", "type": { "kind": "HttpTypeReference", + "oasRef": "#/components/schemas/Metadata", "ident": "Record", "typeParameters": [ { @@ -26399,10 +26403,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch { "kind": "HttpTypeString" } - ], - "oasRef": "#/components/schemas/Metadata" + ] }, - "docstring": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.\n", "children": [] }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) object > (member) 0": { @@ -26476,6 +26478,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.runs.steps > (model) message_creation_step_details > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RunStepDetailsMessageCreationObject", + "docstring": "Details of the message creation by the run step.", "ident": "MessageCreationStepDetails", "type": { "kind": "HttpTypeObject", @@ -26488,7 +26491,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Details of the message creation by the run step.", "childrenParentSchema": "object", "children": [ "(resource) beta.threads.runs.steps > (model) message_creation_step_details > (schema) > (property) message_creation", @@ -26498,6 +26500,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RunStepDetailsToolCallsObject", + "docstring": "Details of the tool call.", "ident": "ToolCallsStepDetails", "type": { "kind": "HttpTypeObject", @@ -26510,7 +26513,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Details of the tool call.", "childrenParentSchema": "object", "children": [ "(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) tool_calls", @@ -26533,43 +26535,43 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) usage > (property) completion_tokens": { "kind": "HttpDeclProperty", - "docstring": "Number of completion tokens used over the course of the run step.", + "oasRef": "#/components/schemas/RunStepCompletionUsage/anyOf/0/properties/completion_tokens", + "deprecated": false, "key": "completion_tokens", - "optional": false, - "nullable": false, + "docstring": "Number of completion tokens used over the course of the run step.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RunStepCompletionUsage/anyOf/0/properties/completion_tokens", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) usage > (property) prompt_tokens": { "kind": "HttpDeclProperty", - "docstring": "Number of prompt tokens used over the course of the run step.", + "oasRef": "#/components/schemas/RunStepCompletionUsage/anyOf/0/properties/prompt_tokens", + "deprecated": false, "key": "prompt_tokens", - "optional": false, - "nullable": false, + "docstring": "Number of prompt tokens used over the course of the run step.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RunStepCompletionUsage/anyOf/0/properties/prompt_tokens", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) usage > (property) total_tokens": { "kind": "HttpDeclProperty", - "docstring": "Total number of tokens used (prompt + completion).", + "oasRef": "#/components/schemas/RunStepCompletionUsage/anyOf/0/properties/total_tokens", + "deprecated": false, "key": "total_tokens", - "optional": false, - "nullable": false, + "docstring": "Total number of tokens used (prompt + completion).", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RunStepCompletionUsage/anyOf/0/properties/total_tokens", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, @@ -26589,9 +26591,9 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) message_creation_step_details > (schema) > (property) message_creation": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RunStepDetailsMessageCreationObject/properties/message_creation", + "deprecated": false, "key": "message_creation", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeObject", "members": [ @@ -26600,8 +26602,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunStepDetailsMessageCreationObject/properties/message_creation", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -26610,22 +26612,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) message_creation_step_details > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "Always `message_creation`.", + "oasRef": "#/components/schemas/RunStepDetailsMessageCreationObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "Always `message_creation`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepDetailsMessageCreationObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "message_creation" } - ], - "oasRef": "#/components/schemas/RunStepDetailsMessageCreationObject/properties/type" + ] }, - "oasRef": "#/components/schemas/RunStepDetailsMessageCreationObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -26634,14 +26636,16 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) tool_calls": { "kind": "HttpDeclProperty", - "docstring": "An array of tool calls the run step was involved in. These can be associated with one of three types of tools: `code_interpreter`, `file_search`, or `function`.\n", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsObject/properties/tool_calls", + "deprecated": false, "key": "tool_calls", - "optional": false, - "nullable": false, + "docstring": "An array of tool calls the run step was involved in. These can be associated with one of three types of tools: `code_interpreter`, `file_search`, or `function`.\n", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsObject/properties/tool_calls", "elementType": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsObject/properties/tool_calls/items", "types": [ { "kind": "HttpTypeReference", @@ -26658,13 +26662,11 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "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" + ] + } }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsObject/properties/tool_calls", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "array", "childrenParentSchema": "union", "children": [ @@ -26675,22 +26677,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "Always `tool_calls`.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "Always `tool_calls`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "tool_calls" } - ], - "oasRef": "#/components/schemas/RunStepDetailsToolCallsObject/properties/type" + ] }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -26699,15 +26701,15 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) message_creation_step_details > (schema) > (property) message_creation > (property) message_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the message that was created by this run step.", + "oasRef": "#/components/schemas/RunStepDetailsMessageCreationObject/properties/message_creation/properties/message_id", + "deprecated": false, "key": "message_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the message that was created by this run step.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepDetailsMessageCreationObject/properties/message_creation/properties/message_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, @@ -26763,6 +26765,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject", + "docstring": "Details of the Code Interpreter tool call the run step was involved in.", "ident": "CodeInterpreterToolCall", "type": { "kind": "HttpTypeObject", @@ -26778,7 +26781,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "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", @@ -26845,24 +26847,24 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the tool call.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/id", + "deprecated": false, "key": "id", - "optional": false, - "nullable": false, + "docstring": "The ID of the tool call.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/id", - "deprecated": false, + "optional": false, + "nullable": 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.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter", + "deprecated": false, "key": "code_interpreter", - "optional": false, - "nullable": false, + "docstring": "The Code Interpreter tool call definition.", "type": { "kind": "HttpTypeObject", "members": [ @@ -26874,8 +26876,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -26885,22 +26887,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(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.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of tool call. This is always going to be `code_interpreter` for this type of tool call.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "code_interpreter" } - ], - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/type" + ] }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -26909,24 +26911,24 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the tool call object.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/id", + "deprecated": false, "key": "id", - "optional": false, - "nullable": false, + "docstring": "The ID of the tool call object.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/id", - "deprecated": false, + "optional": false, + "nullable": 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.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/file_search", + "deprecated": false, "key": "file_search", - "optional": false, - "nullable": false, + "docstring": "For now, this is always going to be an empty object.", "type": { "kind": "HttpTypeObject", "members": [ @@ -26938,8 +26940,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/file_search", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -26949,22 +26951,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(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.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of tool call. This is always going to be `file_search` for this type of tool call.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "file_search" } - ], - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/type" + ] }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -26973,24 +26975,24 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the tool call object.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/id", + "deprecated": false, "key": "id", - "optional": false, - "nullable": false, + "docstring": "The ID of the tool call object.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/id", - "deprecated": false, + "optional": false, + "nullable": 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.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/function", + "deprecated": false, "key": "function", - "optional": false, - "nullable": false, + "docstring": "The definition of the function that was called.", "type": { "kind": "HttpTypeObject", "members": [ @@ -27005,8 +27007,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/function", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -27017,22 +27019,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(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.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of tool call. This is always going to be `function` for this type of tool call.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "function" } - ], - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/type" + ] }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -27041,28 +27043,30 @@ 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) input": { "kind": "HttpDeclProperty", - "docstring": "The input to the Code Interpreter tool call.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter/properties/input", + "deprecated": false, "key": "input", - "optional": false, - "nullable": false, + "docstring": "The input to the Code Interpreter tool call.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter/properties/input", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs": { "kind": "HttpDeclProperty", - "docstring": "The outputs from the Code Interpreter tool call. Code Interpreter can output one or more items, including text (`logs`) or images (`image`). Each of these are represented by a different object type.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter/properties/outputs", + "deprecated": false, "key": "outputs", - "optional": false, - "nullable": false, + "docstring": "The outputs from the Code Interpreter tool call. Code Interpreter can output one or more items, including text (`logs`) or images (`image`). Each of these are represented by a different object type.", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter/properties/outputs", "elementType": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter/properties/outputs/items", "types": [ { "kind": "HttpTypeObject", @@ -27086,13 +27090,11 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] } - ], - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter/properties/outputs/items" - }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter/properties/outputs" + ] + } }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter/properties/outputs", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "array", "childrenParentSchema": "union", "children": [ @@ -27109,11 +27111,11 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) ranking_options": { "kind": "HttpDeclProperty", - "title": "File search tool call ranking options", - "docstring": "The ranking options for the file search.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/file_search/properties/ranking_options", + "deprecated": false, "key": "ranking_options", - "optional": true, - "nullable": false, + "docstring": "The ranking options for the file search.", + "title": "File search tool call ranking options", "type": { "kind": "HttpTypeObject", "members": [ @@ -27125,8 +27127,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/file_search/properties/ranking_options", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -27136,12 +27138,13 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) results": { "kind": "HttpDeclProperty", - "docstring": "The results of the file search.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/file_search/properties/results", + "deprecated": false, "key": "results", - "optional": true, - "nullable": false, + "docstring": "The results of the file search.", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/file_search/properties/results", "elementType": { "kind": "HttpTypeObject", "members": [ @@ -27158,11 +27161,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "ident": "content" } ] + } }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/file_search/properties/results" - }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/file_search/properties/results", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "array", "childrenParentSchema": "object", "children": [ @@ -27181,43 +27183,43 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) function > (property) arguments": { "kind": "HttpDeclProperty", - "docstring": "The arguments passed to the function.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/function/properties/arguments", + "deprecated": false, "key": "arguments", - "optional": false, - "nullable": false, + "docstring": "The arguments passed to the function.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/function/properties/arguments", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) function > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the function.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/function/properties/name", + "deprecated": false, "key": "name", - "optional": false, - "nullable": false, + "docstring": "The name of the function.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/function/properties/name", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(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](/docs/api-reference/runs/submitToolOutputs) yet.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/function/properties/output", + "deprecated": false, "key": "output", - "optional": false, - "nullable": true, + "docstring": "The output of the function. This will be `null` if the outputs have not been [submitted](/docs/api-reference/runs/submitToolOutputs) yet.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/function/properties/output", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "string", "children": [] }, @@ -27231,6 +27233,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) 0": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter/properties/outputs/items/oneOf/0", + "docstring": "Text output from the Code Interpreter tool call as part of a run step.", "ident": "CodeInterpreterLogOutput", "type": { "kind": "HttpTypeObject", @@ -27243,7 +27246,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Text output from the Code Interpreter tool call as part of a run step.", "childrenParentSchema": "object", "children": [ "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 0 > (property) logs", @@ -27273,12 +27275,13 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) ranking_options > (property) ranker": { "kind": "HttpDeclProperty", - "docstring": "The ranker to use for the file search. If not specified will use the `auto` ranker.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchRankingOptionsObject/properties/ranker", + "deprecated": false, "key": "ranker", - "optional": false, - "nullable": false, + "docstring": "The ranker to use for the file search. If not specified will use the `auto` ranker.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchRankingOptionsObject/properties/ranker", "types": [ { "kind": "HttpTypeLiteral", @@ -27288,11 +27291,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "default_2024_08_21" } - ], - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchRankingOptionsObject/properties/ranker" + ] }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchRankingOptionsObject/properties/ranker", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -27302,10 +27304,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) ranking_options > (property) score_threshold": { "kind": "HttpDeclProperty", - "docstring": "The score threshold for the file search. All values must be a floating point number between 0 and 1.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchRankingOptionsObject/properties/score_threshold", + "deprecated": false, "key": "score_threshold", - "optional": false, - "nullable": false, + "docstring": "The score threshold for the file search. All values must be a floating point number between 0 and 1.", "type": { "kind": "HttpTypeNumber" }, @@ -27313,45 +27315,45 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "minimum": 0, "maximum": 1 }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchRankingOptionsObject/properties/score_threshold", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "number", "children": [] }, "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) results > (items) > (property) file_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the file that result was found in.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/file_id", + "deprecated": false, "key": "file_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the file that result was found in.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/file_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) results > (items) > (property) file_name": { "kind": "HttpDeclProperty", - "docstring": "The name of the file that result was found in.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/file_name", + "deprecated": false, "key": "file_name", - "optional": false, - "nullable": false, + "docstring": "The name of the file that result was found in.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/file_name", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) results > (items) > (property) score": { "kind": "HttpDeclProperty", - "docstring": "The score of the result. All values must be a floating point number between 0 and 1.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/score", + "deprecated": false, "key": "score", - "optional": false, - "nullable": false, + "docstring": "The score of the result. All values must be a floating point number between 0 and 1.", "type": { "kind": "HttpTypeNumber" }, @@ -27359,19 +27361,20 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "minimum": 0, "maximum": 1 }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/score", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "number", "children": [] }, "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) results > (items) > (property) content": { "kind": "HttpDeclProperty", - "docstring": "The content of the result that was found. The content is only included if requested via the include query parameter.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/content", + "deprecated": false, "key": "content", - "optional": true, - "nullable": false, + "docstring": "The content of the result that was found. The content is only included if requested via the include query parameter.", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/content", "elementType": { "kind": "HttpTypeObject", "members": [ @@ -27382,11 +27385,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "ident": "type" } ] + } }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/content" - }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/content", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "array", "childrenParentSchema": "object", "children": [ @@ -27396,36 +27398,36 @@ 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 > (property) logs": { "kind": "HttpDeclProperty", - "docstring": "The text output from the Code Interpreter tool call.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputLogsObject/properties/logs", + "deprecated": false, "key": "logs", - "optional": false, - "nullable": false, + "docstring": "The text output from the Code Interpreter tool call.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputLogsObject/properties/logs", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 0 > (property) type": { "kind": "HttpDeclProperty", - "docstring": "Always `logs`.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputLogsObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "Always `logs`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputLogsObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "logs" } - ], - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputLogsObject/properties/type" + ] }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputLogsObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -27434,9 +27436,9 @@ 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": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputImageObject/properties/image", + "deprecated": false, "key": "image", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeObject", "members": [ @@ -27445,8 +27447,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputImageObject/properties/image", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -27455,22 +27457,22 @@ 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) type": { "kind": "HttpDeclProperty", - "docstring": "Always `image`.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputImageObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "Always `image`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputImageObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "image" } - ], - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputImageObject/properties/type" + ] }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputImageObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -27493,36 +27495,36 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) results > (items) > (property) content > (items) > (property) text": { "kind": "HttpDeclProperty", - "docstring": "The text content of the file.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/content/items/properties/text", + "deprecated": false, "key": "text", - "optional": true, - "nullable": false, + "docstring": "The text content of the file.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/content/items/properties/text", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) results > (items) > (property) content > (items) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the content.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/content/items/properties/type", + "deprecated": false, "key": "type", - "optional": true, - "nullable": false, + "docstring": "The type of the content.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/content/items/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "text" } - ], - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/content/items/properties/type" + ] }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/content/items/properties/type", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -27538,15 +27540,15 @@ 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](/docs/api-reference/files) ID of the image.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputImageObject/properties/image/properties/file_id", + "deprecated": false, "key": "file_id", - "optional": false, - "nullable": false, + "docstring": "The [file](/docs/api-reference/files) ID of the image.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputImageObject/properties/image/properties/file_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, @@ -27586,7 +27588,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/oneOf/2", - "ident": "UnionMember13", + "docstring": "Occurs when parts of a [run step](/docs/api-reference/run-steps/step-object) are being streamed.", + "ident": "ThreadRunStepDelta", "type": { "kind": "HttpTypeObject", "members": [ @@ -27598,7 +27601,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "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", @@ -27607,20 +27609,20 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 13 > (property) data": { "kind": "HttpDeclProperty", - "title": "Run step delta object", - "docstring": "Represents a run step delta i.e. any changed fields on a run step during streaming.\n", + "oasRef": "#/components/schemas/RunStepStreamEvent/oneOf/2/properties/data", + "deprecated": false, "key": "data", - "optional": false, - "nullable": false, + "docstring": "Represents a run step delta i.e. any changed fields on a run step during streaming.\n", + "title": "Run step delta object", "type": { "kind": "HttpTypeReference", "ident": "RunStepDeltaEvent", "$ref": "(resource) beta.threads.runs.steps > (model) run_step_delta_event > (schema)" }, - "oasRef": "#/components/schemas/RunStepStreamEvent/oneOf/2/properties/data", - "deprecated": false, - "schemaType": "object", + "optional": false, + "nullable": false, "modelImplicit": false, + "schemaType": "object", "modelPath": "(resource) beta.threads.runs.steps > (model) run_step_delta_event", "childrenParentSchema": "object", "children": [ @@ -27631,21 +27633,21 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 13 > (property) event": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RunStepStreamEvent/oneOf/2/properties/event", + "deprecated": false, "key": "event", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepStreamEvent/oneOf/2/properties/event", "types": [ { "kind": "HttpTypeLiteral", "literal": "thread.run.step.delta" } - ], - "oasRef": "#/components/schemas/RunStepStreamEvent/oneOf/2/properties/event" + ] }, - "oasRef": "#/components/schemas/RunStepStreamEvent/oneOf/2/properties/event", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -27654,24 +27656,24 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) run_step_delta_event > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The identifier of the run step, which can be referenced in API endpoints.", + "oasRef": "#/components/schemas/RunStepDeltaObject/properties/id", + "deprecated": false, "key": "id", - "optional": false, - "nullable": false, + "docstring": "The identifier of the run step, which can be referenced in API endpoints.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepDeltaObject/properties/id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs.steps > (model) run_step_delta_event > (schema) > (property) delta": { "kind": "HttpDeclProperty", - "docstring": "The delta containing the fields that have changed on the run step.", + "oasRef": "#/components/schemas/RunStepDeltaObject/properties/delta", + "deprecated": false, "key": "delta", - "optional": false, - "nullable": false, + "docstring": "The delta containing the fields that have changed on the run step.", "type": { "kind": "HttpTypeObject", "members": [ @@ -27680,8 +27682,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunStepDeltaObject/properties/delta", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -27690,22 +27692,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) run_step_delta_event > (schema) > (property) object": { "kind": "HttpDeclProperty", - "docstring": "The object type, which is always `thread.run.step.delta`.", + "oasRef": "#/components/schemas/RunStepDeltaObject/properties/object", + "deprecated": false, "key": "object", - "optional": false, - "nullable": false, + "docstring": "The object type, which is always `thread.run.step.delta`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepDeltaObject/properties/object", "types": [ { "kind": "HttpTypeLiteral", "literal": "thread.run.step.delta" } - ], - "oasRef": "#/components/schemas/RunStepDeltaObject/properties/object" + ] }, - "oasRef": "#/components/schemas/RunStepDeltaObject/properties/object", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -27715,6 +27717,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.runs.steps > (model) run_step_delta_event > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RunStepDeltaObject", + "docstring": "Represents a run step delta i.e. any changed fields on a run step during streaming.\n", "ident": "RunStepDeltaEvent", "type": { "kind": "HttpTypeObject", @@ -27730,7 +27733,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Represents a run step delta i.e. any changed fields on a run step during streaming.\n", "childrenParentSchema": "object", "children": [ "(resource) beta.threads.runs.steps > (model) run_step_delta_event > (schema) > (property) id", @@ -27747,12 +27749,13 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(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.", + "oasRef": "#/components/schemas/RunStepDeltaObject/properties/delta/properties/step_details", + "deprecated": false, "key": "step_details", - "optional": true, - "nullable": false, + "docstring": "The details of the run step.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepDeltaObject/properties/delta/properties/step_details", "types": [ { "kind": "HttpTypeReference", @@ -27764,11 +27767,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "ident": "ToolCallDeltaObject", "$ref": "(resource) beta.threads.runs.steps > (model) tool_call_delta_object > (schema)" } - ], - "oasRef": "#/components/schemas/RunStepDeltaObject/properties/delta/properties/step_details" + ] }, - "oasRef": "#/components/schemas/RunStepDeltaObject/properties/delta/properties/step_details", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "union", "childrenParentSchema": "union", "children": [ @@ -27812,6 +27814,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.runs.steps > (model) run_step_delta_message_delta > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RunStepDeltaStepDetailsMessageCreationObject", + "docstring": "Details of the message creation by the run step.", "ident": "RunStepDeltaMessageDelta", "type": { "kind": "HttpTypeObject", @@ -27824,7 +27827,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Details of the message creation by the run step.", "childrenParentSchema": "object", "children": [ "(resource) beta.threads.runs.steps > (model) run_step_delta_message_delta > (schema) > (property) type", @@ -27834,6 +27836,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.runs.steps > (model) tool_call_delta_object > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsObject", + "docstring": "Details of the tool call.", "ident": "ToolCallDeltaObject", "type": { "kind": "HttpTypeObject", @@ -27846,7 +27849,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Details of the tool call.", "childrenParentSchema": "object", "children": [ "(resource) beta.threads.runs.steps > (model) tool_call_delta_object > (schema) > (property) type", @@ -27855,22 +27857,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) run_step_delta_message_delta > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "Always `message_creation`.", + "oasRef": "#/components/schemas/RunStepDeltaStepDetailsMessageCreationObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "Always `message_creation`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepDeltaStepDetailsMessageCreationObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "message_creation" } - ], - "oasRef": "#/components/schemas/RunStepDeltaStepDetailsMessageCreationObject/properties/type" + ] }, - "oasRef": "#/components/schemas/RunStepDeltaStepDetailsMessageCreationObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -27879,9 +27881,9 @@ 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": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RunStepDeltaStepDetailsMessageCreationObject/properties/message_creation", + "deprecated": false, "key": "message_creation", - "optional": true, - "nullable": false, "type": { "kind": "HttpTypeObject", "members": [ @@ -27890,8 +27892,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunStepDeltaStepDetailsMessageCreationObject/properties/message_creation", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -27900,22 +27902,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) tool_call_delta_object > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "Always `tool_calls`.", + "oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "Always `tool_calls`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "tool_calls" } - ], - "oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsObject/properties/type" + ] }, - "oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -27924,14 +27926,16 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) tool_call_delta_object > (schema) > (property) tool_calls": { "kind": "HttpDeclProperty", - "docstring": "An array of tool calls the run step was involved in. These can be associated with one of three types of tools: `code_interpreter`, `file_search`, or `function`.\n", + "oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsObject/properties/tool_calls", + "deprecated": false, "key": "tool_calls", - "optional": true, - "nullable": false, + "docstring": "An array of tool calls the run step was involved in. These can be associated with one of three types of tools: `code_interpreter`, `file_search`, or `function`.\n", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsObject/properties/tool_calls", "elementType": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsObject/properties/tool_calls/items", "types": [ { "kind": "HttpTypeReference", @@ -27948,13 +27952,11 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "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" + ] + } }, - "oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsObject/properties/tool_calls", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "array", "childrenParentSchema": "union", "children": [ @@ -27972,15 +27974,15 @@ 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 > (property) message_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the message that was created by this run step.", + "oasRef": "#/components/schemas/RunStepDeltaStepDetailsMessageCreationObject/properties/message_creation/properties/message_id", + "deprecated": false, "key": "message_id", - "optional": true, - "nullable": false, + "docstring": "The ID of the message that was created by this run step.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepDeltaStepDetailsMessageCreationObject/properties/message_creation/properties/message_id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, @@ -28039,6 +28041,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call_delta > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsCodeObject", + "docstring": "Details of the Code Interpreter tool call the run step was involved in.", "ident": "CodeInterpreterToolCallDelta", "type": { "kind": "HttpTypeObject", @@ -28057,7 +28060,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "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", @@ -28126,36 +28128,36 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call_delta > (schema) > (property) index": { "kind": "HttpDeclProperty", - "docstring": "The index of the tool call in the tool calls array.", + "oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsCodeObject/properties/index", + "deprecated": false, "key": "index", - "optional": false, - "nullable": false, + "docstring": "The index of the tool call in the tool calls array.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsCodeObject/properties/index", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call_delta > (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.", + "oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsCodeObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of tool call. This is always going to be `code_interpreter` for this type of tool call.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsCodeObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "code_interpreter" } - ], - "oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsCodeObject/properties/type" + ] }, - "oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsCodeObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -28164,24 +28166,24 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call_delta > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the tool call.", + "oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsCodeObject/properties/id", + "deprecated": false, "key": "id", - "optional": true, - "nullable": false, + "docstring": "The ID of the tool call.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsCodeObject/properties/id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call_delta > (schema) > (property) code_interpreter": { "kind": "HttpDeclProperty", - "docstring": "The Code Interpreter tool call definition.", + "oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsCodeObject/properties/code_interpreter", + "deprecated": false, "key": "code_interpreter", - "optional": true, - "nullable": false, + "docstring": "The Code Interpreter tool call definition.", "type": { "kind": "HttpTypeObject", "members": [ @@ -28193,8 +28195,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsCodeObject/properties/code_interpreter", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -28204,50 +28206,50 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(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.", + "oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsFileSearchObject/properties/file_search", + "deprecated": false, "key": "file_search", - "optional": false, - "nullable": false, + "docstring": "For now, this is always going to be an empty object.", "type": { "kind": "HttpTypeUnknown" }, - "oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsFileSearchObject/properties/file_search", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "unknown", "children": [] }, "(resource) beta.threads.runs.steps > (model) file_search_tool_call_delta > (schema) > (property) index": { "kind": "HttpDeclProperty", - "docstring": "The index of the tool call in the tool calls array.", + "oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsFileSearchObject/properties/index", + "deprecated": false, "key": "index", - "optional": false, - "nullable": false, + "docstring": "The index of the tool call in the tool calls array.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsFileSearchObject/properties/index", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs.steps > (model) file_search_tool_call_delta > (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.", + "oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsFileSearchObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of tool call. This is always going to be `file_search` for this type of tool call.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsFileSearchObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "file_search" } - ], - "oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsFileSearchObject/properties/type" + ] }, - "oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsFileSearchObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -28256,50 +28258,50 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) file_search_tool_call_delta > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the tool call object.", + "oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsFileSearchObject/properties/id", + "deprecated": false, "key": "id", - "optional": true, - "nullable": false, + "docstring": "The ID of the tool call object.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsFileSearchObject/properties/id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(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.", + "oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsFunctionObject/properties/index", + "deprecated": false, "key": "index", - "optional": false, - "nullable": false, + "docstring": "The index of the tool call in the tool calls array.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsFunctionObject/properties/index", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs.steps > (model) function_tool_call_delta > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of tool call. This is always going to be `function` for this type of tool call.", + "oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsFunctionObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of tool call. This is always going to be `function` for this type of tool call.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsFunctionObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "function" } - ], - "oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsFunctionObject/properties/type" + ] }, - "oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsFunctionObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -28308,24 +28310,24 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) function_tool_call_delta > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the tool call object.", + "oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsFunctionObject/properties/id", + "deprecated": false, "key": "id", - "optional": true, - "nullable": false, + "docstring": "The ID of the tool call object.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsFunctionObject/properties/id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs.steps > (model) function_tool_call_delta > (schema) > (property) function": { "kind": "HttpDeclProperty", - "docstring": "The definition of the function that was called.", + "oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsFunctionObject/properties/function", + "deprecated": false, "key": "function", - "optional": true, - "nullable": false, + "docstring": "The definition of the function that was called.", "type": { "kind": "HttpTypeObject", "members": [ @@ -28340,8 +28342,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsFunctionObject/properties/function", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -28359,28 +28361,30 @@ 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) input": { "kind": "HttpDeclProperty", - "docstring": "The input to the Code Interpreter tool call.", + "oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsCodeObject/properties/code_interpreter/properties/input", + "deprecated": false, "key": "input", - "optional": true, - "nullable": false, + "docstring": "The input to the Code Interpreter tool call.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsCodeObject/properties/code_interpreter/properties/input", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call_delta > (schema) > (property) code_interpreter > (property) outputs": { "kind": "HttpDeclProperty", - "docstring": "The outputs from the Code Interpreter tool call. Code Interpreter can output one or more items, including text (`logs`) or images (`image`). Each of these are represented by a different object type.", + "oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsCodeObject/properties/code_interpreter/properties/outputs", + "deprecated": false, "key": "outputs", - "optional": true, - "nullable": false, + "docstring": "The outputs from the Code Interpreter tool call. Code Interpreter can output one or more items, including text (`logs`) or images (`image`). Each of these are represented by a different object type.", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsCodeObject/properties/code_interpreter/properties/outputs", "elementType": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsCodeObject/properties/code_interpreter/properties/outputs/items", "types": [ { "kind": "HttpTypeReference", @@ -28392,13 +28396,11 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "ident": "CodeInterpreterOutputImage", "$ref": "(resource) beta.threads.runs.steps > (model) code_interpreter_output_image > (schema)" } - ], - "oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsCodeObject/properties/code_interpreter/properties/outputs/items" - }, - "oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsCodeObject/properties/code_interpreter/properties/outputs" + ] + } }, - "oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsCodeObject/properties/code_interpreter/properties/outputs", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "array", "childrenParentSchema": "union", "children": [ @@ -28422,43 +28424,43 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) function_tool_call_delta > (schema) > (property) function > (property) arguments": { "kind": "HttpDeclProperty", - "docstring": "The arguments passed to the function.", + "oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsFunctionObject/properties/function/properties/arguments", + "deprecated": false, "key": "arguments", - "optional": true, - "nullable": false, + "docstring": "The arguments passed to the function.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsFunctionObject/properties/function/properties/arguments", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs.steps > (model) function_tool_call_delta > (schema) > (property) function > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the function.", + "oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsFunctionObject/properties/function/properties/name", + "deprecated": false, "key": "name", - "optional": true, - "nullable": false, + "docstring": "The name of the function.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsFunctionObject/properties/function/properties/name", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(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](/docs/api-reference/runs/submitToolOutputs) yet.", + "oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsFunctionObject/properties/function/properties/output", + "deprecated": false, "key": "output", - "optional": true, - "nullable": true, + "docstring": "The output of the function. This will be `null` if the outputs have not been [submitted](/docs/api-reference/runs/submitToolOutputs) yet.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsFunctionObject/properties/function/properties/output", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "string", "children": [] }, @@ -28493,6 +28495,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.runs.steps > (model) code_interpreter_logs > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsCodeOutputLogsObject", + "docstring": "Text output from the Code Interpreter tool call as part of a run step.", "ident": "CodeInterpreterLogs", "type": { "kind": "HttpTypeObject", @@ -28508,7 +28511,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Text output from the Code Interpreter tool call as part of a run step.", "childrenParentSchema": "object", "children": [ "(resource) beta.threads.runs.steps > (model) code_interpreter_logs > (schema) > (property) index", @@ -28543,36 +28545,36 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) code_interpreter_logs > (schema) > (property) index": { "kind": "HttpDeclProperty", - "docstring": "The index of the output in the outputs array.", + "oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsCodeOutputLogsObject/properties/index", + "deprecated": false, "key": "index", - "optional": false, - "nullable": false, + "docstring": "The index of the output in the outputs array.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsCodeOutputLogsObject/properties/index", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs.steps > (model) code_interpreter_logs > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "Always `logs`.", + "oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsCodeOutputLogsObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "Always `logs`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsCodeOutputLogsObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "logs" } - ], - "oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsCodeOutputLogsObject/properties/type" + ] }, - "oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsCodeOutputLogsObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -28581,50 +28583,50 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) code_interpreter_logs > (schema) > (property) logs": { "kind": "HttpDeclProperty", - "docstring": "The text output from the Code Interpreter tool call.", + "oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsCodeOutputLogsObject/properties/logs", + "deprecated": false, "key": "logs", - "optional": true, - "nullable": false, + "docstring": "The text output from the Code Interpreter tool call.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsCodeOutputLogsObject/properties/logs", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs.steps > (model) code_interpreter_output_image > (schema) > (property) index": { "kind": "HttpDeclProperty", - "docstring": "The index of the output in the outputs array.", + "oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsCodeOutputImageObject/properties/index", + "deprecated": false, "key": "index", - "optional": false, - "nullable": false, + "docstring": "The index of the output in the outputs array.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsCodeOutputImageObject/properties/index", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs.steps > (model) code_interpreter_output_image > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "Always `image`.", + "oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsCodeOutputImageObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "Always `image`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsCodeOutputImageObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "image" } - ], - "oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsCodeOutputImageObject/properties/type" + ] }, - "oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsCodeOutputImageObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -28633,9 +28635,9 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) code_interpreter_output_image > (schema) > (property) image": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsCodeOutputImageObject/properties/image", + "deprecated": false, "key": "image", - "optional": true, - "nullable": false, "type": { "kind": "HttpTypeObject", "members": [ @@ -28644,8 +28646,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsCodeOutputImageObject/properties/image", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -28668,15 +28670,15 @@ 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](/docs/api-reference/files) ID of the image.", + "oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsCodeOutputImageObject/properties/image/properties/file_id", + "deprecated": false, "key": "file_id", - "optional": true, - "nullable": false, + "docstring": "The [file](/docs/api-reference/files) ID of the image.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsCodeOutputImageObject/properties/image/properties/file_id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] } @@ -28702,7 +28704,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/oneOf/3", - "ident": "UnionMember14", + "docstring": "Occurs when a [run step](/docs/api-reference/run-steps/step-object) is completed.", + "ident": "ThreadRunStepCompleted", "type": { "kind": "HttpTypeObject", "members": [ @@ -28714,7 +28717,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "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", @@ -28723,20 +28725,20 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 14 > (property) data": { "kind": "HttpDeclProperty", - "title": "Run steps", - "docstring": "Represents a step in execution of a run.\n", + "oasRef": "#/components/schemas/RunStepStreamEvent/oneOf/3/properties/data", + "deprecated": false, "key": "data", - "optional": false, - "nullable": false, + "docstring": "Represents a step in execution of a run.\n", + "title": "Run steps", "type": { "kind": "HttpTypeReference", "ident": "RunStep", "$ref": "(resource) beta.threads.runs.steps > (model) run_step > (schema)" }, - "oasRef": "#/components/schemas/RunStepStreamEvent/oneOf/3/properties/data", - "deprecated": false, - "schemaType": "object", + "optional": false, + "nullable": false, "modelImplicit": false, + "schemaType": "object", "modelPath": "(resource) beta.threads.runs.steps > (model) run_step", "childrenParentSchema": "object", "children": [ @@ -28760,21 +28762,21 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 14 > (property) event": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RunStepStreamEvent/oneOf/3/properties/event", + "deprecated": false, "key": "event", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepStreamEvent/oneOf/3/properties/event", "types": [ { "kind": "HttpTypeLiteral", "literal": "thread.run.step.completed" } - ], - "oasRef": "#/components/schemas/RunStepStreamEvent/oneOf/3/properties/event" + ] }, - "oasRef": "#/components/schemas/RunStepStreamEvent/oneOf/3/properties/event", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -28783,123 +28785,123 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The identifier of the run step, which can be referenced in API endpoints.", + "oasRef": "#/components/schemas/RunStepObject/properties/id", + "deprecated": false, "key": "id", - "optional": false, - "nullable": false, + "docstring": "The identifier of the run step, which can be referenced in API endpoints.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepObject/properties/id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) assistant_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the [assistant](/docs/api-reference/assistants) associated with the run step.", + "oasRef": "#/components/schemas/RunStepObject/properties/assistant_id", + "deprecated": false, "key": "assistant_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the [assistant](/docs/api-reference/assistants) associated with the run step.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepObject/properties/assistant_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) cancelled_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the run step was cancelled.", + "oasRef": "#/components/schemas/RunStepObject/properties/cancelled_at", + "deprecated": false, "key": "cancelled_at", - "optional": false, - "nullable": true, + "docstring": "The Unix timestamp (in seconds) for when the run step was cancelled.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/RunStepObject/properties/cancelled_at", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) completed_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the run step completed.", + "oasRef": "#/components/schemas/RunStepObject/properties/completed_at", + "deprecated": false, "key": "completed_at", - "optional": false, - "nullable": true, + "docstring": "The Unix timestamp (in seconds) for when the run step completed.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/RunStepObject/properties/completed_at", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) created_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the run step was created.", + "oasRef": "#/components/schemas/RunStepObject/properties/created_at", + "deprecated": false, "key": "created_at", - "optional": false, - "nullable": false, + "docstring": "The Unix timestamp (in seconds) for when the run step was created.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/RunStepObject/properties/created_at", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) expired_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the run step expired. A step is considered expired if the parent run is expired.", + "oasRef": "#/components/schemas/RunStepObject/properties/expired_at", + "deprecated": false, "key": "expired_at", - "optional": false, - "nullable": true, + "docstring": "The Unix timestamp (in seconds) for when the run step expired. A step is considered expired if the parent run is expired.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/RunStepObject/properties/expired_at", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) failed_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the run step failed.", + "oasRef": "#/components/schemas/RunStepObject/properties/failed_at", + "deprecated": false, "key": "failed_at", - "optional": false, - "nullable": true, + "docstring": "The Unix timestamp (in seconds) for when the run step failed.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/RunStepObject/properties/failed_at", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) last_error": { "kind": "HttpDeclProperty", - "docstring": "The last error associated with this run step. Will be `null` if there are no errors.", + "oasRef": "#/components/schemas/RunStepObject/properties/last_error", + "deprecated": false, "key": "last_error", - "optional": false, - "nullable": true, + "docstring": "The last error associated with this run step. Will be `null` if there are no errors.", "type": { "kind": "HttpTypeObject", "members": [ @@ -28911,8 +28913,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunStepObject/properties/last_error", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -28922,40 +28924,40 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) metadata": { "kind": "HttpDeclProperty", - "docstring": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.\n", + "oasRef": "#/components/schemas/RunStepObject/properties/metadata", + "deprecated": false, "key": "metadata", - "optional": false, - "nullable": true, + "docstring": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.\n", "type": { "kind": "HttpTypeReference", "ident": "Metadata", "$ref": "(resource) $shared > (model) metadata > (schema)" }, - "oasRef": "#/components/schemas/RunStepObject/properties/metadata", - "deprecated": false, - "schemaType": "map", + "optional": false, + "nullable": true, "modelImplicit": false, + "schemaType": "map", "modelPath": "(resource) $shared > (model) metadata", "children": [] }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) object": { "kind": "HttpDeclProperty", - "docstring": "The object type, which is always `thread.run.step`.", + "oasRef": "#/components/schemas/RunStepObject/properties/object", + "deprecated": false, "key": "object", - "optional": false, - "nullable": false, + "docstring": "The object type, which is always `thread.run.step`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepObject/properties/object", "types": [ { "kind": "HttpTypeLiteral", "literal": "thread.run.step" } - ], - "oasRef": "#/components/schemas/RunStepObject/properties/object" + ] }, - "oasRef": "#/components/schemas/RunStepObject/properties/object", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -28964,26 +28966,27 @@ 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](/docs/api-reference/runs) that this run step is a part of.", + "oasRef": "#/components/schemas/RunStepObject/properties/run_id", + "deprecated": false, "key": "run_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the [run](/docs/api-reference/runs) that this run step is a part of.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepObject/properties/run_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) status": { "kind": "HttpDeclProperty", - "docstring": "The status of the run step, which can be either `in_progress`, `cancelled`, `failed`, `completed`, or `expired`.", + "oasRef": "#/components/schemas/RunStepObject/properties/status", + "deprecated": false, "key": "status", - "optional": false, - "nullable": false, + "docstring": "The status of the run step, which can be either `in_progress`, `cancelled`, `failed`, `completed`, or `expired`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepObject/properties/status", "types": [ { "kind": "HttpTypeLiteral", @@ -29005,11 +29008,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "expired" } - ], - "oasRef": "#/components/schemas/RunStepObject/properties/status" + ] }, - "oasRef": "#/components/schemas/RunStepObject/properties/status", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -29022,12 +29024,13 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) step_details": { "kind": "HttpDeclProperty", - "docstring": "The details of the run step.", + "oasRef": "#/components/schemas/RunStepObject/properties/step_details", + "deprecated": false, "key": "step_details", - "optional": false, - "nullable": false, + "docstring": "The details of the run step.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepObject/properties/step_details", "types": [ { "kind": "HttpTypeReference", @@ -29039,11 +29042,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "ident": "ToolCallsStepDetails", "$ref": "(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema)" } - ], - "oasRef": "#/components/schemas/RunStepObject/properties/step_details" + ] }, - "oasRef": "#/components/schemas/RunStepObject/properties/step_details", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "union", "childrenParentSchema": "union", "children": [ @@ -29053,26 +29055,27 @@ 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](/docs/api-reference/threads) that was run.", + "oasRef": "#/components/schemas/RunStepObject/properties/thread_id", + "deprecated": false, "key": "thread_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the [thread](/docs/api-reference/threads) that was run.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepObject/properties/thread_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of run step, which can be either `message_creation` or `tool_calls`.", + "oasRef": "#/components/schemas/RunStepObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of run step, which can be either `message_creation` or `tool_calls`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", @@ -29082,11 +29085,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "tool_calls" } - ], - "oasRef": "#/components/schemas/RunStepObject/properties/type" + ] }, - "oasRef": "#/components/schemas/RunStepObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -29096,10 +29098,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) usage": { "kind": "HttpDeclProperty", - "docstring": "Usage statistics related to the run step. This value will be `null` while the run step's status is `in_progress`.", + "oasRef": "#/components/schemas/RunStepObject/properties/usage", + "deprecated": false, "key": "usage", - "optional": false, - "nullable": true, + "docstring": "Usage statistics related to the run step. This value will be `null` while the run step's status is `in_progress`.", "type": { "kind": "HttpTypeObject", "members": [ @@ -29114,8 +29116,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunStepObject/properties/usage", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -29127,6 +29129,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.runs.steps > (model) run_step > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RunStepObject", + "docstring": "Represents a step in execution of a run.\n", "ident": "RunStep", "type": { "kind": "HttpTypeObject", @@ -29181,7 +29184,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Represents a step in execution of a run.\n", "childrenParentSchema": "object", "children": [ "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) id", @@ -29211,12 +29213,13 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) last_error > (property) code": { "kind": "HttpDeclProperty", - "docstring": "One of `server_error` or `rate_limit_exceeded`.", + "oasRef": "#/components/schemas/RunStepObject/properties/last_error/anyOf/0/properties/code", + "deprecated": false, "key": "code", - "optional": false, - "nullable": false, + "docstring": "One of `server_error` or `rate_limit_exceeded`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepObject/properties/last_error/anyOf/0/properties/code", "types": [ { "kind": "HttpTypeLiteral", @@ -29226,11 +29229,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "rate_limit_exceeded" } - ], - "oasRef": "#/components/schemas/RunStepObject/properties/last_error/anyOf/0/properties/code" + ] }, - "oasRef": "#/components/schemas/RunStepObject/properties/last_error/anyOf/0/properties/code", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -29240,24 +29242,26 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) last_error > (property) message": { "kind": "HttpDeclProperty", - "docstring": "A human-readable description of the error.", + "oasRef": "#/components/schemas/RunStepObject/properties/last_error/anyOf/0/properties/message", + "deprecated": false, "key": "message", - "optional": false, - "nullable": false, + "docstring": "A human-readable description of the error.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepObject/properties/last_error/anyOf/0/properties/message", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) $shared > (model) metadata > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/Metadata", + "docstring": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.\n", "ident": "Metadata", "type": { "kind": "HttpTypeReference", + "oasRef": "#/components/schemas/Metadata", "ident": "Record", "typeParameters": [ { @@ -29266,10 +29270,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch { "kind": "HttpTypeString" } - ], - "oasRef": "#/components/schemas/Metadata" + ] }, - "docstring": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.\n", "children": [] }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) object > (member) 0": { @@ -29343,6 +29345,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.runs.steps > (model) message_creation_step_details > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RunStepDetailsMessageCreationObject", + "docstring": "Details of the message creation by the run step.", "ident": "MessageCreationStepDetails", "type": { "kind": "HttpTypeObject", @@ -29355,7 +29358,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Details of the message creation by the run step.", "childrenParentSchema": "object", "children": [ "(resource) beta.threads.runs.steps > (model) message_creation_step_details > (schema) > (property) message_creation", @@ -29365,6 +29367,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RunStepDetailsToolCallsObject", + "docstring": "Details of the tool call.", "ident": "ToolCallsStepDetails", "type": { "kind": "HttpTypeObject", @@ -29377,7 +29380,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Details of the tool call.", "childrenParentSchema": "object", "children": [ "(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) tool_calls", @@ -29400,43 +29402,43 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) usage > (property) completion_tokens": { "kind": "HttpDeclProperty", - "docstring": "Number of completion tokens used over the course of the run step.", + "oasRef": "#/components/schemas/RunStepCompletionUsage/anyOf/0/properties/completion_tokens", + "deprecated": false, "key": "completion_tokens", - "optional": false, - "nullable": false, + "docstring": "Number of completion tokens used over the course of the run step.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RunStepCompletionUsage/anyOf/0/properties/completion_tokens", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) usage > (property) prompt_tokens": { "kind": "HttpDeclProperty", - "docstring": "Number of prompt tokens used over the course of the run step.", + "oasRef": "#/components/schemas/RunStepCompletionUsage/anyOf/0/properties/prompt_tokens", + "deprecated": false, "key": "prompt_tokens", - "optional": false, - "nullable": false, + "docstring": "Number of prompt tokens used over the course of the run step.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RunStepCompletionUsage/anyOf/0/properties/prompt_tokens", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) usage > (property) total_tokens": { "kind": "HttpDeclProperty", - "docstring": "Total number of tokens used (prompt + completion).", + "oasRef": "#/components/schemas/RunStepCompletionUsage/anyOf/0/properties/total_tokens", + "deprecated": false, "key": "total_tokens", - "optional": false, - "nullable": false, + "docstring": "Total number of tokens used (prompt + completion).", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RunStepCompletionUsage/anyOf/0/properties/total_tokens", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, @@ -29456,9 +29458,9 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) message_creation_step_details > (schema) > (property) message_creation": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RunStepDetailsMessageCreationObject/properties/message_creation", + "deprecated": false, "key": "message_creation", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeObject", "members": [ @@ -29467,8 +29469,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunStepDetailsMessageCreationObject/properties/message_creation", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -29477,22 +29479,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) message_creation_step_details > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "Always `message_creation`.", + "oasRef": "#/components/schemas/RunStepDetailsMessageCreationObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "Always `message_creation`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepDetailsMessageCreationObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "message_creation" } - ], - "oasRef": "#/components/schemas/RunStepDetailsMessageCreationObject/properties/type" + ] }, - "oasRef": "#/components/schemas/RunStepDetailsMessageCreationObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -29501,14 +29503,16 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) tool_calls": { "kind": "HttpDeclProperty", - "docstring": "An array of tool calls the run step was involved in. These can be associated with one of three types of tools: `code_interpreter`, `file_search`, or `function`.\n", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsObject/properties/tool_calls", + "deprecated": false, "key": "tool_calls", - "optional": false, - "nullable": false, + "docstring": "An array of tool calls the run step was involved in. These can be associated with one of three types of tools: `code_interpreter`, `file_search`, or `function`.\n", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsObject/properties/tool_calls", "elementType": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsObject/properties/tool_calls/items", "types": [ { "kind": "HttpTypeReference", @@ -29525,13 +29529,11 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "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" + ] + } }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsObject/properties/tool_calls", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "array", "childrenParentSchema": "union", "children": [ @@ -29542,22 +29544,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "Always `tool_calls`.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "Always `tool_calls`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "tool_calls" } - ], - "oasRef": "#/components/schemas/RunStepDetailsToolCallsObject/properties/type" + ] }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -29566,15 +29568,15 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) message_creation_step_details > (schema) > (property) message_creation > (property) message_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the message that was created by this run step.", + "oasRef": "#/components/schemas/RunStepDetailsMessageCreationObject/properties/message_creation/properties/message_id", + "deprecated": false, "key": "message_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the message that was created by this run step.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepDetailsMessageCreationObject/properties/message_creation/properties/message_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, @@ -29630,6 +29632,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject", + "docstring": "Details of the Code Interpreter tool call the run step was involved in.", "ident": "CodeInterpreterToolCall", "type": { "kind": "HttpTypeObject", @@ -29645,7 +29648,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "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", @@ -29712,24 +29714,24 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the tool call.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/id", + "deprecated": false, "key": "id", - "optional": false, - "nullable": false, + "docstring": "The ID of the tool call.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/id", - "deprecated": false, + "optional": false, + "nullable": 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.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter", + "deprecated": false, "key": "code_interpreter", - "optional": false, - "nullable": false, + "docstring": "The Code Interpreter tool call definition.", "type": { "kind": "HttpTypeObject", "members": [ @@ -29741,8 +29743,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -29752,22 +29754,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(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.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of tool call. This is always going to be `code_interpreter` for this type of tool call.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "code_interpreter" } - ], - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/type" + ] }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -29776,24 +29778,24 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the tool call object.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/id", + "deprecated": false, "key": "id", - "optional": false, - "nullable": false, + "docstring": "The ID of the tool call object.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/id", - "deprecated": false, + "optional": false, + "nullable": 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.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/file_search", + "deprecated": false, "key": "file_search", - "optional": false, - "nullable": false, + "docstring": "For now, this is always going to be an empty object.", "type": { "kind": "HttpTypeObject", "members": [ @@ -29805,8 +29807,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/file_search", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -29816,22 +29818,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(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.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of tool call. This is always going to be `file_search` for this type of tool call.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "file_search" } - ], - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/type" + ] }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -29840,24 +29842,24 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the tool call object.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/id", + "deprecated": false, "key": "id", - "optional": false, - "nullable": false, + "docstring": "The ID of the tool call object.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/id", - "deprecated": false, + "optional": false, + "nullable": 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.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/function", + "deprecated": false, "key": "function", - "optional": false, - "nullable": false, + "docstring": "The definition of the function that was called.", "type": { "kind": "HttpTypeObject", "members": [ @@ -29872,8 +29874,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/function", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -29884,22 +29886,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(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.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of tool call. This is always going to be `function` for this type of tool call.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "function" } - ], - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/type" + ] }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -29908,28 +29910,30 @@ 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) input": { "kind": "HttpDeclProperty", - "docstring": "The input to the Code Interpreter tool call.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter/properties/input", + "deprecated": false, "key": "input", - "optional": false, - "nullable": false, + "docstring": "The input to the Code Interpreter tool call.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter/properties/input", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs": { "kind": "HttpDeclProperty", - "docstring": "The outputs from the Code Interpreter tool call. Code Interpreter can output one or more items, including text (`logs`) or images (`image`). Each of these are represented by a different object type.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter/properties/outputs", + "deprecated": false, "key": "outputs", - "optional": false, - "nullable": false, + "docstring": "The outputs from the Code Interpreter tool call. Code Interpreter can output one or more items, including text (`logs`) or images (`image`). Each of these are represented by a different object type.", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter/properties/outputs", "elementType": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter/properties/outputs/items", "types": [ { "kind": "HttpTypeObject", @@ -29953,13 +29957,11 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] } - ], - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter/properties/outputs/items" - }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter/properties/outputs" + ] + } }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter/properties/outputs", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "array", "childrenParentSchema": "union", "children": [ @@ -29976,11 +29978,11 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) ranking_options": { "kind": "HttpDeclProperty", - "title": "File search tool call ranking options", - "docstring": "The ranking options for the file search.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/file_search/properties/ranking_options", + "deprecated": false, "key": "ranking_options", - "optional": true, - "nullable": false, + "docstring": "The ranking options for the file search.", + "title": "File search tool call ranking options", "type": { "kind": "HttpTypeObject", "members": [ @@ -29992,8 +29994,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/file_search/properties/ranking_options", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -30003,12 +30005,13 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) results": { "kind": "HttpDeclProperty", - "docstring": "The results of the file search.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/file_search/properties/results", + "deprecated": false, "key": "results", - "optional": true, - "nullable": false, + "docstring": "The results of the file search.", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/file_search/properties/results", "elementType": { "kind": "HttpTypeObject", "members": [ @@ -30025,11 +30028,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "ident": "content" } ] + } }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/file_search/properties/results" - }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/file_search/properties/results", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "array", "childrenParentSchema": "object", "children": [ @@ -30048,43 +30050,43 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) function > (property) arguments": { "kind": "HttpDeclProperty", - "docstring": "The arguments passed to the function.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/function/properties/arguments", + "deprecated": false, "key": "arguments", - "optional": false, - "nullable": false, + "docstring": "The arguments passed to the function.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/function/properties/arguments", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) function > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the function.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/function/properties/name", + "deprecated": false, "key": "name", - "optional": false, - "nullable": false, + "docstring": "The name of the function.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/function/properties/name", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(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](/docs/api-reference/runs/submitToolOutputs) yet.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/function/properties/output", + "deprecated": false, "key": "output", - "optional": false, - "nullable": true, + "docstring": "The output of the function. This will be `null` if the outputs have not been [submitted](/docs/api-reference/runs/submitToolOutputs) yet.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/function/properties/output", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "string", "children": [] }, @@ -30098,6 +30100,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) 0": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter/properties/outputs/items/oneOf/0", + "docstring": "Text output from the Code Interpreter tool call as part of a run step.", "ident": "CodeInterpreterLogOutput", "type": { "kind": "HttpTypeObject", @@ -30110,7 +30113,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Text output from the Code Interpreter tool call as part of a run step.", "childrenParentSchema": "object", "children": [ "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 0 > (property) logs", @@ -30140,12 +30142,13 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) ranking_options > (property) ranker": { "kind": "HttpDeclProperty", - "docstring": "The ranker to use for the file search. If not specified will use the `auto` ranker.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchRankingOptionsObject/properties/ranker", + "deprecated": false, "key": "ranker", - "optional": false, - "nullable": false, + "docstring": "The ranker to use for the file search. If not specified will use the `auto` ranker.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchRankingOptionsObject/properties/ranker", "types": [ { "kind": "HttpTypeLiteral", @@ -30155,11 +30158,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "default_2024_08_21" } - ], - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchRankingOptionsObject/properties/ranker" + ] }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchRankingOptionsObject/properties/ranker", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -30169,10 +30171,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) ranking_options > (property) score_threshold": { "kind": "HttpDeclProperty", - "docstring": "The score threshold for the file search. All values must be a floating point number between 0 and 1.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchRankingOptionsObject/properties/score_threshold", + "deprecated": false, "key": "score_threshold", - "optional": false, - "nullable": false, + "docstring": "The score threshold for the file search. All values must be a floating point number between 0 and 1.", "type": { "kind": "HttpTypeNumber" }, @@ -30180,45 +30182,45 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "minimum": 0, "maximum": 1 }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchRankingOptionsObject/properties/score_threshold", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "number", "children": [] }, "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) results > (items) > (property) file_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the file that result was found in.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/file_id", + "deprecated": false, "key": "file_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the file that result was found in.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/file_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) results > (items) > (property) file_name": { "kind": "HttpDeclProperty", - "docstring": "The name of the file that result was found in.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/file_name", + "deprecated": false, "key": "file_name", - "optional": false, - "nullable": false, + "docstring": "The name of the file that result was found in.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/file_name", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) results > (items) > (property) score": { "kind": "HttpDeclProperty", - "docstring": "The score of the result. All values must be a floating point number between 0 and 1.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/score", + "deprecated": false, "key": "score", - "optional": false, - "nullable": false, + "docstring": "The score of the result. All values must be a floating point number between 0 and 1.", "type": { "kind": "HttpTypeNumber" }, @@ -30226,19 +30228,20 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "minimum": 0, "maximum": 1 }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/score", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "number", "children": [] }, "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) results > (items) > (property) content": { "kind": "HttpDeclProperty", - "docstring": "The content of the result that was found. The content is only included if requested via the include query parameter.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/content", + "deprecated": false, "key": "content", - "optional": true, - "nullable": false, + "docstring": "The content of the result that was found. The content is only included if requested via the include query parameter.", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/content", "elementType": { "kind": "HttpTypeObject", "members": [ @@ -30249,11 +30252,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "ident": "type" } ] + } }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/content" - }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/content", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "array", "childrenParentSchema": "object", "children": [ @@ -30263,36 +30265,36 @@ 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 > (property) logs": { "kind": "HttpDeclProperty", - "docstring": "The text output from the Code Interpreter tool call.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputLogsObject/properties/logs", + "deprecated": false, "key": "logs", - "optional": false, - "nullable": false, + "docstring": "The text output from the Code Interpreter tool call.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputLogsObject/properties/logs", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 0 > (property) type": { "kind": "HttpDeclProperty", - "docstring": "Always `logs`.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputLogsObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "Always `logs`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputLogsObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "logs" } - ], - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputLogsObject/properties/type" + ] }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputLogsObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -30301,9 +30303,9 @@ 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": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputImageObject/properties/image", + "deprecated": false, "key": "image", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeObject", "members": [ @@ -30312,8 +30314,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputImageObject/properties/image", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -30322,22 +30324,22 @@ 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) type": { "kind": "HttpDeclProperty", - "docstring": "Always `image`.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputImageObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "Always `image`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputImageObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "image" } - ], - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputImageObject/properties/type" + ] }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputImageObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -30360,36 +30362,36 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) results > (items) > (property) content > (items) > (property) text": { "kind": "HttpDeclProperty", - "docstring": "The text content of the file.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/content/items/properties/text", + "deprecated": false, "key": "text", - "optional": true, - "nullable": false, + "docstring": "The text content of the file.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/content/items/properties/text", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) results > (items) > (property) content > (items) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the content.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/content/items/properties/type", + "deprecated": false, "key": "type", - "optional": true, - "nullable": false, + "docstring": "The type of the content.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/content/items/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "text" } - ], - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/content/items/properties/type" + ] }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/content/items/properties/type", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -30405,15 +30407,15 @@ 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](/docs/api-reference/files) ID of the image.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputImageObject/properties/image/properties/file_id", + "deprecated": false, "key": "file_id", - "optional": false, - "nullable": false, + "docstring": "The [file](/docs/api-reference/files) ID of the image.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputImageObject/properties/image/properties/file_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, @@ -30453,7 +30455,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/oneOf/4", - "ident": "UnionMember15", + "docstring": "Occurs when a [run step](/docs/api-reference/run-steps/step-object) fails.", + "ident": "ThreadRunStepFailed", "type": { "kind": "HttpTypeObject", "members": [ @@ -30465,7 +30468,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "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", @@ -30474,20 +30476,20 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 15 > (property) data": { "kind": "HttpDeclProperty", - "title": "Run steps", - "docstring": "Represents a step in execution of a run.\n", + "oasRef": "#/components/schemas/RunStepStreamEvent/oneOf/4/properties/data", + "deprecated": false, "key": "data", - "optional": false, - "nullable": false, + "docstring": "Represents a step in execution of a run.\n", + "title": "Run steps", "type": { "kind": "HttpTypeReference", "ident": "RunStep", "$ref": "(resource) beta.threads.runs.steps > (model) run_step > (schema)" }, - "oasRef": "#/components/schemas/RunStepStreamEvent/oneOf/4/properties/data", - "deprecated": false, - "schemaType": "object", + "optional": false, + "nullable": false, "modelImplicit": false, + "schemaType": "object", "modelPath": "(resource) beta.threads.runs.steps > (model) run_step", "childrenParentSchema": "object", "children": [ @@ -30511,21 +30513,21 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 15 > (property) event": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RunStepStreamEvent/oneOf/4/properties/event", + "deprecated": false, "key": "event", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepStreamEvent/oneOf/4/properties/event", "types": [ { "kind": "HttpTypeLiteral", "literal": "thread.run.step.failed" } - ], - "oasRef": "#/components/schemas/RunStepStreamEvent/oneOf/4/properties/event" + ] }, - "oasRef": "#/components/schemas/RunStepStreamEvent/oneOf/4/properties/event", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -30534,123 +30536,123 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The identifier of the run step, which can be referenced in API endpoints.", + "oasRef": "#/components/schemas/RunStepObject/properties/id", + "deprecated": false, "key": "id", - "optional": false, - "nullable": false, + "docstring": "The identifier of the run step, which can be referenced in API endpoints.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepObject/properties/id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) assistant_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the [assistant](/docs/api-reference/assistants) associated with the run step.", + "oasRef": "#/components/schemas/RunStepObject/properties/assistant_id", + "deprecated": false, "key": "assistant_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the [assistant](/docs/api-reference/assistants) associated with the run step.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepObject/properties/assistant_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) cancelled_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the run step was cancelled.", + "oasRef": "#/components/schemas/RunStepObject/properties/cancelled_at", + "deprecated": false, "key": "cancelled_at", - "optional": false, - "nullable": true, + "docstring": "The Unix timestamp (in seconds) for when the run step was cancelled.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/RunStepObject/properties/cancelled_at", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) completed_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the run step completed.", + "oasRef": "#/components/schemas/RunStepObject/properties/completed_at", + "deprecated": false, "key": "completed_at", - "optional": false, - "nullable": true, + "docstring": "The Unix timestamp (in seconds) for when the run step completed.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/RunStepObject/properties/completed_at", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) created_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the run step was created.", + "oasRef": "#/components/schemas/RunStepObject/properties/created_at", + "deprecated": false, "key": "created_at", - "optional": false, - "nullable": false, + "docstring": "The Unix timestamp (in seconds) for when the run step was created.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/RunStepObject/properties/created_at", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) expired_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the run step expired. A step is considered expired if the parent run is expired.", + "oasRef": "#/components/schemas/RunStepObject/properties/expired_at", + "deprecated": false, "key": "expired_at", - "optional": false, - "nullable": true, + "docstring": "The Unix timestamp (in seconds) for when the run step expired. A step is considered expired if the parent run is expired.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/RunStepObject/properties/expired_at", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) failed_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the run step failed.", + "oasRef": "#/components/schemas/RunStepObject/properties/failed_at", + "deprecated": false, "key": "failed_at", - "optional": false, - "nullable": true, + "docstring": "The Unix timestamp (in seconds) for when the run step failed.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/RunStepObject/properties/failed_at", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) last_error": { "kind": "HttpDeclProperty", - "docstring": "The last error associated with this run step. Will be `null` if there are no errors.", + "oasRef": "#/components/schemas/RunStepObject/properties/last_error", + "deprecated": false, "key": "last_error", - "optional": false, - "nullable": true, + "docstring": "The last error associated with this run step. Will be `null` if there are no errors.", "type": { "kind": "HttpTypeObject", "members": [ @@ -30662,8 +30664,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunStepObject/properties/last_error", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -30673,40 +30675,40 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) metadata": { "kind": "HttpDeclProperty", - "docstring": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.\n", + "oasRef": "#/components/schemas/RunStepObject/properties/metadata", + "deprecated": false, "key": "metadata", - "optional": false, - "nullable": true, + "docstring": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.\n", "type": { "kind": "HttpTypeReference", "ident": "Metadata", "$ref": "(resource) $shared > (model) metadata > (schema)" }, - "oasRef": "#/components/schemas/RunStepObject/properties/metadata", - "deprecated": false, - "schemaType": "map", + "optional": false, + "nullable": true, "modelImplicit": false, + "schemaType": "map", "modelPath": "(resource) $shared > (model) metadata", "children": [] }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) object": { "kind": "HttpDeclProperty", - "docstring": "The object type, which is always `thread.run.step`.", + "oasRef": "#/components/schemas/RunStepObject/properties/object", + "deprecated": false, "key": "object", - "optional": false, - "nullable": false, + "docstring": "The object type, which is always `thread.run.step`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepObject/properties/object", "types": [ { "kind": "HttpTypeLiteral", "literal": "thread.run.step" } - ], - "oasRef": "#/components/schemas/RunStepObject/properties/object" + ] }, - "oasRef": "#/components/schemas/RunStepObject/properties/object", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -30715,26 +30717,27 @@ 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](/docs/api-reference/runs) that this run step is a part of.", + "oasRef": "#/components/schemas/RunStepObject/properties/run_id", + "deprecated": false, "key": "run_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the [run](/docs/api-reference/runs) that this run step is a part of.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepObject/properties/run_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) status": { "kind": "HttpDeclProperty", - "docstring": "The status of the run step, which can be either `in_progress`, `cancelled`, `failed`, `completed`, or `expired`.", + "oasRef": "#/components/schemas/RunStepObject/properties/status", + "deprecated": false, "key": "status", - "optional": false, - "nullable": false, + "docstring": "The status of the run step, which can be either `in_progress`, `cancelled`, `failed`, `completed`, or `expired`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepObject/properties/status", "types": [ { "kind": "HttpTypeLiteral", @@ -30756,11 +30759,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "expired" } - ], - "oasRef": "#/components/schemas/RunStepObject/properties/status" + ] }, - "oasRef": "#/components/schemas/RunStepObject/properties/status", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -30773,12 +30775,13 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) step_details": { "kind": "HttpDeclProperty", - "docstring": "The details of the run step.", + "oasRef": "#/components/schemas/RunStepObject/properties/step_details", + "deprecated": false, "key": "step_details", - "optional": false, - "nullable": false, + "docstring": "The details of the run step.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepObject/properties/step_details", "types": [ { "kind": "HttpTypeReference", @@ -30790,11 +30793,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "ident": "ToolCallsStepDetails", "$ref": "(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema)" } - ], - "oasRef": "#/components/schemas/RunStepObject/properties/step_details" + ] }, - "oasRef": "#/components/schemas/RunStepObject/properties/step_details", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "union", "childrenParentSchema": "union", "children": [ @@ -30804,26 +30806,27 @@ 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](/docs/api-reference/threads) that was run.", + "oasRef": "#/components/schemas/RunStepObject/properties/thread_id", + "deprecated": false, "key": "thread_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the [thread](/docs/api-reference/threads) that was run.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepObject/properties/thread_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of run step, which can be either `message_creation` or `tool_calls`.", + "oasRef": "#/components/schemas/RunStepObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of run step, which can be either `message_creation` or `tool_calls`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", @@ -30833,11 +30836,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "tool_calls" } - ], - "oasRef": "#/components/schemas/RunStepObject/properties/type" + ] }, - "oasRef": "#/components/schemas/RunStepObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -30847,10 +30849,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) usage": { "kind": "HttpDeclProperty", - "docstring": "Usage statistics related to the run step. This value will be `null` while the run step's status is `in_progress`.", + "oasRef": "#/components/schemas/RunStepObject/properties/usage", + "deprecated": false, "key": "usage", - "optional": false, - "nullable": true, + "docstring": "Usage statistics related to the run step. This value will be `null` while the run step's status is `in_progress`.", "type": { "kind": "HttpTypeObject", "members": [ @@ -30865,8 +30867,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunStepObject/properties/usage", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -30878,6 +30880,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.runs.steps > (model) run_step > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RunStepObject", + "docstring": "Represents a step in execution of a run.\n", "ident": "RunStep", "type": { "kind": "HttpTypeObject", @@ -30932,7 +30935,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Represents a step in execution of a run.\n", "childrenParentSchema": "object", "children": [ "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) id", @@ -30962,12 +30964,13 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) last_error > (property) code": { "kind": "HttpDeclProperty", - "docstring": "One of `server_error` or `rate_limit_exceeded`.", + "oasRef": "#/components/schemas/RunStepObject/properties/last_error/anyOf/0/properties/code", + "deprecated": false, "key": "code", - "optional": false, - "nullable": false, + "docstring": "One of `server_error` or `rate_limit_exceeded`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepObject/properties/last_error/anyOf/0/properties/code", "types": [ { "kind": "HttpTypeLiteral", @@ -30977,11 +30980,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "rate_limit_exceeded" } - ], - "oasRef": "#/components/schemas/RunStepObject/properties/last_error/anyOf/0/properties/code" + ] }, - "oasRef": "#/components/schemas/RunStepObject/properties/last_error/anyOf/0/properties/code", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -30991,24 +30993,26 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) last_error > (property) message": { "kind": "HttpDeclProperty", - "docstring": "A human-readable description of the error.", + "oasRef": "#/components/schemas/RunStepObject/properties/last_error/anyOf/0/properties/message", + "deprecated": false, "key": "message", - "optional": false, - "nullable": false, + "docstring": "A human-readable description of the error.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepObject/properties/last_error/anyOf/0/properties/message", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) $shared > (model) metadata > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/Metadata", + "docstring": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.\n", "ident": "Metadata", "type": { "kind": "HttpTypeReference", + "oasRef": "#/components/schemas/Metadata", "ident": "Record", "typeParameters": [ { @@ -31017,10 +31021,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch { "kind": "HttpTypeString" } - ], - "oasRef": "#/components/schemas/Metadata" + ] }, - "docstring": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.\n", "children": [] }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) object > (member) 0": { @@ -31094,6 +31096,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.runs.steps > (model) message_creation_step_details > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RunStepDetailsMessageCreationObject", + "docstring": "Details of the message creation by the run step.", "ident": "MessageCreationStepDetails", "type": { "kind": "HttpTypeObject", @@ -31106,7 +31109,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Details of the message creation by the run step.", "childrenParentSchema": "object", "children": [ "(resource) beta.threads.runs.steps > (model) message_creation_step_details > (schema) > (property) message_creation", @@ -31116,6 +31118,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RunStepDetailsToolCallsObject", + "docstring": "Details of the tool call.", "ident": "ToolCallsStepDetails", "type": { "kind": "HttpTypeObject", @@ -31128,7 +31131,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Details of the tool call.", "childrenParentSchema": "object", "children": [ "(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) tool_calls", @@ -31151,43 +31153,43 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) usage > (property) completion_tokens": { "kind": "HttpDeclProperty", - "docstring": "Number of completion tokens used over the course of the run step.", + "oasRef": "#/components/schemas/RunStepCompletionUsage/anyOf/0/properties/completion_tokens", + "deprecated": false, "key": "completion_tokens", - "optional": false, - "nullable": false, + "docstring": "Number of completion tokens used over the course of the run step.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RunStepCompletionUsage/anyOf/0/properties/completion_tokens", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) usage > (property) prompt_tokens": { "kind": "HttpDeclProperty", - "docstring": "Number of prompt tokens used over the course of the run step.", + "oasRef": "#/components/schemas/RunStepCompletionUsage/anyOf/0/properties/prompt_tokens", + "deprecated": false, "key": "prompt_tokens", - "optional": false, - "nullable": false, + "docstring": "Number of prompt tokens used over the course of the run step.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RunStepCompletionUsage/anyOf/0/properties/prompt_tokens", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) usage > (property) total_tokens": { "kind": "HttpDeclProperty", - "docstring": "Total number of tokens used (prompt + completion).", + "oasRef": "#/components/schemas/RunStepCompletionUsage/anyOf/0/properties/total_tokens", + "deprecated": false, "key": "total_tokens", - "optional": false, - "nullable": false, + "docstring": "Total number of tokens used (prompt + completion).", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RunStepCompletionUsage/anyOf/0/properties/total_tokens", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, @@ -31207,9 +31209,9 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) message_creation_step_details > (schema) > (property) message_creation": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RunStepDetailsMessageCreationObject/properties/message_creation", + "deprecated": false, "key": "message_creation", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeObject", "members": [ @@ -31218,8 +31220,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunStepDetailsMessageCreationObject/properties/message_creation", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -31228,22 +31230,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) message_creation_step_details > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "Always `message_creation`.", + "oasRef": "#/components/schemas/RunStepDetailsMessageCreationObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "Always `message_creation`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepDetailsMessageCreationObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "message_creation" } - ], - "oasRef": "#/components/schemas/RunStepDetailsMessageCreationObject/properties/type" + ] }, - "oasRef": "#/components/schemas/RunStepDetailsMessageCreationObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -31252,14 +31254,16 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) tool_calls": { "kind": "HttpDeclProperty", - "docstring": "An array of tool calls the run step was involved in. These can be associated with one of three types of tools: `code_interpreter`, `file_search`, or `function`.\n", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsObject/properties/tool_calls", + "deprecated": false, "key": "tool_calls", - "optional": false, - "nullable": false, + "docstring": "An array of tool calls the run step was involved in. These can be associated with one of three types of tools: `code_interpreter`, `file_search`, or `function`.\n", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsObject/properties/tool_calls", "elementType": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsObject/properties/tool_calls/items", "types": [ { "kind": "HttpTypeReference", @@ -31276,13 +31280,11 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "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" + ] + } }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsObject/properties/tool_calls", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "array", "childrenParentSchema": "union", "children": [ @@ -31293,22 +31295,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "Always `tool_calls`.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "Always `tool_calls`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "tool_calls" } - ], - "oasRef": "#/components/schemas/RunStepDetailsToolCallsObject/properties/type" + ] }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -31317,15 +31319,15 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) message_creation_step_details > (schema) > (property) message_creation > (property) message_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the message that was created by this run step.", + "oasRef": "#/components/schemas/RunStepDetailsMessageCreationObject/properties/message_creation/properties/message_id", + "deprecated": false, "key": "message_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the message that was created by this run step.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepDetailsMessageCreationObject/properties/message_creation/properties/message_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, @@ -31381,6 +31383,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject", + "docstring": "Details of the Code Interpreter tool call the run step was involved in.", "ident": "CodeInterpreterToolCall", "type": { "kind": "HttpTypeObject", @@ -31396,7 +31399,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "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", @@ -31463,24 +31465,24 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the tool call.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/id", + "deprecated": false, "key": "id", - "optional": false, - "nullable": false, + "docstring": "The ID of the tool call.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/id", - "deprecated": false, + "optional": false, + "nullable": 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.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter", + "deprecated": false, "key": "code_interpreter", - "optional": false, - "nullable": false, + "docstring": "The Code Interpreter tool call definition.", "type": { "kind": "HttpTypeObject", "members": [ @@ -31492,8 +31494,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -31503,22 +31505,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(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.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of tool call. This is always going to be `code_interpreter` for this type of tool call.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "code_interpreter" } - ], - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/type" + ] }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -31527,24 +31529,24 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the tool call object.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/id", + "deprecated": false, "key": "id", - "optional": false, - "nullable": false, + "docstring": "The ID of the tool call object.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/id", - "deprecated": false, + "optional": false, + "nullable": 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.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/file_search", + "deprecated": false, "key": "file_search", - "optional": false, - "nullable": false, + "docstring": "For now, this is always going to be an empty object.", "type": { "kind": "HttpTypeObject", "members": [ @@ -31556,8 +31558,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/file_search", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -31567,22 +31569,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(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.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of tool call. This is always going to be `file_search` for this type of tool call.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "file_search" } - ], - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/type" + ] }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -31591,24 +31593,24 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the tool call object.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/id", + "deprecated": false, "key": "id", - "optional": false, - "nullable": false, + "docstring": "The ID of the tool call object.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/id", - "deprecated": false, + "optional": false, + "nullable": 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.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/function", + "deprecated": false, "key": "function", - "optional": false, - "nullable": false, + "docstring": "The definition of the function that was called.", "type": { "kind": "HttpTypeObject", "members": [ @@ -31623,8 +31625,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/function", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -31635,22 +31637,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(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.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of tool call. This is always going to be `function` for this type of tool call.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "function" } - ], - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/type" + ] }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -31659,28 +31661,30 @@ 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) input": { "kind": "HttpDeclProperty", - "docstring": "The input to the Code Interpreter tool call.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter/properties/input", + "deprecated": false, "key": "input", - "optional": false, - "nullable": false, + "docstring": "The input to the Code Interpreter tool call.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter/properties/input", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs": { "kind": "HttpDeclProperty", - "docstring": "The outputs from the Code Interpreter tool call. Code Interpreter can output one or more items, including text (`logs`) or images (`image`). Each of these are represented by a different object type.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter/properties/outputs", + "deprecated": false, "key": "outputs", - "optional": false, - "nullable": false, + "docstring": "The outputs from the Code Interpreter tool call. Code Interpreter can output one or more items, including text (`logs`) or images (`image`). Each of these are represented by a different object type.", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter/properties/outputs", "elementType": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter/properties/outputs/items", "types": [ { "kind": "HttpTypeObject", @@ -31704,13 +31708,11 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] } - ], - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter/properties/outputs/items" - }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter/properties/outputs" + ] + } }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter/properties/outputs", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "array", "childrenParentSchema": "union", "children": [ @@ -31727,11 +31729,11 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) ranking_options": { "kind": "HttpDeclProperty", - "title": "File search tool call ranking options", - "docstring": "The ranking options for the file search.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/file_search/properties/ranking_options", + "deprecated": false, "key": "ranking_options", - "optional": true, - "nullable": false, + "docstring": "The ranking options for the file search.", + "title": "File search tool call ranking options", "type": { "kind": "HttpTypeObject", "members": [ @@ -31743,8 +31745,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/file_search/properties/ranking_options", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -31754,12 +31756,13 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) results": { "kind": "HttpDeclProperty", - "docstring": "The results of the file search.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/file_search/properties/results", + "deprecated": false, "key": "results", - "optional": true, - "nullable": false, + "docstring": "The results of the file search.", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/file_search/properties/results", "elementType": { "kind": "HttpTypeObject", "members": [ @@ -31776,11 +31779,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "ident": "content" } ] + } }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/file_search/properties/results" - }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/file_search/properties/results", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "array", "childrenParentSchema": "object", "children": [ @@ -31799,43 +31801,43 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) function > (property) arguments": { "kind": "HttpDeclProperty", - "docstring": "The arguments passed to the function.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/function/properties/arguments", + "deprecated": false, "key": "arguments", - "optional": false, - "nullable": false, + "docstring": "The arguments passed to the function.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/function/properties/arguments", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) function > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the function.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/function/properties/name", + "deprecated": false, "key": "name", - "optional": false, - "nullable": false, + "docstring": "The name of the function.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/function/properties/name", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(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](/docs/api-reference/runs/submitToolOutputs) yet.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/function/properties/output", + "deprecated": false, "key": "output", - "optional": false, - "nullable": true, + "docstring": "The output of the function. This will be `null` if the outputs have not been [submitted](/docs/api-reference/runs/submitToolOutputs) yet.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/function/properties/output", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "string", "children": [] }, @@ -31849,6 +31851,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) 0": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter/properties/outputs/items/oneOf/0", + "docstring": "Text output from the Code Interpreter tool call as part of a run step.", "ident": "CodeInterpreterLogOutput", "type": { "kind": "HttpTypeObject", @@ -31861,7 +31864,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Text output from the Code Interpreter tool call as part of a run step.", "childrenParentSchema": "object", "children": [ "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 0 > (property) logs", @@ -31891,12 +31893,13 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) ranking_options > (property) ranker": { "kind": "HttpDeclProperty", - "docstring": "The ranker to use for the file search. If not specified will use the `auto` ranker.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchRankingOptionsObject/properties/ranker", + "deprecated": false, "key": "ranker", - "optional": false, - "nullable": false, + "docstring": "The ranker to use for the file search. If not specified will use the `auto` ranker.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchRankingOptionsObject/properties/ranker", "types": [ { "kind": "HttpTypeLiteral", @@ -31906,11 +31909,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "default_2024_08_21" } - ], - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchRankingOptionsObject/properties/ranker" + ] }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchRankingOptionsObject/properties/ranker", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -31920,10 +31922,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) ranking_options > (property) score_threshold": { "kind": "HttpDeclProperty", - "docstring": "The score threshold for the file search. All values must be a floating point number between 0 and 1.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchRankingOptionsObject/properties/score_threshold", + "deprecated": false, "key": "score_threshold", - "optional": false, - "nullable": false, + "docstring": "The score threshold for the file search. All values must be a floating point number between 0 and 1.", "type": { "kind": "HttpTypeNumber" }, @@ -31931,45 +31933,45 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "minimum": 0, "maximum": 1 }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchRankingOptionsObject/properties/score_threshold", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "number", "children": [] }, "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) results > (items) > (property) file_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the file that result was found in.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/file_id", + "deprecated": false, "key": "file_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the file that result was found in.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/file_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) results > (items) > (property) file_name": { "kind": "HttpDeclProperty", - "docstring": "The name of the file that result was found in.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/file_name", + "deprecated": false, "key": "file_name", - "optional": false, - "nullable": false, + "docstring": "The name of the file that result was found in.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/file_name", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) results > (items) > (property) score": { "kind": "HttpDeclProperty", - "docstring": "The score of the result. All values must be a floating point number between 0 and 1.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/score", + "deprecated": false, "key": "score", - "optional": false, - "nullable": false, + "docstring": "The score of the result. All values must be a floating point number between 0 and 1.", "type": { "kind": "HttpTypeNumber" }, @@ -31977,19 +31979,20 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "minimum": 0, "maximum": 1 }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/score", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "number", "children": [] }, "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) results > (items) > (property) content": { "kind": "HttpDeclProperty", - "docstring": "The content of the result that was found. The content is only included if requested via the include query parameter.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/content", + "deprecated": false, "key": "content", - "optional": true, - "nullable": false, + "docstring": "The content of the result that was found. The content is only included if requested via the include query parameter.", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/content", "elementType": { "kind": "HttpTypeObject", "members": [ @@ -32000,11 +32003,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "ident": "type" } ] + } }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/content" - }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/content", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "array", "childrenParentSchema": "object", "children": [ @@ -32014,36 +32016,36 @@ 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 > (property) logs": { "kind": "HttpDeclProperty", - "docstring": "The text output from the Code Interpreter tool call.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputLogsObject/properties/logs", + "deprecated": false, "key": "logs", - "optional": false, - "nullable": false, + "docstring": "The text output from the Code Interpreter tool call.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputLogsObject/properties/logs", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 0 > (property) type": { "kind": "HttpDeclProperty", - "docstring": "Always `logs`.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputLogsObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "Always `logs`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputLogsObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "logs" } - ], - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputLogsObject/properties/type" + ] }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputLogsObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -32052,9 +32054,9 @@ 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": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputImageObject/properties/image", + "deprecated": false, "key": "image", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeObject", "members": [ @@ -32063,8 +32065,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputImageObject/properties/image", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -32073,22 +32075,22 @@ 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) type": { "kind": "HttpDeclProperty", - "docstring": "Always `image`.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputImageObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "Always `image`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputImageObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "image" } - ], - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputImageObject/properties/type" + ] }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputImageObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -32111,36 +32113,36 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) results > (items) > (property) content > (items) > (property) text": { "kind": "HttpDeclProperty", - "docstring": "The text content of the file.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/content/items/properties/text", + "deprecated": false, "key": "text", - "optional": true, - "nullable": false, + "docstring": "The text content of the file.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/content/items/properties/text", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) results > (items) > (property) content > (items) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the content.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/content/items/properties/type", + "deprecated": false, "key": "type", - "optional": true, - "nullable": false, + "docstring": "The type of the content.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/content/items/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "text" } - ], - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/content/items/properties/type" + ] }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/content/items/properties/type", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -32156,15 +32158,15 @@ 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](/docs/api-reference/files) ID of the image.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputImageObject/properties/image/properties/file_id", + "deprecated": false, "key": "file_id", - "optional": false, - "nullable": false, + "docstring": "The [file](/docs/api-reference/files) ID of the image.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputImageObject/properties/image/properties/file_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, @@ -32204,7 +32206,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/oneOf/5", - "ident": "UnionMember16", + "docstring": "Occurs when a [run step](/docs/api-reference/run-steps/step-object) is cancelled.", + "ident": "ThreadRunStepCancelled", "type": { "kind": "HttpTypeObject", "members": [ @@ -32216,7 +32219,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "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", @@ -32225,20 +32227,20 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 16 > (property) data": { "kind": "HttpDeclProperty", - "title": "Run steps", - "docstring": "Represents a step in execution of a run.\n", + "oasRef": "#/components/schemas/RunStepStreamEvent/oneOf/5/properties/data", + "deprecated": false, "key": "data", - "optional": false, - "nullable": false, + "docstring": "Represents a step in execution of a run.\n", + "title": "Run steps", "type": { "kind": "HttpTypeReference", "ident": "RunStep", "$ref": "(resource) beta.threads.runs.steps > (model) run_step > (schema)" }, - "oasRef": "#/components/schemas/RunStepStreamEvent/oneOf/5/properties/data", - "deprecated": false, - "schemaType": "object", + "optional": false, + "nullable": false, "modelImplicit": false, + "schemaType": "object", "modelPath": "(resource) beta.threads.runs.steps > (model) run_step", "childrenParentSchema": "object", "children": [ @@ -32262,21 +32264,21 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 16 > (property) event": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RunStepStreamEvent/oneOf/5/properties/event", + "deprecated": false, "key": "event", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepStreamEvent/oneOf/5/properties/event", "types": [ { "kind": "HttpTypeLiteral", "literal": "thread.run.step.cancelled" } - ], - "oasRef": "#/components/schemas/RunStepStreamEvent/oneOf/5/properties/event" + ] }, - "oasRef": "#/components/schemas/RunStepStreamEvent/oneOf/5/properties/event", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -32285,123 +32287,123 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The identifier of the run step, which can be referenced in API endpoints.", + "oasRef": "#/components/schemas/RunStepObject/properties/id", + "deprecated": false, "key": "id", - "optional": false, - "nullable": false, + "docstring": "The identifier of the run step, which can be referenced in API endpoints.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepObject/properties/id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) assistant_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the [assistant](/docs/api-reference/assistants) associated with the run step.", + "oasRef": "#/components/schemas/RunStepObject/properties/assistant_id", + "deprecated": false, "key": "assistant_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the [assistant](/docs/api-reference/assistants) associated with the run step.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepObject/properties/assistant_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) cancelled_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the run step was cancelled.", + "oasRef": "#/components/schemas/RunStepObject/properties/cancelled_at", + "deprecated": false, "key": "cancelled_at", - "optional": false, - "nullable": true, + "docstring": "The Unix timestamp (in seconds) for when the run step was cancelled.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/RunStepObject/properties/cancelled_at", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) completed_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the run step completed.", + "oasRef": "#/components/schemas/RunStepObject/properties/completed_at", + "deprecated": false, "key": "completed_at", - "optional": false, - "nullable": true, + "docstring": "The Unix timestamp (in seconds) for when the run step completed.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/RunStepObject/properties/completed_at", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) created_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the run step was created.", + "oasRef": "#/components/schemas/RunStepObject/properties/created_at", + "deprecated": false, "key": "created_at", - "optional": false, - "nullable": false, + "docstring": "The Unix timestamp (in seconds) for when the run step was created.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/RunStepObject/properties/created_at", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) expired_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the run step expired. A step is considered expired if the parent run is expired.", + "oasRef": "#/components/schemas/RunStepObject/properties/expired_at", + "deprecated": false, "key": "expired_at", - "optional": false, - "nullable": true, + "docstring": "The Unix timestamp (in seconds) for when the run step expired. A step is considered expired if the parent run is expired.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/RunStepObject/properties/expired_at", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) failed_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the run step failed.", + "oasRef": "#/components/schemas/RunStepObject/properties/failed_at", + "deprecated": false, "key": "failed_at", - "optional": false, - "nullable": true, + "docstring": "The Unix timestamp (in seconds) for when the run step failed.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/RunStepObject/properties/failed_at", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) last_error": { "kind": "HttpDeclProperty", - "docstring": "The last error associated with this run step. Will be `null` if there are no errors.", + "oasRef": "#/components/schemas/RunStepObject/properties/last_error", + "deprecated": false, "key": "last_error", - "optional": false, - "nullable": true, + "docstring": "The last error associated with this run step. Will be `null` if there are no errors.", "type": { "kind": "HttpTypeObject", "members": [ @@ -32413,8 +32415,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunStepObject/properties/last_error", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -32424,40 +32426,40 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) metadata": { "kind": "HttpDeclProperty", - "docstring": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.\n", + "oasRef": "#/components/schemas/RunStepObject/properties/metadata", + "deprecated": false, "key": "metadata", - "optional": false, - "nullable": true, + "docstring": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.\n", "type": { "kind": "HttpTypeReference", "ident": "Metadata", "$ref": "(resource) $shared > (model) metadata > (schema)" }, - "oasRef": "#/components/schemas/RunStepObject/properties/metadata", - "deprecated": false, - "schemaType": "map", + "optional": false, + "nullable": true, "modelImplicit": false, + "schemaType": "map", "modelPath": "(resource) $shared > (model) metadata", "children": [] }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) object": { "kind": "HttpDeclProperty", - "docstring": "The object type, which is always `thread.run.step`.", + "oasRef": "#/components/schemas/RunStepObject/properties/object", + "deprecated": false, "key": "object", - "optional": false, - "nullable": false, + "docstring": "The object type, which is always `thread.run.step`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepObject/properties/object", "types": [ { "kind": "HttpTypeLiteral", "literal": "thread.run.step" } - ], - "oasRef": "#/components/schemas/RunStepObject/properties/object" + ] }, - "oasRef": "#/components/schemas/RunStepObject/properties/object", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -32466,26 +32468,27 @@ 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](/docs/api-reference/runs) that this run step is a part of.", + "oasRef": "#/components/schemas/RunStepObject/properties/run_id", + "deprecated": false, "key": "run_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the [run](/docs/api-reference/runs) that this run step is a part of.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepObject/properties/run_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) status": { "kind": "HttpDeclProperty", - "docstring": "The status of the run step, which can be either `in_progress`, `cancelled`, `failed`, `completed`, or `expired`.", + "oasRef": "#/components/schemas/RunStepObject/properties/status", + "deprecated": false, "key": "status", - "optional": false, - "nullable": false, + "docstring": "The status of the run step, which can be either `in_progress`, `cancelled`, `failed`, `completed`, or `expired`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepObject/properties/status", "types": [ { "kind": "HttpTypeLiteral", @@ -32507,11 +32510,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "expired" } - ], - "oasRef": "#/components/schemas/RunStepObject/properties/status" + ] }, - "oasRef": "#/components/schemas/RunStepObject/properties/status", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -32524,12 +32526,13 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) step_details": { "kind": "HttpDeclProperty", - "docstring": "The details of the run step.", + "oasRef": "#/components/schemas/RunStepObject/properties/step_details", + "deprecated": false, "key": "step_details", - "optional": false, - "nullable": false, + "docstring": "The details of the run step.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepObject/properties/step_details", "types": [ { "kind": "HttpTypeReference", @@ -32541,11 +32544,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "ident": "ToolCallsStepDetails", "$ref": "(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema)" } - ], - "oasRef": "#/components/schemas/RunStepObject/properties/step_details" + ] }, - "oasRef": "#/components/schemas/RunStepObject/properties/step_details", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "union", "childrenParentSchema": "union", "children": [ @@ -32555,26 +32557,27 @@ 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](/docs/api-reference/threads) that was run.", + "oasRef": "#/components/schemas/RunStepObject/properties/thread_id", + "deprecated": false, "key": "thread_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the [thread](/docs/api-reference/threads) that was run.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepObject/properties/thread_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of run step, which can be either `message_creation` or `tool_calls`.", + "oasRef": "#/components/schemas/RunStepObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of run step, which can be either `message_creation` or `tool_calls`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", @@ -32584,11 +32587,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "tool_calls" } - ], - "oasRef": "#/components/schemas/RunStepObject/properties/type" + ] }, - "oasRef": "#/components/schemas/RunStepObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -32598,10 +32600,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) usage": { "kind": "HttpDeclProperty", - "docstring": "Usage statistics related to the run step. This value will be `null` while the run step's status is `in_progress`.", + "oasRef": "#/components/schemas/RunStepObject/properties/usage", + "deprecated": false, "key": "usage", - "optional": false, - "nullable": true, + "docstring": "Usage statistics related to the run step. This value will be `null` while the run step's status is `in_progress`.", "type": { "kind": "HttpTypeObject", "members": [ @@ -32616,8 +32618,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunStepObject/properties/usage", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -32629,6 +32631,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.runs.steps > (model) run_step > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RunStepObject", + "docstring": "Represents a step in execution of a run.\n", "ident": "RunStep", "type": { "kind": "HttpTypeObject", @@ -32683,7 +32686,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Represents a step in execution of a run.\n", "childrenParentSchema": "object", "children": [ "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) id", @@ -32713,12 +32715,13 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) last_error > (property) code": { "kind": "HttpDeclProperty", - "docstring": "One of `server_error` or `rate_limit_exceeded`.", + "oasRef": "#/components/schemas/RunStepObject/properties/last_error/anyOf/0/properties/code", + "deprecated": false, "key": "code", - "optional": false, - "nullable": false, + "docstring": "One of `server_error` or `rate_limit_exceeded`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepObject/properties/last_error/anyOf/0/properties/code", "types": [ { "kind": "HttpTypeLiteral", @@ -32728,11 +32731,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "rate_limit_exceeded" } - ], - "oasRef": "#/components/schemas/RunStepObject/properties/last_error/anyOf/0/properties/code" + ] }, - "oasRef": "#/components/schemas/RunStepObject/properties/last_error/anyOf/0/properties/code", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -32742,24 +32744,26 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) last_error > (property) message": { "kind": "HttpDeclProperty", - "docstring": "A human-readable description of the error.", + "oasRef": "#/components/schemas/RunStepObject/properties/last_error/anyOf/0/properties/message", + "deprecated": false, "key": "message", - "optional": false, - "nullable": false, + "docstring": "A human-readable description of the error.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepObject/properties/last_error/anyOf/0/properties/message", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) $shared > (model) metadata > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/Metadata", + "docstring": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.\n", "ident": "Metadata", "type": { "kind": "HttpTypeReference", + "oasRef": "#/components/schemas/Metadata", "ident": "Record", "typeParameters": [ { @@ -32768,10 +32772,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch { "kind": "HttpTypeString" } - ], - "oasRef": "#/components/schemas/Metadata" + ] }, - "docstring": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.\n", "children": [] }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) object > (member) 0": { @@ -32845,6 +32847,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.runs.steps > (model) message_creation_step_details > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RunStepDetailsMessageCreationObject", + "docstring": "Details of the message creation by the run step.", "ident": "MessageCreationStepDetails", "type": { "kind": "HttpTypeObject", @@ -32857,7 +32860,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Details of the message creation by the run step.", "childrenParentSchema": "object", "children": [ "(resource) beta.threads.runs.steps > (model) message_creation_step_details > (schema) > (property) message_creation", @@ -32867,6 +32869,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RunStepDetailsToolCallsObject", + "docstring": "Details of the tool call.", "ident": "ToolCallsStepDetails", "type": { "kind": "HttpTypeObject", @@ -32879,7 +32882,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Details of the tool call.", "childrenParentSchema": "object", "children": [ "(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) tool_calls", @@ -32902,43 +32904,43 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) usage > (property) completion_tokens": { "kind": "HttpDeclProperty", - "docstring": "Number of completion tokens used over the course of the run step.", + "oasRef": "#/components/schemas/RunStepCompletionUsage/anyOf/0/properties/completion_tokens", + "deprecated": false, "key": "completion_tokens", - "optional": false, - "nullable": false, + "docstring": "Number of completion tokens used over the course of the run step.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RunStepCompletionUsage/anyOf/0/properties/completion_tokens", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) usage > (property) prompt_tokens": { "kind": "HttpDeclProperty", - "docstring": "Number of prompt tokens used over the course of the run step.", + "oasRef": "#/components/schemas/RunStepCompletionUsage/anyOf/0/properties/prompt_tokens", + "deprecated": false, "key": "prompt_tokens", - "optional": false, - "nullable": false, + "docstring": "Number of prompt tokens used over the course of the run step.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RunStepCompletionUsage/anyOf/0/properties/prompt_tokens", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) usage > (property) total_tokens": { "kind": "HttpDeclProperty", - "docstring": "Total number of tokens used (prompt + completion).", + "oasRef": "#/components/schemas/RunStepCompletionUsage/anyOf/0/properties/total_tokens", + "deprecated": false, "key": "total_tokens", - "optional": false, - "nullable": false, + "docstring": "Total number of tokens used (prompt + completion).", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RunStepCompletionUsage/anyOf/0/properties/total_tokens", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, @@ -32958,9 +32960,9 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) message_creation_step_details > (schema) > (property) message_creation": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RunStepDetailsMessageCreationObject/properties/message_creation", + "deprecated": false, "key": "message_creation", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeObject", "members": [ @@ -32969,8 +32971,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunStepDetailsMessageCreationObject/properties/message_creation", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -32979,22 +32981,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) message_creation_step_details > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "Always `message_creation`.", + "oasRef": "#/components/schemas/RunStepDetailsMessageCreationObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "Always `message_creation`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepDetailsMessageCreationObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "message_creation" } - ], - "oasRef": "#/components/schemas/RunStepDetailsMessageCreationObject/properties/type" + ] }, - "oasRef": "#/components/schemas/RunStepDetailsMessageCreationObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -33003,14 +33005,16 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) tool_calls": { "kind": "HttpDeclProperty", - "docstring": "An array of tool calls the run step was involved in. These can be associated with one of three types of tools: `code_interpreter`, `file_search`, or `function`.\n", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsObject/properties/tool_calls", + "deprecated": false, "key": "tool_calls", - "optional": false, - "nullable": false, + "docstring": "An array of tool calls the run step was involved in. These can be associated with one of three types of tools: `code_interpreter`, `file_search`, or `function`.\n", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsObject/properties/tool_calls", "elementType": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsObject/properties/tool_calls/items", "types": [ { "kind": "HttpTypeReference", @@ -33027,13 +33031,11 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "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" + ] + } }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsObject/properties/tool_calls", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "array", "childrenParentSchema": "union", "children": [ @@ -33044,22 +33046,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "Always `tool_calls`.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "Always `tool_calls`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "tool_calls" } - ], - "oasRef": "#/components/schemas/RunStepDetailsToolCallsObject/properties/type" + ] }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -33068,15 +33070,15 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) message_creation_step_details > (schema) > (property) message_creation > (property) message_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the message that was created by this run step.", + "oasRef": "#/components/schemas/RunStepDetailsMessageCreationObject/properties/message_creation/properties/message_id", + "deprecated": false, "key": "message_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the message that was created by this run step.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepDetailsMessageCreationObject/properties/message_creation/properties/message_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, @@ -33132,6 +33134,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject", + "docstring": "Details of the Code Interpreter tool call the run step was involved in.", "ident": "CodeInterpreterToolCall", "type": { "kind": "HttpTypeObject", @@ -33147,7 +33150,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "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", @@ -33214,24 +33216,24 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the tool call.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/id", + "deprecated": false, "key": "id", - "optional": false, - "nullable": false, + "docstring": "The ID of the tool call.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/id", - "deprecated": false, + "optional": false, + "nullable": 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.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter", + "deprecated": false, "key": "code_interpreter", - "optional": false, - "nullable": false, + "docstring": "The Code Interpreter tool call definition.", "type": { "kind": "HttpTypeObject", "members": [ @@ -33243,8 +33245,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -33254,22 +33256,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(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.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of tool call. This is always going to be `code_interpreter` for this type of tool call.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "code_interpreter" } - ], - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/type" + ] }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -33278,24 +33280,24 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the tool call object.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/id", + "deprecated": false, "key": "id", - "optional": false, - "nullable": false, + "docstring": "The ID of the tool call object.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/id", - "deprecated": false, + "optional": false, + "nullable": 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.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/file_search", + "deprecated": false, "key": "file_search", - "optional": false, - "nullable": false, + "docstring": "For now, this is always going to be an empty object.", "type": { "kind": "HttpTypeObject", "members": [ @@ -33307,8 +33309,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/file_search", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -33318,22 +33320,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(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.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of tool call. This is always going to be `file_search` for this type of tool call.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "file_search" } - ], - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/type" + ] }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -33342,24 +33344,24 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the tool call object.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/id", + "deprecated": false, "key": "id", - "optional": false, - "nullable": false, + "docstring": "The ID of the tool call object.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/id", - "deprecated": false, + "optional": false, + "nullable": 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.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/function", + "deprecated": false, "key": "function", - "optional": false, - "nullable": false, + "docstring": "The definition of the function that was called.", "type": { "kind": "HttpTypeObject", "members": [ @@ -33374,8 +33376,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/function", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -33386,22 +33388,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(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.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of tool call. This is always going to be `function` for this type of tool call.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "function" } - ], - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/type" + ] }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -33410,28 +33412,30 @@ 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) input": { "kind": "HttpDeclProperty", - "docstring": "The input to the Code Interpreter tool call.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter/properties/input", + "deprecated": false, "key": "input", - "optional": false, - "nullable": false, + "docstring": "The input to the Code Interpreter tool call.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter/properties/input", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs": { "kind": "HttpDeclProperty", - "docstring": "The outputs from the Code Interpreter tool call. Code Interpreter can output one or more items, including text (`logs`) or images (`image`). Each of these are represented by a different object type.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter/properties/outputs", + "deprecated": false, "key": "outputs", - "optional": false, - "nullable": false, + "docstring": "The outputs from the Code Interpreter tool call. Code Interpreter can output one or more items, including text (`logs`) or images (`image`). Each of these are represented by a different object type.", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter/properties/outputs", "elementType": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter/properties/outputs/items", "types": [ { "kind": "HttpTypeObject", @@ -33455,13 +33459,11 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] } - ], - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter/properties/outputs/items" - }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter/properties/outputs" + ] + } }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter/properties/outputs", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "array", "childrenParentSchema": "union", "children": [ @@ -33478,11 +33480,11 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) ranking_options": { "kind": "HttpDeclProperty", - "title": "File search tool call ranking options", - "docstring": "The ranking options for the file search.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/file_search/properties/ranking_options", + "deprecated": false, "key": "ranking_options", - "optional": true, - "nullable": false, + "docstring": "The ranking options for the file search.", + "title": "File search tool call ranking options", "type": { "kind": "HttpTypeObject", "members": [ @@ -33494,8 +33496,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/file_search/properties/ranking_options", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -33505,12 +33507,13 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) results": { "kind": "HttpDeclProperty", - "docstring": "The results of the file search.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/file_search/properties/results", + "deprecated": false, "key": "results", - "optional": true, - "nullable": false, + "docstring": "The results of the file search.", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/file_search/properties/results", "elementType": { "kind": "HttpTypeObject", "members": [ @@ -33527,11 +33530,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "ident": "content" } ] + } }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/file_search/properties/results" - }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/file_search/properties/results", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "array", "childrenParentSchema": "object", "children": [ @@ -33550,43 +33552,43 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) function > (property) arguments": { "kind": "HttpDeclProperty", - "docstring": "The arguments passed to the function.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/function/properties/arguments", + "deprecated": false, "key": "arguments", - "optional": false, - "nullable": false, + "docstring": "The arguments passed to the function.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/function/properties/arguments", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) function > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the function.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/function/properties/name", + "deprecated": false, "key": "name", - "optional": false, - "nullable": false, + "docstring": "The name of the function.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/function/properties/name", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(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](/docs/api-reference/runs/submitToolOutputs) yet.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/function/properties/output", + "deprecated": false, "key": "output", - "optional": false, - "nullable": true, + "docstring": "The output of the function. This will be `null` if the outputs have not been [submitted](/docs/api-reference/runs/submitToolOutputs) yet.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/function/properties/output", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "string", "children": [] }, @@ -33600,6 +33602,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) 0": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter/properties/outputs/items/oneOf/0", + "docstring": "Text output from the Code Interpreter tool call as part of a run step.", "ident": "CodeInterpreterLogOutput", "type": { "kind": "HttpTypeObject", @@ -33612,7 +33615,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Text output from the Code Interpreter tool call as part of a run step.", "childrenParentSchema": "object", "children": [ "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 0 > (property) logs", @@ -33642,12 +33644,13 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) ranking_options > (property) ranker": { "kind": "HttpDeclProperty", - "docstring": "The ranker to use for the file search. If not specified will use the `auto` ranker.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchRankingOptionsObject/properties/ranker", + "deprecated": false, "key": "ranker", - "optional": false, - "nullable": false, + "docstring": "The ranker to use for the file search. If not specified will use the `auto` ranker.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchRankingOptionsObject/properties/ranker", "types": [ { "kind": "HttpTypeLiteral", @@ -33657,11 +33660,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "default_2024_08_21" } - ], - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchRankingOptionsObject/properties/ranker" + ] }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchRankingOptionsObject/properties/ranker", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -33671,10 +33673,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) ranking_options > (property) score_threshold": { "kind": "HttpDeclProperty", - "docstring": "The score threshold for the file search. All values must be a floating point number between 0 and 1.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchRankingOptionsObject/properties/score_threshold", + "deprecated": false, "key": "score_threshold", - "optional": false, - "nullable": false, + "docstring": "The score threshold for the file search. All values must be a floating point number between 0 and 1.", "type": { "kind": "HttpTypeNumber" }, @@ -33682,45 +33684,45 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "minimum": 0, "maximum": 1 }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchRankingOptionsObject/properties/score_threshold", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "number", "children": [] }, "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) results > (items) > (property) file_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the file that result was found in.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/file_id", + "deprecated": false, "key": "file_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the file that result was found in.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/file_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) results > (items) > (property) file_name": { "kind": "HttpDeclProperty", - "docstring": "The name of the file that result was found in.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/file_name", + "deprecated": false, "key": "file_name", - "optional": false, - "nullable": false, + "docstring": "The name of the file that result was found in.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/file_name", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) results > (items) > (property) score": { "kind": "HttpDeclProperty", - "docstring": "The score of the result. All values must be a floating point number between 0 and 1.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/score", + "deprecated": false, "key": "score", - "optional": false, - "nullable": false, + "docstring": "The score of the result. All values must be a floating point number between 0 and 1.", "type": { "kind": "HttpTypeNumber" }, @@ -33728,19 +33730,20 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "minimum": 0, "maximum": 1 }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/score", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "number", "children": [] }, "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) results > (items) > (property) content": { "kind": "HttpDeclProperty", - "docstring": "The content of the result that was found. The content is only included if requested via the include query parameter.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/content", + "deprecated": false, "key": "content", - "optional": true, - "nullable": false, + "docstring": "The content of the result that was found. The content is only included if requested via the include query parameter.", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/content", "elementType": { "kind": "HttpTypeObject", "members": [ @@ -33751,11 +33754,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "ident": "type" } ] + } }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/content" - }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/content", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "array", "childrenParentSchema": "object", "children": [ @@ -33765,36 +33767,36 @@ 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 > (property) logs": { "kind": "HttpDeclProperty", - "docstring": "The text output from the Code Interpreter tool call.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputLogsObject/properties/logs", + "deprecated": false, "key": "logs", - "optional": false, - "nullable": false, + "docstring": "The text output from the Code Interpreter tool call.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputLogsObject/properties/logs", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 0 > (property) type": { "kind": "HttpDeclProperty", - "docstring": "Always `logs`.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputLogsObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "Always `logs`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputLogsObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "logs" } - ], - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputLogsObject/properties/type" + ] }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputLogsObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -33803,9 +33805,9 @@ 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": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputImageObject/properties/image", + "deprecated": false, "key": "image", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeObject", "members": [ @@ -33814,8 +33816,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputImageObject/properties/image", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -33824,22 +33826,22 @@ 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) type": { "kind": "HttpDeclProperty", - "docstring": "Always `image`.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputImageObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "Always `image`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputImageObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "image" } - ], - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputImageObject/properties/type" + ] }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputImageObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -33862,36 +33864,36 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) results > (items) > (property) content > (items) > (property) text": { "kind": "HttpDeclProperty", - "docstring": "The text content of the file.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/content/items/properties/text", + "deprecated": false, "key": "text", - "optional": true, - "nullable": false, + "docstring": "The text content of the file.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/content/items/properties/text", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) results > (items) > (property) content > (items) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the content.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/content/items/properties/type", + "deprecated": false, "key": "type", - "optional": true, - "nullable": false, + "docstring": "The type of the content.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/content/items/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "text" } - ], - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/content/items/properties/type" + ] }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/content/items/properties/type", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -33907,15 +33909,15 @@ 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](/docs/api-reference/files) ID of the image.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputImageObject/properties/image/properties/file_id", + "deprecated": false, "key": "file_id", - "optional": false, - "nullable": false, + "docstring": "The [file](/docs/api-reference/files) ID of the image.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputImageObject/properties/image/properties/file_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, @@ -33955,7 +33957,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/oneOf/6", - "ident": "UnionMember17", + "docstring": "Occurs when a [run step](/docs/api-reference/run-steps/step-object) expires.", + "ident": "ThreadRunStepExpired", "type": { "kind": "HttpTypeObject", "members": [ @@ -33967,7 +33970,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "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", @@ -33976,20 +33978,20 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 17 > (property) data": { "kind": "HttpDeclProperty", - "title": "Run steps", - "docstring": "Represents a step in execution of a run.\n", + "oasRef": "#/components/schemas/RunStepStreamEvent/oneOf/6/properties/data", + "deprecated": false, "key": "data", - "optional": false, - "nullable": false, + "docstring": "Represents a step in execution of a run.\n", + "title": "Run steps", "type": { "kind": "HttpTypeReference", "ident": "RunStep", "$ref": "(resource) beta.threads.runs.steps > (model) run_step > (schema)" }, - "oasRef": "#/components/schemas/RunStepStreamEvent/oneOf/6/properties/data", - "deprecated": false, - "schemaType": "object", + "optional": false, + "nullable": false, "modelImplicit": false, + "schemaType": "object", "modelPath": "(resource) beta.threads.runs.steps > (model) run_step", "childrenParentSchema": "object", "children": [ @@ -34013,21 +34015,21 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 17 > (property) event": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RunStepStreamEvent/oneOf/6/properties/event", + "deprecated": false, "key": "event", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepStreamEvent/oneOf/6/properties/event", "types": [ { "kind": "HttpTypeLiteral", "literal": "thread.run.step.expired" } - ], - "oasRef": "#/components/schemas/RunStepStreamEvent/oneOf/6/properties/event" + ] }, - "oasRef": "#/components/schemas/RunStepStreamEvent/oneOf/6/properties/event", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -34036,123 +34038,123 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The identifier of the run step, which can be referenced in API endpoints.", + "oasRef": "#/components/schemas/RunStepObject/properties/id", + "deprecated": false, "key": "id", - "optional": false, - "nullable": false, + "docstring": "The identifier of the run step, which can be referenced in API endpoints.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepObject/properties/id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) assistant_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the [assistant](/docs/api-reference/assistants) associated with the run step.", + "oasRef": "#/components/schemas/RunStepObject/properties/assistant_id", + "deprecated": false, "key": "assistant_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the [assistant](/docs/api-reference/assistants) associated with the run step.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepObject/properties/assistant_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) cancelled_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the run step was cancelled.", + "oasRef": "#/components/schemas/RunStepObject/properties/cancelled_at", + "deprecated": false, "key": "cancelled_at", - "optional": false, - "nullable": true, + "docstring": "The Unix timestamp (in seconds) for when the run step was cancelled.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/RunStepObject/properties/cancelled_at", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) completed_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the run step completed.", + "oasRef": "#/components/schemas/RunStepObject/properties/completed_at", + "deprecated": false, "key": "completed_at", - "optional": false, - "nullable": true, + "docstring": "The Unix timestamp (in seconds) for when the run step completed.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/RunStepObject/properties/completed_at", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) created_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the run step was created.", + "oasRef": "#/components/schemas/RunStepObject/properties/created_at", + "deprecated": false, "key": "created_at", - "optional": false, - "nullable": false, + "docstring": "The Unix timestamp (in seconds) for when the run step was created.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/RunStepObject/properties/created_at", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) expired_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the run step expired. A step is considered expired if the parent run is expired.", + "oasRef": "#/components/schemas/RunStepObject/properties/expired_at", + "deprecated": false, "key": "expired_at", - "optional": false, - "nullable": true, + "docstring": "The Unix timestamp (in seconds) for when the run step expired. A step is considered expired if the parent run is expired.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/RunStepObject/properties/expired_at", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) failed_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the run step failed.", + "oasRef": "#/components/schemas/RunStepObject/properties/failed_at", + "deprecated": false, "key": "failed_at", - "optional": false, - "nullable": true, + "docstring": "The Unix timestamp (in seconds) for when the run step failed.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/RunStepObject/properties/failed_at", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) last_error": { "kind": "HttpDeclProperty", - "docstring": "The last error associated with this run step. Will be `null` if there are no errors.", + "oasRef": "#/components/schemas/RunStepObject/properties/last_error", + "deprecated": false, "key": "last_error", - "optional": false, - "nullable": true, + "docstring": "The last error associated with this run step. Will be `null` if there are no errors.", "type": { "kind": "HttpTypeObject", "members": [ @@ -34164,8 +34166,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunStepObject/properties/last_error", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -34175,40 +34177,40 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) metadata": { "kind": "HttpDeclProperty", - "docstring": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.\n", + "oasRef": "#/components/schemas/RunStepObject/properties/metadata", + "deprecated": false, "key": "metadata", - "optional": false, - "nullable": true, + "docstring": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.\n", "type": { "kind": "HttpTypeReference", "ident": "Metadata", "$ref": "(resource) $shared > (model) metadata > (schema)" }, - "oasRef": "#/components/schemas/RunStepObject/properties/metadata", - "deprecated": false, - "schemaType": "map", + "optional": false, + "nullable": true, "modelImplicit": false, + "schemaType": "map", "modelPath": "(resource) $shared > (model) metadata", "children": [] }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) object": { "kind": "HttpDeclProperty", - "docstring": "The object type, which is always `thread.run.step`.", + "oasRef": "#/components/schemas/RunStepObject/properties/object", + "deprecated": false, "key": "object", - "optional": false, - "nullable": false, + "docstring": "The object type, which is always `thread.run.step`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepObject/properties/object", "types": [ { "kind": "HttpTypeLiteral", "literal": "thread.run.step" } - ], - "oasRef": "#/components/schemas/RunStepObject/properties/object" + ] }, - "oasRef": "#/components/schemas/RunStepObject/properties/object", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -34217,26 +34219,27 @@ 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](/docs/api-reference/runs) that this run step is a part of.", + "oasRef": "#/components/schemas/RunStepObject/properties/run_id", + "deprecated": false, "key": "run_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the [run](/docs/api-reference/runs) that this run step is a part of.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepObject/properties/run_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) status": { "kind": "HttpDeclProperty", - "docstring": "The status of the run step, which can be either `in_progress`, `cancelled`, `failed`, `completed`, or `expired`.", + "oasRef": "#/components/schemas/RunStepObject/properties/status", + "deprecated": false, "key": "status", - "optional": false, - "nullable": false, + "docstring": "The status of the run step, which can be either `in_progress`, `cancelled`, `failed`, `completed`, or `expired`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepObject/properties/status", "types": [ { "kind": "HttpTypeLiteral", @@ -34258,11 +34261,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "expired" } - ], - "oasRef": "#/components/schemas/RunStepObject/properties/status" + ] }, - "oasRef": "#/components/schemas/RunStepObject/properties/status", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -34275,12 +34277,13 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) step_details": { "kind": "HttpDeclProperty", - "docstring": "The details of the run step.", + "oasRef": "#/components/schemas/RunStepObject/properties/step_details", + "deprecated": false, "key": "step_details", - "optional": false, - "nullable": false, + "docstring": "The details of the run step.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepObject/properties/step_details", "types": [ { "kind": "HttpTypeReference", @@ -34292,11 +34295,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "ident": "ToolCallsStepDetails", "$ref": "(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema)" } - ], - "oasRef": "#/components/schemas/RunStepObject/properties/step_details" + ] }, - "oasRef": "#/components/schemas/RunStepObject/properties/step_details", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "union", "childrenParentSchema": "union", "children": [ @@ -34306,26 +34308,27 @@ 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](/docs/api-reference/threads) that was run.", + "oasRef": "#/components/schemas/RunStepObject/properties/thread_id", + "deprecated": false, "key": "thread_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the [thread](/docs/api-reference/threads) that was run.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepObject/properties/thread_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of run step, which can be either `message_creation` or `tool_calls`.", + "oasRef": "#/components/schemas/RunStepObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of run step, which can be either `message_creation` or `tool_calls`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", @@ -34335,11 +34338,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "tool_calls" } - ], - "oasRef": "#/components/schemas/RunStepObject/properties/type" + ] }, - "oasRef": "#/components/schemas/RunStepObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -34349,10 +34351,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) usage": { "kind": "HttpDeclProperty", - "docstring": "Usage statistics related to the run step. This value will be `null` while the run step's status is `in_progress`.", + "oasRef": "#/components/schemas/RunStepObject/properties/usage", + "deprecated": false, "key": "usage", - "optional": false, - "nullable": true, + "docstring": "Usage statistics related to the run step. This value will be `null` while the run step's status is `in_progress`.", "type": { "kind": "HttpTypeObject", "members": [ @@ -34367,8 +34369,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunStepObject/properties/usage", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -34380,6 +34382,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.runs.steps > (model) run_step > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RunStepObject", + "docstring": "Represents a step in execution of a run.\n", "ident": "RunStep", "type": { "kind": "HttpTypeObject", @@ -34434,7 +34437,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Represents a step in execution of a run.\n", "childrenParentSchema": "object", "children": [ "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) id", @@ -34464,12 +34466,13 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) last_error > (property) code": { "kind": "HttpDeclProperty", - "docstring": "One of `server_error` or `rate_limit_exceeded`.", + "oasRef": "#/components/schemas/RunStepObject/properties/last_error/anyOf/0/properties/code", + "deprecated": false, "key": "code", - "optional": false, - "nullable": false, + "docstring": "One of `server_error` or `rate_limit_exceeded`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepObject/properties/last_error/anyOf/0/properties/code", "types": [ { "kind": "HttpTypeLiteral", @@ -34479,11 +34482,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "rate_limit_exceeded" } - ], - "oasRef": "#/components/schemas/RunStepObject/properties/last_error/anyOf/0/properties/code" + ] }, - "oasRef": "#/components/schemas/RunStepObject/properties/last_error/anyOf/0/properties/code", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -34493,24 +34495,26 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) last_error > (property) message": { "kind": "HttpDeclProperty", - "docstring": "A human-readable description of the error.", + "oasRef": "#/components/schemas/RunStepObject/properties/last_error/anyOf/0/properties/message", + "deprecated": false, "key": "message", - "optional": false, - "nullable": false, + "docstring": "A human-readable description of the error.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepObject/properties/last_error/anyOf/0/properties/message", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) $shared > (model) metadata > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/Metadata", + "docstring": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.\n", "ident": "Metadata", "type": { "kind": "HttpTypeReference", + "oasRef": "#/components/schemas/Metadata", "ident": "Record", "typeParameters": [ { @@ -34519,10 +34523,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch { "kind": "HttpTypeString" } - ], - "oasRef": "#/components/schemas/Metadata" + ] }, - "docstring": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.\n", "children": [] }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) object > (member) 0": { @@ -34596,6 +34598,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.runs.steps > (model) message_creation_step_details > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RunStepDetailsMessageCreationObject", + "docstring": "Details of the message creation by the run step.", "ident": "MessageCreationStepDetails", "type": { "kind": "HttpTypeObject", @@ -34608,7 +34611,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Details of the message creation by the run step.", "childrenParentSchema": "object", "children": [ "(resource) beta.threads.runs.steps > (model) message_creation_step_details > (schema) > (property) message_creation", @@ -34618,6 +34620,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RunStepDetailsToolCallsObject", + "docstring": "Details of the tool call.", "ident": "ToolCallsStepDetails", "type": { "kind": "HttpTypeObject", @@ -34630,7 +34633,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Details of the tool call.", "childrenParentSchema": "object", "children": [ "(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) tool_calls", @@ -34653,43 +34655,43 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) usage > (property) completion_tokens": { "kind": "HttpDeclProperty", - "docstring": "Number of completion tokens used over the course of the run step.", + "oasRef": "#/components/schemas/RunStepCompletionUsage/anyOf/0/properties/completion_tokens", + "deprecated": false, "key": "completion_tokens", - "optional": false, - "nullable": false, + "docstring": "Number of completion tokens used over the course of the run step.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RunStepCompletionUsage/anyOf/0/properties/completion_tokens", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) usage > (property) prompt_tokens": { "kind": "HttpDeclProperty", - "docstring": "Number of prompt tokens used over the course of the run step.", + "oasRef": "#/components/schemas/RunStepCompletionUsage/anyOf/0/properties/prompt_tokens", + "deprecated": false, "key": "prompt_tokens", - "optional": false, - "nullable": false, + "docstring": "Number of prompt tokens used over the course of the run step.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RunStepCompletionUsage/anyOf/0/properties/prompt_tokens", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) usage > (property) total_tokens": { "kind": "HttpDeclProperty", - "docstring": "Total number of tokens used (prompt + completion).", + "oasRef": "#/components/schemas/RunStepCompletionUsage/anyOf/0/properties/total_tokens", + "deprecated": false, "key": "total_tokens", - "optional": false, - "nullable": false, + "docstring": "Total number of tokens used (prompt + completion).", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RunStepCompletionUsage/anyOf/0/properties/total_tokens", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, @@ -34709,9 +34711,9 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) message_creation_step_details > (schema) > (property) message_creation": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RunStepDetailsMessageCreationObject/properties/message_creation", + "deprecated": false, "key": "message_creation", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeObject", "members": [ @@ -34720,8 +34722,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunStepDetailsMessageCreationObject/properties/message_creation", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -34730,22 +34732,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) message_creation_step_details > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "Always `message_creation`.", + "oasRef": "#/components/schemas/RunStepDetailsMessageCreationObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "Always `message_creation`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepDetailsMessageCreationObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "message_creation" } - ], - "oasRef": "#/components/schemas/RunStepDetailsMessageCreationObject/properties/type" + ] }, - "oasRef": "#/components/schemas/RunStepDetailsMessageCreationObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -34754,14 +34756,16 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) tool_calls": { "kind": "HttpDeclProperty", - "docstring": "An array of tool calls the run step was involved in. These can be associated with one of three types of tools: `code_interpreter`, `file_search`, or `function`.\n", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsObject/properties/tool_calls", + "deprecated": false, "key": "tool_calls", - "optional": false, - "nullable": false, + "docstring": "An array of tool calls the run step was involved in. These can be associated with one of three types of tools: `code_interpreter`, `file_search`, or `function`.\n", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsObject/properties/tool_calls", "elementType": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsObject/properties/tool_calls/items", "types": [ { "kind": "HttpTypeReference", @@ -34778,13 +34782,11 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "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" + ] + } }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsObject/properties/tool_calls", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "array", "childrenParentSchema": "union", "children": [ @@ -34795,22 +34797,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "Always `tool_calls`.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "Always `tool_calls`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "tool_calls" } - ], - "oasRef": "#/components/schemas/RunStepDetailsToolCallsObject/properties/type" + ] }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -34819,15 +34821,15 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) message_creation_step_details > (schema) > (property) message_creation > (property) message_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the message that was created by this run step.", + "oasRef": "#/components/schemas/RunStepDetailsMessageCreationObject/properties/message_creation/properties/message_id", + "deprecated": false, "key": "message_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the message that was created by this run step.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepDetailsMessageCreationObject/properties/message_creation/properties/message_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, @@ -34883,6 +34885,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject", + "docstring": "Details of the Code Interpreter tool call the run step was involved in.", "ident": "CodeInterpreterToolCall", "type": { "kind": "HttpTypeObject", @@ -34898,7 +34901,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "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", @@ -34965,24 +34967,24 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the tool call.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/id", + "deprecated": false, "key": "id", - "optional": false, - "nullable": false, + "docstring": "The ID of the tool call.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/id", - "deprecated": false, + "optional": false, + "nullable": 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.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter", + "deprecated": false, "key": "code_interpreter", - "optional": false, - "nullable": false, + "docstring": "The Code Interpreter tool call definition.", "type": { "kind": "HttpTypeObject", "members": [ @@ -34994,8 +34996,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -35005,22 +35007,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(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.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of tool call. This is always going to be `code_interpreter` for this type of tool call.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "code_interpreter" } - ], - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/type" + ] }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -35029,24 +35031,24 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the tool call object.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/id", + "deprecated": false, "key": "id", - "optional": false, - "nullable": false, + "docstring": "The ID of the tool call object.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/id", - "deprecated": false, + "optional": false, + "nullable": 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.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/file_search", + "deprecated": false, "key": "file_search", - "optional": false, - "nullable": false, + "docstring": "For now, this is always going to be an empty object.", "type": { "kind": "HttpTypeObject", "members": [ @@ -35058,8 +35060,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/file_search", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -35069,22 +35071,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(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.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of tool call. This is always going to be `file_search` for this type of tool call.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "file_search" } - ], - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/type" + ] }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -35093,24 +35095,24 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the tool call object.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/id", + "deprecated": false, "key": "id", - "optional": false, - "nullable": false, + "docstring": "The ID of the tool call object.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/id", - "deprecated": false, + "optional": false, + "nullable": 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.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/function", + "deprecated": false, "key": "function", - "optional": false, - "nullable": false, + "docstring": "The definition of the function that was called.", "type": { "kind": "HttpTypeObject", "members": [ @@ -35125,8 +35127,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/function", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -35137,22 +35139,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(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.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of tool call. This is always going to be `function` for this type of tool call.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "function" } - ], - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/type" + ] }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -35161,28 +35163,30 @@ 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) input": { "kind": "HttpDeclProperty", - "docstring": "The input to the Code Interpreter tool call.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter/properties/input", + "deprecated": false, "key": "input", - "optional": false, - "nullable": false, + "docstring": "The input to the Code Interpreter tool call.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter/properties/input", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs": { "kind": "HttpDeclProperty", - "docstring": "The outputs from the Code Interpreter tool call. Code Interpreter can output one or more items, including text (`logs`) or images (`image`). Each of these are represented by a different object type.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter/properties/outputs", + "deprecated": false, "key": "outputs", - "optional": false, - "nullable": false, + "docstring": "The outputs from the Code Interpreter tool call. Code Interpreter can output one or more items, including text (`logs`) or images (`image`). Each of these are represented by a different object type.", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter/properties/outputs", "elementType": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter/properties/outputs/items", "types": [ { "kind": "HttpTypeObject", @@ -35206,13 +35210,11 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] } - ], - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter/properties/outputs/items" - }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter/properties/outputs" + ] + } }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter/properties/outputs", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "array", "childrenParentSchema": "union", "children": [ @@ -35229,11 +35231,11 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) ranking_options": { "kind": "HttpDeclProperty", - "title": "File search tool call ranking options", - "docstring": "The ranking options for the file search.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/file_search/properties/ranking_options", + "deprecated": false, "key": "ranking_options", - "optional": true, - "nullable": false, + "docstring": "The ranking options for the file search.", + "title": "File search tool call ranking options", "type": { "kind": "HttpTypeObject", "members": [ @@ -35245,8 +35247,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/file_search/properties/ranking_options", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -35256,12 +35258,13 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) results": { "kind": "HttpDeclProperty", - "docstring": "The results of the file search.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/file_search/properties/results", + "deprecated": false, "key": "results", - "optional": true, - "nullable": false, + "docstring": "The results of the file search.", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/file_search/properties/results", "elementType": { "kind": "HttpTypeObject", "members": [ @@ -35278,11 +35281,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "ident": "content" } ] + } }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/file_search/properties/results" - }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/file_search/properties/results", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "array", "childrenParentSchema": "object", "children": [ @@ -35301,43 +35303,43 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) function > (property) arguments": { "kind": "HttpDeclProperty", - "docstring": "The arguments passed to the function.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/function/properties/arguments", + "deprecated": false, "key": "arguments", - "optional": false, - "nullable": false, + "docstring": "The arguments passed to the function.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/function/properties/arguments", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) function > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the function.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/function/properties/name", + "deprecated": false, "key": "name", - "optional": false, - "nullable": false, + "docstring": "The name of the function.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/function/properties/name", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(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](/docs/api-reference/runs/submitToolOutputs) yet.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/function/properties/output", + "deprecated": false, "key": "output", - "optional": false, - "nullable": true, + "docstring": "The output of the function. This will be `null` if the outputs have not been [submitted](/docs/api-reference/runs/submitToolOutputs) yet.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/function/properties/output", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "string", "children": [] }, @@ -35351,6 +35353,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) 0": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter/properties/outputs/items/oneOf/0", + "docstring": "Text output from the Code Interpreter tool call as part of a run step.", "ident": "CodeInterpreterLogOutput", "type": { "kind": "HttpTypeObject", @@ -35363,7 +35366,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Text output from the Code Interpreter tool call as part of a run step.", "childrenParentSchema": "object", "children": [ "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 0 > (property) logs", @@ -35393,12 +35395,13 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) ranking_options > (property) ranker": { "kind": "HttpDeclProperty", - "docstring": "The ranker to use for the file search. If not specified will use the `auto` ranker.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchRankingOptionsObject/properties/ranker", + "deprecated": false, "key": "ranker", - "optional": false, - "nullable": false, + "docstring": "The ranker to use for the file search. If not specified will use the `auto` ranker.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchRankingOptionsObject/properties/ranker", "types": [ { "kind": "HttpTypeLiteral", @@ -35408,11 +35411,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "default_2024_08_21" } - ], - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchRankingOptionsObject/properties/ranker" + ] }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchRankingOptionsObject/properties/ranker", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -35422,10 +35424,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) ranking_options > (property) score_threshold": { "kind": "HttpDeclProperty", - "docstring": "The score threshold for the file search. All values must be a floating point number between 0 and 1.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchRankingOptionsObject/properties/score_threshold", + "deprecated": false, "key": "score_threshold", - "optional": false, - "nullable": false, + "docstring": "The score threshold for the file search. All values must be a floating point number between 0 and 1.", "type": { "kind": "HttpTypeNumber" }, @@ -35433,45 +35435,45 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "minimum": 0, "maximum": 1 }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchRankingOptionsObject/properties/score_threshold", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "number", "children": [] }, "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) results > (items) > (property) file_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the file that result was found in.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/file_id", + "deprecated": false, "key": "file_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the file that result was found in.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/file_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) results > (items) > (property) file_name": { "kind": "HttpDeclProperty", - "docstring": "The name of the file that result was found in.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/file_name", + "deprecated": false, "key": "file_name", - "optional": false, - "nullable": false, + "docstring": "The name of the file that result was found in.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/file_name", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) results > (items) > (property) score": { "kind": "HttpDeclProperty", - "docstring": "The score of the result. All values must be a floating point number between 0 and 1.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/score", + "deprecated": false, "key": "score", - "optional": false, - "nullable": false, + "docstring": "The score of the result. All values must be a floating point number between 0 and 1.", "type": { "kind": "HttpTypeNumber" }, @@ -35479,19 +35481,20 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "minimum": 0, "maximum": 1 }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/score", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "number", "children": [] }, "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) results > (items) > (property) content": { "kind": "HttpDeclProperty", - "docstring": "The content of the result that was found. The content is only included if requested via the include query parameter.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/content", + "deprecated": false, "key": "content", - "optional": true, - "nullable": false, + "docstring": "The content of the result that was found. The content is only included if requested via the include query parameter.", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/content", "elementType": { "kind": "HttpTypeObject", "members": [ @@ -35502,11 +35505,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "ident": "type" } ] + } }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/content" - }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/content", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "array", "childrenParentSchema": "object", "children": [ @@ -35516,36 +35518,36 @@ 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 > (property) logs": { "kind": "HttpDeclProperty", - "docstring": "The text output from the Code Interpreter tool call.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputLogsObject/properties/logs", + "deprecated": false, "key": "logs", - "optional": false, - "nullable": false, + "docstring": "The text output from the Code Interpreter tool call.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputLogsObject/properties/logs", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 0 > (property) type": { "kind": "HttpDeclProperty", - "docstring": "Always `logs`.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputLogsObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "Always `logs`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputLogsObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "logs" } - ], - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputLogsObject/properties/type" + ] }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputLogsObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -35554,9 +35556,9 @@ 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": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputImageObject/properties/image", + "deprecated": false, "key": "image", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeObject", "members": [ @@ -35565,8 +35567,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputImageObject/properties/image", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -35575,22 +35577,22 @@ 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) type": { "kind": "HttpDeclProperty", - "docstring": "Always `image`.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputImageObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "Always `image`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputImageObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "image" } - ], - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputImageObject/properties/type" + ] }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputImageObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -35613,36 +35615,36 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) results > (items) > (property) content > (items) > (property) text": { "kind": "HttpDeclProperty", - "docstring": "The text content of the file.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/content/items/properties/text", + "deprecated": false, "key": "text", - "optional": true, - "nullable": false, + "docstring": "The text content of the file.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/content/items/properties/text", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) results > (items) > (property) content > (items) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the content.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/content/items/properties/type", + "deprecated": false, "key": "type", - "optional": true, - "nullable": false, + "docstring": "The type of the content.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/content/items/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "text" } - ], - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/content/items/properties/type" + ] }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/content/items/properties/type", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -35658,15 +35660,15 @@ 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](/docs/api-reference/files) ID of the image.", + "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputImageObject/properties/image/properties/file_id", + "deprecated": false, "key": "file_id", - "optional": false, - "nullable": false, + "docstring": "The [file](/docs/api-reference/files) ID of the image.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputImageObject/properties/image/properties/file_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, @@ -35706,7 +35708,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/oneOf/0", - "ident": "UnionMember18", + "docstring": "Occurs when a [message](/docs/api-reference/messages/object) is created.", + "ident": "ThreadMessageCreated", "type": { "kind": "HttpTypeObject", "members": [ @@ -35718,7 +35721,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "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", @@ -35727,20 +35729,20 @@ 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](/docs/api-reference/threads).", + "oasRef": "#/components/schemas/MessageStreamEvent/oneOf/0/properties/data", + "deprecated": false, "key": "data", - "optional": false, - "nullable": false, + "docstring": "Represents a message within a [thread](/docs/api-reference/threads).", + "title": "The message object", "type": { "kind": "HttpTypeReference", "ident": "Message", "$ref": "(resource) beta.threads.messages > (model) message > (schema)" }, - "oasRef": "#/components/schemas/MessageStreamEvent/oneOf/0/properties/data", - "deprecated": false, - "schemaType": "object", + "optional": false, + "nullable": false, "modelImplicit": false, + "schemaType": "object", "modelPath": "(resource) beta.threads.messages > (model) message", "childrenParentSchema": "object", "children": [ @@ -35762,21 +35764,21 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 18 > (property) event": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/MessageStreamEvent/oneOf/0/properties/event", + "deprecated": false, "key": "event", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MessageStreamEvent/oneOf/0/properties/event", "types": [ { "kind": "HttpTypeLiteral", "literal": "thread.message.created" } - ], - "oasRef": "#/components/schemas/MessageStreamEvent/oneOf/0/properties/event" + ] }, - "oasRef": "#/components/schemas/MessageStreamEvent/oneOf/0/properties/event", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -35785,40 +35787,41 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) message > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The identifier, which can be referenced in API endpoints.", + "oasRef": "#/components/schemas/MessageObject/properties/id", + "deprecated": false, "key": "id", - "optional": false, - "nullable": false, + "docstring": "The identifier, which can be referenced in API endpoints.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/MessageObject/properties/id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.messages > (model) message > (schema) > (property) assistant_id": { "kind": "HttpDeclProperty", - "docstring": "If applicable, the ID of the [assistant](/docs/api-reference/assistants) that authored this message.", + "oasRef": "#/components/schemas/MessageObject/properties/assistant_id", + "deprecated": false, "key": "assistant_id", - "optional": false, - "nullable": true, + "docstring": "If applicable, the ID of the [assistant](/docs/api-reference/assistants) that authored this message.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/MessageObject/properties/assistant_id", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "string", "children": [] }, "(resource) beta.threads.messages > (model) message > (schema) > (property) attachments": { "kind": "HttpDeclProperty", - "docstring": "A list of files attached to the message, and the tools they were added to.", + "oasRef": "#/components/schemas/MessageObject/properties/attachments", + "deprecated": false, "key": "attachments", - "optional": false, - "nullable": true, + "docstring": "A list of files attached to the message, and the tools they were added to.", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/MessageObject/properties/attachments", "elementType": { "kind": "HttpTypeObject", "members": [ @@ -35829,11 +35832,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "ident": "tools" } ] + } }, - "oasRef": "#/components/schemas/MessageObject/properties/attachments" - }, - "oasRef": "#/components/schemas/MessageObject/properties/attachments", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "array", "childrenParentSchema": "object", "children": [ @@ -35843,31 +35845,33 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) message > (schema) > (property) completed_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the message was completed.", + "oasRef": "#/components/schemas/MessageObject/properties/completed_at", + "deprecated": false, "key": "completed_at", - "optional": false, - "nullable": true, + "docstring": "The Unix timestamp (in seconds) for when the message was completed.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/MessageObject/properties/completed_at", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.messages > (model) message > (schema) > (property) content": { "kind": "HttpDeclProperty", - "docstring": "The content of the message in array of text and/or images.", + "oasRef": "#/components/schemas/MessageObject/properties/content", + "deprecated": false, "key": "content", - "optional": false, - "nullable": false, + "docstring": "The content of the message in array of text and/or images.", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/MessageObject/properties/content", "elementType": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MessageObject/properties/content/items", "types": [ { "kind": "HttpTypeReference", @@ -35889,13 +35893,11 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "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" + ] + } }, - "oasRef": "#/components/schemas/MessageObject/properties/content", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "array", "childrenParentSchema": "union", "children": [ @@ -35907,44 +35909,44 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) message > (schema) > (property) created_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the message was created.", + "oasRef": "#/components/schemas/MessageObject/properties/created_at", + "deprecated": false, "key": "created_at", - "optional": false, - "nullable": false, + "docstring": "The Unix timestamp (in seconds) for when the message was created.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/MessageObject/properties/created_at", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.threads.messages > (model) message > (schema) > (property) incomplete_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the message was marked as incomplete.", + "oasRef": "#/components/schemas/MessageObject/properties/incomplete_at", + "deprecated": false, "key": "incomplete_at", - "optional": false, - "nullable": true, + "docstring": "The Unix timestamp (in seconds) for when the message was marked as incomplete.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/MessageObject/properties/incomplete_at", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.messages > (model) message > (schema) > (property) incomplete_details": { "kind": "HttpDeclProperty", - "docstring": "On an incomplete message, details about why the message is incomplete.", + "oasRef": "#/components/schemas/MessageObject/properties/incomplete_details", + "deprecated": false, "key": "incomplete_details", - "optional": false, - "nullable": true, + "docstring": "On an incomplete message, details about why the message is incomplete.", "type": { "kind": "HttpTypeObject", "members": [ @@ -35953,8 +35955,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/MessageObject/properties/incomplete_details", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -35963,40 +35965,40 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) message > (schema) > (property) metadata": { "kind": "HttpDeclProperty", - "docstring": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.\n", + "oasRef": "#/components/schemas/MessageObject/properties/metadata", + "deprecated": false, "key": "metadata", - "optional": false, - "nullable": true, + "docstring": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.\n", "type": { "kind": "HttpTypeReference", "ident": "Metadata", "$ref": "(resource) $shared > (model) metadata > (schema)" }, - "oasRef": "#/components/schemas/MessageObject/properties/metadata", - "deprecated": false, - "schemaType": "map", + "optional": false, + "nullable": true, "modelImplicit": false, + "schemaType": "map", "modelPath": "(resource) $shared > (model) metadata", "children": [] }, "(resource) beta.threads.messages > (model) message > (schema) > (property) object": { "kind": "HttpDeclProperty", - "docstring": "The object type, which is always `thread.message`.", + "oasRef": "#/components/schemas/MessageObject/properties/object", + "deprecated": false, "key": "object", - "optional": false, - "nullable": false, + "docstring": "The object type, which is always `thread.message`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MessageObject/properties/object", "types": [ { "kind": "HttpTypeLiteral", "literal": "thread.message" } - ], - "oasRef": "#/components/schemas/MessageObject/properties/object" + ] }, - "oasRef": "#/components/schemas/MessageObject/properties/object", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -36005,12 +36007,13 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) message > (schema) > (property) role": { "kind": "HttpDeclProperty", - "docstring": "The entity that produced the message. One of `user` or `assistant`.", + "oasRef": "#/components/schemas/MessageObject/properties/role", + "deprecated": false, "key": "role", - "optional": false, - "nullable": false, + "docstring": "The entity that produced the message. One of `user` or `assistant`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MessageObject/properties/role", "types": [ { "kind": "HttpTypeLiteral", @@ -36020,11 +36023,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "assistant" } - ], - "oasRef": "#/components/schemas/MessageObject/properties/role" + ] }, - "oasRef": "#/components/schemas/MessageObject/properties/role", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -36034,26 +36036,27 @@ 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](/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.", + "oasRef": "#/components/schemas/MessageObject/properties/run_id", + "deprecated": false, "key": "run_id", - "optional": false, - "nullable": true, + "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.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/MessageObject/properties/run_id", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "string", "children": [] }, "(resource) beta.threads.messages > (model) message > (schema) > (property) status": { "kind": "HttpDeclProperty", - "docstring": "The status of the message, which can be either `in_progress`, `incomplete`, or `completed`.", + "oasRef": "#/components/schemas/MessageObject/properties/status", + "deprecated": false, "key": "status", - "optional": false, - "nullable": false, + "docstring": "The status of the message, which can be either `in_progress`, `incomplete`, or `completed`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MessageObject/properties/status", "types": [ { "kind": "HttpTypeLiteral", @@ -36067,11 +36070,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "completed" } - ], - "oasRef": "#/components/schemas/MessageObject/properties/status" + ] }, - "oasRef": "#/components/schemas/MessageObject/properties/status", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -36082,21 +36084,22 @@ 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](/docs/api-reference/threads) ID that this message belongs to.", + "oasRef": "#/components/schemas/MessageObject/properties/thread_id", + "deprecated": false, "key": "thread_id", - "optional": false, - "nullable": false, + "docstring": "The [thread](/docs/api-reference/threads) ID that this message belongs to.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/MessageObject/properties/thread_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.messages > (model) message > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/MessageObject", + "docstring": "Represents a message within a [thread](/docs/api-reference/threads).", "ident": "Message", "type": { "kind": "HttpTypeObject", @@ -36145,7 +36148,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Represents a message within a [thread](/docs/api-reference/threads).", "childrenParentSchema": "object", "children": [ "(resource) beta.threads.messages > (model) message > (schema) > (property) id", @@ -36173,28 +36175,30 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) message > (schema) > (property) attachments > (items) > (property) file_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the file to attach to the message.", + "oasRef": "#/components/schemas/MessageObject/properties/attachments/anyOf/0/items/properties/file_id", + "deprecated": false, "key": "file_id", - "optional": true, - "nullable": false, + "docstring": "The ID of the file to attach to the message.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/MessageObject/properties/attachments/anyOf/0/items/properties/file_id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.messages > (model) message > (schema) > (property) attachments > (items) > (property) tools": { "kind": "HttpDeclProperty", - "docstring": "The tools to add this file to.", + "oasRef": "#/components/schemas/MessageObject/properties/attachments/anyOf/0/items/properties/tools", + "deprecated": false, "key": "tools", - "optional": true, - "nullable": false, + "docstring": "The tools to add this file to.", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/MessageObject/properties/attachments/anyOf/0/items/properties/tools", "elementType": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MessageObject/properties/attachments/anyOf/0/items/properties/tools/items", "types": [ { "kind": "HttpTypeReference", @@ -36209,13 +36213,11 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] } - ], - "oasRef": "#/components/schemas/MessageObject/properties/attachments/anyOf/0/items/properties/tools/items" - }, - "oasRef": "#/components/schemas/MessageObject/properties/attachments/anyOf/0/items/properties/tools" + ] + } }, - "oasRef": "#/components/schemas/MessageObject/properties/attachments/anyOf/0/items/properties/tools", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "array", "childrenParentSchema": "union", "children": [ @@ -36278,6 +36280,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.messages > (model) image_file_content_block > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/MessageContentImageFileObject", + "docstring": "References an image [File](/docs/api-reference/files) in the content of a message.", "ident": "ImageFileContentBlock", "type": { "kind": "HttpTypeObject", @@ -36290,7 +36293,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "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", @@ -36300,6 +36302,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.messages > (model) image_url_content_block > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/MessageContentImageUrlObject", + "docstring": "References an image URL in the content of a message.", "ident": "ImageURLContentBlock", "type": { "kind": "HttpTypeObject", @@ -36312,7 +36315,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "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", @@ -36322,6 +36324,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.messages > (model) text_content_block > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/MessageContentTextObject", + "docstring": "The text content that is part of a message.", "ident": "TextContentBlock", "type": { "kind": "HttpTypeObject", @@ -36334,7 +36337,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "The text content that is part of a message.", "childrenParentSchema": "object", "children": [ "(resource) beta.threads.messages > (model) text_content_block > (schema) > (property) text", @@ -36344,6 +36346,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.messages > (model) refusal_content_block > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/MessageContentRefusalObject", + "docstring": "The refusal content generated by the assistant.", "ident": "RefusalContentBlock", "type": { "kind": "HttpTypeObject", @@ -36356,7 +36359,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "The refusal content generated by the assistant.", "childrenParentSchema": "object", "children": [ "(resource) beta.threads.messages > (model) refusal_content_block > (schema) > (property) refusal", @@ -36365,12 +36367,13 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) message > (schema) > (property) incomplete_details > (property) reason": { "kind": "HttpDeclProperty", - "docstring": "The reason the message is incomplete.", + "oasRef": "#/components/schemas/MessageObject/properties/incomplete_details/anyOf/0/properties/reason", + "deprecated": false, "key": "reason", - "optional": false, - "nullable": false, + "docstring": "The reason the message is incomplete.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MessageObject/properties/incomplete_details/anyOf/0/properties/reason", "types": [ { "kind": "HttpTypeLiteral", @@ -36392,11 +36395,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "run_failed" } - ], - "oasRef": "#/components/schemas/MessageObject/properties/incomplete_details/anyOf/0/properties/reason" + ] }, - "oasRef": "#/components/schemas/MessageObject/properties/incomplete_details/anyOf/0/properties/reason", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -36410,9 +36412,11 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) $shared > (model) metadata > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/Metadata", + "docstring": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.\n", "ident": "Metadata", "type": { "kind": "HttpTypeReference", + "oasRef": "#/components/schemas/Metadata", "ident": "Record", "typeParameters": [ { @@ -36421,10 +36425,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch { "kind": "HttpTypeString" } - ], - "oasRef": "#/components/schemas/Metadata" + ] }, - "docstring": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.\n", "children": [] }, "(resource) beta.threads.messages > (model) message > (schema) > (property) object > (member) 0": { @@ -36517,18 +36519,18 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) image_file_content_block > (schema) > (property) image_file": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/MessageContentImageFileObject/properties/image_file", + "deprecated": false, "key": "image_file", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeReference", "ident": "ImageFile", "$ref": "(resource) beta.threads.messages > (model) image_file > (schema)" }, - "oasRef": "#/components/schemas/MessageContentImageFileObject/properties/image_file", - "deprecated": false, - "schemaType": "object", + "optional": false, + "nullable": false, "modelImplicit": false, + "schemaType": "object", "modelPath": "(resource) beta.threads.messages > (model) image_file", "childrenParentSchema": "object", "children": [ @@ -36538,22 +36540,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) image_file_content_block > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "Always `image_file`.", + "oasRef": "#/components/schemas/MessageContentImageFileObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "Always `image_file`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MessageContentImageFileObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "image_file" } - ], - "oasRef": "#/components/schemas/MessageContentImageFileObject/properties/type" + ] }, - "oasRef": "#/components/schemas/MessageContentImageFileObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -36562,18 +36564,18 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) image_url_content_block > (schema) > (property) image_url": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/MessageContentImageUrlObject/properties/image_url", + "deprecated": false, "key": "image_url", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeReference", "ident": "ImageURL", "$ref": "(resource) beta.threads.messages > (model) image_url > (schema)" }, - "oasRef": "#/components/schemas/MessageContentImageUrlObject/properties/image_url", - "deprecated": false, - "schemaType": "object", + "optional": false, + "nullable": false, "modelImplicit": false, + "schemaType": "object", "modelPath": "(resource) beta.threads.messages > (model) image_url", "childrenParentSchema": "object", "children": [ @@ -36583,22 +36585,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) image_url_content_block > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the content part.", + "oasRef": "#/components/schemas/MessageContentImageUrlObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the content part.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MessageContentImageUrlObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "image_url" } - ], - "oasRef": "#/components/schemas/MessageContentImageUrlObject/properties/type" + ] }, - "oasRef": "#/components/schemas/MessageContentImageUrlObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -36607,18 +36609,18 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) text_content_block > (schema) > (property) text": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/MessageContentTextObject/properties/text", + "deprecated": false, "key": "text", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeReference", "ident": "Text", "$ref": "(resource) beta.threads.messages > (model) text > (schema)" }, - "oasRef": "#/components/schemas/MessageContentTextObject/properties/text", - "deprecated": false, - "schemaType": "object", + "optional": false, + "nullable": false, "modelImplicit": false, + "schemaType": "object", "modelPath": "(resource) beta.threads.messages > (model) text", "childrenParentSchema": "object", "children": [ @@ -36628,22 +36630,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) text_content_block > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "Always `text`.", + "oasRef": "#/components/schemas/MessageContentTextObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "Always `text`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MessageContentTextObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "text" } - ], - "oasRef": "#/components/schemas/MessageContentTextObject/properties/type" + ] }, - "oasRef": "#/components/schemas/MessageContentTextObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -36652,35 +36654,35 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) refusal_content_block > (schema) > (property) refusal": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/MessageContentRefusalObject/properties/refusal", + "deprecated": false, "key": "refusal", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/MessageContentRefusalObject/properties/refusal", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.messages > (model) refusal_content_block > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "Always `refusal`.", + "oasRef": "#/components/schemas/MessageContentRefusalObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "Always `refusal`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MessageContentRefusalObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "refusal" } - ], - "oasRef": "#/components/schemas/MessageContentRefusalObject/properties/type" + ] }, - "oasRef": "#/components/schemas/MessageContentRefusalObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -36724,22 +36726,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of tool being defined: `code_interpreter`", + "oasRef": "#/components/schemas/AssistantToolsCode/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of tool being defined: `code_interpreter`", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantToolsCode/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "code_interpreter" } - ], - "oasRef": "#/components/schemas/AssistantToolsCode/properties/type" + ] }, - "oasRef": "#/components/schemas/AssistantToolsCode/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -36748,22 +36750,22 @@ 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 > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of tool being defined: `file_search`", + "oasRef": "#/components/schemas/AssistantToolsFileSearchTypeOnly/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of tool being defined: `file_search`", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantToolsFileSearchTypeOnly/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "file_search" } - ], - "oasRef": "#/components/schemas/AssistantToolsFileSearchTypeOnly/properties/type" + ] }, - "oasRef": "#/components/schemas/AssistantToolsFileSearchTypeOnly/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -36772,27 +36774,27 @@ 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](/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.", + "oasRef": "#/components/schemas/MessageContentImageFileObject/properties/image_file/properties/file_id", + "deprecated": false, "key": "file_id", - "optional": false, - "nullable": false, + "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.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/MessageContentImageFileObject/properties/image_file/properties/file_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.messages > (model) image_file > (schema) > (property) detail": { "kind": "HttpDeclProperty", - "docstring": "Specifies the detail level of the image if specified by the user. `low` uses fewer tokens, you can opt in to high resolution using `high`.", + "oasRef": "#/components/schemas/MessageContentImageFileObject/properties/image_file/properties/detail", + "deprecated": false, "key": "detail", - "optional": true, - "nullable": false, - "default": "auto", + "docstring": "Specifies the detail level of the image if specified by the user. `low` uses fewer tokens, you can opt in to high resolution using `high`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MessageContentImageFileObject/properties/image_file/properties/detail", "types": [ { "kind": "HttpTypeLiteral", @@ -36806,11 +36808,11 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "high" } - ], - "oasRef": "#/components/schemas/MessageContentImageFileObject/properties/image_file/properties/detail" + ] }, - "oasRef": "#/components/schemas/MessageContentImageFileObject/properties/image_file/properties/detail", - "deprecated": false, + "default": "auto", + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -36849,30 +36851,30 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) image_url > (schema) > (property) url": { "kind": "HttpDeclProperty", - "docstring": "The external URL of the image, must be a supported image types: jpeg, jpg, png, gif, webp.", + "oasRef": "#/components/schemas/MessageContentImageUrlObject/properties/image_url/properties/url", + "deprecated": false, "key": "url", - "optional": false, - "nullable": false, + "docstring": "The external URL of the image, must be a supported image types: jpeg, jpg, png, gif, webp.", "type": { "kind": "HttpTypeString" }, "constraints": { "format": "uri" }, - "oasRef": "#/components/schemas/MessageContentImageUrlObject/properties/image_url/properties/url", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.messages > (model) image_url > (schema) > (property) detail": { "kind": "HttpDeclProperty", - "docstring": "Specifies the detail level of the image. `low` uses fewer tokens, you can opt in to high resolution using `high`. Default value is `auto`", + "oasRef": "#/components/schemas/MessageContentImageUrlObject/properties/image_url/properties/detail", + "deprecated": false, "key": "detail", - "optional": true, - "nullable": false, - "default": "auto", + "docstring": "Specifies the detail level of the image. `low` uses fewer tokens, you can opt in to high resolution using `high`. Default value is `auto`", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MessageContentImageUrlObject/properties/image_url/properties/detail", "types": [ { "kind": "HttpTypeLiteral", @@ -36886,11 +36888,11 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "high" } - ], - "oasRef": "#/components/schemas/MessageContentImageUrlObject/properties/image_url/properties/detail" + ] }, - "oasRef": "#/components/schemas/MessageContentImageUrlObject/properties/image_url/properties/detail", - "deprecated": false, + "default": "auto", + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -36929,13 +36931,15 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) text > (schema) > (property) annotations": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/MessageContentTextObject/properties/text/properties/annotations", + "deprecated": false, "key": "annotations", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/MessageContentTextObject/properties/text/properties/annotations", "elementType": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MessageContentTextObject/properties/text/properties/annotations/items", "types": [ { "kind": "HttpTypeReference", @@ -36947,13 +36951,11 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "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" + ] + } }, - "oasRef": "#/components/schemas/MessageContentTextObject/properties/text/properties/annotations", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "array", "childrenParentSchema": "union", "children": [ @@ -36963,15 +36965,15 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) text > (schema) > (property) value": { "kind": "HttpDeclProperty", - "docstring": "The data that makes up the text.", + "oasRef": "#/components/schemas/MessageContentTextObject/properties/text/properties/value", + "deprecated": false, "key": "value", - "optional": false, - "nullable": false, + "docstring": "The data that makes up the text.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/MessageContentTextObject/properties/text/properties/value", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, @@ -37101,6 +37103,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.messages > (model) file_citation_annotation > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject", + "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.", "ident": "FileCitationAnnotation", "type": { "kind": "HttpTypeObject", @@ -37122,7 +37125,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "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", @@ -37135,6 +37137,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.messages > (model) file_path_annotation > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/MessageContentTextAnnotationsFilePathObject", + "docstring": "A URL for the file that's generated when the assistant used the `code_interpreter` tool to generate a file.", "ident": "FilePathAnnotation", "type": { "kind": "HttpTypeObject", @@ -37156,7 +37159,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "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", @@ -37168,25 +37170,25 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) end_index": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject/properties/end_index", + "deprecated": false, "key": "end_index", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeNumber" }, "constraints": { "minimum": 0 }, - "oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject/properties/end_index", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) file_citation": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject/properties/file_citation", + "deprecated": false, "key": "file_citation", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeObject", "members": [ @@ -37195,8 +37197,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject/properties/file_citation", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -37205,52 +37207,52 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) start_index": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject/properties/start_index", + "deprecated": false, "key": "start_index", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeNumber" }, "constraints": { "minimum": 0 }, - "oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject/properties/start_index", - "deprecated": false, + "optional": false, + "nullable": 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.", + "oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject/properties/text", + "deprecated": false, "key": "text", - "optional": false, - "nullable": false, + "docstring": "The text in the message content that needs to be replaced.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject/properties/text", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "Always `file_citation`.", + "oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "Always `file_citation`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "file_citation" } - ], - "oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject/properties/type" + ] }, - "oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -37259,25 +37261,25 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) end_index": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/MessageContentTextAnnotationsFilePathObject/properties/end_index", + "deprecated": false, "key": "end_index", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeNumber" }, "constraints": { "minimum": 0 }, - "oasRef": "#/components/schemas/MessageContentTextAnnotationsFilePathObject/properties/end_index", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) file_path": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/MessageContentTextAnnotationsFilePathObject/properties/file_path", + "deprecated": false, "key": "file_path", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeObject", "members": [ @@ -37286,8 +37288,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/MessageContentTextAnnotationsFilePathObject/properties/file_path", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -37296,52 +37298,52 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) start_index": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/MessageContentTextAnnotationsFilePathObject/properties/start_index", + "deprecated": false, "key": "start_index", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeNumber" }, "constraints": { "minimum": 0 }, - "oasRef": "#/components/schemas/MessageContentTextAnnotationsFilePathObject/properties/start_index", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) text": { "kind": "HttpDeclProperty", - "docstring": "The text in the message content that needs to be replaced.", + "oasRef": "#/components/schemas/MessageContentTextAnnotationsFilePathObject/properties/text", + "deprecated": false, "key": "text", - "optional": false, - "nullable": false, + "docstring": "The text in the message content that needs to be replaced.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/MessageContentTextAnnotationsFilePathObject/properties/text", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "Always `file_path`.", + "oasRef": "#/components/schemas/MessageContentTextAnnotationsFilePathObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "Always `file_path`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MessageContentTextAnnotationsFilePathObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "file_path" } - ], - "oasRef": "#/components/schemas/MessageContentTextAnnotationsFilePathObject/properties/type" + ] }, - "oasRef": "#/components/schemas/MessageContentTextAnnotationsFilePathObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -37350,15 +37352,15 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(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.", + "oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject/properties/file_citation/properties/file_id", + "deprecated": false, "key": "file_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the specific File the citation is from.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject/properties/file_citation/properties/file_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, @@ -37371,15 +37373,15 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) file_path > (property) file_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the file that was generated.", + "oasRef": "#/components/schemas/MessageContentTextAnnotationsFilePathObject/properties/file_path/properties/file_id", + "deprecated": false, "key": "file_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the file that was generated.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/MessageContentTextAnnotationsFilePathObject/properties/file_path/properties/file_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, @@ -37412,7 +37414,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/oneOf/1", - "ident": "UnionMember19", + "docstring": "Occurs when a [message](/docs/api-reference/messages/object) moves to an `in_progress` state.", + "ident": "ThreadMessageInProgress", "type": { "kind": "HttpTypeObject", "members": [ @@ -37424,7 +37427,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "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", @@ -37433,20 +37435,20 @@ 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](/docs/api-reference/threads).", + "oasRef": "#/components/schemas/MessageStreamEvent/oneOf/1/properties/data", + "deprecated": false, "key": "data", - "optional": false, - "nullable": false, + "docstring": "Represents a message within a [thread](/docs/api-reference/threads).", + "title": "The message object", "type": { "kind": "HttpTypeReference", "ident": "Message", "$ref": "(resource) beta.threads.messages > (model) message > (schema)" }, - "oasRef": "#/components/schemas/MessageStreamEvent/oneOf/1/properties/data", - "deprecated": false, - "schemaType": "object", + "optional": false, + "nullable": false, "modelImplicit": false, + "schemaType": "object", "modelPath": "(resource) beta.threads.messages > (model) message", "childrenParentSchema": "object", "children": [ @@ -37468,21 +37470,21 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 19 > (property) event": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/MessageStreamEvent/oneOf/1/properties/event", + "deprecated": false, "key": "event", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MessageStreamEvent/oneOf/1/properties/event", "types": [ { "kind": "HttpTypeLiteral", "literal": "thread.message.in_progress" } - ], - "oasRef": "#/components/schemas/MessageStreamEvent/oneOf/1/properties/event" + ] }, - "oasRef": "#/components/schemas/MessageStreamEvent/oneOf/1/properties/event", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -37491,40 +37493,41 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) message > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The identifier, which can be referenced in API endpoints.", + "oasRef": "#/components/schemas/MessageObject/properties/id", + "deprecated": false, "key": "id", - "optional": false, - "nullable": false, + "docstring": "The identifier, which can be referenced in API endpoints.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/MessageObject/properties/id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.messages > (model) message > (schema) > (property) assistant_id": { "kind": "HttpDeclProperty", - "docstring": "If applicable, the ID of the [assistant](/docs/api-reference/assistants) that authored this message.", + "oasRef": "#/components/schemas/MessageObject/properties/assistant_id", + "deprecated": false, "key": "assistant_id", - "optional": false, - "nullable": true, + "docstring": "If applicable, the ID of the [assistant](/docs/api-reference/assistants) that authored this message.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/MessageObject/properties/assistant_id", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "string", "children": [] }, "(resource) beta.threads.messages > (model) message > (schema) > (property) attachments": { "kind": "HttpDeclProperty", - "docstring": "A list of files attached to the message, and the tools they were added to.", + "oasRef": "#/components/schemas/MessageObject/properties/attachments", + "deprecated": false, "key": "attachments", - "optional": false, - "nullable": true, + "docstring": "A list of files attached to the message, and the tools they were added to.", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/MessageObject/properties/attachments", "elementType": { "kind": "HttpTypeObject", "members": [ @@ -37535,11 +37538,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "ident": "tools" } ] + } }, - "oasRef": "#/components/schemas/MessageObject/properties/attachments" - }, - "oasRef": "#/components/schemas/MessageObject/properties/attachments", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "array", "childrenParentSchema": "object", "children": [ @@ -37549,31 +37551,33 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) message > (schema) > (property) completed_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the message was completed.", + "oasRef": "#/components/schemas/MessageObject/properties/completed_at", + "deprecated": false, "key": "completed_at", - "optional": false, - "nullable": true, + "docstring": "The Unix timestamp (in seconds) for when the message was completed.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/MessageObject/properties/completed_at", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.messages > (model) message > (schema) > (property) content": { "kind": "HttpDeclProperty", - "docstring": "The content of the message in array of text and/or images.", + "oasRef": "#/components/schemas/MessageObject/properties/content", + "deprecated": false, "key": "content", - "optional": false, - "nullable": false, + "docstring": "The content of the message in array of text and/or images.", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/MessageObject/properties/content", "elementType": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MessageObject/properties/content/items", "types": [ { "kind": "HttpTypeReference", @@ -37595,13 +37599,11 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "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" + ] + } }, - "oasRef": "#/components/schemas/MessageObject/properties/content", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "array", "childrenParentSchema": "union", "children": [ @@ -37613,44 +37615,44 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) message > (schema) > (property) created_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the message was created.", + "oasRef": "#/components/schemas/MessageObject/properties/created_at", + "deprecated": false, "key": "created_at", - "optional": false, - "nullable": false, + "docstring": "The Unix timestamp (in seconds) for when the message was created.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/MessageObject/properties/created_at", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.threads.messages > (model) message > (schema) > (property) incomplete_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the message was marked as incomplete.", + "oasRef": "#/components/schemas/MessageObject/properties/incomplete_at", + "deprecated": false, "key": "incomplete_at", - "optional": false, - "nullable": true, + "docstring": "The Unix timestamp (in seconds) for when the message was marked as incomplete.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/MessageObject/properties/incomplete_at", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.messages > (model) message > (schema) > (property) incomplete_details": { "kind": "HttpDeclProperty", - "docstring": "On an incomplete message, details about why the message is incomplete.", + "oasRef": "#/components/schemas/MessageObject/properties/incomplete_details", + "deprecated": false, "key": "incomplete_details", - "optional": false, - "nullable": true, + "docstring": "On an incomplete message, details about why the message is incomplete.", "type": { "kind": "HttpTypeObject", "members": [ @@ -37659,8 +37661,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/MessageObject/properties/incomplete_details", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -37669,40 +37671,40 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) message > (schema) > (property) metadata": { "kind": "HttpDeclProperty", - "docstring": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.\n", + "oasRef": "#/components/schemas/MessageObject/properties/metadata", + "deprecated": false, "key": "metadata", - "optional": false, - "nullable": true, + "docstring": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.\n", "type": { "kind": "HttpTypeReference", "ident": "Metadata", "$ref": "(resource) $shared > (model) metadata > (schema)" }, - "oasRef": "#/components/schemas/MessageObject/properties/metadata", - "deprecated": false, - "schemaType": "map", + "optional": false, + "nullable": true, "modelImplicit": false, + "schemaType": "map", "modelPath": "(resource) $shared > (model) metadata", "children": [] }, "(resource) beta.threads.messages > (model) message > (schema) > (property) object": { "kind": "HttpDeclProperty", - "docstring": "The object type, which is always `thread.message`.", + "oasRef": "#/components/schemas/MessageObject/properties/object", + "deprecated": false, "key": "object", - "optional": false, - "nullable": false, + "docstring": "The object type, which is always `thread.message`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MessageObject/properties/object", "types": [ { "kind": "HttpTypeLiteral", "literal": "thread.message" } - ], - "oasRef": "#/components/schemas/MessageObject/properties/object" + ] }, - "oasRef": "#/components/schemas/MessageObject/properties/object", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -37711,12 +37713,13 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) message > (schema) > (property) role": { "kind": "HttpDeclProperty", - "docstring": "The entity that produced the message. One of `user` or `assistant`.", + "oasRef": "#/components/schemas/MessageObject/properties/role", + "deprecated": false, "key": "role", - "optional": false, - "nullable": false, + "docstring": "The entity that produced the message. One of `user` or `assistant`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MessageObject/properties/role", "types": [ { "kind": "HttpTypeLiteral", @@ -37726,11 +37729,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "assistant" } - ], - "oasRef": "#/components/schemas/MessageObject/properties/role" + ] }, - "oasRef": "#/components/schemas/MessageObject/properties/role", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -37740,26 +37742,27 @@ 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](/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.", + "oasRef": "#/components/schemas/MessageObject/properties/run_id", + "deprecated": false, "key": "run_id", - "optional": false, - "nullable": true, + "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.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/MessageObject/properties/run_id", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "string", "children": [] }, "(resource) beta.threads.messages > (model) message > (schema) > (property) status": { "kind": "HttpDeclProperty", - "docstring": "The status of the message, which can be either `in_progress`, `incomplete`, or `completed`.", + "oasRef": "#/components/schemas/MessageObject/properties/status", + "deprecated": false, "key": "status", - "optional": false, - "nullable": false, + "docstring": "The status of the message, which can be either `in_progress`, `incomplete`, or `completed`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MessageObject/properties/status", "types": [ { "kind": "HttpTypeLiteral", @@ -37773,11 +37776,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "completed" } - ], - "oasRef": "#/components/schemas/MessageObject/properties/status" + ] }, - "oasRef": "#/components/schemas/MessageObject/properties/status", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -37788,21 +37790,22 @@ 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](/docs/api-reference/threads) ID that this message belongs to.", + "oasRef": "#/components/schemas/MessageObject/properties/thread_id", + "deprecated": false, "key": "thread_id", - "optional": false, - "nullable": false, + "docstring": "The [thread](/docs/api-reference/threads) ID that this message belongs to.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/MessageObject/properties/thread_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.messages > (model) message > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/MessageObject", + "docstring": "Represents a message within a [thread](/docs/api-reference/threads).", "ident": "Message", "type": { "kind": "HttpTypeObject", @@ -37851,7 +37854,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Represents a message within a [thread](/docs/api-reference/threads).", "childrenParentSchema": "object", "children": [ "(resource) beta.threads.messages > (model) message > (schema) > (property) id", @@ -37879,28 +37881,30 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) message > (schema) > (property) attachments > (items) > (property) file_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the file to attach to the message.", + "oasRef": "#/components/schemas/MessageObject/properties/attachments/anyOf/0/items/properties/file_id", + "deprecated": false, "key": "file_id", - "optional": true, - "nullable": false, + "docstring": "The ID of the file to attach to the message.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/MessageObject/properties/attachments/anyOf/0/items/properties/file_id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.messages > (model) message > (schema) > (property) attachments > (items) > (property) tools": { "kind": "HttpDeclProperty", - "docstring": "The tools to add this file to.", + "oasRef": "#/components/schemas/MessageObject/properties/attachments/anyOf/0/items/properties/tools", + "deprecated": false, "key": "tools", - "optional": true, - "nullable": false, + "docstring": "The tools to add this file to.", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/MessageObject/properties/attachments/anyOf/0/items/properties/tools", "elementType": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MessageObject/properties/attachments/anyOf/0/items/properties/tools/items", "types": [ { "kind": "HttpTypeReference", @@ -37915,13 +37919,11 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] } - ], - "oasRef": "#/components/schemas/MessageObject/properties/attachments/anyOf/0/items/properties/tools/items" - }, - "oasRef": "#/components/schemas/MessageObject/properties/attachments/anyOf/0/items/properties/tools" + ] + } }, - "oasRef": "#/components/schemas/MessageObject/properties/attachments/anyOf/0/items/properties/tools", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "array", "childrenParentSchema": "union", "children": [ @@ -37984,6 +37986,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.messages > (model) image_file_content_block > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/MessageContentImageFileObject", + "docstring": "References an image [File](/docs/api-reference/files) in the content of a message.", "ident": "ImageFileContentBlock", "type": { "kind": "HttpTypeObject", @@ -37996,7 +37999,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "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", @@ -38006,6 +38008,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.messages > (model) image_url_content_block > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/MessageContentImageUrlObject", + "docstring": "References an image URL in the content of a message.", "ident": "ImageURLContentBlock", "type": { "kind": "HttpTypeObject", @@ -38018,7 +38021,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "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", @@ -38028,6 +38030,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.messages > (model) text_content_block > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/MessageContentTextObject", + "docstring": "The text content that is part of a message.", "ident": "TextContentBlock", "type": { "kind": "HttpTypeObject", @@ -38040,7 +38043,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "The text content that is part of a message.", "childrenParentSchema": "object", "children": [ "(resource) beta.threads.messages > (model) text_content_block > (schema) > (property) text", @@ -38050,6 +38052,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.messages > (model) refusal_content_block > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/MessageContentRefusalObject", + "docstring": "The refusal content generated by the assistant.", "ident": "RefusalContentBlock", "type": { "kind": "HttpTypeObject", @@ -38062,7 +38065,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "The refusal content generated by the assistant.", "childrenParentSchema": "object", "children": [ "(resource) beta.threads.messages > (model) refusal_content_block > (schema) > (property) refusal", @@ -38071,12 +38073,13 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) message > (schema) > (property) incomplete_details > (property) reason": { "kind": "HttpDeclProperty", - "docstring": "The reason the message is incomplete.", + "oasRef": "#/components/schemas/MessageObject/properties/incomplete_details/anyOf/0/properties/reason", + "deprecated": false, "key": "reason", - "optional": false, - "nullable": false, + "docstring": "The reason the message is incomplete.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MessageObject/properties/incomplete_details/anyOf/0/properties/reason", "types": [ { "kind": "HttpTypeLiteral", @@ -38098,11 +38101,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "run_failed" } - ], - "oasRef": "#/components/schemas/MessageObject/properties/incomplete_details/anyOf/0/properties/reason" + ] }, - "oasRef": "#/components/schemas/MessageObject/properties/incomplete_details/anyOf/0/properties/reason", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -38116,9 +38118,11 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) $shared > (model) metadata > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/Metadata", + "docstring": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.\n", "ident": "Metadata", "type": { "kind": "HttpTypeReference", + "oasRef": "#/components/schemas/Metadata", "ident": "Record", "typeParameters": [ { @@ -38127,10 +38131,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch { "kind": "HttpTypeString" } - ], - "oasRef": "#/components/schemas/Metadata" + ] }, - "docstring": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.\n", "children": [] }, "(resource) beta.threads.messages > (model) message > (schema) > (property) object > (member) 0": { @@ -38223,18 +38225,18 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) image_file_content_block > (schema) > (property) image_file": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/MessageContentImageFileObject/properties/image_file", + "deprecated": false, "key": "image_file", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeReference", "ident": "ImageFile", "$ref": "(resource) beta.threads.messages > (model) image_file > (schema)" }, - "oasRef": "#/components/schemas/MessageContentImageFileObject/properties/image_file", - "deprecated": false, - "schemaType": "object", + "optional": false, + "nullable": false, "modelImplicit": false, + "schemaType": "object", "modelPath": "(resource) beta.threads.messages > (model) image_file", "childrenParentSchema": "object", "children": [ @@ -38244,22 +38246,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) image_file_content_block > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "Always `image_file`.", + "oasRef": "#/components/schemas/MessageContentImageFileObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "Always `image_file`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MessageContentImageFileObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "image_file" } - ], - "oasRef": "#/components/schemas/MessageContentImageFileObject/properties/type" + ] }, - "oasRef": "#/components/schemas/MessageContentImageFileObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -38268,18 +38270,18 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) image_url_content_block > (schema) > (property) image_url": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/MessageContentImageUrlObject/properties/image_url", + "deprecated": false, "key": "image_url", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeReference", "ident": "ImageURL", "$ref": "(resource) beta.threads.messages > (model) image_url > (schema)" }, - "oasRef": "#/components/schemas/MessageContentImageUrlObject/properties/image_url", - "deprecated": false, - "schemaType": "object", + "optional": false, + "nullable": false, "modelImplicit": false, + "schemaType": "object", "modelPath": "(resource) beta.threads.messages > (model) image_url", "childrenParentSchema": "object", "children": [ @@ -38289,22 +38291,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) image_url_content_block > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the content part.", + "oasRef": "#/components/schemas/MessageContentImageUrlObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the content part.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MessageContentImageUrlObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "image_url" } - ], - "oasRef": "#/components/schemas/MessageContentImageUrlObject/properties/type" + ] }, - "oasRef": "#/components/schemas/MessageContentImageUrlObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -38313,18 +38315,18 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) text_content_block > (schema) > (property) text": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/MessageContentTextObject/properties/text", + "deprecated": false, "key": "text", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeReference", "ident": "Text", "$ref": "(resource) beta.threads.messages > (model) text > (schema)" }, - "oasRef": "#/components/schemas/MessageContentTextObject/properties/text", - "deprecated": false, - "schemaType": "object", + "optional": false, + "nullable": false, "modelImplicit": false, + "schemaType": "object", "modelPath": "(resource) beta.threads.messages > (model) text", "childrenParentSchema": "object", "children": [ @@ -38334,22 +38336,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) text_content_block > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "Always `text`.", + "oasRef": "#/components/schemas/MessageContentTextObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "Always `text`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MessageContentTextObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "text" } - ], - "oasRef": "#/components/schemas/MessageContentTextObject/properties/type" + ] }, - "oasRef": "#/components/schemas/MessageContentTextObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -38358,35 +38360,35 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) refusal_content_block > (schema) > (property) refusal": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/MessageContentRefusalObject/properties/refusal", + "deprecated": false, "key": "refusal", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/MessageContentRefusalObject/properties/refusal", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.messages > (model) refusal_content_block > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "Always `refusal`.", + "oasRef": "#/components/schemas/MessageContentRefusalObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "Always `refusal`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MessageContentRefusalObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "refusal" } - ], - "oasRef": "#/components/schemas/MessageContentRefusalObject/properties/type" + ] }, - "oasRef": "#/components/schemas/MessageContentRefusalObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -38430,22 +38432,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of tool being defined: `code_interpreter`", + "oasRef": "#/components/schemas/AssistantToolsCode/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of tool being defined: `code_interpreter`", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantToolsCode/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "code_interpreter" } - ], - "oasRef": "#/components/schemas/AssistantToolsCode/properties/type" + ] }, - "oasRef": "#/components/schemas/AssistantToolsCode/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -38454,22 +38456,22 @@ 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 > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of tool being defined: `file_search`", + "oasRef": "#/components/schemas/AssistantToolsFileSearchTypeOnly/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of tool being defined: `file_search`", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantToolsFileSearchTypeOnly/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "file_search" } - ], - "oasRef": "#/components/schemas/AssistantToolsFileSearchTypeOnly/properties/type" + ] }, - "oasRef": "#/components/schemas/AssistantToolsFileSearchTypeOnly/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -38478,27 +38480,27 @@ 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](/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.", + "oasRef": "#/components/schemas/MessageContentImageFileObject/properties/image_file/properties/file_id", + "deprecated": false, "key": "file_id", - "optional": false, - "nullable": false, + "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.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/MessageContentImageFileObject/properties/image_file/properties/file_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.messages > (model) image_file > (schema) > (property) detail": { "kind": "HttpDeclProperty", - "docstring": "Specifies the detail level of the image if specified by the user. `low` uses fewer tokens, you can opt in to high resolution using `high`.", + "oasRef": "#/components/schemas/MessageContentImageFileObject/properties/image_file/properties/detail", + "deprecated": false, "key": "detail", - "optional": true, - "nullable": false, - "default": "auto", + "docstring": "Specifies the detail level of the image if specified by the user. `low` uses fewer tokens, you can opt in to high resolution using `high`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MessageContentImageFileObject/properties/image_file/properties/detail", "types": [ { "kind": "HttpTypeLiteral", @@ -38512,11 +38514,11 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "high" } - ], - "oasRef": "#/components/schemas/MessageContentImageFileObject/properties/image_file/properties/detail" + ] }, - "oasRef": "#/components/schemas/MessageContentImageFileObject/properties/image_file/properties/detail", - "deprecated": false, + "default": "auto", + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -38555,30 +38557,30 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) image_url > (schema) > (property) url": { "kind": "HttpDeclProperty", - "docstring": "The external URL of the image, must be a supported image types: jpeg, jpg, png, gif, webp.", + "oasRef": "#/components/schemas/MessageContentImageUrlObject/properties/image_url/properties/url", + "deprecated": false, "key": "url", - "optional": false, - "nullable": false, + "docstring": "The external URL of the image, must be a supported image types: jpeg, jpg, png, gif, webp.", "type": { "kind": "HttpTypeString" }, "constraints": { "format": "uri" }, - "oasRef": "#/components/schemas/MessageContentImageUrlObject/properties/image_url/properties/url", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.messages > (model) image_url > (schema) > (property) detail": { "kind": "HttpDeclProperty", - "docstring": "Specifies the detail level of the image. `low` uses fewer tokens, you can opt in to high resolution using `high`. Default value is `auto`", + "oasRef": "#/components/schemas/MessageContentImageUrlObject/properties/image_url/properties/detail", + "deprecated": false, "key": "detail", - "optional": true, - "nullable": false, - "default": "auto", + "docstring": "Specifies the detail level of the image. `low` uses fewer tokens, you can opt in to high resolution using `high`. Default value is `auto`", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MessageContentImageUrlObject/properties/image_url/properties/detail", "types": [ { "kind": "HttpTypeLiteral", @@ -38592,11 +38594,11 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "high" } - ], - "oasRef": "#/components/schemas/MessageContentImageUrlObject/properties/image_url/properties/detail" + ] }, - "oasRef": "#/components/schemas/MessageContentImageUrlObject/properties/image_url/properties/detail", - "deprecated": false, + "default": "auto", + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -38635,13 +38637,15 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) text > (schema) > (property) annotations": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/MessageContentTextObject/properties/text/properties/annotations", + "deprecated": false, "key": "annotations", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/MessageContentTextObject/properties/text/properties/annotations", "elementType": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MessageContentTextObject/properties/text/properties/annotations/items", "types": [ { "kind": "HttpTypeReference", @@ -38653,13 +38657,11 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "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" + ] + } }, - "oasRef": "#/components/schemas/MessageContentTextObject/properties/text/properties/annotations", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "array", "childrenParentSchema": "union", "children": [ @@ -38669,15 +38671,15 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) text > (schema) > (property) value": { "kind": "HttpDeclProperty", - "docstring": "The data that makes up the text.", + "oasRef": "#/components/schemas/MessageContentTextObject/properties/text/properties/value", + "deprecated": false, "key": "value", - "optional": false, - "nullable": false, + "docstring": "The data that makes up the text.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/MessageContentTextObject/properties/text/properties/value", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, @@ -38807,6 +38809,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.messages > (model) file_citation_annotation > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject", + "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.", "ident": "FileCitationAnnotation", "type": { "kind": "HttpTypeObject", @@ -38828,7 +38831,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "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", @@ -38841,6 +38843,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.messages > (model) file_path_annotation > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/MessageContentTextAnnotationsFilePathObject", + "docstring": "A URL for the file that's generated when the assistant used the `code_interpreter` tool to generate a file.", "ident": "FilePathAnnotation", "type": { "kind": "HttpTypeObject", @@ -38862,7 +38865,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "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", @@ -38874,25 +38876,25 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) end_index": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject/properties/end_index", + "deprecated": false, "key": "end_index", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeNumber" }, "constraints": { "minimum": 0 }, - "oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject/properties/end_index", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) file_citation": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject/properties/file_citation", + "deprecated": false, "key": "file_citation", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeObject", "members": [ @@ -38901,8 +38903,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject/properties/file_citation", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -38911,52 +38913,52 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) start_index": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject/properties/start_index", + "deprecated": false, "key": "start_index", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeNumber" }, "constraints": { "minimum": 0 }, - "oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject/properties/start_index", - "deprecated": false, + "optional": false, + "nullable": 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.", + "oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject/properties/text", + "deprecated": false, "key": "text", - "optional": false, - "nullable": false, + "docstring": "The text in the message content that needs to be replaced.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject/properties/text", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "Always `file_citation`.", + "oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "Always `file_citation`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "file_citation" } - ], - "oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject/properties/type" + ] }, - "oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -38965,25 +38967,25 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) end_index": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/MessageContentTextAnnotationsFilePathObject/properties/end_index", + "deprecated": false, "key": "end_index", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeNumber" }, "constraints": { "minimum": 0 }, - "oasRef": "#/components/schemas/MessageContentTextAnnotationsFilePathObject/properties/end_index", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) file_path": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/MessageContentTextAnnotationsFilePathObject/properties/file_path", + "deprecated": false, "key": "file_path", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeObject", "members": [ @@ -38992,8 +38994,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/MessageContentTextAnnotationsFilePathObject/properties/file_path", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -39002,52 +39004,52 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) start_index": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/MessageContentTextAnnotationsFilePathObject/properties/start_index", + "deprecated": false, "key": "start_index", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeNumber" }, "constraints": { "minimum": 0 }, - "oasRef": "#/components/schemas/MessageContentTextAnnotationsFilePathObject/properties/start_index", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) text": { "kind": "HttpDeclProperty", - "docstring": "The text in the message content that needs to be replaced.", + "oasRef": "#/components/schemas/MessageContentTextAnnotationsFilePathObject/properties/text", + "deprecated": false, "key": "text", - "optional": false, - "nullable": false, + "docstring": "The text in the message content that needs to be replaced.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/MessageContentTextAnnotationsFilePathObject/properties/text", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "Always `file_path`.", + "oasRef": "#/components/schemas/MessageContentTextAnnotationsFilePathObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "Always `file_path`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MessageContentTextAnnotationsFilePathObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "file_path" } - ], - "oasRef": "#/components/schemas/MessageContentTextAnnotationsFilePathObject/properties/type" + ] }, - "oasRef": "#/components/schemas/MessageContentTextAnnotationsFilePathObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -39056,15 +39058,15 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(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.", + "oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject/properties/file_citation/properties/file_id", + "deprecated": false, "key": "file_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the specific File the citation is from.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject/properties/file_citation/properties/file_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, @@ -39077,15 +39079,15 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) file_path > (property) file_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the file that was generated.", + "oasRef": "#/components/schemas/MessageContentTextAnnotationsFilePathObject/properties/file_path/properties/file_id", + "deprecated": false, "key": "file_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the file that was generated.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/MessageContentTextAnnotationsFilePathObject/properties/file_path/properties/file_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, @@ -39118,7 +39120,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/oneOf/2", - "ident": "UnionMember20", + "docstring": "Occurs when parts of a [Message](/docs/api-reference/messages/object) are being streamed.", + "ident": "ThreadMessageDelta", "type": { "kind": "HttpTypeObject", "members": [ @@ -39130,7 +39133,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "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", @@ -39139,20 +39141,20 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 20 > (property) data": { "kind": "HttpDeclProperty", - "title": "Message delta object", - "docstring": "Represents a message delta i.e. any changed fields on a message during streaming.\n", + "oasRef": "#/components/schemas/MessageStreamEvent/oneOf/2/properties/data", + "deprecated": false, "key": "data", - "optional": false, - "nullable": false, + "docstring": "Represents a message delta i.e. any changed fields on a message during streaming.\n", + "title": "Message delta object", "type": { "kind": "HttpTypeReference", "ident": "MessageDeltaEvent", "$ref": "(resource) beta.threads.messages > (model) message_delta_event > (schema)" }, - "oasRef": "#/components/schemas/MessageStreamEvent/oneOf/2/properties/data", - "deprecated": false, - "schemaType": "object", + "optional": false, + "nullable": false, "modelImplicit": false, + "schemaType": "object", "modelPath": "(resource) beta.threads.messages > (model) message_delta_event", "childrenParentSchema": "object", "children": [ @@ -39163,21 +39165,21 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 20 > (property) event": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/MessageStreamEvent/oneOf/2/properties/event", + "deprecated": false, "key": "event", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MessageStreamEvent/oneOf/2/properties/event", "types": [ { "kind": "HttpTypeLiteral", "literal": "thread.message.delta" } - ], - "oasRef": "#/components/schemas/MessageStreamEvent/oneOf/2/properties/event" + ] }, - "oasRef": "#/components/schemas/MessageStreamEvent/oneOf/2/properties/event", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -39186,33 +39188,33 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) message_delta_event > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The identifier of the message, which can be referenced in API endpoints.", + "oasRef": "#/components/schemas/MessageDeltaObject/properties/id", + "deprecated": false, "key": "id", - "optional": false, - "nullable": false, + "docstring": "The identifier of the message, which can be referenced in API endpoints.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/MessageDeltaObject/properties/id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.messages > (model) message_delta_event > (schema) > (property) delta": { "kind": "HttpDeclProperty", - "docstring": "The delta containing the fields that have changed on the Message.", + "oasRef": "#/components/schemas/MessageDeltaObject/properties/delta", + "deprecated": false, "key": "delta", - "optional": false, - "nullable": false, + "docstring": "The delta containing the fields that have changed on the Message.", "type": { "kind": "HttpTypeReference", "ident": "MessageDelta", "$ref": "(resource) beta.threads.messages > (model) message_delta > (schema)" }, - "oasRef": "#/components/schemas/MessageDeltaObject/properties/delta", - "deprecated": false, - "schemaType": "object", + "optional": false, + "nullable": false, "modelImplicit": false, + "schemaType": "object", "modelPath": "(resource) beta.threads.messages > (model) message_delta", "childrenParentSchema": "object", "children": [ @@ -39222,22 +39224,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) message_delta_event > (schema) > (property) object": { "kind": "HttpDeclProperty", - "docstring": "The object type, which is always `thread.message.delta`.", + "oasRef": "#/components/schemas/MessageDeltaObject/properties/object", + "deprecated": false, "key": "object", - "optional": false, - "nullable": false, + "docstring": "The object type, which is always `thread.message.delta`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MessageDeltaObject/properties/object", "types": [ { "kind": "HttpTypeLiteral", "literal": "thread.message.delta" } - ], - "oasRef": "#/components/schemas/MessageDeltaObject/properties/object" + ] }, - "oasRef": "#/components/schemas/MessageDeltaObject/properties/object", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -39247,6 +39249,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.messages > (model) message_delta_event > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/MessageDeltaObject", + "docstring": "Represents a message delta i.e. any changed fields on a message during streaming.\n", "ident": "MessageDeltaEvent", "type": { "kind": "HttpTypeObject", @@ -39262,7 +39265,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Represents a message delta i.e. any changed fields on a message during streaming.\n", "childrenParentSchema": "object", "children": [ "(resource) beta.threads.messages > (model) message_delta_event > (schema) > (property) id", @@ -39279,14 +39281,16 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) message_delta > (schema) > (property) content": { "kind": "HttpDeclProperty", - "docstring": "The content of the message in array of text and/or images.", + "oasRef": "#/components/schemas/MessageDeltaObject/properties/delta/properties/content", + "deprecated": false, "key": "content", - "optional": true, - "nullable": false, + "docstring": "The content of the message in array of text and/or images.", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/MessageDeltaObject/properties/delta/properties/content", "elementType": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MessageDeltaObject/properties/delta/properties/content/items", "types": [ { "kind": "HttpTypeReference", @@ -39308,13 +39312,11 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "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" + ] + } }, - "oasRef": "#/components/schemas/MessageDeltaObject/properties/delta/properties/content", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "array", "childrenParentSchema": "union", "children": [ @@ -39326,12 +39328,13 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) message_delta > (schema) > (property) role": { "kind": "HttpDeclProperty", - "docstring": "The entity that produced the message. One of `user` or `assistant`.", + "oasRef": "#/components/schemas/MessageDeltaObject/properties/delta/properties/role", + "deprecated": false, "key": "role", - "optional": true, - "nullable": false, + "docstring": "The entity that produced the message. One of `user` or `assistant`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MessageDeltaObject/properties/delta/properties/role", "types": [ { "kind": "HttpTypeLiteral", @@ -39341,11 +39344,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "assistant" } - ], - "oasRef": "#/components/schemas/MessageDeltaObject/properties/delta/properties/role" + ] }, - "oasRef": "#/components/schemas/MessageDeltaObject/properties/delta/properties/role", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -39356,6 +39358,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.messages > (model) message_delta > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/MessageDeltaObject/properties/delta", + "docstring": "The delta containing the fields that have changed on the Message.", "ident": "MessageDelta", "type": { "kind": "HttpTypeObject", @@ -39368,7 +39371,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "The delta containing the fields that have changed on the Message.", "childrenParentSchema": "object", "children": [ "(resource) beta.threads.messages > (model) message_delta > (schema) > (property) content", @@ -39441,6 +39443,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.messages > (model) image_file_delta_block > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/MessageDeltaContentImageFileObject", + "docstring": "References an image [File](/docs/api-reference/files) in the content of a message.", "ident": "ImageFileDeltaBlock", "type": { "kind": "HttpTypeObject", @@ -39456,7 +39459,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "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", @@ -39467,6 +39469,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.messages > (model) text_delta_block > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/MessageDeltaContentTextObject", + "docstring": "The text content that is part of a message.", "ident": "TextDeltaBlock", "type": { "kind": "HttpTypeObject", @@ -39482,7 +39485,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "The text content that is part of a message.", "childrenParentSchema": "object", "children": [ "(resource) beta.threads.messages > (model) text_delta_block > (schema) > (property) index", @@ -39493,6 +39495,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.messages > (model) refusal_delta_block > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/MessageDeltaContentRefusalObject", + "docstring": "The refusal content that is part of a message.", "ident": "RefusalDeltaBlock", "type": { "kind": "HttpTypeObject", @@ -39508,7 +39511,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "The refusal content that is part of a message.", "childrenParentSchema": "object", "children": [ "(resource) beta.threads.messages > (model) refusal_delta_block > (schema) > (property) index", @@ -39519,6 +39521,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.messages > (model) image_url_delta_block > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/MessageDeltaContentImageUrlObject", + "docstring": "References an image URL in the content of a message.", "ident": "ImageURLDeltaBlock", "type": { "kind": "HttpTypeObject", @@ -39534,7 +39537,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "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", @@ -39558,36 +39560,36 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) image_file_delta_block > (schema) > (property) index": { "kind": "HttpDeclProperty", - "docstring": "The index of the content part in the message.", + "oasRef": "#/components/schemas/MessageDeltaContentImageFileObject/properties/index", + "deprecated": false, "key": "index", - "optional": false, - "nullable": false, + "docstring": "The index of the content part in the message.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/MessageDeltaContentImageFileObject/properties/index", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.threads.messages > (model) image_file_delta_block > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "Always `image_file`.", + "oasRef": "#/components/schemas/MessageDeltaContentImageFileObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "Always `image_file`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MessageDeltaContentImageFileObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "image_file" } - ], - "oasRef": "#/components/schemas/MessageDeltaContentImageFileObject/properties/type" + ] }, - "oasRef": "#/components/schemas/MessageDeltaContentImageFileObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -39596,18 +39598,18 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) image_file_delta_block > (schema) > (property) image_file": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/MessageDeltaContentImageFileObject/properties/image_file", + "deprecated": false, "key": "image_file", - "optional": true, - "nullable": false, "type": { "kind": "HttpTypeReference", "ident": "ImageFileDelta", "$ref": "(resource) beta.threads.messages > (model) image_file_delta > (schema)" }, - "oasRef": "#/components/schemas/MessageDeltaContentImageFileObject/properties/image_file", - "deprecated": false, - "schemaType": "object", + "optional": true, + "nullable": false, "modelImplicit": false, + "schemaType": "object", "modelPath": "(resource) beta.threads.messages > (model) image_file_delta", "childrenParentSchema": "object", "children": [ @@ -39617,36 +39619,36 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) text_delta_block > (schema) > (property) index": { "kind": "HttpDeclProperty", - "docstring": "The index of the content part in the message.", + "oasRef": "#/components/schemas/MessageDeltaContentTextObject/properties/index", + "deprecated": false, "key": "index", - "optional": false, - "nullable": false, + "docstring": "The index of the content part in the message.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/MessageDeltaContentTextObject/properties/index", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.threads.messages > (model) text_delta_block > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "Always `text`.", + "oasRef": "#/components/schemas/MessageDeltaContentTextObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "Always `text`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MessageDeltaContentTextObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "text" } - ], - "oasRef": "#/components/schemas/MessageDeltaContentTextObject/properties/type" + ] }, - "oasRef": "#/components/schemas/MessageDeltaContentTextObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -39655,18 +39657,18 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) text_delta_block > (schema) > (property) text": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/MessageDeltaContentTextObject/properties/text", + "deprecated": false, "key": "text", - "optional": true, - "nullable": false, "type": { "kind": "HttpTypeReference", "ident": "TextDelta", "$ref": "(resource) beta.threads.messages > (model) text_delta > (schema)" }, - "oasRef": "#/components/schemas/MessageDeltaContentTextObject/properties/text", - "deprecated": false, - "schemaType": "object", + "optional": true, + "nullable": false, "modelImplicit": false, + "schemaType": "object", "modelPath": "(resource) beta.threads.messages > (model) text_delta", "childrenParentSchema": "object", "children": [ @@ -39676,36 +39678,36 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) refusal_delta_block > (schema) > (property) index": { "kind": "HttpDeclProperty", - "docstring": "The index of the refusal part in the message.", + "oasRef": "#/components/schemas/MessageDeltaContentRefusalObject/properties/index", + "deprecated": false, "key": "index", - "optional": false, - "nullable": false, + "docstring": "The index of the refusal part in the message.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/MessageDeltaContentRefusalObject/properties/index", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.threads.messages > (model) refusal_delta_block > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "Always `refusal`.", + "oasRef": "#/components/schemas/MessageDeltaContentRefusalObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "Always `refusal`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MessageDeltaContentRefusalObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "refusal" } - ], - "oasRef": "#/components/schemas/MessageDeltaContentRefusalObject/properties/type" + ] }, - "oasRef": "#/components/schemas/MessageDeltaContentRefusalObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -39714,49 +39716,49 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) refusal_delta_block > (schema) > (property) refusal": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/MessageDeltaContentRefusalObject/properties/refusal", + "deprecated": false, "key": "refusal", - "optional": true, - "nullable": false, "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/MessageDeltaContentRefusalObject/properties/refusal", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.messages > (model) image_url_delta_block > (schema) > (property) index": { "kind": "HttpDeclProperty", - "docstring": "The index of the content part in the message.", + "oasRef": "#/components/schemas/MessageDeltaContentImageUrlObject/properties/index", + "deprecated": false, "key": "index", - "optional": false, - "nullable": false, + "docstring": "The index of the content part in the message.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/MessageDeltaContentImageUrlObject/properties/index", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.threads.messages > (model) image_url_delta_block > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "Always `image_url`.", + "oasRef": "#/components/schemas/MessageDeltaContentImageUrlObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "Always `image_url`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MessageDeltaContentImageUrlObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "image_url" } - ], - "oasRef": "#/components/schemas/MessageDeltaContentImageUrlObject/properties/type" + ] }, - "oasRef": "#/components/schemas/MessageDeltaContentImageUrlObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -39765,18 +39767,18 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) image_url_delta_block > (schema) > (property) image_url": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/MessageDeltaContentImageUrlObject/properties/image_url", + "deprecated": false, "key": "image_url", - "optional": true, - "nullable": false, "type": { "kind": "HttpTypeReference", "ident": "ImageURLDelta", "$ref": "(resource) beta.threads.messages > (model) image_url_delta > (schema)" }, - "oasRef": "#/components/schemas/MessageDeltaContentImageUrlObject/properties/image_url", - "deprecated": false, - "schemaType": "object", + "optional": true, + "nullable": false, "modelImplicit": false, + "schemaType": "object", "modelPath": "(resource) beta.threads.messages > (model) image_url_delta", "childrenParentSchema": "object", "children": [ @@ -39793,13 +39795,13 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) image_file_delta > (schema) > (property) detail": { "kind": "HttpDeclProperty", - "docstring": "Specifies the detail level of the image if specified by the user. `low` uses fewer tokens, you can opt in to high resolution using `high`.", + "oasRef": "#/components/schemas/MessageDeltaContentImageFileObject/properties/image_file/properties/detail", + "deprecated": false, "key": "detail", - "optional": true, - "nullable": false, - "default": "auto", + "docstring": "Specifies the detail level of the image if specified by the user. `low` uses fewer tokens, you can opt in to high resolution using `high`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MessageDeltaContentImageFileObject/properties/image_file/properties/detail", "types": [ { "kind": "HttpTypeLiteral", @@ -39813,11 +39815,11 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "high" } - ], - "oasRef": "#/components/schemas/MessageDeltaContentImageFileObject/properties/image_file/properties/detail" + ] }, - "oasRef": "#/components/schemas/MessageDeltaContentImageFileObject/properties/image_file/properties/detail", - "deprecated": false, + "default": "auto", + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -39828,15 +39830,15 @@ 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](/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.", + "oasRef": "#/components/schemas/MessageDeltaContentImageFileObject/properties/image_file/properties/file_id", + "deprecated": false, "key": "file_id", - "optional": true, - "nullable": false, + "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.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/MessageDeltaContentImageFileObject/properties/image_file/properties/file_id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, @@ -39870,13 +39872,15 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) text_delta > (schema) > (property) annotations": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/MessageDeltaContentTextObject/properties/text/properties/annotations", + "deprecated": false, "key": "annotations", - "optional": true, - "nullable": false, "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/MessageDeltaContentTextObject/properties/text/properties/annotations", "elementType": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MessageDeltaContentTextObject/properties/text/properties/annotations/items", "types": [ { "kind": "HttpTypeReference", @@ -39888,13 +39892,11 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "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" + ] + } }, - "oasRef": "#/components/schemas/MessageDeltaContentTextObject/properties/text/properties/annotations", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "array", "childrenParentSchema": "union", "children": [ @@ -39904,15 +39906,15 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) text_delta > (schema) > (property) value": { "kind": "HttpDeclProperty", - "docstring": "The data that makes up the text.", + "oasRef": "#/components/schemas/MessageDeltaContentTextObject/properties/text/properties/value", + "deprecated": false, "key": "value", - "optional": true, - "nullable": false, + "docstring": "The data that makes up the text.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/MessageDeltaContentTextObject/properties/text/properties/value", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, @@ -39953,13 +39955,13 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) image_url_delta > (schema) > (property) detail": { "kind": "HttpDeclProperty", - "docstring": "Specifies the detail level of the image. `low` uses fewer tokens, you can opt in to high resolution using `high`.", + "oasRef": "#/components/schemas/MessageDeltaContentImageUrlObject/properties/image_url/properties/detail", + "deprecated": false, "key": "detail", - "optional": true, - "nullable": false, - "default": "auto", + "docstring": "Specifies the detail level of the image. `low` uses fewer tokens, you can opt in to high resolution using `high`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MessageDeltaContentImageUrlObject/properties/image_url/properties/detail", "types": [ { "kind": "HttpTypeLiteral", @@ -39973,11 +39975,11 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "high" } - ], - "oasRef": "#/components/schemas/MessageDeltaContentImageUrlObject/properties/image_url/properties/detail" + ] }, - "oasRef": "#/components/schemas/MessageDeltaContentImageUrlObject/properties/image_url/properties/detail", - "deprecated": false, + "default": "auto", + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -39988,18 +39990,18 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) image_url_delta > (schema) > (property) url": { "kind": "HttpDeclProperty", - "docstring": "The URL of the image, must be a supported image types: jpeg, jpg, png, gif, webp.", + "oasRef": "#/components/schemas/MessageDeltaContentImageUrlObject/properties/image_url/properties/url", + "deprecated": false, "key": "url", - "optional": true, - "nullable": false, + "docstring": "The URL of the image, must be a supported image types: jpeg, jpg, png, gif, webp.", "type": { "kind": "HttpTypeString" }, "constraints": { "format": "uri" }, - "oasRef": "#/components/schemas/MessageDeltaContentImageUrlObject/properties/image_url/properties/url", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, @@ -40082,6 +40084,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.messages > (model) file_citation_delta_annotation > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/MessageDeltaContentTextAnnotationsFileCitationObject", + "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.", "ident": "FileCitationDeltaAnnotation", "type": { "kind": "HttpTypeObject", @@ -40106,7 +40109,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "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", @@ -40120,6 +40122,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.messages > (model) file_path_delta_annotation > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/MessageDeltaContentTextAnnotationsFilePathObject", + "docstring": "A URL for the file that's generated when the assistant used the `code_interpreter` tool to generate a file.", "ident": "FilePathDeltaAnnotation", "type": { "kind": "HttpTypeObject", @@ -40144,7 +40147,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "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", @@ -40178,36 +40180,36 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) file_citation_delta_annotation > (schema) > (property) index": { "kind": "HttpDeclProperty", - "docstring": "The index of the annotation in the text content part.", + "oasRef": "#/components/schemas/MessageDeltaContentTextAnnotationsFileCitationObject/properties/index", + "deprecated": false, "key": "index", - "optional": false, - "nullable": false, + "docstring": "The index of the annotation in the text content part.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/MessageDeltaContentTextAnnotationsFileCitationObject/properties/index", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.threads.messages > (model) file_citation_delta_annotation > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "Always `file_citation`.", + "oasRef": "#/components/schemas/MessageDeltaContentTextAnnotationsFileCitationObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "Always `file_citation`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MessageDeltaContentTextAnnotationsFileCitationObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "file_citation" } - ], - "oasRef": "#/components/schemas/MessageDeltaContentTextAnnotationsFileCitationObject/properties/type" + ] }, - "oasRef": "#/components/schemas/MessageDeltaContentTextAnnotationsFileCitationObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -40216,25 +40218,25 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) file_citation_delta_annotation > (schema) > (property) end_index": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/MessageDeltaContentTextAnnotationsFileCitationObject/properties/end_index", + "deprecated": false, "key": "end_index", - "optional": true, - "nullable": false, "type": { "kind": "HttpTypeNumber" }, "constraints": { "minimum": 0 }, - "oasRef": "#/components/schemas/MessageDeltaContentTextAnnotationsFileCitationObject/properties/end_index", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.threads.messages > (model) file_citation_delta_annotation > (schema) > (property) file_citation": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/MessageDeltaContentTextAnnotationsFileCitationObject/properties/file_citation", + "deprecated": false, "key": "file_citation", - "optional": true, - "nullable": false, "type": { "kind": "HttpTypeObject", "members": [ @@ -40246,8 +40248,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/MessageDeltaContentTextAnnotationsFileCitationObject/properties/file_citation", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -40257,66 +40259,66 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) file_citation_delta_annotation > (schema) > (property) start_index": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/MessageDeltaContentTextAnnotationsFileCitationObject/properties/start_index", + "deprecated": false, "key": "start_index", - "optional": true, - "nullable": false, "type": { "kind": "HttpTypeNumber" }, "constraints": { "minimum": 0 }, - "oasRef": "#/components/schemas/MessageDeltaContentTextAnnotationsFileCitationObject/properties/start_index", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.threads.messages > (model) file_citation_delta_annotation > (schema) > (property) text": { "kind": "HttpDeclProperty", - "docstring": "The text in the message content that needs to be replaced.", + "oasRef": "#/components/schemas/MessageDeltaContentTextAnnotationsFileCitationObject/properties/text", + "deprecated": false, "key": "text", - "optional": true, - "nullable": false, + "docstring": "The text in the message content that needs to be replaced.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/MessageDeltaContentTextAnnotationsFileCitationObject/properties/text", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(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.", + "oasRef": "#/components/schemas/MessageDeltaContentTextAnnotationsFilePathObject/properties/index", + "deprecated": false, "key": "index", - "optional": false, - "nullable": false, + "docstring": "The index of the annotation in the text content part.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/MessageDeltaContentTextAnnotationsFilePathObject/properties/index", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.threads.messages > (model) file_path_delta_annotation > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "Always `file_path`.", + "oasRef": "#/components/schemas/MessageDeltaContentTextAnnotationsFilePathObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "Always `file_path`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MessageDeltaContentTextAnnotationsFilePathObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "file_path" } - ], - "oasRef": "#/components/schemas/MessageDeltaContentTextAnnotationsFilePathObject/properties/type" + ] }, - "oasRef": "#/components/schemas/MessageDeltaContentTextAnnotationsFilePathObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -40325,25 +40327,25 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) file_path_delta_annotation > (schema) > (property) end_index": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/MessageDeltaContentTextAnnotationsFilePathObject/properties/end_index", + "deprecated": false, "key": "end_index", - "optional": true, - "nullable": false, "type": { "kind": "HttpTypeNumber" }, "constraints": { "minimum": 0 }, - "oasRef": "#/components/schemas/MessageDeltaContentTextAnnotationsFilePathObject/properties/end_index", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.threads.messages > (model) file_path_delta_annotation > (schema) > (property) file_path": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/MessageDeltaContentTextAnnotationsFilePathObject/properties/file_path", + "deprecated": false, "key": "file_path", - "optional": true, - "nullable": false, "type": { "kind": "HttpTypeObject", "members": [ @@ -40352,8 +40354,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/MessageDeltaContentTextAnnotationsFilePathObject/properties/file_path", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -40362,31 +40364,31 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) file_path_delta_annotation > (schema) > (property) start_index": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/MessageDeltaContentTextAnnotationsFilePathObject/properties/start_index", + "deprecated": false, "key": "start_index", - "optional": true, - "nullable": false, "type": { "kind": "HttpTypeNumber" }, "constraints": { "minimum": 0 }, - "oasRef": "#/components/schemas/MessageDeltaContentTextAnnotationsFilePathObject/properties/start_index", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.threads.messages > (model) file_path_delta_annotation > (schema) > (property) text": { "kind": "HttpDeclProperty", - "docstring": "The text in the message content that needs to be replaced.", + "oasRef": "#/components/schemas/MessageDeltaContentTextAnnotationsFilePathObject/properties/text", + "deprecated": false, "key": "text", - "optional": true, - "nullable": false, + "docstring": "The text in the message content that needs to be replaced.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/MessageDeltaContentTextAnnotationsFilePathObject/properties/text", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, @@ -40399,29 +40401,29 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) file_citation_delta_annotation > (schema) > (property) file_citation > (property) file_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the specific File the citation is from.", + "oasRef": "#/components/schemas/MessageDeltaContentTextAnnotationsFileCitationObject/properties/file_citation/properties/file_id", + "deprecated": false, "key": "file_id", - "optional": true, - "nullable": false, + "docstring": "The ID of the specific File the citation is from.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/MessageDeltaContentTextAnnotationsFileCitationObject/properties/file_citation/properties/file_id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.messages > (model) file_citation_delta_annotation > (schema) > (property) file_citation > (property) quote": { "kind": "HttpDeclProperty", - "docstring": "The specific quote in the file.", + "oasRef": "#/components/schemas/MessageDeltaContentTextAnnotationsFileCitationObject/properties/file_citation/properties/quote", + "deprecated": false, "key": "quote", - "optional": true, - "nullable": false, + "docstring": "The specific quote in the file.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/MessageDeltaContentTextAnnotationsFileCitationObject/properties/file_citation/properties/quote", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, @@ -40434,15 +40436,15 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) file_path_delta_annotation > (schema) > (property) file_path > (property) file_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the file that was generated.", + "oasRef": "#/components/schemas/MessageDeltaContentTextAnnotationsFilePathObject/properties/file_path/properties/file_id", + "deprecated": false, "key": "file_id", - "optional": true, - "nullable": false, + "docstring": "The ID of the file that was generated.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/MessageDeltaContentTextAnnotationsFilePathObject/properties/file_path/properties/file_id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] } @@ -40468,7 +40470,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/oneOf/3", - "ident": "UnionMember21", + "docstring": "Occurs when a [message](/docs/api-reference/messages/object) is completed.", + "ident": "ThreadMessageCompleted", "type": { "kind": "HttpTypeObject", "members": [ @@ -40480,7 +40483,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "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", @@ -40489,20 +40491,20 @@ 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](/docs/api-reference/threads).", + "oasRef": "#/components/schemas/MessageStreamEvent/oneOf/3/properties/data", + "deprecated": false, "key": "data", - "optional": false, - "nullable": false, + "docstring": "Represents a message within a [thread](/docs/api-reference/threads).", + "title": "The message object", "type": { "kind": "HttpTypeReference", "ident": "Message", "$ref": "(resource) beta.threads.messages > (model) message > (schema)" }, - "oasRef": "#/components/schemas/MessageStreamEvent/oneOf/3/properties/data", - "deprecated": false, - "schemaType": "object", + "optional": false, + "nullable": false, "modelImplicit": false, + "schemaType": "object", "modelPath": "(resource) beta.threads.messages > (model) message", "childrenParentSchema": "object", "children": [ @@ -40524,21 +40526,21 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 21 > (property) event": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/MessageStreamEvent/oneOf/3/properties/event", + "deprecated": false, "key": "event", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MessageStreamEvent/oneOf/3/properties/event", "types": [ { "kind": "HttpTypeLiteral", "literal": "thread.message.completed" } - ], - "oasRef": "#/components/schemas/MessageStreamEvent/oneOf/3/properties/event" + ] }, - "oasRef": "#/components/schemas/MessageStreamEvent/oneOf/3/properties/event", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -40547,40 +40549,41 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) message > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The identifier, which can be referenced in API endpoints.", + "oasRef": "#/components/schemas/MessageObject/properties/id", + "deprecated": false, "key": "id", - "optional": false, - "nullable": false, + "docstring": "The identifier, which can be referenced in API endpoints.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/MessageObject/properties/id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.messages > (model) message > (schema) > (property) assistant_id": { "kind": "HttpDeclProperty", - "docstring": "If applicable, the ID of the [assistant](/docs/api-reference/assistants) that authored this message.", + "oasRef": "#/components/schemas/MessageObject/properties/assistant_id", + "deprecated": false, "key": "assistant_id", - "optional": false, - "nullable": true, + "docstring": "If applicable, the ID of the [assistant](/docs/api-reference/assistants) that authored this message.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/MessageObject/properties/assistant_id", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "string", "children": [] }, "(resource) beta.threads.messages > (model) message > (schema) > (property) attachments": { "kind": "HttpDeclProperty", - "docstring": "A list of files attached to the message, and the tools they were added to.", + "oasRef": "#/components/schemas/MessageObject/properties/attachments", + "deprecated": false, "key": "attachments", - "optional": false, - "nullable": true, + "docstring": "A list of files attached to the message, and the tools they were added to.", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/MessageObject/properties/attachments", "elementType": { "kind": "HttpTypeObject", "members": [ @@ -40591,11 +40594,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "ident": "tools" } ] + } }, - "oasRef": "#/components/schemas/MessageObject/properties/attachments" - }, - "oasRef": "#/components/schemas/MessageObject/properties/attachments", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "array", "childrenParentSchema": "object", "children": [ @@ -40605,31 +40607,33 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) message > (schema) > (property) completed_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the message was completed.", + "oasRef": "#/components/schemas/MessageObject/properties/completed_at", + "deprecated": false, "key": "completed_at", - "optional": false, - "nullable": true, + "docstring": "The Unix timestamp (in seconds) for when the message was completed.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/MessageObject/properties/completed_at", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.messages > (model) message > (schema) > (property) content": { "kind": "HttpDeclProperty", - "docstring": "The content of the message in array of text and/or images.", + "oasRef": "#/components/schemas/MessageObject/properties/content", + "deprecated": false, "key": "content", - "optional": false, - "nullable": false, + "docstring": "The content of the message in array of text and/or images.", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/MessageObject/properties/content", "elementType": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MessageObject/properties/content/items", "types": [ { "kind": "HttpTypeReference", @@ -40651,13 +40655,11 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "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" + ] + } }, - "oasRef": "#/components/schemas/MessageObject/properties/content", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "array", "childrenParentSchema": "union", "children": [ @@ -40669,44 +40671,44 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) message > (schema) > (property) created_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the message was created.", + "oasRef": "#/components/schemas/MessageObject/properties/created_at", + "deprecated": false, "key": "created_at", - "optional": false, - "nullable": false, + "docstring": "The Unix timestamp (in seconds) for when the message was created.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/MessageObject/properties/created_at", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.threads.messages > (model) message > (schema) > (property) incomplete_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the message was marked as incomplete.", + "oasRef": "#/components/schemas/MessageObject/properties/incomplete_at", + "deprecated": false, "key": "incomplete_at", - "optional": false, - "nullable": true, + "docstring": "The Unix timestamp (in seconds) for when the message was marked as incomplete.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/MessageObject/properties/incomplete_at", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.messages > (model) message > (schema) > (property) incomplete_details": { "kind": "HttpDeclProperty", - "docstring": "On an incomplete message, details about why the message is incomplete.", + "oasRef": "#/components/schemas/MessageObject/properties/incomplete_details", + "deprecated": false, "key": "incomplete_details", - "optional": false, - "nullable": true, + "docstring": "On an incomplete message, details about why the message is incomplete.", "type": { "kind": "HttpTypeObject", "members": [ @@ -40715,8 +40717,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/MessageObject/properties/incomplete_details", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -40725,40 +40727,40 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) message > (schema) > (property) metadata": { "kind": "HttpDeclProperty", - "docstring": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.\n", + "oasRef": "#/components/schemas/MessageObject/properties/metadata", + "deprecated": false, "key": "metadata", - "optional": false, - "nullable": true, + "docstring": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.\n", "type": { "kind": "HttpTypeReference", "ident": "Metadata", "$ref": "(resource) $shared > (model) metadata > (schema)" }, - "oasRef": "#/components/schemas/MessageObject/properties/metadata", - "deprecated": false, - "schemaType": "map", + "optional": false, + "nullable": true, "modelImplicit": false, + "schemaType": "map", "modelPath": "(resource) $shared > (model) metadata", "children": [] }, "(resource) beta.threads.messages > (model) message > (schema) > (property) object": { "kind": "HttpDeclProperty", - "docstring": "The object type, which is always `thread.message`.", + "oasRef": "#/components/schemas/MessageObject/properties/object", + "deprecated": false, "key": "object", - "optional": false, - "nullable": false, + "docstring": "The object type, which is always `thread.message`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MessageObject/properties/object", "types": [ { "kind": "HttpTypeLiteral", "literal": "thread.message" } - ], - "oasRef": "#/components/schemas/MessageObject/properties/object" + ] }, - "oasRef": "#/components/schemas/MessageObject/properties/object", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -40767,12 +40769,13 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) message > (schema) > (property) role": { "kind": "HttpDeclProperty", - "docstring": "The entity that produced the message. One of `user` or `assistant`.", + "oasRef": "#/components/schemas/MessageObject/properties/role", + "deprecated": false, "key": "role", - "optional": false, - "nullable": false, + "docstring": "The entity that produced the message. One of `user` or `assistant`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MessageObject/properties/role", "types": [ { "kind": "HttpTypeLiteral", @@ -40782,11 +40785,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "assistant" } - ], - "oasRef": "#/components/schemas/MessageObject/properties/role" + ] }, - "oasRef": "#/components/schemas/MessageObject/properties/role", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -40796,26 +40798,27 @@ 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](/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.", + "oasRef": "#/components/schemas/MessageObject/properties/run_id", + "deprecated": false, "key": "run_id", - "optional": false, - "nullable": true, + "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.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/MessageObject/properties/run_id", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "string", "children": [] }, "(resource) beta.threads.messages > (model) message > (schema) > (property) status": { "kind": "HttpDeclProperty", - "docstring": "The status of the message, which can be either `in_progress`, `incomplete`, or `completed`.", + "oasRef": "#/components/schemas/MessageObject/properties/status", + "deprecated": false, "key": "status", - "optional": false, - "nullable": false, + "docstring": "The status of the message, which can be either `in_progress`, `incomplete`, or `completed`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MessageObject/properties/status", "types": [ { "kind": "HttpTypeLiteral", @@ -40829,11 +40832,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "completed" } - ], - "oasRef": "#/components/schemas/MessageObject/properties/status" + ] }, - "oasRef": "#/components/schemas/MessageObject/properties/status", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -40844,21 +40846,22 @@ 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](/docs/api-reference/threads) ID that this message belongs to.", + "oasRef": "#/components/schemas/MessageObject/properties/thread_id", + "deprecated": false, "key": "thread_id", - "optional": false, - "nullable": false, + "docstring": "The [thread](/docs/api-reference/threads) ID that this message belongs to.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/MessageObject/properties/thread_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.messages > (model) message > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/MessageObject", + "docstring": "Represents a message within a [thread](/docs/api-reference/threads).", "ident": "Message", "type": { "kind": "HttpTypeObject", @@ -40907,7 +40910,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Represents a message within a [thread](/docs/api-reference/threads).", "childrenParentSchema": "object", "children": [ "(resource) beta.threads.messages > (model) message > (schema) > (property) id", @@ -40935,28 +40937,30 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) message > (schema) > (property) attachments > (items) > (property) file_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the file to attach to the message.", + "oasRef": "#/components/schemas/MessageObject/properties/attachments/anyOf/0/items/properties/file_id", + "deprecated": false, "key": "file_id", - "optional": true, - "nullable": false, + "docstring": "The ID of the file to attach to the message.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/MessageObject/properties/attachments/anyOf/0/items/properties/file_id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.messages > (model) message > (schema) > (property) attachments > (items) > (property) tools": { "kind": "HttpDeclProperty", - "docstring": "The tools to add this file to.", + "oasRef": "#/components/schemas/MessageObject/properties/attachments/anyOf/0/items/properties/tools", + "deprecated": false, "key": "tools", - "optional": true, - "nullable": false, + "docstring": "The tools to add this file to.", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/MessageObject/properties/attachments/anyOf/0/items/properties/tools", "elementType": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MessageObject/properties/attachments/anyOf/0/items/properties/tools/items", "types": [ { "kind": "HttpTypeReference", @@ -40971,13 +40975,11 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] } - ], - "oasRef": "#/components/schemas/MessageObject/properties/attachments/anyOf/0/items/properties/tools/items" - }, - "oasRef": "#/components/schemas/MessageObject/properties/attachments/anyOf/0/items/properties/tools" + ] + } }, - "oasRef": "#/components/schemas/MessageObject/properties/attachments/anyOf/0/items/properties/tools", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "array", "childrenParentSchema": "union", "children": [ @@ -41040,6 +41042,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.messages > (model) image_file_content_block > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/MessageContentImageFileObject", + "docstring": "References an image [File](/docs/api-reference/files) in the content of a message.", "ident": "ImageFileContentBlock", "type": { "kind": "HttpTypeObject", @@ -41052,7 +41055,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "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", @@ -41062,6 +41064,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.messages > (model) image_url_content_block > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/MessageContentImageUrlObject", + "docstring": "References an image URL in the content of a message.", "ident": "ImageURLContentBlock", "type": { "kind": "HttpTypeObject", @@ -41074,7 +41077,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "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", @@ -41084,6 +41086,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.messages > (model) text_content_block > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/MessageContentTextObject", + "docstring": "The text content that is part of a message.", "ident": "TextContentBlock", "type": { "kind": "HttpTypeObject", @@ -41096,7 +41099,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "The text content that is part of a message.", "childrenParentSchema": "object", "children": [ "(resource) beta.threads.messages > (model) text_content_block > (schema) > (property) text", @@ -41106,6 +41108,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.messages > (model) refusal_content_block > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/MessageContentRefusalObject", + "docstring": "The refusal content generated by the assistant.", "ident": "RefusalContentBlock", "type": { "kind": "HttpTypeObject", @@ -41118,7 +41121,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "The refusal content generated by the assistant.", "childrenParentSchema": "object", "children": [ "(resource) beta.threads.messages > (model) refusal_content_block > (schema) > (property) refusal", @@ -41127,12 +41129,13 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) message > (schema) > (property) incomplete_details > (property) reason": { "kind": "HttpDeclProperty", - "docstring": "The reason the message is incomplete.", + "oasRef": "#/components/schemas/MessageObject/properties/incomplete_details/anyOf/0/properties/reason", + "deprecated": false, "key": "reason", - "optional": false, - "nullable": false, + "docstring": "The reason the message is incomplete.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MessageObject/properties/incomplete_details/anyOf/0/properties/reason", "types": [ { "kind": "HttpTypeLiteral", @@ -41154,11 +41157,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "run_failed" } - ], - "oasRef": "#/components/schemas/MessageObject/properties/incomplete_details/anyOf/0/properties/reason" + ] }, - "oasRef": "#/components/schemas/MessageObject/properties/incomplete_details/anyOf/0/properties/reason", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -41172,9 +41174,11 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) $shared > (model) metadata > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/Metadata", + "docstring": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.\n", "ident": "Metadata", "type": { "kind": "HttpTypeReference", + "oasRef": "#/components/schemas/Metadata", "ident": "Record", "typeParameters": [ { @@ -41183,10 +41187,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch { "kind": "HttpTypeString" } - ], - "oasRef": "#/components/schemas/Metadata" + ] }, - "docstring": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.\n", "children": [] }, "(resource) beta.threads.messages > (model) message > (schema) > (property) object > (member) 0": { @@ -41279,18 +41281,18 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) image_file_content_block > (schema) > (property) image_file": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/MessageContentImageFileObject/properties/image_file", + "deprecated": false, "key": "image_file", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeReference", "ident": "ImageFile", "$ref": "(resource) beta.threads.messages > (model) image_file > (schema)" }, - "oasRef": "#/components/schemas/MessageContentImageFileObject/properties/image_file", - "deprecated": false, - "schemaType": "object", + "optional": false, + "nullable": false, "modelImplicit": false, + "schemaType": "object", "modelPath": "(resource) beta.threads.messages > (model) image_file", "childrenParentSchema": "object", "children": [ @@ -41300,22 +41302,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) image_file_content_block > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "Always `image_file`.", + "oasRef": "#/components/schemas/MessageContentImageFileObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "Always `image_file`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MessageContentImageFileObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "image_file" } - ], - "oasRef": "#/components/schemas/MessageContentImageFileObject/properties/type" + ] }, - "oasRef": "#/components/schemas/MessageContentImageFileObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -41324,18 +41326,18 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) image_url_content_block > (schema) > (property) image_url": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/MessageContentImageUrlObject/properties/image_url", + "deprecated": false, "key": "image_url", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeReference", "ident": "ImageURL", "$ref": "(resource) beta.threads.messages > (model) image_url > (schema)" }, - "oasRef": "#/components/schemas/MessageContentImageUrlObject/properties/image_url", - "deprecated": false, - "schemaType": "object", + "optional": false, + "nullable": false, "modelImplicit": false, + "schemaType": "object", "modelPath": "(resource) beta.threads.messages > (model) image_url", "childrenParentSchema": "object", "children": [ @@ -41345,22 +41347,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) image_url_content_block > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the content part.", + "oasRef": "#/components/schemas/MessageContentImageUrlObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the content part.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MessageContentImageUrlObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "image_url" } - ], - "oasRef": "#/components/schemas/MessageContentImageUrlObject/properties/type" + ] }, - "oasRef": "#/components/schemas/MessageContentImageUrlObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -41369,18 +41371,18 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) text_content_block > (schema) > (property) text": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/MessageContentTextObject/properties/text", + "deprecated": false, "key": "text", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeReference", "ident": "Text", "$ref": "(resource) beta.threads.messages > (model) text > (schema)" }, - "oasRef": "#/components/schemas/MessageContentTextObject/properties/text", - "deprecated": false, - "schemaType": "object", + "optional": false, + "nullable": false, "modelImplicit": false, + "schemaType": "object", "modelPath": "(resource) beta.threads.messages > (model) text", "childrenParentSchema": "object", "children": [ @@ -41390,22 +41392,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) text_content_block > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "Always `text`.", + "oasRef": "#/components/schemas/MessageContentTextObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "Always `text`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MessageContentTextObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "text" } - ], - "oasRef": "#/components/schemas/MessageContentTextObject/properties/type" + ] }, - "oasRef": "#/components/schemas/MessageContentTextObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -41414,35 +41416,35 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) refusal_content_block > (schema) > (property) refusal": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/MessageContentRefusalObject/properties/refusal", + "deprecated": false, "key": "refusal", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/MessageContentRefusalObject/properties/refusal", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.messages > (model) refusal_content_block > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "Always `refusal`.", + "oasRef": "#/components/schemas/MessageContentRefusalObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "Always `refusal`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MessageContentRefusalObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "refusal" } - ], - "oasRef": "#/components/schemas/MessageContentRefusalObject/properties/type" + ] }, - "oasRef": "#/components/schemas/MessageContentRefusalObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -41486,22 +41488,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of tool being defined: `code_interpreter`", + "oasRef": "#/components/schemas/AssistantToolsCode/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of tool being defined: `code_interpreter`", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantToolsCode/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "code_interpreter" } - ], - "oasRef": "#/components/schemas/AssistantToolsCode/properties/type" + ] }, - "oasRef": "#/components/schemas/AssistantToolsCode/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -41510,22 +41512,22 @@ 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 > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of tool being defined: `file_search`", + "oasRef": "#/components/schemas/AssistantToolsFileSearchTypeOnly/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of tool being defined: `file_search`", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantToolsFileSearchTypeOnly/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "file_search" } - ], - "oasRef": "#/components/schemas/AssistantToolsFileSearchTypeOnly/properties/type" + ] }, - "oasRef": "#/components/schemas/AssistantToolsFileSearchTypeOnly/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -41534,27 +41536,27 @@ 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](/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.", + "oasRef": "#/components/schemas/MessageContentImageFileObject/properties/image_file/properties/file_id", + "deprecated": false, "key": "file_id", - "optional": false, - "nullable": false, + "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.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/MessageContentImageFileObject/properties/image_file/properties/file_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.messages > (model) image_file > (schema) > (property) detail": { "kind": "HttpDeclProperty", - "docstring": "Specifies the detail level of the image if specified by the user. `low` uses fewer tokens, you can opt in to high resolution using `high`.", + "oasRef": "#/components/schemas/MessageContentImageFileObject/properties/image_file/properties/detail", + "deprecated": false, "key": "detail", - "optional": true, - "nullable": false, - "default": "auto", + "docstring": "Specifies the detail level of the image if specified by the user. `low` uses fewer tokens, you can opt in to high resolution using `high`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MessageContentImageFileObject/properties/image_file/properties/detail", "types": [ { "kind": "HttpTypeLiteral", @@ -41568,11 +41570,11 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "high" } - ], - "oasRef": "#/components/schemas/MessageContentImageFileObject/properties/image_file/properties/detail" + ] }, - "oasRef": "#/components/schemas/MessageContentImageFileObject/properties/image_file/properties/detail", - "deprecated": false, + "default": "auto", + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -41611,30 +41613,30 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) image_url > (schema) > (property) url": { "kind": "HttpDeclProperty", - "docstring": "The external URL of the image, must be a supported image types: jpeg, jpg, png, gif, webp.", + "oasRef": "#/components/schemas/MessageContentImageUrlObject/properties/image_url/properties/url", + "deprecated": false, "key": "url", - "optional": false, - "nullable": false, + "docstring": "The external URL of the image, must be a supported image types: jpeg, jpg, png, gif, webp.", "type": { "kind": "HttpTypeString" }, "constraints": { "format": "uri" }, - "oasRef": "#/components/schemas/MessageContentImageUrlObject/properties/image_url/properties/url", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.messages > (model) image_url > (schema) > (property) detail": { "kind": "HttpDeclProperty", - "docstring": "Specifies the detail level of the image. `low` uses fewer tokens, you can opt in to high resolution using `high`. Default value is `auto`", + "oasRef": "#/components/schemas/MessageContentImageUrlObject/properties/image_url/properties/detail", + "deprecated": false, "key": "detail", - "optional": true, - "nullable": false, - "default": "auto", + "docstring": "Specifies the detail level of the image. `low` uses fewer tokens, you can opt in to high resolution using `high`. Default value is `auto`", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MessageContentImageUrlObject/properties/image_url/properties/detail", "types": [ { "kind": "HttpTypeLiteral", @@ -41648,11 +41650,11 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "high" } - ], - "oasRef": "#/components/schemas/MessageContentImageUrlObject/properties/image_url/properties/detail" + ] }, - "oasRef": "#/components/schemas/MessageContentImageUrlObject/properties/image_url/properties/detail", - "deprecated": false, + "default": "auto", + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -41691,13 +41693,15 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) text > (schema) > (property) annotations": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/MessageContentTextObject/properties/text/properties/annotations", + "deprecated": false, "key": "annotations", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/MessageContentTextObject/properties/text/properties/annotations", "elementType": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MessageContentTextObject/properties/text/properties/annotations/items", "types": [ { "kind": "HttpTypeReference", @@ -41709,13 +41713,11 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "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" + ] + } }, - "oasRef": "#/components/schemas/MessageContentTextObject/properties/text/properties/annotations", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "array", "childrenParentSchema": "union", "children": [ @@ -41725,15 +41727,15 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) text > (schema) > (property) value": { "kind": "HttpDeclProperty", - "docstring": "The data that makes up the text.", + "oasRef": "#/components/schemas/MessageContentTextObject/properties/text/properties/value", + "deprecated": false, "key": "value", - "optional": false, - "nullable": false, + "docstring": "The data that makes up the text.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/MessageContentTextObject/properties/text/properties/value", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, @@ -41863,6 +41865,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.messages > (model) file_citation_annotation > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject", + "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.", "ident": "FileCitationAnnotation", "type": { "kind": "HttpTypeObject", @@ -41884,7 +41887,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "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", @@ -41897,6 +41899,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.messages > (model) file_path_annotation > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/MessageContentTextAnnotationsFilePathObject", + "docstring": "A URL for the file that's generated when the assistant used the `code_interpreter` tool to generate a file.", "ident": "FilePathAnnotation", "type": { "kind": "HttpTypeObject", @@ -41918,7 +41921,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "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", @@ -41930,25 +41932,25 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) end_index": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject/properties/end_index", + "deprecated": false, "key": "end_index", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeNumber" }, "constraints": { "minimum": 0 }, - "oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject/properties/end_index", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) file_citation": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject/properties/file_citation", + "deprecated": false, "key": "file_citation", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeObject", "members": [ @@ -41957,8 +41959,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject/properties/file_citation", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -41967,52 +41969,52 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) start_index": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject/properties/start_index", + "deprecated": false, "key": "start_index", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeNumber" }, "constraints": { "minimum": 0 }, - "oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject/properties/start_index", - "deprecated": false, + "optional": false, + "nullable": 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.", + "oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject/properties/text", + "deprecated": false, "key": "text", - "optional": false, - "nullable": false, + "docstring": "The text in the message content that needs to be replaced.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject/properties/text", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "Always `file_citation`.", + "oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "Always `file_citation`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "file_citation" } - ], - "oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject/properties/type" + ] }, - "oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -42021,25 +42023,25 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) end_index": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/MessageContentTextAnnotationsFilePathObject/properties/end_index", + "deprecated": false, "key": "end_index", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeNumber" }, "constraints": { "minimum": 0 }, - "oasRef": "#/components/schemas/MessageContentTextAnnotationsFilePathObject/properties/end_index", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) file_path": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/MessageContentTextAnnotationsFilePathObject/properties/file_path", + "deprecated": false, "key": "file_path", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeObject", "members": [ @@ -42048,8 +42050,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/MessageContentTextAnnotationsFilePathObject/properties/file_path", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -42058,52 +42060,52 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) start_index": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/MessageContentTextAnnotationsFilePathObject/properties/start_index", + "deprecated": false, "key": "start_index", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeNumber" }, "constraints": { "minimum": 0 }, - "oasRef": "#/components/schemas/MessageContentTextAnnotationsFilePathObject/properties/start_index", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) text": { "kind": "HttpDeclProperty", - "docstring": "The text in the message content that needs to be replaced.", + "oasRef": "#/components/schemas/MessageContentTextAnnotationsFilePathObject/properties/text", + "deprecated": false, "key": "text", - "optional": false, - "nullable": false, + "docstring": "The text in the message content that needs to be replaced.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/MessageContentTextAnnotationsFilePathObject/properties/text", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "Always `file_path`.", + "oasRef": "#/components/schemas/MessageContentTextAnnotationsFilePathObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "Always `file_path`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MessageContentTextAnnotationsFilePathObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "file_path" } - ], - "oasRef": "#/components/schemas/MessageContentTextAnnotationsFilePathObject/properties/type" + ] }, - "oasRef": "#/components/schemas/MessageContentTextAnnotationsFilePathObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -42112,15 +42114,15 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(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.", + "oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject/properties/file_citation/properties/file_id", + "deprecated": false, "key": "file_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the specific File the citation is from.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject/properties/file_citation/properties/file_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, @@ -42133,15 +42135,15 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) file_path > (property) file_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the file that was generated.", + "oasRef": "#/components/schemas/MessageContentTextAnnotationsFilePathObject/properties/file_path/properties/file_id", + "deprecated": false, "key": "file_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the file that was generated.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/MessageContentTextAnnotationsFilePathObject/properties/file_path/properties/file_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, @@ -42174,7 +42176,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/oneOf/4", - "ident": "UnionMember22", + "docstring": "Occurs when a [message](/docs/api-reference/messages/object) ends before it is completed.", + "ident": "ThreadMessageIncomplete", "type": { "kind": "HttpTypeObject", "members": [ @@ -42186,7 +42189,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "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", @@ -42195,20 +42197,20 @@ 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](/docs/api-reference/threads).", + "oasRef": "#/components/schemas/MessageStreamEvent/oneOf/4/properties/data", + "deprecated": false, "key": "data", - "optional": false, - "nullable": false, + "docstring": "Represents a message within a [thread](/docs/api-reference/threads).", + "title": "The message object", "type": { "kind": "HttpTypeReference", "ident": "Message", "$ref": "(resource) beta.threads.messages > (model) message > (schema)" }, - "oasRef": "#/components/schemas/MessageStreamEvent/oneOf/4/properties/data", - "deprecated": false, - "schemaType": "object", + "optional": false, + "nullable": false, "modelImplicit": false, + "schemaType": "object", "modelPath": "(resource) beta.threads.messages > (model) message", "childrenParentSchema": "object", "children": [ @@ -42230,21 +42232,21 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 22 > (property) event": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/MessageStreamEvent/oneOf/4/properties/event", + "deprecated": false, "key": "event", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MessageStreamEvent/oneOf/4/properties/event", "types": [ { "kind": "HttpTypeLiteral", "literal": "thread.message.incomplete" } - ], - "oasRef": "#/components/schemas/MessageStreamEvent/oneOf/4/properties/event" + ] }, - "oasRef": "#/components/schemas/MessageStreamEvent/oneOf/4/properties/event", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -42253,40 +42255,41 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) message > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The identifier, which can be referenced in API endpoints.", + "oasRef": "#/components/schemas/MessageObject/properties/id", + "deprecated": false, "key": "id", - "optional": false, - "nullable": false, + "docstring": "The identifier, which can be referenced in API endpoints.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/MessageObject/properties/id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.messages > (model) message > (schema) > (property) assistant_id": { "kind": "HttpDeclProperty", - "docstring": "If applicable, the ID of the [assistant](/docs/api-reference/assistants) that authored this message.", + "oasRef": "#/components/schemas/MessageObject/properties/assistant_id", + "deprecated": false, "key": "assistant_id", - "optional": false, - "nullable": true, + "docstring": "If applicable, the ID of the [assistant](/docs/api-reference/assistants) that authored this message.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/MessageObject/properties/assistant_id", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "string", "children": [] }, "(resource) beta.threads.messages > (model) message > (schema) > (property) attachments": { "kind": "HttpDeclProperty", - "docstring": "A list of files attached to the message, and the tools they were added to.", + "oasRef": "#/components/schemas/MessageObject/properties/attachments", + "deprecated": false, "key": "attachments", - "optional": false, - "nullable": true, + "docstring": "A list of files attached to the message, and the tools they were added to.", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/MessageObject/properties/attachments", "elementType": { "kind": "HttpTypeObject", "members": [ @@ -42297,11 +42300,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "ident": "tools" } ] + } }, - "oasRef": "#/components/schemas/MessageObject/properties/attachments" - }, - "oasRef": "#/components/schemas/MessageObject/properties/attachments", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "array", "childrenParentSchema": "object", "children": [ @@ -42311,31 +42313,33 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) message > (schema) > (property) completed_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the message was completed.", + "oasRef": "#/components/schemas/MessageObject/properties/completed_at", + "deprecated": false, "key": "completed_at", - "optional": false, - "nullable": true, + "docstring": "The Unix timestamp (in seconds) for when the message was completed.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/MessageObject/properties/completed_at", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.messages > (model) message > (schema) > (property) content": { "kind": "HttpDeclProperty", - "docstring": "The content of the message in array of text and/or images.", + "oasRef": "#/components/schemas/MessageObject/properties/content", + "deprecated": false, "key": "content", - "optional": false, - "nullable": false, + "docstring": "The content of the message in array of text and/or images.", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/MessageObject/properties/content", "elementType": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MessageObject/properties/content/items", "types": [ { "kind": "HttpTypeReference", @@ -42357,13 +42361,11 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "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" + ] + } }, - "oasRef": "#/components/schemas/MessageObject/properties/content", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "array", "childrenParentSchema": "union", "children": [ @@ -42375,44 +42377,44 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) message > (schema) > (property) created_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the message was created.", + "oasRef": "#/components/schemas/MessageObject/properties/created_at", + "deprecated": false, "key": "created_at", - "optional": false, - "nullable": false, + "docstring": "The Unix timestamp (in seconds) for when the message was created.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/MessageObject/properties/created_at", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.threads.messages > (model) message > (schema) > (property) incomplete_at": { "kind": "HttpDeclProperty", - "docstring": "The Unix timestamp (in seconds) for when the message was marked as incomplete.", + "oasRef": "#/components/schemas/MessageObject/properties/incomplete_at", + "deprecated": false, "key": "incomplete_at", - "optional": false, - "nullable": true, + "docstring": "The Unix timestamp (in seconds) for when the message was marked as incomplete.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/MessageObject/properties/incomplete_at", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.threads.messages > (model) message > (schema) > (property) incomplete_details": { "kind": "HttpDeclProperty", - "docstring": "On an incomplete message, details about why the message is incomplete.", + "oasRef": "#/components/schemas/MessageObject/properties/incomplete_details", + "deprecated": false, "key": "incomplete_details", - "optional": false, - "nullable": true, + "docstring": "On an incomplete message, details about why the message is incomplete.", "type": { "kind": "HttpTypeObject", "members": [ @@ -42421,8 +42423,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/MessageObject/properties/incomplete_details", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -42431,40 +42433,40 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) message > (schema) > (property) metadata": { "kind": "HttpDeclProperty", - "docstring": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.\n", + "oasRef": "#/components/schemas/MessageObject/properties/metadata", + "deprecated": false, "key": "metadata", - "optional": false, - "nullable": true, + "docstring": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.\n", "type": { "kind": "HttpTypeReference", "ident": "Metadata", "$ref": "(resource) $shared > (model) metadata > (schema)" }, - "oasRef": "#/components/schemas/MessageObject/properties/metadata", - "deprecated": false, - "schemaType": "map", + "optional": false, + "nullable": true, "modelImplicit": false, + "schemaType": "map", "modelPath": "(resource) $shared > (model) metadata", "children": [] }, "(resource) beta.threads.messages > (model) message > (schema) > (property) object": { "kind": "HttpDeclProperty", - "docstring": "The object type, which is always `thread.message`.", + "oasRef": "#/components/schemas/MessageObject/properties/object", + "deprecated": false, "key": "object", - "optional": false, - "nullable": false, + "docstring": "The object type, which is always `thread.message`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MessageObject/properties/object", "types": [ { "kind": "HttpTypeLiteral", "literal": "thread.message" } - ], - "oasRef": "#/components/schemas/MessageObject/properties/object" + ] }, - "oasRef": "#/components/schemas/MessageObject/properties/object", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -42473,12 +42475,13 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) message > (schema) > (property) role": { "kind": "HttpDeclProperty", - "docstring": "The entity that produced the message. One of `user` or `assistant`.", + "oasRef": "#/components/schemas/MessageObject/properties/role", + "deprecated": false, "key": "role", - "optional": false, - "nullable": false, + "docstring": "The entity that produced the message. One of `user` or `assistant`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MessageObject/properties/role", "types": [ { "kind": "HttpTypeLiteral", @@ -42488,11 +42491,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "assistant" } - ], - "oasRef": "#/components/schemas/MessageObject/properties/role" + ] }, - "oasRef": "#/components/schemas/MessageObject/properties/role", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -42502,26 +42504,27 @@ 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](/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.", + "oasRef": "#/components/schemas/MessageObject/properties/run_id", + "deprecated": false, "key": "run_id", - "optional": false, - "nullable": true, + "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.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/MessageObject/properties/run_id", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "string", "children": [] }, "(resource) beta.threads.messages > (model) message > (schema) > (property) status": { "kind": "HttpDeclProperty", - "docstring": "The status of the message, which can be either `in_progress`, `incomplete`, or `completed`.", + "oasRef": "#/components/schemas/MessageObject/properties/status", + "deprecated": false, "key": "status", - "optional": false, - "nullable": false, + "docstring": "The status of the message, which can be either `in_progress`, `incomplete`, or `completed`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MessageObject/properties/status", "types": [ { "kind": "HttpTypeLiteral", @@ -42535,11 +42538,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "completed" } - ], - "oasRef": "#/components/schemas/MessageObject/properties/status" + ] }, - "oasRef": "#/components/schemas/MessageObject/properties/status", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -42550,21 +42552,22 @@ 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](/docs/api-reference/threads) ID that this message belongs to.", + "oasRef": "#/components/schemas/MessageObject/properties/thread_id", + "deprecated": false, "key": "thread_id", - "optional": false, - "nullable": false, + "docstring": "The [thread](/docs/api-reference/threads) ID that this message belongs to.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/MessageObject/properties/thread_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.messages > (model) message > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/MessageObject", + "docstring": "Represents a message within a [thread](/docs/api-reference/threads).", "ident": "Message", "type": { "kind": "HttpTypeObject", @@ -42613,7 +42616,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Represents a message within a [thread](/docs/api-reference/threads).", "childrenParentSchema": "object", "children": [ "(resource) beta.threads.messages > (model) message > (schema) > (property) id", @@ -42641,28 +42643,30 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) message > (schema) > (property) attachments > (items) > (property) file_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the file to attach to the message.", + "oasRef": "#/components/schemas/MessageObject/properties/attachments/anyOf/0/items/properties/file_id", + "deprecated": false, "key": "file_id", - "optional": true, - "nullable": false, + "docstring": "The ID of the file to attach to the message.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/MessageObject/properties/attachments/anyOf/0/items/properties/file_id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.messages > (model) message > (schema) > (property) attachments > (items) > (property) tools": { "kind": "HttpDeclProperty", - "docstring": "The tools to add this file to.", + "oasRef": "#/components/schemas/MessageObject/properties/attachments/anyOf/0/items/properties/tools", + "deprecated": false, "key": "tools", - "optional": true, - "nullable": false, + "docstring": "The tools to add this file to.", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/MessageObject/properties/attachments/anyOf/0/items/properties/tools", "elementType": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MessageObject/properties/attachments/anyOf/0/items/properties/tools/items", "types": [ { "kind": "HttpTypeReference", @@ -42677,13 +42681,11 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] } - ], - "oasRef": "#/components/schemas/MessageObject/properties/attachments/anyOf/0/items/properties/tools/items" - }, - "oasRef": "#/components/schemas/MessageObject/properties/attachments/anyOf/0/items/properties/tools" + ] + } }, - "oasRef": "#/components/schemas/MessageObject/properties/attachments/anyOf/0/items/properties/tools", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "array", "childrenParentSchema": "union", "children": [ @@ -42746,6 +42748,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.messages > (model) image_file_content_block > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/MessageContentImageFileObject", + "docstring": "References an image [File](/docs/api-reference/files) in the content of a message.", "ident": "ImageFileContentBlock", "type": { "kind": "HttpTypeObject", @@ -42758,7 +42761,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "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", @@ -42768,6 +42770,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.messages > (model) image_url_content_block > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/MessageContentImageUrlObject", + "docstring": "References an image URL in the content of a message.", "ident": "ImageURLContentBlock", "type": { "kind": "HttpTypeObject", @@ -42780,7 +42783,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "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", @@ -42790,6 +42792,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.messages > (model) text_content_block > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/MessageContentTextObject", + "docstring": "The text content that is part of a message.", "ident": "TextContentBlock", "type": { "kind": "HttpTypeObject", @@ -42802,7 +42805,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "The text content that is part of a message.", "childrenParentSchema": "object", "children": [ "(resource) beta.threads.messages > (model) text_content_block > (schema) > (property) text", @@ -42812,6 +42814,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.messages > (model) refusal_content_block > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/MessageContentRefusalObject", + "docstring": "The refusal content generated by the assistant.", "ident": "RefusalContentBlock", "type": { "kind": "HttpTypeObject", @@ -42824,7 +42827,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "The refusal content generated by the assistant.", "childrenParentSchema": "object", "children": [ "(resource) beta.threads.messages > (model) refusal_content_block > (schema) > (property) refusal", @@ -42833,12 +42835,13 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) message > (schema) > (property) incomplete_details > (property) reason": { "kind": "HttpDeclProperty", - "docstring": "The reason the message is incomplete.", + "oasRef": "#/components/schemas/MessageObject/properties/incomplete_details/anyOf/0/properties/reason", + "deprecated": false, "key": "reason", - "optional": false, - "nullable": false, + "docstring": "The reason the message is incomplete.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MessageObject/properties/incomplete_details/anyOf/0/properties/reason", "types": [ { "kind": "HttpTypeLiteral", @@ -42860,11 +42863,10 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "run_failed" } - ], - "oasRef": "#/components/schemas/MessageObject/properties/incomplete_details/anyOf/0/properties/reason" + ] }, - "oasRef": "#/components/schemas/MessageObject/properties/incomplete_details/anyOf/0/properties/reason", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -42878,9 +42880,11 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) $shared > (model) metadata > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/Metadata", + "docstring": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.\n", "ident": "Metadata", "type": { "kind": "HttpTypeReference", + "oasRef": "#/components/schemas/Metadata", "ident": "Record", "typeParameters": [ { @@ -42889,10 +42893,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch { "kind": "HttpTypeString" } - ], - "oasRef": "#/components/schemas/Metadata" + ] }, - "docstring": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.\n", "children": [] }, "(resource) beta.threads.messages > (model) message > (schema) > (property) object > (member) 0": { @@ -42985,18 +42987,18 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) image_file_content_block > (schema) > (property) image_file": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/MessageContentImageFileObject/properties/image_file", + "deprecated": false, "key": "image_file", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeReference", "ident": "ImageFile", "$ref": "(resource) beta.threads.messages > (model) image_file > (schema)" }, - "oasRef": "#/components/schemas/MessageContentImageFileObject/properties/image_file", - "deprecated": false, - "schemaType": "object", + "optional": false, + "nullable": false, "modelImplicit": false, + "schemaType": "object", "modelPath": "(resource) beta.threads.messages > (model) image_file", "childrenParentSchema": "object", "children": [ @@ -43006,22 +43008,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) image_file_content_block > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "Always `image_file`.", + "oasRef": "#/components/schemas/MessageContentImageFileObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "Always `image_file`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MessageContentImageFileObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "image_file" } - ], - "oasRef": "#/components/schemas/MessageContentImageFileObject/properties/type" + ] }, - "oasRef": "#/components/schemas/MessageContentImageFileObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -43030,18 +43032,18 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) image_url_content_block > (schema) > (property) image_url": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/MessageContentImageUrlObject/properties/image_url", + "deprecated": false, "key": "image_url", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeReference", "ident": "ImageURL", "$ref": "(resource) beta.threads.messages > (model) image_url > (schema)" }, - "oasRef": "#/components/schemas/MessageContentImageUrlObject/properties/image_url", - "deprecated": false, - "schemaType": "object", + "optional": false, + "nullable": false, "modelImplicit": false, + "schemaType": "object", "modelPath": "(resource) beta.threads.messages > (model) image_url", "childrenParentSchema": "object", "children": [ @@ -43051,22 +43053,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) image_url_content_block > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the content part.", + "oasRef": "#/components/schemas/MessageContentImageUrlObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the content part.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MessageContentImageUrlObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "image_url" } - ], - "oasRef": "#/components/schemas/MessageContentImageUrlObject/properties/type" + ] }, - "oasRef": "#/components/schemas/MessageContentImageUrlObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -43075,18 +43077,18 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) text_content_block > (schema) > (property) text": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/MessageContentTextObject/properties/text", + "deprecated": false, "key": "text", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeReference", "ident": "Text", "$ref": "(resource) beta.threads.messages > (model) text > (schema)" }, - "oasRef": "#/components/schemas/MessageContentTextObject/properties/text", - "deprecated": false, - "schemaType": "object", + "optional": false, + "nullable": false, "modelImplicit": false, + "schemaType": "object", "modelPath": "(resource) beta.threads.messages > (model) text", "childrenParentSchema": "object", "children": [ @@ -43096,22 +43098,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) text_content_block > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "Always `text`.", + "oasRef": "#/components/schemas/MessageContentTextObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "Always `text`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MessageContentTextObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "text" } - ], - "oasRef": "#/components/schemas/MessageContentTextObject/properties/type" + ] }, - "oasRef": "#/components/schemas/MessageContentTextObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -43120,35 +43122,35 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) refusal_content_block > (schema) > (property) refusal": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/MessageContentRefusalObject/properties/refusal", + "deprecated": false, "key": "refusal", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/MessageContentRefusalObject/properties/refusal", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.messages > (model) refusal_content_block > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "Always `refusal`.", + "oasRef": "#/components/schemas/MessageContentRefusalObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "Always `refusal`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MessageContentRefusalObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "refusal" } - ], - "oasRef": "#/components/schemas/MessageContentRefusalObject/properties/type" + ] }, - "oasRef": "#/components/schemas/MessageContentRefusalObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -43192,22 +43194,22 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of tool being defined: `code_interpreter`", + "oasRef": "#/components/schemas/AssistantToolsCode/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of tool being defined: `code_interpreter`", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantToolsCode/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "code_interpreter" } - ], - "oasRef": "#/components/schemas/AssistantToolsCode/properties/type" + ] }, - "oasRef": "#/components/schemas/AssistantToolsCode/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -43216,22 +43218,22 @@ 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 > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of tool being defined: `file_search`", + "oasRef": "#/components/schemas/AssistantToolsFileSearchTypeOnly/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of tool being defined: `file_search`", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AssistantToolsFileSearchTypeOnly/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "file_search" } - ], - "oasRef": "#/components/schemas/AssistantToolsFileSearchTypeOnly/properties/type" + ] }, - "oasRef": "#/components/schemas/AssistantToolsFileSearchTypeOnly/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -43240,27 +43242,27 @@ 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](/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.", + "oasRef": "#/components/schemas/MessageContentImageFileObject/properties/image_file/properties/file_id", + "deprecated": false, "key": "file_id", - "optional": false, - "nullable": false, + "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.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/MessageContentImageFileObject/properties/image_file/properties/file_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.messages > (model) image_file > (schema) > (property) detail": { "kind": "HttpDeclProperty", - "docstring": "Specifies the detail level of the image if specified by the user. `low` uses fewer tokens, you can opt in to high resolution using `high`.", + "oasRef": "#/components/schemas/MessageContentImageFileObject/properties/image_file/properties/detail", + "deprecated": false, "key": "detail", - "optional": true, - "nullable": false, - "default": "auto", + "docstring": "Specifies the detail level of the image if specified by the user. `low` uses fewer tokens, you can opt in to high resolution using `high`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MessageContentImageFileObject/properties/image_file/properties/detail", "types": [ { "kind": "HttpTypeLiteral", @@ -43274,11 +43276,11 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "high" } - ], - "oasRef": "#/components/schemas/MessageContentImageFileObject/properties/image_file/properties/detail" + ] }, - "oasRef": "#/components/schemas/MessageContentImageFileObject/properties/image_file/properties/detail", - "deprecated": false, + "default": "auto", + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -43317,30 +43319,30 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) image_url > (schema) > (property) url": { "kind": "HttpDeclProperty", - "docstring": "The external URL of the image, must be a supported image types: jpeg, jpg, png, gif, webp.", + "oasRef": "#/components/schemas/MessageContentImageUrlObject/properties/image_url/properties/url", + "deprecated": false, "key": "url", - "optional": false, - "nullable": false, + "docstring": "The external URL of the image, must be a supported image types: jpeg, jpg, png, gif, webp.", "type": { "kind": "HttpTypeString" }, "constraints": { "format": "uri" }, - "oasRef": "#/components/schemas/MessageContentImageUrlObject/properties/image_url/properties/url", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.messages > (model) image_url > (schema) > (property) detail": { "kind": "HttpDeclProperty", - "docstring": "Specifies the detail level of the image. `low` uses fewer tokens, you can opt in to high resolution using `high`. Default value is `auto`", + "oasRef": "#/components/schemas/MessageContentImageUrlObject/properties/image_url/properties/detail", + "deprecated": false, "key": "detail", - "optional": true, - "nullable": false, - "default": "auto", + "docstring": "Specifies the detail level of the image. `low` uses fewer tokens, you can opt in to high resolution using `high`. Default value is `auto`", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MessageContentImageUrlObject/properties/image_url/properties/detail", "types": [ { "kind": "HttpTypeLiteral", @@ -43354,11 +43356,11 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "kind": "HttpTypeLiteral", "literal": "high" } - ], - "oasRef": "#/components/schemas/MessageContentImageUrlObject/properties/image_url/properties/detail" + ] }, - "oasRef": "#/components/schemas/MessageContentImageUrlObject/properties/image_url/properties/detail", - "deprecated": false, + "default": "auto", + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -43397,13 +43399,15 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) text > (schema) > (property) annotations": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/MessageContentTextObject/properties/text/properties/annotations", + "deprecated": false, "key": "annotations", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/MessageContentTextObject/properties/text/properties/annotations", "elementType": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MessageContentTextObject/properties/text/properties/annotations/items", "types": [ { "kind": "HttpTypeReference", @@ -43415,13 +43419,11 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "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" + ] + } }, - "oasRef": "#/components/schemas/MessageContentTextObject/properties/text/properties/annotations", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "array", "childrenParentSchema": "union", "children": [ @@ -43431,15 +43433,15 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) text > (schema) > (property) value": { "kind": "HttpDeclProperty", - "docstring": "The data that makes up the text.", + "oasRef": "#/components/schemas/MessageContentTextObject/properties/text/properties/value", + "deprecated": false, "key": "value", - "optional": false, - "nullable": false, + "docstring": "The data that makes up the text.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/MessageContentTextObject/properties/text/properties/value", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, @@ -43569,6 +43571,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.messages > (model) file_citation_annotation > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject", + "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.", "ident": "FileCitationAnnotation", "type": { "kind": "HttpTypeObject", @@ -43590,7 +43593,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "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", @@ -43603,6 +43605,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.threads.messages > (model) file_path_annotation > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/MessageContentTextAnnotationsFilePathObject", + "docstring": "A URL for the file that's generated when the assistant used the `code_interpreter` tool to generate a file.", "ident": "FilePathAnnotation", "type": { "kind": "HttpTypeObject", @@ -43624,7 +43627,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "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", @@ -43636,25 +43638,25 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) end_index": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject/properties/end_index", + "deprecated": false, "key": "end_index", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeNumber" }, "constraints": { "minimum": 0 }, - "oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject/properties/end_index", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) file_citation": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject/properties/file_citation", + "deprecated": false, "key": "file_citation", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeObject", "members": [ @@ -43663,8 +43665,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject/properties/file_citation", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -43673,52 +43675,52 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) start_index": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject/properties/start_index", + "deprecated": false, "key": "start_index", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeNumber" }, "constraints": { "minimum": 0 }, - "oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject/properties/start_index", - "deprecated": false, + "optional": false, + "nullable": 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.", + "oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject/properties/text", + "deprecated": false, "key": "text", - "optional": false, - "nullable": false, + "docstring": "The text in the message content that needs to be replaced.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject/properties/text", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "Always `file_citation`.", + "oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "Always `file_citation`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "file_citation" } - ], - "oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject/properties/type" + ] }, - "oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -43727,25 +43729,25 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) end_index": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/MessageContentTextAnnotationsFilePathObject/properties/end_index", + "deprecated": false, "key": "end_index", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeNumber" }, "constraints": { "minimum": 0 }, - "oasRef": "#/components/schemas/MessageContentTextAnnotationsFilePathObject/properties/end_index", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) file_path": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/MessageContentTextAnnotationsFilePathObject/properties/file_path", + "deprecated": false, "key": "file_path", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeObject", "members": [ @@ -43754,8 +43756,8 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "oasRef": "#/components/schemas/MessageContentTextAnnotationsFilePathObject/properties/file_path", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -43764,52 +43766,52 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) start_index": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/MessageContentTextAnnotationsFilePathObject/properties/start_index", + "deprecated": false, "key": "start_index", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeNumber" }, "constraints": { "minimum": 0 }, - "oasRef": "#/components/schemas/MessageContentTextAnnotationsFilePathObject/properties/start_index", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) text": { "kind": "HttpDeclProperty", - "docstring": "The text in the message content that needs to be replaced.", + "oasRef": "#/components/schemas/MessageContentTextAnnotationsFilePathObject/properties/text", + "deprecated": false, "key": "text", - "optional": false, - "nullable": false, + "docstring": "The text in the message content that needs to be replaced.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/MessageContentTextAnnotationsFilePathObject/properties/text", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "Always `file_path`.", + "oasRef": "#/components/schemas/MessageContentTextAnnotationsFilePathObject/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "Always `file_path`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MessageContentTextAnnotationsFilePathObject/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "file_path" } - ], - "oasRef": "#/components/schemas/MessageContentTextAnnotationsFilePathObject/properties/type" + ] }, - "oasRef": "#/components/schemas/MessageContentTextAnnotationsFilePathObject/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -43818,15 +43820,15 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(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.", + "oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject/properties/file_citation/properties/file_id", + "deprecated": false, "key": "file_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the specific File the citation is from.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject/properties/file_citation/properties/file_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, @@ -43839,15 +43841,15 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) file_path > (property) file_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the file that was generated.", + "oasRef": "#/components/schemas/MessageContentTextAnnotationsFilePathObject/properties/file_path/properties/file_id", + "deprecated": false, "key": "file_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the file that was generated.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/MessageContentTextAnnotationsFilePathObject/properties/file_path/properties/file_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, @@ -43880,6 +43882,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/oneOf/4", + "docstring": "Occurs when an [error](/docs/guides/error-codes#api-errors) occurs. This can happen due to an internal server error or a timeout.", "ident": "ErrorEvent", "type": { "kind": "HttpTypeObject", @@ -43892,7 +43895,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "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", @@ -43901,18 +43903,18 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 23 > (property) data": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/ErrorEvent/properties/data", + "deprecated": false, "key": "data", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeReference", "ident": "ErrorObject", "$ref": "(resource) $shared > (model) error_object > (schema)" }, - "oasRef": "#/components/schemas/ErrorEvent/properties/data", - "deprecated": false, - "schemaType": "object", + "optional": false, + "nullable": false, "modelImplicit": false, + "schemaType": "object", "modelPath": "(resource) $shared > (model) error_object", "childrenParentSchema": "object", "children": [ @@ -43924,21 +43926,21 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 23 > (property) event": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/ErrorEvent/properties/event", + "deprecated": false, "key": "event", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/ErrorEvent/properties/event", "types": [ { "kind": "HttpTypeLiteral", "literal": "error" } - ], - "oasRef": "#/components/schemas/ErrorEvent/properties/event" + ] }, - "oasRef": "#/components/schemas/ErrorEvent/properties/event", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -43947,53 +43949,53 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) $shared > (model) error_object > (schema) > (property) code": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/Error/properties/code", + "deprecated": false, "key": "code", - "optional": false, - "nullable": true, "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/Error/properties/code", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "string", "children": [] }, "(resource) $shared > (model) error_object > (schema) > (property) message": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/Error/properties/message", + "deprecated": false, "key": "message", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/Error/properties/message", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) $shared > (model) error_object > (schema) > (property) param": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/Error/properties/param", + "deprecated": false, "key": "param", - "optional": false, - "nullable": true, "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/Error/properties/param", - "deprecated": false, + "optional": false, + "nullable": true, "schemaType": "string", "children": [] }, "(resource) $shared > (model) error_object > (schema) > (property) type": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/Error/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/Error/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, @@ -44055,6 +44057,7 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 24": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/AssistantStreamEvent/oneOf/5", + "docstring": "Occurs when a stream ends.", "ident": "DoneEvent", "type": { "kind": "HttpTypeObject", @@ -44067,7 +44070,6 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch } ] }, - "docstring": "Occurs when a stream ends.", "childrenParentSchema": "object", "children": [ "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 24 > (property) data", @@ -44076,21 +44078,21 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 24 > (property) data": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/DoneEvent/properties/data", + "deprecated": false, "key": "data", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/DoneEvent/properties/data", "types": [ { "kind": "HttpTypeLiteral", "literal": "[DONE]" } - ], - "oasRef": "#/components/schemas/DoneEvent/properties/data" + ] }, - "oasRef": "#/components/schemas/DoneEvent/properties/data", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -44099,21 +44101,21 @@ Schema name: `(resource) beta.assistants > (model) assistant_stream_event > (sch }, "(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 24 > (property) event": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/DoneEvent/properties/event", + "deprecated": false, "key": "event", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/DoneEvent/properties/event", "types": [ { "kind": "HttpTypeLiteral", "literal": "done" } - ], - "oasRef": "#/components/schemas/DoneEvent/properties/event" + ] }, - "oasRef": "#/components/schemas/DoneEvent/properties/event", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [