Assistants streaming events
Stream the result of executing a Run or resuming a Run after submitting tool outputs.
You can stream events from the Create Thread and Run,
Create Run, and Submit Tool Outputs
endpoints by passing "stream": true. The response will be a Server-Sent events stream.
Our Node and Python SDKs provide helpful utilities to make streaming easy. Reference the
Assistants API quickstart to learn more.
event
Occurs when a new thread is created.
Schema
Schema name: (resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 0
{
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 0": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/ThreadStreamEvent/oneOf/0",
"ident": "UnionMember0",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "data"
},
{
"ident": "event"
},
{
"ident": "enabled"
}
]
},
"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",
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 0 > (property) event",
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 0 > (property) enabled"
]
},
"(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).",
"key": "data",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeReference",
"ident": "Thread",
"$ref": "(resource) beta.threads > (model) thread > (schema)"
},
"oasRef": "#/components/schemas/ThreadStreamEvent/oneOf/0/properties/data",
"deprecated": false,
"schemaType": "object",
"modelImplicit": false,
"modelPath": "(resource) beta.threads > (model) thread",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads > (model) thread > (schema) > (property) id",
"(resource) beta.threads > (model) thread > (schema) > (property) created_at",
"(resource) beta.threads > (model) thread > (schema) > (property) metadata",
"(resource) beta.threads > (model) thread > (schema) > (property) object",
"(resource) beta.threads > (model) thread > (schema) > (property) tool_resources"
]
},
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 0 > (property) event": {
"kind": "HttpDeclProperty",
"key": "event",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "thread.created"
}
],
"oasRef": "#/components/schemas/ThreadStreamEvent/oneOf/0/properties/event"
},
"oasRef": "#/components/schemas/ThreadStreamEvent/oneOf/0/properties/event",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 0 > (property) event > (member) 0"
]
},
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 0 > (property) enabled": {
"kind": "HttpDeclProperty",
"docstring": "Whether to enable input audio transcription.",
"key": "enabled",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeBoolean"
},
"oasRef": "#/components/schemas/ThreadStreamEvent/oneOf/0/properties/enabled",
"deprecated": false,
"schemaType": "boolean",
"children": []
},
"(resource) beta.threads > (model) thread > (schema) > (property) id": {
"kind": "HttpDeclProperty",
"docstring": "The identifier, which can be referenced in API endpoints.",
"key": "id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/ThreadObject/properties/id",
"deprecated": 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.",
"key": "created_at",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/ThreadObject/properties/created_at",
"deprecated": 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",
"key": "metadata",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeReference",
"ident": "Metadata",
"$ref": "(resource) $shared > (model) metadata > (schema)"
},
"oasRef": "#/components/schemas/ThreadObject/properties/metadata",
"deprecated": false,
"schemaType": "map",
"modelImplicit": false,
"modelPath": "(resource) $shared > (model) metadata",
"children": []
},
"(resource) beta.threads > (model) thread > (schema) > (property) object": {
"kind": "HttpDeclProperty",
"docstring": "The object type, which is always `thread`.",
"key": "object",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "thread"
}
],
"oasRef": "#/components/schemas/ThreadObject/properties/object"
},
"oasRef": "#/components/schemas/ThreadObject/properties/object",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads > (model) thread > (schema) > (property) object > (member) 0"
]
},
"(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",
"key": "tool_resources",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "code_interpreter"
},
{
"ident": "file_search"
}
]
},
"oasRef": "#/components/schemas/ThreadObject/properties/tool_resources",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads > (model) thread > (schema) > (property) tool_resources > (property) code_interpreter",
"(resource) beta.threads > (model) thread > (schema) > (property) tool_resources > (property) file_search"
]
},
"(resource) beta.threads > (model) thread > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/ThreadObject",
"ident": "Thread",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "id"
},
{
"ident": "created_at"
},
{
"ident": "metadata"
},
{
"ident": "object"
},
{
"ident": "tool_resources"
}
]
},
"docstring": "Represents a thread that contains [messages](/docs/api-reference/messages).",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads > (model) thread > (schema) > (property) id",
"(resource) beta.threads > (model) thread > (schema) > (property) created_at",
"(resource) beta.threads > (model) thread > (schema) > (property) metadata",
"(resource) beta.threads > (model) thread > (schema) > (property) object",
"(resource) beta.threads > (model) thread > (schema) > (property) tool_resources"
]
},
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 0 > (property) event > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "thread.created"
}
},
"(resource) $shared > (model) metadata > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/Metadata",
"ident": "Metadata",
"type": {
"kind": "HttpTypeReference",
"ident": "Record",
"typeParameters": [
{
"kind": "HttpTypeString"
},
{
"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": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "thread"
}
},
"(resource) beta.threads > (model) thread > (schema) > (property) tool_resources > (property) code_interpreter": {
"kind": "HttpDeclProperty",
"key": "code_interpreter",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "file_ids"
}
]
},
"oasRef": "#/components/schemas/ThreadObject/properties/tool_resources/anyOf/0/properties/code_interpreter",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads > (model) thread > (schema) > (property) tool_resources > (property) code_interpreter > (property) file_ids"
]
},
"(resource) beta.threads > (model) thread > (schema) > (property) tool_resources > (property) file_search": {
"kind": "HttpDeclProperty",
"key": "file_search",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "vector_store_ids"
}
]
},
"oasRef": "#/components/schemas/ThreadObject/properties/tool_resources/anyOf/0/properties/file_search",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads > (model) thread > (schema) > (property) tool_resources > (property) file_search > (property) vector_store_ids"
]
},
"(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",
"key": "file_ids",
"optional": true,
"nullable": false,
"default": [],
"type": {
"kind": "HttpTypeArray",
"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,
"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",
"key": "vector_store_ids",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeArray",
"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,
"schemaType": "array",
"children": []
}
}
Example
{}
event
Occurs when a new run is created.
Schema
Schema name: (resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 1
{
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 1": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RunStreamEvent/oneOf/0",
"ident": "UnionMember1",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "data"
},
{
"ident": "event"
}
]
},
"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",
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 1 > (property) event"
]
},
"(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).",
"key": "data",
"optional": false,
"nullable": false,
"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",
"modelImplicit": false,
"modelPath": "(resource) beta.threads.runs > (model) run",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) id",
"(resource) beta.threads.runs > (model) run > (schema) > (property) assistant_id",
"(resource) beta.threads.runs > (model) run > (schema) > (property) cancelled_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) completed_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) created_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) expires_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) failed_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) incomplete_details",
"(resource) beta.threads.runs > (model) run > (schema) > (property) instructions",
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error",
"(resource) beta.threads.runs > (model) run > (schema) > (property) max_completion_tokens",
"(resource) beta.threads.runs > (model) run > (schema) > (property) max_prompt_tokens",
"(resource) beta.threads.runs > (model) run > (schema) > (property) metadata",
"(resource) beta.threads.runs > (model) run > (schema) > (property) model",
"(resource) beta.threads.runs > (model) run > (schema) > (property) object",
"(resource) beta.threads.runs > (model) run > (schema) > (property) parallel_tool_calls",
"(resource) beta.threads.runs > (model) run > (schema) > (property) required_action",
"(resource) beta.threads.runs > (model) run > (schema) > (property) response_format",
"(resource) beta.threads.runs > (model) run > (schema) > (property) started_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) status",
"(resource) beta.threads.runs > (model) run > (schema) > (property) thread_id",
"(resource) beta.threads.runs > (model) run > (schema) > (property) tool_choice",
"(resource) beta.threads.runs > (model) run > (schema) > (property) tools",
"(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy",
"(resource) beta.threads.runs > (model) run > (schema) > (property) usage",
"(resource) beta.threads.runs > (model) run > (schema) > (property) temperature",
"(resource) beta.threads.runs > (model) run > (schema) > (property) top_p"
]
},
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 1 > (property) event": {
"kind": "HttpDeclProperty",
"key": "event",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"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,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 1 > (property) event > (member) 0"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) id": {
"kind": "HttpDeclProperty",
"docstring": "The identifier, which can be referenced in API endpoints.",
"key": "id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunObject/properties/id",
"deprecated": 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.",
"key": "assistant_id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunObject/properties/assistant_id",
"deprecated": 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.",
"key": "cancelled_at",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/RunObject/properties/cancelled_at",
"deprecated": false,
"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.",
"key": "completed_at",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/RunObject/properties/completed_at",
"deprecated": false,
"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.",
"key": "created_at",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/RunObject/properties/created_at",
"deprecated": 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.",
"key": "expires_at",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/RunObject/properties/expires_at",
"deprecated": false,
"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.",
"key": "failed_at",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/RunObject/properties/failed_at",
"deprecated": false,
"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.",
"key": "incomplete_details",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "reason"
}
]
},
"oasRef": "#/components/schemas/RunObject/properties/incomplete_details",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) incomplete_details > (property) reason"
]
},
"(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.",
"key": "instructions",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunObject/properties/instructions",
"deprecated": 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.",
"key": "last_error",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "code"
},
{
"ident": "message"
}
]
},
"oasRef": "#/components/schemas/RunObject/properties/last_error",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) code",
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) message"
]
},
"(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",
"key": "max_completion_tokens",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"minimum": 256
},
"oasRef": "#/components/schemas/RunObject/properties/max_completion_tokens",
"deprecated": false,
"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",
"key": "max_prompt_tokens",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"minimum": 256
},
"oasRef": "#/components/schemas/RunObject/properties/max_prompt_tokens",
"deprecated": false,
"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",
"key": "metadata",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeReference",
"ident": "Metadata",
"$ref": "(resource) $shared > (model) metadata > (schema)"
},
"oasRef": "#/components/schemas/RunObject/properties/metadata",
"deprecated": false,
"schemaType": "map",
"modelImplicit": false,
"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.",
"key": "model",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunObject/properties/model",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) object": {
"kind": "HttpDeclProperty",
"docstring": "The object type, which is always `thread.run`.",
"key": "object",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "thread.run"
}
],
"oasRef": "#/components/schemas/RunObject/properties/object"
},
"oasRef": "#/components/schemas/RunObject/properties/object",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) object > (member) 0"
]
},
"(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.",
"key": "parallel_tool_calls",
"optional": false,
"nullable": false,
"default": true,
"type": {
"kind": "HttpTypeBoolean"
},
"oasRef": "#/components/schemas/RunObject/properties/parallel_tool_calls",
"deprecated": 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.",
"key": "required_action",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "submit_tool_outputs"
},
{
"ident": "type"
}
]
},
"oasRef": "#/components/schemas/RunObject/properties/required_action",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) required_action > (property) submit_tool_outputs",
"(resource) beta.threads.runs > (model) run > (schema) > (property) required_action > (property) type"
]
},
"(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",
"key": "response_format",
"optional": false,
"nullable": true,
"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",
"modelImplicit": false,
"modelPath": "(resource) beta.threads > (model) assistant_response_format_option",
"childrenParentSchema": "union",
"children": [
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 0",
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 1",
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 2",
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 3"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) started_at": {
"kind": "HttpDeclProperty",
"docstring": "The Unix timestamp (in seconds) for when the run was started.",
"key": "started_at",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/RunObject/properties/started_at",
"deprecated": false,
"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`.",
"key": "status",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "queued"
},
{
"kind": "HttpTypeLiteral",
"literal": "in_progress"
},
{
"kind": "HttpTypeLiteral",
"literal": "requires_action"
},
{
"kind": "HttpTypeLiteral",
"literal": "cancelling"
},
{
"kind": "HttpTypeLiteral",
"literal": "cancelled"
},
{
"kind": "HttpTypeLiteral",
"literal": "failed"
},
{
"kind": "HttpTypeLiteral",
"literal": "completed"
},
{
"kind": "HttpTypeLiteral",
"literal": "incomplete"
},
{
"kind": "HttpTypeLiteral",
"literal": "expired"
}
],
"oasRef": "#/components/schemas/RunObject/properties/status"
},
"oasRef": "#/components/schemas/RunObject/properties/status",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 0",
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 1",
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 2",
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 3",
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 4",
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 5",
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 6",
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 7",
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 8"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) thread_id": {
"kind": "HttpDeclProperty",
"docstring": "The ID of the [thread](/docs/api-reference/threads) that was executed on as a part of this run.",
"key": "thread_id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunObject/properties/thread_id",
"deprecated": 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",
"key": "tool_choice",
"optional": false,
"nullable": true,
"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",
"modelImplicit": false,
"modelPath": "(resource) beta.threads > (model) assistant_tool_choice_option",
"childrenParentSchema": "union",
"children": [
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0",
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 1"
]
},
"(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.",
"key": "tools",
"optional": false,
"nullable": false,
"default": [],
"type": {
"kind": "HttpTypeArray",
"elementType": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeReference",
"ident": "CodeInterpreterTool",
"$ref": "(resource) beta.assistants > (model) code_interpreter_tool > (schema)"
},
{
"kind": "HttpTypeReference",
"ident": "FileSearchTool",
"$ref": "(resource) beta.assistants > (model) file_search_tool > (schema)"
},
{
"kind": "HttpTypeReference",
"ident": "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,
"schemaType": "array",
"childrenParentSchema": "union",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 0",
"(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 1",
"(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 2"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy": {
"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.",
"key": "truncation_strategy",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
},
{
"ident": "last_messages"
}
]
},
"oasRef": "#/components/schemas/RunObject/properties/truncation_strategy",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) type",
"(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) last_messages"
]
},
"(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.).",
"key": "usage",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "completion_tokens"
},
{
"ident": "prompt_tokens"
},
{
"ident": "total_tokens"
}
]
},
"oasRef": "#/components/schemas/RunObject/properties/usage",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) usage > (property) completion_tokens",
"(resource) beta.threads.runs > (model) run > (schema) > (property) usage > (property) prompt_tokens",
"(resource) beta.threads.runs > (model) run > (schema) > (property) usage > (property) total_tokens"
]
},
"(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.",
"key": "temperature",
"optional": true,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"oasRef": "#/components/schemas/RunObject/properties/temperature",
"deprecated": false,
"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.",
"key": "top_p",
"optional": true,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"oasRef": "#/components/schemas/RunObject/properties/top_p",
"deprecated": false,
"schemaType": "number",
"children": []
},
"(resource) beta.threads.runs > (model) run > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RunObject",
"ident": "Run",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "id"
},
{
"ident": "assistant_id"
},
{
"ident": "cancelled_at"
},
{
"ident": "completed_at"
},
{
"ident": "created_at"
},
{
"ident": "expires_at"
},
{
"ident": "failed_at"
},
{
"ident": "incomplete_details"
},
{
"ident": "instructions"
},
{
"ident": "last_error"
},
{
"ident": "max_completion_tokens"
},
{
"ident": "max_prompt_tokens"
},
{
"ident": "metadata"
},
{
"ident": "model"
},
{
"ident": "object"
},
{
"ident": "parallel_tool_calls"
},
{
"ident": "required_action"
},
{
"ident": "response_format"
},
{
"ident": "started_at"
},
{
"ident": "status"
},
{
"ident": "thread_id"
},
{
"ident": "tool_choice"
},
{
"ident": "tools"
},
{
"ident": "truncation_strategy"
},
{
"ident": "usage"
},
{
"ident": "temperature"
},
{
"ident": "top_p"
}
]
},
"docstring": "Represents an execution run on a [thread](/docs/api-reference/threads).",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) id",
"(resource) beta.threads.runs > (model) run > (schema) > (property) assistant_id",
"(resource) beta.threads.runs > (model) run > (schema) > (property) cancelled_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) completed_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) created_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) expires_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) failed_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) incomplete_details",
"(resource) beta.threads.runs > (model) run > (schema) > (property) instructions",
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error",
"(resource) beta.threads.runs > (model) run > (schema) > (property) max_completion_tokens",
"(resource) beta.threads.runs > (model) run > (schema) > (property) max_prompt_tokens",
"(resource) beta.threads.runs > (model) run > (schema) > (property) metadata",
"(resource) beta.threads.runs > (model) run > (schema) > (property) model",
"(resource) beta.threads.runs > (model) run > (schema) > (property) object",
"(resource) beta.threads.runs > (model) run > (schema) > (property) parallel_tool_calls",
"(resource) beta.threads.runs > (model) run > (schema) > (property) required_action",
"(resource) beta.threads.runs > (model) run > (schema) > (property) response_format",
"(resource) beta.threads.runs > (model) run > (schema) > (property) started_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) status",
"(resource) beta.threads.runs > (model) run > (schema) > (property) thread_id",
"(resource) beta.threads.runs > (model) run > (schema) > (property) tool_choice",
"(resource) beta.threads.runs > (model) run > (schema) > (property) tools",
"(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy",
"(resource) beta.threads.runs > (model) run > (schema) > (property) usage",
"(resource) beta.threads.runs > (model) run > (schema) > (property) temperature",
"(resource) beta.threads.runs > (model) run > (schema) > (property) top_p"
]
},
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 1 > (property) event > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "thread.run.created"
}
},
"(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.",
"key": "reason",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "max_completion_tokens"
},
{
"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,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) incomplete_details > (property) reason > (member) 0",
"(resource) beta.threads.runs > (model) run > (schema) > (property) incomplete_details > (property) reason > (member) 1"
]
},
"(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`.",
"key": "code",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "server_error"
},
{
"kind": "HttpTypeLiteral",
"literal": "rate_limit_exceeded"
},
{
"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,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) code > (member) 0",
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) code > (member) 1",
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) code > (member) 2"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) message": {
"kind": "HttpDeclProperty",
"docstring": "A human-readable description of the error.",
"key": "message",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunObject/properties/last_error/properties/message",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) $shared > (model) metadata > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/Metadata",
"ident": "Metadata",
"type": {
"kind": "HttpTypeReference",
"ident": "Record",
"typeParameters": [
{
"kind": "HttpTypeString"
},
{
"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": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "thread.run"
}
},
"(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.",
"key": "submit_tool_outputs",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "tool_calls"
}
]
},
"oasRef": "#/components/schemas/RunObject/properties/required_action/properties/submit_tool_outputs",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) required_action > (property) submit_tool_outputs > (property) tool_calls"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) required_action > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "For now, this is always `submit_tool_outputs`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"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,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) required_action > (property) type > (member) 0"
]
},
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 0": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/oneOf/0",
"ident": "UnionMember0",
"type": {
"kind": "HttpTypeUnion",
"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"
]
},
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "ResponseFormatText",
"$ref": "(resource) $shared > (model) response_format_text > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) $shared > (model) response_format_text > (schema) > (property) type"
]
},
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "ResponseFormatJSONObject",
"$ref": "(resource) $shared > (model) response_format_json_object > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) $shared > (model) response_format_json_object > (schema) > (property) type"
]
},
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 3": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "ResponseFormatJSONSchema",
"$ref": "(resource) $shared > (model) response_format_json_schema > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema",
"(resource) $shared > (model) response_format_json_schema > (schema) > (property) type"
]
},
"(resource) beta.threads > (model) assistant_response_format_option > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/AssistantsApiResponseFormatOption",
"ident": "AssistantResponseFormatOption",
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "auto"
}
],
"oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/oneOf/0"
},
{
"kind": "HttpTypeReference",
"ident": "ResponseFormatText",
"$ref": "(resource) $shared > (model) response_format_text > (schema)"
},
{
"kind": "HttpTypeReference",
"ident": "ResponseFormatJSONObject",
"$ref": "(resource) $shared > (model) response_format_json_object > (schema)"
},
{
"kind": "HttpTypeReference",
"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",
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 1",
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 2",
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 3"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "queued"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "in_progress"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "requires_action"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 3": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "cancelling"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 4": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "cancelled"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 5": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "failed"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 6": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "completed"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 7": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "incomplete"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 8": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "expired"
}
},
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/AssistantsApiToolChoiceOption/oneOf/0",
"ident": "UnionMember0",
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "none"
},
{
"kind": "HttpTypeLiteral",
"literal": "auto"
},
{
"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",
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0 > (member) 1",
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0 > (member) 2"
]
},
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "AssistantToolChoice",
"$ref": "(resource) beta.threads > (model) assistant_tool_choice > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) type",
"(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) function"
]
},
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/AssistantsApiToolChoiceOption",
"ident": "AssistantToolChoiceOption",
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "none"
},
{
"kind": "HttpTypeLiteral",
"literal": "auto"
},
{
"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",
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 1"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "CodeInterpreterTool",
"$ref": "(resource) beta.assistants > (model) code_interpreter_tool > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "FileSearchTool",
"$ref": "(resource) beta.assistants > (model) file_search_tool > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) type",
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "FunctionTool",
"$ref": "(resource) beta.assistants > (model) function_tool > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.assistants > (model) function_tool > (schema) > (property) function",
"(resource) beta.assistants > (model) function_tool > (schema) > (property) type"
]
},
"(resource) beta.assistants > (model) code_interpreter_tool > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/AssistantToolsCode",
"ident": "CodeInterpreterTool",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type"
]
},
"(resource) beta.assistants > (model) file_search_tool > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/AssistantToolsFileSearch",
"ident": "FileSearchTool",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
},
{
"ident": "file_search"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) type",
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search"
]
},
"(resource) beta.assistants > (model) function_tool > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/AssistantToolsFunction",
"ident": "FunctionTool",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "function"
},
{
"ident": "type"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.assistants > (model) function_tool > (schema) > (property) function",
"(resource) beta.assistants > (model) function_tool > (schema) > (property) type"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) type": {
"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`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "auto"
},
{
"kind": "HttpTypeLiteral",
"literal": "last_messages"
}
],
"oasRef": "#/components/schemas/TruncationObject/properties/type"
},
"oasRef": "#/components/schemas/TruncationObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) type > (member) 0",
"(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) type > (member) 1"
]
},
"(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.",
"key": "last_messages",
"optional": true,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"minimum": 1
},
"oasRef": "#/components/schemas/TruncationObject/properties/last_messages",
"deprecated": false,
"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.",
"key": "completion_tokens",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"oasRef": "#/components/schemas/RunCompletionUsage/anyOf/0/properties/completion_tokens",
"deprecated": 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.",
"key": "prompt_tokens",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"oasRef": "#/components/schemas/RunCompletionUsage/anyOf/0/properties/prompt_tokens",
"deprecated": 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).",
"key": "total_tokens",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"oasRef": "#/components/schemas/RunCompletionUsage/anyOf/0/properties/total_tokens",
"deprecated": false,
"schemaType": "integer",
"children": []
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) incomplete_details > (property) reason > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "max_completion_tokens"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) incomplete_details > (property) reason > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "max_prompt_tokens"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) code > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "server_error"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) code > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "rate_limit_exceeded"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) code > (member) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "invalid_prompt"
}
},
"(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.",
"key": "tool_calls",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeArray",
"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,
"schemaType": "array",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) id",
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) function",
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) type"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) required_action > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "submit_tool_outputs"
}
},
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 0 > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "auto"
}
},
"(resource) $shared > (model) response_format_text > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The type of response format being defined. Always `text`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "text"
}
],
"oasRef": "#/components/schemas/ResponseFormatText/properties/type"
},
"oasRef": "#/components/schemas/ResponseFormatText/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) $shared > (model) response_format_text > (schema) > (property) type > (member) 0"
]
},
"(resource) $shared > (model) response_format_text > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/ResponseFormatText",
"ident": "ResponseFormatText",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
}
]
},
"docstring": "Default response format. Used to generate text responses.\n",
"childrenParentSchema": "object",
"children": [
"(resource) $shared > (model) response_format_text > (schema) > (property) type"
]
},
"(resource) $shared > (model) response_format_json_object > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The type of response format being defined. Always `json_object`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "json_object"
}
],
"oasRef": "#/components/schemas/ResponseFormatJsonObject/properties/type"
},
"oasRef": "#/components/schemas/ResponseFormatJsonObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) $shared > (model) response_format_json_object > (schema) > (property) type > (member) 0"
]
},
"(resource) $shared > (model) response_format_json_object > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/ResponseFormatJsonObject",
"ident": "ResponseFormatJSONObject",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
}
]
},
"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"
]
},
"(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",
"key": "json_schema",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "name"
},
{
"ident": "description"
},
{
"ident": "schema"
},
{
"ident": "strict"
}
]
},
"oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema > (property) name",
"(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema > (property) description",
"(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema > (property) schema",
"(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema > (property) strict"
]
},
"(resource) $shared > (model) response_format_json_schema > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The type of response format being defined. Always `json_schema`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "json_schema"
}
],
"oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/type"
},
"oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) $shared > (model) response_format_json_schema > (schema) > (property) type > (member) 0"
]
},
"(resource) $shared > (model) response_format_json_schema > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/ResponseFormatJsonSchema",
"ident": "ResponseFormatJSONSchema",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "json_schema"
},
{
"ident": "type"
}
]
},
"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",
"(resource) $shared > (model) response_format_json_schema > (schema) > (property) type"
]
},
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0 > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "none"
}
},
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0 > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "auto"
}
},
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0 > (member) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "required"
}
},
"(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",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "function"
},
{
"kind": "HttpTypeLiteral",
"literal": "code_interpreter"
},
{
"kind": "HttpTypeLiteral",
"literal": "file_search"
}
],
"oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/type"
},
"oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) type > (member) 0",
"(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) type > (member) 1",
"(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) type > (member) 2"
]
},
"(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) function": {
"kind": "HttpDeclProperty",
"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",
"modelImplicit": false,
"modelPath": "(resource) beta.threads > (model) assistant_tool_choice_function",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads > (model) assistant_tool_choice_function > (schema) > (property) name"
]
},
"(resource) beta.threads > (model) assistant_tool_choice > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/AssistantsNamedToolChoice",
"ident": "AssistantToolChoice",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
},
{
"ident": "function"
}
]
},
"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",
"(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) function"
]
},
"(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The type of tool being defined: `code_interpreter`",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "code_interpreter"
}
],
"oasRef": "#/components/schemas/AssistantToolsCode/properties/type"
},
"oasRef": "#/components/schemas/AssistantToolsCode/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type > (member) 0"
]
},
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The type of tool being defined: `file_search`",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "file_search"
}
],
"oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/type"
},
"oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) type > (member) 0"
]
},
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search": {
"kind": "HttpDeclProperty",
"docstring": "Overrides for the file search tool.",
"key": "file_search",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "max_num_results"
},
{
"ident": "ranking_options"
}
]
},
"oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/file_search",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) max_num_results",
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options"
]
},
"(resource) beta.assistants > (model) function_tool > (schema) > (property) function": {
"kind": "HttpDeclProperty",
"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",
"modelImplicit": false,
"modelPath": "(resource) $shared > (model) function_definition",
"childrenParentSchema": "object",
"children": [
"(resource) $shared > (model) function_definition > (schema) > (property) name",
"(resource) $shared > (model) function_definition > (schema) > (property) description",
"(resource) $shared > (model) function_definition > (schema) > (property) parameters",
"(resource) $shared > (model) function_definition > (schema) > (property) strict"
]
},
"(resource) beta.assistants > (model) function_tool > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The type of tool being defined: `function`",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "function"
}
],
"oasRef": "#/components/schemas/AssistantToolsFunction/properties/type"
},
"oasRef": "#/components/schemas/AssistantToolsFunction/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.assistants > (model) function_tool > (schema) > (property) type > (member) 0"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "auto"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) type > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "last_messages"
}
},
"(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.",
"key": "id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunToolCallObject/properties/id",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) function": {
"kind": "HttpDeclProperty",
"docstring": "The function definition.",
"key": "function",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "arguments"
},
{
"ident": "name"
}
]
},
"oasRef": "#/components/schemas/RunToolCallObject/properties/function",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) function > (property) arguments",
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) function > (property) name"
]
},
"(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`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "function"
}
],
"oasRef": "#/components/schemas/RunToolCallObject/properties/type"
},
"oasRef": "#/components/schemas/RunToolCallObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) type > (member) 0"
]
},
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RunToolCallObject",
"ident": "RequiredActionFunctionToolCall",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "id"
},
{
"ident": "function"
},
{
"ident": "type"
}
]
},
"docstring": "Tool call objects",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) id",
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) function",
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) type"
]
},
"(resource) $shared > (model) response_format_text > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "text"
}
},
"(resource) $shared > (model) response_format_json_object > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "json_object"
}
},
"(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",
"key": "name",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/name",
"deprecated": 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",
"key": "description",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/description",
"deprecated": 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",
"key": "schema",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeReference",
"ident": "Record",
"typeParameters": [
{
"kind": "HttpTypeString"
},
{
"kind": "HttpTypeUnknown"
}
],
"oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/schema"
},
"oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/schema",
"deprecated": 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",
"key": "strict",
"optional": true,
"nullable": true,
"default": false,
"type": {
"kind": "HttpTypeBoolean"
},
"oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/strict",
"deprecated": false,
"schemaType": "boolean",
"children": []
},
"(resource) $shared > (model) response_format_json_schema > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "json_schema"
}
},
"(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "function"
}
},
"(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) type > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "code_interpreter"
}
},
"(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) type > (member) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "file_search"
}
},
"(resource) beta.threads > (model) assistant_tool_choice_function > (schema) > (property) name": {
"kind": "HttpDeclProperty",
"docstring": "The name of the function to call.",
"key": "name",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/function/properties/name",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads > (model) assistant_tool_choice_function > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/function",
"ident": "AssistantToolChoiceFunction",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "name"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads > (model) assistant_tool_choice_function > (schema) > (property) name"
]
},
"(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "code_interpreter"
}
},
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "file_search"
}
},
"(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",
"key": "max_num_results",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"minimum": 1,
"maximum": 50
},
"oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/file_search/properties/max_num_results",
"deprecated": 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",
"key": "ranking_options",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "score_threshold"
},
{
"ident": "ranker"
}
]
},
"oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/file_search/properties/ranking_options",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options > (property) score_threshold",
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options > (property) ranker"
]
},
"(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.",
"key": "name",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/FunctionObject/properties/name",
"deprecated": 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.",
"key": "description",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/FunctionObject/properties/description",
"deprecated": 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.",
"key": "parameters",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeReference",
"ident": "FunctionParameters",
"$ref": "(resource) $shared > (model) function_parameters > (schema)"
},
"oasRef": "#/components/schemas/FunctionObject/properties/parameters",
"deprecated": false,
"schemaType": "map",
"modelImplicit": false,
"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).",
"key": "strict",
"optional": true,
"nullable": true,
"default": false,
"type": {
"kind": "HttpTypeBoolean"
},
"oasRef": "#/components/schemas/FunctionObject/properties/strict",
"deprecated": false,
"schemaType": "boolean",
"children": []
},
"(resource) $shared > (model) function_definition > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/FunctionObject",
"ident": "FunctionDefinition",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "name"
},
{
"ident": "description"
},
{
"ident": "parameters"
},
{
"ident": "strict"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) $shared > (model) function_definition > (schema) > (property) name",
"(resource) $shared > (model) function_definition > (schema) > (property) description",
"(resource) $shared > (model) function_definition > (schema) > (property) parameters",
"(resource) $shared > (model) function_definition > (schema) > (property) strict"
]
},
"(resource) beta.assistants > (model) function_tool > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "function"
}
},
"(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.",
"key": "arguments",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunToolCallObject/properties/function/properties/arguments",
"deprecated": 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.",
"key": "name",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunToolCallObject/properties/function/properties/name",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "function"
}
},
"(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.",
"key": "score_threshold",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"minimum": 0,
"maximum": 1
},
"oasRef": "#/components/schemas/FileSearchRankingOptions/properties/score_threshold",
"deprecated": 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.",
"key": "ranker",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "auto"
},
{
"kind": "HttpTypeLiteral",
"literal": "default_2024_08_21"
}
],
"oasRef": "#/components/schemas/FileSearchRankingOptions/properties/ranker"
},
"oasRef": "#/components/schemas/FileSearchRankingOptions/properties/ranker",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options > (property) ranker > (member) 0",
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options > (property) ranker > (member) 1"
]
},
"(resource) $shared > (model) function_parameters > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/FunctionParameters",
"ident": "FunctionParameters",
"type": {
"kind": "HttpTypeReference",
"ident": "Record",
"typeParameters": [
{
"kind": "HttpTypeString"
},
{
"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": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "auto"
}
},
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options > (property) ranker > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "default_2024_08_21"
}
}
}
Example
{}
event
Occurs when a run moves to a queued status.
Schema
Schema name: (resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 2
{
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 2": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RunStreamEvent/oneOf/1",
"ident": "UnionMember2",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "data"
},
{
"ident": "event"
}
]
},
"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",
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 2 > (property) event"
]
},
"(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).",
"key": "data",
"optional": false,
"nullable": false,
"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",
"modelImplicit": false,
"modelPath": "(resource) beta.threads.runs > (model) run",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) id",
"(resource) beta.threads.runs > (model) run > (schema) > (property) assistant_id",
"(resource) beta.threads.runs > (model) run > (schema) > (property) cancelled_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) completed_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) created_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) expires_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) failed_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) incomplete_details",
"(resource) beta.threads.runs > (model) run > (schema) > (property) instructions",
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error",
"(resource) beta.threads.runs > (model) run > (schema) > (property) max_completion_tokens",
"(resource) beta.threads.runs > (model) run > (schema) > (property) max_prompt_tokens",
"(resource) beta.threads.runs > (model) run > (schema) > (property) metadata",
"(resource) beta.threads.runs > (model) run > (schema) > (property) model",
"(resource) beta.threads.runs > (model) run > (schema) > (property) object",
"(resource) beta.threads.runs > (model) run > (schema) > (property) parallel_tool_calls",
"(resource) beta.threads.runs > (model) run > (schema) > (property) required_action",
"(resource) beta.threads.runs > (model) run > (schema) > (property) response_format",
"(resource) beta.threads.runs > (model) run > (schema) > (property) started_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) status",
"(resource) beta.threads.runs > (model) run > (schema) > (property) thread_id",
"(resource) beta.threads.runs > (model) run > (schema) > (property) tool_choice",
"(resource) beta.threads.runs > (model) run > (schema) > (property) tools",
"(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy",
"(resource) beta.threads.runs > (model) run > (schema) > (property) usage",
"(resource) beta.threads.runs > (model) run > (schema) > (property) temperature",
"(resource) beta.threads.runs > (model) run > (schema) > (property) top_p"
]
},
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 2 > (property) event": {
"kind": "HttpDeclProperty",
"key": "event",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"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,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 2 > (property) event > (member) 0"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) id": {
"kind": "HttpDeclProperty",
"docstring": "The identifier, which can be referenced in API endpoints.",
"key": "id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunObject/properties/id",
"deprecated": 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.",
"key": "assistant_id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunObject/properties/assistant_id",
"deprecated": 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.",
"key": "cancelled_at",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/RunObject/properties/cancelled_at",
"deprecated": false,
"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.",
"key": "completed_at",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/RunObject/properties/completed_at",
"deprecated": false,
"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.",
"key": "created_at",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/RunObject/properties/created_at",
"deprecated": 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.",
"key": "expires_at",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/RunObject/properties/expires_at",
"deprecated": false,
"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.",
"key": "failed_at",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/RunObject/properties/failed_at",
"deprecated": false,
"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.",
"key": "incomplete_details",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "reason"
}
]
},
"oasRef": "#/components/schemas/RunObject/properties/incomplete_details",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) incomplete_details > (property) reason"
]
},
"(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.",
"key": "instructions",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunObject/properties/instructions",
"deprecated": 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.",
"key": "last_error",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "code"
},
{
"ident": "message"
}
]
},
"oasRef": "#/components/schemas/RunObject/properties/last_error",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) code",
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) message"
]
},
"(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",
"key": "max_completion_tokens",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"minimum": 256
},
"oasRef": "#/components/schemas/RunObject/properties/max_completion_tokens",
"deprecated": false,
"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",
"key": "max_prompt_tokens",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"minimum": 256
},
"oasRef": "#/components/schemas/RunObject/properties/max_prompt_tokens",
"deprecated": false,
"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",
"key": "metadata",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeReference",
"ident": "Metadata",
"$ref": "(resource) $shared > (model) metadata > (schema)"
},
"oasRef": "#/components/schemas/RunObject/properties/metadata",
"deprecated": false,
"schemaType": "map",
"modelImplicit": false,
"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.",
"key": "model",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunObject/properties/model",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) object": {
"kind": "HttpDeclProperty",
"docstring": "The object type, which is always `thread.run`.",
"key": "object",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "thread.run"
}
],
"oasRef": "#/components/schemas/RunObject/properties/object"
},
"oasRef": "#/components/schemas/RunObject/properties/object",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) object > (member) 0"
]
},
"(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.",
"key": "parallel_tool_calls",
"optional": false,
"nullable": false,
"default": true,
"type": {
"kind": "HttpTypeBoolean"
},
"oasRef": "#/components/schemas/RunObject/properties/parallel_tool_calls",
"deprecated": 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.",
"key": "required_action",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "submit_tool_outputs"
},
{
"ident": "type"
}
]
},
"oasRef": "#/components/schemas/RunObject/properties/required_action",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) required_action > (property) submit_tool_outputs",
"(resource) beta.threads.runs > (model) run > (schema) > (property) required_action > (property) type"
]
},
"(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",
"key": "response_format",
"optional": false,
"nullable": true,
"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",
"modelImplicit": false,
"modelPath": "(resource) beta.threads > (model) assistant_response_format_option",
"childrenParentSchema": "union",
"children": [
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 0",
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 1",
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 2",
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 3"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) started_at": {
"kind": "HttpDeclProperty",
"docstring": "The Unix timestamp (in seconds) for when the run was started.",
"key": "started_at",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/RunObject/properties/started_at",
"deprecated": false,
"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`.",
"key": "status",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "queued"
},
{
"kind": "HttpTypeLiteral",
"literal": "in_progress"
},
{
"kind": "HttpTypeLiteral",
"literal": "requires_action"
},
{
"kind": "HttpTypeLiteral",
"literal": "cancelling"
},
{
"kind": "HttpTypeLiteral",
"literal": "cancelled"
},
{
"kind": "HttpTypeLiteral",
"literal": "failed"
},
{
"kind": "HttpTypeLiteral",
"literal": "completed"
},
{
"kind": "HttpTypeLiteral",
"literal": "incomplete"
},
{
"kind": "HttpTypeLiteral",
"literal": "expired"
}
],
"oasRef": "#/components/schemas/RunObject/properties/status"
},
"oasRef": "#/components/schemas/RunObject/properties/status",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 0",
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 1",
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 2",
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 3",
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 4",
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 5",
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 6",
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 7",
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 8"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) thread_id": {
"kind": "HttpDeclProperty",
"docstring": "The ID of the [thread](/docs/api-reference/threads) that was executed on as a part of this run.",
"key": "thread_id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunObject/properties/thread_id",
"deprecated": 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",
"key": "tool_choice",
"optional": false,
"nullable": true,
"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",
"modelImplicit": false,
"modelPath": "(resource) beta.threads > (model) assistant_tool_choice_option",
"childrenParentSchema": "union",
"children": [
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0",
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 1"
]
},
"(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.",
"key": "tools",
"optional": false,
"nullable": false,
"default": [],
"type": {
"kind": "HttpTypeArray",
"elementType": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeReference",
"ident": "CodeInterpreterTool",
"$ref": "(resource) beta.assistants > (model) code_interpreter_tool > (schema)"
},
{
"kind": "HttpTypeReference",
"ident": "FileSearchTool",
"$ref": "(resource) beta.assistants > (model) file_search_tool > (schema)"
},
{
"kind": "HttpTypeReference",
"ident": "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,
"schemaType": "array",
"childrenParentSchema": "union",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 0",
"(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 1",
"(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 2"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy": {
"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.",
"key": "truncation_strategy",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
},
{
"ident": "last_messages"
}
]
},
"oasRef": "#/components/schemas/RunObject/properties/truncation_strategy",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) type",
"(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) last_messages"
]
},
"(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.).",
"key": "usage",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "completion_tokens"
},
{
"ident": "prompt_tokens"
},
{
"ident": "total_tokens"
}
]
},
"oasRef": "#/components/schemas/RunObject/properties/usage",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) usage > (property) completion_tokens",
"(resource) beta.threads.runs > (model) run > (schema) > (property) usage > (property) prompt_tokens",
"(resource) beta.threads.runs > (model) run > (schema) > (property) usage > (property) total_tokens"
]
},
"(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.",
"key": "temperature",
"optional": true,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"oasRef": "#/components/schemas/RunObject/properties/temperature",
"deprecated": false,
"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.",
"key": "top_p",
"optional": true,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"oasRef": "#/components/schemas/RunObject/properties/top_p",
"deprecated": false,
"schemaType": "number",
"children": []
},
"(resource) beta.threads.runs > (model) run > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RunObject",
"ident": "Run",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "id"
},
{
"ident": "assistant_id"
},
{
"ident": "cancelled_at"
},
{
"ident": "completed_at"
},
{
"ident": "created_at"
},
{
"ident": "expires_at"
},
{
"ident": "failed_at"
},
{
"ident": "incomplete_details"
},
{
"ident": "instructions"
},
{
"ident": "last_error"
},
{
"ident": "max_completion_tokens"
},
{
"ident": "max_prompt_tokens"
},
{
"ident": "metadata"
},
{
"ident": "model"
},
{
"ident": "object"
},
{
"ident": "parallel_tool_calls"
},
{
"ident": "required_action"
},
{
"ident": "response_format"
},
{
"ident": "started_at"
},
{
"ident": "status"
},
{
"ident": "thread_id"
},
{
"ident": "tool_choice"
},
{
"ident": "tools"
},
{
"ident": "truncation_strategy"
},
{
"ident": "usage"
},
{
"ident": "temperature"
},
{
"ident": "top_p"
}
]
},
"docstring": "Represents an execution run on a [thread](/docs/api-reference/threads).",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) id",
"(resource) beta.threads.runs > (model) run > (schema) > (property) assistant_id",
"(resource) beta.threads.runs > (model) run > (schema) > (property) cancelled_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) completed_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) created_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) expires_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) failed_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) incomplete_details",
"(resource) beta.threads.runs > (model) run > (schema) > (property) instructions",
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error",
"(resource) beta.threads.runs > (model) run > (schema) > (property) max_completion_tokens",
"(resource) beta.threads.runs > (model) run > (schema) > (property) max_prompt_tokens",
"(resource) beta.threads.runs > (model) run > (schema) > (property) metadata",
"(resource) beta.threads.runs > (model) run > (schema) > (property) model",
"(resource) beta.threads.runs > (model) run > (schema) > (property) object",
"(resource) beta.threads.runs > (model) run > (schema) > (property) parallel_tool_calls",
"(resource) beta.threads.runs > (model) run > (schema) > (property) required_action",
"(resource) beta.threads.runs > (model) run > (schema) > (property) response_format",
"(resource) beta.threads.runs > (model) run > (schema) > (property) started_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) status",
"(resource) beta.threads.runs > (model) run > (schema) > (property) thread_id",
"(resource) beta.threads.runs > (model) run > (schema) > (property) tool_choice",
"(resource) beta.threads.runs > (model) run > (schema) > (property) tools",
"(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy",
"(resource) beta.threads.runs > (model) run > (schema) > (property) usage",
"(resource) beta.threads.runs > (model) run > (schema) > (property) temperature",
"(resource) beta.threads.runs > (model) run > (schema) > (property) top_p"
]
},
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 2 > (property) event > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "thread.run.queued"
}
},
"(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.",
"key": "reason",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "max_completion_tokens"
},
{
"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,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) incomplete_details > (property) reason > (member) 0",
"(resource) beta.threads.runs > (model) run > (schema) > (property) incomplete_details > (property) reason > (member) 1"
]
},
"(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`.",
"key": "code",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "server_error"
},
{
"kind": "HttpTypeLiteral",
"literal": "rate_limit_exceeded"
},
{
"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,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) code > (member) 0",
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) code > (member) 1",
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) code > (member) 2"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) message": {
"kind": "HttpDeclProperty",
"docstring": "A human-readable description of the error.",
"key": "message",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunObject/properties/last_error/properties/message",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) $shared > (model) metadata > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/Metadata",
"ident": "Metadata",
"type": {
"kind": "HttpTypeReference",
"ident": "Record",
"typeParameters": [
{
"kind": "HttpTypeString"
},
{
"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": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "thread.run"
}
},
"(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.",
"key": "submit_tool_outputs",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "tool_calls"
}
]
},
"oasRef": "#/components/schemas/RunObject/properties/required_action/properties/submit_tool_outputs",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) required_action > (property) submit_tool_outputs > (property) tool_calls"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) required_action > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "For now, this is always `submit_tool_outputs`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"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,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) required_action > (property) type > (member) 0"
]
},
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 0": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/oneOf/0",
"ident": "UnionMember0",
"type": {
"kind": "HttpTypeUnion",
"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"
]
},
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "ResponseFormatText",
"$ref": "(resource) $shared > (model) response_format_text > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) $shared > (model) response_format_text > (schema) > (property) type"
]
},
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "ResponseFormatJSONObject",
"$ref": "(resource) $shared > (model) response_format_json_object > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) $shared > (model) response_format_json_object > (schema) > (property) type"
]
},
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 3": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "ResponseFormatJSONSchema",
"$ref": "(resource) $shared > (model) response_format_json_schema > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema",
"(resource) $shared > (model) response_format_json_schema > (schema) > (property) type"
]
},
"(resource) beta.threads > (model) assistant_response_format_option > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/AssistantsApiResponseFormatOption",
"ident": "AssistantResponseFormatOption",
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "auto"
}
],
"oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/oneOf/0"
},
{
"kind": "HttpTypeReference",
"ident": "ResponseFormatText",
"$ref": "(resource) $shared > (model) response_format_text > (schema)"
},
{
"kind": "HttpTypeReference",
"ident": "ResponseFormatJSONObject",
"$ref": "(resource) $shared > (model) response_format_json_object > (schema)"
},
{
"kind": "HttpTypeReference",
"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",
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 1",
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 2",
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 3"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "queued"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "in_progress"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "requires_action"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 3": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "cancelling"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 4": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "cancelled"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 5": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "failed"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 6": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "completed"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 7": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "incomplete"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 8": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "expired"
}
},
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/AssistantsApiToolChoiceOption/oneOf/0",
"ident": "UnionMember0",
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "none"
},
{
"kind": "HttpTypeLiteral",
"literal": "auto"
},
{
"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",
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0 > (member) 1",
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0 > (member) 2"
]
},
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "AssistantToolChoice",
"$ref": "(resource) beta.threads > (model) assistant_tool_choice > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) type",
"(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) function"
]
},
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/AssistantsApiToolChoiceOption",
"ident": "AssistantToolChoiceOption",
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "none"
},
{
"kind": "HttpTypeLiteral",
"literal": "auto"
},
{
"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",
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 1"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "CodeInterpreterTool",
"$ref": "(resource) beta.assistants > (model) code_interpreter_tool > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "FileSearchTool",
"$ref": "(resource) beta.assistants > (model) file_search_tool > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) type",
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "FunctionTool",
"$ref": "(resource) beta.assistants > (model) function_tool > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.assistants > (model) function_tool > (schema) > (property) function",
"(resource) beta.assistants > (model) function_tool > (schema) > (property) type"
]
},
"(resource) beta.assistants > (model) code_interpreter_tool > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/AssistantToolsCode",
"ident": "CodeInterpreterTool",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type"
]
},
"(resource) beta.assistants > (model) file_search_tool > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/AssistantToolsFileSearch",
"ident": "FileSearchTool",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
},
{
"ident": "file_search"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) type",
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search"
]
},
"(resource) beta.assistants > (model) function_tool > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/AssistantToolsFunction",
"ident": "FunctionTool",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "function"
},
{
"ident": "type"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.assistants > (model) function_tool > (schema) > (property) function",
"(resource) beta.assistants > (model) function_tool > (schema) > (property) type"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) type": {
"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`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "auto"
},
{
"kind": "HttpTypeLiteral",
"literal": "last_messages"
}
],
"oasRef": "#/components/schemas/TruncationObject/properties/type"
},
"oasRef": "#/components/schemas/TruncationObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) type > (member) 0",
"(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) type > (member) 1"
]
},
"(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.",
"key": "last_messages",
"optional": true,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"minimum": 1
},
"oasRef": "#/components/schemas/TruncationObject/properties/last_messages",
"deprecated": false,
"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.",
"key": "completion_tokens",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"oasRef": "#/components/schemas/RunCompletionUsage/anyOf/0/properties/completion_tokens",
"deprecated": 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.",
"key": "prompt_tokens",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"oasRef": "#/components/schemas/RunCompletionUsage/anyOf/0/properties/prompt_tokens",
"deprecated": 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).",
"key": "total_tokens",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"oasRef": "#/components/schemas/RunCompletionUsage/anyOf/0/properties/total_tokens",
"deprecated": false,
"schemaType": "integer",
"children": []
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) incomplete_details > (property) reason > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "max_completion_tokens"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) incomplete_details > (property) reason > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "max_prompt_tokens"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) code > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "server_error"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) code > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "rate_limit_exceeded"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) code > (member) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "invalid_prompt"
}
},
"(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.",
"key": "tool_calls",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeArray",
"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,
"schemaType": "array",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) id",
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) function",
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) type"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) required_action > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "submit_tool_outputs"
}
},
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 0 > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "auto"
}
},
"(resource) $shared > (model) response_format_text > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The type of response format being defined. Always `text`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "text"
}
],
"oasRef": "#/components/schemas/ResponseFormatText/properties/type"
},
"oasRef": "#/components/schemas/ResponseFormatText/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) $shared > (model) response_format_text > (schema) > (property) type > (member) 0"
]
},
"(resource) $shared > (model) response_format_text > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/ResponseFormatText",
"ident": "ResponseFormatText",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
}
]
},
"docstring": "Default response format. Used to generate text responses.\n",
"childrenParentSchema": "object",
"children": [
"(resource) $shared > (model) response_format_text > (schema) > (property) type"
]
},
"(resource) $shared > (model) response_format_json_object > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The type of response format being defined. Always `json_object`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "json_object"
}
],
"oasRef": "#/components/schemas/ResponseFormatJsonObject/properties/type"
},
"oasRef": "#/components/schemas/ResponseFormatJsonObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) $shared > (model) response_format_json_object > (schema) > (property) type > (member) 0"
]
},
"(resource) $shared > (model) response_format_json_object > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/ResponseFormatJsonObject",
"ident": "ResponseFormatJSONObject",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
}
]
},
"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"
]
},
"(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",
"key": "json_schema",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "name"
},
{
"ident": "description"
},
{
"ident": "schema"
},
{
"ident": "strict"
}
]
},
"oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema > (property) name",
"(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema > (property) description",
"(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema > (property) schema",
"(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema > (property) strict"
]
},
"(resource) $shared > (model) response_format_json_schema > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The type of response format being defined. Always `json_schema`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "json_schema"
}
],
"oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/type"
},
"oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) $shared > (model) response_format_json_schema > (schema) > (property) type > (member) 0"
]
},
"(resource) $shared > (model) response_format_json_schema > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/ResponseFormatJsonSchema",
"ident": "ResponseFormatJSONSchema",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "json_schema"
},
{
"ident": "type"
}
]
},
"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",
"(resource) $shared > (model) response_format_json_schema > (schema) > (property) type"
]
},
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0 > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "none"
}
},
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0 > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "auto"
}
},
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0 > (member) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "required"
}
},
"(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",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "function"
},
{
"kind": "HttpTypeLiteral",
"literal": "code_interpreter"
},
{
"kind": "HttpTypeLiteral",
"literal": "file_search"
}
],
"oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/type"
},
"oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) type > (member) 0",
"(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) type > (member) 1",
"(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) type > (member) 2"
]
},
"(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) function": {
"kind": "HttpDeclProperty",
"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",
"modelImplicit": false,
"modelPath": "(resource) beta.threads > (model) assistant_tool_choice_function",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads > (model) assistant_tool_choice_function > (schema) > (property) name"
]
},
"(resource) beta.threads > (model) assistant_tool_choice > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/AssistantsNamedToolChoice",
"ident": "AssistantToolChoice",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
},
{
"ident": "function"
}
]
},
"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",
"(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) function"
]
},
"(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The type of tool being defined: `code_interpreter`",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "code_interpreter"
}
],
"oasRef": "#/components/schemas/AssistantToolsCode/properties/type"
},
"oasRef": "#/components/schemas/AssistantToolsCode/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type > (member) 0"
]
},
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The type of tool being defined: `file_search`",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "file_search"
}
],
"oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/type"
},
"oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) type > (member) 0"
]
},
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search": {
"kind": "HttpDeclProperty",
"docstring": "Overrides for the file search tool.",
"key": "file_search",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "max_num_results"
},
{
"ident": "ranking_options"
}
]
},
"oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/file_search",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) max_num_results",
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options"
]
},
"(resource) beta.assistants > (model) function_tool > (schema) > (property) function": {
"kind": "HttpDeclProperty",
"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",
"modelImplicit": false,
"modelPath": "(resource) $shared > (model) function_definition",
"childrenParentSchema": "object",
"children": [
"(resource) $shared > (model) function_definition > (schema) > (property) name",
"(resource) $shared > (model) function_definition > (schema) > (property) description",
"(resource) $shared > (model) function_definition > (schema) > (property) parameters",
"(resource) $shared > (model) function_definition > (schema) > (property) strict"
]
},
"(resource) beta.assistants > (model) function_tool > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The type of tool being defined: `function`",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "function"
}
],
"oasRef": "#/components/schemas/AssistantToolsFunction/properties/type"
},
"oasRef": "#/components/schemas/AssistantToolsFunction/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.assistants > (model) function_tool > (schema) > (property) type > (member) 0"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "auto"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) type > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "last_messages"
}
},
"(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.",
"key": "id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunToolCallObject/properties/id",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) function": {
"kind": "HttpDeclProperty",
"docstring": "The function definition.",
"key": "function",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "arguments"
},
{
"ident": "name"
}
]
},
"oasRef": "#/components/schemas/RunToolCallObject/properties/function",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) function > (property) arguments",
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) function > (property) name"
]
},
"(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`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "function"
}
],
"oasRef": "#/components/schemas/RunToolCallObject/properties/type"
},
"oasRef": "#/components/schemas/RunToolCallObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) type > (member) 0"
]
},
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RunToolCallObject",
"ident": "RequiredActionFunctionToolCall",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "id"
},
{
"ident": "function"
},
{
"ident": "type"
}
]
},
"docstring": "Tool call objects",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) id",
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) function",
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) type"
]
},
"(resource) $shared > (model) response_format_text > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "text"
}
},
"(resource) $shared > (model) response_format_json_object > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "json_object"
}
},
"(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",
"key": "name",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/name",
"deprecated": 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",
"key": "description",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/description",
"deprecated": 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",
"key": "schema",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeReference",
"ident": "Record",
"typeParameters": [
{
"kind": "HttpTypeString"
},
{
"kind": "HttpTypeUnknown"
}
],
"oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/schema"
},
"oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/schema",
"deprecated": 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",
"key": "strict",
"optional": true,
"nullable": true,
"default": false,
"type": {
"kind": "HttpTypeBoolean"
},
"oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/strict",
"deprecated": false,
"schemaType": "boolean",
"children": []
},
"(resource) $shared > (model) response_format_json_schema > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "json_schema"
}
},
"(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "function"
}
},
"(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) type > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "code_interpreter"
}
},
"(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) type > (member) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "file_search"
}
},
"(resource) beta.threads > (model) assistant_tool_choice_function > (schema) > (property) name": {
"kind": "HttpDeclProperty",
"docstring": "The name of the function to call.",
"key": "name",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/function/properties/name",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads > (model) assistant_tool_choice_function > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/function",
"ident": "AssistantToolChoiceFunction",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "name"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads > (model) assistant_tool_choice_function > (schema) > (property) name"
]
},
"(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "code_interpreter"
}
},
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "file_search"
}
},
"(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",
"key": "max_num_results",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"minimum": 1,
"maximum": 50
},
"oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/file_search/properties/max_num_results",
"deprecated": 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",
"key": "ranking_options",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "score_threshold"
},
{
"ident": "ranker"
}
]
},
"oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/file_search/properties/ranking_options",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options > (property) score_threshold",
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options > (property) ranker"
]
},
"(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.",
"key": "name",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/FunctionObject/properties/name",
"deprecated": 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.",
"key": "description",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/FunctionObject/properties/description",
"deprecated": 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.",
"key": "parameters",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeReference",
"ident": "FunctionParameters",
"$ref": "(resource) $shared > (model) function_parameters > (schema)"
},
"oasRef": "#/components/schemas/FunctionObject/properties/parameters",
"deprecated": false,
"schemaType": "map",
"modelImplicit": false,
"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).",
"key": "strict",
"optional": true,
"nullable": true,
"default": false,
"type": {
"kind": "HttpTypeBoolean"
},
"oasRef": "#/components/schemas/FunctionObject/properties/strict",
"deprecated": false,
"schemaType": "boolean",
"children": []
},
"(resource) $shared > (model) function_definition > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/FunctionObject",
"ident": "FunctionDefinition",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "name"
},
{
"ident": "description"
},
{
"ident": "parameters"
},
{
"ident": "strict"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) $shared > (model) function_definition > (schema) > (property) name",
"(resource) $shared > (model) function_definition > (schema) > (property) description",
"(resource) $shared > (model) function_definition > (schema) > (property) parameters",
"(resource) $shared > (model) function_definition > (schema) > (property) strict"
]
},
"(resource) beta.assistants > (model) function_tool > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "function"
}
},
"(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.",
"key": "arguments",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunToolCallObject/properties/function/properties/arguments",
"deprecated": 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.",
"key": "name",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunToolCallObject/properties/function/properties/name",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "function"
}
},
"(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.",
"key": "score_threshold",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"minimum": 0,
"maximum": 1
},
"oasRef": "#/components/schemas/FileSearchRankingOptions/properties/score_threshold",
"deprecated": 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.",
"key": "ranker",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "auto"
},
{
"kind": "HttpTypeLiteral",
"literal": "default_2024_08_21"
}
],
"oasRef": "#/components/schemas/FileSearchRankingOptions/properties/ranker"
},
"oasRef": "#/components/schemas/FileSearchRankingOptions/properties/ranker",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options > (property) ranker > (member) 0",
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options > (property) ranker > (member) 1"
]
},
"(resource) $shared > (model) function_parameters > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/FunctionParameters",
"ident": "FunctionParameters",
"type": {
"kind": "HttpTypeReference",
"ident": "Record",
"typeParameters": [
{
"kind": "HttpTypeString"
},
{
"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": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "auto"
}
},
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options > (property) ranker > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "default_2024_08_21"
}
}
}
Example
{}
event
Occurs when a run moves to an in_progress status.
Schema
Schema name: (resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 3
{
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 3": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RunStreamEvent/oneOf/2",
"ident": "UnionMember3",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "data"
},
{
"ident": "event"
}
]
},
"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",
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 3 > (property) event"
]
},
"(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).",
"key": "data",
"optional": false,
"nullable": false,
"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",
"modelImplicit": false,
"modelPath": "(resource) beta.threads.runs > (model) run",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) id",
"(resource) beta.threads.runs > (model) run > (schema) > (property) assistant_id",
"(resource) beta.threads.runs > (model) run > (schema) > (property) cancelled_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) completed_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) created_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) expires_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) failed_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) incomplete_details",
"(resource) beta.threads.runs > (model) run > (schema) > (property) instructions",
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error",
"(resource) beta.threads.runs > (model) run > (schema) > (property) max_completion_tokens",
"(resource) beta.threads.runs > (model) run > (schema) > (property) max_prompt_tokens",
"(resource) beta.threads.runs > (model) run > (schema) > (property) metadata",
"(resource) beta.threads.runs > (model) run > (schema) > (property) model",
"(resource) beta.threads.runs > (model) run > (schema) > (property) object",
"(resource) beta.threads.runs > (model) run > (schema) > (property) parallel_tool_calls",
"(resource) beta.threads.runs > (model) run > (schema) > (property) required_action",
"(resource) beta.threads.runs > (model) run > (schema) > (property) response_format",
"(resource) beta.threads.runs > (model) run > (schema) > (property) started_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) status",
"(resource) beta.threads.runs > (model) run > (schema) > (property) thread_id",
"(resource) beta.threads.runs > (model) run > (schema) > (property) tool_choice",
"(resource) beta.threads.runs > (model) run > (schema) > (property) tools",
"(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy",
"(resource) beta.threads.runs > (model) run > (schema) > (property) usage",
"(resource) beta.threads.runs > (model) run > (schema) > (property) temperature",
"(resource) beta.threads.runs > (model) run > (schema) > (property) top_p"
]
},
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 3 > (property) event": {
"kind": "HttpDeclProperty",
"key": "event",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"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,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 3 > (property) event > (member) 0"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) id": {
"kind": "HttpDeclProperty",
"docstring": "The identifier, which can be referenced in API endpoints.",
"key": "id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunObject/properties/id",
"deprecated": 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.",
"key": "assistant_id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunObject/properties/assistant_id",
"deprecated": 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.",
"key": "cancelled_at",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/RunObject/properties/cancelled_at",
"deprecated": false,
"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.",
"key": "completed_at",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/RunObject/properties/completed_at",
"deprecated": false,
"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.",
"key": "created_at",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/RunObject/properties/created_at",
"deprecated": 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.",
"key": "expires_at",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/RunObject/properties/expires_at",
"deprecated": false,
"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.",
"key": "failed_at",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/RunObject/properties/failed_at",
"deprecated": false,
"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.",
"key": "incomplete_details",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "reason"
}
]
},
"oasRef": "#/components/schemas/RunObject/properties/incomplete_details",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) incomplete_details > (property) reason"
]
},
"(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.",
"key": "instructions",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunObject/properties/instructions",
"deprecated": 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.",
"key": "last_error",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "code"
},
{
"ident": "message"
}
]
},
"oasRef": "#/components/schemas/RunObject/properties/last_error",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) code",
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) message"
]
},
"(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",
"key": "max_completion_tokens",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"minimum": 256
},
"oasRef": "#/components/schemas/RunObject/properties/max_completion_tokens",
"deprecated": false,
"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",
"key": "max_prompt_tokens",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"minimum": 256
},
"oasRef": "#/components/schemas/RunObject/properties/max_prompt_tokens",
"deprecated": false,
"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",
"key": "metadata",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeReference",
"ident": "Metadata",
"$ref": "(resource) $shared > (model) metadata > (schema)"
},
"oasRef": "#/components/schemas/RunObject/properties/metadata",
"deprecated": false,
"schemaType": "map",
"modelImplicit": false,
"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.",
"key": "model",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunObject/properties/model",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) object": {
"kind": "HttpDeclProperty",
"docstring": "The object type, which is always `thread.run`.",
"key": "object",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "thread.run"
}
],
"oasRef": "#/components/schemas/RunObject/properties/object"
},
"oasRef": "#/components/schemas/RunObject/properties/object",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) object > (member) 0"
]
},
"(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.",
"key": "parallel_tool_calls",
"optional": false,
"nullable": false,
"default": true,
"type": {
"kind": "HttpTypeBoolean"
},
"oasRef": "#/components/schemas/RunObject/properties/parallel_tool_calls",
"deprecated": 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.",
"key": "required_action",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "submit_tool_outputs"
},
{
"ident": "type"
}
]
},
"oasRef": "#/components/schemas/RunObject/properties/required_action",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) required_action > (property) submit_tool_outputs",
"(resource) beta.threads.runs > (model) run > (schema) > (property) required_action > (property) type"
]
},
"(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",
"key": "response_format",
"optional": false,
"nullable": true,
"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",
"modelImplicit": false,
"modelPath": "(resource) beta.threads > (model) assistant_response_format_option",
"childrenParentSchema": "union",
"children": [
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 0",
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 1",
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 2",
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 3"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) started_at": {
"kind": "HttpDeclProperty",
"docstring": "The Unix timestamp (in seconds) for when the run was started.",
"key": "started_at",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/RunObject/properties/started_at",
"deprecated": false,
"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`.",
"key": "status",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "queued"
},
{
"kind": "HttpTypeLiteral",
"literal": "in_progress"
},
{
"kind": "HttpTypeLiteral",
"literal": "requires_action"
},
{
"kind": "HttpTypeLiteral",
"literal": "cancelling"
},
{
"kind": "HttpTypeLiteral",
"literal": "cancelled"
},
{
"kind": "HttpTypeLiteral",
"literal": "failed"
},
{
"kind": "HttpTypeLiteral",
"literal": "completed"
},
{
"kind": "HttpTypeLiteral",
"literal": "incomplete"
},
{
"kind": "HttpTypeLiteral",
"literal": "expired"
}
],
"oasRef": "#/components/schemas/RunObject/properties/status"
},
"oasRef": "#/components/schemas/RunObject/properties/status",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 0",
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 1",
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 2",
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 3",
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 4",
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 5",
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 6",
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 7",
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 8"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) thread_id": {
"kind": "HttpDeclProperty",
"docstring": "The ID of the [thread](/docs/api-reference/threads) that was executed on as a part of this run.",
"key": "thread_id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunObject/properties/thread_id",
"deprecated": 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",
"key": "tool_choice",
"optional": false,
"nullable": true,
"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",
"modelImplicit": false,
"modelPath": "(resource) beta.threads > (model) assistant_tool_choice_option",
"childrenParentSchema": "union",
"children": [
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0",
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 1"
]
},
"(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.",
"key": "tools",
"optional": false,
"nullable": false,
"default": [],
"type": {
"kind": "HttpTypeArray",
"elementType": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeReference",
"ident": "CodeInterpreterTool",
"$ref": "(resource) beta.assistants > (model) code_interpreter_tool > (schema)"
},
{
"kind": "HttpTypeReference",
"ident": "FileSearchTool",
"$ref": "(resource) beta.assistants > (model) file_search_tool > (schema)"
},
{
"kind": "HttpTypeReference",
"ident": "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,
"schemaType": "array",
"childrenParentSchema": "union",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 0",
"(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 1",
"(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 2"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy": {
"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.",
"key": "truncation_strategy",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
},
{
"ident": "last_messages"
}
]
},
"oasRef": "#/components/schemas/RunObject/properties/truncation_strategy",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) type",
"(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) last_messages"
]
},
"(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.).",
"key": "usage",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "completion_tokens"
},
{
"ident": "prompt_tokens"
},
{
"ident": "total_tokens"
}
]
},
"oasRef": "#/components/schemas/RunObject/properties/usage",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) usage > (property) completion_tokens",
"(resource) beta.threads.runs > (model) run > (schema) > (property) usage > (property) prompt_tokens",
"(resource) beta.threads.runs > (model) run > (schema) > (property) usage > (property) total_tokens"
]
},
"(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.",
"key": "temperature",
"optional": true,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"oasRef": "#/components/schemas/RunObject/properties/temperature",
"deprecated": false,
"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.",
"key": "top_p",
"optional": true,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"oasRef": "#/components/schemas/RunObject/properties/top_p",
"deprecated": false,
"schemaType": "number",
"children": []
},
"(resource) beta.threads.runs > (model) run > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RunObject",
"ident": "Run",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "id"
},
{
"ident": "assistant_id"
},
{
"ident": "cancelled_at"
},
{
"ident": "completed_at"
},
{
"ident": "created_at"
},
{
"ident": "expires_at"
},
{
"ident": "failed_at"
},
{
"ident": "incomplete_details"
},
{
"ident": "instructions"
},
{
"ident": "last_error"
},
{
"ident": "max_completion_tokens"
},
{
"ident": "max_prompt_tokens"
},
{
"ident": "metadata"
},
{
"ident": "model"
},
{
"ident": "object"
},
{
"ident": "parallel_tool_calls"
},
{
"ident": "required_action"
},
{
"ident": "response_format"
},
{
"ident": "started_at"
},
{
"ident": "status"
},
{
"ident": "thread_id"
},
{
"ident": "tool_choice"
},
{
"ident": "tools"
},
{
"ident": "truncation_strategy"
},
{
"ident": "usage"
},
{
"ident": "temperature"
},
{
"ident": "top_p"
}
]
},
"docstring": "Represents an execution run on a [thread](/docs/api-reference/threads).",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) id",
"(resource) beta.threads.runs > (model) run > (schema) > (property) assistant_id",
"(resource) beta.threads.runs > (model) run > (schema) > (property) cancelled_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) completed_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) created_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) expires_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) failed_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) incomplete_details",
"(resource) beta.threads.runs > (model) run > (schema) > (property) instructions",
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error",
"(resource) beta.threads.runs > (model) run > (schema) > (property) max_completion_tokens",
"(resource) beta.threads.runs > (model) run > (schema) > (property) max_prompt_tokens",
"(resource) beta.threads.runs > (model) run > (schema) > (property) metadata",
"(resource) beta.threads.runs > (model) run > (schema) > (property) model",
"(resource) beta.threads.runs > (model) run > (schema) > (property) object",
"(resource) beta.threads.runs > (model) run > (schema) > (property) parallel_tool_calls",
"(resource) beta.threads.runs > (model) run > (schema) > (property) required_action",
"(resource) beta.threads.runs > (model) run > (schema) > (property) response_format",
"(resource) beta.threads.runs > (model) run > (schema) > (property) started_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) status",
"(resource) beta.threads.runs > (model) run > (schema) > (property) thread_id",
"(resource) beta.threads.runs > (model) run > (schema) > (property) tool_choice",
"(resource) beta.threads.runs > (model) run > (schema) > (property) tools",
"(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy",
"(resource) beta.threads.runs > (model) run > (schema) > (property) usage",
"(resource) beta.threads.runs > (model) run > (schema) > (property) temperature",
"(resource) beta.threads.runs > (model) run > (schema) > (property) top_p"
]
},
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 3 > (property) event > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "thread.run.in_progress"
}
},
"(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.",
"key": "reason",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "max_completion_tokens"
},
{
"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,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) incomplete_details > (property) reason > (member) 0",
"(resource) beta.threads.runs > (model) run > (schema) > (property) incomplete_details > (property) reason > (member) 1"
]
},
"(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`.",
"key": "code",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "server_error"
},
{
"kind": "HttpTypeLiteral",
"literal": "rate_limit_exceeded"
},
{
"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,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) code > (member) 0",
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) code > (member) 1",
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) code > (member) 2"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) message": {
"kind": "HttpDeclProperty",
"docstring": "A human-readable description of the error.",
"key": "message",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunObject/properties/last_error/properties/message",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) $shared > (model) metadata > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/Metadata",
"ident": "Metadata",
"type": {
"kind": "HttpTypeReference",
"ident": "Record",
"typeParameters": [
{
"kind": "HttpTypeString"
},
{
"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": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "thread.run"
}
},
"(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.",
"key": "submit_tool_outputs",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "tool_calls"
}
]
},
"oasRef": "#/components/schemas/RunObject/properties/required_action/properties/submit_tool_outputs",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) required_action > (property) submit_tool_outputs > (property) tool_calls"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) required_action > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "For now, this is always `submit_tool_outputs`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"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,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) required_action > (property) type > (member) 0"
]
},
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 0": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/oneOf/0",
"ident": "UnionMember0",
"type": {
"kind": "HttpTypeUnion",
"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"
]
},
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "ResponseFormatText",
"$ref": "(resource) $shared > (model) response_format_text > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) $shared > (model) response_format_text > (schema) > (property) type"
]
},
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "ResponseFormatJSONObject",
"$ref": "(resource) $shared > (model) response_format_json_object > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) $shared > (model) response_format_json_object > (schema) > (property) type"
]
},
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 3": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "ResponseFormatJSONSchema",
"$ref": "(resource) $shared > (model) response_format_json_schema > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema",
"(resource) $shared > (model) response_format_json_schema > (schema) > (property) type"
]
},
"(resource) beta.threads > (model) assistant_response_format_option > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/AssistantsApiResponseFormatOption",
"ident": "AssistantResponseFormatOption",
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "auto"
}
],
"oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/oneOf/0"
},
{
"kind": "HttpTypeReference",
"ident": "ResponseFormatText",
"$ref": "(resource) $shared > (model) response_format_text > (schema)"
},
{
"kind": "HttpTypeReference",
"ident": "ResponseFormatJSONObject",
"$ref": "(resource) $shared > (model) response_format_json_object > (schema)"
},
{
"kind": "HttpTypeReference",
"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",
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 1",
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 2",
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 3"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "queued"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "in_progress"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "requires_action"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 3": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "cancelling"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 4": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "cancelled"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 5": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "failed"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 6": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "completed"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 7": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "incomplete"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 8": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "expired"
}
},
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/AssistantsApiToolChoiceOption/oneOf/0",
"ident": "UnionMember0",
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "none"
},
{
"kind": "HttpTypeLiteral",
"literal": "auto"
},
{
"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",
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0 > (member) 1",
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0 > (member) 2"
]
},
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "AssistantToolChoice",
"$ref": "(resource) beta.threads > (model) assistant_tool_choice > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) type",
"(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) function"
]
},
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/AssistantsApiToolChoiceOption",
"ident": "AssistantToolChoiceOption",
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "none"
},
{
"kind": "HttpTypeLiteral",
"literal": "auto"
},
{
"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",
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 1"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "CodeInterpreterTool",
"$ref": "(resource) beta.assistants > (model) code_interpreter_tool > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "FileSearchTool",
"$ref": "(resource) beta.assistants > (model) file_search_tool > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) type",
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "FunctionTool",
"$ref": "(resource) beta.assistants > (model) function_tool > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.assistants > (model) function_tool > (schema) > (property) function",
"(resource) beta.assistants > (model) function_tool > (schema) > (property) type"
]
},
"(resource) beta.assistants > (model) code_interpreter_tool > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/AssistantToolsCode",
"ident": "CodeInterpreterTool",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type"
]
},
"(resource) beta.assistants > (model) file_search_tool > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/AssistantToolsFileSearch",
"ident": "FileSearchTool",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
},
{
"ident": "file_search"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) type",
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search"
]
},
"(resource) beta.assistants > (model) function_tool > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/AssistantToolsFunction",
"ident": "FunctionTool",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "function"
},
{
"ident": "type"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.assistants > (model) function_tool > (schema) > (property) function",
"(resource) beta.assistants > (model) function_tool > (schema) > (property) type"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) type": {
"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`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "auto"
},
{
"kind": "HttpTypeLiteral",
"literal": "last_messages"
}
],
"oasRef": "#/components/schemas/TruncationObject/properties/type"
},
"oasRef": "#/components/schemas/TruncationObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) type > (member) 0",
"(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) type > (member) 1"
]
},
"(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.",
"key": "last_messages",
"optional": true,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"minimum": 1
},
"oasRef": "#/components/schemas/TruncationObject/properties/last_messages",
"deprecated": false,
"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.",
"key": "completion_tokens",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"oasRef": "#/components/schemas/RunCompletionUsage/anyOf/0/properties/completion_tokens",
"deprecated": 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.",
"key": "prompt_tokens",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"oasRef": "#/components/schemas/RunCompletionUsage/anyOf/0/properties/prompt_tokens",
"deprecated": 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).",
"key": "total_tokens",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"oasRef": "#/components/schemas/RunCompletionUsage/anyOf/0/properties/total_tokens",
"deprecated": false,
"schemaType": "integer",
"children": []
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) incomplete_details > (property) reason > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "max_completion_tokens"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) incomplete_details > (property) reason > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "max_prompt_tokens"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) code > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "server_error"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) code > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "rate_limit_exceeded"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) code > (member) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "invalid_prompt"
}
},
"(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.",
"key": "tool_calls",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeArray",
"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,
"schemaType": "array",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) id",
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) function",
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) type"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) required_action > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "submit_tool_outputs"
}
},
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 0 > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "auto"
}
},
"(resource) $shared > (model) response_format_text > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The type of response format being defined. Always `text`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "text"
}
],
"oasRef": "#/components/schemas/ResponseFormatText/properties/type"
},
"oasRef": "#/components/schemas/ResponseFormatText/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) $shared > (model) response_format_text > (schema) > (property) type > (member) 0"
]
},
"(resource) $shared > (model) response_format_text > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/ResponseFormatText",
"ident": "ResponseFormatText",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
}
]
},
"docstring": "Default response format. Used to generate text responses.\n",
"childrenParentSchema": "object",
"children": [
"(resource) $shared > (model) response_format_text > (schema) > (property) type"
]
},
"(resource) $shared > (model) response_format_json_object > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The type of response format being defined. Always `json_object`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "json_object"
}
],
"oasRef": "#/components/schemas/ResponseFormatJsonObject/properties/type"
},
"oasRef": "#/components/schemas/ResponseFormatJsonObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) $shared > (model) response_format_json_object > (schema) > (property) type > (member) 0"
]
},
"(resource) $shared > (model) response_format_json_object > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/ResponseFormatJsonObject",
"ident": "ResponseFormatJSONObject",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
}
]
},
"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"
]
},
"(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",
"key": "json_schema",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "name"
},
{
"ident": "description"
},
{
"ident": "schema"
},
{
"ident": "strict"
}
]
},
"oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema > (property) name",
"(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema > (property) description",
"(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema > (property) schema",
"(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema > (property) strict"
]
},
"(resource) $shared > (model) response_format_json_schema > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The type of response format being defined. Always `json_schema`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "json_schema"
}
],
"oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/type"
},
"oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) $shared > (model) response_format_json_schema > (schema) > (property) type > (member) 0"
]
},
"(resource) $shared > (model) response_format_json_schema > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/ResponseFormatJsonSchema",
"ident": "ResponseFormatJSONSchema",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "json_schema"
},
{
"ident": "type"
}
]
},
"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",
"(resource) $shared > (model) response_format_json_schema > (schema) > (property) type"
]
},
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0 > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "none"
}
},
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0 > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "auto"
}
},
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0 > (member) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "required"
}
},
"(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",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "function"
},
{
"kind": "HttpTypeLiteral",
"literal": "code_interpreter"
},
{
"kind": "HttpTypeLiteral",
"literal": "file_search"
}
],
"oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/type"
},
"oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) type > (member) 0",
"(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) type > (member) 1",
"(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) type > (member) 2"
]
},
"(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) function": {
"kind": "HttpDeclProperty",
"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",
"modelImplicit": false,
"modelPath": "(resource) beta.threads > (model) assistant_tool_choice_function",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads > (model) assistant_tool_choice_function > (schema) > (property) name"
]
},
"(resource) beta.threads > (model) assistant_tool_choice > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/AssistantsNamedToolChoice",
"ident": "AssistantToolChoice",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
},
{
"ident": "function"
}
]
},
"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",
"(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) function"
]
},
"(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The type of tool being defined: `code_interpreter`",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "code_interpreter"
}
],
"oasRef": "#/components/schemas/AssistantToolsCode/properties/type"
},
"oasRef": "#/components/schemas/AssistantToolsCode/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type > (member) 0"
]
},
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The type of tool being defined: `file_search`",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "file_search"
}
],
"oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/type"
},
"oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) type > (member) 0"
]
},
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search": {
"kind": "HttpDeclProperty",
"docstring": "Overrides for the file search tool.",
"key": "file_search",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "max_num_results"
},
{
"ident": "ranking_options"
}
]
},
"oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/file_search",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) max_num_results",
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options"
]
},
"(resource) beta.assistants > (model) function_tool > (schema) > (property) function": {
"kind": "HttpDeclProperty",
"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",
"modelImplicit": false,
"modelPath": "(resource) $shared > (model) function_definition",
"childrenParentSchema": "object",
"children": [
"(resource) $shared > (model) function_definition > (schema) > (property) name",
"(resource) $shared > (model) function_definition > (schema) > (property) description",
"(resource) $shared > (model) function_definition > (schema) > (property) parameters",
"(resource) $shared > (model) function_definition > (schema) > (property) strict"
]
},
"(resource) beta.assistants > (model) function_tool > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The type of tool being defined: `function`",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "function"
}
],
"oasRef": "#/components/schemas/AssistantToolsFunction/properties/type"
},
"oasRef": "#/components/schemas/AssistantToolsFunction/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.assistants > (model) function_tool > (schema) > (property) type > (member) 0"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "auto"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) type > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "last_messages"
}
},
"(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.",
"key": "id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunToolCallObject/properties/id",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) function": {
"kind": "HttpDeclProperty",
"docstring": "The function definition.",
"key": "function",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "arguments"
},
{
"ident": "name"
}
]
},
"oasRef": "#/components/schemas/RunToolCallObject/properties/function",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) function > (property) arguments",
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) function > (property) name"
]
},
"(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`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "function"
}
],
"oasRef": "#/components/schemas/RunToolCallObject/properties/type"
},
"oasRef": "#/components/schemas/RunToolCallObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) type > (member) 0"
]
},
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RunToolCallObject",
"ident": "RequiredActionFunctionToolCall",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "id"
},
{
"ident": "function"
},
{
"ident": "type"
}
]
},
"docstring": "Tool call objects",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) id",
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) function",
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) type"
]
},
"(resource) $shared > (model) response_format_text > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "text"
}
},
"(resource) $shared > (model) response_format_json_object > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "json_object"
}
},
"(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",
"key": "name",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/name",
"deprecated": 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",
"key": "description",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/description",
"deprecated": 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",
"key": "schema",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeReference",
"ident": "Record",
"typeParameters": [
{
"kind": "HttpTypeString"
},
{
"kind": "HttpTypeUnknown"
}
],
"oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/schema"
},
"oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/schema",
"deprecated": 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",
"key": "strict",
"optional": true,
"nullable": true,
"default": false,
"type": {
"kind": "HttpTypeBoolean"
},
"oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/strict",
"deprecated": false,
"schemaType": "boolean",
"children": []
},
"(resource) $shared > (model) response_format_json_schema > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "json_schema"
}
},
"(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "function"
}
},
"(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) type > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "code_interpreter"
}
},
"(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) type > (member) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "file_search"
}
},
"(resource) beta.threads > (model) assistant_tool_choice_function > (schema) > (property) name": {
"kind": "HttpDeclProperty",
"docstring": "The name of the function to call.",
"key": "name",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/function/properties/name",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads > (model) assistant_tool_choice_function > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/function",
"ident": "AssistantToolChoiceFunction",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "name"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads > (model) assistant_tool_choice_function > (schema) > (property) name"
]
},
"(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "code_interpreter"
}
},
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "file_search"
}
},
"(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",
"key": "max_num_results",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"minimum": 1,
"maximum": 50
},
"oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/file_search/properties/max_num_results",
"deprecated": 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",
"key": "ranking_options",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "score_threshold"
},
{
"ident": "ranker"
}
]
},
"oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/file_search/properties/ranking_options",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options > (property) score_threshold",
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options > (property) ranker"
]
},
"(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.",
"key": "name",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/FunctionObject/properties/name",
"deprecated": 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.",
"key": "description",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/FunctionObject/properties/description",
"deprecated": 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.",
"key": "parameters",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeReference",
"ident": "FunctionParameters",
"$ref": "(resource) $shared > (model) function_parameters > (schema)"
},
"oasRef": "#/components/schemas/FunctionObject/properties/parameters",
"deprecated": false,
"schemaType": "map",
"modelImplicit": false,
"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).",
"key": "strict",
"optional": true,
"nullable": true,
"default": false,
"type": {
"kind": "HttpTypeBoolean"
},
"oasRef": "#/components/schemas/FunctionObject/properties/strict",
"deprecated": false,
"schemaType": "boolean",
"children": []
},
"(resource) $shared > (model) function_definition > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/FunctionObject",
"ident": "FunctionDefinition",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "name"
},
{
"ident": "description"
},
{
"ident": "parameters"
},
{
"ident": "strict"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) $shared > (model) function_definition > (schema) > (property) name",
"(resource) $shared > (model) function_definition > (schema) > (property) description",
"(resource) $shared > (model) function_definition > (schema) > (property) parameters",
"(resource) $shared > (model) function_definition > (schema) > (property) strict"
]
},
"(resource) beta.assistants > (model) function_tool > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "function"
}
},
"(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.",
"key": "arguments",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunToolCallObject/properties/function/properties/arguments",
"deprecated": 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.",
"key": "name",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunToolCallObject/properties/function/properties/name",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "function"
}
},
"(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.",
"key": "score_threshold",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"minimum": 0,
"maximum": 1
},
"oasRef": "#/components/schemas/FileSearchRankingOptions/properties/score_threshold",
"deprecated": 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.",
"key": "ranker",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "auto"
},
{
"kind": "HttpTypeLiteral",
"literal": "default_2024_08_21"
}
],
"oasRef": "#/components/schemas/FileSearchRankingOptions/properties/ranker"
},
"oasRef": "#/components/schemas/FileSearchRankingOptions/properties/ranker",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options > (property) ranker > (member) 0",
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options > (property) ranker > (member) 1"
]
},
"(resource) $shared > (model) function_parameters > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/FunctionParameters",
"ident": "FunctionParameters",
"type": {
"kind": "HttpTypeReference",
"ident": "Record",
"typeParameters": [
{
"kind": "HttpTypeString"
},
{
"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": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "auto"
}
},
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options > (property) ranker > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "default_2024_08_21"
}
}
}
Example
{}
event
Occurs when a run moves to a requires_action status.
Schema
Schema name: (resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 4
{
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 4": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RunStreamEvent/oneOf/3",
"ident": "UnionMember4",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "data"
},
{
"ident": "event"
}
]
},
"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",
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 4 > (property) event"
]
},
"(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).",
"key": "data",
"optional": false,
"nullable": false,
"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",
"modelImplicit": false,
"modelPath": "(resource) beta.threads.runs > (model) run",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) id",
"(resource) beta.threads.runs > (model) run > (schema) > (property) assistant_id",
"(resource) beta.threads.runs > (model) run > (schema) > (property) cancelled_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) completed_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) created_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) expires_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) failed_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) incomplete_details",
"(resource) beta.threads.runs > (model) run > (schema) > (property) instructions",
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error",
"(resource) beta.threads.runs > (model) run > (schema) > (property) max_completion_tokens",
"(resource) beta.threads.runs > (model) run > (schema) > (property) max_prompt_tokens",
"(resource) beta.threads.runs > (model) run > (schema) > (property) metadata",
"(resource) beta.threads.runs > (model) run > (schema) > (property) model",
"(resource) beta.threads.runs > (model) run > (schema) > (property) object",
"(resource) beta.threads.runs > (model) run > (schema) > (property) parallel_tool_calls",
"(resource) beta.threads.runs > (model) run > (schema) > (property) required_action",
"(resource) beta.threads.runs > (model) run > (schema) > (property) response_format",
"(resource) beta.threads.runs > (model) run > (schema) > (property) started_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) status",
"(resource) beta.threads.runs > (model) run > (schema) > (property) thread_id",
"(resource) beta.threads.runs > (model) run > (schema) > (property) tool_choice",
"(resource) beta.threads.runs > (model) run > (schema) > (property) tools",
"(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy",
"(resource) beta.threads.runs > (model) run > (schema) > (property) usage",
"(resource) beta.threads.runs > (model) run > (schema) > (property) temperature",
"(resource) beta.threads.runs > (model) run > (schema) > (property) top_p"
]
},
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 4 > (property) event": {
"kind": "HttpDeclProperty",
"key": "event",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"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,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 4 > (property) event > (member) 0"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) id": {
"kind": "HttpDeclProperty",
"docstring": "The identifier, which can be referenced in API endpoints.",
"key": "id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunObject/properties/id",
"deprecated": 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.",
"key": "assistant_id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunObject/properties/assistant_id",
"deprecated": 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.",
"key": "cancelled_at",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/RunObject/properties/cancelled_at",
"deprecated": false,
"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.",
"key": "completed_at",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/RunObject/properties/completed_at",
"deprecated": false,
"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.",
"key": "created_at",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/RunObject/properties/created_at",
"deprecated": 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.",
"key": "expires_at",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/RunObject/properties/expires_at",
"deprecated": false,
"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.",
"key": "failed_at",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/RunObject/properties/failed_at",
"deprecated": false,
"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.",
"key": "incomplete_details",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "reason"
}
]
},
"oasRef": "#/components/schemas/RunObject/properties/incomplete_details",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) incomplete_details > (property) reason"
]
},
"(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.",
"key": "instructions",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunObject/properties/instructions",
"deprecated": 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.",
"key": "last_error",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "code"
},
{
"ident": "message"
}
]
},
"oasRef": "#/components/schemas/RunObject/properties/last_error",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) code",
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) message"
]
},
"(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",
"key": "max_completion_tokens",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"minimum": 256
},
"oasRef": "#/components/schemas/RunObject/properties/max_completion_tokens",
"deprecated": false,
"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",
"key": "max_prompt_tokens",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"minimum": 256
},
"oasRef": "#/components/schemas/RunObject/properties/max_prompt_tokens",
"deprecated": false,
"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",
"key": "metadata",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeReference",
"ident": "Metadata",
"$ref": "(resource) $shared > (model) metadata > (schema)"
},
"oasRef": "#/components/schemas/RunObject/properties/metadata",
"deprecated": false,
"schemaType": "map",
"modelImplicit": false,
"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.",
"key": "model",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunObject/properties/model",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) object": {
"kind": "HttpDeclProperty",
"docstring": "The object type, which is always `thread.run`.",
"key": "object",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "thread.run"
}
],
"oasRef": "#/components/schemas/RunObject/properties/object"
},
"oasRef": "#/components/schemas/RunObject/properties/object",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) object > (member) 0"
]
},
"(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.",
"key": "parallel_tool_calls",
"optional": false,
"nullable": false,
"default": true,
"type": {
"kind": "HttpTypeBoolean"
},
"oasRef": "#/components/schemas/RunObject/properties/parallel_tool_calls",
"deprecated": 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.",
"key": "required_action",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "submit_tool_outputs"
},
{
"ident": "type"
}
]
},
"oasRef": "#/components/schemas/RunObject/properties/required_action",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) required_action > (property) submit_tool_outputs",
"(resource) beta.threads.runs > (model) run > (schema) > (property) required_action > (property) type"
]
},
"(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",
"key": "response_format",
"optional": false,
"nullable": true,
"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",
"modelImplicit": false,
"modelPath": "(resource) beta.threads > (model) assistant_response_format_option",
"childrenParentSchema": "union",
"children": [
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 0",
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 1",
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 2",
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 3"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) started_at": {
"kind": "HttpDeclProperty",
"docstring": "The Unix timestamp (in seconds) for when the run was started.",
"key": "started_at",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/RunObject/properties/started_at",
"deprecated": false,
"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`.",
"key": "status",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "queued"
},
{
"kind": "HttpTypeLiteral",
"literal": "in_progress"
},
{
"kind": "HttpTypeLiteral",
"literal": "requires_action"
},
{
"kind": "HttpTypeLiteral",
"literal": "cancelling"
},
{
"kind": "HttpTypeLiteral",
"literal": "cancelled"
},
{
"kind": "HttpTypeLiteral",
"literal": "failed"
},
{
"kind": "HttpTypeLiteral",
"literal": "completed"
},
{
"kind": "HttpTypeLiteral",
"literal": "incomplete"
},
{
"kind": "HttpTypeLiteral",
"literal": "expired"
}
],
"oasRef": "#/components/schemas/RunObject/properties/status"
},
"oasRef": "#/components/schemas/RunObject/properties/status",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 0",
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 1",
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 2",
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 3",
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 4",
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 5",
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 6",
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 7",
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 8"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) thread_id": {
"kind": "HttpDeclProperty",
"docstring": "The ID of the [thread](/docs/api-reference/threads) that was executed on as a part of this run.",
"key": "thread_id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunObject/properties/thread_id",
"deprecated": 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",
"key": "tool_choice",
"optional": false,
"nullable": true,
"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",
"modelImplicit": false,
"modelPath": "(resource) beta.threads > (model) assistant_tool_choice_option",
"childrenParentSchema": "union",
"children": [
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0",
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 1"
]
},
"(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.",
"key": "tools",
"optional": false,
"nullable": false,
"default": [],
"type": {
"kind": "HttpTypeArray",
"elementType": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeReference",
"ident": "CodeInterpreterTool",
"$ref": "(resource) beta.assistants > (model) code_interpreter_tool > (schema)"
},
{
"kind": "HttpTypeReference",
"ident": "FileSearchTool",
"$ref": "(resource) beta.assistants > (model) file_search_tool > (schema)"
},
{
"kind": "HttpTypeReference",
"ident": "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,
"schemaType": "array",
"childrenParentSchema": "union",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 0",
"(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 1",
"(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 2"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy": {
"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.",
"key": "truncation_strategy",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
},
{
"ident": "last_messages"
}
]
},
"oasRef": "#/components/schemas/RunObject/properties/truncation_strategy",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) type",
"(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) last_messages"
]
},
"(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.).",
"key": "usage",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "completion_tokens"
},
{
"ident": "prompt_tokens"
},
{
"ident": "total_tokens"
}
]
},
"oasRef": "#/components/schemas/RunObject/properties/usage",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) usage > (property) completion_tokens",
"(resource) beta.threads.runs > (model) run > (schema) > (property) usage > (property) prompt_tokens",
"(resource) beta.threads.runs > (model) run > (schema) > (property) usage > (property) total_tokens"
]
},
"(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.",
"key": "temperature",
"optional": true,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"oasRef": "#/components/schemas/RunObject/properties/temperature",
"deprecated": false,
"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.",
"key": "top_p",
"optional": true,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"oasRef": "#/components/schemas/RunObject/properties/top_p",
"deprecated": false,
"schemaType": "number",
"children": []
},
"(resource) beta.threads.runs > (model) run > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RunObject",
"ident": "Run",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "id"
},
{
"ident": "assistant_id"
},
{
"ident": "cancelled_at"
},
{
"ident": "completed_at"
},
{
"ident": "created_at"
},
{
"ident": "expires_at"
},
{
"ident": "failed_at"
},
{
"ident": "incomplete_details"
},
{
"ident": "instructions"
},
{
"ident": "last_error"
},
{
"ident": "max_completion_tokens"
},
{
"ident": "max_prompt_tokens"
},
{
"ident": "metadata"
},
{
"ident": "model"
},
{
"ident": "object"
},
{
"ident": "parallel_tool_calls"
},
{
"ident": "required_action"
},
{
"ident": "response_format"
},
{
"ident": "started_at"
},
{
"ident": "status"
},
{
"ident": "thread_id"
},
{
"ident": "tool_choice"
},
{
"ident": "tools"
},
{
"ident": "truncation_strategy"
},
{
"ident": "usage"
},
{
"ident": "temperature"
},
{
"ident": "top_p"
}
]
},
"docstring": "Represents an execution run on a [thread](/docs/api-reference/threads).",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) id",
"(resource) beta.threads.runs > (model) run > (schema) > (property) assistant_id",
"(resource) beta.threads.runs > (model) run > (schema) > (property) cancelled_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) completed_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) created_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) expires_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) failed_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) incomplete_details",
"(resource) beta.threads.runs > (model) run > (schema) > (property) instructions",
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error",
"(resource) beta.threads.runs > (model) run > (schema) > (property) max_completion_tokens",
"(resource) beta.threads.runs > (model) run > (schema) > (property) max_prompt_tokens",
"(resource) beta.threads.runs > (model) run > (schema) > (property) metadata",
"(resource) beta.threads.runs > (model) run > (schema) > (property) model",
"(resource) beta.threads.runs > (model) run > (schema) > (property) object",
"(resource) beta.threads.runs > (model) run > (schema) > (property) parallel_tool_calls",
"(resource) beta.threads.runs > (model) run > (schema) > (property) required_action",
"(resource) beta.threads.runs > (model) run > (schema) > (property) response_format",
"(resource) beta.threads.runs > (model) run > (schema) > (property) started_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) status",
"(resource) beta.threads.runs > (model) run > (schema) > (property) thread_id",
"(resource) beta.threads.runs > (model) run > (schema) > (property) tool_choice",
"(resource) beta.threads.runs > (model) run > (schema) > (property) tools",
"(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy",
"(resource) beta.threads.runs > (model) run > (schema) > (property) usage",
"(resource) beta.threads.runs > (model) run > (schema) > (property) temperature",
"(resource) beta.threads.runs > (model) run > (schema) > (property) top_p"
]
},
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 4 > (property) event > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "thread.run.requires_action"
}
},
"(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.",
"key": "reason",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "max_completion_tokens"
},
{
"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,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) incomplete_details > (property) reason > (member) 0",
"(resource) beta.threads.runs > (model) run > (schema) > (property) incomplete_details > (property) reason > (member) 1"
]
},
"(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`.",
"key": "code",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "server_error"
},
{
"kind": "HttpTypeLiteral",
"literal": "rate_limit_exceeded"
},
{
"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,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) code > (member) 0",
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) code > (member) 1",
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) code > (member) 2"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) message": {
"kind": "HttpDeclProperty",
"docstring": "A human-readable description of the error.",
"key": "message",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunObject/properties/last_error/properties/message",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) $shared > (model) metadata > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/Metadata",
"ident": "Metadata",
"type": {
"kind": "HttpTypeReference",
"ident": "Record",
"typeParameters": [
{
"kind": "HttpTypeString"
},
{
"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": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "thread.run"
}
},
"(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.",
"key": "submit_tool_outputs",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "tool_calls"
}
]
},
"oasRef": "#/components/schemas/RunObject/properties/required_action/properties/submit_tool_outputs",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) required_action > (property) submit_tool_outputs > (property) tool_calls"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) required_action > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "For now, this is always `submit_tool_outputs`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"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,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) required_action > (property) type > (member) 0"
]
},
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 0": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/oneOf/0",
"ident": "UnionMember0",
"type": {
"kind": "HttpTypeUnion",
"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"
]
},
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "ResponseFormatText",
"$ref": "(resource) $shared > (model) response_format_text > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) $shared > (model) response_format_text > (schema) > (property) type"
]
},
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "ResponseFormatJSONObject",
"$ref": "(resource) $shared > (model) response_format_json_object > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) $shared > (model) response_format_json_object > (schema) > (property) type"
]
},
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 3": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "ResponseFormatJSONSchema",
"$ref": "(resource) $shared > (model) response_format_json_schema > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema",
"(resource) $shared > (model) response_format_json_schema > (schema) > (property) type"
]
},
"(resource) beta.threads > (model) assistant_response_format_option > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/AssistantsApiResponseFormatOption",
"ident": "AssistantResponseFormatOption",
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "auto"
}
],
"oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/oneOf/0"
},
{
"kind": "HttpTypeReference",
"ident": "ResponseFormatText",
"$ref": "(resource) $shared > (model) response_format_text > (schema)"
},
{
"kind": "HttpTypeReference",
"ident": "ResponseFormatJSONObject",
"$ref": "(resource) $shared > (model) response_format_json_object > (schema)"
},
{
"kind": "HttpTypeReference",
"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",
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 1",
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 2",
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 3"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "queued"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "in_progress"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "requires_action"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 3": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "cancelling"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 4": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "cancelled"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 5": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "failed"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 6": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "completed"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 7": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "incomplete"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 8": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "expired"
}
},
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/AssistantsApiToolChoiceOption/oneOf/0",
"ident": "UnionMember0",
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "none"
},
{
"kind": "HttpTypeLiteral",
"literal": "auto"
},
{
"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",
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0 > (member) 1",
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0 > (member) 2"
]
},
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "AssistantToolChoice",
"$ref": "(resource) beta.threads > (model) assistant_tool_choice > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) type",
"(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) function"
]
},
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/AssistantsApiToolChoiceOption",
"ident": "AssistantToolChoiceOption",
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "none"
},
{
"kind": "HttpTypeLiteral",
"literal": "auto"
},
{
"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",
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 1"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "CodeInterpreterTool",
"$ref": "(resource) beta.assistants > (model) code_interpreter_tool > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "FileSearchTool",
"$ref": "(resource) beta.assistants > (model) file_search_tool > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) type",
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "FunctionTool",
"$ref": "(resource) beta.assistants > (model) function_tool > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.assistants > (model) function_tool > (schema) > (property) function",
"(resource) beta.assistants > (model) function_tool > (schema) > (property) type"
]
},
"(resource) beta.assistants > (model) code_interpreter_tool > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/AssistantToolsCode",
"ident": "CodeInterpreterTool",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type"
]
},
"(resource) beta.assistants > (model) file_search_tool > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/AssistantToolsFileSearch",
"ident": "FileSearchTool",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
},
{
"ident": "file_search"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) type",
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search"
]
},
"(resource) beta.assistants > (model) function_tool > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/AssistantToolsFunction",
"ident": "FunctionTool",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "function"
},
{
"ident": "type"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.assistants > (model) function_tool > (schema) > (property) function",
"(resource) beta.assistants > (model) function_tool > (schema) > (property) type"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) type": {
"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`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "auto"
},
{
"kind": "HttpTypeLiteral",
"literal": "last_messages"
}
],
"oasRef": "#/components/schemas/TruncationObject/properties/type"
},
"oasRef": "#/components/schemas/TruncationObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) type > (member) 0",
"(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) type > (member) 1"
]
},
"(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.",
"key": "last_messages",
"optional": true,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"minimum": 1
},
"oasRef": "#/components/schemas/TruncationObject/properties/last_messages",
"deprecated": false,
"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.",
"key": "completion_tokens",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"oasRef": "#/components/schemas/RunCompletionUsage/anyOf/0/properties/completion_tokens",
"deprecated": 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.",
"key": "prompt_tokens",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"oasRef": "#/components/schemas/RunCompletionUsage/anyOf/0/properties/prompt_tokens",
"deprecated": 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).",
"key": "total_tokens",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"oasRef": "#/components/schemas/RunCompletionUsage/anyOf/0/properties/total_tokens",
"deprecated": false,
"schemaType": "integer",
"children": []
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) incomplete_details > (property) reason > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "max_completion_tokens"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) incomplete_details > (property) reason > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "max_prompt_tokens"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) code > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "server_error"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) code > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "rate_limit_exceeded"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) code > (member) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "invalid_prompt"
}
},
"(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.",
"key": "tool_calls",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeArray",
"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,
"schemaType": "array",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) id",
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) function",
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) type"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) required_action > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "submit_tool_outputs"
}
},
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 0 > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "auto"
}
},
"(resource) $shared > (model) response_format_text > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The type of response format being defined. Always `text`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "text"
}
],
"oasRef": "#/components/schemas/ResponseFormatText/properties/type"
},
"oasRef": "#/components/schemas/ResponseFormatText/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) $shared > (model) response_format_text > (schema) > (property) type > (member) 0"
]
},
"(resource) $shared > (model) response_format_text > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/ResponseFormatText",
"ident": "ResponseFormatText",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
}
]
},
"docstring": "Default response format. Used to generate text responses.\n",
"childrenParentSchema": "object",
"children": [
"(resource) $shared > (model) response_format_text > (schema) > (property) type"
]
},
"(resource) $shared > (model) response_format_json_object > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The type of response format being defined. Always `json_object`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "json_object"
}
],
"oasRef": "#/components/schemas/ResponseFormatJsonObject/properties/type"
},
"oasRef": "#/components/schemas/ResponseFormatJsonObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) $shared > (model) response_format_json_object > (schema) > (property) type > (member) 0"
]
},
"(resource) $shared > (model) response_format_json_object > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/ResponseFormatJsonObject",
"ident": "ResponseFormatJSONObject",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
}
]
},
"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"
]
},
"(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",
"key": "json_schema",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "name"
},
{
"ident": "description"
},
{
"ident": "schema"
},
{
"ident": "strict"
}
]
},
"oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema > (property) name",
"(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema > (property) description",
"(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema > (property) schema",
"(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema > (property) strict"
]
},
"(resource) $shared > (model) response_format_json_schema > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The type of response format being defined. Always `json_schema`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "json_schema"
}
],
"oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/type"
},
"oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) $shared > (model) response_format_json_schema > (schema) > (property) type > (member) 0"
]
},
"(resource) $shared > (model) response_format_json_schema > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/ResponseFormatJsonSchema",
"ident": "ResponseFormatJSONSchema",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "json_schema"
},
{
"ident": "type"
}
]
},
"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",
"(resource) $shared > (model) response_format_json_schema > (schema) > (property) type"
]
},
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0 > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "none"
}
},
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0 > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "auto"
}
},
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0 > (member) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "required"
}
},
"(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",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "function"
},
{
"kind": "HttpTypeLiteral",
"literal": "code_interpreter"
},
{
"kind": "HttpTypeLiteral",
"literal": "file_search"
}
],
"oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/type"
},
"oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) type > (member) 0",
"(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) type > (member) 1",
"(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) type > (member) 2"
]
},
"(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) function": {
"kind": "HttpDeclProperty",
"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",
"modelImplicit": false,
"modelPath": "(resource) beta.threads > (model) assistant_tool_choice_function",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads > (model) assistant_tool_choice_function > (schema) > (property) name"
]
},
"(resource) beta.threads > (model) assistant_tool_choice > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/AssistantsNamedToolChoice",
"ident": "AssistantToolChoice",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
},
{
"ident": "function"
}
]
},
"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",
"(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) function"
]
},
"(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The type of tool being defined: `code_interpreter`",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "code_interpreter"
}
],
"oasRef": "#/components/schemas/AssistantToolsCode/properties/type"
},
"oasRef": "#/components/schemas/AssistantToolsCode/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type > (member) 0"
]
},
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The type of tool being defined: `file_search`",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "file_search"
}
],
"oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/type"
},
"oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) type > (member) 0"
]
},
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search": {
"kind": "HttpDeclProperty",
"docstring": "Overrides for the file search tool.",
"key": "file_search",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "max_num_results"
},
{
"ident": "ranking_options"
}
]
},
"oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/file_search",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) max_num_results",
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options"
]
},
"(resource) beta.assistants > (model) function_tool > (schema) > (property) function": {
"kind": "HttpDeclProperty",
"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",
"modelImplicit": false,
"modelPath": "(resource) $shared > (model) function_definition",
"childrenParentSchema": "object",
"children": [
"(resource) $shared > (model) function_definition > (schema) > (property) name",
"(resource) $shared > (model) function_definition > (schema) > (property) description",
"(resource) $shared > (model) function_definition > (schema) > (property) parameters",
"(resource) $shared > (model) function_definition > (schema) > (property) strict"
]
},
"(resource) beta.assistants > (model) function_tool > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The type of tool being defined: `function`",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "function"
}
],
"oasRef": "#/components/schemas/AssistantToolsFunction/properties/type"
},
"oasRef": "#/components/schemas/AssistantToolsFunction/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.assistants > (model) function_tool > (schema) > (property) type > (member) 0"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "auto"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) type > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "last_messages"
}
},
"(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.",
"key": "id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunToolCallObject/properties/id",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) function": {
"kind": "HttpDeclProperty",
"docstring": "The function definition.",
"key": "function",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "arguments"
},
{
"ident": "name"
}
]
},
"oasRef": "#/components/schemas/RunToolCallObject/properties/function",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) function > (property) arguments",
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) function > (property) name"
]
},
"(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`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "function"
}
],
"oasRef": "#/components/schemas/RunToolCallObject/properties/type"
},
"oasRef": "#/components/schemas/RunToolCallObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) type > (member) 0"
]
},
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RunToolCallObject",
"ident": "RequiredActionFunctionToolCall",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "id"
},
{
"ident": "function"
},
{
"ident": "type"
}
]
},
"docstring": "Tool call objects",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) id",
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) function",
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) type"
]
},
"(resource) $shared > (model) response_format_text > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "text"
}
},
"(resource) $shared > (model) response_format_json_object > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "json_object"
}
},
"(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",
"key": "name",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/name",
"deprecated": 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",
"key": "description",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/description",
"deprecated": 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",
"key": "schema",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeReference",
"ident": "Record",
"typeParameters": [
{
"kind": "HttpTypeString"
},
{
"kind": "HttpTypeUnknown"
}
],
"oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/schema"
},
"oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/schema",
"deprecated": 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",
"key": "strict",
"optional": true,
"nullable": true,
"default": false,
"type": {
"kind": "HttpTypeBoolean"
},
"oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/strict",
"deprecated": false,
"schemaType": "boolean",
"children": []
},
"(resource) $shared > (model) response_format_json_schema > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "json_schema"
}
},
"(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "function"
}
},
"(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) type > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "code_interpreter"
}
},
"(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) type > (member) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "file_search"
}
},
"(resource) beta.threads > (model) assistant_tool_choice_function > (schema) > (property) name": {
"kind": "HttpDeclProperty",
"docstring": "The name of the function to call.",
"key": "name",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/function/properties/name",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads > (model) assistant_tool_choice_function > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/function",
"ident": "AssistantToolChoiceFunction",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "name"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads > (model) assistant_tool_choice_function > (schema) > (property) name"
]
},
"(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "code_interpreter"
}
},
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "file_search"
}
},
"(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",
"key": "max_num_results",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"minimum": 1,
"maximum": 50
},
"oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/file_search/properties/max_num_results",
"deprecated": 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",
"key": "ranking_options",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "score_threshold"
},
{
"ident": "ranker"
}
]
},
"oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/file_search/properties/ranking_options",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options > (property) score_threshold",
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options > (property) ranker"
]
},
"(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.",
"key": "name",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/FunctionObject/properties/name",
"deprecated": 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.",
"key": "description",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/FunctionObject/properties/description",
"deprecated": 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.",
"key": "parameters",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeReference",
"ident": "FunctionParameters",
"$ref": "(resource) $shared > (model) function_parameters > (schema)"
},
"oasRef": "#/components/schemas/FunctionObject/properties/parameters",
"deprecated": false,
"schemaType": "map",
"modelImplicit": false,
"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).",
"key": "strict",
"optional": true,
"nullable": true,
"default": false,
"type": {
"kind": "HttpTypeBoolean"
},
"oasRef": "#/components/schemas/FunctionObject/properties/strict",
"deprecated": false,
"schemaType": "boolean",
"children": []
},
"(resource) $shared > (model) function_definition > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/FunctionObject",
"ident": "FunctionDefinition",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "name"
},
{
"ident": "description"
},
{
"ident": "parameters"
},
{
"ident": "strict"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) $shared > (model) function_definition > (schema) > (property) name",
"(resource) $shared > (model) function_definition > (schema) > (property) description",
"(resource) $shared > (model) function_definition > (schema) > (property) parameters",
"(resource) $shared > (model) function_definition > (schema) > (property) strict"
]
},
"(resource) beta.assistants > (model) function_tool > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "function"
}
},
"(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.",
"key": "arguments",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunToolCallObject/properties/function/properties/arguments",
"deprecated": 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.",
"key": "name",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunToolCallObject/properties/function/properties/name",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "function"
}
},
"(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.",
"key": "score_threshold",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"minimum": 0,
"maximum": 1
},
"oasRef": "#/components/schemas/FileSearchRankingOptions/properties/score_threshold",
"deprecated": 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.",
"key": "ranker",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "auto"
},
{
"kind": "HttpTypeLiteral",
"literal": "default_2024_08_21"
}
],
"oasRef": "#/components/schemas/FileSearchRankingOptions/properties/ranker"
},
"oasRef": "#/components/schemas/FileSearchRankingOptions/properties/ranker",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options > (property) ranker > (member) 0",
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options > (property) ranker > (member) 1"
]
},
"(resource) $shared > (model) function_parameters > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/FunctionParameters",
"ident": "FunctionParameters",
"type": {
"kind": "HttpTypeReference",
"ident": "Record",
"typeParameters": [
{
"kind": "HttpTypeString"
},
{
"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": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "auto"
}
},
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options > (property) ranker > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "default_2024_08_21"
}
}
}
Example
{}
event
Occurs when a run is completed.
Schema
Schema name: (resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 5
{
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 5": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RunStreamEvent/oneOf/4",
"ident": "UnionMember5",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "data"
},
{
"ident": "event"
}
]
},
"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",
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 5 > (property) event"
]
},
"(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).",
"key": "data",
"optional": false,
"nullable": false,
"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",
"modelImplicit": false,
"modelPath": "(resource) beta.threads.runs > (model) run",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) id",
"(resource) beta.threads.runs > (model) run > (schema) > (property) assistant_id",
"(resource) beta.threads.runs > (model) run > (schema) > (property) cancelled_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) completed_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) created_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) expires_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) failed_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) incomplete_details",
"(resource) beta.threads.runs > (model) run > (schema) > (property) instructions",
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error",
"(resource) beta.threads.runs > (model) run > (schema) > (property) max_completion_tokens",
"(resource) beta.threads.runs > (model) run > (schema) > (property) max_prompt_tokens",
"(resource) beta.threads.runs > (model) run > (schema) > (property) metadata",
"(resource) beta.threads.runs > (model) run > (schema) > (property) model",
"(resource) beta.threads.runs > (model) run > (schema) > (property) object",
"(resource) beta.threads.runs > (model) run > (schema) > (property) parallel_tool_calls",
"(resource) beta.threads.runs > (model) run > (schema) > (property) required_action",
"(resource) beta.threads.runs > (model) run > (schema) > (property) response_format",
"(resource) beta.threads.runs > (model) run > (schema) > (property) started_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) status",
"(resource) beta.threads.runs > (model) run > (schema) > (property) thread_id",
"(resource) beta.threads.runs > (model) run > (schema) > (property) tool_choice",
"(resource) beta.threads.runs > (model) run > (schema) > (property) tools",
"(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy",
"(resource) beta.threads.runs > (model) run > (schema) > (property) usage",
"(resource) beta.threads.runs > (model) run > (schema) > (property) temperature",
"(resource) beta.threads.runs > (model) run > (schema) > (property) top_p"
]
},
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 5 > (property) event": {
"kind": "HttpDeclProperty",
"key": "event",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"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,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 5 > (property) event > (member) 0"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) id": {
"kind": "HttpDeclProperty",
"docstring": "The identifier, which can be referenced in API endpoints.",
"key": "id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunObject/properties/id",
"deprecated": 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.",
"key": "assistant_id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunObject/properties/assistant_id",
"deprecated": 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.",
"key": "cancelled_at",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/RunObject/properties/cancelled_at",
"deprecated": false,
"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.",
"key": "completed_at",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/RunObject/properties/completed_at",
"deprecated": false,
"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.",
"key": "created_at",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/RunObject/properties/created_at",
"deprecated": 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.",
"key": "expires_at",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/RunObject/properties/expires_at",
"deprecated": false,
"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.",
"key": "failed_at",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/RunObject/properties/failed_at",
"deprecated": false,
"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.",
"key": "incomplete_details",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "reason"
}
]
},
"oasRef": "#/components/schemas/RunObject/properties/incomplete_details",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) incomplete_details > (property) reason"
]
},
"(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.",
"key": "instructions",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunObject/properties/instructions",
"deprecated": 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.",
"key": "last_error",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "code"
},
{
"ident": "message"
}
]
},
"oasRef": "#/components/schemas/RunObject/properties/last_error",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) code",
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) message"
]
},
"(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",
"key": "max_completion_tokens",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"minimum": 256
},
"oasRef": "#/components/schemas/RunObject/properties/max_completion_tokens",
"deprecated": false,
"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",
"key": "max_prompt_tokens",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"minimum": 256
},
"oasRef": "#/components/schemas/RunObject/properties/max_prompt_tokens",
"deprecated": false,
"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",
"key": "metadata",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeReference",
"ident": "Metadata",
"$ref": "(resource) $shared > (model) metadata > (schema)"
},
"oasRef": "#/components/schemas/RunObject/properties/metadata",
"deprecated": false,
"schemaType": "map",
"modelImplicit": false,
"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.",
"key": "model",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunObject/properties/model",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) object": {
"kind": "HttpDeclProperty",
"docstring": "The object type, which is always `thread.run`.",
"key": "object",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "thread.run"
}
],
"oasRef": "#/components/schemas/RunObject/properties/object"
},
"oasRef": "#/components/schemas/RunObject/properties/object",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) object > (member) 0"
]
},
"(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.",
"key": "parallel_tool_calls",
"optional": false,
"nullable": false,
"default": true,
"type": {
"kind": "HttpTypeBoolean"
},
"oasRef": "#/components/schemas/RunObject/properties/parallel_tool_calls",
"deprecated": 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.",
"key": "required_action",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "submit_tool_outputs"
},
{
"ident": "type"
}
]
},
"oasRef": "#/components/schemas/RunObject/properties/required_action",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) required_action > (property) submit_tool_outputs",
"(resource) beta.threads.runs > (model) run > (schema) > (property) required_action > (property) type"
]
},
"(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",
"key": "response_format",
"optional": false,
"nullable": true,
"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",
"modelImplicit": false,
"modelPath": "(resource) beta.threads > (model) assistant_response_format_option",
"childrenParentSchema": "union",
"children": [
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 0",
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 1",
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 2",
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 3"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) started_at": {
"kind": "HttpDeclProperty",
"docstring": "The Unix timestamp (in seconds) for when the run was started.",
"key": "started_at",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/RunObject/properties/started_at",
"deprecated": false,
"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`.",
"key": "status",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "queued"
},
{
"kind": "HttpTypeLiteral",
"literal": "in_progress"
},
{
"kind": "HttpTypeLiteral",
"literal": "requires_action"
},
{
"kind": "HttpTypeLiteral",
"literal": "cancelling"
},
{
"kind": "HttpTypeLiteral",
"literal": "cancelled"
},
{
"kind": "HttpTypeLiteral",
"literal": "failed"
},
{
"kind": "HttpTypeLiteral",
"literal": "completed"
},
{
"kind": "HttpTypeLiteral",
"literal": "incomplete"
},
{
"kind": "HttpTypeLiteral",
"literal": "expired"
}
],
"oasRef": "#/components/schemas/RunObject/properties/status"
},
"oasRef": "#/components/schemas/RunObject/properties/status",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 0",
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 1",
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 2",
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 3",
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 4",
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 5",
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 6",
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 7",
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 8"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) thread_id": {
"kind": "HttpDeclProperty",
"docstring": "The ID of the [thread](/docs/api-reference/threads) that was executed on as a part of this run.",
"key": "thread_id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunObject/properties/thread_id",
"deprecated": 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",
"key": "tool_choice",
"optional": false,
"nullable": true,
"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",
"modelImplicit": false,
"modelPath": "(resource) beta.threads > (model) assistant_tool_choice_option",
"childrenParentSchema": "union",
"children": [
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0",
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 1"
]
},
"(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.",
"key": "tools",
"optional": false,
"nullable": false,
"default": [],
"type": {
"kind": "HttpTypeArray",
"elementType": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeReference",
"ident": "CodeInterpreterTool",
"$ref": "(resource) beta.assistants > (model) code_interpreter_tool > (schema)"
},
{
"kind": "HttpTypeReference",
"ident": "FileSearchTool",
"$ref": "(resource) beta.assistants > (model) file_search_tool > (schema)"
},
{
"kind": "HttpTypeReference",
"ident": "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,
"schemaType": "array",
"childrenParentSchema": "union",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 0",
"(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 1",
"(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 2"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy": {
"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.",
"key": "truncation_strategy",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
},
{
"ident": "last_messages"
}
]
},
"oasRef": "#/components/schemas/RunObject/properties/truncation_strategy",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) type",
"(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) last_messages"
]
},
"(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.).",
"key": "usage",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "completion_tokens"
},
{
"ident": "prompt_tokens"
},
{
"ident": "total_tokens"
}
]
},
"oasRef": "#/components/schemas/RunObject/properties/usage",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) usage > (property) completion_tokens",
"(resource) beta.threads.runs > (model) run > (schema) > (property) usage > (property) prompt_tokens",
"(resource) beta.threads.runs > (model) run > (schema) > (property) usage > (property) total_tokens"
]
},
"(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.",
"key": "temperature",
"optional": true,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"oasRef": "#/components/schemas/RunObject/properties/temperature",
"deprecated": false,
"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.",
"key": "top_p",
"optional": true,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"oasRef": "#/components/schemas/RunObject/properties/top_p",
"deprecated": false,
"schemaType": "number",
"children": []
},
"(resource) beta.threads.runs > (model) run > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RunObject",
"ident": "Run",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "id"
},
{
"ident": "assistant_id"
},
{
"ident": "cancelled_at"
},
{
"ident": "completed_at"
},
{
"ident": "created_at"
},
{
"ident": "expires_at"
},
{
"ident": "failed_at"
},
{
"ident": "incomplete_details"
},
{
"ident": "instructions"
},
{
"ident": "last_error"
},
{
"ident": "max_completion_tokens"
},
{
"ident": "max_prompt_tokens"
},
{
"ident": "metadata"
},
{
"ident": "model"
},
{
"ident": "object"
},
{
"ident": "parallel_tool_calls"
},
{
"ident": "required_action"
},
{
"ident": "response_format"
},
{
"ident": "started_at"
},
{
"ident": "status"
},
{
"ident": "thread_id"
},
{
"ident": "tool_choice"
},
{
"ident": "tools"
},
{
"ident": "truncation_strategy"
},
{
"ident": "usage"
},
{
"ident": "temperature"
},
{
"ident": "top_p"
}
]
},
"docstring": "Represents an execution run on a [thread](/docs/api-reference/threads).",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) id",
"(resource) beta.threads.runs > (model) run > (schema) > (property) assistant_id",
"(resource) beta.threads.runs > (model) run > (schema) > (property) cancelled_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) completed_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) created_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) expires_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) failed_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) incomplete_details",
"(resource) beta.threads.runs > (model) run > (schema) > (property) instructions",
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error",
"(resource) beta.threads.runs > (model) run > (schema) > (property) max_completion_tokens",
"(resource) beta.threads.runs > (model) run > (schema) > (property) max_prompt_tokens",
"(resource) beta.threads.runs > (model) run > (schema) > (property) metadata",
"(resource) beta.threads.runs > (model) run > (schema) > (property) model",
"(resource) beta.threads.runs > (model) run > (schema) > (property) object",
"(resource) beta.threads.runs > (model) run > (schema) > (property) parallel_tool_calls",
"(resource) beta.threads.runs > (model) run > (schema) > (property) required_action",
"(resource) beta.threads.runs > (model) run > (schema) > (property) response_format",
"(resource) beta.threads.runs > (model) run > (schema) > (property) started_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) status",
"(resource) beta.threads.runs > (model) run > (schema) > (property) thread_id",
"(resource) beta.threads.runs > (model) run > (schema) > (property) tool_choice",
"(resource) beta.threads.runs > (model) run > (schema) > (property) tools",
"(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy",
"(resource) beta.threads.runs > (model) run > (schema) > (property) usage",
"(resource) beta.threads.runs > (model) run > (schema) > (property) temperature",
"(resource) beta.threads.runs > (model) run > (schema) > (property) top_p"
]
},
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 5 > (property) event > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "thread.run.completed"
}
},
"(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.",
"key": "reason",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "max_completion_tokens"
},
{
"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,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) incomplete_details > (property) reason > (member) 0",
"(resource) beta.threads.runs > (model) run > (schema) > (property) incomplete_details > (property) reason > (member) 1"
]
},
"(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`.",
"key": "code",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "server_error"
},
{
"kind": "HttpTypeLiteral",
"literal": "rate_limit_exceeded"
},
{
"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,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) code > (member) 0",
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) code > (member) 1",
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) code > (member) 2"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) message": {
"kind": "HttpDeclProperty",
"docstring": "A human-readable description of the error.",
"key": "message",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunObject/properties/last_error/properties/message",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) $shared > (model) metadata > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/Metadata",
"ident": "Metadata",
"type": {
"kind": "HttpTypeReference",
"ident": "Record",
"typeParameters": [
{
"kind": "HttpTypeString"
},
{
"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": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "thread.run"
}
},
"(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.",
"key": "submit_tool_outputs",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "tool_calls"
}
]
},
"oasRef": "#/components/schemas/RunObject/properties/required_action/properties/submit_tool_outputs",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) required_action > (property) submit_tool_outputs > (property) tool_calls"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) required_action > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "For now, this is always `submit_tool_outputs`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"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,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) required_action > (property) type > (member) 0"
]
},
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 0": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/oneOf/0",
"ident": "UnionMember0",
"type": {
"kind": "HttpTypeUnion",
"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"
]
},
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "ResponseFormatText",
"$ref": "(resource) $shared > (model) response_format_text > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) $shared > (model) response_format_text > (schema) > (property) type"
]
},
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "ResponseFormatJSONObject",
"$ref": "(resource) $shared > (model) response_format_json_object > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) $shared > (model) response_format_json_object > (schema) > (property) type"
]
},
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 3": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "ResponseFormatJSONSchema",
"$ref": "(resource) $shared > (model) response_format_json_schema > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema",
"(resource) $shared > (model) response_format_json_schema > (schema) > (property) type"
]
},
"(resource) beta.threads > (model) assistant_response_format_option > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/AssistantsApiResponseFormatOption",
"ident": "AssistantResponseFormatOption",
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "auto"
}
],
"oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/oneOf/0"
},
{
"kind": "HttpTypeReference",
"ident": "ResponseFormatText",
"$ref": "(resource) $shared > (model) response_format_text > (schema)"
},
{
"kind": "HttpTypeReference",
"ident": "ResponseFormatJSONObject",
"$ref": "(resource) $shared > (model) response_format_json_object > (schema)"
},
{
"kind": "HttpTypeReference",
"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",
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 1",
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 2",
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 3"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "queued"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "in_progress"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "requires_action"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 3": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "cancelling"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 4": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "cancelled"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 5": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "failed"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 6": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "completed"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 7": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "incomplete"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 8": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "expired"
}
},
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/AssistantsApiToolChoiceOption/oneOf/0",
"ident": "UnionMember0",
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "none"
},
{
"kind": "HttpTypeLiteral",
"literal": "auto"
},
{
"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",
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0 > (member) 1",
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0 > (member) 2"
]
},
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "AssistantToolChoice",
"$ref": "(resource) beta.threads > (model) assistant_tool_choice > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) type",
"(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) function"
]
},
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/AssistantsApiToolChoiceOption",
"ident": "AssistantToolChoiceOption",
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "none"
},
{
"kind": "HttpTypeLiteral",
"literal": "auto"
},
{
"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",
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 1"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "CodeInterpreterTool",
"$ref": "(resource) beta.assistants > (model) code_interpreter_tool > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "FileSearchTool",
"$ref": "(resource) beta.assistants > (model) file_search_tool > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) type",
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "FunctionTool",
"$ref": "(resource) beta.assistants > (model) function_tool > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.assistants > (model) function_tool > (schema) > (property) function",
"(resource) beta.assistants > (model) function_tool > (schema) > (property) type"
]
},
"(resource) beta.assistants > (model) code_interpreter_tool > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/AssistantToolsCode",
"ident": "CodeInterpreterTool",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type"
]
},
"(resource) beta.assistants > (model) file_search_tool > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/AssistantToolsFileSearch",
"ident": "FileSearchTool",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
},
{
"ident": "file_search"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) type",
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search"
]
},
"(resource) beta.assistants > (model) function_tool > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/AssistantToolsFunction",
"ident": "FunctionTool",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "function"
},
{
"ident": "type"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.assistants > (model) function_tool > (schema) > (property) function",
"(resource) beta.assistants > (model) function_tool > (schema) > (property) type"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) type": {
"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`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "auto"
},
{
"kind": "HttpTypeLiteral",
"literal": "last_messages"
}
],
"oasRef": "#/components/schemas/TruncationObject/properties/type"
},
"oasRef": "#/components/schemas/TruncationObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) type > (member) 0",
"(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) type > (member) 1"
]
},
"(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.",
"key": "last_messages",
"optional": true,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"minimum": 1
},
"oasRef": "#/components/schemas/TruncationObject/properties/last_messages",
"deprecated": false,
"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.",
"key": "completion_tokens",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"oasRef": "#/components/schemas/RunCompletionUsage/anyOf/0/properties/completion_tokens",
"deprecated": 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.",
"key": "prompt_tokens",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"oasRef": "#/components/schemas/RunCompletionUsage/anyOf/0/properties/prompt_tokens",
"deprecated": 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).",
"key": "total_tokens",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"oasRef": "#/components/schemas/RunCompletionUsage/anyOf/0/properties/total_tokens",
"deprecated": false,
"schemaType": "integer",
"children": []
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) incomplete_details > (property) reason > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "max_completion_tokens"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) incomplete_details > (property) reason > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "max_prompt_tokens"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) code > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "server_error"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) code > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "rate_limit_exceeded"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) code > (member) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "invalid_prompt"
}
},
"(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.",
"key": "tool_calls",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeArray",
"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,
"schemaType": "array",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) id",
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) function",
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) type"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) required_action > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "submit_tool_outputs"
}
},
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 0 > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "auto"
}
},
"(resource) $shared > (model) response_format_text > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The type of response format being defined. Always `text`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "text"
}
],
"oasRef": "#/components/schemas/ResponseFormatText/properties/type"
},
"oasRef": "#/components/schemas/ResponseFormatText/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) $shared > (model) response_format_text > (schema) > (property) type > (member) 0"
]
},
"(resource) $shared > (model) response_format_text > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/ResponseFormatText",
"ident": "ResponseFormatText",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
}
]
},
"docstring": "Default response format. Used to generate text responses.\n",
"childrenParentSchema": "object",
"children": [
"(resource) $shared > (model) response_format_text > (schema) > (property) type"
]
},
"(resource) $shared > (model) response_format_json_object > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The type of response format being defined. Always `json_object`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "json_object"
}
],
"oasRef": "#/components/schemas/ResponseFormatJsonObject/properties/type"
},
"oasRef": "#/components/schemas/ResponseFormatJsonObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) $shared > (model) response_format_json_object > (schema) > (property) type > (member) 0"
]
},
"(resource) $shared > (model) response_format_json_object > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/ResponseFormatJsonObject",
"ident": "ResponseFormatJSONObject",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
}
]
},
"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"
]
},
"(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",
"key": "json_schema",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "name"
},
{
"ident": "description"
},
{
"ident": "schema"
},
{
"ident": "strict"
}
]
},
"oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema > (property) name",
"(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema > (property) description",
"(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema > (property) schema",
"(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema > (property) strict"
]
},
"(resource) $shared > (model) response_format_json_schema > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The type of response format being defined. Always `json_schema`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "json_schema"
}
],
"oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/type"
},
"oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) $shared > (model) response_format_json_schema > (schema) > (property) type > (member) 0"
]
},
"(resource) $shared > (model) response_format_json_schema > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/ResponseFormatJsonSchema",
"ident": "ResponseFormatJSONSchema",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "json_schema"
},
{
"ident": "type"
}
]
},
"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",
"(resource) $shared > (model) response_format_json_schema > (schema) > (property) type"
]
},
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0 > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "none"
}
},
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0 > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "auto"
}
},
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0 > (member) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "required"
}
},
"(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",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "function"
},
{
"kind": "HttpTypeLiteral",
"literal": "code_interpreter"
},
{
"kind": "HttpTypeLiteral",
"literal": "file_search"
}
],
"oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/type"
},
"oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) type > (member) 0",
"(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) type > (member) 1",
"(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) type > (member) 2"
]
},
"(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) function": {
"kind": "HttpDeclProperty",
"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",
"modelImplicit": false,
"modelPath": "(resource) beta.threads > (model) assistant_tool_choice_function",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads > (model) assistant_tool_choice_function > (schema) > (property) name"
]
},
"(resource) beta.threads > (model) assistant_tool_choice > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/AssistantsNamedToolChoice",
"ident": "AssistantToolChoice",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
},
{
"ident": "function"
}
]
},
"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",
"(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) function"
]
},
"(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The type of tool being defined: `code_interpreter`",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "code_interpreter"
}
],
"oasRef": "#/components/schemas/AssistantToolsCode/properties/type"
},
"oasRef": "#/components/schemas/AssistantToolsCode/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type > (member) 0"
]
},
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The type of tool being defined: `file_search`",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "file_search"
}
],
"oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/type"
},
"oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) type > (member) 0"
]
},
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search": {
"kind": "HttpDeclProperty",
"docstring": "Overrides for the file search tool.",
"key": "file_search",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "max_num_results"
},
{
"ident": "ranking_options"
}
]
},
"oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/file_search",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) max_num_results",
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options"
]
},
"(resource) beta.assistants > (model) function_tool > (schema) > (property) function": {
"kind": "HttpDeclProperty",
"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",
"modelImplicit": false,
"modelPath": "(resource) $shared > (model) function_definition",
"childrenParentSchema": "object",
"children": [
"(resource) $shared > (model) function_definition > (schema) > (property) name",
"(resource) $shared > (model) function_definition > (schema) > (property) description",
"(resource) $shared > (model) function_definition > (schema) > (property) parameters",
"(resource) $shared > (model) function_definition > (schema) > (property) strict"
]
},
"(resource) beta.assistants > (model) function_tool > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The type of tool being defined: `function`",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "function"
}
],
"oasRef": "#/components/schemas/AssistantToolsFunction/properties/type"
},
"oasRef": "#/components/schemas/AssistantToolsFunction/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.assistants > (model) function_tool > (schema) > (property) type > (member) 0"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "auto"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) type > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "last_messages"
}
},
"(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.",
"key": "id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunToolCallObject/properties/id",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) function": {
"kind": "HttpDeclProperty",
"docstring": "The function definition.",
"key": "function",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "arguments"
},
{
"ident": "name"
}
]
},
"oasRef": "#/components/schemas/RunToolCallObject/properties/function",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) function > (property) arguments",
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) function > (property) name"
]
},
"(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`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "function"
}
],
"oasRef": "#/components/schemas/RunToolCallObject/properties/type"
},
"oasRef": "#/components/schemas/RunToolCallObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) type > (member) 0"
]
},
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RunToolCallObject",
"ident": "RequiredActionFunctionToolCall",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "id"
},
{
"ident": "function"
},
{
"ident": "type"
}
]
},
"docstring": "Tool call objects",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) id",
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) function",
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) type"
]
},
"(resource) $shared > (model) response_format_text > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "text"
}
},
"(resource) $shared > (model) response_format_json_object > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "json_object"
}
},
"(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",
"key": "name",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/name",
"deprecated": 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",
"key": "description",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/description",
"deprecated": 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",
"key": "schema",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeReference",
"ident": "Record",
"typeParameters": [
{
"kind": "HttpTypeString"
},
{
"kind": "HttpTypeUnknown"
}
],
"oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/schema"
},
"oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/schema",
"deprecated": 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",
"key": "strict",
"optional": true,
"nullable": true,
"default": false,
"type": {
"kind": "HttpTypeBoolean"
},
"oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/strict",
"deprecated": false,
"schemaType": "boolean",
"children": []
},
"(resource) $shared > (model) response_format_json_schema > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "json_schema"
}
},
"(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "function"
}
},
"(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) type > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "code_interpreter"
}
},
"(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) type > (member) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "file_search"
}
},
"(resource) beta.threads > (model) assistant_tool_choice_function > (schema) > (property) name": {
"kind": "HttpDeclProperty",
"docstring": "The name of the function to call.",
"key": "name",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/function/properties/name",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads > (model) assistant_tool_choice_function > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/function",
"ident": "AssistantToolChoiceFunction",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "name"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads > (model) assistant_tool_choice_function > (schema) > (property) name"
]
},
"(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "code_interpreter"
}
},
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "file_search"
}
},
"(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",
"key": "max_num_results",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"minimum": 1,
"maximum": 50
},
"oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/file_search/properties/max_num_results",
"deprecated": 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",
"key": "ranking_options",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "score_threshold"
},
{
"ident": "ranker"
}
]
},
"oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/file_search/properties/ranking_options",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options > (property) score_threshold",
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options > (property) ranker"
]
},
"(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.",
"key": "name",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/FunctionObject/properties/name",
"deprecated": 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.",
"key": "description",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/FunctionObject/properties/description",
"deprecated": 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.",
"key": "parameters",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeReference",
"ident": "FunctionParameters",
"$ref": "(resource) $shared > (model) function_parameters > (schema)"
},
"oasRef": "#/components/schemas/FunctionObject/properties/parameters",
"deprecated": false,
"schemaType": "map",
"modelImplicit": false,
"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).",
"key": "strict",
"optional": true,
"nullable": true,
"default": false,
"type": {
"kind": "HttpTypeBoolean"
},
"oasRef": "#/components/schemas/FunctionObject/properties/strict",
"deprecated": false,
"schemaType": "boolean",
"children": []
},
"(resource) $shared > (model) function_definition > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/FunctionObject",
"ident": "FunctionDefinition",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "name"
},
{
"ident": "description"
},
{
"ident": "parameters"
},
{
"ident": "strict"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) $shared > (model) function_definition > (schema) > (property) name",
"(resource) $shared > (model) function_definition > (schema) > (property) description",
"(resource) $shared > (model) function_definition > (schema) > (property) parameters",
"(resource) $shared > (model) function_definition > (schema) > (property) strict"
]
},
"(resource) beta.assistants > (model) function_tool > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "function"
}
},
"(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.",
"key": "arguments",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunToolCallObject/properties/function/properties/arguments",
"deprecated": 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.",
"key": "name",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunToolCallObject/properties/function/properties/name",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "function"
}
},
"(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.",
"key": "score_threshold",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"minimum": 0,
"maximum": 1
},
"oasRef": "#/components/schemas/FileSearchRankingOptions/properties/score_threshold",
"deprecated": 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.",
"key": "ranker",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "auto"
},
{
"kind": "HttpTypeLiteral",
"literal": "default_2024_08_21"
}
],
"oasRef": "#/components/schemas/FileSearchRankingOptions/properties/ranker"
},
"oasRef": "#/components/schemas/FileSearchRankingOptions/properties/ranker",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options > (property) ranker > (member) 0",
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options > (property) ranker > (member) 1"
]
},
"(resource) $shared > (model) function_parameters > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/FunctionParameters",
"ident": "FunctionParameters",
"type": {
"kind": "HttpTypeReference",
"ident": "Record",
"typeParameters": [
{
"kind": "HttpTypeString"
},
{
"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": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "auto"
}
},
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options > (property) ranker > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "default_2024_08_21"
}
}
}
Example
{}
event
Occurs when a run ends with status incomplete.
Schema
Schema name: (resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 6
{
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 6": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RunStreamEvent/oneOf/5",
"ident": "UnionMember6",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "data"
},
{
"ident": "event"
}
]
},
"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",
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 6 > (property) event"
]
},
"(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).",
"key": "data",
"optional": false,
"nullable": false,
"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",
"modelImplicit": false,
"modelPath": "(resource) beta.threads.runs > (model) run",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) id",
"(resource) beta.threads.runs > (model) run > (schema) > (property) assistant_id",
"(resource) beta.threads.runs > (model) run > (schema) > (property) cancelled_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) completed_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) created_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) expires_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) failed_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) incomplete_details",
"(resource) beta.threads.runs > (model) run > (schema) > (property) instructions",
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error",
"(resource) beta.threads.runs > (model) run > (schema) > (property) max_completion_tokens",
"(resource) beta.threads.runs > (model) run > (schema) > (property) max_prompt_tokens",
"(resource) beta.threads.runs > (model) run > (schema) > (property) metadata",
"(resource) beta.threads.runs > (model) run > (schema) > (property) model",
"(resource) beta.threads.runs > (model) run > (schema) > (property) object",
"(resource) beta.threads.runs > (model) run > (schema) > (property) parallel_tool_calls",
"(resource) beta.threads.runs > (model) run > (schema) > (property) required_action",
"(resource) beta.threads.runs > (model) run > (schema) > (property) response_format",
"(resource) beta.threads.runs > (model) run > (schema) > (property) started_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) status",
"(resource) beta.threads.runs > (model) run > (schema) > (property) thread_id",
"(resource) beta.threads.runs > (model) run > (schema) > (property) tool_choice",
"(resource) beta.threads.runs > (model) run > (schema) > (property) tools",
"(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy",
"(resource) beta.threads.runs > (model) run > (schema) > (property) usage",
"(resource) beta.threads.runs > (model) run > (schema) > (property) temperature",
"(resource) beta.threads.runs > (model) run > (schema) > (property) top_p"
]
},
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 6 > (property) event": {
"kind": "HttpDeclProperty",
"key": "event",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"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,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 6 > (property) event > (member) 0"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) id": {
"kind": "HttpDeclProperty",
"docstring": "The identifier, which can be referenced in API endpoints.",
"key": "id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunObject/properties/id",
"deprecated": 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.",
"key": "assistant_id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunObject/properties/assistant_id",
"deprecated": 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.",
"key": "cancelled_at",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/RunObject/properties/cancelled_at",
"deprecated": false,
"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.",
"key": "completed_at",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/RunObject/properties/completed_at",
"deprecated": false,
"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.",
"key": "created_at",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/RunObject/properties/created_at",
"deprecated": 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.",
"key": "expires_at",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/RunObject/properties/expires_at",
"deprecated": false,
"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.",
"key": "failed_at",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/RunObject/properties/failed_at",
"deprecated": false,
"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.",
"key": "incomplete_details",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "reason"
}
]
},
"oasRef": "#/components/schemas/RunObject/properties/incomplete_details",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) incomplete_details > (property) reason"
]
},
"(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.",
"key": "instructions",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunObject/properties/instructions",
"deprecated": 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.",
"key": "last_error",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "code"
},
{
"ident": "message"
}
]
},
"oasRef": "#/components/schemas/RunObject/properties/last_error",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) code",
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) message"
]
},
"(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",
"key": "max_completion_tokens",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"minimum": 256
},
"oasRef": "#/components/schemas/RunObject/properties/max_completion_tokens",
"deprecated": false,
"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",
"key": "max_prompt_tokens",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"minimum": 256
},
"oasRef": "#/components/schemas/RunObject/properties/max_prompt_tokens",
"deprecated": false,
"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",
"key": "metadata",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeReference",
"ident": "Metadata",
"$ref": "(resource) $shared > (model) metadata > (schema)"
},
"oasRef": "#/components/schemas/RunObject/properties/metadata",
"deprecated": false,
"schemaType": "map",
"modelImplicit": false,
"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.",
"key": "model",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunObject/properties/model",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) object": {
"kind": "HttpDeclProperty",
"docstring": "The object type, which is always `thread.run`.",
"key": "object",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "thread.run"
}
],
"oasRef": "#/components/schemas/RunObject/properties/object"
},
"oasRef": "#/components/schemas/RunObject/properties/object",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) object > (member) 0"
]
},
"(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.",
"key": "parallel_tool_calls",
"optional": false,
"nullable": false,
"default": true,
"type": {
"kind": "HttpTypeBoolean"
},
"oasRef": "#/components/schemas/RunObject/properties/parallel_tool_calls",
"deprecated": 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.",
"key": "required_action",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "submit_tool_outputs"
},
{
"ident": "type"
}
]
},
"oasRef": "#/components/schemas/RunObject/properties/required_action",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) required_action > (property) submit_tool_outputs",
"(resource) beta.threads.runs > (model) run > (schema) > (property) required_action > (property) type"
]
},
"(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",
"key": "response_format",
"optional": false,
"nullable": true,
"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",
"modelImplicit": false,
"modelPath": "(resource) beta.threads > (model) assistant_response_format_option",
"childrenParentSchema": "union",
"children": [
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 0",
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 1",
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 2",
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 3"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) started_at": {
"kind": "HttpDeclProperty",
"docstring": "The Unix timestamp (in seconds) for when the run was started.",
"key": "started_at",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/RunObject/properties/started_at",
"deprecated": false,
"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`.",
"key": "status",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "queued"
},
{
"kind": "HttpTypeLiteral",
"literal": "in_progress"
},
{
"kind": "HttpTypeLiteral",
"literal": "requires_action"
},
{
"kind": "HttpTypeLiteral",
"literal": "cancelling"
},
{
"kind": "HttpTypeLiteral",
"literal": "cancelled"
},
{
"kind": "HttpTypeLiteral",
"literal": "failed"
},
{
"kind": "HttpTypeLiteral",
"literal": "completed"
},
{
"kind": "HttpTypeLiteral",
"literal": "incomplete"
},
{
"kind": "HttpTypeLiteral",
"literal": "expired"
}
],
"oasRef": "#/components/schemas/RunObject/properties/status"
},
"oasRef": "#/components/schemas/RunObject/properties/status",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 0",
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 1",
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 2",
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 3",
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 4",
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 5",
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 6",
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 7",
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 8"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) thread_id": {
"kind": "HttpDeclProperty",
"docstring": "The ID of the [thread](/docs/api-reference/threads) that was executed on as a part of this run.",
"key": "thread_id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunObject/properties/thread_id",
"deprecated": 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",
"key": "tool_choice",
"optional": false,
"nullable": true,
"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",
"modelImplicit": false,
"modelPath": "(resource) beta.threads > (model) assistant_tool_choice_option",
"childrenParentSchema": "union",
"children": [
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0",
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 1"
]
},
"(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.",
"key": "tools",
"optional": false,
"nullable": false,
"default": [],
"type": {
"kind": "HttpTypeArray",
"elementType": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeReference",
"ident": "CodeInterpreterTool",
"$ref": "(resource) beta.assistants > (model) code_interpreter_tool > (schema)"
},
{
"kind": "HttpTypeReference",
"ident": "FileSearchTool",
"$ref": "(resource) beta.assistants > (model) file_search_tool > (schema)"
},
{
"kind": "HttpTypeReference",
"ident": "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,
"schemaType": "array",
"childrenParentSchema": "union",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 0",
"(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 1",
"(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 2"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy": {
"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.",
"key": "truncation_strategy",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
},
{
"ident": "last_messages"
}
]
},
"oasRef": "#/components/schemas/RunObject/properties/truncation_strategy",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) type",
"(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) last_messages"
]
},
"(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.).",
"key": "usage",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "completion_tokens"
},
{
"ident": "prompt_tokens"
},
{
"ident": "total_tokens"
}
]
},
"oasRef": "#/components/schemas/RunObject/properties/usage",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) usage > (property) completion_tokens",
"(resource) beta.threads.runs > (model) run > (schema) > (property) usage > (property) prompt_tokens",
"(resource) beta.threads.runs > (model) run > (schema) > (property) usage > (property) total_tokens"
]
},
"(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.",
"key": "temperature",
"optional": true,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"oasRef": "#/components/schemas/RunObject/properties/temperature",
"deprecated": false,
"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.",
"key": "top_p",
"optional": true,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"oasRef": "#/components/schemas/RunObject/properties/top_p",
"deprecated": false,
"schemaType": "number",
"children": []
},
"(resource) beta.threads.runs > (model) run > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RunObject",
"ident": "Run",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "id"
},
{
"ident": "assistant_id"
},
{
"ident": "cancelled_at"
},
{
"ident": "completed_at"
},
{
"ident": "created_at"
},
{
"ident": "expires_at"
},
{
"ident": "failed_at"
},
{
"ident": "incomplete_details"
},
{
"ident": "instructions"
},
{
"ident": "last_error"
},
{
"ident": "max_completion_tokens"
},
{
"ident": "max_prompt_tokens"
},
{
"ident": "metadata"
},
{
"ident": "model"
},
{
"ident": "object"
},
{
"ident": "parallel_tool_calls"
},
{
"ident": "required_action"
},
{
"ident": "response_format"
},
{
"ident": "started_at"
},
{
"ident": "status"
},
{
"ident": "thread_id"
},
{
"ident": "tool_choice"
},
{
"ident": "tools"
},
{
"ident": "truncation_strategy"
},
{
"ident": "usage"
},
{
"ident": "temperature"
},
{
"ident": "top_p"
}
]
},
"docstring": "Represents an execution run on a [thread](/docs/api-reference/threads).",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) id",
"(resource) beta.threads.runs > (model) run > (schema) > (property) assistant_id",
"(resource) beta.threads.runs > (model) run > (schema) > (property) cancelled_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) completed_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) created_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) expires_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) failed_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) incomplete_details",
"(resource) beta.threads.runs > (model) run > (schema) > (property) instructions",
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error",
"(resource) beta.threads.runs > (model) run > (schema) > (property) max_completion_tokens",
"(resource) beta.threads.runs > (model) run > (schema) > (property) max_prompt_tokens",
"(resource) beta.threads.runs > (model) run > (schema) > (property) metadata",
"(resource) beta.threads.runs > (model) run > (schema) > (property) model",
"(resource) beta.threads.runs > (model) run > (schema) > (property) object",
"(resource) beta.threads.runs > (model) run > (schema) > (property) parallel_tool_calls",
"(resource) beta.threads.runs > (model) run > (schema) > (property) required_action",
"(resource) beta.threads.runs > (model) run > (schema) > (property) response_format",
"(resource) beta.threads.runs > (model) run > (schema) > (property) started_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) status",
"(resource) beta.threads.runs > (model) run > (schema) > (property) thread_id",
"(resource) beta.threads.runs > (model) run > (schema) > (property) tool_choice",
"(resource) beta.threads.runs > (model) run > (schema) > (property) tools",
"(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy",
"(resource) beta.threads.runs > (model) run > (schema) > (property) usage",
"(resource) beta.threads.runs > (model) run > (schema) > (property) temperature",
"(resource) beta.threads.runs > (model) run > (schema) > (property) top_p"
]
},
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 6 > (property) event > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "thread.run.incomplete"
}
},
"(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.",
"key": "reason",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "max_completion_tokens"
},
{
"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,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) incomplete_details > (property) reason > (member) 0",
"(resource) beta.threads.runs > (model) run > (schema) > (property) incomplete_details > (property) reason > (member) 1"
]
},
"(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`.",
"key": "code",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "server_error"
},
{
"kind": "HttpTypeLiteral",
"literal": "rate_limit_exceeded"
},
{
"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,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) code > (member) 0",
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) code > (member) 1",
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) code > (member) 2"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) message": {
"kind": "HttpDeclProperty",
"docstring": "A human-readable description of the error.",
"key": "message",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunObject/properties/last_error/properties/message",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) $shared > (model) metadata > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/Metadata",
"ident": "Metadata",
"type": {
"kind": "HttpTypeReference",
"ident": "Record",
"typeParameters": [
{
"kind": "HttpTypeString"
},
{
"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": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "thread.run"
}
},
"(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.",
"key": "submit_tool_outputs",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "tool_calls"
}
]
},
"oasRef": "#/components/schemas/RunObject/properties/required_action/properties/submit_tool_outputs",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) required_action > (property) submit_tool_outputs > (property) tool_calls"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) required_action > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "For now, this is always `submit_tool_outputs`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"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,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) required_action > (property) type > (member) 0"
]
},
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 0": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/oneOf/0",
"ident": "UnionMember0",
"type": {
"kind": "HttpTypeUnion",
"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"
]
},
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "ResponseFormatText",
"$ref": "(resource) $shared > (model) response_format_text > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) $shared > (model) response_format_text > (schema) > (property) type"
]
},
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "ResponseFormatJSONObject",
"$ref": "(resource) $shared > (model) response_format_json_object > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) $shared > (model) response_format_json_object > (schema) > (property) type"
]
},
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 3": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "ResponseFormatJSONSchema",
"$ref": "(resource) $shared > (model) response_format_json_schema > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema",
"(resource) $shared > (model) response_format_json_schema > (schema) > (property) type"
]
},
"(resource) beta.threads > (model) assistant_response_format_option > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/AssistantsApiResponseFormatOption",
"ident": "AssistantResponseFormatOption",
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "auto"
}
],
"oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/oneOf/0"
},
{
"kind": "HttpTypeReference",
"ident": "ResponseFormatText",
"$ref": "(resource) $shared > (model) response_format_text > (schema)"
},
{
"kind": "HttpTypeReference",
"ident": "ResponseFormatJSONObject",
"$ref": "(resource) $shared > (model) response_format_json_object > (schema)"
},
{
"kind": "HttpTypeReference",
"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",
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 1",
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 2",
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 3"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "queued"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "in_progress"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "requires_action"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 3": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "cancelling"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 4": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "cancelled"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 5": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "failed"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 6": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "completed"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 7": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "incomplete"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 8": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "expired"
}
},
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/AssistantsApiToolChoiceOption/oneOf/0",
"ident": "UnionMember0",
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "none"
},
{
"kind": "HttpTypeLiteral",
"literal": "auto"
},
{
"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",
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0 > (member) 1",
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0 > (member) 2"
]
},
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "AssistantToolChoice",
"$ref": "(resource) beta.threads > (model) assistant_tool_choice > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) type",
"(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) function"
]
},
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/AssistantsApiToolChoiceOption",
"ident": "AssistantToolChoiceOption",
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "none"
},
{
"kind": "HttpTypeLiteral",
"literal": "auto"
},
{
"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",
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 1"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "CodeInterpreterTool",
"$ref": "(resource) beta.assistants > (model) code_interpreter_tool > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "FileSearchTool",
"$ref": "(resource) beta.assistants > (model) file_search_tool > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) type",
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "FunctionTool",
"$ref": "(resource) beta.assistants > (model) function_tool > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.assistants > (model) function_tool > (schema) > (property) function",
"(resource) beta.assistants > (model) function_tool > (schema) > (property) type"
]
},
"(resource) beta.assistants > (model) code_interpreter_tool > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/AssistantToolsCode",
"ident": "CodeInterpreterTool",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type"
]
},
"(resource) beta.assistants > (model) file_search_tool > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/AssistantToolsFileSearch",
"ident": "FileSearchTool",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
},
{
"ident": "file_search"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) type",
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search"
]
},
"(resource) beta.assistants > (model) function_tool > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/AssistantToolsFunction",
"ident": "FunctionTool",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "function"
},
{
"ident": "type"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.assistants > (model) function_tool > (schema) > (property) function",
"(resource) beta.assistants > (model) function_tool > (schema) > (property) type"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) type": {
"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`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "auto"
},
{
"kind": "HttpTypeLiteral",
"literal": "last_messages"
}
],
"oasRef": "#/components/schemas/TruncationObject/properties/type"
},
"oasRef": "#/components/schemas/TruncationObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) type > (member) 0",
"(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) type > (member) 1"
]
},
"(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.",
"key": "last_messages",
"optional": true,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"minimum": 1
},
"oasRef": "#/components/schemas/TruncationObject/properties/last_messages",
"deprecated": false,
"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.",
"key": "completion_tokens",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"oasRef": "#/components/schemas/RunCompletionUsage/anyOf/0/properties/completion_tokens",
"deprecated": 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.",
"key": "prompt_tokens",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"oasRef": "#/components/schemas/RunCompletionUsage/anyOf/0/properties/prompt_tokens",
"deprecated": 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).",
"key": "total_tokens",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"oasRef": "#/components/schemas/RunCompletionUsage/anyOf/0/properties/total_tokens",
"deprecated": false,
"schemaType": "integer",
"children": []
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) incomplete_details > (property) reason > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "max_completion_tokens"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) incomplete_details > (property) reason > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "max_prompt_tokens"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) code > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "server_error"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) code > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "rate_limit_exceeded"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) code > (member) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "invalid_prompt"
}
},
"(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.",
"key": "tool_calls",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeArray",
"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,
"schemaType": "array",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) id",
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) function",
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) type"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) required_action > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "submit_tool_outputs"
}
},
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 0 > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "auto"
}
},
"(resource) $shared > (model) response_format_text > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The type of response format being defined. Always `text`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "text"
}
],
"oasRef": "#/components/schemas/ResponseFormatText/properties/type"
},
"oasRef": "#/components/schemas/ResponseFormatText/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) $shared > (model) response_format_text > (schema) > (property) type > (member) 0"
]
},
"(resource) $shared > (model) response_format_text > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/ResponseFormatText",
"ident": "ResponseFormatText",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
}
]
},
"docstring": "Default response format. Used to generate text responses.\n",
"childrenParentSchema": "object",
"children": [
"(resource) $shared > (model) response_format_text > (schema) > (property) type"
]
},
"(resource) $shared > (model) response_format_json_object > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The type of response format being defined. Always `json_object`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "json_object"
}
],
"oasRef": "#/components/schemas/ResponseFormatJsonObject/properties/type"
},
"oasRef": "#/components/schemas/ResponseFormatJsonObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) $shared > (model) response_format_json_object > (schema) > (property) type > (member) 0"
]
},
"(resource) $shared > (model) response_format_json_object > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/ResponseFormatJsonObject",
"ident": "ResponseFormatJSONObject",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
}
]
},
"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"
]
},
"(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",
"key": "json_schema",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "name"
},
{
"ident": "description"
},
{
"ident": "schema"
},
{
"ident": "strict"
}
]
},
"oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema > (property) name",
"(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema > (property) description",
"(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema > (property) schema",
"(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema > (property) strict"
]
},
"(resource) $shared > (model) response_format_json_schema > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The type of response format being defined. Always `json_schema`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "json_schema"
}
],
"oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/type"
},
"oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) $shared > (model) response_format_json_schema > (schema) > (property) type > (member) 0"
]
},
"(resource) $shared > (model) response_format_json_schema > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/ResponseFormatJsonSchema",
"ident": "ResponseFormatJSONSchema",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "json_schema"
},
{
"ident": "type"
}
]
},
"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",
"(resource) $shared > (model) response_format_json_schema > (schema) > (property) type"
]
},
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0 > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "none"
}
},
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0 > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "auto"
}
},
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0 > (member) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "required"
}
},
"(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",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "function"
},
{
"kind": "HttpTypeLiteral",
"literal": "code_interpreter"
},
{
"kind": "HttpTypeLiteral",
"literal": "file_search"
}
],
"oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/type"
},
"oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) type > (member) 0",
"(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) type > (member) 1",
"(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) type > (member) 2"
]
},
"(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) function": {
"kind": "HttpDeclProperty",
"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",
"modelImplicit": false,
"modelPath": "(resource) beta.threads > (model) assistant_tool_choice_function",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads > (model) assistant_tool_choice_function > (schema) > (property) name"
]
},
"(resource) beta.threads > (model) assistant_tool_choice > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/AssistantsNamedToolChoice",
"ident": "AssistantToolChoice",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
},
{
"ident": "function"
}
]
},
"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",
"(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) function"
]
},
"(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The type of tool being defined: `code_interpreter`",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "code_interpreter"
}
],
"oasRef": "#/components/schemas/AssistantToolsCode/properties/type"
},
"oasRef": "#/components/schemas/AssistantToolsCode/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type > (member) 0"
]
},
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The type of tool being defined: `file_search`",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "file_search"
}
],
"oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/type"
},
"oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) type > (member) 0"
]
},
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search": {
"kind": "HttpDeclProperty",
"docstring": "Overrides for the file search tool.",
"key": "file_search",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "max_num_results"
},
{
"ident": "ranking_options"
}
]
},
"oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/file_search",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) max_num_results",
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options"
]
},
"(resource) beta.assistants > (model) function_tool > (schema) > (property) function": {
"kind": "HttpDeclProperty",
"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",
"modelImplicit": false,
"modelPath": "(resource) $shared > (model) function_definition",
"childrenParentSchema": "object",
"children": [
"(resource) $shared > (model) function_definition > (schema) > (property) name",
"(resource) $shared > (model) function_definition > (schema) > (property) description",
"(resource) $shared > (model) function_definition > (schema) > (property) parameters",
"(resource) $shared > (model) function_definition > (schema) > (property) strict"
]
},
"(resource) beta.assistants > (model) function_tool > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The type of tool being defined: `function`",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "function"
}
],
"oasRef": "#/components/schemas/AssistantToolsFunction/properties/type"
},
"oasRef": "#/components/schemas/AssistantToolsFunction/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.assistants > (model) function_tool > (schema) > (property) type > (member) 0"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "auto"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) type > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "last_messages"
}
},
"(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.",
"key": "id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunToolCallObject/properties/id",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) function": {
"kind": "HttpDeclProperty",
"docstring": "The function definition.",
"key": "function",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "arguments"
},
{
"ident": "name"
}
]
},
"oasRef": "#/components/schemas/RunToolCallObject/properties/function",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) function > (property) arguments",
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) function > (property) name"
]
},
"(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`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "function"
}
],
"oasRef": "#/components/schemas/RunToolCallObject/properties/type"
},
"oasRef": "#/components/schemas/RunToolCallObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) type > (member) 0"
]
},
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RunToolCallObject",
"ident": "RequiredActionFunctionToolCall",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "id"
},
{
"ident": "function"
},
{
"ident": "type"
}
]
},
"docstring": "Tool call objects",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) id",
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) function",
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) type"
]
},
"(resource) $shared > (model) response_format_text > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "text"
}
},
"(resource) $shared > (model) response_format_json_object > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "json_object"
}
},
"(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",
"key": "name",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/name",
"deprecated": 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",
"key": "description",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/description",
"deprecated": 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",
"key": "schema",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeReference",
"ident": "Record",
"typeParameters": [
{
"kind": "HttpTypeString"
},
{
"kind": "HttpTypeUnknown"
}
],
"oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/schema"
},
"oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/schema",
"deprecated": 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",
"key": "strict",
"optional": true,
"nullable": true,
"default": false,
"type": {
"kind": "HttpTypeBoolean"
},
"oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/strict",
"deprecated": false,
"schemaType": "boolean",
"children": []
},
"(resource) $shared > (model) response_format_json_schema > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "json_schema"
}
},
"(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "function"
}
},
"(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) type > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "code_interpreter"
}
},
"(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) type > (member) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "file_search"
}
},
"(resource) beta.threads > (model) assistant_tool_choice_function > (schema) > (property) name": {
"kind": "HttpDeclProperty",
"docstring": "The name of the function to call.",
"key": "name",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/function/properties/name",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads > (model) assistant_tool_choice_function > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/function",
"ident": "AssistantToolChoiceFunction",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "name"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads > (model) assistant_tool_choice_function > (schema) > (property) name"
]
},
"(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "code_interpreter"
}
},
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "file_search"
}
},
"(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",
"key": "max_num_results",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"minimum": 1,
"maximum": 50
},
"oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/file_search/properties/max_num_results",
"deprecated": 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",
"key": "ranking_options",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "score_threshold"
},
{
"ident": "ranker"
}
]
},
"oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/file_search/properties/ranking_options",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options > (property) score_threshold",
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options > (property) ranker"
]
},
"(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.",
"key": "name",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/FunctionObject/properties/name",
"deprecated": 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.",
"key": "description",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/FunctionObject/properties/description",
"deprecated": 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.",
"key": "parameters",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeReference",
"ident": "FunctionParameters",
"$ref": "(resource) $shared > (model) function_parameters > (schema)"
},
"oasRef": "#/components/schemas/FunctionObject/properties/parameters",
"deprecated": false,
"schemaType": "map",
"modelImplicit": false,
"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).",
"key": "strict",
"optional": true,
"nullable": true,
"default": false,
"type": {
"kind": "HttpTypeBoolean"
},
"oasRef": "#/components/schemas/FunctionObject/properties/strict",
"deprecated": false,
"schemaType": "boolean",
"children": []
},
"(resource) $shared > (model) function_definition > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/FunctionObject",
"ident": "FunctionDefinition",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "name"
},
{
"ident": "description"
},
{
"ident": "parameters"
},
{
"ident": "strict"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) $shared > (model) function_definition > (schema) > (property) name",
"(resource) $shared > (model) function_definition > (schema) > (property) description",
"(resource) $shared > (model) function_definition > (schema) > (property) parameters",
"(resource) $shared > (model) function_definition > (schema) > (property) strict"
]
},
"(resource) beta.assistants > (model) function_tool > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "function"
}
},
"(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.",
"key": "arguments",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunToolCallObject/properties/function/properties/arguments",
"deprecated": 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.",
"key": "name",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunToolCallObject/properties/function/properties/name",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "function"
}
},
"(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.",
"key": "score_threshold",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"minimum": 0,
"maximum": 1
},
"oasRef": "#/components/schemas/FileSearchRankingOptions/properties/score_threshold",
"deprecated": 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.",
"key": "ranker",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "auto"
},
{
"kind": "HttpTypeLiteral",
"literal": "default_2024_08_21"
}
],
"oasRef": "#/components/schemas/FileSearchRankingOptions/properties/ranker"
},
"oasRef": "#/components/schemas/FileSearchRankingOptions/properties/ranker",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options > (property) ranker > (member) 0",
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options > (property) ranker > (member) 1"
]
},
"(resource) $shared > (model) function_parameters > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/FunctionParameters",
"ident": "FunctionParameters",
"type": {
"kind": "HttpTypeReference",
"ident": "Record",
"typeParameters": [
{
"kind": "HttpTypeString"
},
{
"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": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "auto"
}
},
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options > (property) ranker > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "default_2024_08_21"
}
}
}
Example
{}
event
Occurs when a run fails.
Schema
Schema name: (resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 7
{
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 7": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RunStreamEvent/oneOf/6",
"ident": "UnionMember7",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "data"
},
{
"ident": "event"
}
]
},
"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",
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 7 > (property) event"
]
},
"(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).",
"key": "data",
"optional": false,
"nullable": false,
"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",
"modelImplicit": false,
"modelPath": "(resource) beta.threads.runs > (model) run",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) id",
"(resource) beta.threads.runs > (model) run > (schema) > (property) assistant_id",
"(resource) beta.threads.runs > (model) run > (schema) > (property) cancelled_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) completed_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) created_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) expires_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) failed_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) incomplete_details",
"(resource) beta.threads.runs > (model) run > (schema) > (property) instructions",
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error",
"(resource) beta.threads.runs > (model) run > (schema) > (property) max_completion_tokens",
"(resource) beta.threads.runs > (model) run > (schema) > (property) max_prompt_tokens",
"(resource) beta.threads.runs > (model) run > (schema) > (property) metadata",
"(resource) beta.threads.runs > (model) run > (schema) > (property) model",
"(resource) beta.threads.runs > (model) run > (schema) > (property) object",
"(resource) beta.threads.runs > (model) run > (schema) > (property) parallel_tool_calls",
"(resource) beta.threads.runs > (model) run > (schema) > (property) required_action",
"(resource) beta.threads.runs > (model) run > (schema) > (property) response_format",
"(resource) beta.threads.runs > (model) run > (schema) > (property) started_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) status",
"(resource) beta.threads.runs > (model) run > (schema) > (property) thread_id",
"(resource) beta.threads.runs > (model) run > (schema) > (property) tool_choice",
"(resource) beta.threads.runs > (model) run > (schema) > (property) tools",
"(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy",
"(resource) beta.threads.runs > (model) run > (schema) > (property) usage",
"(resource) beta.threads.runs > (model) run > (schema) > (property) temperature",
"(resource) beta.threads.runs > (model) run > (schema) > (property) top_p"
]
},
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 7 > (property) event": {
"kind": "HttpDeclProperty",
"key": "event",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"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,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 7 > (property) event > (member) 0"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) id": {
"kind": "HttpDeclProperty",
"docstring": "The identifier, which can be referenced in API endpoints.",
"key": "id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunObject/properties/id",
"deprecated": 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.",
"key": "assistant_id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunObject/properties/assistant_id",
"deprecated": 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.",
"key": "cancelled_at",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/RunObject/properties/cancelled_at",
"deprecated": false,
"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.",
"key": "completed_at",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/RunObject/properties/completed_at",
"deprecated": false,
"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.",
"key": "created_at",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/RunObject/properties/created_at",
"deprecated": 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.",
"key": "expires_at",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/RunObject/properties/expires_at",
"deprecated": false,
"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.",
"key": "failed_at",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/RunObject/properties/failed_at",
"deprecated": false,
"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.",
"key": "incomplete_details",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "reason"
}
]
},
"oasRef": "#/components/schemas/RunObject/properties/incomplete_details",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) incomplete_details > (property) reason"
]
},
"(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.",
"key": "instructions",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunObject/properties/instructions",
"deprecated": 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.",
"key": "last_error",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "code"
},
{
"ident": "message"
}
]
},
"oasRef": "#/components/schemas/RunObject/properties/last_error",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) code",
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) message"
]
},
"(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",
"key": "max_completion_tokens",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"minimum": 256
},
"oasRef": "#/components/schemas/RunObject/properties/max_completion_tokens",
"deprecated": false,
"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",
"key": "max_prompt_tokens",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"minimum": 256
},
"oasRef": "#/components/schemas/RunObject/properties/max_prompt_tokens",
"deprecated": false,
"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",
"key": "metadata",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeReference",
"ident": "Metadata",
"$ref": "(resource) $shared > (model) metadata > (schema)"
},
"oasRef": "#/components/schemas/RunObject/properties/metadata",
"deprecated": false,
"schemaType": "map",
"modelImplicit": false,
"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.",
"key": "model",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunObject/properties/model",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) object": {
"kind": "HttpDeclProperty",
"docstring": "The object type, which is always `thread.run`.",
"key": "object",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "thread.run"
}
],
"oasRef": "#/components/schemas/RunObject/properties/object"
},
"oasRef": "#/components/schemas/RunObject/properties/object",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) object > (member) 0"
]
},
"(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.",
"key": "parallel_tool_calls",
"optional": false,
"nullable": false,
"default": true,
"type": {
"kind": "HttpTypeBoolean"
},
"oasRef": "#/components/schemas/RunObject/properties/parallel_tool_calls",
"deprecated": 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.",
"key": "required_action",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "submit_tool_outputs"
},
{
"ident": "type"
}
]
},
"oasRef": "#/components/schemas/RunObject/properties/required_action",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) required_action > (property) submit_tool_outputs",
"(resource) beta.threads.runs > (model) run > (schema) > (property) required_action > (property) type"
]
},
"(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",
"key": "response_format",
"optional": false,
"nullable": true,
"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",
"modelImplicit": false,
"modelPath": "(resource) beta.threads > (model) assistant_response_format_option",
"childrenParentSchema": "union",
"children": [
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 0",
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 1",
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 2",
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 3"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) started_at": {
"kind": "HttpDeclProperty",
"docstring": "The Unix timestamp (in seconds) for when the run was started.",
"key": "started_at",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/RunObject/properties/started_at",
"deprecated": false,
"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`.",
"key": "status",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "queued"
},
{
"kind": "HttpTypeLiteral",
"literal": "in_progress"
},
{
"kind": "HttpTypeLiteral",
"literal": "requires_action"
},
{
"kind": "HttpTypeLiteral",
"literal": "cancelling"
},
{
"kind": "HttpTypeLiteral",
"literal": "cancelled"
},
{
"kind": "HttpTypeLiteral",
"literal": "failed"
},
{
"kind": "HttpTypeLiteral",
"literal": "completed"
},
{
"kind": "HttpTypeLiteral",
"literal": "incomplete"
},
{
"kind": "HttpTypeLiteral",
"literal": "expired"
}
],
"oasRef": "#/components/schemas/RunObject/properties/status"
},
"oasRef": "#/components/schemas/RunObject/properties/status",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 0",
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 1",
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 2",
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 3",
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 4",
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 5",
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 6",
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 7",
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 8"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) thread_id": {
"kind": "HttpDeclProperty",
"docstring": "The ID of the [thread](/docs/api-reference/threads) that was executed on as a part of this run.",
"key": "thread_id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunObject/properties/thread_id",
"deprecated": 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",
"key": "tool_choice",
"optional": false,
"nullable": true,
"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",
"modelImplicit": false,
"modelPath": "(resource) beta.threads > (model) assistant_tool_choice_option",
"childrenParentSchema": "union",
"children": [
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0",
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 1"
]
},
"(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.",
"key": "tools",
"optional": false,
"nullable": false,
"default": [],
"type": {
"kind": "HttpTypeArray",
"elementType": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeReference",
"ident": "CodeInterpreterTool",
"$ref": "(resource) beta.assistants > (model) code_interpreter_tool > (schema)"
},
{
"kind": "HttpTypeReference",
"ident": "FileSearchTool",
"$ref": "(resource) beta.assistants > (model) file_search_tool > (schema)"
},
{
"kind": "HttpTypeReference",
"ident": "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,
"schemaType": "array",
"childrenParentSchema": "union",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 0",
"(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 1",
"(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 2"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy": {
"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.",
"key": "truncation_strategy",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
},
{
"ident": "last_messages"
}
]
},
"oasRef": "#/components/schemas/RunObject/properties/truncation_strategy",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) type",
"(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) last_messages"
]
},
"(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.).",
"key": "usage",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "completion_tokens"
},
{
"ident": "prompt_tokens"
},
{
"ident": "total_tokens"
}
]
},
"oasRef": "#/components/schemas/RunObject/properties/usage",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) usage > (property) completion_tokens",
"(resource) beta.threads.runs > (model) run > (schema) > (property) usage > (property) prompt_tokens",
"(resource) beta.threads.runs > (model) run > (schema) > (property) usage > (property) total_tokens"
]
},
"(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.",
"key": "temperature",
"optional": true,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"oasRef": "#/components/schemas/RunObject/properties/temperature",
"deprecated": false,
"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.",
"key": "top_p",
"optional": true,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"oasRef": "#/components/schemas/RunObject/properties/top_p",
"deprecated": false,
"schemaType": "number",
"children": []
},
"(resource) beta.threads.runs > (model) run > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RunObject",
"ident": "Run",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "id"
},
{
"ident": "assistant_id"
},
{
"ident": "cancelled_at"
},
{
"ident": "completed_at"
},
{
"ident": "created_at"
},
{
"ident": "expires_at"
},
{
"ident": "failed_at"
},
{
"ident": "incomplete_details"
},
{
"ident": "instructions"
},
{
"ident": "last_error"
},
{
"ident": "max_completion_tokens"
},
{
"ident": "max_prompt_tokens"
},
{
"ident": "metadata"
},
{
"ident": "model"
},
{
"ident": "object"
},
{
"ident": "parallel_tool_calls"
},
{
"ident": "required_action"
},
{
"ident": "response_format"
},
{
"ident": "started_at"
},
{
"ident": "status"
},
{
"ident": "thread_id"
},
{
"ident": "tool_choice"
},
{
"ident": "tools"
},
{
"ident": "truncation_strategy"
},
{
"ident": "usage"
},
{
"ident": "temperature"
},
{
"ident": "top_p"
}
]
},
"docstring": "Represents an execution run on a [thread](/docs/api-reference/threads).",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) id",
"(resource) beta.threads.runs > (model) run > (schema) > (property) assistant_id",
"(resource) beta.threads.runs > (model) run > (schema) > (property) cancelled_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) completed_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) created_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) expires_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) failed_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) incomplete_details",
"(resource) beta.threads.runs > (model) run > (schema) > (property) instructions",
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error",
"(resource) beta.threads.runs > (model) run > (schema) > (property) max_completion_tokens",
"(resource) beta.threads.runs > (model) run > (schema) > (property) max_prompt_tokens",
"(resource) beta.threads.runs > (model) run > (schema) > (property) metadata",
"(resource) beta.threads.runs > (model) run > (schema) > (property) model",
"(resource) beta.threads.runs > (model) run > (schema) > (property) object",
"(resource) beta.threads.runs > (model) run > (schema) > (property) parallel_tool_calls",
"(resource) beta.threads.runs > (model) run > (schema) > (property) required_action",
"(resource) beta.threads.runs > (model) run > (schema) > (property) response_format",
"(resource) beta.threads.runs > (model) run > (schema) > (property) started_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) status",
"(resource) beta.threads.runs > (model) run > (schema) > (property) thread_id",
"(resource) beta.threads.runs > (model) run > (schema) > (property) tool_choice",
"(resource) beta.threads.runs > (model) run > (schema) > (property) tools",
"(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy",
"(resource) beta.threads.runs > (model) run > (schema) > (property) usage",
"(resource) beta.threads.runs > (model) run > (schema) > (property) temperature",
"(resource) beta.threads.runs > (model) run > (schema) > (property) top_p"
]
},
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 7 > (property) event > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "thread.run.failed"
}
},
"(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.",
"key": "reason",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "max_completion_tokens"
},
{
"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,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) incomplete_details > (property) reason > (member) 0",
"(resource) beta.threads.runs > (model) run > (schema) > (property) incomplete_details > (property) reason > (member) 1"
]
},
"(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`.",
"key": "code",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "server_error"
},
{
"kind": "HttpTypeLiteral",
"literal": "rate_limit_exceeded"
},
{
"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,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) code > (member) 0",
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) code > (member) 1",
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) code > (member) 2"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) message": {
"kind": "HttpDeclProperty",
"docstring": "A human-readable description of the error.",
"key": "message",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunObject/properties/last_error/properties/message",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) $shared > (model) metadata > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/Metadata",
"ident": "Metadata",
"type": {
"kind": "HttpTypeReference",
"ident": "Record",
"typeParameters": [
{
"kind": "HttpTypeString"
},
{
"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": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "thread.run"
}
},
"(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.",
"key": "submit_tool_outputs",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "tool_calls"
}
]
},
"oasRef": "#/components/schemas/RunObject/properties/required_action/properties/submit_tool_outputs",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) required_action > (property) submit_tool_outputs > (property) tool_calls"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) required_action > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "For now, this is always `submit_tool_outputs`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"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,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) required_action > (property) type > (member) 0"
]
},
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 0": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/oneOf/0",
"ident": "UnionMember0",
"type": {
"kind": "HttpTypeUnion",
"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"
]
},
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "ResponseFormatText",
"$ref": "(resource) $shared > (model) response_format_text > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) $shared > (model) response_format_text > (schema) > (property) type"
]
},
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "ResponseFormatJSONObject",
"$ref": "(resource) $shared > (model) response_format_json_object > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) $shared > (model) response_format_json_object > (schema) > (property) type"
]
},
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 3": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "ResponseFormatJSONSchema",
"$ref": "(resource) $shared > (model) response_format_json_schema > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema",
"(resource) $shared > (model) response_format_json_schema > (schema) > (property) type"
]
},
"(resource) beta.threads > (model) assistant_response_format_option > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/AssistantsApiResponseFormatOption",
"ident": "AssistantResponseFormatOption",
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "auto"
}
],
"oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/oneOf/0"
},
{
"kind": "HttpTypeReference",
"ident": "ResponseFormatText",
"$ref": "(resource) $shared > (model) response_format_text > (schema)"
},
{
"kind": "HttpTypeReference",
"ident": "ResponseFormatJSONObject",
"$ref": "(resource) $shared > (model) response_format_json_object > (schema)"
},
{
"kind": "HttpTypeReference",
"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",
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 1",
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 2",
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 3"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "queued"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "in_progress"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "requires_action"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 3": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "cancelling"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 4": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "cancelled"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 5": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "failed"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 6": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "completed"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 7": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "incomplete"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 8": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "expired"
}
},
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/AssistantsApiToolChoiceOption/oneOf/0",
"ident": "UnionMember0",
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "none"
},
{
"kind": "HttpTypeLiteral",
"literal": "auto"
},
{
"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",
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0 > (member) 1",
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0 > (member) 2"
]
},
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "AssistantToolChoice",
"$ref": "(resource) beta.threads > (model) assistant_tool_choice > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) type",
"(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) function"
]
},
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/AssistantsApiToolChoiceOption",
"ident": "AssistantToolChoiceOption",
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "none"
},
{
"kind": "HttpTypeLiteral",
"literal": "auto"
},
{
"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",
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 1"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "CodeInterpreterTool",
"$ref": "(resource) beta.assistants > (model) code_interpreter_tool > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "FileSearchTool",
"$ref": "(resource) beta.assistants > (model) file_search_tool > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) type",
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "FunctionTool",
"$ref": "(resource) beta.assistants > (model) function_tool > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.assistants > (model) function_tool > (schema) > (property) function",
"(resource) beta.assistants > (model) function_tool > (schema) > (property) type"
]
},
"(resource) beta.assistants > (model) code_interpreter_tool > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/AssistantToolsCode",
"ident": "CodeInterpreterTool",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type"
]
},
"(resource) beta.assistants > (model) file_search_tool > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/AssistantToolsFileSearch",
"ident": "FileSearchTool",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
},
{
"ident": "file_search"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) type",
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search"
]
},
"(resource) beta.assistants > (model) function_tool > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/AssistantToolsFunction",
"ident": "FunctionTool",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "function"
},
{
"ident": "type"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.assistants > (model) function_tool > (schema) > (property) function",
"(resource) beta.assistants > (model) function_tool > (schema) > (property) type"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) type": {
"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`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "auto"
},
{
"kind": "HttpTypeLiteral",
"literal": "last_messages"
}
],
"oasRef": "#/components/schemas/TruncationObject/properties/type"
},
"oasRef": "#/components/schemas/TruncationObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) type > (member) 0",
"(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) type > (member) 1"
]
},
"(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.",
"key": "last_messages",
"optional": true,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"minimum": 1
},
"oasRef": "#/components/schemas/TruncationObject/properties/last_messages",
"deprecated": false,
"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.",
"key": "completion_tokens",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"oasRef": "#/components/schemas/RunCompletionUsage/anyOf/0/properties/completion_tokens",
"deprecated": 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.",
"key": "prompt_tokens",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"oasRef": "#/components/schemas/RunCompletionUsage/anyOf/0/properties/prompt_tokens",
"deprecated": 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).",
"key": "total_tokens",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"oasRef": "#/components/schemas/RunCompletionUsage/anyOf/0/properties/total_tokens",
"deprecated": false,
"schemaType": "integer",
"children": []
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) incomplete_details > (property) reason > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "max_completion_tokens"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) incomplete_details > (property) reason > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "max_prompt_tokens"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) code > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "server_error"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) code > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "rate_limit_exceeded"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) code > (member) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "invalid_prompt"
}
},
"(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.",
"key": "tool_calls",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeArray",
"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,
"schemaType": "array",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) id",
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) function",
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) type"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) required_action > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "submit_tool_outputs"
}
},
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 0 > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "auto"
}
},
"(resource) $shared > (model) response_format_text > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The type of response format being defined. Always `text`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "text"
}
],
"oasRef": "#/components/schemas/ResponseFormatText/properties/type"
},
"oasRef": "#/components/schemas/ResponseFormatText/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) $shared > (model) response_format_text > (schema) > (property) type > (member) 0"
]
},
"(resource) $shared > (model) response_format_text > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/ResponseFormatText",
"ident": "ResponseFormatText",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
}
]
},
"docstring": "Default response format. Used to generate text responses.\n",
"childrenParentSchema": "object",
"children": [
"(resource) $shared > (model) response_format_text > (schema) > (property) type"
]
},
"(resource) $shared > (model) response_format_json_object > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The type of response format being defined. Always `json_object`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "json_object"
}
],
"oasRef": "#/components/schemas/ResponseFormatJsonObject/properties/type"
},
"oasRef": "#/components/schemas/ResponseFormatJsonObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) $shared > (model) response_format_json_object > (schema) > (property) type > (member) 0"
]
},
"(resource) $shared > (model) response_format_json_object > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/ResponseFormatJsonObject",
"ident": "ResponseFormatJSONObject",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
}
]
},
"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"
]
},
"(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",
"key": "json_schema",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "name"
},
{
"ident": "description"
},
{
"ident": "schema"
},
{
"ident": "strict"
}
]
},
"oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema > (property) name",
"(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema > (property) description",
"(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema > (property) schema",
"(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema > (property) strict"
]
},
"(resource) $shared > (model) response_format_json_schema > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The type of response format being defined. Always `json_schema`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "json_schema"
}
],
"oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/type"
},
"oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) $shared > (model) response_format_json_schema > (schema) > (property) type > (member) 0"
]
},
"(resource) $shared > (model) response_format_json_schema > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/ResponseFormatJsonSchema",
"ident": "ResponseFormatJSONSchema",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "json_schema"
},
{
"ident": "type"
}
]
},
"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",
"(resource) $shared > (model) response_format_json_schema > (schema) > (property) type"
]
},
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0 > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "none"
}
},
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0 > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "auto"
}
},
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0 > (member) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "required"
}
},
"(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",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "function"
},
{
"kind": "HttpTypeLiteral",
"literal": "code_interpreter"
},
{
"kind": "HttpTypeLiteral",
"literal": "file_search"
}
],
"oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/type"
},
"oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) type > (member) 0",
"(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) type > (member) 1",
"(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) type > (member) 2"
]
},
"(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) function": {
"kind": "HttpDeclProperty",
"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",
"modelImplicit": false,
"modelPath": "(resource) beta.threads > (model) assistant_tool_choice_function",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads > (model) assistant_tool_choice_function > (schema) > (property) name"
]
},
"(resource) beta.threads > (model) assistant_tool_choice > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/AssistantsNamedToolChoice",
"ident": "AssistantToolChoice",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
},
{
"ident": "function"
}
]
},
"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",
"(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) function"
]
},
"(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The type of tool being defined: `code_interpreter`",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "code_interpreter"
}
],
"oasRef": "#/components/schemas/AssistantToolsCode/properties/type"
},
"oasRef": "#/components/schemas/AssistantToolsCode/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type > (member) 0"
]
},
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The type of tool being defined: `file_search`",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "file_search"
}
],
"oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/type"
},
"oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) type > (member) 0"
]
},
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search": {
"kind": "HttpDeclProperty",
"docstring": "Overrides for the file search tool.",
"key": "file_search",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "max_num_results"
},
{
"ident": "ranking_options"
}
]
},
"oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/file_search",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) max_num_results",
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options"
]
},
"(resource) beta.assistants > (model) function_tool > (schema) > (property) function": {
"kind": "HttpDeclProperty",
"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",
"modelImplicit": false,
"modelPath": "(resource) $shared > (model) function_definition",
"childrenParentSchema": "object",
"children": [
"(resource) $shared > (model) function_definition > (schema) > (property) name",
"(resource) $shared > (model) function_definition > (schema) > (property) description",
"(resource) $shared > (model) function_definition > (schema) > (property) parameters",
"(resource) $shared > (model) function_definition > (schema) > (property) strict"
]
},
"(resource) beta.assistants > (model) function_tool > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The type of tool being defined: `function`",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "function"
}
],
"oasRef": "#/components/schemas/AssistantToolsFunction/properties/type"
},
"oasRef": "#/components/schemas/AssistantToolsFunction/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.assistants > (model) function_tool > (schema) > (property) type > (member) 0"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "auto"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) type > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "last_messages"
}
},
"(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.",
"key": "id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunToolCallObject/properties/id",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) function": {
"kind": "HttpDeclProperty",
"docstring": "The function definition.",
"key": "function",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "arguments"
},
{
"ident": "name"
}
]
},
"oasRef": "#/components/schemas/RunToolCallObject/properties/function",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) function > (property) arguments",
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) function > (property) name"
]
},
"(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`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "function"
}
],
"oasRef": "#/components/schemas/RunToolCallObject/properties/type"
},
"oasRef": "#/components/schemas/RunToolCallObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) type > (member) 0"
]
},
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RunToolCallObject",
"ident": "RequiredActionFunctionToolCall",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "id"
},
{
"ident": "function"
},
{
"ident": "type"
}
]
},
"docstring": "Tool call objects",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) id",
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) function",
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) type"
]
},
"(resource) $shared > (model) response_format_text > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "text"
}
},
"(resource) $shared > (model) response_format_json_object > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "json_object"
}
},
"(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",
"key": "name",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/name",
"deprecated": 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",
"key": "description",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/description",
"deprecated": 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",
"key": "schema",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeReference",
"ident": "Record",
"typeParameters": [
{
"kind": "HttpTypeString"
},
{
"kind": "HttpTypeUnknown"
}
],
"oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/schema"
},
"oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/schema",
"deprecated": 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",
"key": "strict",
"optional": true,
"nullable": true,
"default": false,
"type": {
"kind": "HttpTypeBoolean"
},
"oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/strict",
"deprecated": false,
"schemaType": "boolean",
"children": []
},
"(resource) $shared > (model) response_format_json_schema > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "json_schema"
}
},
"(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "function"
}
},
"(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) type > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "code_interpreter"
}
},
"(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) type > (member) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "file_search"
}
},
"(resource) beta.threads > (model) assistant_tool_choice_function > (schema) > (property) name": {
"kind": "HttpDeclProperty",
"docstring": "The name of the function to call.",
"key": "name",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/function/properties/name",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads > (model) assistant_tool_choice_function > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/function",
"ident": "AssistantToolChoiceFunction",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "name"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads > (model) assistant_tool_choice_function > (schema) > (property) name"
]
},
"(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "code_interpreter"
}
},
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "file_search"
}
},
"(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",
"key": "max_num_results",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"minimum": 1,
"maximum": 50
},
"oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/file_search/properties/max_num_results",
"deprecated": 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",
"key": "ranking_options",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "score_threshold"
},
{
"ident": "ranker"
}
]
},
"oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/file_search/properties/ranking_options",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options > (property) score_threshold",
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options > (property) ranker"
]
},
"(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.",
"key": "name",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/FunctionObject/properties/name",
"deprecated": 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.",
"key": "description",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/FunctionObject/properties/description",
"deprecated": 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.",
"key": "parameters",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeReference",
"ident": "FunctionParameters",
"$ref": "(resource) $shared > (model) function_parameters > (schema)"
},
"oasRef": "#/components/schemas/FunctionObject/properties/parameters",
"deprecated": false,
"schemaType": "map",
"modelImplicit": false,
"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).",
"key": "strict",
"optional": true,
"nullable": true,
"default": false,
"type": {
"kind": "HttpTypeBoolean"
},
"oasRef": "#/components/schemas/FunctionObject/properties/strict",
"deprecated": false,
"schemaType": "boolean",
"children": []
},
"(resource) $shared > (model) function_definition > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/FunctionObject",
"ident": "FunctionDefinition",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "name"
},
{
"ident": "description"
},
{
"ident": "parameters"
},
{
"ident": "strict"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) $shared > (model) function_definition > (schema) > (property) name",
"(resource) $shared > (model) function_definition > (schema) > (property) description",
"(resource) $shared > (model) function_definition > (schema) > (property) parameters",
"(resource) $shared > (model) function_definition > (schema) > (property) strict"
]
},
"(resource) beta.assistants > (model) function_tool > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "function"
}
},
"(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.",
"key": "arguments",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunToolCallObject/properties/function/properties/arguments",
"deprecated": 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.",
"key": "name",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunToolCallObject/properties/function/properties/name",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "function"
}
},
"(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.",
"key": "score_threshold",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"minimum": 0,
"maximum": 1
},
"oasRef": "#/components/schemas/FileSearchRankingOptions/properties/score_threshold",
"deprecated": 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.",
"key": "ranker",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "auto"
},
{
"kind": "HttpTypeLiteral",
"literal": "default_2024_08_21"
}
],
"oasRef": "#/components/schemas/FileSearchRankingOptions/properties/ranker"
},
"oasRef": "#/components/schemas/FileSearchRankingOptions/properties/ranker",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options > (property) ranker > (member) 0",
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options > (property) ranker > (member) 1"
]
},
"(resource) $shared > (model) function_parameters > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/FunctionParameters",
"ident": "FunctionParameters",
"type": {
"kind": "HttpTypeReference",
"ident": "Record",
"typeParameters": [
{
"kind": "HttpTypeString"
},
{
"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": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "auto"
}
},
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options > (property) ranker > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "default_2024_08_21"
}
}
}
Example
{}
event
Occurs when a run moves to a cancelling status.
Schema
Schema name: (resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 8
{
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 8": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RunStreamEvent/oneOf/7",
"ident": "UnionMember8",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "data"
},
{
"ident": "event"
}
]
},
"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",
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 8 > (property) event"
]
},
"(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).",
"key": "data",
"optional": false,
"nullable": false,
"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",
"modelImplicit": false,
"modelPath": "(resource) beta.threads.runs > (model) run",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) id",
"(resource) beta.threads.runs > (model) run > (schema) > (property) assistant_id",
"(resource) beta.threads.runs > (model) run > (schema) > (property) cancelled_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) completed_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) created_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) expires_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) failed_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) incomplete_details",
"(resource) beta.threads.runs > (model) run > (schema) > (property) instructions",
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error",
"(resource) beta.threads.runs > (model) run > (schema) > (property) max_completion_tokens",
"(resource) beta.threads.runs > (model) run > (schema) > (property) max_prompt_tokens",
"(resource) beta.threads.runs > (model) run > (schema) > (property) metadata",
"(resource) beta.threads.runs > (model) run > (schema) > (property) model",
"(resource) beta.threads.runs > (model) run > (schema) > (property) object",
"(resource) beta.threads.runs > (model) run > (schema) > (property) parallel_tool_calls",
"(resource) beta.threads.runs > (model) run > (schema) > (property) required_action",
"(resource) beta.threads.runs > (model) run > (schema) > (property) response_format",
"(resource) beta.threads.runs > (model) run > (schema) > (property) started_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) status",
"(resource) beta.threads.runs > (model) run > (schema) > (property) thread_id",
"(resource) beta.threads.runs > (model) run > (schema) > (property) tool_choice",
"(resource) beta.threads.runs > (model) run > (schema) > (property) tools",
"(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy",
"(resource) beta.threads.runs > (model) run > (schema) > (property) usage",
"(resource) beta.threads.runs > (model) run > (schema) > (property) temperature",
"(resource) beta.threads.runs > (model) run > (schema) > (property) top_p"
]
},
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 8 > (property) event": {
"kind": "HttpDeclProperty",
"key": "event",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"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,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 8 > (property) event > (member) 0"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) id": {
"kind": "HttpDeclProperty",
"docstring": "The identifier, which can be referenced in API endpoints.",
"key": "id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunObject/properties/id",
"deprecated": 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.",
"key": "assistant_id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunObject/properties/assistant_id",
"deprecated": 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.",
"key": "cancelled_at",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/RunObject/properties/cancelled_at",
"deprecated": false,
"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.",
"key": "completed_at",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/RunObject/properties/completed_at",
"deprecated": false,
"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.",
"key": "created_at",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/RunObject/properties/created_at",
"deprecated": 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.",
"key": "expires_at",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/RunObject/properties/expires_at",
"deprecated": false,
"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.",
"key": "failed_at",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/RunObject/properties/failed_at",
"deprecated": false,
"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.",
"key": "incomplete_details",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "reason"
}
]
},
"oasRef": "#/components/schemas/RunObject/properties/incomplete_details",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) incomplete_details > (property) reason"
]
},
"(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.",
"key": "instructions",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunObject/properties/instructions",
"deprecated": 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.",
"key": "last_error",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "code"
},
{
"ident": "message"
}
]
},
"oasRef": "#/components/schemas/RunObject/properties/last_error",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) code",
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) message"
]
},
"(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",
"key": "max_completion_tokens",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"minimum": 256
},
"oasRef": "#/components/schemas/RunObject/properties/max_completion_tokens",
"deprecated": false,
"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",
"key": "max_prompt_tokens",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"minimum": 256
},
"oasRef": "#/components/schemas/RunObject/properties/max_prompt_tokens",
"deprecated": false,
"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",
"key": "metadata",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeReference",
"ident": "Metadata",
"$ref": "(resource) $shared > (model) metadata > (schema)"
},
"oasRef": "#/components/schemas/RunObject/properties/metadata",
"deprecated": false,
"schemaType": "map",
"modelImplicit": false,
"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.",
"key": "model",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunObject/properties/model",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) object": {
"kind": "HttpDeclProperty",
"docstring": "The object type, which is always `thread.run`.",
"key": "object",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "thread.run"
}
],
"oasRef": "#/components/schemas/RunObject/properties/object"
},
"oasRef": "#/components/schemas/RunObject/properties/object",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) object > (member) 0"
]
},
"(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.",
"key": "parallel_tool_calls",
"optional": false,
"nullable": false,
"default": true,
"type": {
"kind": "HttpTypeBoolean"
},
"oasRef": "#/components/schemas/RunObject/properties/parallel_tool_calls",
"deprecated": 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.",
"key": "required_action",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "submit_tool_outputs"
},
{
"ident": "type"
}
]
},
"oasRef": "#/components/schemas/RunObject/properties/required_action",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) required_action > (property) submit_tool_outputs",
"(resource) beta.threads.runs > (model) run > (schema) > (property) required_action > (property) type"
]
},
"(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",
"key": "response_format",
"optional": false,
"nullable": true,
"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",
"modelImplicit": false,
"modelPath": "(resource) beta.threads > (model) assistant_response_format_option",
"childrenParentSchema": "union",
"children": [
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 0",
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 1",
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 2",
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 3"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) started_at": {
"kind": "HttpDeclProperty",
"docstring": "The Unix timestamp (in seconds) for when the run was started.",
"key": "started_at",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/RunObject/properties/started_at",
"deprecated": false,
"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`.",
"key": "status",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "queued"
},
{
"kind": "HttpTypeLiteral",
"literal": "in_progress"
},
{
"kind": "HttpTypeLiteral",
"literal": "requires_action"
},
{
"kind": "HttpTypeLiteral",
"literal": "cancelling"
},
{
"kind": "HttpTypeLiteral",
"literal": "cancelled"
},
{
"kind": "HttpTypeLiteral",
"literal": "failed"
},
{
"kind": "HttpTypeLiteral",
"literal": "completed"
},
{
"kind": "HttpTypeLiteral",
"literal": "incomplete"
},
{
"kind": "HttpTypeLiteral",
"literal": "expired"
}
],
"oasRef": "#/components/schemas/RunObject/properties/status"
},
"oasRef": "#/components/schemas/RunObject/properties/status",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 0",
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 1",
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 2",
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 3",
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 4",
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 5",
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 6",
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 7",
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 8"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) thread_id": {
"kind": "HttpDeclProperty",
"docstring": "The ID of the [thread](/docs/api-reference/threads) that was executed on as a part of this run.",
"key": "thread_id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunObject/properties/thread_id",
"deprecated": 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",
"key": "tool_choice",
"optional": false,
"nullable": true,
"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",
"modelImplicit": false,
"modelPath": "(resource) beta.threads > (model) assistant_tool_choice_option",
"childrenParentSchema": "union",
"children": [
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0",
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 1"
]
},
"(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.",
"key": "tools",
"optional": false,
"nullable": false,
"default": [],
"type": {
"kind": "HttpTypeArray",
"elementType": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeReference",
"ident": "CodeInterpreterTool",
"$ref": "(resource) beta.assistants > (model) code_interpreter_tool > (schema)"
},
{
"kind": "HttpTypeReference",
"ident": "FileSearchTool",
"$ref": "(resource) beta.assistants > (model) file_search_tool > (schema)"
},
{
"kind": "HttpTypeReference",
"ident": "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,
"schemaType": "array",
"childrenParentSchema": "union",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 0",
"(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 1",
"(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 2"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy": {
"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.",
"key": "truncation_strategy",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
},
{
"ident": "last_messages"
}
]
},
"oasRef": "#/components/schemas/RunObject/properties/truncation_strategy",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) type",
"(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) last_messages"
]
},
"(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.).",
"key": "usage",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "completion_tokens"
},
{
"ident": "prompt_tokens"
},
{
"ident": "total_tokens"
}
]
},
"oasRef": "#/components/schemas/RunObject/properties/usage",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) usage > (property) completion_tokens",
"(resource) beta.threads.runs > (model) run > (schema) > (property) usage > (property) prompt_tokens",
"(resource) beta.threads.runs > (model) run > (schema) > (property) usage > (property) total_tokens"
]
},
"(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.",
"key": "temperature",
"optional": true,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"oasRef": "#/components/schemas/RunObject/properties/temperature",
"deprecated": false,
"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.",
"key": "top_p",
"optional": true,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"oasRef": "#/components/schemas/RunObject/properties/top_p",
"deprecated": false,
"schemaType": "number",
"children": []
},
"(resource) beta.threads.runs > (model) run > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RunObject",
"ident": "Run",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "id"
},
{
"ident": "assistant_id"
},
{
"ident": "cancelled_at"
},
{
"ident": "completed_at"
},
{
"ident": "created_at"
},
{
"ident": "expires_at"
},
{
"ident": "failed_at"
},
{
"ident": "incomplete_details"
},
{
"ident": "instructions"
},
{
"ident": "last_error"
},
{
"ident": "max_completion_tokens"
},
{
"ident": "max_prompt_tokens"
},
{
"ident": "metadata"
},
{
"ident": "model"
},
{
"ident": "object"
},
{
"ident": "parallel_tool_calls"
},
{
"ident": "required_action"
},
{
"ident": "response_format"
},
{
"ident": "started_at"
},
{
"ident": "status"
},
{
"ident": "thread_id"
},
{
"ident": "tool_choice"
},
{
"ident": "tools"
},
{
"ident": "truncation_strategy"
},
{
"ident": "usage"
},
{
"ident": "temperature"
},
{
"ident": "top_p"
}
]
},
"docstring": "Represents an execution run on a [thread](/docs/api-reference/threads).",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) id",
"(resource) beta.threads.runs > (model) run > (schema) > (property) assistant_id",
"(resource) beta.threads.runs > (model) run > (schema) > (property) cancelled_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) completed_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) created_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) expires_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) failed_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) incomplete_details",
"(resource) beta.threads.runs > (model) run > (schema) > (property) instructions",
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error",
"(resource) beta.threads.runs > (model) run > (schema) > (property) max_completion_tokens",
"(resource) beta.threads.runs > (model) run > (schema) > (property) max_prompt_tokens",
"(resource) beta.threads.runs > (model) run > (schema) > (property) metadata",
"(resource) beta.threads.runs > (model) run > (schema) > (property) model",
"(resource) beta.threads.runs > (model) run > (schema) > (property) object",
"(resource) beta.threads.runs > (model) run > (schema) > (property) parallel_tool_calls",
"(resource) beta.threads.runs > (model) run > (schema) > (property) required_action",
"(resource) beta.threads.runs > (model) run > (schema) > (property) response_format",
"(resource) beta.threads.runs > (model) run > (schema) > (property) started_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) status",
"(resource) beta.threads.runs > (model) run > (schema) > (property) thread_id",
"(resource) beta.threads.runs > (model) run > (schema) > (property) tool_choice",
"(resource) beta.threads.runs > (model) run > (schema) > (property) tools",
"(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy",
"(resource) beta.threads.runs > (model) run > (schema) > (property) usage",
"(resource) beta.threads.runs > (model) run > (schema) > (property) temperature",
"(resource) beta.threads.runs > (model) run > (schema) > (property) top_p"
]
},
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 8 > (property) event > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "thread.run.cancelling"
}
},
"(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.",
"key": "reason",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "max_completion_tokens"
},
{
"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,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) incomplete_details > (property) reason > (member) 0",
"(resource) beta.threads.runs > (model) run > (schema) > (property) incomplete_details > (property) reason > (member) 1"
]
},
"(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`.",
"key": "code",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "server_error"
},
{
"kind": "HttpTypeLiteral",
"literal": "rate_limit_exceeded"
},
{
"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,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) code > (member) 0",
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) code > (member) 1",
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) code > (member) 2"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) message": {
"kind": "HttpDeclProperty",
"docstring": "A human-readable description of the error.",
"key": "message",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunObject/properties/last_error/properties/message",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) $shared > (model) metadata > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/Metadata",
"ident": "Metadata",
"type": {
"kind": "HttpTypeReference",
"ident": "Record",
"typeParameters": [
{
"kind": "HttpTypeString"
},
{
"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": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "thread.run"
}
},
"(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.",
"key": "submit_tool_outputs",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "tool_calls"
}
]
},
"oasRef": "#/components/schemas/RunObject/properties/required_action/properties/submit_tool_outputs",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) required_action > (property) submit_tool_outputs > (property) tool_calls"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) required_action > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "For now, this is always `submit_tool_outputs`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"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,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) required_action > (property) type > (member) 0"
]
},
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 0": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/oneOf/0",
"ident": "UnionMember0",
"type": {
"kind": "HttpTypeUnion",
"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"
]
},
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "ResponseFormatText",
"$ref": "(resource) $shared > (model) response_format_text > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) $shared > (model) response_format_text > (schema) > (property) type"
]
},
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "ResponseFormatJSONObject",
"$ref": "(resource) $shared > (model) response_format_json_object > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) $shared > (model) response_format_json_object > (schema) > (property) type"
]
},
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 3": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "ResponseFormatJSONSchema",
"$ref": "(resource) $shared > (model) response_format_json_schema > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema",
"(resource) $shared > (model) response_format_json_schema > (schema) > (property) type"
]
},
"(resource) beta.threads > (model) assistant_response_format_option > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/AssistantsApiResponseFormatOption",
"ident": "AssistantResponseFormatOption",
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "auto"
}
],
"oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/oneOf/0"
},
{
"kind": "HttpTypeReference",
"ident": "ResponseFormatText",
"$ref": "(resource) $shared > (model) response_format_text > (schema)"
},
{
"kind": "HttpTypeReference",
"ident": "ResponseFormatJSONObject",
"$ref": "(resource) $shared > (model) response_format_json_object > (schema)"
},
{
"kind": "HttpTypeReference",
"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",
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 1",
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 2",
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 3"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "queued"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "in_progress"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "requires_action"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 3": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "cancelling"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 4": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "cancelled"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 5": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "failed"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 6": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "completed"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 7": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "incomplete"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 8": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "expired"
}
},
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/AssistantsApiToolChoiceOption/oneOf/0",
"ident": "UnionMember0",
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "none"
},
{
"kind": "HttpTypeLiteral",
"literal": "auto"
},
{
"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",
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0 > (member) 1",
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0 > (member) 2"
]
},
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "AssistantToolChoice",
"$ref": "(resource) beta.threads > (model) assistant_tool_choice > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) type",
"(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) function"
]
},
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/AssistantsApiToolChoiceOption",
"ident": "AssistantToolChoiceOption",
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "none"
},
{
"kind": "HttpTypeLiteral",
"literal": "auto"
},
{
"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",
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 1"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "CodeInterpreterTool",
"$ref": "(resource) beta.assistants > (model) code_interpreter_tool > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "FileSearchTool",
"$ref": "(resource) beta.assistants > (model) file_search_tool > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) type",
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "FunctionTool",
"$ref": "(resource) beta.assistants > (model) function_tool > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.assistants > (model) function_tool > (schema) > (property) function",
"(resource) beta.assistants > (model) function_tool > (schema) > (property) type"
]
},
"(resource) beta.assistants > (model) code_interpreter_tool > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/AssistantToolsCode",
"ident": "CodeInterpreterTool",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type"
]
},
"(resource) beta.assistants > (model) file_search_tool > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/AssistantToolsFileSearch",
"ident": "FileSearchTool",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
},
{
"ident": "file_search"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) type",
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search"
]
},
"(resource) beta.assistants > (model) function_tool > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/AssistantToolsFunction",
"ident": "FunctionTool",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "function"
},
{
"ident": "type"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.assistants > (model) function_tool > (schema) > (property) function",
"(resource) beta.assistants > (model) function_tool > (schema) > (property) type"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) type": {
"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`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "auto"
},
{
"kind": "HttpTypeLiteral",
"literal": "last_messages"
}
],
"oasRef": "#/components/schemas/TruncationObject/properties/type"
},
"oasRef": "#/components/schemas/TruncationObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) type > (member) 0",
"(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) type > (member) 1"
]
},
"(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.",
"key": "last_messages",
"optional": true,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"minimum": 1
},
"oasRef": "#/components/schemas/TruncationObject/properties/last_messages",
"deprecated": false,
"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.",
"key": "completion_tokens",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"oasRef": "#/components/schemas/RunCompletionUsage/anyOf/0/properties/completion_tokens",
"deprecated": 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.",
"key": "prompt_tokens",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"oasRef": "#/components/schemas/RunCompletionUsage/anyOf/0/properties/prompt_tokens",
"deprecated": 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).",
"key": "total_tokens",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"oasRef": "#/components/schemas/RunCompletionUsage/anyOf/0/properties/total_tokens",
"deprecated": false,
"schemaType": "integer",
"children": []
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) incomplete_details > (property) reason > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "max_completion_tokens"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) incomplete_details > (property) reason > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "max_prompt_tokens"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) code > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "server_error"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) code > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "rate_limit_exceeded"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) code > (member) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "invalid_prompt"
}
},
"(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.",
"key": "tool_calls",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeArray",
"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,
"schemaType": "array",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) id",
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) function",
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) type"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) required_action > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "submit_tool_outputs"
}
},
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 0 > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "auto"
}
},
"(resource) $shared > (model) response_format_text > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The type of response format being defined. Always `text`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "text"
}
],
"oasRef": "#/components/schemas/ResponseFormatText/properties/type"
},
"oasRef": "#/components/schemas/ResponseFormatText/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) $shared > (model) response_format_text > (schema) > (property) type > (member) 0"
]
},
"(resource) $shared > (model) response_format_text > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/ResponseFormatText",
"ident": "ResponseFormatText",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
}
]
},
"docstring": "Default response format. Used to generate text responses.\n",
"childrenParentSchema": "object",
"children": [
"(resource) $shared > (model) response_format_text > (schema) > (property) type"
]
},
"(resource) $shared > (model) response_format_json_object > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The type of response format being defined. Always `json_object`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "json_object"
}
],
"oasRef": "#/components/schemas/ResponseFormatJsonObject/properties/type"
},
"oasRef": "#/components/schemas/ResponseFormatJsonObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) $shared > (model) response_format_json_object > (schema) > (property) type > (member) 0"
]
},
"(resource) $shared > (model) response_format_json_object > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/ResponseFormatJsonObject",
"ident": "ResponseFormatJSONObject",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
}
]
},
"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"
]
},
"(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",
"key": "json_schema",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "name"
},
{
"ident": "description"
},
{
"ident": "schema"
},
{
"ident": "strict"
}
]
},
"oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema > (property) name",
"(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema > (property) description",
"(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema > (property) schema",
"(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema > (property) strict"
]
},
"(resource) $shared > (model) response_format_json_schema > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The type of response format being defined. Always `json_schema`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "json_schema"
}
],
"oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/type"
},
"oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) $shared > (model) response_format_json_schema > (schema) > (property) type > (member) 0"
]
},
"(resource) $shared > (model) response_format_json_schema > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/ResponseFormatJsonSchema",
"ident": "ResponseFormatJSONSchema",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "json_schema"
},
{
"ident": "type"
}
]
},
"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",
"(resource) $shared > (model) response_format_json_schema > (schema) > (property) type"
]
},
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0 > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "none"
}
},
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0 > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "auto"
}
},
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0 > (member) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "required"
}
},
"(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",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "function"
},
{
"kind": "HttpTypeLiteral",
"literal": "code_interpreter"
},
{
"kind": "HttpTypeLiteral",
"literal": "file_search"
}
],
"oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/type"
},
"oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) type > (member) 0",
"(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) type > (member) 1",
"(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) type > (member) 2"
]
},
"(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) function": {
"kind": "HttpDeclProperty",
"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",
"modelImplicit": false,
"modelPath": "(resource) beta.threads > (model) assistant_tool_choice_function",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads > (model) assistant_tool_choice_function > (schema) > (property) name"
]
},
"(resource) beta.threads > (model) assistant_tool_choice > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/AssistantsNamedToolChoice",
"ident": "AssistantToolChoice",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
},
{
"ident": "function"
}
]
},
"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",
"(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) function"
]
},
"(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The type of tool being defined: `code_interpreter`",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "code_interpreter"
}
],
"oasRef": "#/components/schemas/AssistantToolsCode/properties/type"
},
"oasRef": "#/components/schemas/AssistantToolsCode/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type > (member) 0"
]
},
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The type of tool being defined: `file_search`",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "file_search"
}
],
"oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/type"
},
"oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) type > (member) 0"
]
},
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search": {
"kind": "HttpDeclProperty",
"docstring": "Overrides for the file search tool.",
"key": "file_search",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "max_num_results"
},
{
"ident": "ranking_options"
}
]
},
"oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/file_search",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) max_num_results",
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options"
]
},
"(resource) beta.assistants > (model) function_tool > (schema) > (property) function": {
"kind": "HttpDeclProperty",
"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",
"modelImplicit": false,
"modelPath": "(resource) $shared > (model) function_definition",
"childrenParentSchema": "object",
"children": [
"(resource) $shared > (model) function_definition > (schema) > (property) name",
"(resource) $shared > (model) function_definition > (schema) > (property) description",
"(resource) $shared > (model) function_definition > (schema) > (property) parameters",
"(resource) $shared > (model) function_definition > (schema) > (property) strict"
]
},
"(resource) beta.assistants > (model) function_tool > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The type of tool being defined: `function`",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "function"
}
],
"oasRef": "#/components/schemas/AssistantToolsFunction/properties/type"
},
"oasRef": "#/components/schemas/AssistantToolsFunction/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.assistants > (model) function_tool > (schema) > (property) type > (member) 0"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "auto"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) type > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "last_messages"
}
},
"(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.",
"key": "id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunToolCallObject/properties/id",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) function": {
"kind": "HttpDeclProperty",
"docstring": "The function definition.",
"key": "function",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "arguments"
},
{
"ident": "name"
}
]
},
"oasRef": "#/components/schemas/RunToolCallObject/properties/function",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) function > (property) arguments",
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) function > (property) name"
]
},
"(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`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "function"
}
],
"oasRef": "#/components/schemas/RunToolCallObject/properties/type"
},
"oasRef": "#/components/schemas/RunToolCallObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) type > (member) 0"
]
},
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RunToolCallObject",
"ident": "RequiredActionFunctionToolCall",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "id"
},
{
"ident": "function"
},
{
"ident": "type"
}
]
},
"docstring": "Tool call objects",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) id",
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) function",
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) type"
]
},
"(resource) $shared > (model) response_format_text > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "text"
}
},
"(resource) $shared > (model) response_format_json_object > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "json_object"
}
},
"(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",
"key": "name",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/name",
"deprecated": 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",
"key": "description",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/description",
"deprecated": 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",
"key": "schema",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeReference",
"ident": "Record",
"typeParameters": [
{
"kind": "HttpTypeString"
},
{
"kind": "HttpTypeUnknown"
}
],
"oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/schema"
},
"oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/schema",
"deprecated": 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",
"key": "strict",
"optional": true,
"nullable": true,
"default": false,
"type": {
"kind": "HttpTypeBoolean"
},
"oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/strict",
"deprecated": false,
"schemaType": "boolean",
"children": []
},
"(resource) $shared > (model) response_format_json_schema > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "json_schema"
}
},
"(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "function"
}
},
"(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) type > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "code_interpreter"
}
},
"(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) type > (member) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "file_search"
}
},
"(resource) beta.threads > (model) assistant_tool_choice_function > (schema) > (property) name": {
"kind": "HttpDeclProperty",
"docstring": "The name of the function to call.",
"key": "name",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/function/properties/name",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads > (model) assistant_tool_choice_function > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/function",
"ident": "AssistantToolChoiceFunction",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "name"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads > (model) assistant_tool_choice_function > (schema) > (property) name"
]
},
"(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "code_interpreter"
}
},
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "file_search"
}
},
"(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",
"key": "max_num_results",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"minimum": 1,
"maximum": 50
},
"oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/file_search/properties/max_num_results",
"deprecated": 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",
"key": "ranking_options",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "score_threshold"
},
{
"ident": "ranker"
}
]
},
"oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/file_search/properties/ranking_options",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options > (property) score_threshold",
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options > (property) ranker"
]
},
"(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.",
"key": "name",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/FunctionObject/properties/name",
"deprecated": 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.",
"key": "description",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/FunctionObject/properties/description",
"deprecated": 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.",
"key": "parameters",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeReference",
"ident": "FunctionParameters",
"$ref": "(resource) $shared > (model) function_parameters > (schema)"
},
"oasRef": "#/components/schemas/FunctionObject/properties/parameters",
"deprecated": false,
"schemaType": "map",
"modelImplicit": false,
"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).",
"key": "strict",
"optional": true,
"nullable": true,
"default": false,
"type": {
"kind": "HttpTypeBoolean"
},
"oasRef": "#/components/schemas/FunctionObject/properties/strict",
"deprecated": false,
"schemaType": "boolean",
"children": []
},
"(resource) $shared > (model) function_definition > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/FunctionObject",
"ident": "FunctionDefinition",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "name"
},
{
"ident": "description"
},
{
"ident": "parameters"
},
{
"ident": "strict"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) $shared > (model) function_definition > (schema) > (property) name",
"(resource) $shared > (model) function_definition > (schema) > (property) description",
"(resource) $shared > (model) function_definition > (schema) > (property) parameters",
"(resource) $shared > (model) function_definition > (schema) > (property) strict"
]
},
"(resource) beta.assistants > (model) function_tool > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "function"
}
},
"(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.",
"key": "arguments",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunToolCallObject/properties/function/properties/arguments",
"deprecated": 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.",
"key": "name",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunToolCallObject/properties/function/properties/name",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "function"
}
},
"(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.",
"key": "score_threshold",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"minimum": 0,
"maximum": 1
},
"oasRef": "#/components/schemas/FileSearchRankingOptions/properties/score_threshold",
"deprecated": 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.",
"key": "ranker",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "auto"
},
{
"kind": "HttpTypeLiteral",
"literal": "default_2024_08_21"
}
],
"oasRef": "#/components/schemas/FileSearchRankingOptions/properties/ranker"
},
"oasRef": "#/components/schemas/FileSearchRankingOptions/properties/ranker",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options > (property) ranker > (member) 0",
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options > (property) ranker > (member) 1"
]
},
"(resource) $shared > (model) function_parameters > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/FunctionParameters",
"ident": "FunctionParameters",
"type": {
"kind": "HttpTypeReference",
"ident": "Record",
"typeParameters": [
{
"kind": "HttpTypeString"
},
{
"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": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "auto"
}
},
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options > (property) ranker > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "default_2024_08_21"
}
}
}
Example
{}
event
Occurs when a run is cancelled.
Schema
Schema name: (resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 9
{
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 9": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RunStreamEvent/oneOf/8",
"ident": "UnionMember9",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "data"
},
{
"ident": "event"
}
]
},
"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",
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 9 > (property) event"
]
},
"(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).",
"key": "data",
"optional": false,
"nullable": false,
"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",
"modelImplicit": false,
"modelPath": "(resource) beta.threads.runs > (model) run",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) id",
"(resource) beta.threads.runs > (model) run > (schema) > (property) assistant_id",
"(resource) beta.threads.runs > (model) run > (schema) > (property) cancelled_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) completed_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) created_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) expires_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) failed_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) incomplete_details",
"(resource) beta.threads.runs > (model) run > (schema) > (property) instructions",
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error",
"(resource) beta.threads.runs > (model) run > (schema) > (property) max_completion_tokens",
"(resource) beta.threads.runs > (model) run > (schema) > (property) max_prompt_tokens",
"(resource) beta.threads.runs > (model) run > (schema) > (property) metadata",
"(resource) beta.threads.runs > (model) run > (schema) > (property) model",
"(resource) beta.threads.runs > (model) run > (schema) > (property) object",
"(resource) beta.threads.runs > (model) run > (schema) > (property) parallel_tool_calls",
"(resource) beta.threads.runs > (model) run > (schema) > (property) required_action",
"(resource) beta.threads.runs > (model) run > (schema) > (property) response_format",
"(resource) beta.threads.runs > (model) run > (schema) > (property) started_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) status",
"(resource) beta.threads.runs > (model) run > (schema) > (property) thread_id",
"(resource) beta.threads.runs > (model) run > (schema) > (property) tool_choice",
"(resource) beta.threads.runs > (model) run > (schema) > (property) tools",
"(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy",
"(resource) beta.threads.runs > (model) run > (schema) > (property) usage",
"(resource) beta.threads.runs > (model) run > (schema) > (property) temperature",
"(resource) beta.threads.runs > (model) run > (schema) > (property) top_p"
]
},
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 9 > (property) event": {
"kind": "HttpDeclProperty",
"key": "event",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"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,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 9 > (property) event > (member) 0"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) id": {
"kind": "HttpDeclProperty",
"docstring": "The identifier, which can be referenced in API endpoints.",
"key": "id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunObject/properties/id",
"deprecated": 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.",
"key": "assistant_id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunObject/properties/assistant_id",
"deprecated": 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.",
"key": "cancelled_at",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/RunObject/properties/cancelled_at",
"deprecated": false,
"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.",
"key": "completed_at",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/RunObject/properties/completed_at",
"deprecated": false,
"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.",
"key": "created_at",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/RunObject/properties/created_at",
"deprecated": 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.",
"key": "expires_at",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/RunObject/properties/expires_at",
"deprecated": false,
"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.",
"key": "failed_at",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/RunObject/properties/failed_at",
"deprecated": false,
"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.",
"key": "incomplete_details",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "reason"
}
]
},
"oasRef": "#/components/schemas/RunObject/properties/incomplete_details",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) incomplete_details > (property) reason"
]
},
"(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.",
"key": "instructions",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunObject/properties/instructions",
"deprecated": 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.",
"key": "last_error",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "code"
},
{
"ident": "message"
}
]
},
"oasRef": "#/components/schemas/RunObject/properties/last_error",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) code",
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) message"
]
},
"(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",
"key": "max_completion_tokens",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"minimum": 256
},
"oasRef": "#/components/schemas/RunObject/properties/max_completion_tokens",
"deprecated": false,
"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",
"key": "max_prompt_tokens",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"minimum": 256
},
"oasRef": "#/components/schemas/RunObject/properties/max_prompt_tokens",
"deprecated": false,
"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",
"key": "metadata",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeReference",
"ident": "Metadata",
"$ref": "(resource) $shared > (model) metadata > (schema)"
},
"oasRef": "#/components/schemas/RunObject/properties/metadata",
"deprecated": false,
"schemaType": "map",
"modelImplicit": false,
"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.",
"key": "model",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunObject/properties/model",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) object": {
"kind": "HttpDeclProperty",
"docstring": "The object type, which is always `thread.run`.",
"key": "object",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "thread.run"
}
],
"oasRef": "#/components/schemas/RunObject/properties/object"
},
"oasRef": "#/components/schemas/RunObject/properties/object",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) object > (member) 0"
]
},
"(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.",
"key": "parallel_tool_calls",
"optional": false,
"nullable": false,
"default": true,
"type": {
"kind": "HttpTypeBoolean"
},
"oasRef": "#/components/schemas/RunObject/properties/parallel_tool_calls",
"deprecated": 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.",
"key": "required_action",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "submit_tool_outputs"
},
{
"ident": "type"
}
]
},
"oasRef": "#/components/schemas/RunObject/properties/required_action",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) required_action > (property) submit_tool_outputs",
"(resource) beta.threads.runs > (model) run > (schema) > (property) required_action > (property) type"
]
},
"(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",
"key": "response_format",
"optional": false,
"nullable": true,
"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",
"modelImplicit": false,
"modelPath": "(resource) beta.threads > (model) assistant_response_format_option",
"childrenParentSchema": "union",
"children": [
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 0",
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 1",
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 2",
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 3"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) started_at": {
"kind": "HttpDeclProperty",
"docstring": "The Unix timestamp (in seconds) for when the run was started.",
"key": "started_at",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/RunObject/properties/started_at",
"deprecated": false,
"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`.",
"key": "status",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "queued"
},
{
"kind": "HttpTypeLiteral",
"literal": "in_progress"
},
{
"kind": "HttpTypeLiteral",
"literal": "requires_action"
},
{
"kind": "HttpTypeLiteral",
"literal": "cancelling"
},
{
"kind": "HttpTypeLiteral",
"literal": "cancelled"
},
{
"kind": "HttpTypeLiteral",
"literal": "failed"
},
{
"kind": "HttpTypeLiteral",
"literal": "completed"
},
{
"kind": "HttpTypeLiteral",
"literal": "incomplete"
},
{
"kind": "HttpTypeLiteral",
"literal": "expired"
}
],
"oasRef": "#/components/schemas/RunObject/properties/status"
},
"oasRef": "#/components/schemas/RunObject/properties/status",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 0",
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 1",
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 2",
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 3",
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 4",
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 5",
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 6",
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 7",
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 8"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) thread_id": {
"kind": "HttpDeclProperty",
"docstring": "The ID of the [thread](/docs/api-reference/threads) that was executed on as a part of this run.",
"key": "thread_id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunObject/properties/thread_id",
"deprecated": 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",
"key": "tool_choice",
"optional": false,
"nullable": true,
"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",
"modelImplicit": false,
"modelPath": "(resource) beta.threads > (model) assistant_tool_choice_option",
"childrenParentSchema": "union",
"children": [
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0",
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 1"
]
},
"(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.",
"key": "tools",
"optional": false,
"nullable": false,
"default": [],
"type": {
"kind": "HttpTypeArray",
"elementType": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeReference",
"ident": "CodeInterpreterTool",
"$ref": "(resource) beta.assistants > (model) code_interpreter_tool > (schema)"
},
{
"kind": "HttpTypeReference",
"ident": "FileSearchTool",
"$ref": "(resource) beta.assistants > (model) file_search_tool > (schema)"
},
{
"kind": "HttpTypeReference",
"ident": "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,
"schemaType": "array",
"childrenParentSchema": "union",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 0",
"(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 1",
"(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 2"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy": {
"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.",
"key": "truncation_strategy",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
},
{
"ident": "last_messages"
}
]
},
"oasRef": "#/components/schemas/RunObject/properties/truncation_strategy",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) type",
"(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) last_messages"
]
},
"(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.).",
"key": "usage",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "completion_tokens"
},
{
"ident": "prompt_tokens"
},
{
"ident": "total_tokens"
}
]
},
"oasRef": "#/components/schemas/RunObject/properties/usage",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) usage > (property) completion_tokens",
"(resource) beta.threads.runs > (model) run > (schema) > (property) usage > (property) prompt_tokens",
"(resource) beta.threads.runs > (model) run > (schema) > (property) usage > (property) total_tokens"
]
},
"(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.",
"key": "temperature",
"optional": true,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"oasRef": "#/components/schemas/RunObject/properties/temperature",
"deprecated": false,
"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.",
"key": "top_p",
"optional": true,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"oasRef": "#/components/schemas/RunObject/properties/top_p",
"deprecated": false,
"schemaType": "number",
"children": []
},
"(resource) beta.threads.runs > (model) run > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RunObject",
"ident": "Run",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "id"
},
{
"ident": "assistant_id"
},
{
"ident": "cancelled_at"
},
{
"ident": "completed_at"
},
{
"ident": "created_at"
},
{
"ident": "expires_at"
},
{
"ident": "failed_at"
},
{
"ident": "incomplete_details"
},
{
"ident": "instructions"
},
{
"ident": "last_error"
},
{
"ident": "max_completion_tokens"
},
{
"ident": "max_prompt_tokens"
},
{
"ident": "metadata"
},
{
"ident": "model"
},
{
"ident": "object"
},
{
"ident": "parallel_tool_calls"
},
{
"ident": "required_action"
},
{
"ident": "response_format"
},
{
"ident": "started_at"
},
{
"ident": "status"
},
{
"ident": "thread_id"
},
{
"ident": "tool_choice"
},
{
"ident": "tools"
},
{
"ident": "truncation_strategy"
},
{
"ident": "usage"
},
{
"ident": "temperature"
},
{
"ident": "top_p"
}
]
},
"docstring": "Represents an execution run on a [thread](/docs/api-reference/threads).",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) id",
"(resource) beta.threads.runs > (model) run > (schema) > (property) assistant_id",
"(resource) beta.threads.runs > (model) run > (schema) > (property) cancelled_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) completed_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) created_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) expires_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) failed_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) incomplete_details",
"(resource) beta.threads.runs > (model) run > (schema) > (property) instructions",
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error",
"(resource) beta.threads.runs > (model) run > (schema) > (property) max_completion_tokens",
"(resource) beta.threads.runs > (model) run > (schema) > (property) max_prompt_tokens",
"(resource) beta.threads.runs > (model) run > (schema) > (property) metadata",
"(resource) beta.threads.runs > (model) run > (schema) > (property) model",
"(resource) beta.threads.runs > (model) run > (schema) > (property) object",
"(resource) beta.threads.runs > (model) run > (schema) > (property) parallel_tool_calls",
"(resource) beta.threads.runs > (model) run > (schema) > (property) required_action",
"(resource) beta.threads.runs > (model) run > (schema) > (property) response_format",
"(resource) beta.threads.runs > (model) run > (schema) > (property) started_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) status",
"(resource) beta.threads.runs > (model) run > (schema) > (property) thread_id",
"(resource) beta.threads.runs > (model) run > (schema) > (property) tool_choice",
"(resource) beta.threads.runs > (model) run > (schema) > (property) tools",
"(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy",
"(resource) beta.threads.runs > (model) run > (schema) > (property) usage",
"(resource) beta.threads.runs > (model) run > (schema) > (property) temperature",
"(resource) beta.threads.runs > (model) run > (schema) > (property) top_p"
]
},
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 9 > (property) event > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "thread.run.cancelled"
}
},
"(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.",
"key": "reason",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "max_completion_tokens"
},
{
"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,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) incomplete_details > (property) reason > (member) 0",
"(resource) beta.threads.runs > (model) run > (schema) > (property) incomplete_details > (property) reason > (member) 1"
]
},
"(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`.",
"key": "code",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "server_error"
},
{
"kind": "HttpTypeLiteral",
"literal": "rate_limit_exceeded"
},
{
"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,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) code > (member) 0",
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) code > (member) 1",
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) code > (member) 2"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) message": {
"kind": "HttpDeclProperty",
"docstring": "A human-readable description of the error.",
"key": "message",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunObject/properties/last_error/properties/message",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) $shared > (model) metadata > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/Metadata",
"ident": "Metadata",
"type": {
"kind": "HttpTypeReference",
"ident": "Record",
"typeParameters": [
{
"kind": "HttpTypeString"
},
{
"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": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "thread.run"
}
},
"(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.",
"key": "submit_tool_outputs",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "tool_calls"
}
]
},
"oasRef": "#/components/schemas/RunObject/properties/required_action/properties/submit_tool_outputs",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) required_action > (property) submit_tool_outputs > (property) tool_calls"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) required_action > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "For now, this is always `submit_tool_outputs`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"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,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) required_action > (property) type > (member) 0"
]
},
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 0": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/oneOf/0",
"ident": "UnionMember0",
"type": {
"kind": "HttpTypeUnion",
"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"
]
},
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "ResponseFormatText",
"$ref": "(resource) $shared > (model) response_format_text > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) $shared > (model) response_format_text > (schema) > (property) type"
]
},
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "ResponseFormatJSONObject",
"$ref": "(resource) $shared > (model) response_format_json_object > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) $shared > (model) response_format_json_object > (schema) > (property) type"
]
},
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 3": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "ResponseFormatJSONSchema",
"$ref": "(resource) $shared > (model) response_format_json_schema > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema",
"(resource) $shared > (model) response_format_json_schema > (schema) > (property) type"
]
},
"(resource) beta.threads > (model) assistant_response_format_option > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/AssistantsApiResponseFormatOption",
"ident": "AssistantResponseFormatOption",
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "auto"
}
],
"oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/oneOf/0"
},
{
"kind": "HttpTypeReference",
"ident": "ResponseFormatText",
"$ref": "(resource) $shared > (model) response_format_text > (schema)"
},
{
"kind": "HttpTypeReference",
"ident": "ResponseFormatJSONObject",
"$ref": "(resource) $shared > (model) response_format_json_object > (schema)"
},
{
"kind": "HttpTypeReference",
"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",
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 1",
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 2",
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 3"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "queued"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "in_progress"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "requires_action"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 3": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "cancelling"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 4": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "cancelled"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 5": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "failed"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 6": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "completed"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 7": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "incomplete"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 8": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "expired"
}
},
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/AssistantsApiToolChoiceOption/oneOf/0",
"ident": "UnionMember0",
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "none"
},
{
"kind": "HttpTypeLiteral",
"literal": "auto"
},
{
"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",
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0 > (member) 1",
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0 > (member) 2"
]
},
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "AssistantToolChoice",
"$ref": "(resource) beta.threads > (model) assistant_tool_choice > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) type",
"(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) function"
]
},
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/AssistantsApiToolChoiceOption",
"ident": "AssistantToolChoiceOption",
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "none"
},
{
"kind": "HttpTypeLiteral",
"literal": "auto"
},
{
"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",
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 1"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "CodeInterpreterTool",
"$ref": "(resource) beta.assistants > (model) code_interpreter_tool > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "FileSearchTool",
"$ref": "(resource) beta.assistants > (model) file_search_tool > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) type",
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "FunctionTool",
"$ref": "(resource) beta.assistants > (model) function_tool > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.assistants > (model) function_tool > (schema) > (property) function",
"(resource) beta.assistants > (model) function_tool > (schema) > (property) type"
]
},
"(resource) beta.assistants > (model) code_interpreter_tool > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/AssistantToolsCode",
"ident": "CodeInterpreterTool",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type"
]
},
"(resource) beta.assistants > (model) file_search_tool > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/AssistantToolsFileSearch",
"ident": "FileSearchTool",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
},
{
"ident": "file_search"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) type",
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search"
]
},
"(resource) beta.assistants > (model) function_tool > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/AssistantToolsFunction",
"ident": "FunctionTool",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "function"
},
{
"ident": "type"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.assistants > (model) function_tool > (schema) > (property) function",
"(resource) beta.assistants > (model) function_tool > (schema) > (property) type"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) type": {
"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`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "auto"
},
{
"kind": "HttpTypeLiteral",
"literal": "last_messages"
}
],
"oasRef": "#/components/schemas/TruncationObject/properties/type"
},
"oasRef": "#/components/schemas/TruncationObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) type > (member) 0",
"(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) type > (member) 1"
]
},
"(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.",
"key": "last_messages",
"optional": true,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"minimum": 1
},
"oasRef": "#/components/schemas/TruncationObject/properties/last_messages",
"deprecated": false,
"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.",
"key": "completion_tokens",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"oasRef": "#/components/schemas/RunCompletionUsage/anyOf/0/properties/completion_tokens",
"deprecated": 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.",
"key": "prompt_tokens",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"oasRef": "#/components/schemas/RunCompletionUsage/anyOf/0/properties/prompt_tokens",
"deprecated": 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).",
"key": "total_tokens",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"oasRef": "#/components/schemas/RunCompletionUsage/anyOf/0/properties/total_tokens",
"deprecated": false,
"schemaType": "integer",
"children": []
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) incomplete_details > (property) reason > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "max_completion_tokens"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) incomplete_details > (property) reason > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "max_prompt_tokens"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) code > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "server_error"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) code > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "rate_limit_exceeded"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) code > (member) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "invalid_prompt"
}
},
"(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.",
"key": "tool_calls",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeArray",
"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,
"schemaType": "array",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) id",
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) function",
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) type"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) required_action > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "submit_tool_outputs"
}
},
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 0 > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "auto"
}
},
"(resource) $shared > (model) response_format_text > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The type of response format being defined. Always `text`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "text"
}
],
"oasRef": "#/components/schemas/ResponseFormatText/properties/type"
},
"oasRef": "#/components/schemas/ResponseFormatText/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) $shared > (model) response_format_text > (schema) > (property) type > (member) 0"
]
},
"(resource) $shared > (model) response_format_text > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/ResponseFormatText",
"ident": "ResponseFormatText",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
}
]
},
"docstring": "Default response format. Used to generate text responses.\n",
"childrenParentSchema": "object",
"children": [
"(resource) $shared > (model) response_format_text > (schema) > (property) type"
]
},
"(resource) $shared > (model) response_format_json_object > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The type of response format being defined. Always `json_object`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "json_object"
}
],
"oasRef": "#/components/schemas/ResponseFormatJsonObject/properties/type"
},
"oasRef": "#/components/schemas/ResponseFormatJsonObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) $shared > (model) response_format_json_object > (schema) > (property) type > (member) 0"
]
},
"(resource) $shared > (model) response_format_json_object > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/ResponseFormatJsonObject",
"ident": "ResponseFormatJSONObject",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
}
]
},
"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"
]
},
"(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",
"key": "json_schema",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "name"
},
{
"ident": "description"
},
{
"ident": "schema"
},
{
"ident": "strict"
}
]
},
"oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema > (property) name",
"(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema > (property) description",
"(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema > (property) schema",
"(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema > (property) strict"
]
},
"(resource) $shared > (model) response_format_json_schema > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The type of response format being defined. Always `json_schema`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "json_schema"
}
],
"oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/type"
},
"oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) $shared > (model) response_format_json_schema > (schema) > (property) type > (member) 0"
]
},
"(resource) $shared > (model) response_format_json_schema > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/ResponseFormatJsonSchema",
"ident": "ResponseFormatJSONSchema",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "json_schema"
},
{
"ident": "type"
}
]
},
"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",
"(resource) $shared > (model) response_format_json_schema > (schema) > (property) type"
]
},
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0 > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "none"
}
},
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0 > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "auto"
}
},
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0 > (member) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "required"
}
},
"(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",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "function"
},
{
"kind": "HttpTypeLiteral",
"literal": "code_interpreter"
},
{
"kind": "HttpTypeLiteral",
"literal": "file_search"
}
],
"oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/type"
},
"oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) type > (member) 0",
"(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) type > (member) 1",
"(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) type > (member) 2"
]
},
"(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) function": {
"kind": "HttpDeclProperty",
"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",
"modelImplicit": false,
"modelPath": "(resource) beta.threads > (model) assistant_tool_choice_function",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads > (model) assistant_tool_choice_function > (schema) > (property) name"
]
},
"(resource) beta.threads > (model) assistant_tool_choice > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/AssistantsNamedToolChoice",
"ident": "AssistantToolChoice",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
},
{
"ident": "function"
}
]
},
"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",
"(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) function"
]
},
"(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The type of tool being defined: `code_interpreter`",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "code_interpreter"
}
],
"oasRef": "#/components/schemas/AssistantToolsCode/properties/type"
},
"oasRef": "#/components/schemas/AssistantToolsCode/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type > (member) 0"
]
},
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The type of tool being defined: `file_search`",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "file_search"
}
],
"oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/type"
},
"oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) type > (member) 0"
]
},
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search": {
"kind": "HttpDeclProperty",
"docstring": "Overrides for the file search tool.",
"key": "file_search",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "max_num_results"
},
{
"ident": "ranking_options"
}
]
},
"oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/file_search",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) max_num_results",
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options"
]
},
"(resource) beta.assistants > (model) function_tool > (schema) > (property) function": {
"kind": "HttpDeclProperty",
"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",
"modelImplicit": false,
"modelPath": "(resource) $shared > (model) function_definition",
"childrenParentSchema": "object",
"children": [
"(resource) $shared > (model) function_definition > (schema) > (property) name",
"(resource) $shared > (model) function_definition > (schema) > (property) description",
"(resource) $shared > (model) function_definition > (schema) > (property) parameters",
"(resource) $shared > (model) function_definition > (schema) > (property) strict"
]
},
"(resource) beta.assistants > (model) function_tool > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The type of tool being defined: `function`",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "function"
}
],
"oasRef": "#/components/schemas/AssistantToolsFunction/properties/type"
},
"oasRef": "#/components/schemas/AssistantToolsFunction/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.assistants > (model) function_tool > (schema) > (property) type > (member) 0"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "auto"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) type > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "last_messages"
}
},
"(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.",
"key": "id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunToolCallObject/properties/id",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) function": {
"kind": "HttpDeclProperty",
"docstring": "The function definition.",
"key": "function",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "arguments"
},
{
"ident": "name"
}
]
},
"oasRef": "#/components/schemas/RunToolCallObject/properties/function",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) function > (property) arguments",
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) function > (property) name"
]
},
"(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`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "function"
}
],
"oasRef": "#/components/schemas/RunToolCallObject/properties/type"
},
"oasRef": "#/components/schemas/RunToolCallObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) type > (member) 0"
]
},
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RunToolCallObject",
"ident": "RequiredActionFunctionToolCall",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "id"
},
{
"ident": "function"
},
{
"ident": "type"
}
]
},
"docstring": "Tool call objects",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) id",
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) function",
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) type"
]
},
"(resource) $shared > (model) response_format_text > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "text"
}
},
"(resource) $shared > (model) response_format_json_object > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "json_object"
}
},
"(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",
"key": "name",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/name",
"deprecated": 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",
"key": "description",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/description",
"deprecated": 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",
"key": "schema",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeReference",
"ident": "Record",
"typeParameters": [
{
"kind": "HttpTypeString"
},
{
"kind": "HttpTypeUnknown"
}
],
"oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/schema"
},
"oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/schema",
"deprecated": 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",
"key": "strict",
"optional": true,
"nullable": true,
"default": false,
"type": {
"kind": "HttpTypeBoolean"
},
"oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/strict",
"deprecated": false,
"schemaType": "boolean",
"children": []
},
"(resource) $shared > (model) response_format_json_schema > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "json_schema"
}
},
"(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "function"
}
},
"(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) type > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "code_interpreter"
}
},
"(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) type > (member) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "file_search"
}
},
"(resource) beta.threads > (model) assistant_tool_choice_function > (schema) > (property) name": {
"kind": "HttpDeclProperty",
"docstring": "The name of the function to call.",
"key": "name",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/function/properties/name",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads > (model) assistant_tool_choice_function > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/function",
"ident": "AssistantToolChoiceFunction",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "name"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads > (model) assistant_tool_choice_function > (schema) > (property) name"
]
},
"(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "code_interpreter"
}
},
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "file_search"
}
},
"(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",
"key": "max_num_results",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"minimum": 1,
"maximum": 50
},
"oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/file_search/properties/max_num_results",
"deprecated": 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",
"key": "ranking_options",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "score_threshold"
},
{
"ident": "ranker"
}
]
},
"oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/file_search/properties/ranking_options",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options > (property) score_threshold",
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options > (property) ranker"
]
},
"(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.",
"key": "name",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/FunctionObject/properties/name",
"deprecated": 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.",
"key": "description",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/FunctionObject/properties/description",
"deprecated": 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.",
"key": "parameters",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeReference",
"ident": "FunctionParameters",
"$ref": "(resource) $shared > (model) function_parameters > (schema)"
},
"oasRef": "#/components/schemas/FunctionObject/properties/parameters",
"deprecated": false,
"schemaType": "map",
"modelImplicit": false,
"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).",
"key": "strict",
"optional": true,
"nullable": true,
"default": false,
"type": {
"kind": "HttpTypeBoolean"
},
"oasRef": "#/components/schemas/FunctionObject/properties/strict",
"deprecated": false,
"schemaType": "boolean",
"children": []
},
"(resource) $shared > (model) function_definition > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/FunctionObject",
"ident": "FunctionDefinition",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "name"
},
{
"ident": "description"
},
{
"ident": "parameters"
},
{
"ident": "strict"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) $shared > (model) function_definition > (schema) > (property) name",
"(resource) $shared > (model) function_definition > (schema) > (property) description",
"(resource) $shared > (model) function_definition > (schema) > (property) parameters",
"(resource) $shared > (model) function_definition > (schema) > (property) strict"
]
},
"(resource) beta.assistants > (model) function_tool > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "function"
}
},
"(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.",
"key": "arguments",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunToolCallObject/properties/function/properties/arguments",
"deprecated": 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.",
"key": "name",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunToolCallObject/properties/function/properties/name",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "function"
}
},
"(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.",
"key": "score_threshold",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"minimum": 0,
"maximum": 1
},
"oasRef": "#/components/schemas/FileSearchRankingOptions/properties/score_threshold",
"deprecated": 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.",
"key": "ranker",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "auto"
},
{
"kind": "HttpTypeLiteral",
"literal": "default_2024_08_21"
}
],
"oasRef": "#/components/schemas/FileSearchRankingOptions/properties/ranker"
},
"oasRef": "#/components/schemas/FileSearchRankingOptions/properties/ranker",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options > (property) ranker > (member) 0",
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options > (property) ranker > (member) 1"
]
},
"(resource) $shared > (model) function_parameters > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/FunctionParameters",
"ident": "FunctionParameters",
"type": {
"kind": "HttpTypeReference",
"ident": "Record",
"typeParameters": [
{
"kind": "HttpTypeString"
},
{
"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": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "auto"
}
},
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options > (property) ranker > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "default_2024_08_21"
}
}
}
Example
{}
event
Occurs when a run expires.
Schema
Schema name: (resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 10
{
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 10": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RunStreamEvent/oneOf/9",
"ident": "UnionMember10",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "data"
},
{
"ident": "event"
}
]
},
"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",
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 10 > (property) event"
]
},
"(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).",
"key": "data",
"optional": false,
"nullable": false,
"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",
"modelImplicit": false,
"modelPath": "(resource) beta.threads.runs > (model) run",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) id",
"(resource) beta.threads.runs > (model) run > (schema) > (property) assistant_id",
"(resource) beta.threads.runs > (model) run > (schema) > (property) cancelled_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) completed_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) created_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) expires_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) failed_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) incomplete_details",
"(resource) beta.threads.runs > (model) run > (schema) > (property) instructions",
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error",
"(resource) beta.threads.runs > (model) run > (schema) > (property) max_completion_tokens",
"(resource) beta.threads.runs > (model) run > (schema) > (property) max_prompt_tokens",
"(resource) beta.threads.runs > (model) run > (schema) > (property) metadata",
"(resource) beta.threads.runs > (model) run > (schema) > (property) model",
"(resource) beta.threads.runs > (model) run > (schema) > (property) object",
"(resource) beta.threads.runs > (model) run > (schema) > (property) parallel_tool_calls",
"(resource) beta.threads.runs > (model) run > (schema) > (property) required_action",
"(resource) beta.threads.runs > (model) run > (schema) > (property) response_format",
"(resource) beta.threads.runs > (model) run > (schema) > (property) started_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) status",
"(resource) beta.threads.runs > (model) run > (schema) > (property) thread_id",
"(resource) beta.threads.runs > (model) run > (schema) > (property) tool_choice",
"(resource) beta.threads.runs > (model) run > (schema) > (property) tools",
"(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy",
"(resource) beta.threads.runs > (model) run > (schema) > (property) usage",
"(resource) beta.threads.runs > (model) run > (schema) > (property) temperature",
"(resource) beta.threads.runs > (model) run > (schema) > (property) top_p"
]
},
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 10 > (property) event": {
"kind": "HttpDeclProperty",
"key": "event",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"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,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 10 > (property) event > (member) 0"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) id": {
"kind": "HttpDeclProperty",
"docstring": "The identifier, which can be referenced in API endpoints.",
"key": "id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunObject/properties/id",
"deprecated": 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.",
"key": "assistant_id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunObject/properties/assistant_id",
"deprecated": 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.",
"key": "cancelled_at",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/RunObject/properties/cancelled_at",
"deprecated": false,
"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.",
"key": "completed_at",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/RunObject/properties/completed_at",
"deprecated": false,
"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.",
"key": "created_at",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/RunObject/properties/created_at",
"deprecated": 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.",
"key": "expires_at",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/RunObject/properties/expires_at",
"deprecated": false,
"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.",
"key": "failed_at",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/RunObject/properties/failed_at",
"deprecated": false,
"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.",
"key": "incomplete_details",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "reason"
}
]
},
"oasRef": "#/components/schemas/RunObject/properties/incomplete_details",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) incomplete_details > (property) reason"
]
},
"(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.",
"key": "instructions",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunObject/properties/instructions",
"deprecated": 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.",
"key": "last_error",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "code"
},
{
"ident": "message"
}
]
},
"oasRef": "#/components/schemas/RunObject/properties/last_error",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) code",
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) message"
]
},
"(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",
"key": "max_completion_tokens",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"minimum": 256
},
"oasRef": "#/components/schemas/RunObject/properties/max_completion_tokens",
"deprecated": false,
"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",
"key": "max_prompt_tokens",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"minimum": 256
},
"oasRef": "#/components/schemas/RunObject/properties/max_prompt_tokens",
"deprecated": false,
"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",
"key": "metadata",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeReference",
"ident": "Metadata",
"$ref": "(resource) $shared > (model) metadata > (schema)"
},
"oasRef": "#/components/schemas/RunObject/properties/metadata",
"deprecated": false,
"schemaType": "map",
"modelImplicit": false,
"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.",
"key": "model",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunObject/properties/model",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) object": {
"kind": "HttpDeclProperty",
"docstring": "The object type, which is always `thread.run`.",
"key": "object",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "thread.run"
}
],
"oasRef": "#/components/schemas/RunObject/properties/object"
},
"oasRef": "#/components/schemas/RunObject/properties/object",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) object > (member) 0"
]
},
"(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.",
"key": "parallel_tool_calls",
"optional": false,
"nullable": false,
"default": true,
"type": {
"kind": "HttpTypeBoolean"
},
"oasRef": "#/components/schemas/RunObject/properties/parallel_tool_calls",
"deprecated": 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.",
"key": "required_action",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "submit_tool_outputs"
},
{
"ident": "type"
}
]
},
"oasRef": "#/components/schemas/RunObject/properties/required_action",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) required_action > (property) submit_tool_outputs",
"(resource) beta.threads.runs > (model) run > (schema) > (property) required_action > (property) type"
]
},
"(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",
"key": "response_format",
"optional": false,
"nullable": true,
"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",
"modelImplicit": false,
"modelPath": "(resource) beta.threads > (model) assistant_response_format_option",
"childrenParentSchema": "union",
"children": [
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 0",
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 1",
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 2",
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 3"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) started_at": {
"kind": "HttpDeclProperty",
"docstring": "The Unix timestamp (in seconds) for when the run was started.",
"key": "started_at",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/RunObject/properties/started_at",
"deprecated": false,
"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`.",
"key": "status",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "queued"
},
{
"kind": "HttpTypeLiteral",
"literal": "in_progress"
},
{
"kind": "HttpTypeLiteral",
"literal": "requires_action"
},
{
"kind": "HttpTypeLiteral",
"literal": "cancelling"
},
{
"kind": "HttpTypeLiteral",
"literal": "cancelled"
},
{
"kind": "HttpTypeLiteral",
"literal": "failed"
},
{
"kind": "HttpTypeLiteral",
"literal": "completed"
},
{
"kind": "HttpTypeLiteral",
"literal": "incomplete"
},
{
"kind": "HttpTypeLiteral",
"literal": "expired"
}
],
"oasRef": "#/components/schemas/RunObject/properties/status"
},
"oasRef": "#/components/schemas/RunObject/properties/status",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 0",
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 1",
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 2",
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 3",
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 4",
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 5",
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 6",
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 7",
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 8"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) thread_id": {
"kind": "HttpDeclProperty",
"docstring": "The ID of the [thread](/docs/api-reference/threads) that was executed on as a part of this run.",
"key": "thread_id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunObject/properties/thread_id",
"deprecated": 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",
"key": "tool_choice",
"optional": false,
"nullable": true,
"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",
"modelImplicit": false,
"modelPath": "(resource) beta.threads > (model) assistant_tool_choice_option",
"childrenParentSchema": "union",
"children": [
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0",
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 1"
]
},
"(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.",
"key": "tools",
"optional": false,
"nullable": false,
"default": [],
"type": {
"kind": "HttpTypeArray",
"elementType": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeReference",
"ident": "CodeInterpreterTool",
"$ref": "(resource) beta.assistants > (model) code_interpreter_tool > (schema)"
},
{
"kind": "HttpTypeReference",
"ident": "FileSearchTool",
"$ref": "(resource) beta.assistants > (model) file_search_tool > (schema)"
},
{
"kind": "HttpTypeReference",
"ident": "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,
"schemaType": "array",
"childrenParentSchema": "union",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 0",
"(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 1",
"(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 2"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy": {
"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.",
"key": "truncation_strategy",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
},
{
"ident": "last_messages"
}
]
},
"oasRef": "#/components/schemas/RunObject/properties/truncation_strategy",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) type",
"(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) last_messages"
]
},
"(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.).",
"key": "usage",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "completion_tokens"
},
{
"ident": "prompt_tokens"
},
{
"ident": "total_tokens"
}
]
},
"oasRef": "#/components/schemas/RunObject/properties/usage",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) usage > (property) completion_tokens",
"(resource) beta.threads.runs > (model) run > (schema) > (property) usage > (property) prompt_tokens",
"(resource) beta.threads.runs > (model) run > (schema) > (property) usage > (property) total_tokens"
]
},
"(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.",
"key": "temperature",
"optional": true,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"oasRef": "#/components/schemas/RunObject/properties/temperature",
"deprecated": false,
"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.",
"key": "top_p",
"optional": true,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"oasRef": "#/components/schemas/RunObject/properties/top_p",
"deprecated": false,
"schemaType": "number",
"children": []
},
"(resource) beta.threads.runs > (model) run > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RunObject",
"ident": "Run",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "id"
},
{
"ident": "assistant_id"
},
{
"ident": "cancelled_at"
},
{
"ident": "completed_at"
},
{
"ident": "created_at"
},
{
"ident": "expires_at"
},
{
"ident": "failed_at"
},
{
"ident": "incomplete_details"
},
{
"ident": "instructions"
},
{
"ident": "last_error"
},
{
"ident": "max_completion_tokens"
},
{
"ident": "max_prompt_tokens"
},
{
"ident": "metadata"
},
{
"ident": "model"
},
{
"ident": "object"
},
{
"ident": "parallel_tool_calls"
},
{
"ident": "required_action"
},
{
"ident": "response_format"
},
{
"ident": "started_at"
},
{
"ident": "status"
},
{
"ident": "thread_id"
},
{
"ident": "tool_choice"
},
{
"ident": "tools"
},
{
"ident": "truncation_strategy"
},
{
"ident": "usage"
},
{
"ident": "temperature"
},
{
"ident": "top_p"
}
]
},
"docstring": "Represents an execution run on a [thread](/docs/api-reference/threads).",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) id",
"(resource) beta.threads.runs > (model) run > (schema) > (property) assistant_id",
"(resource) beta.threads.runs > (model) run > (schema) > (property) cancelled_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) completed_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) created_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) expires_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) failed_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) incomplete_details",
"(resource) beta.threads.runs > (model) run > (schema) > (property) instructions",
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error",
"(resource) beta.threads.runs > (model) run > (schema) > (property) max_completion_tokens",
"(resource) beta.threads.runs > (model) run > (schema) > (property) max_prompt_tokens",
"(resource) beta.threads.runs > (model) run > (schema) > (property) metadata",
"(resource) beta.threads.runs > (model) run > (schema) > (property) model",
"(resource) beta.threads.runs > (model) run > (schema) > (property) object",
"(resource) beta.threads.runs > (model) run > (schema) > (property) parallel_tool_calls",
"(resource) beta.threads.runs > (model) run > (schema) > (property) required_action",
"(resource) beta.threads.runs > (model) run > (schema) > (property) response_format",
"(resource) beta.threads.runs > (model) run > (schema) > (property) started_at",
"(resource) beta.threads.runs > (model) run > (schema) > (property) status",
"(resource) beta.threads.runs > (model) run > (schema) > (property) thread_id",
"(resource) beta.threads.runs > (model) run > (schema) > (property) tool_choice",
"(resource) beta.threads.runs > (model) run > (schema) > (property) tools",
"(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy",
"(resource) beta.threads.runs > (model) run > (schema) > (property) usage",
"(resource) beta.threads.runs > (model) run > (schema) > (property) temperature",
"(resource) beta.threads.runs > (model) run > (schema) > (property) top_p"
]
},
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 10 > (property) event > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "thread.run.expired"
}
},
"(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.",
"key": "reason",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "max_completion_tokens"
},
{
"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,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) incomplete_details > (property) reason > (member) 0",
"(resource) beta.threads.runs > (model) run > (schema) > (property) incomplete_details > (property) reason > (member) 1"
]
},
"(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`.",
"key": "code",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "server_error"
},
{
"kind": "HttpTypeLiteral",
"literal": "rate_limit_exceeded"
},
{
"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,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) code > (member) 0",
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) code > (member) 1",
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) code > (member) 2"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) message": {
"kind": "HttpDeclProperty",
"docstring": "A human-readable description of the error.",
"key": "message",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunObject/properties/last_error/properties/message",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) $shared > (model) metadata > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/Metadata",
"ident": "Metadata",
"type": {
"kind": "HttpTypeReference",
"ident": "Record",
"typeParameters": [
{
"kind": "HttpTypeString"
},
{
"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": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "thread.run"
}
},
"(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.",
"key": "submit_tool_outputs",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "tool_calls"
}
]
},
"oasRef": "#/components/schemas/RunObject/properties/required_action/properties/submit_tool_outputs",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) required_action > (property) submit_tool_outputs > (property) tool_calls"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) required_action > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "For now, this is always `submit_tool_outputs`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"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,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) required_action > (property) type > (member) 0"
]
},
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 0": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/oneOf/0",
"ident": "UnionMember0",
"type": {
"kind": "HttpTypeUnion",
"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"
]
},
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "ResponseFormatText",
"$ref": "(resource) $shared > (model) response_format_text > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) $shared > (model) response_format_text > (schema) > (property) type"
]
},
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "ResponseFormatJSONObject",
"$ref": "(resource) $shared > (model) response_format_json_object > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) $shared > (model) response_format_json_object > (schema) > (property) type"
]
},
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 3": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "ResponseFormatJSONSchema",
"$ref": "(resource) $shared > (model) response_format_json_schema > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema",
"(resource) $shared > (model) response_format_json_schema > (schema) > (property) type"
]
},
"(resource) beta.threads > (model) assistant_response_format_option > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/AssistantsApiResponseFormatOption",
"ident": "AssistantResponseFormatOption",
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "auto"
}
],
"oasRef": "#/components/schemas/AssistantsApiResponseFormatOption/oneOf/0"
},
{
"kind": "HttpTypeReference",
"ident": "ResponseFormatText",
"$ref": "(resource) $shared > (model) response_format_text > (schema)"
},
{
"kind": "HttpTypeReference",
"ident": "ResponseFormatJSONObject",
"$ref": "(resource) $shared > (model) response_format_json_object > (schema)"
},
{
"kind": "HttpTypeReference",
"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",
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 1",
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 2",
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 3"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "queued"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "in_progress"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "requires_action"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 3": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "cancelling"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 4": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "cancelled"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 5": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "failed"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 6": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "completed"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 7": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "incomplete"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) status > (member) 8": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "expired"
}
},
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/AssistantsApiToolChoiceOption/oneOf/0",
"ident": "UnionMember0",
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "none"
},
{
"kind": "HttpTypeLiteral",
"literal": "auto"
},
{
"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",
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0 > (member) 1",
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0 > (member) 2"
]
},
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "AssistantToolChoice",
"$ref": "(resource) beta.threads > (model) assistant_tool_choice > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) type",
"(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) function"
]
},
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/AssistantsApiToolChoiceOption",
"ident": "AssistantToolChoiceOption",
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "none"
},
{
"kind": "HttpTypeLiteral",
"literal": "auto"
},
{
"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",
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 1"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "CodeInterpreterTool",
"$ref": "(resource) beta.assistants > (model) code_interpreter_tool > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "FileSearchTool",
"$ref": "(resource) beta.assistants > (model) file_search_tool > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) type",
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) tools > (items) > (variant) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "FunctionTool",
"$ref": "(resource) beta.assistants > (model) function_tool > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.assistants > (model) function_tool > (schema) > (property) function",
"(resource) beta.assistants > (model) function_tool > (schema) > (property) type"
]
},
"(resource) beta.assistants > (model) code_interpreter_tool > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/AssistantToolsCode",
"ident": "CodeInterpreterTool",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type"
]
},
"(resource) beta.assistants > (model) file_search_tool > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/AssistantToolsFileSearch",
"ident": "FileSearchTool",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
},
{
"ident": "file_search"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) type",
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search"
]
},
"(resource) beta.assistants > (model) function_tool > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/AssistantToolsFunction",
"ident": "FunctionTool",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "function"
},
{
"ident": "type"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.assistants > (model) function_tool > (schema) > (property) function",
"(resource) beta.assistants > (model) function_tool > (schema) > (property) type"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) type": {
"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`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "auto"
},
{
"kind": "HttpTypeLiteral",
"literal": "last_messages"
}
],
"oasRef": "#/components/schemas/TruncationObject/properties/type"
},
"oasRef": "#/components/schemas/TruncationObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) type > (member) 0",
"(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) type > (member) 1"
]
},
"(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.",
"key": "last_messages",
"optional": true,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"minimum": 1
},
"oasRef": "#/components/schemas/TruncationObject/properties/last_messages",
"deprecated": false,
"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.",
"key": "completion_tokens",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"oasRef": "#/components/schemas/RunCompletionUsage/anyOf/0/properties/completion_tokens",
"deprecated": 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.",
"key": "prompt_tokens",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"oasRef": "#/components/schemas/RunCompletionUsage/anyOf/0/properties/prompt_tokens",
"deprecated": 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).",
"key": "total_tokens",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"oasRef": "#/components/schemas/RunCompletionUsage/anyOf/0/properties/total_tokens",
"deprecated": false,
"schemaType": "integer",
"children": []
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) incomplete_details > (property) reason > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "max_completion_tokens"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) incomplete_details > (property) reason > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "max_prompt_tokens"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) code > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "server_error"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) code > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "rate_limit_exceeded"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) last_error > (property) code > (member) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "invalid_prompt"
}
},
"(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.",
"key": "tool_calls",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeArray",
"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,
"schemaType": "array",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) id",
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) function",
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) type"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) required_action > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "submit_tool_outputs"
}
},
"(resource) beta.threads > (model) assistant_response_format_option > (schema) > (variant) 0 > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "auto"
}
},
"(resource) $shared > (model) response_format_text > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The type of response format being defined. Always `text`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "text"
}
],
"oasRef": "#/components/schemas/ResponseFormatText/properties/type"
},
"oasRef": "#/components/schemas/ResponseFormatText/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) $shared > (model) response_format_text > (schema) > (property) type > (member) 0"
]
},
"(resource) $shared > (model) response_format_text > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/ResponseFormatText",
"ident": "ResponseFormatText",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
}
]
},
"docstring": "Default response format. Used to generate text responses.\n",
"childrenParentSchema": "object",
"children": [
"(resource) $shared > (model) response_format_text > (schema) > (property) type"
]
},
"(resource) $shared > (model) response_format_json_object > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The type of response format being defined. Always `json_object`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "json_object"
}
],
"oasRef": "#/components/schemas/ResponseFormatJsonObject/properties/type"
},
"oasRef": "#/components/schemas/ResponseFormatJsonObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) $shared > (model) response_format_json_object > (schema) > (property) type > (member) 0"
]
},
"(resource) $shared > (model) response_format_json_object > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/ResponseFormatJsonObject",
"ident": "ResponseFormatJSONObject",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
}
]
},
"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"
]
},
"(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",
"key": "json_schema",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "name"
},
{
"ident": "description"
},
{
"ident": "schema"
},
{
"ident": "strict"
}
]
},
"oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema > (property) name",
"(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema > (property) description",
"(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema > (property) schema",
"(resource) $shared > (model) response_format_json_schema > (schema) > (property) json_schema > (property) strict"
]
},
"(resource) $shared > (model) response_format_json_schema > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The type of response format being defined. Always `json_schema`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "json_schema"
}
],
"oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/type"
},
"oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) $shared > (model) response_format_json_schema > (schema) > (property) type > (member) 0"
]
},
"(resource) $shared > (model) response_format_json_schema > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/ResponseFormatJsonSchema",
"ident": "ResponseFormatJSONSchema",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "json_schema"
},
{
"ident": "type"
}
]
},
"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",
"(resource) $shared > (model) response_format_json_schema > (schema) > (property) type"
]
},
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0 > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "none"
}
},
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0 > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "auto"
}
},
"(resource) beta.threads > (model) assistant_tool_choice_option > (schema) > (variant) 0 > (member) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "required"
}
},
"(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",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "function"
},
{
"kind": "HttpTypeLiteral",
"literal": "code_interpreter"
},
{
"kind": "HttpTypeLiteral",
"literal": "file_search"
}
],
"oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/type"
},
"oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) type > (member) 0",
"(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) type > (member) 1",
"(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) type > (member) 2"
]
},
"(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) function": {
"kind": "HttpDeclProperty",
"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",
"modelImplicit": false,
"modelPath": "(resource) beta.threads > (model) assistant_tool_choice_function",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads > (model) assistant_tool_choice_function > (schema) > (property) name"
]
},
"(resource) beta.threads > (model) assistant_tool_choice > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/AssistantsNamedToolChoice",
"ident": "AssistantToolChoice",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
},
{
"ident": "function"
}
]
},
"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",
"(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) function"
]
},
"(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The type of tool being defined: `code_interpreter`",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "code_interpreter"
}
],
"oasRef": "#/components/schemas/AssistantToolsCode/properties/type"
},
"oasRef": "#/components/schemas/AssistantToolsCode/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type > (member) 0"
]
},
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The type of tool being defined: `file_search`",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "file_search"
}
],
"oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/type"
},
"oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) type > (member) 0"
]
},
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search": {
"kind": "HttpDeclProperty",
"docstring": "Overrides for the file search tool.",
"key": "file_search",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "max_num_results"
},
{
"ident": "ranking_options"
}
]
},
"oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/file_search",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) max_num_results",
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options"
]
},
"(resource) beta.assistants > (model) function_tool > (schema) > (property) function": {
"kind": "HttpDeclProperty",
"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",
"modelImplicit": false,
"modelPath": "(resource) $shared > (model) function_definition",
"childrenParentSchema": "object",
"children": [
"(resource) $shared > (model) function_definition > (schema) > (property) name",
"(resource) $shared > (model) function_definition > (schema) > (property) description",
"(resource) $shared > (model) function_definition > (schema) > (property) parameters",
"(resource) $shared > (model) function_definition > (schema) > (property) strict"
]
},
"(resource) beta.assistants > (model) function_tool > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The type of tool being defined: `function`",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "function"
}
],
"oasRef": "#/components/schemas/AssistantToolsFunction/properties/type"
},
"oasRef": "#/components/schemas/AssistantToolsFunction/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.assistants > (model) function_tool > (schema) > (property) type > (member) 0"
]
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "auto"
}
},
"(resource) beta.threads.runs > (model) run > (schema) > (property) truncation_strategy > (property) type > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "last_messages"
}
},
"(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.",
"key": "id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunToolCallObject/properties/id",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) function": {
"kind": "HttpDeclProperty",
"docstring": "The function definition.",
"key": "function",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "arguments"
},
{
"ident": "name"
}
]
},
"oasRef": "#/components/schemas/RunToolCallObject/properties/function",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) function > (property) arguments",
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) function > (property) name"
]
},
"(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`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "function"
}
],
"oasRef": "#/components/schemas/RunToolCallObject/properties/type"
},
"oasRef": "#/components/schemas/RunToolCallObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) type > (member) 0"
]
},
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RunToolCallObject",
"ident": "RequiredActionFunctionToolCall",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "id"
},
{
"ident": "function"
},
{
"ident": "type"
}
]
},
"docstring": "Tool call objects",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) id",
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) function",
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) type"
]
},
"(resource) $shared > (model) response_format_text > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "text"
}
},
"(resource) $shared > (model) response_format_json_object > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "json_object"
}
},
"(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",
"key": "name",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/name",
"deprecated": 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",
"key": "description",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/description",
"deprecated": 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",
"key": "schema",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeReference",
"ident": "Record",
"typeParameters": [
{
"kind": "HttpTypeString"
},
{
"kind": "HttpTypeUnknown"
}
],
"oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/schema"
},
"oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/schema",
"deprecated": 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",
"key": "strict",
"optional": true,
"nullable": true,
"default": false,
"type": {
"kind": "HttpTypeBoolean"
},
"oasRef": "#/components/schemas/ResponseFormatJsonSchema/properties/json_schema/properties/strict",
"deprecated": false,
"schemaType": "boolean",
"children": []
},
"(resource) $shared > (model) response_format_json_schema > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "json_schema"
}
},
"(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "function"
}
},
"(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) type > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "code_interpreter"
}
},
"(resource) beta.threads > (model) assistant_tool_choice > (schema) > (property) type > (member) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "file_search"
}
},
"(resource) beta.threads > (model) assistant_tool_choice_function > (schema) > (property) name": {
"kind": "HttpDeclProperty",
"docstring": "The name of the function to call.",
"key": "name",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/function/properties/name",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads > (model) assistant_tool_choice_function > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/AssistantsNamedToolChoice/properties/function",
"ident": "AssistantToolChoiceFunction",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "name"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads > (model) assistant_tool_choice_function > (schema) > (property) name"
]
},
"(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "code_interpreter"
}
},
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "file_search"
}
},
"(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",
"key": "max_num_results",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"minimum": 1,
"maximum": 50
},
"oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/file_search/properties/max_num_results",
"deprecated": 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",
"key": "ranking_options",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "score_threshold"
},
{
"ident": "ranker"
}
]
},
"oasRef": "#/components/schemas/AssistantToolsFileSearch/properties/file_search/properties/ranking_options",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options > (property) score_threshold",
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options > (property) ranker"
]
},
"(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.",
"key": "name",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/FunctionObject/properties/name",
"deprecated": 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.",
"key": "description",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/FunctionObject/properties/description",
"deprecated": 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.",
"key": "parameters",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeReference",
"ident": "FunctionParameters",
"$ref": "(resource) $shared > (model) function_parameters > (schema)"
},
"oasRef": "#/components/schemas/FunctionObject/properties/parameters",
"deprecated": false,
"schemaType": "map",
"modelImplicit": false,
"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).",
"key": "strict",
"optional": true,
"nullable": true,
"default": false,
"type": {
"kind": "HttpTypeBoolean"
},
"oasRef": "#/components/schemas/FunctionObject/properties/strict",
"deprecated": false,
"schemaType": "boolean",
"children": []
},
"(resource) $shared > (model) function_definition > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/FunctionObject",
"ident": "FunctionDefinition",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "name"
},
{
"ident": "description"
},
{
"ident": "parameters"
},
{
"ident": "strict"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) $shared > (model) function_definition > (schema) > (property) name",
"(resource) $shared > (model) function_definition > (schema) > (property) description",
"(resource) $shared > (model) function_definition > (schema) > (property) parameters",
"(resource) $shared > (model) function_definition > (schema) > (property) strict"
]
},
"(resource) beta.assistants > (model) function_tool > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "function"
}
},
"(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.",
"key": "arguments",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunToolCallObject/properties/function/properties/arguments",
"deprecated": 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.",
"key": "name",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunToolCallObject/properties/function/properties/name",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.runs > (model) required_action_function_tool_call > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "function"
}
},
"(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.",
"key": "score_threshold",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"minimum": 0,
"maximum": 1
},
"oasRef": "#/components/schemas/FileSearchRankingOptions/properties/score_threshold",
"deprecated": 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.",
"key": "ranker",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "auto"
},
{
"kind": "HttpTypeLiteral",
"literal": "default_2024_08_21"
}
],
"oasRef": "#/components/schemas/FileSearchRankingOptions/properties/ranker"
},
"oasRef": "#/components/schemas/FileSearchRankingOptions/properties/ranker",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options > (property) ranker > (member) 0",
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options > (property) ranker > (member) 1"
]
},
"(resource) $shared > (model) function_parameters > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/FunctionParameters",
"ident": "FunctionParameters",
"type": {
"kind": "HttpTypeReference",
"ident": "Record",
"typeParameters": [
{
"kind": "HttpTypeString"
},
{
"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": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "auto"
}
},
"(resource) beta.assistants > (model) file_search_tool > (schema) > (property) file_search > (property) ranking_options > (property) ranker > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "default_2024_08_21"
}
}
}
Example
{}
event
Occurs when a run step is created.
Schema
Schema name: (resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 11
{
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 11": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RunStepStreamEvent/oneOf/0",
"ident": "UnionMember11",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "data"
},
{
"ident": "event"
}
]
},
"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",
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 11 > (property) event"
]
},
"(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",
"key": "data",
"optional": false,
"nullable": false,
"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",
"modelImplicit": false,
"modelPath": "(resource) beta.threads.runs.steps > (model) run_step",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) id",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) assistant_id",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) cancelled_at",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) completed_at",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) created_at",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) expired_at",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) failed_at",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) last_error",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) metadata",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) object",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) run_id",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) status",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) step_details",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) thread_id",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) type",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) usage"
]
},
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 11 > (property) event": {
"kind": "HttpDeclProperty",
"key": "event",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"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,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 11 > (property) event > (member) 0"
]
},
"(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.",
"key": "id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepObject/properties/id",
"deprecated": 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.",
"key": "assistant_id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepObject/properties/assistant_id",
"deprecated": 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.",
"key": "cancelled_at",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/RunStepObject/properties/cancelled_at",
"deprecated": false,
"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.",
"key": "completed_at",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/RunStepObject/properties/completed_at",
"deprecated": false,
"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.",
"key": "created_at",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/RunStepObject/properties/created_at",
"deprecated": 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.",
"key": "expired_at",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/RunStepObject/properties/expired_at",
"deprecated": false,
"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.",
"key": "failed_at",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/RunStepObject/properties/failed_at",
"deprecated": false,
"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.",
"key": "last_error",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "code"
},
{
"ident": "message"
}
]
},
"oasRef": "#/components/schemas/RunStepObject/properties/last_error",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) last_error > (property) code",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) last_error > (property) message"
]
},
"(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",
"key": "metadata",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeReference",
"ident": "Metadata",
"$ref": "(resource) $shared > (model) metadata > (schema)"
},
"oasRef": "#/components/schemas/RunStepObject/properties/metadata",
"deprecated": false,
"schemaType": "map",
"modelImplicit": false,
"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`.",
"key": "object",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "thread.run.step"
}
],
"oasRef": "#/components/schemas/RunStepObject/properties/object"
},
"oasRef": "#/components/schemas/RunStepObject/properties/object",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) object > (member) 0"
]
},
"(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.",
"key": "run_id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepObject/properties/run_id",
"deprecated": 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`.",
"key": "status",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "in_progress"
},
{
"kind": "HttpTypeLiteral",
"literal": "cancelled"
},
{
"kind": "HttpTypeLiteral",
"literal": "failed"
},
{
"kind": "HttpTypeLiteral",
"literal": "completed"
},
{
"kind": "HttpTypeLiteral",
"literal": "expired"
}
],
"oasRef": "#/components/schemas/RunStepObject/properties/status"
},
"oasRef": "#/components/schemas/RunStepObject/properties/status",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) status > (member) 0",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) status > (member) 1",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) status > (member) 2",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) status > (member) 3",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) status > (member) 4"
]
},
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) step_details": {
"kind": "HttpDeclProperty",
"docstring": "The details of the run step.",
"key": "step_details",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeReference",
"ident": "MessageCreationStepDetails",
"$ref": "(resource) beta.threads.runs.steps > (model) message_creation_step_details > (schema)"
},
{
"kind": "HttpTypeReference",
"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,
"schemaType": "union",
"childrenParentSchema": "union",
"children": [
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) step_details > (variant) 0",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) step_details > (variant) 1"
]
},
"(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.",
"key": "thread_id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepObject/properties/thread_id",
"deprecated": 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`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "message_creation"
},
{
"kind": "HttpTypeLiteral",
"literal": "tool_calls"
}
],
"oasRef": "#/components/schemas/RunStepObject/properties/type"
},
"oasRef": "#/components/schemas/RunStepObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) type > (member) 0",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) type > (member) 1"
]
},
"(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`.",
"key": "usage",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "completion_tokens"
},
{
"ident": "prompt_tokens"
},
{
"ident": "total_tokens"
}
]
},
"oasRef": "#/components/schemas/RunStepObject/properties/usage",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) usage > (property) completion_tokens",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) usage > (property) prompt_tokens",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) usage > (property) total_tokens"
]
},
"(resource) beta.threads.runs.steps > (model) run_step > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RunStepObject",
"ident": "RunStep",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "id"
},
{
"ident": "assistant_id"
},
{
"ident": "cancelled_at"
},
{
"ident": "completed_at"
},
{
"ident": "created_at"
},
{
"ident": "expired_at"
},
{
"ident": "failed_at"
},
{
"ident": "last_error"
},
{
"ident": "metadata"
},
{
"ident": "object"
},
{
"ident": "run_id"
},
{
"ident": "status"
},
{
"ident": "step_details"
},
{
"ident": "thread_id"
},
{
"ident": "type"
},
{
"ident": "usage"
}
]
},
"docstring": "Represents a step in execution of a run.\n",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) id",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) assistant_id",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) cancelled_at",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) completed_at",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) created_at",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) expired_at",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) failed_at",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) last_error",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) metadata",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) object",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) run_id",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) status",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) step_details",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) thread_id",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) type",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) usage"
]
},
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 11 > (property) event > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "thread.run.step.created"
}
},
"(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`.",
"key": "code",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "server_error"
},
{
"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,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) last_error > (property) code > (member) 0",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) last_error > (property) code > (member) 1"
]
},
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) last_error > (property) message": {
"kind": "HttpDeclProperty",
"docstring": "A human-readable description of the error.",
"key": "message",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepObject/properties/last_error/anyOf/0/properties/message",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) $shared > (model) metadata > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/Metadata",
"ident": "Metadata",
"type": {
"kind": "HttpTypeReference",
"ident": "Record",
"typeParameters": [
{
"kind": "HttpTypeString"
},
{
"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": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "thread.run.step"
}
},
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) status > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "in_progress"
}
},
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) status > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "cancelled"
}
},
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) status > (member) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "failed"
}
},
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) status > (member) 3": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "completed"
}
},
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) status > (member) 4": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "expired"
}
},
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) step_details > (variant) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "MessageCreationStepDetails",
"$ref": "(resource) beta.threads.runs.steps > (model) message_creation_step_details > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) message_creation_step_details > (schema) > (property) message_creation",
"(resource) beta.threads.runs.steps > (model) message_creation_step_details > (schema) > (property) type"
]
},
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) step_details > (variant) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "ToolCallsStepDetails",
"$ref": "(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) tool_calls",
"(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) type"
]
},
"(resource) beta.threads.runs.steps > (model) message_creation_step_details > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RunStepDetailsMessageCreationObject",
"ident": "MessageCreationStepDetails",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "message_creation"
},
{
"ident": "type"
}
]
},
"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",
"(resource) beta.threads.runs.steps > (model) message_creation_step_details > (schema) > (property) type"
]
},
"(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RunStepDetailsToolCallsObject",
"ident": "ToolCallsStepDetails",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "tool_calls"
},
{
"ident": "type"
}
]
},
"docstring": "Details of the tool call.",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) tool_calls",
"(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) type"
]
},
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "message_creation"
}
},
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) type > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "tool_calls"
}
},
"(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.",
"key": "completion_tokens",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"oasRef": "#/components/schemas/RunStepCompletionUsage/anyOf/0/properties/completion_tokens",
"deprecated": 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.",
"key": "prompt_tokens",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"oasRef": "#/components/schemas/RunStepCompletionUsage/anyOf/0/properties/prompt_tokens",
"deprecated": 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).",
"key": "total_tokens",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"oasRef": "#/components/schemas/RunStepCompletionUsage/anyOf/0/properties/total_tokens",
"deprecated": false,
"schemaType": "integer",
"children": []
},
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) last_error > (property) code > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "server_error"
}
},
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) last_error > (property) code > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "rate_limit_exceeded"
}
},
"(resource) beta.threads.runs.steps > (model) message_creation_step_details > (schema) > (property) message_creation": {
"kind": "HttpDeclProperty",
"key": "message_creation",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "message_id"
}
]
},
"oasRef": "#/components/schemas/RunStepDetailsMessageCreationObject/properties/message_creation",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) message_creation_step_details > (schema) > (property) message_creation > (property) message_id"
]
},
"(resource) beta.threads.runs.steps > (model) message_creation_step_details > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "Always `message_creation`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "message_creation"
}
],
"oasRef": "#/components/schemas/RunStepDetailsMessageCreationObject/properties/type"
},
"oasRef": "#/components/schemas/RunStepDetailsMessageCreationObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs.steps > (model) message_creation_step_details > (schema) > (property) type > (member) 0"
]
},
"(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",
"key": "tool_calls",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeArray",
"elementType": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeReference",
"ident": "CodeInterpreterToolCall",
"$ref": "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema)"
},
{
"kind": "HttpTypeReference",
"ident": "FileSearchToolCall",
"$ref": "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema)"
},
{
"kind": "HttpTypeReference",
"ident": "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,
"schemaType": "array",
"childrenParentSchema": "union",
"children": [
"(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) tool_calls > (items) > (variant) 0",
"(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) tool_calls > (items) > (variant) 1",
"(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) tool_calls > (items) > (variant) 2"
]
},
"(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "Always `tool_calls`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "tool_calls"
}
],
"oasRef": "#/components/schemas/RunStepDetailsToolCallsObject/properties/type"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) type > (member) 0"
]
},
"(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.",
"key": "message_id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepDetailsMessageCreationObject/properties/message_creation/properties/message_id",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.runs.steps > (model) message_creation_step_details > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "message_creation"
}
},
"(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) tool_calls > (items) > (variant) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "CodeInterpreterToolCall",
"$ref": "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) id",
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter",
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) type"
]
},
"(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) tool_calls > (items) > (variant) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "FileSearchToolCall",
"$ref": "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) id",
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search",
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) type"
]
},
"(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) tool_calls > (items) > (variant) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "FunctionToolCall",
"$ref": "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) id",
"(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) function",
"(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) type"
]
},
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject",
"ident": "CodeInterpreterToolCall",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "id"
},
{
"ident": "code_interpreter"
},
{
"ident": "type"
}
]
},
"docstring": "Details of the Code Interpreter tool call the run step was involved in.",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) id",
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter",
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) type"
]
},
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject",
"ident": "FileSearchToolCall",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "id"
},
{
"ident": "file_search"
},
{
"ident": "type"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) id",
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search",
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) type"
]
},
"(resource) beta.threads.runs.steps > (model) function_tool_call > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject",
"ident": "FunctionToolCall",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "id"
},
{
"ident": "function"
},
{
"ident": "type"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) id",
"(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) function",
"(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) type"
]
},
"(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "tool_calls"
}
},
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) id": {
"kind": "HttpDeclProperty",
"docstring": "The ID of the tool call.",
"key": "id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/id",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter": {
"kind": "HttpDeclProperty",
"docstring": "The Code Interpreter tool call definition.",
"key": "code_interpreter",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "input"
},
{
"ident": "outputs"
}
]
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) input",
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs"
]
},
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The type of tool call. This is always going to be `code_interpreter` for this type of tool call.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "code_interpreter"
}
],
"oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/type"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) type > (member) 0"
]
},
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) id": {
"kind": "HttpDeclProperty",
"docstring": "The ID of the tool call object.",
"key": "id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/id",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search": {
"kind": "HttpDeclProperty",
"docstring": "For now, this is always going to be an empty object.",
"key": "file_search",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "ranking_options"
},
{
"ident": "results"
}
]
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/file_search",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) ranking_options",
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) results"
]
},
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The type of tool call. This is always going to be `file_search` for this type of tool call.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "file_search"
}
],
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/type"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) type > (member) 0"
]
},
"(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) id": {
"kind": "HttpDeclProperty",
"docstring": "The ID of the tool call object.",
"key": "id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/id",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) function": {
"kind": "HttpDeclProperty",
"docstring": "The definition of the function that was called.",
"key": "function",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "arguments"
},
{
"ident": "name"
},
{
"ident": "output"
}
]
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/function",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) function > (property) arguments",
"(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) function > (property) name",
"(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) function > (property) output"
]
},
"(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The type of tool call. This is always going to be `function` for this type of tool call.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "function"
}
],
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/type"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) type > (member) 0"
]
},
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) input": {
"kind": "HttpDeclProperty",
"docstring": "The input to the Code Interpreter tool call.",
"key": "input",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter/properties/input",
"deprecated": 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.",
"key": "outputs",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeArray",
"elementType": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeObject",
"members": [
{
"ident": "logs"
},
{
"ident": "type"
}
]
},
{
"kind": "HttpTypeObject",
"members": [
{
"ident": "image"
},
{
"ident": "type"
}
]
}
],
"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,
"schemaType": "array",
"childrenParentSchema": "union",
"children": [
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 0",
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 1"
]
},
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "code_interpreter"
}
},
"(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.",
"key": "ranking_options",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "ranker"
},
{
"ident": "score_threshold"
}
]
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/file_search/properties/ranking_options",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) ranking_options > (property) ranker",
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) ranking_options > (property) score_threshold"
]
},
"(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.",
"key": "results",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeArray",
"elementType": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "file_id"
},
{
"ident": "file_name"
},
{
"ident": "score"
},
{
"ident": "content"
}
]
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/file_search/properties/results"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/file_search/properties/results",
"deprecated": false,
"schemaType": "array",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) results > (items) > (property) file_id",
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) results > (items) > (property) file_name",
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) results > (items) > (property) score",
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) results > (items) > (property) content"
]
},
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "file_search"
}
},
"(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) function > (property) arguments": {
"kind": "HttpDeclProperty",
"docstring": "The arguments passed to the function.",
"key": "arguments",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/function/properties/arguments",
"deprecated": 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.",
"key": "name",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/function/properties/name",
"deprecated": 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.",
"key": "output",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/function/properties/output",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "function"
}
},
"(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",
"ident": "CodeInterpreterLogOutput",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "logs"
},
{
"ident": "type"
}
]
},
"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",
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 0 > (property) type"
]
},
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 1": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter/properties/outputs/items/oneOf/1",
"ident": "CodeInterpreterImageOutput",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "image"
},
{
"ident": "type"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 1 > (property) image",
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 1 > (property) type"
]
},
"(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.",
"key": "ranker",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "auto"
},
{
"kind": "HttpTypeLiteral",
"literal": "default_2024_08_21"
}
],
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchRankingOptionsObject/properties/ranker"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchRankingOptionsObject/properties/ranker",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) ranking_options > (property) ranker > (member) 0",
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) ranking_options > (property) ranker > (member) 1"
]
},
"(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.",
"key": "score_threshold",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"minimum": 0,
"maximum": 1
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchRankingOptionsObject/properties/score_threshold",
"deprecated": 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.",
"key": "file_id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/file_id",
"deprecated": 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.",
"key": "file_name",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/file_name",
"deprecated": 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.",
"key": "score",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"minimum": 0,
"maximum": 1
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/score",
"deprecated": 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.",
"key": "content",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeArray",
"elementType": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "text"
},
{
"ident": "type"
}
]
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/content"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/content",
"deprecated": false,
"schemaType": "array",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) results > (items) > (property) content > (items) > (property) text",
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) results > (items) > (property) content > (items) > (property) type"
]
},
"(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.",
"key": "logs",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputLogsObject/properties/logs",
"deprecated": 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`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "logs"
}
],
"oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputLogsObject/properties/type"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputLogsObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 0 > (property) type > (member) 0"
]
},
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 1 > (property) image": {
"kind": "HttpDeclProperty",
"key": "image",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "file_id"
}
]
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputImageObject/properties/image",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 1 > (property) image > (property) file_id"
]
},
"(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`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "image"
}
],
"oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputImageObject/properties/type"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputImageObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 1 > (property) type > (member) 0"
]
},
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) ranking_options > (property) ranker > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "auto"
}
},
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) ranking_options > (property) ranker > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "default_2024_08_21"
}
},
"(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.",
"key": "text",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/content/items/properties/text",
"deprecated": 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.",
"key": "type",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"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,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) results > (items) > (property) content > (items) > (property) type > (member) 0"
]
},
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 0 > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "logs"
}
},
"(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.",
"key": "file_id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputImageObject/properties/image/properties/file_id",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 1 > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "image"
}
},
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) results > (items) > (property) content > (items) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "text"
}
}
}
Example
{}
event
Occurs when a run step moves to an in_progress state.
Schema
Schema name: (resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 12
{
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 12": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RunStepStreamEvent/oneOf/1",
"ident": "UnionMember12",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "data"
},
{
"ident": "event"
}
]
},
"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",
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 12 > (property) event"
]
},
"(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",
"key": "data",
"optional": false,
"nullable": false,
"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",
"modelImplicit": false,
"modelPath": "(resource) beta.threads.runs.steps > (model) run_step",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) id",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) assistant_id",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) cancelled_at",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) completed_at",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) created_at",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) expired_at",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) failed_at",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) last_error",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) metadata",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) object",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) run_id",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) status",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) step_details",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) thread_id",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) type",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) usage"
]
},
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 12 > (property) event": {
"kind": "HttpDeclProperty",
"key": "event",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"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,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 12 > (property) event > (member) 0"
]
},
"(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.",
"key": "id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepObject/properties/id",
"deprecated": 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.",
"key": "assistant_id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepObject/properties/assistant_id",
"deprecated": 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.",
"key": "cancelled_at",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/RunStepObject/properties/cancelled_at",
"deprecated": false,
"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.",
"key": "completed_at",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/RunStepObject/properties/completed_at",
"deprecated": false,
"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.",
"key": "created_at",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/RunStepObject/properties/created_at",
"deprecated": 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.",
"key": "expired_at",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/RunStepObject/properties/expired_at",
"deprecated": false,
"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.",
"key": "failed_at",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/RunStepObject/properties/failed_at",
"deprecated": false,
"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.",
"key": "last_error",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "code"
},
{
"ident": "message"
}
]
},
"oasRef": "#/components/schemas/RunStepObject/properties/last_error",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) last_error > (property) code",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) last_error > (property) message"
]
},
"(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",
"key": "metadata",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeReference",
"ident": "Metadata",
"$ref": "(resource) $shared > (model) metadata > (schema)"
},
"oasRef": "#/components/schemas/RunStepObject/properties/metadata",
"deprecated": false,
"schemaType": "map",
"modelImplicit": false,
"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`.",
"key": "object",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "thread.run.step"
}
],
"oasRef": "#/components/schemas/RunStepObject/properties/object"
},
"oasRef": "#/components/schemas/RunStepObject/properties/object",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) object > (member) 0"
]
},
"(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.",
"key": "run_id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepObject/properties/run_id",
"deprecated": 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`.",
"key": "status",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "in_progress"
},
{
"kind": "HttpTypeLiteral",
"literal": "cancelled"
},
{
"kind": "HttpTypeLiteral",
"literal": "failed"
},
{
"kind": "HttpTypeLiteral",
"literal": "completed"
},
{
"kind": "HttpTypeLiteral",
"literal": "expired"
}
],
"oasRef": "#/components/schemas/RunStepObject/properties/status"
},
"oasRef": "#/components/schemas/RunStepObject/properties/status",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) status > (member) 0",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) status > (member) 1",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) status > (member) 2",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) status > (member) 3",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) status > (member) 4"
]
},
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) step_details": {
"kind": "HttpDeclProperty",
"docstring": "The details of the run step.",
"key": "step_details",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeReference",
"ident": "MessageCreationStepDetails",
"$ref": "(resource) beta.threads.runs.steps > (model) message_creation_step_details > (schema)"
},
{
"kind": "HttpTypeReference",
"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,
"schemaType": "union",
"childrenParentSchema": "union",
"children": [
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) step_details > (variant) 0",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) step_details > (variant) 1"
]
},
"(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.",
"key": "thread_id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepObject/properties/thread_id",
"deprecated": 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`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "message_creation"
},
{
"kind": "HttpTypeLiteral",
"literal": "tool_calls"
}
],
"oasRef": "#/components/schemas/RunStepObject/properties/type"
},
"oasRef": "#/components/schemas/RunStepObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) type > (member) 0",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) type > (member) 1"
]
},
"(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`.",
"key": "usage",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "completion_tokens"
},
{
"ident": "prompt_tokens"
},
{
"ident": "total_tokens"
}
]
},
"oasRef": "#/components/schemas/RunStepObject/properties/usage",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) usage > (property) completion_tokens",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) usage > (property) prompt_tokens",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) usage > (property) total_tokens"
]
},
"(resource) beta.threads.runs.steps > (model) run_step > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RunStepObject",
"ident": "RunStep",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "id"
},
{
"ident": "assistant_id"
},
{
"ident": "cancelled_at"
},
{
"ident": "completed_at"
},
{
"ident": "created_at"
},
{
"ident": "expired_at"
},
{
"ident": "failed_at"
},
{
"ident": "last_error"
},
{
"ident": "metadata"
},
{
"ident": "object"
},
{
"ident": "run_id"
},
{
"ident": "status"
},
{
"ident": "step_details"
},
{
"ident": "thread_id"
},
{
"ident": "type"
},
{
"ident": "usage"
}
]
},
"docstring": "Represents a step in execution of a run.\n",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) id",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) assistant_id",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) cancelled_at",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) completed_at",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) created_at",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) expired_at",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) failed_at",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) last_error",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) metadata",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) object",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) run_id",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) status",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) step_details",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) thread_id",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) type",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) usage"
]
},
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 12 > (property) event > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "thread.run.step.in_progress"
}
},
"(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`.",
"key": "code",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "server_error"
},
{
"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,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) last_error > (property) code > (member) 0",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) last_error > (property) code > (member) 1"
]
},
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) last_error > (property) message": {
"kind": "HttpDeclProperty",
"docstring": "A human-readable description of the error.",
"key": "message",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepObject/properties/last_error/anyOf/0/properties/message",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) $shared > (model) metadata > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/Metadata",
"ident": "Metadata",
"type": {
"kind": "HttpTypeReference",
"ident": "Record",
"typeParameters": [
{
"kind": "HttpTypeString"
},
{
"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": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "thread.run.step"
}
},
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) status > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "in_progress"
}
},
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) status > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "cancelled"
}
},
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) status > (member) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "failed"
}
},
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) status > (member) 3": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "completed"
}
},
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) status > (member) 4": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "expired"
}
},
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) step_details > (variant) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "MessageCreationStepDetails",
"$ref": "(resource) beta.threads.runs.steps > (model) message_creation_step_details > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) message_creation_step_details > (schema) > (property) message_creation",
"(resource) beta.threads.runs.steps > (model) message_creation_step_details > (schema) > (property) type"
]
},
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) step_details > (variant) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "ToolCallsStepDetails",
"$ref": "(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) tool_calls",
"(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) type"
]
},
"(resource) beta.threads.runs.steps > (model) message_creation_step_details > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RunStepDetailsMessageCreationObject",
"ident": "MessageCreationStepDetails",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "message_creation"
},
{
"ident": "type"
}
]
},
"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",
"(resource) beta.threads.runs.steps > (model) message_creation_step_details > (schema) > (property) type"
]
},
"(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RunStepDetailsToolCallsObject",
"ident": "ToolCallsStepDetails",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "tool_calls"
},
{
"ident": "type"
}
]
},
"docstring": "Details of the tool call.",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) tool_calls",
"(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) type"
]
},
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "message_creation"
}
},
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) type > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "tool_calls"
}
},
"(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.",
"key": "completion_tokens",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"oasRef": "#/components/schemas/RunStepCompletionUsage/anyOf/0/properties/completion_tokens",
"deprecated": 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.",
"key": "prompt_tokens",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"oasRef": "#/components/schemas/RunStepCompletionUsage/anyOf/0/properties/prompt_tokens",
"deprecated": 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).",
"key": "total_tokens",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"oasRef": "#/components/schemas/RunStepCompletionUsage/anyOf/0/properties/total_tokens",
"deprecated": false,
"schemaType": "integer",
"children": []
},
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) last_error > (property) code > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "server_error"
}
},
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) last_error > (property) code > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "rate_limit_exceeded"
}
},
"(resource) beta.threads.runs.steps > (model) message_creation_step_details > (schema) > (property) message_creation": {
"kind": "HttpDeclProperty",
"key": "message_creation",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "message_id"
}
]
},
"oasRef": "#/components/schemas/RunStepDetailsMessageCreationObject/properties/message_creation",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) message_creation_step_details > (schema) > (property) message_creation > (property) message_id"
]
},
"(resource) beta.threads.runs.steps > (model) message_creation_step_details > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "Always `message_creation`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "message_creation"
}
],
"oasRef": "#/components/schemas/RunStepDetailsMessageCreationObject/properties/type"
},
"oasRef": "#/components/schemas/RunStepDetailsMessageCreationObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs.steps > (model) message_creation_step_details > (schema) > (property) type > (member) 0"
]
},
"(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",
"key": "tool_calls",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeArray",
"elementType": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeReference",
"ident": "CodeInterpreterToolCall",
"$ref": "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema)"
},
{
"kind": "HttpTypeReference",
"ident": "FileSearchToolCall",
"$ref": "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema)"
},
{
"kind": "HttpTypeReference",
"ident": "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,
"schemaType": "array",
"childrenParentSchema": "union",
"children": [
"(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) tool_calls > (items) > (variant) 0",
"(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) tool_calls > (items) > (variant) 1",
"(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) tool_calls > (items) > (variant) 2"
]
},
"(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "Always `tool_calls`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "tool_calls"
}
],
"oasRef": "#/components/schemas/RunStepDetailsToolCallsObject/properties/type"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) type > (member) 0"
]
},
"(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.",
"key": "message_id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepDetailsMessageCreationObject/properties/message_creation/properties/message_id",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.runs.steps > (model) message_creation_step_details > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "message_creation"
}
},
"(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) tool_calls > (items) > (variant) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "CodeInterpreterToolCall",
"$ref": "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) id",
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter",
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) type"
]
},
"(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) tool_calls > (items) > (variant) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "FileSearchToolCall",
"$ref": "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) id",
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search",
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) type"
]
},
"(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) tool_calls > (items) > (variant) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "FunctionToolCall",
"$ref": "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) id",
"(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) function",
"(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) type"
]
},
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject",
"ident": "CodeInterpreterToolCall",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "id"
},
{
"ident": "code_interpreter"
},
{
"ident": "type"
}
]
},
"docstring": "Details of the Code Interpreter tool call the run step was involved in.",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) id",
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter",
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) type"
]
},
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject",
"ident": "FileSearchToolCall",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "id"
},
{
"ident": "file_search"
},
{
"ident": "type"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) id",
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search",
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) type"
]
},
"(resource) beta.threads.runs.steps > (model) function_tool_call > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject",
"ident": "FunctionToolCall",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "id"
},
{
"ident": "function"
},
{
"ident": "type"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) id",
"(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) function",
"(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) type"
]
},
"(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "tool_calls"
}
},
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) id": {
"kind": "HttpDeclProperty",
"docstring": "The ID of the tool call.",
"key": "id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/id",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter": {
"kind": "HttpDeclProperty",
"docstring": "The Code Interpreter tool call definition.",
"key": "code_interpreter",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "input"
},
{
"ident": "outputs"
}
]
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) input",
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs"
]
},
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The type of tool call. This is always going to be `code_interpreter` for this type of tool call.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "code_interpreter"
}
],
"oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/type"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) type > (member) 0"
]
},
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) id": {
"kind": "HttpDeclProperty",
"docstring": "The ID of the tool call object.",
"key": "id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/id",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search": {
"kind": "HttpDeclProperty",
"docstring": "For now, this is always going to be an empty object.",
"key": "file_search",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "ranking_options"
},
{
"ident": "results"
}
]
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/file_search",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) ranking_options",
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) results"
]
},
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The type of tool call. This is always going to be `file_search` for this type of tool call.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "file_search"
}
],
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/type"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) type > (member) 0"
]
},
"(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) id": {
"kind": "HttpDeclProperty",
"docstring": "The ID of the tool call object.",
"key": "id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/id",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) function": {
"kind": "HttpDeclProperty",
"docstring": "The definition of the function that was called.",
"key": "function",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "arguments"
},
{
"ident": "name"
},
{
"ident": "output"
}
]
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/function",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) function > (property) arguments",
"(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) function > (property) name",
"(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) function > (property) output"
]
},
"(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The type of tool call. This is always going to be `function` for this type of tool call.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "function"
}
],
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/type"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) type > (member) 0"
]
},
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) input": {
"kind": "HttpDeclProperty",
"docstring": "The input to the Code Interpreter tool call.",
"key": "input",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter/properties/input",
"deprecated": 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.",
"key": "outputs",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeArray",
"elementType": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeObject",
"members": [
{
"ident": "logs"
},
{
"ident": "type"
}
]
},
{
"kind": "HttpTypeObject",
"members": [
{
"ident": "image"
},
{
"ident": "type"
}
]
}
],
"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,
"schemaType": "array",
"childrenParentSchema": "union",
"children": [
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 0",
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 1"
]
},
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "code_interpreter"
}
},
"(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.",
"key": "ranking_options",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "ranker"
},
{
"ident": "score_threshold"
}
]
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/file_search/properties/ranking_options",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) ranking_options > (property) ranker",
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) ranking_options > (property) score_threshold"
]
},
"(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.",
"key": "results",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeArray",
"elementType": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "file_id"
},
{
"ident": "file_name"
},
{
"ident": "score"
},
{
"ident": "content"
}
]
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/file_search/properties/results"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/file_search/properties/results",
"deprecated": false,
"schemaType": "array",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) results > (items) > (property) file_id",
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) results > (items) > (property) file_name",
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) results > (items) > (property) score",
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) results > (items) > (property) content"
]
},
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "file_search"
}
},
"(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) function > (property) arguments": {
"kind": "HttpDeclProperty",
"docstring": "The arguments passed to the function.",
"key": "arguments",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/function/properties/arguments",
"deprecated": 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.",
"key": "name",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/function/properties/name",
"deprecated": 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.",
"key": "output",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/function/properties/output",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "function"
}
},
"(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",
"ident": "CodeInterpreterLogOutput",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "logs"
},
{
"ident": "type"
}
]
},
"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",
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 0 > (property) type"
]
},
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 1": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter/properties/outputs/items/oneOf/1",
"ident": "CodeInterpreterImageOutput",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "image"
},
{
"ident": "type"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 1 > (property) image",
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 1 > (property) type"
]
},
"(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.",
"key": "ranker",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "auto"
},
{
"kind": "HttpTypeLiteral",
"literal": "default_2024_08_21"
}
],
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchRankingOptionsObject/properties/ranker"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchRankingOptionsObject/properties/ranker",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) ranking_options > (property) ranker > (member) 0",
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) ranking_options > (property) ranker > (member) 1"
]
},
"(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.",
"key": "score_threshold",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"minimum": 0,
"maximum": 1
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchRankingOptionsObject/properties/score_threshold",
"deprecated": 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.",
"key": "file_id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/file_id",
"deprecated": 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.",
"key": "file_name",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/file_name",
"deprecated": 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.",
"key": "score",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"minimum": 0,
"maximum": 1
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/score",
"deprecated": 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.",
"key": "content",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeArray",
"elementType": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "text"
},
{
"ident": "type"
}
]
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/content"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/content",
"deprecated": false,
"schemaType": "array",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) results > (items) > (property) content > (items) > (property) text",
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) results > (items) > (property) content > (items) > (property) type"
]
},
"(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.",
"key": "logs",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputLogsObject/properties/logs",
"deprecated": 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`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "logs"
}
],
"oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputLogsObject/properties/type"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputLogsObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 0 > (property) type > (member) 0"
]
},
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 1 > (property) image": {
"kind": "HttpDeclProperty",
"key": "image",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "file_id"
}
]
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputImageObject/properties/image",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 1 > (property) image > (property) file_id"
]
},
"(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`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "image"
}
],
"oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputImageObject/properties/type"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputImageObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 1 > (property) type > (member) 0"
]
},
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) ranking_options > (property) ranker > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "auto"
}
},
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) ranking_options > (property) ranker > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "default_2024_08_21"
}
},
"(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.",
"key": "text",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/content/items/properties/text",
"deprecated": 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.",
"key": "type",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"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,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) results > (items) > (property) content > (items) > (property) type > (member) 0"
]
},
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 0 > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "logs"
}
},
"(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.",
"key": "file_id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputImageObject/properties/image/properties/file_id",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 1 > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "image"
}
},
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) results > (items) > (property) content > (items) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "text"
}
}
}
Example
{}
event
Occurs when parts of a run step are being streamed.
Schema
Schema name: (resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 13
{
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 13": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RunStepStreamEvent/oneOf/2",
"ident": "UnionMember13",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "data"
},
{
"ident": "event"
}
]
},
"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",
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 13 > (property) event"
]
},
"(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",
"key": "data",
"optional": false,
"nullable": false,
"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",
"modelImplicit": false,
"modelPath": "(resource) beta.threads.runs.steps > (model) run_step_delta_event",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) run_step_delta_event > (schema) > (property) id",
"(resource) beta.threads.runs.steps > (model) run_step_delta_event > (schema) > (property) delta",
"(resource) beta.threads.runs.steps > (model) run_step_delta_event > (schema) > (property) object"
]
},
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 13 > (property) event": {
"kind": "HttpDeclProperty",
"key": "event",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"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,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 13 > (property) event > (member) 0"
]
},
"(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.",
"key": "id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepDeltaObject/properties/id",
"deprecated": 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.",
"key": "delta",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "step_details"
}
]
},
"oasRef": "#/components/schemas/RunStepDeltaObject/properties/delta",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) run_step_delta_event > (schema) > (property) delta > (property) step_details"
]
},
"(resource) beta.threads.runs.steps > (model) run_step_delta_event > (schema) > (property) object": {
"kind": "HttpDeclProperty",
"docstring": "The object type, which is always `thread.run.step.delta`.",
"key": "object",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "thread.run.step.delta"
}
],
"oasRef": "#/components/schemas/RunStepDeltaObject/properties/object"
},
"oasRef": "#/components/schemas/RunStepDeltaObject/properties/object",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs.steps > (model) run_step_delta_event > (schema) > (property) object > (member) 0"
]
},
"(resource) beta.threads.runs.steps > (model) run_step_delta_event > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RunStepDeltaObject",
"ident": "RunStepDeltaEvent",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "id"
},
{
"ident": "delta"
},
{
"ident": "object"
}
]
},
"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",
"(resource) beta.threads.runs.steps > (model) run_step_delta_event > (schema) > (property) delta",
"(resource) beta.threads.runs.steps > (model) run_step_delta_event > (schema) > (property) object"
]
},
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 13 > (property) event > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "thread.run.step.delta"
}
},
"(resource) beta.threads.runs.steps > (model) run_step_delta_event > (schema) > (property) delta > (property) step_details": {
"kind": "HttpDeclProperty",
"docstring": "The details of the run step.",
"key": "step_details",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeReference",
"ident": "RunStepDeltaMessageDelta",
"$ref": "(resource) beta.threads.runs.steps > (model) run_step_delta_message_delta > (schema)"
},
{
"kind": "HttpTypeReference",
"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,
"schemaType": "union",
"childrenParentSchema": "union",
"children": [
"(resource) beta.threads.runs.steps > (model) run_step_delta_event > (schema) > (property) delta > (property) step_details > (variant) 0",
"(resource) beta.threads.runs.steps > (model) run_step_delta_event > (schema) > (property) delta > (property) step_details > (variant) 1"
]
},
"(resource) beta.threads.runs.steps > (model) run_step_delta_event > (schema) > (property) object > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "thread.run.step.delta"
}
},
"(resource) beta.threads.runs.steps > (model) run_step_delta_event > (schema) > (property) delta > (property) step_details > (variant) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "RunStepDeltaMessageDelta",
"$ref": "(resource) beta.threads.runs.steps > (model) run_step_delta_message_delta > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) run_step_delta_message_delta > (schema) > (property) type",
"(resource) beta.threads.runs.steps > (model) run_step_delta_message_delta > (schema) > (property) message_creation"
]
},
"(resource) beta.threads.runs.steps > (model) run_step_delta_event > (schema) > (property) delta > (property) step_details > (variant) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "ToolCallDeltaObject",
"$ref": "(resource) beta.threads.runs.steps > (model) tool_call_delta_object > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) tool_call_delta_object > (schema) > (property) type",
"(resource) beta.threads.runs.steps > (model) tool_call_delta_object > (schema) > (property) tool_calls"
]
},
"(resource) beta.threads.runs.steps > (model) run_step_delta_message_delta > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RunStepDeltaStepDetailsMessageCreationObject",
"ident": "RunStepDeltaMessageDelta",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
},
{
"ident": "message_creation"
}
]
},
"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",
"(resource) beta.threads.runs.steps > (model) run_step_delta_message_delta > (schema) > (property) message_creation"
]
},
"(resource) beta.threads.runs.steps > (model) tool_call_delta_object > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsObject",
"ident": "ToolCallDeltaObject",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
},
{
"ident": "tool_calls"
}
]
},
"docstring": "Details of the tool call.",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) tool_call_delta_object > (schema) > (property) type",
"(resource) beta.threads.runs.steps > (model) tool_call_delta_object > (schema) > (property) tool_calls"
]
},
"(resource) beta.threads.runs.steps > (model) run_step_delta_message_delta > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "Always `message_creation`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "message_creation"
}
],
"oasRef": "#/components/schemas/RunStepDeltaStepDetailsMessageCreationObject/properties/type"
},
"oasRef": "#/components/schemas/RunStepDeltaStepDetailsMessageCreationObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs.steps > (model) run_step_delta_message_delta > (schema) > (property) type > (member) 0"
]
},
"(resource) beta.threads.runs.steps > (model) run_step_delta_message_delta > (schema) > (property) message_creation": {
"kind": "HttpDeclProperty",
"key": "message_creation",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "message_id"
}
]
},
"oasRef": "#/components/schemas/RunStepDeltaStepDetailsMessageCreationObject/properties/message_creation",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) run_step_delta_message_delta > (schema) > (property) message_creation > (property) message_id"
]
},
"(resource) beta.threads.runs.steps > (model) tool_call_delta_object > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "Always `tool_calls`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "tool_calls"
}
],
"oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsObject/properties/type"
},
"oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs.steps > (model) tool_call_delta_object > (schema) > (property) type > (member) 0"
]
},
"(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",
"key": "tool_calls",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeArray",
"elementType": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeReference",
"ident": "CodeInterpreterToolCallDelta",
"$ref": "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call_delta > (schema)"
},
{
"kind": "HttpTypeReference",
"ident": "FileSearchToolCallDelta",
"$ref": "(resource) beta.threads.runs.steps > (model) file_search_tool_call_delta > (schema)"
},
{
"kind": "HttpTypeReference",
"ident": "FunctionToolCallDelta",
"$ref": "(resource) beta.threads.runs.steps > (model) function_tool_call_delta > (schema)"
}
],
"oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsObject/properties/tool_calls/items"
},
"oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsObject/properties/tool_calls"
},
"oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsObject/properties/tool_calls",
"deprecated": false,
"schemaType": "array",
"childrenParentSchema": "union",
"children": [
"(resource) beta.threads.runs.steps > (model) tool_call_delta_object > (schema) > (property) tool_calls > (items) > (variant) 0",
"(resource) beta.threads.runs.steps > (model) tool_call_delta_object > (schema) > (property) tool_calls > (items) > (variant) 1",
"(resource) beta.threads.runs.steps > (model) tool_call_delta_object > (schema) > (property) tool_calls > (items) > (variant) 2"
]
},
"(resource) beta.threads.runs.steps > (model) run_step_delta_message_delta > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "message_creation"
}
},
"(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.",
"key": "message_id",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepDeltaStepDetailsMessageCreationObject/properties/message_creation/properties/message_id",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.runs.steps > (model) tool_call_delta_object > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "tool_calls"
}
},
"(resource) beta.threads.runs.steps > (model) tool_call_delta_object > (schema) > (property) tool_calls > (items) > (variant) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "CodeInterpreterToolCallDelta",
"$ref": "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call_delta > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call_delta > (schema) > (property) index",
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call_delta > (schema) > (property) type",
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call_delta > (schema) > (property) id",
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call_delta > (schema) > (property) code_interpreter"
]
},
"(resource) beta.threads.runs.steps > (model) tool_call_delta_object > (schema) > (property) tool_calls > (items) > (variant) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "FileSearchToolCallDelta",
"$ref": "(resource) beta.threads.runs.steps > (model) file_search_tool_call_delta > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) file_search_tool_call_delta > (schema) > (property) file_search",
"(resource) beta.threads.runs.steps > (model) file_search_tool_call_delta > (schema) > (property) index",
"(resource) beta.threads.runs.steps > (model) file_search_tool_call_delta > (schema) > (property) type",
"(resource) beta.threads.runs.steps > (model) file_search_tool_call_delta > (schema) > (property) id"
]
},
"(resource) beta.threads.runs.steps > (model) tool_call_delta_object > (schema) > (property) tool_calls > (items) > (variant) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "FunctionToolCallDelta",
"$ref": "(resource) beta.threads.runs.steps > (model) function_tool_call_delta > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) function_tool_call_delta > (schema) > (property) index",
"(resource) beta.threads.runs.steps > (model) function_tool_call_delta > (schema) > (property) type",
"(resource) beta.threads.runs.steps > (model) function_tool_call_delta > (schema) > (property) id",
"(resource) beta.threads.runs.steps > (model) function_tool_call_delta > (schema) > (property) function"
]
},
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call_delta > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsCodeObject",
"ident": "CodeInterpreterToolCallDelta",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "index"
},
{
"ident": "type"
},
{
"ident": "id"
},
{
"ident": "code_interpreter"
}
]
},
"docstring": "Details of the Code Interpreter tool call the run step was involved in.",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call_delta > (schema) > (property) index",
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call_delta > (schema) > (property) type",
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call_delta > (schema) > (property) id",
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call_delta > (schema) > (property) code_interpreter"
]
},
"(resource) beta.threads.runs.steps > (model) file_search_tool_call_delta > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsFileSearchObject",
"ident": "FileSearchToolCallDelta",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "file_search"
},
{
"ident": "index"
},
{
"ident": "type"
},
{
"ident": "id"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) file_search_tool_call_delta > (schema) > (property) file_search",
"(resource) beta.threads.runs.steps > (model) file_search_tool_call_delta > (schema) > (property) index",
"(resource) beta.threads.runs.steps > (model) file_search_tool_call_delta > (schema) > (property) type",
"(resource) beta.threads.runs.steps > (model) file_search_tool_call_delta > (schema) > (property) id"
]
},
"(resource) beta.threads.runs.steps > (model) function_tool_call_delta > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsFunctionObject",
"ident": "FunctionToolCallDelta",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "index"
},
{
"ident": "type"
},
{
"ident": "id"
},
{
"ident": "function"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) function_tool_call_delta > (schema) > (property) index",
"(resource) beta.threads.runs.steps > (model) function_tool_call_delta > (schema) > (property) type",
"(resource) beta.threads.runs.steps > (model) function_tool_call_delta > (schema) > (property) id",
"(resource) beta.threads.runs.steps > (model) function_tool_call_delta > (schema) > (property) function"
]
},
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call_delta > (schema) > (property) index": {
"kind": "HttpDeclProperty",
"docstring": "The index of the tool call in the tool calls array.",
"key": "index",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsCodeObject/properties/index",
"deprecated": 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.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "code_interpreter"
}
],
"oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsCodeObject/properties/type"
},
"oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsCodeObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call_delta > (schema) > (property) type > (member) 0"
]
},
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call_delta > (schema) > (property) id": {
"kind": "HttpDeclProperty",
"docstring": "The ID of the tool call.",
"key": "id",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsCodeObject/properties/id",
"deprecated": 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.",
"key": "code_interpreter",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "input"
},
{
"ident": "outputs"
}
]
},
"oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsCodeObject/properties/code_interpreter",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call_delta > (schema) > (property) code_interpreter > (property) input",
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call_delta > (schema) > (property) code_interpreter > (property) outputs"
]
},
"(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.",
"key": "file_search",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnknown"
},
"oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsFileSearchObject/properties/file_search",
"deprecated": 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.",
"key": "index",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsFileSearchObject/properties/index",
"deprecated": 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.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "file_search"
}
],
"oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsFileSearchObject/properties/type"
},
"oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsFileSearchObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs.steps > (model) file_search_tool_call_delta > (schema) > (property) type > (member) 0"
]
},
"(resource) beta.threads.runs.steps > (model) file_search_tool_call_delta > (schema) > (property) id": {
"kind": "HttpDeclProperty",
"docstring": "The ID of the tool call object.",
"key": "id",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsFileSearchObject/properties/id",
"deprecated": 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.",
"key": "index",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsFunctionObject/properties/index",
"deprecated": 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.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "function"
}
],
"oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsFunctionObject/properties/type"
},
"oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsFunctionObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs.steps > (model) function_tool_call_delta > (schema) > (property) type > (member) 0"
]
},
"(resource) beta.threads.runs.steps > (model) function_tool_call_delta > (schema) > (property) id": {
"kind": "HttpDeclProperty",
"docstring": "The ID of the tool call object.",
"key": "id",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsFunctionObject/properties/id",
"deprecated": 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.",
"key": "function",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "arguments"
},
{
"ident": "name"
},
{
"ident": "output"
}
]
},
"oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsFunctionObject/properties/function",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) function_tool_call_delta > (schema) > (property) function > (property) arguments",
"(resource) beta.threads.runs.steps > (model) function_tool_call_delta > (schema) > (property) function > (property) name",
"(resource) beta.threads.runs.steps > (model) function_tool_call_delta > (schema) > (property) function > (property) output"
]
},
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call_delta > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "code_interpreter"
}
},
"(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.",
"key": "input",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsCodeObject/properties/code_interpreter/properties/input",
"deprecated": 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.",
"key": "outputs",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeArray",
"elementType": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeReference",
"ident": "CodeInterpreterLogs",
"$ref": "(resource) beta.threads.runs.steps > (model) code_interpreter_logs > (schema)"
},
{
"kind": "HttpTypeReference",
"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,
"schemaType": "array",
"childrenParentSchema": "union",
"children": [
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call_delta > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 0",
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call_delta > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 1"
]
},
"(resource) beta.threads.runs.steps > (model) file_search_tool_call_delta > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "file_search"
}
},
"(resource) beta.threads.runs.steps > (model) function_tool_call_delta > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "function"
}
},
"(resource) beta.threads.runs.steps > (model) function_tool_call_delta > (schema) > (property) function > (property) arguments": {
"kind": "HttpDeclProperty",
"docstring": "The arguments passed to the function.",
"key": "arguments",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsFunctionObject/properties/function/properties/arguments",
"deprecated": 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.",
"key": "name",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsFunctionObject/properties/function/properties/name",
"deprecated": 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.",
"key": "output",
"optional": true,
"nullable": true,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsFunctionObject/properties/function/properties/output",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call_delta > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "CodeInterpreterLogs",
"$ref": "(resource) beta.threads.runs.steps > (model) code_interpreter_logs > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) code_interpreter_logs > (schema) > (property) index",
"(resource) beta.threads.runs.steps > (model) code_interpreter_logs > (schema) > (property) type",
"(resource) beta.threads.runs.steps > (model) code_interpreter_logs > (schema) > (property) logs"
]
},
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call_delta > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "CodeInterpreterOutputImage",
"$ref": "(resource) beta.threads.runs.steps > (model) code_interpreter_output_image > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) code_interpreter_output_image > (schema) > (property) index",
"(resource) beta.threads.runs.steps > (model) code_interpreter_output_image > (schema) > (property) type",
"(resource) beta.threads.runs.steps > (model) code_interpreter_output_image > (schema) > (property) image"
]
},
"(resource) beta.threads.runs.steps > (model) code_interpreter_logs > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsCodeOutputLogsObject",
"ident": "CodeInterpreterLogs",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "index"
},
{
"ident": "type"
},
{
"ident": "logs"
}
]
},
"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",
"(resource) beta.threads.runs.steps > (model) code_interpreter_logs > (schema) > (property) type",
"(resource) beta.threads.runs.steps > (model) code_interpreter_logs > (schema) > (property) logs"
]
},
"(resource) beta.threads.runs.steps > (model) code_interpreter_output_image > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsCodeOutputImageObject",
"ident": "CodeInterpreterOutputImage",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "index"
},
{
"ident": "type"
},
{
"ident": "image"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) code_interpreter_output_image > (schema) > (property) index",
"(resource) beta.threads.runs.steps > (model) code_interpreter_output_image > (schema) > (property) type",
"(resource) beta.threads.runs.steps > (model) code_interpreter_output_image > (schema) > (property) image"
]
},
"(resource) beta.threads.runs.steps > (model) code_interpreter_logs > (schema) > (property) index": {
"kind": "HttpDeclProperty",
"docstring": "The index of the output in the outputs array.",
"key": "index",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsCodeOutputLogsObject/properties/index",
"deprecated": false,
"schemaType": "integer",
"children": []
},
"(resource) beta.threads.runs.steps > (model) code_interpreter_logs > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "Always `logs`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "logs"
}
],
"oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsCodeOutputLogsObject/properties/type"
},
"oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsCodeOutputLogsObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs.steps > (model) code_interpreter_logs > (schema) > (property) type > (member) 0"
]
},
"(resource) beta.threads.runs.steps > (model) code_interpreter_logs > (schema) > (property) logs": {
"kind": "HttpDeclProperty",
"docstring": "The text output from the Code Interpreter tool call.",
"key": "logs",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsCodeOutputLogsObject/properties/logs",
"deprecated": 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.",
"key": "index",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsCodeOutputImageObject/properties/index",
"deprecated": false,
"schemaType": "integer",
"children": []
},
"(resource) beta.threads.runs.steps > (model) code_interpreter_output_image > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "Always `image`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "image"
}
],
"oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsCodeOutputImageObject/properties/type"
},
"oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsCodeOutputImageObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs.steps > (model) code_interpreter_output_image > (schema) > (property) type > (member) 0"
]
},
"(resource) beta.threads.runs.steps > (model) code_interpreter_output_image > (schema) > (property) image": {
"kind": "HttpDeclProperty",
"key": "image",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "file_id"
}
]
},
"oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsCodeOutputImageObject/properties/image",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) code_interpreter_output_image > (schema) > (property) image > (property) file_id"
]
},
"(resource) beta.threads.runs.steps > (model) code_interpreter_logs > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "logs"
}
},
"(resource) beta.threads.runs.steps > (model) code_interpreter_output_image > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "image"
}
},
"(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.",
"key": "file_id",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepDeltaStepDetailsToolCallsCodeOutputImageObject/properties/image/properties/file_id",
"deprecated": false,
"schemaType": "string",
"children": []
}
}
Example
{}
event
Occurs when a run step is completed.
Schema
Schema name: (resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 14
{
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 14": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RunStepStreamEvent/oneOf/3",
"ident": "UnionMember14",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "data"
},
{
"ident": "event"
}
]
},
"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",
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 14 > (property) event"
]
},
"(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",
"key": "data",
"optional": false,
"nullable": false,
"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",
"modelImplicit": false,
"modelPath": "(resource) beta.threads.runs.steps > (model) run_step",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) id",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) assistant_id",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) cancelled_at",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) completed_at",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) created_at",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) expired_at",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) failed_at",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) last_error",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) metadata",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) object",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) run_id",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) status",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) step_details",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) thread_id",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) type",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) usage"
]
},
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 14 > (property) event": {
"kind": "HttpDeclProperty",
"key": "event",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"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,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 14 > (property) event > (member) 0"
]
},
"(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.",
"key": "id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepObject/properties/id",
"deprecated": 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.",
"key": "assistant_id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepObject/properties/assistant_id",
"deprecated": 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.",
"key": "cancelled_at",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/RunStepObject/properties/cancelled_at",
"deprecated": false,
"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.",
"key": "completed_at",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/RunStepObject/properties/completed_at",
"deprecated": false,
"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.",
"key": "created_at",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/RunStepObject/properties/created_at",
"deprecated": 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.",
"key": "expired_at",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/RunStepObject/properties/expired_at",
"deprecated": false,
"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.",
"key": "failed_at",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/RunStepObject/properties/failed_at",
"deprecated": false,
"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.",
"key": "last_error",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "code"
},
{
"ident": "message"
}
]
},
"oasRef": "#/components/schemas/RunStepObject/properties/last_error",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) last_error > (property) code",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) last_error > (property) message"
]
},
"(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",
"key": "metadata",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeReference",
"ident": "Metadata",
"$ref": "(resource) $shared > (model) metadata > (schema)"
},
"oasRef": "#/components/schemas/RunStepObject/properties/metadata",
"deprecated": false,
"schemaType": "map",
"modelImplicit": false,
"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`.",
"key": "object",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "thread.run.step"
}
],
"oasRef": "#/components/schemas/RunStepObject/properties/object"
},
"oasRef": "#/components/schemas/RunStepObject/properties/object",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) object > (member) 0"
]
},
"(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.",
"key": "run_id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepObject/properties/run_id",
"deprecated": 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`.",
"key": "status",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "in_progress"
},
{
"kind": "HttpTypeLiteral",
"literal": "cancelled"
},
{
"kind": "HttpTypeLiteral",
"literal": "failed"
},
{
"kind": "HttpTypeLiteral",
"literal": "completed"
},
{
"kind": "HttpTypeLiteral",
"literal": "expired"
}
],
"oasRef": "#/components/schemas/RunStepObject/properties/status"
},
"oasRef": "#/components/schemas/RunStepObject/properties/status",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) status > (member) 0",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) status > (member) 1",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) status > (member) 2",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) status > (member) 3",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) status > (member) 4"
]
},
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) step_details": {
"kind": "HttpDeclProperty",
"docstring": "The details of the run step.",
"key": "step_details",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeReference",
"ident": "MessageCreationStepDetails",
"$ref": "(resource) beta.threads.runs.steps > (model) message_creation_step_details > (schema)"
},
{
"kind": "HttpTypeReference",
"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,
"schemaType": "union",
"childrenParentSchema": "union",
"children": [
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) step_details > (variant) 0",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) step_details > (variant) 1"
]
},
"(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.",
"key": "thread_id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepObject/properties/thread_id",
"deprecated": 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`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "message_creation"
},
{
"kind": "HttpTypeLiteral",
"literal": "tool_calls"
}
],
"oasRef": "#/components/schemas/RunStepObject/properties/type"
},
"oasRef": "#/components/schemas/RunStepObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) type > (member) 0",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) type > (member) 1"
]
},
"(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`.",
"key": "usage",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "completion_tokens"
},
{
"ident": "prompt_tokens"
},
{
"ident": "total_tokens"
}
]
},
"oasRef": "#/components/schemas/RunStepObject/properties/usage",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) usage > (property) completion_tokens",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) usage > (property) prompt_tokens",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) usage > (property) total_tokens"
]
},
"(resource) beta.threads.runs.steps > (model) run_step > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RunStepObject",
"ident": "RunStep",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "id"
},
{
"ident": "assistant_id"
},
{
"ident": "cancelled_at"
},
{
"ident": "completed_at"
},
{
"ident": "created_at"
},
{
"ident": "expired_at"
},
{
"ident": "failed_at"
},
{
"ident": "last_error"
},
{
"ident": "metadata"
},
{
"ident": "object"
},
{
"ident": "run_id"
},
{
"ident": "status"
},
{
"ident": "step_details"
},
{
"ident": "thread_id"
},
{
"ident": "type"
},
{
"ident": "usage"
}
]
},
"docstring": "Represents a step in execution of a run.\n",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) id",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) assistant_id",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) cancelled_at",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) completed_at",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) created_at",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) expired_at",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) failed_at",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) last_error",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) metadata",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) object",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) run_id",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) status",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) step_details",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) thread_id",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) type",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) usage"
]
},
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 14 > (property) event > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "thread.run.step.completed"
}
},
"(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`.",
"key": "code",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "server_error"
},
{
"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,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) last_error > (property) code > (member) 0",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) last_error > (property) code > (member) 1"
]
},
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) last_error > (property) message": {
"kind": "HttpDeclProperty",
"docstring": "A human-readable description of the error.",
"key": "message",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepObject/properties/last_error/anyOf/0/properties/message",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) $shared > (model) metadata > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/Metadata",
"ident": "Metadata",
"type": {
"kind": "HttpTypeReference",
"ident": "Record",
"typeParameters": [
{
"kind": "HttpTypeString"
},
{
"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": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "thread.run.step"
}
},
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) status > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "in_progress"
}
},
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) status > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "cancelled"
}
},
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) status > (member) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "failed"
}
},
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) status > (member) 3": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "completed"
}
},
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) status > (member) 4": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "expired"
}
},
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) step_details > (variant) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "MessageCreationStepDetails",
"$ref": "(resource) beta.threads.runs.steps > (model) message_creation_step_details > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) message_creation_step_details > (schema) > (property) message_creation",
"(resource) beta.threads.runs.steps > (model) message_creation_step_details > (schema) > (property) type"
]
},
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) step_details > (variant) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "ToolCallsStepDetails",
"$ref": "(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) tool_calls",
"(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) type"
]
},
"(resource) beta.threads.runs.steps > (model) message_creation_step_details > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RunStepDetailsMessageCreationObject",
"ident": "MessageCreationStepDetails",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "message_creation"
},
{
"ident": "type"
}
]
},
"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",
"(resource) beta.threads.runs.steps > (model) message_creation_step_details > (schema) > (property) type"
]
},
"(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RunStepDetailsToolCallsObject",
"ident": "ToolCallsStepDetails",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "tool_calls"
},
{
"ident": "type"
}
]
},
"docstring": "Details of the tool call.",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) tool_calls",
"(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) type"
]
},
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "message_creation"
}
},
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) type > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "tool_calls"
}
},
"(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.",
"key": "completion_tokens",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"oasRef": "#/components/schemas/RunStepCompletionUsage/anyOf/0/properties/completion_tokens",
"deprecated": 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.",
"key": "prompt_tokens",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"oasRef": "#/components/schemas/RunStepCompletionUsage/anyOf/0/properties/prompt_tokens",
"deprecated": 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).",
"key": "total_tokens",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"oasRef": "#/components/schemas/RunStepCompletionUsage/anyOf/0/properties/total_tokens",
"deprecated": false,
"schemaType": "integer",
"children": []
},
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) last_error > (property) code > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "server_error"
}
},
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) last_error > (property) code > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "rate_limit_exceeded"
}
},
"(resource) beta.threads.runs.steps > (model) message_creation_step_details > (schema) > (property) message_creation": {
"kind": "HttpDeclProperty",
"key": "message_creation",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "message_id"
}
]
},
"oasRef": "#/components/schemas/RunStepDetailsMessageCreationObject/properties/message_creation",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) message_creation_step_details > (schema) > (property) message_creation > (property) message_id"
]
},
"(resource) beta.threads.runs.steps > (model) message_creation_step_details > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "Always `message_creation`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "message_creation"
}
],
"oasRef": "#/components/schemas/RunStepDetailsMessageCreationObject/properties/type"
},
"oasRef": "#/components/schemas/RunStepDetailsMessageCreationObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs.steps > (model) message_creation_step_details > (schema) > (property) type > (member) 0"
]
},
"(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",
"key": "tool_calls",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeArray",
"elementType": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeReference",
"ident": "CodeInterpreterToolCall",
"$ref": "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema)"
},
{
"kind": "HttpTypeReference",
"ident": "FileSearchToolCall",
"$ref": "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema)"
},
{
"kind": "HttpTypeReference",
"ident": "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,
"schemaType": "array",
"childrenParentSchema": "union",
"children": [
"(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) tool_calls > (items) > (variant) 0",
"(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) tool_calls > (items) > (variant) 1",
"(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) tool_calls > (items) > (variant) 2"
]
},
"(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "Always `tool_calls`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "tool_calls"
}
],
"oasRef": "#/components/schemas/RunStepDetailsToolCallsObject/properties/type"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) type > (member) 0"
]
},
"(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.",
"key": "message_id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepDetailsMessageCreationObject/properties/message_creation/properties/message_id",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.runs.steps > (model) message_creation_step_details > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "message_creation"
}
},
"(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) tool_calls > (items) > (variant) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "CodeInterpreterToolCall",
"$ref": "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) id",
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter",
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) type"
]
},
"(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) tool_calls > (items) > (variant) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "FileSearchToolCall",
"$ref": "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) id",
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search",
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) type"
]
},
"(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) tool_calls > (items) > (variant) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "FunctionToolCall",
"$ref": "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) id",
"(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) function",
"(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) type"
]
},
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject",
"ident": "CodeInterpreterToolCall",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "id"
},
{
"ident": "code_interpreter"
},
{
"ident": "type"
}
]
},
"docstring": "Details of the Code Interpreter tool call the run step was involved in.",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) id",
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter",
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) type"
]
},
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject",
"ident": "FileSearchToolCall",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "id"
},
{
"ident": "file_search"
},
{
"ident": "type"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) id",
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search",
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) type"
]
},
"(resource) beta.threads.runs.steps > (model) function_tool_call > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject",
"ident": "FunctionToolCall",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "id"
},
{
"ident": "function"
},
{
"ident": "type"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) id",
"(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) function",
"(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) type"
]
},
"(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "tool_calls"
}
},
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) id": {
"kind": "HttpDeclProperty",
"docstring": "The ID of the tool call.",
"key": "id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/id",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter": {
"kind": "HttpDeclProperty",
"docstring": "The Code Interpreter tool call definition.",
"key": "code_interpreter",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "input"
},
{
"ident": "outputs"
}
]
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) input",
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs"
]
},
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The type of tool call. This is always going to be `code_interpreter` for this type of tool call.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "code_interpreter"
}
],
"oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/type"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) type > (member) 0"
]
},
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) id": {
"kind": "HttpDeclProperty",
"docstring": "The ID of the tool call object.",
"key": "id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/id",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search": {
"kind": "HttpDeclProperty",
"docstring": "For now, this is always going to be an empty object.",
"key": "file_search",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "ranking_options"
},
{
"ident": "results"
}
]
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/file_search",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) ranking_options",
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) results"
]
},
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The type of tool call. This is always going to be `file_search` for this type of tool call.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "file_search"
}
],
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/type"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) type > (member) 0"
]
},
"(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) id": {
"kind": "HttpDeclProperty",
"docstring": "The ID of the tool call object.",
"key": "id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/id",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) function": {
"kind": "HttpDeclProperty",
"docstring": "The definition of the function that was called.",
"key": "function",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "arguments"
},
{
"ident": "name"
},
{
"ident": "output"
}
]
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/function",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) function > (property) arguments",
"(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) function > (property) name",
"(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) function > (property) output"
]
},
"(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The type of tool call. This is always going to be `function` for this type of tool call.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "function"
}
],
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/type"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) type > (member) 0"
]
},
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) input": {
"kind": "HttpDeclProperty",
"docstring": "The input to the Code Interpreter tool call.",
"key": "input",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter/properties/input",
"deprecated": 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.",
"key": "outputs",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeArray",
"elementType": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeObject",
"members": [
{
"ident": "logs"
},
{
"ident": "type"
}
]
},
{
"kind": "HttpTypeObject",
"members": [
{
"ident": "image"
},
{
"ident": "type"
}
]
}
],
"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,
"schemaType": "array",
"childrenParentSchema": "union",
"children": [
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 0",
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 1"
]
},
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "code_interpreter"
}
},
"(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.",
"key": "ranking_options",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "ranker"
},
{
"ident": "score_threshold"
}
]
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/file_search/properties/ranking_options",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) ranking_options > (property) ranker",
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) ranking_options > (property) score_threshold"
]
},
"(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.",
"key": "results",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeArray",
"elementType": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "file_id"
},
{
"ident": "file_name"
},
{
"ident": "score"
},
{
"ident": "content"
}
]
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/file_search/properties/results"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/file_search/properties/results",
"deprecated": false,
"schemaType": "array",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) results > (items) > (property) file_id",
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) results > (items) > (property) file_name",
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) results > (items) > (property) score",
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) results > (items) > (property) content"
]
},
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "file_search"
}
},
"(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) function > (property) arguments": {
"kind": "HttpDeclProperty",
"docstring": "The arguments passed to the function.",
"key": "arguments",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/function/properties/arguments",
"deprecated": 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.",
"key": "name",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/function/properties/name",
"deprecated": 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.",
"key": "output",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/function/properties/output",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "function"
}
},
"(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",
"ident": "CodeInterpreterLogOutput",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "logs"
},
{
"ident": "type"
}
]
},
"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",
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 0 > (property) type"
]
},
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 1": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter/properties/outputs/items/oneOf/1",
"ident": "CodeInterpreterImageOutput",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "image"
},
{
"ident": "type"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 1 > (property) image",
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 1 > (property) type"
]
},
"(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.",
"key": "ranker",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "auto"
},
{
"kind": "HttpTypeLiteral",
"literal": "default_2024_08_21"
}
],
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchRankingOptionsObject/properties/ranker"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchRankingOptionsObject/properties/ranker",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) ranking_options > (property) ranker > (member) 0",
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) ranking_options > (property) ranker > (member) 1"
]
},
"(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.",
"key": "score_threshold",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"minimum": 0,
"maximum": 1
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchRankingOptionsObject/properties/score_threshold",
"deprecated": 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.",
"key": "file_id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/file_id",
"deprecated": 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.",
"key": "file_name",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/file_name",
"deprecated": 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.",
"key": "score",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"minimum": 0,
"maximum": 1
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/score",
"deprecated": 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.",
"key": "content",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeArray",
"elementType": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "text"
},
{
"ident": "type"
}
]
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/content"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/content",
"deprecated": false,
"schemaType": "array",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) results > (items) > (property) content > (items) > (property) text",
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) results > (items) > (property) content > (items) > (property) type"
]
},
"(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.",
"key": "logs",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputLogsObject/properties/logs",
"deprecated": 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`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "logs"
}
],
"oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputLogsObject/properties/type"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputLogsObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 0 > (property) type > (member) 0"
]
},
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 1 > (property) image": {
"kind": "HttpDeclProperty",
"key": "image",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "file_id"
}
]
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputImageObject/properties/image",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 1 > (property) image > (property) file_id"
]
},
"(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`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "image"
}
],
"oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputImageObject/properties/type"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputImageObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 1 > (property) type > (member) 0"
]
},
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) ranking_options > (property) ranker > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "auto"
}
},
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) ranking_options > (property) ranker > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "default_2024_08_21"
}
},
"(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.",
"key": "text",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/content/items/properties/text",
"deprecated": 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.",
"key": "type",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"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,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) results > (items) > (property) content > (items) > (property) type > (member) 0"
]
},
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 0 > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "logs"
}
},
"(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.",
"key": "file_id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputImageObject/properties/image/properties/file_id",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 1 > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "image"
}
},
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) results > (items) > (property) content > (items) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "text"
}
}
}
Example
{}
event
Occurs when a run step fails.
Schema
Schema name: (resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 15
{
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 15": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RunStepStreamEvent/oneOf/4",
"ident": "UnionMember15",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "data"
},
{
"ident": "event"
}
]
},
"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",
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 15 > (property) event"
]
},
"(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",
"key": "data",
"optional": false,
"nullable": false,
"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",
"modelImplicit": false,
"modelPath": "(resource) beta.threads.runs.steps > (model) run_step",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) id",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) assistant_id",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) cancelled_at",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) completed_at",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) created_at",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) expired_at",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) failed_at",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) last_error",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) metadata",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) object",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) run_id",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) status",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) step_details",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) thread_id",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) type",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) usage"
]
},
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 15 > (property) event": {
"kind": "HttpDeclProperty",
"key": "event",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"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,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 15 > (property) event > (member) 0"
]
},
"(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.",
"key": "id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepObject/properties/id",
"deprecated": 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.",
"key": "assistant_id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepObject/properties/assistant_id",
"deprecated": 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.",
"key": "cancelled_at",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/RunStepObject/properties/cancelled_at",
"deprecated": false,
"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.",
"key": "completed_at",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/RunStepObject/properties/completed_at",
"deprecated": false,
"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.",
"key": "created_at",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/RunStepObject/properties/created_at",
"deprecated": 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.",
"key": "expired_at",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/RunStepObject/properties/expired_at",
"deprecated": false,
"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.",
"key": "failed_at",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/RunStepObject/properties/failed_at",
"deprecated": false,
"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.",
"key": "last_error",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "code"
},
{
"ident": "message"
}
]
},
"oasRef": "#/components/schemas/RunStepObject/properties/last_error",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) last_error > (property) code",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) last_error > (property) message"
]
},
"(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",
"key": "metadata",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeReference",
"ident": "Metadata",
"$ref": "(resource) $shared > (model) metadata > (schema)"
},
"oasRef": "#/components/schemas/RunStepObject/properties/metadata",
"deprecated": false,
"schemaType": "map",
"modelImplicit": false,
"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`.",
"key": "object",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "thread.run.step"
}
],
"oasRef": "#/components/schemas/RunStepObject/properties/object"
},
"oasRef": "#/components/schemas/RunStepObject/properties/object",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) object > (member) 0"
]
},
"(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.",
"key": "run_id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepObject/properties/run_id",
"deprecated": 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`.",
"key": "status",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "in_progress"
},
{
"kind": "HttpTypeLiteral",
"literal": "cancelled"
},
{
"kind": "HttpTypeLiteral",
"literal": "failed"
},
{
"kind": "HttpTypeLiteral",
"literal": "completed"
},
{
"kind": "HttpTypeLiteral",
"literal": "expired"
}
],
"oasRef": "#/components/schemas/RunStepObject/properties/status"
},
"oasRef": "#/components/schemas/RunStepObject/properties/status",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) status > (member) 0",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) status > (member) 1",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) status > (member) 2",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) status > (member) 3",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) status > (member) 4"
]
},
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) step_details": {
"kind": "HttpDeclProperty",
"docstring": "The details of the run step.",
"key": "step_details",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeReference",
"ident": "MessageCreationStepDetails",
"$ref": "(resource) beta.threads.runs.steps > (model) message_creation_step_details > (schema)"
},
{
"kind": "HttpTypeReference",
"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,
"schemaType": "union",
"childrenParentSchema": "union",
"children": [
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) step_details > (variant) 0",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) step_details > (variant) 1"
]
},
"(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.",
"key": "thread_id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepObject/properties/thread_id",
"deprecated": 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`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "message_creation"
},
{
"kind": "HttpTypeLiteral",
"literal": "tool_calls"
}
],
"oasRef": "#/components/schemas/RunStepObject/properties/type"
},
"oasRef": "#/components/schemas/RunStepObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) type > (member) 0",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) type > (member) 1"
]
},
"(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`.",
"key": "usage",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "completion_tokens"
},
{
"ident": "prompt_tokens"
},
{
"ident": "total_tokens"
}
]
},
"oasRef": "#/components/schemas/RunStepObject/properties/usage",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) usage > (property) completion_tokens",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) usage > (property) prompt_tokens",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) usage > (property) total_tokens"
]
},
"(resource) beta.threads.runs.steps > (model) run_step > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RunStepObject",
"ident": "RunStep",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "id"
},
{
"ident": "assistant_id"
},
{
"ident": "cancelled_at"
},
{
"ident": "completed_at"
},
{
"ident": "created_at"
},
{
"ident": "expired_at"
},
{
"ident": "failed_at"
},
{
"ident": "last_error"
},
{
"ident": "metadata"
},
{
"ident": "object"
},
{
"ident": "run_id"
},
{
"ident": "status"
},
{
"ident": "step_details"
},
{
"ident": "thread_id"
},
{
"ident": "type"
},
{
"ident": "usage"
}
]
},
"docstring": "Represents a step in execution of a run.\n",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) id",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) assistant_id",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) cancelled_at",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) completed_at",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) created_at",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) expired_at",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) failed_at",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) last_error",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) metadata",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) object",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) run_id",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) status",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) step_details",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) thread_id",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) type",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) usage"
]
},
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 15 > (property) event > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "thread.run.step.failed"
}
},
"(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`.",
"key": "code",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "server_error"
},
{
"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,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) last_error > (property) code > (member) 0",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) last_error > (property) code > (member) 1"
]
},
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) last_error > (property) message": {
"kind": "HttpDeclProperty",
"docstring": "A human-readable description of the error.",
"key": "message",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepObject/properties/last_error/anyOf/0/properties/message",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) $shared > (model) metadata > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/Metadata",
"ident": "Metadata",
"type": {
"kind": "HttpTypeReference",
"ident": "Record",
"typeParameters": [
{
"kind": "HttpTypeString"
},
{
"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": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "thread.run.step"
}
},
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) status > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "in_progress"
}
},
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) status > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "cancelled"
}
},
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) status > (member) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "failed"
}
},
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) status > (member) 3": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "completed"
}
},
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) status > (member) 4": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "expired"
}
},
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) step_details > (variant) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "MessageCreationStepDetails",
"$ref": "(resource) beta.threads.runs.steps > (model) message_creation_step_details > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) message_creation_step_details > (schema) > (property) message_creation",
"(resource) beta.threads.runs.steps > (model) message_creation_step_details > (schema) > (property) type"
]
},
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) step_details > (variant) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "ToolCallsStepDetails",
"$ref": "(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) tool_calls",
"(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) type"
]
},
"(resource) beta.threads.runs.steps > (model) message_creation_step_details > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RunStepDetailsMessageCreationObject",
"ident": "MessageCreationStepDetails",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "message_creation"
},
{
"ident": "type"
}
]
},
"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",
"(resource) beta.threads.runs.steps > (model) message_creation_step_details > (schema) > (property) type"
]
},
"(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RunStepDetailsToolCallsObject",
"ident": "ToolCallsStepDetails",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "tool_calls"
},
{
"ident": "type"
}
]
},
"docstring": "Details of the tool call.",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) tool_calls",
"(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) type"
]
},
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "message_creation"
}
},
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) type > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "tool_calls"
}
},
"(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.",
"key": "completion_tokens",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"oasRef": "#/components/schemas/RunStepCompletionUsage/anyOf/0/properties/completion_tokens",
"deprecated": 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.",
"key": "prompt_tokens",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"oasRef": "#/components/schemas/RunStepCompletionUsage/anyOf/0/properties/prompt_tokens",
"deprecated": 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).",
"key": "total_tokens",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"oasRef": "#/components/schemas/RunStepCompletionUsage/anyOf/0/properties/total_tokens",
"deprecated": false,
"schemaType": "integer",
"children": []
},
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) last_error > (property) code > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "server_error"
}
},
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) last_error > (property) code > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "rate_limit_exceeded"
}
},
"(resource) beta.threads.runs.steps > (model) message_creation_step_details > (schema) > (property) message_creation": {
"kind": "HttpDeclProperty",
"key": "message_creation",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "message_id"
}
]
},
"oasRef": "#/components/schemas/RunStepDetailsMessageCreationObject/properties/message_creation",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) message_creation_step_details > (schema) > (property) message_creation > (property) message_id"
]
},
"(resource) beta.threads.runs.steps > (model) message_creation_step_details > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "Always `message_creation`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "message_creation"
}
],
"oasRef": "#/components/schemas/RunStepDetailsMessageCreationObject/properties/type"
},
"oasRef": "#/components/schemas/RunStepDetailsMessageCreationObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs.steps > (model) message_creation_step_details > (schema) > (property) type > (member) 0"
]
},
"(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",
"key": "tool_calls",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeArray",
"elementType": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeReference",
"ident": "CodeInterpreterToolCall",
"$ref": "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema)"
},
{
"kind": "HttpTypeReference",
"ident": "FileSearchToolCall",
"$ref": "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema)"
},
{
"kind": "HttpTypeReference",
"ident": "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,
"schemaType": "array",
"childrenParentSchema": "union",
"children": [
"(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) tool_calls > (items) > (variant) 0",
"(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) tool_calls > (items) > (variant) 1",
"(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) tool_calls > (items) > (variant) 2"
]
},
"(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "Always `tool_calls`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "tool_calls"
}
],
"oasRef": "#/components/schemas/RunStepDetailsToolCallsObject/properties/type"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) type > (member) 0"
]
},
"(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.",
"key": "message_id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepDetailsMessageCreationObject/properties/message_creation/properties/message_id",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.runs.steps > (model) message_creation_step_details > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "message_creation"
}
},
"(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) tool_calls > (items) > (variant) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "CodeInterpreterToolCall",
"$ref": "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) id",
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter",
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) type"
]
},
"(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) tool_calls > (items) > (variant) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "FileSearchToolCall",
"$ref": "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) id",
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search",
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) type"
]
},
"(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) tool_calls > (items) > (variant) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "FunctionToolCall",
"$ref": "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) id",
"(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) function",
"(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) type"
]
},
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject",
"ident": "CodeInterpreterToolCall",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "id"
},
{
"ident": "code_interpreter"
},
{
"ident": "type"
}
]
},
"docstring": "Details of the Code Interpreter tool call the run step was involved in.",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) id",
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter",
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) type"
]
},
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject",
"ident": "FileSearchToolCall",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "id"
},
{
"ident": "file_search"
},
{
"ident": "type"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) id",
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search",
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) type"
]
},
"(resource) beta.threads.runs.steps > (model) function_tool_call > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject",
"ident": "FunctionToolCall",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "id"
},
{
"ident": "function"
},
{
"ident": "type"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) id",
"(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) function",
"(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) type"
]
},
"(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "tool_calls"
}
},
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) id": {
"kind": "HttpDeclProperty",
"docstring": "The ID of the tool call.",
"key": "id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/id",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter": {
"kind": "HttpDeclProperty",
"docstring": "The Code Interpreter tool call definition.",
"key": "code_interpreter",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "input"
},
{
"ident": "outputs"
}
]
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) input",
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs"
]
},
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The type of tool call. This is always going to be `code_interpreter` for this type of tool call.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "code_interpreter"
}
],
"oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/type"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) type > (member) 0"
]
},
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) id": {
"kind": "HttpDeclProperty",
"docstring": "The ID of the tool call object.",
"key": "id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/id",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search": {
"kind": "HttpDeclProperty",
"docstring": "For now, this is always going to be an empty object.",
"key": "file_search",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "ranking_options"
},
{
"ident": "results"
}
]
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/file_search",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) ranking_options",
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) results"
]
},
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The type of tool call. This is always going to be `file_search` for this type of tool call.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "file_search"
}
],
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/type"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) type > (member) 0"
]
},
"(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) id": {
"kind": "HttpDeclProperty",
"docstring": "The ID of the tool call object.",
"key": "id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/id",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) function": {
"kind": "HttpDeclProperty",
"docstring": "The definition of the function that was called.",
"key": "function",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "arguments"
},
{
"ident": "name"
},
{
"ident": "output"
}
]
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/function",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) function > (property) arguments",
"(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) function > (property) name",
"(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) function > (property) output"
]
},
"(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The type of tool call. This is always going to be `function` for this type of tool call.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "function"
}
],
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/type"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) type > (member) 0"
]
},
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) input": {
"kind": "HttpDeclProperty",
"docstring": "The input to the Code Interpreter tool call.",
"key": "input",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter/properties/input",
"deprecated": 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.",
"key": "outputs",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeArray",
"elementType": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeObject",
"members": [
{
"ident": "logs"
},
{
"ident": "type"
}
]
},
{
"kind": "HttpTypeObject",
"members": [
{
"ident": "image"
},
{
"ident": "type"
}
]
}
],
"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,
"schemaType": "array",
"childrenParentSchema": "union",
"children": [
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 0",
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 1"
]
},
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "code_interpreter"
}
},
"(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.",
"key": "ranking_options",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "ranker"
},
{
"ident": "score_threshold"
}
]
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/file_search/properties/ranking_options",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) ranking_options > (property) ranker",
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) ranking_options > (property) score_threshold"
]
},
"(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.",
"key": "results",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeArray",
"elementType": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "file_id"
},
{
"ident": "file_name"
},
{
"ident": "score"
},
{
"ident": "content"
}
]
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/file_search/properties/results"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/file_search/properties/results",
"deprecated": false,
"schemaType": "array",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) results > (items) > (property) file_id",
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) results > (items) > (property) file_name",
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) results > (items) > (property) score",
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) results > (items) > (property) content"
]
},
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "file_search"
}
},
"(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) function > (property) arguments": {
"kind": "HttpDeclProperty",
"docstring": "The arguments passed to the function.",
"key": "arguments",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/function/properties/arguments",
"deprecated": 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.",
"key": "name",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/function/properties/name",
"deprecated": 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.",
"key": "output",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/function/properties/output",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "function"
}
},
"(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",
"ident": "CodeInterpreterLogOutput",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "logs"
},
{
"ident": "type"
}
]
},
"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",
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 0 > (property) type"
]
},
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 1": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter/properties/outputs/items/oneOf/1",
"ident": "CodeInterpreterImageOutput",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "image"
},
{
"ident": "type"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 1 > (property) image",
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 1 > (property) type"
]
},
"(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.",
"key": "ranker",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "auto"
},
{
"kind": "HttpTypeLiteral",
"literal": "default_2024_08_21"
}
],
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchRankingOptionsObject/properties/ranker"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchRankingOptionsObject/properties/ranker",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) ranking_options > (property) ranker > (member) 0",
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) ranking_options > (property) ranker > (member) 1"
]
},
"(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.",
"key": "score_threshold",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"minimum": 0,
"maximum": 1
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchRankingOptionsObject/properties/score_threshold",
"deprecated": 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.",
"key": "file_id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/file_id",
"deprecated": 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.",
"key": "file_name",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/file_name",
"deprecated": 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.",
"key": "score",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"minimum": 0,
"maximum": 1
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/score",
"deprecated": 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.",
"key": "content",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeArray",
"elementType": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "text"
},
{
"ident": "type"
}
]
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/content"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/content",
"deprecated": false,
"schemaType": "array",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) results > (items) > (property) content > (items) > (property) text",
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) results > (items) > (property) content > (items) > (property) type"
]
},
"(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.",
"key": "logs",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputLogsObject/properties/logs",
"deprecated": 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`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "logs"
}
],
"oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputLogsObject/properties/type"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputLogsObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 0 > (property) type > (member) 0"
]
},
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 1 > (property) image": {
"kind": "HttpDeclProperty",
"key": "image",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "file_id"
}
]
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputImageObject/properties/image",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 1 > (property) image > (property) file_id"
]
},
"(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`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "image"
}
],
"oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputImageObject/properties/type"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputImageObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 1 > (property) type > (member) 0"
]
},
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) ranking_options > (property) ranker > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "auto"
}
},
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) ranking_options > (property) ranker > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "default_2024_08_21"
}
},
"(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.",
"key": "text",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/content/items/properties/text",
"deprecated": 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.",
"key": "type",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"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,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) results > (items) > (property) content > (items) > (property) type > (member) 0"
]
},
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 0 > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "logs"
}
},
"(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.",
"key": "file_id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputImageObject/properties/image/properties/file_id",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 1 > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "image"
}
},
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) results > (items) > (property) content > (items) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "text"
}
}
}
Example
{}
event
Occurs when a run step is cancelled.
Schema
Schema name: (resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 16
{
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 16": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RunStepStreamEvent/oneOf/5",
"ident": "UnionMember16",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "data"
},
{
"ident": "event"
}
]
},
"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",
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 16 > (property) event"
]
},
"(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",
"key": "data",
"optional": false,
"nullable": false,
"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",
"modelImplicit": false,
"modelPath": "(resource) beta.threads.runs.steps > (model) run_step",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) id",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) assistant_id",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) cancelled_at",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) completed_at",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) created_at",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) expired_at",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) failed_at",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) last_error",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) metadata",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) object",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) run_id",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) status",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) step_details",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) thread_id",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) type",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) usage"
]
},
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 16 > (property) event": {
"kind": "HttpDeclProperty",
"key": "event",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"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,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 16 > (property) event > (member) 0"
]
},
"(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.",
"key": "id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepObject/properties/id",
"deprecated": 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.",
"key": "assistant_id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepObject/properties/assistant_id",
"deprecated": 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.",
"key": "cancelled_at",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/RunStepObject/properties/cancelled_at",
"deprecated": false,
"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.",
"key": "completed_at",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/RunStepObject/properties/completed_at",
"deprecated": false,
"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.",
"key": "created_at",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/RunStepObject/properties/created_at",
"deprecated": 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.",
"key": "expired_at",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/RunStepObject/properties/expired_at",
"deprecated": false,
"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.",
"key": "failed_at",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/RunStepObject/properties/failed_at",
"deprecated": false,
"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.",
"key": "last_error",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "code"
},
{
"ident": "message"
}
]
},
"oasRef": "#/components/schemas/RunStepObject/properties/last_error",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) last_error > (property) code",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) last_error > (property) message"
]
},
"(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",
"key": "metadata",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeReference",
"ident": "Metadata",
"$ref": "(resource) $shared > (model) metadata > (schema)"
},
"oasRef": "#/components/schemas/RunStepObject/properties/metadata",
"deprecated": false,
"schemaType": "map",
"modelImplicit": false,
"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`.",
"key": "object",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "thread.run.step"
}
],
"oasRef": "#/components/schemas/RunStepObject/properties/object"
},
"oasRef": "#/components/schemas/RunStepObject/properties/object",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) object > (member) 0"
]
},
"(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.",
"key": "run_id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepObject/properties/run_id",
"deprecated": 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`.",
"key": "status",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "in_progress"
},
{
"kind": "HttpTypeLiteral",
"literal": "cancelled"
},
{
"kind": "HttpTypeLiteral",
"literal": "failed"
},
{
"kind": "HttpTypeLiteral",
"literal": "completed"
},
{
"kind": "HttpTypeLiteral",
"literal": "expired"
}
],
"oasRef": "#/components/schemas/RunStepObject/properties/status"
},
"oasRef": "#/components/schemas/RunStepObject/properties/status",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) status > (member) 0",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) status > (member) 1",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) status > (member) 2",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) status > (member) 3",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) status > (member) 4"
]
},
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) step_details": {
"kind": "HttpDeclProperty",
"docstring": "The details of the run step.",
"key": "step_details",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeReference",
"ident": "MessageCreationStepDetails",
"$ref": "(resource) beta.threads.runs.steps > (model) message_creation_step_details > (schema)"
},
{
"kind": "HttpTypeReference",
"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,
"schemaType": "union",
"childrenParentSchema": "union",
"children": [
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) step_details > (variant) 0",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) step_details > (variant) 1"
]
},
"(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.",
"key": "thread_id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepObject/properties/thread_id",
"deprecated": 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`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "message_creation"
},
{
"kind": "HttpTypeLiteral",
"literal": "tool_calls"
}
],
"oasRef": "#/components/schemas/RunStepObject/properties/type"
},
"oasRef": "#/components/schemas/RunStepObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) type > (member) 0",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) type > (member) 1"
]
},
"(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`.",
"key": "usage",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "completion_tokens"
},
{
"ident": "prompt_tokens"
},
{
"ident": "total_tokens"
}
]
},
"oasRef": "#/components/schemas/RunStepObject/properties/usage",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) usage > (property) completion_tokens",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) usage > (property) prompt_tokens",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) usage > (property) total_tokens"
]
},
"(resource) beta.threads.runs.steps > (model) run_step > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RunStepObject",
"ident": "RunStep",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "id"
},
{
"ident": "assistant_id"
},
{
"ident": "cancelled_at"
},
{
"ident": "completed_at"
},
{
"ident": "created_at"
},
{
"ident": "expired_at"
},
{
"ident": "failed_at"
},
{
"ident": "last_error"
},
{
"ident": "metadata"
},
{
"ident": "object"
},
{
"ident": "run_id"
},
{
"ident": "status"
},
{
"ident": "step_details"
},
{
"ident": "thread_id"
},
{
"ident": "type"
},
{
"ident": "usage"
}
]
},
"docstring": "Represents a step in execution of a run.\n",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) id",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) assistant_id",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) cancelled_at",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) completed_at",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) created_at",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) expired_at",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) failed_at",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) last_error",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) metadata",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) object",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) run_id",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) status",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) step_details",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) thread_id",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) type",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) usage"
]
},
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 16 > (property) event > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "thread.run.step.cancelled"
}
},
"(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`.",
"key": "code",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "server_error"
},
{
"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,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) last_error > (property) code > (member) 0",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) last_error > (property) code > (member) 1"
]
},
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) last_error > (property) message": {
"kind": "HttpDeclProperty",
"docstring": "A human-readable description of the error.",
"key": "message",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepObject/properties/last_error/anyOf/0/properties/message",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) $shared > (model) metadata > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/Metadata",
"ident": "Metadata",
"type": {
"kind": "HttpTypeReference",
"ident": "Record",
"typeParameters": [
{
"kind": "HttpTypeString"
},
{
"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": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "thread.run.step"
}
},
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) status > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "in_progress"
}
},
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) status > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "cancelled"
}
},
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) status > (member) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "failed"
}
},
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) status > (member) 3": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "completed"
}
},
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) status > (member) 4": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "expired"
}
},
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) step_details > (variant) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "MessageCreationStepDetails",
"$ref": "(resource) beta.threads.runs.steps > (model) message_creation_step_details > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) message_creation_step_details > (schema) > (property) message_creation",
"(resource) beta.threads.runs.steps > (model) message_creation_step_details > (schema) > (property) type"
]
},
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) step_details > (variant) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "ToolCallsStepDetails",
"$ref": "(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) tool_calls",
"(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) type"
]
},
"(resource) beta.threads.runs.steps > (model) message_creation_step_details > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RunStepDetailsMessageCreationObject",
"ident": "MessageCreationStepDetails",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "message_creation"
},
{
"ident": "type"
}
]
},
"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",
"(resource) beta.threads.runs.steps > (model) message_creation_step_details > (schema) > (property) type"
]
},
"(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RunStepDetailsToolCallsObject",
"ident": "ToolCallsStepDetails",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "tool_calls"
},
{
"ident": "type"
}
]
},
"docstring": "Details of the tool call.",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) tool_calls",
"(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) type"
]
},
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "message_creation"
}
},
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) type > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "tool_calls"
}
},
"(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.",
"key": "completion_tokens",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"oasRef": "#/components/schemas/RunStepCompletionUsage/anyOf/0/properties/completion_tokens",
"deprecated": 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.",
"key": "prompt_tokens",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"oasRef": "#/components/schemas/RunStepCompletionUsage/anyOf/0/properties/prompt_tokens",
"deprecated": 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).",
"key": "total_tokens",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"oasRef": "#/components/schemas/RunStepCompletionUsage/anyOf/0/properties/total_tokens",
"deprecated": false,
"schemaType": "integer",
"children": []
},
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) last_error > (property) code > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "server_error"
}
},
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) last_error > (property) code > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "rate_limit_exceeded"
}
},
"(resource) beta.threads.runs.steps > (model) message_creation_step_details > (schema) > (property) message_creation": {
"kind": "HttpDeclProperty",
"key": "message_creation",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "message_id"
}
]
},
"oasRef": "#/components/schemas/RunStepDetailsMessageCreationObject/properties/message_creation",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) message_creation_step_details > (schema) > (property) message_creation > (property) message_id"
]
},
"(resource) beta.threads.runs.steps > (model) message_creation_step_details > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "Always `message_creation`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "message_creation"
}
],
"oasRef": "#/components/schemas/RunStepDetailsMessageCreationObject/properties/type"
},
"oasRef": "#/components/schemas/RunStepDetailsMessageCreationObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs.steps > (model) message_creation_step_details > (schema) > (property) type > (member) 0"
]
},
"(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",
"key": "tool_calls",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeArray",
"elementType": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeReference",
"ident": "CodeInterpreterToolCall",
"$ref": "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema)"
},
{
"kind": "HttpTypeReference",
"ident": "FileSearchToolCall",
"$ref": "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema)"
},
{
"kind": "HttpTypeReference",
"ident": "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,
"schemaType": "array",
"childrenParentSchema": "union",
"children": [
"(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) tool_calls > (items) > (variant) 0",
"(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) tool_calls > (items) > (variant) 1",
"(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) tool_calls > (items) > (variant) 2"
]
},
"(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "Always `tool_calls`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "tool_calls"
}
],
"oasRef": "#/components/schemas/RunStepDetailsToolCallsObject/properties/type"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) type > (member) 0"
]
},
"(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.",
"key": "message_id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepDetailsMessageCreationObject/properties/message_creation/properties/message_id",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.runs.steps > (model) message_creation_step_details > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "message_creation"
}
},
"(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) tool_calls > (items) > (variant) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "CodeInterpreterToolCall",
"$ref": "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) id",
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter",
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) type"
]
},
"(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) tool_calls > (items) > (variant) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "FileSearchToolCall",
"$ref": "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) id",
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search",
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) type"
]
},
"(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) tool_calls > (items) > (variant) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "FunctionToolCall",
"$ref": "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) id",
"(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) function",
"(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) type"
]
},
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject",
"ident": "CodeInterpreterToolCall",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "id"
},
{
"ident": "code_interpreter"
},
{
"ident": "type"
}
]
},
"docstring": "Details of the Code Interpreter tool call the run step was involved in.",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) id",
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter",
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) type"
]
},
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject",
"ident": "FileSearchToolCall",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "id"
},
{
"ident": "file_search"
},
{
"ident": "type"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) id",
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search",
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) type"
]
},
"(resource) beta.threads.runs.steps > (model) function_tool_call > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject",
"ident": "FunctionToolCall",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "id"
},
{
"ident": "function"
},
{
"ident": "type"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) id",
"(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) function",
"(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) type"
]
},
"(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "tool_calls"
}
},
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) id": {
"kind": "HttpDeclProperty",
"docstring": "The ID of the tool call.",
"key": "id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/id",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter": {
"kind": "HttpDeclProperty",
"docstring": "The Code Interpreter tool call definition.",
"key": "code_interpreter",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "input"
},
{
"ident": "outputs"
}
]
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) input",
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs"
]
},
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The type of tool call. This is always going to be `code_interpreter` for this type of tool call.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "code_interpreter"
}
],
"oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/type"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) type > (member) 0"
]
},
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) id": {
"kind": "HttpDeclProperty",
"docstring": "The ID of the tool call object.",
"key": "id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/id",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search": {
"kind": "HttpDeclProperty",
"docstring": "For now, this is always going to be an empty object.",
"key": "file_search",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "ranking_options"
},
{
"ident": "results"
}
]
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/file_search",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) ranking_options",
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) results"
]
},
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The type of tool call. This is always going to be `file_search` for this type of tool call.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "file_search"
}
],
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/type"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) type > (member) 0"
]
},
"(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) id": {
"kind": "HttpDeclProperty",
"docstring": "The ID of the tool call object.",
"key": "id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/id",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) function": {
"kind": "HttpDeclProperty",
"docstring": "The definition of the function that was called.",
"key": "function",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "arguments"
},
{
"ident": "name"
},
{
"ident": "output"
}
]
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/function",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) function > (property) arguments",
"(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) function > (property) name",
"(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) function > (property) output"
]
},
"(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The type of tool call. This is always going to be `function` for this type of tool call.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "function"
}
],
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/type"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) type > (member) 0"
]
},
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) input": {
"kind": "HttpDeclProperty",
"docstring": "The input to the Code Interpreter tool call.",
"key": "input",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter/properties/input",
"deprecated": 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.",
"key": "outputs",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeArray",
"elementType": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeObject",
"members": [
{
"ident": "logs"
},
{
"ident": "type"
}
]
},
{
"kind": "HttpTypeObject",
"members": [
{
"ident": "image"
},
{
"ident": "type"
}
]
}
],
"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,
"schemaType": "array",
"childrenParentSchema": "union",
"children": [
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 0",
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 1"
]
},
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "code_interpreter"
}
},
"(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.",
"key": "ranking_options",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "ranker"
},
{
"ident": "score_threshold"
}
]
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/file_search/properties/ranking_options",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) ranking_options > (property) ranker",
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) ranking_options > (property) score_threshold"
]
},
"(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.",
"key": "results",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeArray",
"elementType": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "file_id"
},
{
"ident": "file_name"
},
{
"ident": "score"
},
{
"ident": "content"
}
]
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/file_search/properties/results"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/file_search/properties/results",
"deprecated": false,
"schemaType": "array",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) results > (items) > (property) file_id",
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) results > (items) > (property) file_name",
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) results > (items) > (property) score",
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) results > (items) > (property) content"
]
},
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "file_search"
}
},
"(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) function > (property) arguments": {
"kind": "HttpDeclProperty",
"docstring": "The arguments passed to the function.",
"key": "arguments",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/function/properties/arguments",
"deprecated": 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.",
"key": "name",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/function/properties/name",
"deprecated": 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.",
"key": "output",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/function/properties/output",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "function"
}
},
"(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",
"ident": "CodeInterpreterLogOutput",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "logs"
},
{
"ident": "type"
}
]
},
"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",
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 0 > (property) type"
]
},
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 1": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter/properties/outputs/items/oneOf/1",
"ident": "CodeInterpreterImageOutput",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "image"
},
{
"ident": "type"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 1 > (property) image",
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 1 > (property) type"
]
},
"(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.",
"key": "ranker",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "auto"
},
{
"kind": "HttpTypeLiteral",
"literal": "default_2024_08_21"
}
],
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchRankingOptionsObject/properties/ranker"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchRankingOptionsObject/properties/ranker",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) ranking_options > (property) ranker > (member) 0",
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) ranking_options > (property) ranker > (member) 1"
]
},
"(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.",
"key": "score_threshold",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"minimum": 0,
"maximum": 1
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchRankingOptionsObject/properties/score_threshold",
"deprecated": 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.",
"key": "file_id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/file_id",
"deprecated": 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.",
"key": "file_name",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/file_name",
"deprecated": 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.",
"key": "score",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"minimum": 0,
"maximum": 1
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/score",
"deprecated": 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.",
"key": "content",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeArray",
"elementType": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "text"
},
{
"ident": "type"
}
]
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/content"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/content",
"deprecated": false,
"schemaType": "array",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) results > (items) > (property) content > (items) > (property) text",
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) results > (items) > (property) content > (items) > (property) type"
]
},
"(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.",
"key": "logs",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputLogsObject/properties/logs",
"deprecated": 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`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "logs"
}
],
"oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputLogsObject/properties/type"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputLogsObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 0 > (property) type > (member) 0"
]
},
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 1 > (property) image": {
"kind": "HttpDeclProperty",
"key": "image",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "file_id"
}
]
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputImageObject/properties/image",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 1 > (property) image > (property) file_id"
]
},
"(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`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "image"
}
],
"oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputImageObject/properties/type"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputImageObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 1 > (property) type > (member) 0"
]
},
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) ranking_options > (property) ranker > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "auto"
}
},
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) ranking_options > (property) ranker > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "default_2024_08_21"
}
},
"(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.",
"key": "text",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/content/items/properties/text",
"deprecated": 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.",
"key": "type",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"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,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) results > (items) > (property) content > (items) > (property) type > (member) 0"
]
},
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 0 > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "logs"
}
},
"(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.",
"key": "file_id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputImageObject/properties/image/properties/file_id",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 1 > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "image"
}
},
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) results > (items) > (property) content > (items) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "text"
}
}
}
Example
{}
event
Occurs when a run step expires.
Schema
Schema name: (resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 17
{
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 17": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RunStepStreamEvent/oneOf/6",
"ident": "UnionMember17",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "data"
},
{
"ident": "event"
}
]
},
"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",
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 17 > (property) event"
]
},
"(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",
"key": "data",
"optional": false,
"nullable": false,
"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",
"modelImplicit": false,
"modelPath": "(resource) beta.threads.runs.steps > (model) run_step",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) id",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) assistant_id",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) cancelled_at",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) completed_at",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) created_at",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) expired_at",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) failed_at",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) last_error",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) metadata",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) object",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) run_id",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) status",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) step_details",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) thread_id",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) type",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) usage"
]
},
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 17 > (property) event": {
"kind": "HttpDeclProperty",
"key": "event",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"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,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 17 > (property) event > (member) 0"
]
},
"(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.",
"key": "id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepObject/properties/id",
"deprecated": 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.",
"key": "assistant_id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepObject/properties/assistant_id",
"deprecated": 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.",
"key": "cancelled_at",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/RunStepObject/properties/cancelled_at",
"deprecated": false,
"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.",
"key": "completed_at",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/RunStepObject/properties/completed_at",
"deprecated": false,
"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.",
"key": "created_at",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/RunStepObject/properties/created_at",
"deprecated": 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.",
"key": "expired_at",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/RunStepObject/properties/expired_at",
"deprecated": false,
"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.",
"key": "failed_at",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/RunStepObject/properties/failed_at",
"deprecated": false,
"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.",
"key": "last_error",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "code"
},
{
"ident": "message"
}
]
},
"oasRef": "#/components/schemas/RunStepObject/properties/last_error",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) last_error > (property) code",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) last_error > (property) message"
]
},
"(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",
"key": "metadata",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeReference",
"ident": "Metadata",
"$ref": "(resource) $shared > (model) metadata > (schema)"
},
"oasRef": "#/components/schemas/RunStepObject/properties/metadata",
"deprecated": false,
"schemaType": "map",
"modelImplicit": false,
"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`.",
"key": "object",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "thread.run.step"
}
],
"oasRef": "#/components/schemas/RunStepObject/properties/object"
},
"oasRef": "#/components/schemas/RunStepObject/properties/object",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) object > (member) 0"
]
},
"(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.",
"key": "run_id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepObject/properties/run_id",
"deprecated": 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`.",
"key": "status",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "in_progress"
},
{
"kind": "HttpTypeLiteral",
"literal": "cancelled"
},
{
"kind": "HttpTypeLiteral",
"literal": "failed"
},
{
"kind": "HttpTypeLiteral",
"literal": "completed"
},
{
"kind": "HttpTypeLiteral",
"literal": "expired"
}
],
"oasRef": "#/components/schemas/RunStepObject/properties/status"
},
"oasRef": "#/components/schemas/RunStepObject/properties/status",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) status > (member) 0",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) status > (member) 1",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) status > (member) 2",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) status > (member) 3",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) status > (member) 4"
]
},
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) step_details": {
"kind": "HttpDeclProperty",
"docstring": "The details of the run step.",
"key": "step_details",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeReference",
"ident": "MessageCreationStepDetails",
"$ref": "(resource) beta.threads.runs.steps > (model) message_creation_step_details > (schema)"
},
{
"kind": "HttpTypeReference",
"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,
"schemaType": "union",
"childrenParentSchema": "union",
"children": [
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) step_details > (variant) 0",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) step_details > (variant) 1"
]
},
"(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.",
"key": "thread_id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepObject/properties/thread_id",
"deprecated": 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`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "message_creation"
},
{
"kind": "HttpTypeLiteral",
"literal": "tool_calls"
}
],
"oasRef": "#/components/schemas/RunStepObject/properties/type"
},
"oasRef": "#/components/schemas/RunStepObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) type > (member) 0",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) type > (member) 1"
]
},
"(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`.",
"key": "usage",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "completion_tokens"
},
{
"ident": "prompt_tokens"
},
{
"ident": "total_tokens"
}
]
},
"oasRef": "#/components/schemas/RunStepObject/properties/usage",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) usage > (property) completion_tokens",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) usage > (property) prompt_tokens",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) usage > (property) total_tokens"
]
},
"(resource) beta.threads.runs.steps > (model) run_step > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RunStepObject",
"ident": "RunStep",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "id"
},
{
"ident": "assistant_id"
},
{
"ident": "cancelled_at"
},
{
"ident": "completed_at"
},
{
"ident": "created_at"
},
{
"ident": "expired_at"
},
{
"ident": "failed_at"
},
{
"ident": "last_error"
},
{
"ident": "metadata"
},
{
"ident": "object"
},
{
"ident": "run_id"
},
{
"ident": "status"
},
{
"ident": "step_details"
},
{
"ident": "thread_id"
},
{
"ident": "type"
},
{
"ident": "usage"
}
]
},
"docstring": "Represents a step in execution of a run.\n",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) id",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) assistant_id",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) cancelled_at",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) completed_at",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) created_at",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) expired_at",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) failed_at",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) last_error",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) metadata",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) object",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) run_id",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) status",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) step_details",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) thread_id",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) type",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) usage"
]
},
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 17 > (property) event > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "thread.run.step.expired"
}
},
"(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`.",
"key": "code",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "server_error"
},
{
"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,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) last_error > (property) code > (member) 0",
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) last_error > (property) code > (member) 1"
]
},
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) last_error > (property) message": {
"kind": "HttpDeclProperty",
"docstring": "A human-readable description of the error.",
"key": "message",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepObject/properties/last_error/anyOf/0/properties/message",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) $shared > (model) metadata > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/Metadata",
"ident": "Metadata",
"type": {
"kind": "HttpTypeReference",
"ident": "Record",
"typeParameters": [
{
"kind": "HttpTypeString"
},
{
"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": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "thread.run.step"
}
},
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) status > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "in_progress"
}
},
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) status > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "cancelled"
}
},
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) status > (member) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "failed"
}
},
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) status > (member) 3": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "completed"
}
},
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) status > (member) 4": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "expired"
}
},
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) step_details > (variant) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "MessageCreationStepDetails",
"$ref": "(resource) beta.threads.runs.steps > (model) message_creation_step_details > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) message_creation_step_details > (schema) > (property) message_creation",
"(resource) beta.threads.runs.steps > (model) message_creation_step_details > (schema) > (property) type"
]
},
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) step_details > (variant) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "ToolCallsStepDetails",
"$ref": "(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) tool_calls",
"(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) type"
]
},
"(resource) beta.threads.runs.steps > (model) message_creation_step_details > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RunStepDetailsMessageCreationObject",
"ident": "MessageCreationStepDetails",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "message_creation"
},
{
"ident": "type"
}
]
},
"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",
"(resource) beta.threads.runs.steps > (model) message_creation_step_details > (schema) > (property) type"
]
},
"(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RunStepDetailsToolCallsObject",
"ident": "ToolCallsStepDetails",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "tool_calls"
},
{
"ident": "type"
}
]
},
"docstring": "Details of the tool call.",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) tool_calls",
"(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) type"
]
},
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "message_creation"
}
},
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) type > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "tool_calls"
}
},
"(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.",
"key": "completion_tokens",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"oasRef": "#/components/schemas/RunStepCompletionUsage/anyOf/0/properties/completion_tokens",
"deprecated": 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.",
"key": "prompt_tokens",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"oasRef": "#/components/schemas/RunStepCompletionUsage/anyOf/0/properties/prompt_tokens",
"deprecated": 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).",
"key": "total_tokens",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"oasRef": "#/components/schemas/RunStepCompletionUsage/anyOf/0/properties/total_tokens",
"deprecated": false,
"schemaType": "integer",
"children": []
},
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) last_error > (property) code > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "server_error"
}
},
"(resource) beta.threads.runs.steps > (model) run_step > (schema) > (property) last_error > (property) code > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "rate_limit_exceeded"
}
},
"(resource) beta.threads.runs.steps > (model) message_creation_step_details > (schema) > (property) message_creation": {
"kind": "HttpDeclProperty",
"key": "message_creation",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "message_id"
}
]
},
"oasRef": "#/components/schemas/RunStepDetailsMessageCreationObject/properties/message_creation",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) message_creation_step_details > (schema) > (property) message_creation > (property) message_id"
]
},
"(resource) beta.threads.runs.steps > (model) message_creation_step_details > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "Always `message_creation`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "message_creation"
}
],
"oasRef": "#/components/schemas/RunStepDetailsMessageCreationObject/properties/type"
},
"oasRef": "#/components/schemas/RunStepDetailsMessageCreationObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs.steps > (model) message_creation_step_details > (schema) > (property) type > (member) 0"
]
},
"(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",
"key": "tool_calls",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeArray",
"elementType": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeReference",
"ident": "CodeInterpreterToolCall",
"$ref": "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema)"
},
{
"kind": "HttpTypeReference",
"ident": "FileSearchToolCall",
"$ref": "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema)"
},
{
"kind": "HttpTypeReference",
"ident": "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,
"schemaType": "array",
"childrenParentSchema": "union",
"children": [
"(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) tool_calls > (items) > (variant) 0",
"(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) tool_calls > (items) > (variant) 1",
"(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) tool_calls > (items) > (variant) 2"
]
},
"(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "Always `tool_calls`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "tool_calls"
}
],
"oasRef": "#/components/schemas/RunStepDetailsToolCallsObject/properties/type"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) type > (member) 0"
]
},
"(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.",
"key": "message_id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepDetailsMessageCreationObject/properties/message_creation/properties/message_id",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.runs.steps > (model) message_creation_step_details > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "message_creation"
}
},
"(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) tool_calls > (items) > (variant) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "CodeInterpreterToolCall",
"$ref": "(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) id",
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter",
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) type"
]
},
"(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) tool_calls > (items) > (variant) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "FileSearchToolCall",
"$ref": "(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) id",
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search",
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) type"
]
},
"(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) tool_calls > (items) > (variant) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "FunctionToolCall",
"$ref": "(resource) beta.threads.runs.steps > (model) function_tool_call > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) id",
"(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) function",
"(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) type"
]
},
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject",
"ident": "CodeInterpreterToolCall",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "id"
},
{
"ident": "code_interpreter"
},
{
"ident": "type"
}
]
},
"docstring": "Details of the Code Interpreter tool call the run step was involved in.",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) id",
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter",
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) type"
]
},
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject",
"ident": "FileSearchToolCall",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "id"
},
{
"ident": "file_search"
},
{
"ident": "type"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) id",
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search",
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) type"
]
},
"(resource) beta.threads.runs.steps > (model) function_tool_call > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject",
"ident": "FunctionToolCall",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "id"
},
{
"ident": "function"
},
{
"ident": "type"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) id",
"(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) function",
"(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) type"
]
},
"(resource) beta.threads.runs.steps > (model) tool_calls_step_details > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "tool_calls"
}
},
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) id": {
"kind": "HttpDeclProperty",
"docstring": "The ID of the tool call.",
"key": "id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/id",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter": {
"kind": "HttpDeclProperty",
"docstring": "The Code Interpreter tool call definition.",
"key": "code_interpreter",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "input"
},
{
"ident": "outputs"
}
]
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) input",
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs"
]
},
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The type of tool call. This is always going to be `code_interpreter` for this type of tool call.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "code_interpreter"
}
],
"oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/type"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) type > (member) 0"
]
},
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) id": {
"kind": "HttpDeclProperty",
"docstring": "The ID of the tool call object.",
"key": "id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/id",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search": {
"kind": "HttpDeclProperty",
"docstring": "For now, this is always going to be an empty object.",
"key": "file_search",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "ranking_options"
},
{
"ident": "results"
}
]
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/file_search",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) ranking_options",
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) results"
]
},
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The type of tool call. This is always going to be `file_search` for this type of tool call.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "file_search"
}
],
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/type"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) type > (member) 0"
]
},
"(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) id": {
"kind": "HttpDeclProperty",
"docstring": "The ID of the tool call object.",
"key": "id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/id",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) function": {
"kind": "HttpDeclProperty",
"docstring": "The definition of the function that was called.",
"key": "function",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "arguments"
},
{
"ident": "name"
},
{
"ident": "output"
}
]
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/function",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) function > (property) arguments",
"(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) function > (property) name",
"(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) function > (property) output"
]
},
"(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The type of tool call. This is always going to be `function` for this type of tool call.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "function"
}
],
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/type"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) type > (member) 0"
]
},
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) input": {
"kind": "HttpDeclProperty",
"docstring": "The input to the Code Interpreter tool call.",
"key": "input",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter/properties/input",
"deprecated": 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.",
"key": "outputs",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeArray",
"elementType": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeObject",
"members": [
{
"ident": "logs"
},
{
"ident": "type"
}
]
},
{
"kind": "HttpTypeObject",
"members": [
{
"ident": "image"
},
{
"ident": "type"
}
]
}
],
"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,
"schemaType": "array",
"childrenParentSchema": "union",
"children": [
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 0",
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 1"
]
},
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "code_interpreter"
}
},
"(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.",
"key": "ranking_options",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "ranker"
},
{
"ident": "score_threshold"
}
]
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/file_search/properties/ranking_options",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) ranking_options > (property) ranker",
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) ranking_options > (property) score_threshold"
]
},
"(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.",
"key": "results",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeArray",
"elementType": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "file_id"
},
{
"ident": "file_name"
},
{
"ident": "score"
},
{
"ident": "content"
}
]
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/file_search/properties/results"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchObject/properties/file_search/properties/results",
"deprecated": false,
"schemaType": "array",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) results > (items) > (property) file_id",
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) results > (items) > (property) file_name",
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) results > (items) > (property) score",
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) results > (items) > (property) content"
]
},
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "file_search"
}
},
"(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) function > (property) arguments": {
"kind": "HttpDeclProperty",
"docstring": "The arguments passed to the function.",
"key": "arguments",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/function/properties/arguments",
"deprecated": 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.",
"key": "name",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/function/properties/name",
"deprecated": 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.",
"key": "output",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFunctionObject/properties/function/properties/output",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.runs.steps > (model) function_tool_call > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "function"
}
},
"(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",
"ident": "CodeInterpreterLogOutput",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "logs"
},
{
"ident": "type"
}
]
},
"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",
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 0 > (property) type"
]
},
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 1": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeObject/properties/code_interpreter/properties/outputs/items/oneOf/1",
"ident": "CodeInterpreterImageOutput",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "image"
},
{
"ident": "type"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 1 > (property) image",
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 1 > (property) type"
]
},
"(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.",
"key": "ranker",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "auto"
},
{
"kind": "HttpTypeLiteral",
"literal": "default_2024_08_21"
}
],
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchRankingOptionsObject/properties/ranker"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchRankingOptionsObject/properties/ranker",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) ranking_options > (property) ranker > (member) 0",
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) ranking_options > (property) ranker > (member) 1"
]
},
"(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.",
"key": "score_threshold",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"minimum": 0,
"maximum": 1
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchRankingOptionsObject/properties/score_threshold",
"deprecated": 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.",
"key": "file_id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/file_id",
"deprecated": 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.",
"key": "file_name",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/file_name",
"deprecated": 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.",
"key": "score",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"minimum": 0,
"maximum": 1
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/score",
"deprecated": 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.",
"key": "content",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeArray",
"elementType": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "text"
},
{
"ident": "type"
}
]
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/content"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/content",
"deprecated": false,
"schemaType": "array",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) results > (items) > (property) content > (items) > (property) text",
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) results > (items) > (property) content > (items) > (property) type"
]
},
"(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.",
"key": "logs",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputLogsObject/properties/logs",
"deprecated": 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`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "logs"
}
],
"oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputLogsObject/properties/type"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputLogsObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 0 > (property) type > (member) 0"
]
},
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 1 > (property) image": {
"kind": "HttpDeclProperty",
"key": "image",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "file_id"
}
]
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputImageObject/properties/image",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 1 > (property) image > (property) file_id"
]
},
"(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`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "image"
}
],
"oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputImageObject/properties/type"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputImageObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 1 > (property) type > (member) 0"
]
},
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) ranking_options > (property) ranker > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "auto"
}
},
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) ranking_options > (property) ranker > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "default_2024_08_21"
}
},
"(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.",
"key": "text",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject/properties/content/items/properties/text",
"deprecated": 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.",
"key": "type",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"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,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) results > (items) > (property) content > (items) > (property) type > (member) 0"
]
},
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 0 > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "logs"
}
},
"(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.",
"key": "file_id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RunStepDetailsToolCallsCodeOutputImageObject/properties/image/properties/file_id",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.runs.steps > (model) code_interpreter_tool_call > (schema) > (property) code_interpreter > (property) outputs > (items) > (variant) 1 > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "image"
}
},
"(resource) beta.threads.runs.steps > (model) file_search_tool_call > (schema) > (property) file_search > (property) results > (items) > (property) content > (items) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "text"
}
}
}
Example
{}
event
Occurs when a message is created.
Schema
Schema name: (resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 18
{
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 18": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/MessageStreamEvent/oneOf/0",
"ident": "UnionMember18",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "data"
},
{
"ident": "event"
}
]
},
"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",
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 18 > (property) event"
]
},
"(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).",
"key": "data",
"optional": false,
"nullable": false,
"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",
"modelImplicit": false,
"modelPath": "(resource) beta.threads.messages > (model) message",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) message > (schema) > (property) id",
"(resource) beta.threads.messages > (model) message > (schema) > (property) assistant_id",
"(resource) beta.threads.messages > (model) message > (schema) > (property) attachments",
"(resource) beta.threads.messages > (model) message > (schema) > (property) completed_at",
"(resource) beta.threads.messages > (model) message > (schema) > (property) content",
"(resource) beta.threads.messages > (model) message > (schema) > (property) created_at",
"(resource) beta.threads.messages > (model) message > (schema) > (property) incomplete_at",
"(resource) beta.threads.messages > (model) message > (schema) > (property) incomplete_details",
"(resource) beta.threads.messages > (model) message > (schema) > (property) metadata",
"(resource) beta.threads.messages > (model) message > (schema) > (property) object",
"(resource) beta.threads.messages > (model) message > (schema) > (property) role",
"(resource) beta.threads.messages > (model) message > (schema) > (property) run_id",
"(resource) beta.threads.messages > (model) message > (schema) > (property) status",
"(resource) beta.threads.messages > (model) message > (schema) > (property) thread_id"
]
},
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 18 > (property) event": {
"kind": "HttpDeclProperty",
"key": "event",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"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,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 18 > (property) event > (member) 0"
]
},
"(resource) beta.threads.messages > (model) message > (schema) > (property) id": {
"kind": "HttpDeclProperty",
"docstring": "The identifier, which can be referenced in API endpoints.",
"key": "id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/MessageObject/properties/id",
"deprecated": 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.",
"key": "assistant_id",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/MessageObject/properties/assistant_id",
"deprecated": false,
"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.",
"key": "attachments",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeArray",
"elementType": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "file_id"
},
{
"ident": "tools"
}
]
},
"oasRef": "#/components/schemas/MessageObject/properties/attachments"
},
"oasRef": "#/components/schemas/MessageObject/properties/attachments",
"deprecated": false,
"schemaType": "array",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) message > (schema) > (property) attachments > (items) > (property) file_id",
"(resource) beta.threads.messages > (model) message > (schema) > (property) attachments > (items) > (property) tools"
]
},
"(resource) beta.threads.messages > (model) message > (schema) > (property) completed_at": {
"kind": "HttpDeclProperty",
"docstring": "The Unix timestamp (in seconds) for when the message was completed.",
"key": "completed_at",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/MessageObject/properties/completed_at",
"deprecated": false,
"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.",
"key": "content",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeArray",
"elementType": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeReference",
"ident": "ImageFileContentBlock",
"$ref": "(resource) beta.threads.messages > (model) image_file_content_block > (schema)"
},
{
"kind": "HttpTypeReference",
"ident": "ImageURLContentBlock",
"$ref": "(resource) beta.threads.messages > (model) image_url_content_block > (schema)"
},
{
"kind": "HttpTypeReference",
"ident": "TextContentBlock",
"$ref": "(resource) beta.threads.messages > (model) text_content_block > (schema)"
},
{
"kind": "HttpTypeReference",
"ident": "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,
"schemaType": "array",
"childrenParentSchema": "union",
"children": [
"(resource) beta.threads.messages > (model) message > (schema) > (property) content > (items) > (variant) 0",
"(resource) beta.threads.messages > (model) message > (schema) > (property) content > (items) > (variant) 1",
"(resource) beta.threads.messages > (model) message > (schema) > (property) content > (items) > (variant) 2",
"(resource) beta.threads.messages > (model) message > (schema) > (property) content > (items) > (variant) 3"
]
},
"(resource) beta.threads.messages > (model) message > (schema) > (property) created_at": {
"kind": "HttpDeclProperty",
"docstring": "The Unix timestamp (in seconds) for when the message was created.",
"key": "created_at",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/MessageObject/properties/created_at",
"deprecated": 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.",
"key": "incomplete_at",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/MessageObject/properties/incomplete_at",
"deprecated": false,
"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.",
"key": "incomplete_details",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "reason"
}
]
},
"oasRef": "#/components/schemas/MessageObject/properties/incomplete_details",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) message > (schema) > (property) incomplete_details > (property) reason"
]
},
"(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",
"key": "metadata",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeReference",
"ident": "Metadata",
"$ref": "(resource) $shared > (model) metadata > (schema)"
},
"oasRef": "#/components/schemas/MessageObject/properties/metadata",
"deprecated": false,
"schemaType": "map",
"modelImplicit": false,
"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`.",
"key": "object",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "thread.message"
}
],
"oasRef": "#/components/schemas/MessageObject/properties/object"
},
"oasRef": "#/components/schemas/MessageObject/properties/object",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.messages > (model) message > (schema) > (property) object > (member) 0"
]
},
"(resource) beta.threads.messages > (model) message > (schema) > (property) role": {
"kind": "HttpDeclProperty",
"docstring": "The entity that produced the message. One of `user` or `assistant`.",
"key": "role",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "user"
},
{
"kind": "HttpTypeLiteral",
"literal": "assistant"
}
],
"oasRef": "#/components/schemas/MessageObject/properties/role"
},
"oasRef": "#/components/schemas/MessageObject/properties/role",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.messages > (model) message > (schema) > (property) role > (member) 0",
"(resource) beta.threads.messages > (model) message > (schema) > (property) role > (member) 1"
]
},
"(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.",
"key": "run_id",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/MessageObject/properties/run_id",
"deprecated": false,
"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`.",
"key": "status",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "in_progress"
},
{
"kind": "HttpTypeLiteral",
"literal": "incomplete"
},
{
"kind": "HttpTypeLiteral",
"literal": "completed"
}
],
"oasRef": "#/components/schemas/MessageObject/properties/status"
},
"oasRef": "#/components/schemas/MessageObject/properties/status",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.messages > (model) message > (schema) > (property) status > (member) 0",
"(resource) beta.threads.messages > (model) message > (schema) > (property) status > (member) 1",
"(resource) beta.threads.messages > (model) message > (schema) > (property) status > (member) 2"
]
},
"(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.",
"key": "thread_id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/MessageObject/properties/thread_id",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.messages > (model) message > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/MessageObject",
"ident": "Message",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "id"
},
{
"ident": "assistant_id"
},
{
"ident": "attachments"
},
{
"ident": "completed_at"
},
{
"ident": "content"
},
{
"ident": "created_at"
},
{
"ident": "incomplete_at"
},
{
"ident": "incomplete_details"
},
{
"ident": "metadata"
},
{
"ident": "object"
},
{
"ident": "role"
},
{
"ident": "run_id"
},
{
"ident": "status"
},
{
"ident": "thread_id"
}
]
},
"docstring": "Represents a message within a [thread](/docs/api-reference/threads).",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) message > (schema) > (property) id",
"(resource) beta.threads.messages > (model) message > (schema) > (property) assistant_id",
"(resource) beta.threads.messages > (model) message > (schema) > (property) attachments",
"(resource) beta.threads.messages > (model) message > (schema) > (property) completed_at",
"(resource) beta.threads.messages > (model) message > (schema) > (property) content",
"(resource) beta.threads.messages > (model) message > (schema) > (property) created_at",
"(resource) beta.threads.messages > (model) message > (schema) > (property) incomplete_at",
"(resource) beta.threads.messages > (model) message > (schema) > (property) incomplete_details",
"(resource) beta.threads.messages > (model) message > (schema) > (property) metadata",
"(resource) beta.threads.messages > (model) message > (schema) > (property) object",
"(resource) beta.threads.messages > (model) message > (schema) > (property) role",
"(resource) beta.threads.messages > (model) message > (schema) > (property) run_id",
"(resource) beta.threads.messages > (model) message > (schema) > (property) status",
"(resource) beta.threads.messages > (model) message > (schema) > (property) thread_id"
]
},
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 18 > (property) event > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "thread.message.created"
}
},
"(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.",
"key": "file_id",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/MessageObject/properties/attachments/anyOf/0/items/properties/file_id",
"deprecated": 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.",
"key": "tools",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeArray",
"elementType": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeReference",
"ident": "CodeInterpreterTool",
"$ref": "(resource) beta.assistants > (model) code_interpreter_tool > (schema)"
},
{
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
}
]
}
],
"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,
"schemaType": "array",
"childrenParentSchema": "union",
"children": [
"(resource) beta.threads.messages > (model) message > (schema) > (property) attachments > (items) > (property) tools > (items) > (variant) 0",
"(resource) beta.threads.messages > (model) message > (schema) > (property) attachments > (items) > (property) tools > (items) > (variant) 1"
]
},
"(resource) beta.threads.messages > (model) message > (schema) > (property) content > (items) > (variant) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "ImageFileContentBlock",
"$ref": "(resource) beta.threads.messages > (model) image_file_content_block > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) image_file_content_block > (schema) > (property) image_file",
"(resource) beta.threads.messages > (model) image_file_content_block > (schema) > (property) type"
]
},
"(resource) beta.threads.messages > (model) message > (schema) > (property) content > (items) > (variant) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "ImageURLContentBlock",
"$ref": "(resource) beta.threads.messages > (model) image_url_content_block > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) image_url_content_block > (schema) > (property) image_url",
"(resource) beta.threads.messages > (model) image_url_content_block > (schema) > (property) type"
]
},
"(resource) beta.threads.messages > (model) message > (schema) > (property) content > (items) > (variant) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "TextContentBlock",
"$ref": "(resource) beta.threads.messages > (model) text_content_block > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) text_content_block > (schema) > (property) text",
"(resource) beta.threads.messages > (model) text_content_block > (schema) > (property) type"
]
},
"(resource) beta.threads.messages > (model) message > (schema) > (property) content > (items) > (variant) 3": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "RefusalContentBlock",
"$ref": "(resource) beta.threads.messages > (model) refusal_content_block > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) refusal_content_block > (schema) > (property) refusal",
"(resource) beta.threads.messages > (model) refusal_content_block > (schema) > (property) type"
]
},
"(resource) beta.threads.messages > (model) image_file_content_block > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/MessageContentImageFileObject",
"ident": "ImageFileContentBlock",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "image_file"
},
{
"ident": "type"
}
]
},
"docstring": "References an image [File](/docs/api-reference/files) in the content of a message.",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) image_file_content_block > (schema) > (property) image_file",
"(resource) beta.threads.messages > (model) image_file_content_block > (schema) > (property) type"
]
},
"(resource) beta.threads.messages > (model) image_url_content_block > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/MessageContentImageUrlObject",
"ident": "ImageURLContentBlock",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "image_url"
},
{
"ident": "type"
}
]
},
"docstring": "References an image URL in the content of a message.",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) image_url_content_block > (schema) > (property) image_url",
"(resource) beta.threads.messages > (model) image_url_content_block > (schema) > (property) type"
]
},
"(resource) beta.threads.messages > (model) text_content_block > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/MessageContentTextObject",
"ident": "TextContentBlock",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "text"
},
{
"ident": "type"
}
]
},
"docstring": "The text content that is part of a message.",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) text_content_block > (schema) > (property) text",
"(resource) beta.threads.messages > (model) text_content_block > (schema) > (property) type"
]
},
"(resource) beta.threads.messages > (model) refusal_content_block > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/MessageContentRefusalObject",
"ident": "RefusalContentBlock",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "refusal"
},
{
"ident": "type"
}
]
},
"docstring": "The refusal content generated by the assistant.",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) refusal_content_block > (schema) > (property) refusal",
"(resource) beta.threads.messages > (model) refusal_content_block > (schema) > (property) type"
]
},
"(resource) beta.threads.messages > (model) message > (schema) > (property) incomplete_details > (property) reason": {
"kind": "HttpDeclProperty",
"docstring": "The reason the message is incomplete.",
"key": "reason",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "content_filter"
},
{
"kind": "HttpTypeLiteral",
"literal": "max_tokens"
},
{
"kind": "HttpTypeLiteral",
"literal": "run_cancelled"
},
{
"kind": "HttpTypeLiteral",
"literal": "run_expired"
},
{
"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,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.messages > (model) message > (schema) > (property) incomplete_details > (property) reason > (member) 0",
"(resource) beta.threads.messages > (model) message > (schema) > (property) incomplete_details > (property) reason > (member) 1",
"(resource) beta.threads.messages > (model) message > (schema) > (property) incomplete_details > (property) reason > (member) 2",
"(resource) beta.threads.messages > (model) message > (schema) > (property) incomplete_details > (property) reason > (member) 3",
"(resource) beta.threads.messages > (model) message > (schema) > (property) incomplete_details > (property) reason > (member) 4"
]
},
"(resource) $shared > (model) metadata > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/Metadata",
"ident": "Metadata",
"type": {
"kind": "HttpTypeReference",
"ident": "Record",
"typeParameters": [
{
"kind": "HttpTypeString"
},
{
"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": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "thread.message"
}
},
"(resource) beta.threads.messages > (model) message > (schema) > (property) role > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "user"
}
},
"(resource) beta.threads.messages > (model) message > (schema) > (property) role > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "assistant"
}
},
"(resource) beta.threads.messages > (model) message > (schema) > (property) status > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "in_progress"
}
},
"(resource) beta.threads.messages > (model) message > (schema) > (property) status > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "incomplete"
}
},
"(resource) beta.threads.messages > (model) message > (schema) > (property) status > (member) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "completed"
}
},
"(resource) beta.threads.messages > (model) message > (schema) > (property) attachments > (items) > (property) tools > (items) > (variant) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "CodeInterpreterTool",
"$ref": "(resource) beta.assistants > (model) code_interpreter_tool > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type"
]
},
"(resource) beta.threads.messages > (model) message > (schema) > (property) attachments > (items) > (property) tools > (items) > (variant) 1": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/MessageObject/properties/attachments/anyOf/0/items/properties/tools/items/oneOf/1",
"ident": "FileSearchTool",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) message > (schema) > (property) attachments > (items) > (property) tools > (items) > (variant) 1 > (property) type"
]
},
"(resource) beta.assistants > (model) code_interpreter_tool > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/AssistantToolsCode",
"ident": "CodeInterpreterTool",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type"
]
},
"(resource) beta.threads.messages > (model) image_file_content_block > (schema) > (property) image_file": {
"kind": "HttpDeclProperty",
"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",
"modelImplicit": false,
"modelPath": "(resource) beta.threads.messages > (model) image_file",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) image_file > (schema) > (property) file_id",
"(resource) beta.threads.messages > (model) image_file > (schema) > (property) detail"
]
},
"(resource) beta.threads.messages > (model) image_file_content_block > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "Always `image_file`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "image_file"
}
],
"oasRef": "#/components/schemas/MessageContentImageFileObject/properties/type"
},
"oasRef": "#/components/schemas/MessageContentImageFileObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.messages > (model) image_file_content_block > (schema) > (property) type > (member) 0"
]
},
"(resource) beta.threads.messages > (model) image_url_content_block > (schema) > (property) image_url": {
"kind": "HttpDeclProperty",
"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",
"modelImplicit": false,
"modelPath": "(resource) beta.threads.messages > (model) image_url",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) image_url > (schema) > (property) url",
"(resource) beta.threads.messages > (model) image_url > (schema) > (property) detail"
]
},
"(resource) beta.threads.messages > (model) image_url_content_block > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The type of the content part.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "image_url"
}
],
"oasRef": "#/components/schemas/MessageContentImageUrlObject/properties/type"
},
"oasRef": "#/components/schemas/MessageContentImageUrlObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.messages > (model) image_url_content_block > (schema) > (property) type > (member) 0"
]
},
"(resource) beta.threads.messages > (model) text_content_block > (schema) > (property) text": {
"kind": "HttpDeclProperty",
"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",
"modelImplicit": false,
"modelPath": "(resource) beta.threads.messages > (model) text",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) text > (schema) > (property) annotations",
"(resource) beta.threads.messages > (model) text > (schema) > (property) value"
]
},
"(resource) beta.threads.messages > (model) text_content_block > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "Always `text`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "text"
}
],
"oasRef": "#/components/schemas/MessageContentTextObject/properties/type"
},
"oasRef": "#/components/schemas/MessageContentTextObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.messages > (model) text_content_block > (schema) > (property) type > (member) 0"
]
},
"(resource) beta.threads.messages > (model) refusal_content_block > (schema) > (property) refusal": {
"kind": "HttpDeclProperty",
"key": "refusal",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/MessageContentRefusalObject/properties/refusal",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.messages > (model) refusal_content_block > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "Always `refusal`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "refusal"
}
],
"oasRef": "#/components/schemas/MessageContentRefusalObject/properties/type"
},
"oasRef": "#/components/schemas/MessageContentRefusalObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.messages > (model) refusal_content_block > (schema) > (property) type > (member) 0"
]
},
"(resource) beta.threads.messages > (model) message > (schema) > (property) incomplete_details > (property) reason > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "content_filter"
}
},
"(resource) beta.threads.messages > (model) message > (schema) > (property) incomplete_details > (property) reason > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "max_tokens"
}
},
"(resource) beta.threads.messages > (model) message > (schema) > (property) incomplete_details > (property) reason > (member) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "run_cancelled"
}
},
"(resource) beta.threads.messages > (model) message > (schema) > (property) incomplete_details > (property) reason > (member) 3": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "run_expired"
}
},
"(resource) beta.threads.messages > (model) message > (schema) > (property) incomplete_details > (property) reason > (member) 4": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "run_failed"
}
},
"(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The type of tool being defined: `code_interpreter`",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "code_interpreter"
}
],
"oasRef": "#/components/schemas/AssistantToolsCode/properties/type"
},
"oasRef": "#/components/schemas/AssistantToolsCode/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type > (member) 0"
]
},
"(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`",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "file_search"
}
],
"oasRef": "#/components/schemas/AssistantToolsFileSearchTypeOnly/properties/type"
},
"oasRef": "#/components/schemas/AssistantToolsFileSearchTypeOnly/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.messages > (model) message > (schema) > (property) attachments > (items) > (property) tools > (items) > (variant) 1 > (property) type > (member) 0"
]
},
"(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.",
"key": "file_id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/MessageContentImageFileObject/properties/image_file/properties/file_id",
"deprecated": 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`.",
"key": "detail",
"optional": true,
"nullable": false,
"default": "auto",
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "auto"
},
{
"kind": "HttpTypeLiteral",
"literal": "low"
},
{
"kind": "HttpTypeLiteral",
"literal": "high"
}
],
"oasRef": "#/components/schemas/MessageContentImageFileObject/properties/image_file/properties/detail"
},
"oasRef": "#/components/schemas/MessageContentImageFileObject/properties/image_file/properties/detail",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.messages > (model) image_file > (schema) > (property) detail > (member) 0",
"(resource) beta.threads.messages > (model) image_file > (schema) > (property) detail > (member) 1",
"(resource) beta.threads.messages > (model) image_file > (schema) > (property) detail > (member) 2"
]
},
"(resource) beta.threads.messages > (model) image_file > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/MessageContentImageFileObject/properties/image_file",
"ident": "ImageFile",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "file_id"
},
{
"ident": "detail"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) image_file > (schema) > (property) file_id",
"(resource) beta.threads.messages > (model) image_file > (schema) > (property) detail"
]
},
"(resource) beta.threads.messages > (model) image_file_content_block > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "image_file"
}
},
"(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.",
"key": "url",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"constraints": {
"format": "uri"
},
"oasRef": "#/components/schemas/MessageContentImageUrlObject/properties/image_url/properties/url",
"deprecated": 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`",
"key": "detail",
"optional": true,
"nullable": false,
"default": "auto",
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "auto"
},
{
"kind": "HttpTypeLiteral",
"literal": "low"
},
{
"kind": "HttpTypeLiteral",
"literal": "high"
}
],
"oasRef": "#/components/schemas/MessageContentImageUrlObject/properties/image_url/properties/detail"
},
"oasRef": "#/components/schemas/MessageContentImageUrlObject/properties/image_url/properties/detail",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.messages > (model) image_url > (schema) > (property) detail > (member) 0",
"(resource) beta.threads.messages > (model) image_url > (schema) > (property) detail > (member) 1",
"(resource) beta.threads.messages > (model) image_url > (schema) > (property) detail > (member) 2"
]
},
"(resource) beta.threads.messages > (model) image_url > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/MessageContentImageUrlObject/properties/image_url",
"ident": "ImageURL",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "url"
},
{
"ident": "detail"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) image_url > (schema) > (property) url",
"(resource) beta.threads.messages > (model) image_url > (schema) > (property) detail"
]
},
"(resource) beta.threads.messages > (model) image_url_content_block > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "image_url"
}
},
"(resource) beta.threads.messages > (model) text > (schema) > (property) annotations": {
"kind": "HttpDeclProperty",
"key": "annotations",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeArray",
"elementType": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeReference",
"ident": "FileCitationAnnotation",
"$ref": "(resource) beta.threads.messages > (model) file_citation_annotation > (schema)"
},
{
"kind": "HttpTypeReference",
"ident": "FilePathAnnotation",
"$ref": "(resource) beta.threads.messages > (model) file_path_annotation > (schema)"
}
],
"oasRef": "#/components/schemas/MessageContentTextObject/properties/text/properties/annotations/items"
},
"oasRef": "#/components/schemas/MessageContentTextObject/properties/text/properties/annotations"
},
"oasRef": "#/components/schemas/MessageContentTextObject/properties/text/properties/annotations",
"deprecated": false,
"schemaType": "array",
"childrenParentSchema": "union",
"children": [
"(resource) beta.threads.messages > (model) text > (schema) > (property) annotations > (items) > (variant) 0",
"(resource) beta.threads.messages > (model) text > (schema) > (property) annotations > (items) > (variant) 1"
]
},
"(resource) beta.threads.messages > (model) text > (schema) > (property) value": {
"kind": "HttpDeclProperty",
"docstring": "The data that makes up the text.",
"key": "value",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/MessageContentTextObject/properties/text/properties/value",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.messages > (model) text > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/MessageContentTextObject/properties/text",
"ident": "Text",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "annotations"
},
{
"ident": "value"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) text > (schema) > (property) annotations",
"(resource) beta.threads.messages > (model) text > (schema) > (property) value"
]
},
"(resource) beta.threads.messages > (model) text_content_block > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "text"
}
},
"(resource) beta.threads.messages > (model) refusal_content_block > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "refusal"
}
},
"(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "code_interpreter"
}
},
"(resource) beta.threads.messages > (model) message > (schema) > (property) attachments > (items) > (property) tools > (items) > (variant) 1 > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "file_search"
}
},
"(resource) beta.threads.messages > (model) image_file > (schema) > (property) detail > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "auto"
}
},
"(resource) beta.threads.messages > (model) image_file > (schema) > (property) detail > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "low"
}
},
"(resource) beta.threads.messages > (model) image_file > (schema) > (property) detail > (member) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "high"
}
},
"(resource) beta.threads.messages > (model) image_url > (schema) > (property) detail > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "auto"
}
},
"(resource) beta.threads.messages > (model) image_url > (schema) > (property) detail > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "low"
}
},
"(resource) beta.threads.messages > (model) image_url > (schema) > (property) detail > (member) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "high"
}
},
"(resource) beta.threads.messages > (model) text > (schema) > (property) annotations > (items) > (variant) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "FileCitationAnnotation",
"$ref": "(resource) beta.threads.messages > (model) file_citation_annotation > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) end_index",
"(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) file_citation",
"(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) start_index",
"(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) text",
"(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) type"
]
},
"(resource) beta.threads.messages > (model) text > (schema) > (property) annotations > (items) > (variant) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "FilePathAnnotation",
"$ref": "(resource) beta.threads.messages > (model) file_path_annotation > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) end_index",
"(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) file_path",
"(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) start_index",
"(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) text",
"(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) type"
]
},
"(resource) beta.threads.messages > (model) file_citation_annotation > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject",
"ident": "FileCitationAnnotation",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "end_index"
},
{
"ident": "file_citation"
},
{
"ident": "start_index"
},
{
"ident": "text"
},
{
"ident": "type"
}
]
},
"docstring": "A citation within the message that points to a specific quote from a specific File associated with the assistant or the message. Generated when the assistant uses the \"file_search\" tool to search files.",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) end_index",
"(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) file_citation",
"(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) start_index",
"(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) text",
"(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) type"
]
},
"(resource) beta.threads.messages > (model) file_path_annotation > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/MessageContentTextAnnotationsFilePathObject",
"ident": "FilePathAnnotation",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "end_index"
},
{
"ident": "file_path"
},
{
"ident": "start_index"
},
{
"ident": "text"
},
{
"ident": "type"
}
]
},
"docstring": "A URL for the file that's generated when the assistant used the `code_interpreter` tool to generate a file.",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) end_index",
"(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) file_path",
"(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) start_index",
"(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) text",
"(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) type"
]
},
"(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) end_index": {
"kind": "HttpDeclProperty",
"key": "end_index",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"minimum": 0
},
"oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject/properties/end_index",
"deprecated": false,
"schemaType": "integer",
"children": []
},
"(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) file_citation": {
"kind": "HttpDeclProperty",
"key": "file_citation",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "file_id"
}
]
},
"oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject/properties/file_citation",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) file_citation > (property) file_id"
]
},
"(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) start_index": {
"kind": "HttpDeclProperty",
"key": "start_index",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"minimum": 0
},
"oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject/properties/start_index",
"deprecated": false,
"schemaType": "integer",
"children": []
},
"(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) text": {
"kind": "HttpDeclProperty",
"docstring": "The text in the message content that needs to be replaced.",
"key": "text",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject/properties/text",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "Always `file_citation`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "file_citation"
}
],
"oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject/properties/type"
},
"oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) type > (member) 0"
]
},
"(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) end_index": {
"kind": "HttpDeclProperty",
"key": "end_index",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"minimum": 0
},
"oasRef": "#/components/schemas/MessageContentTextAnnotationsFilePathObject/properties/end_index",
"deprecated": false,
"schemaType": "integer",
"children": []
},
"(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) file_path": {
"kind": "HttpDeclProperty",
"key": "file_path",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "file_id"
}
]
},
"oasRef": "#/components/schemas/MessageContentTextAnnotationsFilePathObject/properties/file_path",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) file_path > (property) file_id"
]
},
"(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) start_index": {
"kind": "HttpDeclProperty",
"key": "start_index",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"minimum": 0
},
"oasRef": "#/components/schemas/MessageContentTextAnnotationsFilePathObject/properties/start_index",
"deprecated": 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.",
"key": "text",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/MessageContentTextAnnotationsFilePathObject/properties/text",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "Always `file_path`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "file_path"
}
],
"oasRef": "#/components/schemas/MessageContentTextAnnotationsFilePathObject/properties/type"
},
"oasRef": "#/components/schemas/MessageContentTextAnnotationsFilePathObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) type > (member) 0"
]
},
"(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.",
"key": "file_id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject/properties/file_citation/properties/file_id",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "file_citation"
}
},
"(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.",
"key": "file_id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/MessageContentTextAnnotationsFilePathObject/properties/file_path/properties/file_id",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "file_path"
}
}
}
Example
{}
event
Occurs when a message moves to an in_progress state.
Schema
Schema name: (resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 19
{
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 19": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/MessageStreamEvent/oneOf/1",
"ident": "UnionMember19",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "data"
},
{
"ident": "event"
}
]
},
"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",
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 19 > (property) event"
]
},
"(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).",
"key": "data",
"optional": false,
"nullable": false,
"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",
"modelImplicit": false,
"modelPath": "(resource) beta.threads.messages > (model) message",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) message > (schema) > (property) id",
"(resource) beta.threads.messages > (model) message > (schema) > (property) assistant_id",
"(resource) beta.threads.messages > (model) message > (schema) > (property) attachments",
"(resource) beta.threads.messages > (model) message > (schema) > (property) completed_at",
"(resource) beta.threads.messages > (model) message > (schema) > (property) content",
"(resource) beta.threads.messages > (model) message > (schema) > (property) created_at",
"(resource) beta.threads.messages > (model) message > (schema) > (property) incomplete_at",
"(resource) beta.threads.messages > (model) message > (schema) > (property) incomplete_details",
"(resource) beta.threads.messages > (model) message > (schema) > (property) metadata",
"(resource) beta.threads.messages > (model) message > (schema) > (property) object",
"(resource) beta.threads.messages > (model) message > (schema) > (property) role",
"(resource) beta.threads.messages > (model) message > (schema) > (property) run_id",
"(resource) beta.threads.messages > (model) message > (schema) > (property) status",
"(resource) beta.threads.messages > (model) message > (schema) > (property) thread_id"
]
},
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 19 > (property) event": {
"kind": "HttpDeclProperty",
"key": "event",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"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,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 19 > (property) event > (member) 0"
]
},
"(resource) beta.threads.messages > (model) message > (schema) > (property) id": {
"kind": "HttpDeclProperty",
"docstring": "The identifier, which can be referenced in API endpoints.",
"key": "id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/MessageObject/properties/id",
"deprecated": 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.",
"key": "assistant_id",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/MessageObject/properties/assistant_id",
"deprecated": false,
"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.",
"key": "attachments",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeArray",
"elementType": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "file_id"
},
{
"ident": "tools"
}
]
},
"oasRef": "#/components/schemas/MessageObject/properties/attachments"
},
"oasRef": "#/components/schemas/MessageObject/properties/attachments",
"deprecated": false,
"schemaType": "array",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) message > (schema) > (property) attachments > (items) > (property) file_id",
"(resource) beta.threads.messages > (model) message > (schema) > (property) attachments > (items) > (property) tools"
]
},
"(resource) beta.threads.messages > (model) message > (schema) > (property) completed_at": {
"kind": "HttpDeclProperty",
"docstring": "The Unix timestamp (in seconds) for when the message was completed.",
"key": "completed_at",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/MessageObject/properties/completed_at",
"deprecated": false,
"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.",
"key": "content",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeArray",
"elementType": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeReference",
"ident": "ImageFileContentBlock",
"$ref": "(resource) beta.threads.messages > (model) image_file_content_block > (schema)"
},
{
"kind": "HttpTypeReference",
"ident": "ImageURLContentBlock",
"$ref": "(resource) beta.threads.messages > (model) image_url_content_block > (schema)"
},
{
"kind": "HttpTypeReference",
"ident": "TextContentBlock",
"$ref": "(resource) beta.threads.messages > (model) text_content_block > (schema)"
},
{
"kind": "HttpTypeReference",
"ident": "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,
"schemaType": "array",
"childrenParentSchema": "union",
"children": [
"(resource) beta.threads.messages > (model) message > (schema) > (property) content > (items) > (variant) 0",
"(resource) beta.threads.messages > (model) message > (schema) > (property) content > (items) > (variant) 1",
"(resource) beta.threads.messages > (model) message > (schema) > (property) content > (items) > (variant) 2",
"(resource) beta.threads.messages > (model) message > (schema) > (property) content > (items) > (variant) 3"
]
},
"(resource) beta.threads.messages > (model) message > (schema) > (property) created_at": {
"kind": "HttpDeclProperty",
"docstring": "The Unix timestamp (in seconds) for when the message was created.",
"key": "created_at",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/MessageObject/properties/created_at",
"deprecated": 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.",
"key": "incomplete_at",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/MessageObject/properties/incomplete_at",
"deprecated": false,
"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.",
"key": "incomplete_details",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "reason"
}
]
},
"oasRef": "#/components/schemas/MessageObject/properties/incomplete_details",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) message > (schema) > (property) incomplete_details > (property) reason"
]
},
"(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",
"key": "metadata",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeReference",
"ident": "Metadata",
"$ref": "(resource) $shared > (model) metadata > (schema)"
},
"oasRef": "#/components/schemas/MessageObject/properties/metadata",
"deprecated": false,
"schemaType": "map",
"modelImplicit": false,
"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`.",
"key": "object",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "thread.message"
}
],
"oasRef": "#/components/schemas/MessageObject/properties/object"
},
"oasRef": "#/components/schemas/MessageObject/properties/object",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.messages > (model) message > (schema) > (property) object > (member) 0"
]
},
"(resource) beta.threads.messages > (model) message > (schema) > (property) role": {
"kind": "HttpDeclProperty",
"docstring": "The entity that produced the message. One of `user` or `assistant`.",
"key": "role",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "user"
},
{
"kind": "HttpTypeLiteral",
"literal": "assistant"
}
],
"oasRef": "#/components/schemas/MessageObject/properties/role"
},
"oasRef": "#/components/schemas/MessageObject/properties/role",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.messages > (model) message > (schema) > (property) role > (member) 0",
"(resource) beta.threads.messages > (model) message > (schema) > (property) role > (member) 1"
]
},
"(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.",
"key": "run_id",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/MessageObject/properties/run_id",
"deprecated": false,
"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`.",
"key": "status",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "in_progress"
},
{
"kind": "HttpTypeLiteral",
"literal": "incomplete"
},
{
"kind": "HttpTypeLiteral",
"literal": "completed"
}
],
"oasRef": "#/components/schemas/MessageObject/properties/status"
},
"oasRef": "#/components/schemas/MessageObject/properties/status",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.messages > (model) message > (schema) > (property) status > (member) 0",
"(resource) beta.threads.messages > (model) message > (schema) > (property) status > (member) 1",
"(resource) beta.threads.messages > (model) message > (schema) > (property) status > (member) 2"
]
},
"(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.",
"key": "thread_id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/MessageObject/properties/thread_id",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.messages > (model) message > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/MessageObject",
"ident": "Message",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "id"
},
{
"ident": "assistant_id"
},
{
"ident": "attachments"
},
{
"ident": "completed_at"
},
{
"ident": "content"
},
{
"ident": "created_at"
},
{
"ident": "incomplete_at"
},
{
"ident": "incomplete_details"
},
{
"ident": "metadata"
},
{
"ident": "object"
},
{
"ident": "role"
},
{
"ident": "run_id"
},
{
"ident": "status"
},
{
"ident": "thread_id"
}
]
},
"docstring": "Represents a message within a [thread](/docs/api-reference/threads).",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) message > (schema) > (property) id",
"(resource) beta.threads.messages > (model) message > (schema) > (property) assistant_id",
"(resource) beta.threads.messages > (model) message > (schema) > (property) attachments",
"(resource) beta.threads.messages > (model) message > (schema) > (property) completed_at",
"(resource) beta.threads.messages > (model) message > (schema) > (property) content",
"(resource) beta.threads.messages > (model) message > (schema) > (property) created_at",
"(resource) beta.threads.messages > (model) message > (schema) > (property) incomplete_at",
"(resource) beta.threads.messages > (model) message > (schema) > (property) incomplete_details",
"(resource) beta.threads.messages > (model) message > (schema) > (property) metadata",
"(resource) beta.threads.messages > (model) message > (schema) > (property) object",
"(resource) beta.threads.messages > (model) message > (schema) > (property) role",
"(resource) beta.threads.messages > (model) message > (schema) > (property) run_id",
"(resource) beta.threads.messages > (model) message > (schema) > (property) status",
"(resource) beta.threads.messages > (model) message > (schema) > (property) thread_id"
]
},
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 19 > (property) event > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "thread.message.in_progress"
}
},
"(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.",
"key": "file_id",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/MessageObject/properties/attachments/anyOf/0/items/properties/file_id",
"deprecated": 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.",
"key": "tools",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeArray",
"elementType": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeReference",
"ident": "CodeInterpreterTool",
"$ref": "(resource) beta.assistants > (model) code_interpreter_tool > (schema)"
},
{
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
}
]
}
],
"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,
"schemaType": "array",
"childrenParentSchema": "union",
"children": [
"(resource) beta.threads.messages > (model) message > (schema) > (property) attachments > (items) > (property) tools > (items) > (variant) 0",
"(resource) beta.threads.messages > (model) message > (schema) > (property) attachments > (items) > (property) tools > (items) > (variant) 1"
]
},
"(resource) beta.threads.messages > (model) message > (schema) > (property) content > (items) > (variant) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "ImageFileContentBlock",
"$ref": "(resource) beta.threads.messages > (model) image_file_content_block > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) image_file_content_block > (schema) > (property) image_file",
"(resource) beta.threads.messages > (model) image_file_content_block > (schema) > (property) type"
]
},
"(resource) beta.threads.messages > (model) message > (schema) > (property) content > (items) > (variant) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "ImageURLContentBlock",
"$ref": "(resource) beta.threads.messages > (model) image_url_content_block > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) image_url_content_block > (schema) > (property) image_url",
"(resource) beta.threads.messages > (model) image_url_content_block > (schema) > (property) type"
]
},
"(resource) beta.threads.messages > (model) message > (schema) > (property) content > (items) > (variant) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "TextContentBlock",
"$ref": "(resource) beta.threads.messages > (model) text_content_block > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) text_content_block > (schema) > (property) text",
"(resource) beta.threads.messages > (model) text_content_block > (schema) > (property) type"
]
},
"(resource) beta.threads.messages > (model) message > (schema) > (property) content > (items) > (variant) 3": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "RefusalContentBlock",
"$ref": "(resource) beta.threads.messages > (model) refusal_content_block > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) refusal_content_block > (schema) > (property) refusal",
"(resource) beta.threads.messages > (model) refusal_content_block > (schema) > (property) type"
]
},
"(resource) beta.threads.messages > (model) image_file_content_block > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/MessageContentImageFileObject",
"ident": "ImageFileContentBlock",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "image_file"
},
{
"ident": "type"
}
]
},
"docstring": "References an image [File](/docs/api-reference/files) in the content of a message.",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) image_file_content_block > (schema) > (property) image_file",
"(resource) beta.threads.messages > (model) image_file_content_block > (schema) > (property) type"
]
},
"(resource) beta.threads.messages > (model) image_url_content_block > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/MessageContentImageUrlObject",
"ident": "ImageURLContentBlock",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "image_url"
},
{
"ident": "type"
}
]
},
"docstring": "References an image URL in the content of a message.",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) image_url_content_block > (schema) > (property) image_url",
"(resource) beta.threads.messages > (model) image_url_content_block > (schema) > (property) type"
]
},
"(resource) beta.threads.messages > (model) text_content_block > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/MessageContentTextObject",
"ident": "TextContentBlock",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "text"
},
{
"ident": "type"
}
]
},
"docstring": "The text content that is part of a message.",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) text_content_block > (schema) > (property) text",
"(resource) beta.threads.messages > (model) text_content_block > (schema) > (property) type"
]
},
"(resource) beta.threads.messages > (model) refusal_content_block > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/MessageContentRefusalObject",
"ident": "RefusalContentBlock",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "refusal"
},
{
"ident": "type"
}
]
},
"docstring": "The refusal content generated by the assistant.",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) refusal_content_block > (schema) > (property) refusal",
"(resource) beta.threads.messages > (model) refusal_content_block > (schema) > (property) type"
]
},
"(resource) beta.threads.messages > (model) message > (schema) > (property) incomplete_details > (property) reason": {
"kind": "HttpDeclProperty",
"docstring": "The reason the message is incomplete.",
"key": "reason",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "content_filter"
},
{
"kind": "HttpTypeLiteral",
"literal": "max_tokens"
},
{
"kind": "HttpTypeLiteral",
"literal": "run_cancelled"
},
{
"kind": "HttpTypeLiteral",
"literal": "run_expired"
},
{
"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,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.messages > (model) message > (schema) > (property) incomplete_details > (property) reason > (member) 0",
"(resource) beta.threads.messages > (model) message > (schema) > (property) incomplete_details > (property) reason > (member) 1",
"(resource) beta.threads.messages > (model) message > (schema) > (property) incomplete_details > (property) reason > (member) 2",
"(resource) beta.threads.messages > (model) message > (schema) > (property) incomplete_details > (property) reason > (member) 3",
"(resource) beta.threads.messages > (model) message > (schema) > (property) incomplete_details > (property) reason > (member) 4"
]
},
"(resource) $shared > (model) metadata > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/Metadata",
"ident": "Metadata",
"type": {
"kind": "HttpTypeReference",
"ident": "Record",
"typeParameters": [
{
"kind": "HttpTypeString"
},
{
"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": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "thread.message"
}
},
"(resource) beta.threads.messages > (model) message > (schema) > (property) role > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "user"
}
},
"(resource) beta.threads.messages > (model) message > (schema) > (property) role > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "assistant"
}
},
"(resource) beta.threads.messages > (model) message > (schema) > (property) status > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "in_progress"
}
},
"(resource) beta.threads.messages > (model) message > (schema) > (property) status > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "incomplete"
}
},
"(resource) beta.threads.messages > (model) message > (schema) > (property) status > (member) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "completed"
}
},
"(resource) beta.threads.messages > (model) message > (schema) > (property) attachments > (items) > (property) tools > (items) > (variant) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "CodeInterpreterTool",
"$ref": "(resource) beta.assistants > (model) code_interpreter_tool > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type"
]
},
"(resource) beta.threads.messages > (model) message > (schema) > (property) attachments > (items) > (property) tools > (items) > (variant) 1": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/MessageObject/properties/attachments/anyOf/0/items/properties/tools/items/oneOf/1",
"ident": "FileSearchTool",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) message > (schema) > (property) attachments > (items) > (property) tools > (items) > (variant) 1 > (property) type"
]
},
"(resource) beta.assistants > (model) code_interpreter_tool > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/AssistantToolsCode",
"ident": "CodeInterpreterTool",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type"
]
},
"(resource) beta.threads.messages > (model) image_file_content_block > (schema) > (property) image_file": {
"kind": "HttpDeclProperty",
"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",
"modelImplicit": false,
"modelPath": "(resource) beta.threads.messages > (model) image_file",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) image_file > (schema) > (property) file_id",
"(resource) beta.threads.messages > (model) image_file > (schema) > (property) detail"
]
},
"(resource) beta.threads.messages > (model) image_file_content_block > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "Always `image_file`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "image_file"
}
],
"oasRef": "#/components/schemas/MessageContentImageFileObject/properties/type"
},
"oasRef": "#/components/schemas/MessageContentImageFileObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.messages > (model) image_file_content_block > (schema) > (property) type > (member) 0"
]
},
"(resource) beta.threads.messages > (model) image_url_content_block > (schema) > (property) image_url": {
"kind": "HttpDeclProperty",
"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",
"modelImplicit": false,
"modelPath": "(resource) beta.threads.messages > (model) image_url",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) image_url > (schema) > (property) url",
"(resource) beta.threads.messages > (model) image_url > (schema) > (property) detail"
]
},
"(resource) beta.threads.messages > (model) image_url_content_block > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The type of the content part.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "image_url"
}
],
"oasRef": "#/components/schemas/MessageContentImageUrlObject/properties/type"
},
"oasRef": "#/components/schemas/MessageContentImageUrlObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.messages > (model) image_url_content_block > (schema) > (property) type > (member) 0"
]
},
"(resource) beta.threads.messages > (model) text_content_block > (schema) > (property) text": {
"kind": "HttpDeclProperty",
"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",
"modelImplicit": false,
"modelPath": "(resource) beta.threads.messages > (model) text",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) text > (schema) > (property) annotations",
"(resource) beta.threads.messages > (model) text > (schema) > (property) value"
]
},
"(resource) beta.threads.messages > (model) text_content_block > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "Always `text`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "text"
}
],
"oasRef": "#/components/schemas/MessageContentTextObject/properties/type"
},
"oasRef": "#/components/schemas/MessageContentTextObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.messages > (model) text_content_block > (schema) > (property) type > (member) 0"
]
},
"(resource) beta.threads.messages > (model) refusal_content_block > (schema) > (property) refusal": {
"kind": "HttpDeclProperty",
"key": "refusal",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/MessageContentRefusalObject/properties/refusal",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.messages > (model) refusal_content_block > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "Always `refusal`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "refusal"
}
],
"oasRef": "#/components/schemas/MessageContentRefusalObject/properties/type"
},
"oasRef": "#/components/schemas/MessageContentRefusalObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.messages > (model) refusal_content_block > (schema) > (property) type > (member) 0"
]
},
"(resource) beta.threads.messages > (model) message > (schema) > (property) incomplete_details > (property) reason > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "content_filter"
}
},
"(resource) beta.threads.messages > (model) message > (schema) > (property) incomplete_details > (property) reason > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "max_tokens"
}
},
"(resource) beta.threads.messages > (model) message > (schema) > (property) incomplete_details > (property) reason > (member) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "run_cancelled"
}
},
"(resource) beta.threads.messages > (model) message > (schema) > (property) incomplete_details > (property) reason > (member) 3": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "run_expired"
}
},
"(resource) beta.threads.messages > (model) message > (schema) > (property) incomplete_details > (property) reason > (member) 4": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "run_failed"
}
},
"(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The type of tool being defined: `code_interpreter`",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "code_interpreter"
}
],
"oasRef": "#/components/schemas/AssistantToolsCode/properties/type"
},
"oasRef": "#/components/schemas/AssistantToolsCode/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type > (member) 0"
]
},
"(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`",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "file_search"
}
],
"oasRef": "#/components/schemas/AssistantToolsFileSearchTypeOnly/properties/type"
},
"oasRef": "#/components/schemas/AssistantToolsFileSearchTypeOnly/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.messages > (model) message > (schema) > (property) attachments > (items) > (property) tools > (items) > (variant) 1 > (property) type > (member) 0"
]
},
"(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.",
"key": "file_id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/MessageContentImageFileObject/properties/image_file/properties/file_id",
"deprecated": 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`.",
"key": "detail",
"optional": true,
"nullable": false,
"default": "auto",
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "auto"
},
{
"kind": "HttpTypeLiteral",
"literal": "low"
},
{
"kind": "HttpTypeLiteral",
"literal": "high"
}
],
"oasRef": "#/components/schemas/MessageContentImageFileObject/properties/image_file/properties/detail"
},
"oasRef": "#/components/schemas/MessageContentImageFileObject/properties/image_file/properties/detail",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.messages > (model) image_file > (schema) > (property) detail > (member) 0",
"(resource) beta.threads.messages > (model) image_file > (schema) > (property) detail > (member) 1",
"(resource) beta.threads.messages > (model) image_file > (schema) > (property) detail > (member) 2"
]
},
"(resource) beta.threads.messages > (model) image_file > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/MessageContentImageFileObject/properties/image_file",
"ident": "ImageFile",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "file_id"
},
{
"ident": "detail"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) image_file > (schema) > (property) file_id",
"(resource) beta.threads.messages > (model) image_file > (schema) > (property) detail"
]
},
"(resource) beta.threads.messages > (model) image_file_content_block > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "image_file"
}
},
"(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.",
"key": "url",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"constraints": {
"format": "uri"
},
"oasRef": "#/components/schemas/MessageContentImageUrlObject/properties/image_url/properties/url",
"deprecated": 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`",
"key": "detail",
"optional": true,
"nullable": false,
"default": "auto",
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "auto"
},
{
"kind": "HttpTypeLiteral",
"literal": "low"
},
{
"kind": "HttpTypeLiteral",
"literal": "high"
}
],
"oasRef": "#/components/schemas/MessageContentImageUrlObject/properties/image_url/properties/detail"
},
"oasRef": "#/components/schemas/MessageContentImageUrlObject/properties/image_url/properties/detail",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.messages > (model) image_url > (schema) > (property) detail > (member) 0",
"(resource) beta.threads.messages > (model) image_url > (schema) > (property) detail > (member) 1",
"(resource) beta.threads.messages > (model) image_url > (schema) > (property) detail > (member) 2"
]
},
"(resource) beta.threads.messages > (model) image_url > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/MessageContentImageUrlObject/properties/image_url",
"ident": "ImageURL",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "url"
},
{
"ident": "detail"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) image_url > (schema) > (property) url",
"(resource) beta.threads.messages > (model) image_url > (schema) > (property) detail"
]
},
"(resource) beta.threads.messages > (model) image_url_content_block > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "image_url"
}
},
"(resource) beta.threads.messages > (model) text > (schema) > (property) annotations": {
"kind": "HttpDeclProperty",
"key": "annotations",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeArray",
"elementType": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeReference",
"ident": "FileCitationAnnotation",
"$ref": "(resource) beta.threads.messages > (model) file_citation_annotation > (schema)"
},
{
"kind": "HttpTypeReference",
"ident": "FilePathAnnotation",
"$ref": "(resource) beta.threads.messages > (model) file_path_annotation > (schema)"
}
],
"oasRef": "#/components/schemas/MessageContentTextObject/properties/text/properties/annotations/items"
},
"oasRef": "#/components/schemas/MessageContentTextObject/properties/text/properties/annotations"
},
"oasRef": "#/components/schemas/MessageContentTextObject/properties/text/properties/annotations",
"deprecated": false,
"schemaType": "array",
"childrenParentSchema": "union",
"children": [
"(resource) beta.threads.messages > (model) text > (schema) > (property) annotations > (items) > (variant) 0",
"(resource) beta.threads.messages > (model) text > (schema) > (property) annotations > (items) > (variant) 1"
]
},
"(resource) beta.threads.messages > (model) text > (schema) > (property) value": {
"kind": "HttpDeclProperty",
"docstring": "The data that makes up the text.",
"key": "value",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/MessageContentTextObject/properties/text/properties/value",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.messages > (model) text > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/MessageContentTextObject/properties/text",
"ident": "Text",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "annotations"
},
{
"ident": "value"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) text > (schema) > (property) annotations",
"(resource) beta.threads.messages > (model) text > (schema) > (property) value"
]
},
"(resource) beta.threads.messages > (model) text_content_block > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "text"
}
},
"(resource) beta.threads.messages > (model) refusal_content_block > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "refusal"
}
},
"(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "code_interpreter"
}
},
"(resource) beta.threads.messages > (model) message > (schema) > (property) attachments > (items) > (property) tools > (items) > (variant) 1 > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "file_search"
}
},
"(resource) beta.threads.messages > (model) image_file > (schema) > (property) detail > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "auto"
}
},
"(resource) beta.threads.messages > (model) image_file > (schema) > (property) detail > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "low"
}
},
"(resource) beta.threads.messages > (model) image_file > (schema) > (property) detail > (member) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "high"
}
},
"(resource) beta.threads.messages > (model) image_url > (schema) > (property) detail > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "auto"
}
},
"(resource) beta.threads.messages > (model) image_url > (schema) > (property) detail > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "low"
}
},
"(resource) beta.threads.messages > (model) image_url > (schema) > (property) detail > (member) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "high"
}
},
"(resource) beta.threads.messages > (model) text > (schema) > (property) annotations > (items) > (variant) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "FileCitationAnnotation",
"$ref": "(resource) beta.threads.messages > (model) file_citation_annotation > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) end_index",
"(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) file_citation",
"(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) start_index",
"(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) text",
"(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) type"
]
},
"(resource) beta.threads.messages > (model) text > (schema) > (property) annotations > (items) > (variant) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "FilePathAnnotation",
"$ref": "(resource) beta.threads.messages > (model) file_path_annotation > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) end_index",
"(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) file_path",
"(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) start_index",
"(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) text",
"(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) type"
]
},
"(resource) beta.threads.messages > (model) file_citation_annotation > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject",
"ident": "FileCitationAnnotation",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "end_index"
},
{
"ident": "file_citation"
},
{
"ident": "start_index"
},
{
"ident": "text"
},
{
"ident": "type"
}
]
},
"docstring": "A citation within the message that points to a specific quote from a specific File associated with the assistant or the message. Generated when the assistant uses the \"file_search\" tool to search files.",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) end_index",
"(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) file_citation",
"(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) start_index",
"(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) text",
"(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) type"
]
},
"(resource) beta.threads.messages > (model) file_path_annotation > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/MessageContentTextAnnotationsFilePathObject",
"ident": "FilePathAnnotation",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "end_index"
},
{
"ident": "file_path"
},
{
"ident": "start_index"
},
{
"ident": "text"
},
{
"ident": "type"
}
]
},
"docstring": "A URL for the file that's generated when the assistant used the `code_interpreter` tool to generate a file.",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) end_index",
"(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) file_path",
"(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) start_index",
"(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) text",
"(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) type"
]
},
"(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) end_index": {
"kind": "HttpDeclProperty",
"key": "end_index",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"minimum": 0
},
"oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject/properties/end_index",
"deprecated": false,
"schemaType": "integer",
"children": []
},
"(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) file_citation": {
"kind": "HttpDeclProperty",
"key": "file_citation",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "file_id"
}
]
},
"oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject/properties/file_citation",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) file_citation > (property) file_id"
]
},
"(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) start_index": {
"kind": "HttpDeclProperty",
"key": "start_index",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"minimum": 0
},
"oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject/properties/start_index",
"deprecated": false,
"schemaType": "integer",
"children": []
},
"(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) text": {
"kind": "HttpDeclProperty",
"docstring": "The text in the message content that needs to be replaced.",
"key": "text",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject/properties/text",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "Always `file_citation`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "file_citation"
}
],
"oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject/properties/type"
},
"oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) type > (member) 0"
]
},
"(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) end_index": {
"kind": "HttpDeclProperty",
"key": "end_index",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"minimum": 0
},
"oasRef": "#/components/schemas/MessageContentTextAnnotationsFilePathObject/properties/end_index",
"deprecated": false,
"schemaType": "integer",
"children": []
},
"(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) file_path": {
"kind": "HttpDeclProperty",
"key": "file_path",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "file_id"
}
]
},
"oasRef": "#/components/schemas/MessageContentTextAnnotationsFilePathObject/properties/file_path",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) file_path > (property) file_id"
]
},
"(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) start_index": {
"kind": "HttpDeclProperty",
"key": "start_index",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"minimum": 0
},
"oasRef": "#/components/schemas/MessageContentTextAnnotationsFilePathObject/properties/start_index",
"deprecated": 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.",
"key": "text",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/MessageContentTextAnnotationsFilePathObject/properties/text",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "Always `file_path`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "file_path"
}
],
"oasRef": "#/components/schemas/MessageContentTextAnnotationsFilePathObject/properties/type"
},
"oasRef": "#/components/schemas/MessageContentTextAnnotationsFilePathObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) type > (member) 0"
]
},
"(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.",
"key": "file_id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject/properties/file_citation/properties/file_id",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "file_citation"
}
},
"(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.",
"key": "file_id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/MessageContentTextAnnotationsFilePathObject/properties/file_path/properties/file_id",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "file_path"
}
}
}
Example
{}
event
Occurs when parts of a Message are being streamed.
Schema
Schema name: (resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 20
{
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 20": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/MessageStreamEvent/oneOf/2",
"ident": "UnionMember20",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "data"
},
{
"ident": "event"
}
]
},
"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",
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 20 > (property) event"
]
},
"(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",
"key": "data",
"optional": false,
"nullable": false,
"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",
"modelImplicit": false,
"modelPath": "(resource) beta.threads.messages > (model) message_delta_event",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) message_delta_event > (schema) > (property) id",
"(resource) beta.threads.messages > (model) message_delta_event > (schema) > (property) delta",
"(resource) beta.threads.messages > (model) message_delta_event > (schema) > (property) object"
]
},
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 20 > (property) event": {
"kind": "HttpDeclProperty",
"key": "event",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"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,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 20 > (property) event > (member) 0"
]
},
"(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.",
"key": "id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/MessageDeltaObject/properties/id",
"deprecated": 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.",
"key": "delta",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeReference",
"ident": "MessageDelta",
"$ref": "(resource) beta.threads.messages > (model) message_delta > (schema)"
},
"oasRef": "#/components/schemas/MessageDeltaObject/properties/delta",
"deprecated": false,
"schemaType": "object",
"modelImplicit": false,
"modelPath": "(resource) beta.threads.messages > (model) message_delta",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) message_delta > (schema) > (property) content",
"(resource) beta.threads.messages > (model) message_delta > (schema) > (property) role"
]
},
"(resource) beta.threads.messages > (model) message_delta_event > (schema) > (property) object": {
"kind": "HttpDeclProperty",
"docstring": "The object type, which is always `thread.message.delta`.",
"key": "object",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "thread.message.delta"
}
],
"oasRef": "#/components/schemas/MessageDeltaObject/properties/object"
},
"oasRef": "#/components/schemas/MessageDeltaObject/properties/object",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.messages > (model) message_delta_event > (schema) > (property) object > (member) 0"
]
},
"(resource) beta.threads.messages > (model) message_delta_event > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/MessageDeltaObject",
"ident": "MessageDeltaEvent",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "id"
},
{
"ident": "delta"
},
{
"ident": "object"
}
]
},
"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",
"(resource) beta.threads.messages > (model) message_delta_event > (schema) > (property) delta",
"(resource) beta.threads.messages > (model) message_delta_event > (schema) > (property) object"
]
},
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 20 > (property) event > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "thread.message.delta"
}
},
"(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.",
"key": "content",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeArray",
"elementType": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeReference",
"ident": "ImageFileDeltaBlock",
"$ref": "(resource) beta.threads.messages > (model) image_file_delta_block > (schema)"
},
{
"kind": "HttpTypeReference",
"ident": "TextDeltaBlock",
"$ref": "(resource) beta.threads.messages > (model) text_delta_block > (schema)"
},
{
"kind": "HttpTypeReference",
"ident": "RefusalDeltaBlock",
"$ref": "(resource) beta.threads.messages > (model) refusal_delta_block > (schema)"
},
{
"kind": "HttpTypeReference",
"ident": "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,
"schemaType": "array",
"childrenParentSchema": "union",
"children": [
"(resource) beta.threads.messages > (model) message_delta > (schema) > (property) content > (items) > (variant) 0",
"(resource) beta.threads.messages > (model) message_delta > (schema) > (property) content > (items) > (variant) 1",
"(resource) beta.threads.messages > (model) message_delta > (schema) > (property) content > (items) > (variant) 2",
"(resource) beta.threads.messages > (model) message_delta > (schema) > (property) content > (items) > (variant) 3"
]
},
"(resource) beta.threads.messages > (model) message_delta > (schema) > (property) role": {
"kind": "HttpDeclProperty",
"docstring": "The entity that produced the message. One of `user` or `assistant`.",
"key": "role",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "user"
},
{
"kind": "HttpTypeLiteral",
"literal": "assistant"
}
],
"oasRef": "#/components/schemas/MessageDeltaObject/properties/delta/properties/role"
},
"oasRef": "#/components/schemas/MessageDeltaObject/properties/delta/properties/role",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.messages > (model) message_delta > (schema) > (property) role > (member) 0",
"(resource) beta.threads.messages > (model) message_delta > (schema) > (property) role > (member) 1"
]
},
"(resource) beta.threads.messages > (model) message_delta > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/MessageDeltaObject/properties/delta",
"ident": "MessageDelta",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "content"
},
{
"ident": "role"
}
]
},
"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",
"(resource) beta.threads.messages > (model) message_delta > (schema) > (property) role"
]
},
"(resource) beta.threads.messages > (model) message_delta_event > (schema) > (property) object > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "thread.message.delta"
}
},
"(resource) beta.threads.messages > (model) message_delta > (schema) > (property) content > (items) > (variant) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "ImageFileDeltaBlock",
"$ref": "(resource) beta.threads.messages > (model) image_file_delta_block > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) image_file_delta_block > (schema) > (property) index",
"(resource) beta.threads.messages > (model) image_file_delta_block > (schema) > (property) type",
"(resource) beta.threads.messages > (model) image_file_delta_block > (schema) > (property) image_file"
]
},
"(resource) beta.threads.messages > (model) message_delta > (schema) > (property) content > (items) > (variant) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "TextDeltaBlock",
"$ref": "(resource) beta.threads.messages > (model) text_delta_block > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) text_delta_block > (schema) > (property) index",
"(resource) beta.threads.messages > (model) text_delta_block > (schema) > (property) type",
"(resource) beta.threads.messages > (model) text_delta_block > (schema) > (property) text"
]
},
"(resource) beta.threads.messages > (model) message_delta > (schema) > (property) content > (items) > (variant) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "RefusalDeltaBlock",
"$ref": "(resource) beta.threads.messages > (model) refusal_delta_block > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) refusal_delta_block > (schema) > (property) index",
"(resource) beta.threads.messages > (model) refusal_delta_block > (schema) > (property) type",
"(resource) beta.threads.messages > (model) refusal_delta_block > (schema) > (property) refusal"
]
},
"(resource) beta.threads.messages > (model) message_delta > (schema) > (property) content > (items) > (variant) 3": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "ImageURLDeltaBlock",
"$ref": "(resource) beta.threads.messages > (model) image_url_delta_block > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) image_url_delta_block > (schema) > (property) index",
"(resource) beta.threads.messages > (model) image_url_delta_block > (schema) > (property) type",
"(resource) beta.threads.messages > (model) image_url_delta_block > (schema) > (property) image_url"
]
},
"(resource) beta.threads.messages > (model) image_file_delta_block > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/MessageDeltaContentImageFileObject",
"ident": "ImageFileDeltaBlock",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "index"
},
{
"ident": "type"
},
{
"ident": "image_file"
}
]
},
"docstring": "References an image [File](/docs/api-reference/files) in the content of a message.",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) image_file_delta_block > (schema) > (property) index",
"(resource) beta.threads.messages > (model) image_file_delta_block > (schema) > (property) type",
"(resource) beta.threads.messages > (model) image_file_delta_block > (schema) > (property) image_file"
]
},
"(resource) beta.threads.messages > (model) text_delta_block > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/MessageDeltaContentTextObject",
"ident": "TextDeltaBlock",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "index"
},
{
"ident": "type"
},
{
"ident": "text"
}
]
},
"docstring": "The text content that is part of a message.",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) text_delta_block > (schema) > (property) index",
"(resource) beta.threads.messages > (model) text_delta_block > (schema) > (property) type",
"(resource) beta.threads.messages > (model) text_delta_block > (schema) > (property) text"
]
},
"(resource) beta.threads.messages > (model) refusal_delta_block > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/MessageDeltaContentRefusalObject",
"ident": "RefusalDeltaBlock",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "index"
},
{
"ident": "type"
},
{
"ident": "refusal"
}
]
},
"docstring": "The refusal content that is part of a message.",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) refusal_delta_block > (schema) > (property) index",
"(resource) beta.threads.messages > (model) refusal_delta_block > (schema) > (property) type",
"(resource) beta.threads.messages > (model) refusal_delta_block > (schema) > (property) refusal"
]
},
"(resource) beta.threads.messages > (model) image_url_delta_block > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/MessageDeltaContentImageUrlObject",
"ident": "ImageURLDeltaBlock",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "index"
},
{
"ident": "type"
},
{
"ident": "image_url"
}
]
},
"docstring": "References an image URL in the content of a message.",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) image_url_delta_block > (schema) > (property) index",
"(resource) beta.threads.messages > (model) image_url_delta_block > (schema) > (property) type",
"(resource) beta.threads.messages > (model) image_url_delta_block > (schema) > (property) image_url"
]
},
"(resource) beta.threads.messages > (model) message_delta > (schema) > (property) role > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "user"
}
},
"(resource) beta.threads.messages > (model) message_delta > (schema) > (property) role > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "assistant"
}
},
"(resource) beta.threads.messages > (model) image_file_delta_block > (schema) > (property) index": {
"kind": "HttpDeclProperty",
"docstring": "The index of the content part in the message.",
"key": "index",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"oasRef": "#/components/schemas/MessageDeltaContentImageFileObject/properties/index",
"deprecated": false,
"schemaType": "integer",
"children": []
},
"(resource) beta.threads.messages > (model) image_file_delta_block > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "Always `image_file`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "image_file"
}
],
"oasRef": "#/components/schemas/MessageDeltaContentImageFileObject/properties/type"
},
"oasRef": "#/components/schemas/MessageDeltaContentImageFileObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.messages > (model) image_file_delta_block > (schema) > (property) type > (member) 0"
]
},
"(resource) beta.threads.messages > (model) image_file_delta_block > (schema) > (property) image_file": {
"kind": "HttpDeclProperty",
"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",
"modelImplicit": false,
"modelPath": "(resource) beta.threads.messages > (model) image_file_delta",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) image_file_delta > (schema) > (property) detail",
"(resource) beta.threads.messages > (model) image_file_delta > (schema) > (property) file_id"
]
},
"(resource) beta.threads.messages > (model) text_delta_block > (schema) > (property) index": {
"kind": "HttpDeclProperty",
"docstring": "The index of the content part in the message.",
"key": "index",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"oasRef": "#/components/schemas/MessageDeltaContentTextObject/properties/index",
"deprecated": false,
"schemaType": "integer",
"children": []
},
"(resource) beta.threads.messages > (model) text_delta_block > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "Always `text`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "text"
}
],
"oasRef": "#/components/schemas/MessageDeltaContentTextObject/properties/type"
},
"oasRef": "#/components/schemas/MessageDeltaContentTextObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.messages > (model) text_delta_block > (schema) > (property) type > (member) 0"
]
},
"(resource) beta.threads.messages > (model) text_delta_block > (schema) > (property) text": {
"kind": "HttpDeclProperty",
"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",
"modelImplicit": false,
"modelPath": "(resource) beta.threads.messages > (model) text_delta",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) text_delta > (schema) > (property) annotations",
"(resource) beta.threads.messages > (model) text_delta > (schema) > (property) value"
]
},
"(resource) beta.threads.messages > (model) refusal_delta_block > (schema) > (property) index": {
"kind": "HttpDeclProperty",
"docstring": "The index of the refusal part in the message.",
"key": "index",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"oasRef": "#/components/schemas/MessageDeltaContentRefusalObject/properties/index",
"deprecated": false,
"schemaType": "integer",
"children": []
},
"(resource) beta.threads.messages > (model) refusal_delta_block > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "Always `refusal`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "refusal"
}
],
"oasRef": "#/components/schemas/MessageDeltaContentRefusalObject/properties/type"
},
"oasRef": "#/components/schemas/MessageDeltaContentRefusalObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.messages > (model) refusal_delta_block > (schema) > (property) type > (member) 0"
]
},
"(resource) beta.threads.messages > (model) refusal_delta_block > (schema) > (property) refusal": {
"kind": "HttpDeclProperty",
"key": "refusal",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/MessageDeltaContentRefusalObject/properties/refusal",
"deprecated": 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.",
"key": "index",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"oasRef": "#/components/schemas/MessageDeltaContentImageUrlObject/properties/index",
"deprecated": false,
"schemaType": "integer",
"children": []
},
"(resource) beta.threads.messages > (model) image_url_delta_block > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "Always `image_url`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "image_url"
}
],
"oasRef": "#/components/schemas/MessageDeltaContentImageUrlObject/properties/type"
},
"oasRef": "#/components/schemas/MessageDeltaContentImageUrlObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.messages > (model) image_url_delta_block > (schema) > (property) type > (member) 0"
]
},
"(resource) beta.threads.messages > (model) image_url_delta_block > (schema) > (property) image_url": {
"kind": "HttpDeclProperty",
"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",
"modelImplicit": false,
"modelPath": "(resource) beta.threads.messages > (model) image_url_delta",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) image_url_delta > (schema) > (property) detail",
"(resource) beta.threads.messages > (model) image_url_delta > (schema) > (property) url"
]
},
"(resource) beta.threads.messages > (model) image_file_delta_block > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "image_file"
}
},
"(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`.",
"key": "detail",
"optional": true,
"nullable": false,
"default": "auto",
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "auto"
},
{
"kind": "HttpTypeLiteral",
"literal": "low"
},
{
"kind": "HttpTypeLiteral",
"literal": "high"
}
],
"oasRef": "#/components/schemas/MessageDeltaContentImageFileObject/properties/image_file/properties/detail"
},
"oasRef": "#/components/schemas/MessageDeltaContentImageFileObject/properties/image_file/properties/detail",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.messages > (model) image_file_delta > (schema) > (property) detail > (member) 0",
"(resource) beta.threads.messages > (model) image_file_delta > (schema) > (property) detail > (member) 1",
"(resource) beta.threads.messages > (model) image_file_delta > (schema) > (property) detail > (member) 2"
]
},
"(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.",
"key": "file_id",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/MessageDeltaContentImageFileObject/properties/image_file/properties/file_id",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.messages > (model) image_file_delta > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/MessageDeltaContentImageFileObject/properties/image_file",
"ident": "ImageFileDelta",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "detail"
},
{
"ident": "file_id"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) image_file_delta > (schema) > (property) detail",
"(resource) beta.threads.messages > (model) image_file_delta > (schema) > (property) file_id"
]
},
"(resource) beta.threads.messages > (model) text_delta_block > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "text"
}
},
"(resource) beta.threads.messages > (model) text_delta > (schema) > (property) annotations": {
"kind": "HttpDeclProperty",
"key": "annotations",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeArray",
"elementType": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeReference",
"ident": "FileCitationDeltaAnnotation",
"$ref": "(resource) beta.threads.messages > (model) file_citation_delta_annotation > (schema)"
},
{
"kind": "HttpTypeReference",
"ident": "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,
"schemaType": "array",
"childrenParentSchema": "union",
"children": [
"(resource) beta.threads.messages > (model) text_delta > (schema) > (property) annotations > (items) > (variant) 0",
"(resource) beta.threads.messages > (model) text_delta > (schema) > (property) annotations > (items) > (variant) 1"
]
},
"(resource) beta.threads.messages > (model) text_delta > (schema) > (property) value": {
"kind": "HttpDeclProperty",
"docstring": "The data that makes up the text.",
"key": "value",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/MessageDeltaContentTextObject/properties/text/properties/value",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.messages > (model) text_delta > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/MessageDeltaContentTextObject/properties/text",
"ident": "TextDelta",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "annotations"
},
{
"ident": "value"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) text_delta > (schema) > (property) annotations",
"(resource) beta.threads.messages > (model) text_delta > (schema) > (property) value"
]
},
"(resource) beta.threads.messages > (model) refusal_delta_block > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "refusal"
}
},
"(resource) beta.threads.messages > (model) image_url_delta_block > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "image_url"
}
},
"(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`.",
"key": "detail",
"optional": true,
"nullable": false,
"default": "auto",
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "auto"
},
{
"kind": "HttpTypeLiteral",
"literal": "low"
},
{
"kind": "HttpTypeLiteral",
"literal": "high"
}
],
"oasRef": "#/components/schemas/MessageDeltaContentImageUrlObject/properties/image_url/properties/detail"
},
"oasRef": "#/components/schemas/MessageDeltaContentImageUrlObject/properties/image_url/properties/detail",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.messages > (model) image_url_delta > (schema) > (property) detail > (member) 0",
"(resource) beta.threads.messages > (model) image_url_delta > (schema) > (property) detail > (member) 1",
"(resource) beta.threads.messages > (model) image_url_delta > (schema) > (property) detail > (member) 2"
]
},
"(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.",
"key": "url",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"constraints": {
"format": "uri"
},
"oasRef": "#/components/schemas/MessageDeltaContentImageUrlObject/properties/image_url/properties/url",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.messages > (model) image_url_delta > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/MessageDeltaContentImageUrlObject/properties/image_url",
"ident": "ImageURLDelta",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "detail"
},
{
"ident": "url"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) image_url_delta > (schema) > (property) detail",
"(resource) beta.threads.messages > (model) image_url_delta > (schema) > (property) url"
]
},
"(resource) beta.threads.messages > (model) image_file_delta > (schema) > (property) detail > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "auto"
}
},
"(resource) beta.threads.messages > (model) image_file_delta > (schema) > (property) detail > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "low"
}
},
"(resource) beta.threads.messages > (model) image_file_delta > (schema) > (property) detail > (member) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "high"
}
},
"(resource) beta.threads.messages > (model) text_delta > (schema) > (property) annotations > (items) > (variant) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "FileCitationDeltaAnnotation",
"$ref": "(resource) beta.threads.messages > (model) file_citation_delta_annotation > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) file_citation_delta_annotation > (schema) > (property) index",
"(resource) beta.threads.messages > (model) file_citation_delta_annotation > (schema) > (property) type",
"(resource) beta.threads.messages > (model) file_citation_delta_annotation > (schema) > (property) end_index",
"(resource) beta.threads.messages > (model) file_citation_delta_annotation > (schema) > (property) file_citation",
"(resource) beta.threads.messages > (model) file_citation_delta_annotation > (schema) > (property) start_index",
"(resource) beta.threads.messages > (model) file_citation_delta_annotation > (schema) > (property) text"
]
},
"(resource) beta.threads.messages > (model) text_delta > (schema) > (property) annotations > (items) > (variant) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "FilePathDeltaAnnotation",
"$ref": "(resource) beta.threads.messages > (model) file_path_delta_annotation > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) file_path_delta_annotation > (schema) > (property) index",
"(resource) beta.threads.messages > (model) file_path_delta_annotation > (schema) > (property) type",
"(resource) beta.threads.messages > (model) file_path_delta_annotation > (schema) > (property) end_index",
"(resource) beta.threads.messages > (model) file_path_delta_annotation > (schema) > (property) file_path",
"(resource) beta.threads.messages > (model) file_path_delta_annotation > (schema) > (property) start_index",
"(resource) beta.threads.messages > (model) file_path_delta_annotation > (schema) > (property) text"
]
},
"(resource) beta.threads.messages > (model) file_citation_delta_annotation > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/MessageDeltaContentTextAnnotationsFileCitationObject",
"ident": "FileCitationDeltaAnnotation",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "index"
},
{
"ident": "type"
},
{
"ident": "end_index"
},
{
"ident": "file_citation"
},
{
"ident": "start_index"
},
{
"ident": "text"
}
]
},
"docstring": "A citation within the message that points to a specific quote from a specific File associated with the assistant or the message. Generated when the assistant uses the \"file_search\" tool to search files.",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) file_citation_delta_annotation > (schema) > (property) index",
"(resource) beta.threads.messages > (model) file_citation_delta_annotation > (schema) > (property) type",
"(resource) beta.threads.messages > (model) file_citation_delta_annotation > (schema) > (property) end_index",
"(resource) beta.threads.messages > (model) file_citation_delta_annotation > (schema) > (property) file_citation",
"(resource) beta.threads.messages > (model) file_citation_delta_annotation > (schema) > (property) start_index",
"(resource) beta.threads.messages > (model) file_citation_delta_annotation > (schema) > (property) text"
]
},
"(resource) beta.threads.messages > (model) file_path_delta_annotation > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/MessageDeltaContentTextAnnotationsFilePathObject",
"ident": "FilePathDeltaAnnotation",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "index"
},
{
"ident": "type"
},
{
"ident": "end_index"
},
{
"ident": "file_path"
},
{
"ident": "start_index"
},
{
"ident": "text"
}
]
},
"docstring": "A URL for the file that's generated when the assistant used the `code_interpreter` tool to generate a file.",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) file_path_delta_annotation > (schema) > (property) index",
"(resource) beta.threads.messages > (model) file_path_delta_annotation > (schema) > (property) type",
"(resource) beta.threads.messages > (model) file_path_delta_annotation > (schema) > (property) end_index",
"(resource) beta.threads.messages > (model) file_path_delta_annotation > (schema) > (property) file_path",
"(resource) beta.threads.messages > (model) file_path_delta_annotation > (schema) > (property) start_index",
"(resource) beta.threads.messages > (model) file_path_delta_annotation > (schema) > (property) text"
]
},
"(resource) beta.threads.messages > (model) image_url_delta > (schema) > (property) detail > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "auto"
}
},
"(resource) beta.threads.messages > (model) image_url_delta > (schema) > (property) detail > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "low"
}
},
"(resource) beta.threads.messages > (model) image_url_delta > (schema) > (property) detail > (member) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "high"
}
},
"(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.",
"key": "index",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"oasRef": "#/components/schemas/MessageDeltaContentTextAnnotationsFileCitationObject/properties/index",
"deprecated": false,
"schemaType": "integer",
"children": []
},
"(resource) beta.threads.messages > (model) file_citation_delta_annotation > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "Always `file_citation`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "file_citation"
}
],
"oasRef": "#/components/schemas/MessageDeltaContentTextAnnotationsFileCitationObject/properties/type"
},
"oasRef": "#/components/schemas/MessageDeltaContentTextAnnotationsFileCitationObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.messages > (model) file_citation_delta_annotation > (schema) > (property) type > (member) 0"
]
},
"(resource) beta.threads.messages > (model) file_citation_delta_annotation > (schema) > (property) end_index": {
"kind": "HttpDeclProperty",
"key": "end_index",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"minimum": 0
},
"oasRef": "#/components/schemas/MessageDeltaContentTextAnnotationsFileCitationObject/properties/end_index",
"deprecated": false,
"schemaType": "integer",
"children": []
},
"(resource) beta.threads.messages > (model) file_citation_delta_annotation > (schema) > (property) file_citation": {
"kind": "HttpDeclProperty",
"key": "file_citation",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "file_id"
},
{
"ident": "quote"
}
]
},
"oasRef": "#/components/schemas/MessageDeltaContentTextAnnotationsFileCitationObject/properties/file_citation",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) file_citation_delta_annotation > (schema) > (property) file_citation > (property) file_id",
"(resource) beta.threads.messages > (model) file_citation_delta_annotation > (schema) > (property) file_citation > (property) quote"
]
},
"(resource) beta.threads.messages > (model) file_citation_delta_annotation > (schema) > (property) start_index": {
"kind": "HttpDeclProperty",
"key": "start_index",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"minimum": 0
},
"oasRef": "#/components/schemas/MessageDeltaContentTextAnnotationsFileCitationObject/properties/start_index",
"deprecated": 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.",
"key": "text",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/MessageDeltaContentTextAnnotationsFileCitationObject/properties/text",
"deprecated": 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.",
"key": "index",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"oasRef": "#/components/schemas/MessageDeltaContentTextAnnotationsFilePathObject/properties/index",
"deprecated": false,
"schemaType": "integer",
"children": []
},
"(resource) beta.threads.messages > (model) file_path_delta_annotation > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "Always `file_path`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "file_path"
}
],
"oasRef": "#/components/schemas/MessageDeltaContentTextAnnotationsFilePathObject/properties/type"
},
"oasRef": "#/components/schemas/MessageDeltaContentTextAnnotationsFilePathObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.messages > (model) file_path_delta_annotation > (schema) > (property) type > (member) 0"
]
},
"(resource) beta.threads.messages > (model) file_path_delta_annotation > (schema) > (property) end_index": {
"kind": "HttpDeclProperty",
"key": "end_index",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"minimum": 0
},
"oasRef": "#/components/schemas/MessageDeltaContentTextAnnotationsFilePathObject/properties/end_index",
"deprecated": false,
"schemaType": "integer",
"children": []
},
"(resource) beta.threads.messages > (model) file_path_delta_annotation > (schema) > (property) file_path": {
"kind": "HttpDeclProperty",
"key": "file_path",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "file_id"
}
]
},
"oasRef": "#/components/schemas/MessageDeltaContentTextAnnotationsFilePathObject/properties/file_path",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) file_path_delta_annotation > (schema) > (property) file_path > (property) file_id"
]
},
"(resource) beta.threads.messages > (model) file_path_delta_annotation > (schema) > (property) start_index": {
"kind": "HttpDeclProperty",
"key": "start_index",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"minimum": 0
},
"oasRef": "#/components/schemas/MessageDeltaContentTextAnnotationsFilePathObject/properties/start_index",
"deprecated": 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.",
"key": "text",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/MessageDeltaContentTextAnnotationsFilePathObject/properties/text",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.messages > (model) file_citation_delta_annotation > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "file_citation"
}
},
"(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.",
"key": "file_id",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/MessageDeltaContentTextAnnotationsFileCitationObject/properties/file_citation/properties/file_id",
"deprecated": 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.",
"key": "quote",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/MessageDeltaContentTextAnnotationsFileCitationObject/properties/file_citation/properties/quote",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.messages > (model) file_path_delta_annotation > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "file_path"
}
},
"(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.",
"key": "file_id",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/MessageDeltaContentTextAnnotationsFilePathObject/properties/file_path/properties/file_id",
"deprecated": false,
"schemaType": "string",
"children": []
}
}
Example
{}
event
Occurs when a message is completed.
Schema
Schema name: (resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 21
{
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 21": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/MessageStreamEvent/oneOf/3",
"ident": "UnionMember21",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "data"
},
{
"ident": "event"
}
]
},
"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",
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 21 > (property) event"
]
},
"(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).",
"key": "data",
"optional": false,
"nullable": false,
"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",
"modelImplicit": false,
"modelPath": "(resource) beta.threads.messages > (model) message",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) message > (schema) > (property) id",
"(resource) beta.threads.messages > (model) message > (schema) > (property) assistant_id",
"(resource) beta.threads.messages > (model) message > (schema) > (property) attachments",
"(resource) beta.threads.messages > (model) message > (schema) > (property) completed_at",
"(resource) beta.threads.messages > (model) message > (schema) > (property) content",
"(resource) beta.threads.messages > (model) message > (schema) > (property) created_at",
"(resource) beta.threads.messages > (model) message > (schema) > (property) incomplete_at",
"(resource) beta.threads.messages > (model) message > (schema) > (property) incomplete_details",
"(resource) beta.threads.messages > (model) message > (schema) > (property) metadata",
"(resource) beta.threads.messages > (model) message > (schema) > (property) object",
"(resource) beta.threads.messages > (model) message > (schema) > (property) role",
"(resource) beta.threads.messages > (model) message > (schema) > (property) run_id",
"(resource) beta.threads.messages > (model) message > (schema) > (property) status",
"(resource) beta.threads.messages > (model) message > (schema) > (property) thread_id"
]
},
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 21 > (property) event": {
"kind": "HttpDeclProperty",
"key": "event",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"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,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 21 > (property) event > (member) 0"
]
},
"(resource) beta.threads.messages > (model) message > (schema) > (property) id": {
"kind": "HttpDeclProperty",
"docstring": "The identifier, which can be referenced in API endpoints.",
"key": "id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/MessageObject/properties/id",
"deprecated": 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.",
"key": "assistant_id",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/MessageObject/properties/assistant_id",
"deprecated": false,
"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.",
"key": "attachments",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeArray",
"elementType": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "file_id"
},
{
"ident": "tools"
}
]
},
"oasRef": "#/components/schemas/MessageObject/properties/attachments"
},
"oasRef": "#/components/schemas/MessageObject/properties/attachments",
"deprecated": false,
"schemaType": "array",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) message > (schema) > (property) attachments > (items) > (property) file_id",
"(resource) beta.threads.messages > (model) message > (schema) > (property) attachments > (items) > (property) tools"
]
},
"(resource) beta.threads.messages > (model) message > (schema) > (property) completed_at": {
"kind": "HttpDeclProperty",
"docstring": "The Unix timestamp (in seconds) for when the message was completed.",
"key": "completed_at",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/MessageObject/properties/completed_at",
"deprecated": false,
"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.",
"key": "content",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeArray",
"elementType": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeReference",
"ident": "ImageFileContentBlock",
"$ref": "(resource) beta.threads.messages > (model) image_file_content_block > (schema)"
},
{
"kind": "HttpTypeReference",
"ident": "ImageURLContentBlock",
"$ref": "(resource) beta.threads.messages > (model) image_url_content_block > (schema)"
},
{
"kind": "HttpTypeReference",
"ident": "TextContentBlock",
"$ref": "(resource) beta.threads.messages > (model) text_content_block > (schema)"
},
{
"kind": "HttpTypeReference",
"ident": "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,
"schemaType": "array",
"childrenParentSchema": "union",
"children": [
"(resource) beta.threads.messages > (model) message > (schema) > (property) content > (items) > (variant) 0",
"(resource) beta.threads.messages > (model) message > (schema) > (property) content > (items) > (variant) 1",
"(resource) beta.threads.messages > (model) message > (schema) > (property) content > (items) > (variant) 2",
"(resource) beta.threads.messages > (model) message > (schema) > (property) content > (items) > (variant) 3"
]
},
"(resource) beta.threads.messages > (model) message > (schema) > (property) created_at": {
"kind": "HttpDeclProperty",
"docstring": "The Unix timestamp (in seconds) for when the message was created.",
"key": "created_at",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/MessageObject/properties/created_at",
"deprecated": 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.",
"key": "incomplete_at",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/MessageObject/properties/incomplete_at",
"deprecated": false,
"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.",
"key": "incomplete_details",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "reason"
}
]
},
"oasRef": "#/components/schemas/MessageObject/properties/incomplete_details",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) message > (schema) > (property) incomplete_details > (property) reason"
]
},
"(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",
"key": "metadata",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeReference",
"ident": "Metadata",
"$ref": "(resource) $shared > (model) metadata > (schema)"
},
"oasRef": "#/components/schemas/MessageObject/properties/metadata",
"deprecated": false,
"schemaType": "map",
"modelImplicit": false,
"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`.",
"key": "object",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "thread.message"
}
],
"oasRef": "#/components/schemas/MessageObject/properties/object"
},
"oasRef": "#/components/schemas/MessageObject/properties/object",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.messages > (model) message > (schema) > (property) object > (member) 0"
]
},
"(resource) beta.threads.messages > (model) message > (schema) > (property) role": {
"kind": "HttpDeclProperty",
"docstring": "The entity that produced the message. One of `user` or `assistant`.",
"key": "role",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "user"
},
{
"kind": "HttpTypeLiteral",
"literal": "assistant"
}
],
"oasRef": "#/components/schemas/MessageObject/properties/role"
},
"oasRef": "#/components/schemas/MessageObject/properties/role",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.messages > (model) message > (schema) > (property) role > (member) 0",
"(resource) beta.threads.messages > (model) message > (schema) > (property) role > (member) 1"
]
},
"(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.",
"key": "run_id",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/MessageObject/properties/run_id",
"deprecated": false,
"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`.",
"key": "status",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "in_progress"
},
{
"kind": "HttpTypeLiteral",
"literal": "incomplete"
},
{
"kind": "HttpTypeLiteral",
"literal": "completed"
}
],
"oasRef": "#/components/schemas/MessageObject/properties/status"
},
"oasRef": "#/components/schemas/MessageObject/properties/status",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.messages > (model) message > (schema) > (property) status > (member) 0",
"(resource) beta.threads.messages > (model) message > (schema) > (property) status > (member) 1",
"(resource) beta.threads.messages > (model) message > (schema) > (property) status > (member) 2"
]
},
"(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.",
"key": "thread_id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/MessageObject/properties/thread_id",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.messages > (model) message > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/MessageObject",
"ident": "Message",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "id"
},
{
"ident": "assistant_id"
},
{
"ident": "attachments"
},
{
"ident": "completed_at"
},
{
"ident": "content"
},
{
"ident": "created_at"
},
{
"ident": "incomplete_at"
},
{
"ident": "incomplete_details"
},
{
"ident": "metadata"
},
{
"ident": "object"
},
{
"ident": "role"
},
{
"ident": "run_id"
},
{
"ident": "status"
},
{
"ident": "thread_id"
}
]
},
"docstring": "Represents a message within a [thread](/docs/api-reference/threads).",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) message > (schema) > (property) id",
"(resource) beta.threads.messages > (model) message > (schema) > (property) assistant_id",
"(resource) beta.threads.messages > (model) message > (schema) > (property) attachments",
"(resource) beta.threads.messages > (model) message > (schema) > (property) completed_at",
"(resource) beta.threads.messages > (model) message > (schema) > (property) content",
"(resource) beta.threads.messages > (model) message > (schema) > (property) created_at",
"(resource) beta.threads.messages > (model) message > (schema) > (property) incomplete_at",
"(resource) beta.threads.messages > (model) message > (schema) > (property) incomplete_details",
"(resource) beta.threads.messages > (model) message > (schema) > (property) metadata",
"(resource) beta.threads.messages > (model) message > (schema) > (property) object",
"(resource) beta.threads.messages > (model) message > (schema) > (property) role",
"(resource) beta.threads.messages > (model) message > (schema) > (property) run_id",
"(resource) beta.threads.messages > (model) message > (schema) > (property) status",
"(resource) beta.threads.messages > (model) message > (schema) > (property) thread_id"
]
},
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 21 > (property) event > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "thread.message.completed"
}
},
"(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.",
"key": "file_id",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/MessageObject/properties/attachments/anyOf/0/items/properties/file_id",
"deprecated": 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.",
"key": "tools",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeArray",
"elementType": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeReference",
"ident": "CodeInterpreterTool",
"$ref": "(resource) beta.assistants > (model) code_interpreter_tool > (schema)"
},
{
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
}
]
}
],
"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,
"schemaType": "array",
"childrenParentSchema": "union",
"children": [
"(resource) beta.threads.messages > (model) message > (schema) > (property) attachments > (items) > (property) tools > (items) > (variant) 0",
"(resource) beta.threads.messages > (model) message > (schema) > (property) attachments > (items) > (property) tools > (items) > (variant) 1"
]
},
"(resource) beta.threads.messages > (model) message > (schema) > (property) content > (items) > (variant) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "ImageFileContentBlock",
"$ref": "(resource) beta.threads.messages > (model) image_file_content_block > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) image_file_content_block > (schema) > (property) image_file",
"(resource) beta.threads.messages > (model) image_file_content_block > (schema) > (property) type"
]
},
"(resource) beta.threads.messages > (model) message > (schema) > (property) content > (items) > (variant) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "ImageURLContentBlock",
"$ref": "(resource) beta.threads.messages > (model) image_url_content_block > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) image_url_content_block > (schema) > (property) image_url",
"(resource) beta.threads.messages > (model) image_url_content_block > (schema) > (property) type"
]
},
"(resource) beta.threads.messages > (model) message > (schema) > (property) content > (items) > (variant) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "TextContentBlock",
"$ref": "(resource) beta.threads.messages > (model) text_content_block > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) text_content_block > (schema) > (property) text",
"(resource) beta.threads.messages > (model) text_content_block > (schema) > (property) type"
]
},
"(resource) beta.threads.messages > (model) message > (schema) > (property) content > (items) > (variant) 3": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "RefusalContentBlock",
"$ref": "(resource) beta.threads.messages > (model) refusal_content_block > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) refusal_content_block > (schema) > (property) refusal",
"(resource) beta.threads.messages > (model) refusal_content_block > (schema) > (property) type"
]
},
"(resource) beta.threads.messages > (model) image_file_content_block > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/MessageContentImageFileObject",
"ident": "ImageFileContentBlock",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "image_file"
},
{
"ident": "type"
}
]
},
"docstring": "References an image [File](/docs/api-reference/files) in the content of a message.",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) image_file_content_block > (schema) > (property) image_file",
"(resource) beta.threads.messages > (model) image_file_content_block > (schema) > (property) type"
]
},
"(resource) beta.threads.messages > (model) image_url_content_block > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/MessageContentImageUrlObject",
"ident": "ImageURLContentBlock",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "image_url"
},
{
"ident": "type"
}
]
},
"docstring": "References an image URL in the content of a message.",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) image_url_content_block > (schema) > (property) image_url",
"(resource) beta.threads.messages > (model) image_url_content_block > (schema) > (property) type"
]
},
"(resource) beta.threads.messages > (model) text_content_block > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/MessageContentTextObject",
"ident": "TextContentBlock",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "text"
},
{
"ident": "type"
}
]
},
"docstring": "The text content that is part of a message.",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) text_content_block > (schema) > (property) text",
"(resource) beta.threads.messages > (model) text_content_block > (schema) > (property) type"
]
},
"(resource) beta.threads.messages > (model) refusal_content_block > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/MessageContentRefusalObject",
"ident": "RefusalContentBlock",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "refusal"
},
{
"ident": "type"
}
]
},
"docstring": "The refusal content generated by the assistant.",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) refusal_content_block > (schema) > (property) refusal",
"(resource) beta.threads.messages > (model) refusal_content_block > (schema) > (property) type"
]
},
"(resource) beta.threads.messages > (model) message > (schema) > (property) incomplete_details > (property) reason": {
"kind": "HttpDeclProperty",
"docstring": "The reason the message is incomplete.",
"key": "reason",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "content_filter"
},
{
"kind": "HttpTypeLiteral",
"literal": "max_tokens"
},
{
"kind": "HttpTypeLiteral",
"literal": "run_cancelled"
},
{
"kind": "HttpTypeLiteral",
"literal": "run_expired"
},
{
"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,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.messages > (model) message > (schema) > (property) incomplete_details > (property) reason > (member) 0",
"(resource) beta.threads.messages > (model) message > (schema) > (property) incomplete_details > (property) reason > (member) 1",
"(resource) beta.threads.messages > (model) message > (schema) > (property) incomplete_details > (property) reason > (member) 2",
"(resource) beta.threads.messages > (model) message > (schema) > (property) incomplete_details > (property) reason > (member) 3",
"(resource) beta.threads.messages > (model) message > (schema) > (property) incomplete_details > (property) reason > (member) 4"
]
},
"(resource) $shared > (model) metadata > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/Metadata",
"ident": "Metadata",
"type": {
"kind": "HttpTypeReference",
"ident": "Record",
"typeParameters": [
{
"kind": "HttpTypeString"
},
{
"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": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "thread.message"
}
},
"(resource) beta.threads.messages > (model) message > (schema) > (property) role > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "user"
}
},
"(resource) beta.threads.messages > (model) message > (schema) > (property) role > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "assistant"
}
},
"(resource) beta.threads.messages > (model) message > (schema) > (property) status > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "in_progress"
}
},
"(resource) beta.threads.messages > (model) message > (schema) > (property) status > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "incomplete"
}
},
"(resource) beta.threads.messages > (model) message > (schema) > (property) status > (member) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "completed"
}
},
"(resource) beta.threads.messages > (model) message > (schema) > (property) attachments > (items) > (property) tools > (items) > (variant) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "CodeInterpreterTool",
"$ref": "(resource) beta.assistants > (model) code_interpreter_tool > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type"
]
},
"(resource) beta.threads.messages > (model) message > (schema) > (property) attachments > (items) > (property) tools > (items) > (variant) 1": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/MessageObject/properties/attachments/anyOf/0/items/properties/tools/items/oneOf/1",
"ident": "FileSearchTool",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) message > (schema) > (property) attachments > (items) > (property) tools > (items) > (variant) 1 > (property) type"
]
},
"(resource) beta.assistants > (model) code_interpreter_tool > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/AssistantToolsCode",
"ident": "CodeInterpreterTool",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type"
]
},
"(resource) beta.threads.messages > (model) image_file_content_block > (schema) > (property) image_file": {
"kind": "HttpDeclProperty",
"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",
"modelImplicit": false,
"modelPath": "(resource) beta.threads.messages > (model) image_file",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) image_file > (schema) > (property) file_id",
"(resource) beta.threads.messages > (model) image_file > (schema) > (property) detail"
]
},
"(resource) beta.threads.messages > (model) image_file_content_block > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "Always `image_file`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "image_file"
}
],
"oasRef": "#/components/schemas/MessageContentImageFileObject/properties/type"
},
"oasRef": "#/components/schemas/MessageContentImageFileObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.messages > (model) image_file_content_block > (schema) > (property) type > (member) 0"
]
},
"(resource) beta.threads.messages > (model) image_url_content_block > (schema) > (property) image_url": {
"kind": "HttpDeclProperty",
"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",
"modelImplicit": false,
"modelPath": "(resource) beta.threads.messages > (model) image_url",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) image_url > (schema) > (property) url",
"(resource) beta.threads.messages > (model) image_url > (schema) > (property) detail"
]
},
"(resource) beta.threads.messages > (model) image_url_content_block > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The type of the content part.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "image_url"
}
],
"oasRef": "#/components/schemas/MessageContentImageUrlObject/properties/type"
},
"oasRef": "#/components/schemas/MessageContentImageUrlObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.messages > (model) image_url_content_block > (schema) > (property) type > (member) 0"
]
},
"(resource) beta.threads.messages > (model) text_content_block > (schema) > (property) text": {
"kind": "HttpDeclProperty",
"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",
"modelImplicit": false,
"modelPath": "(resource) beta.threads.messages > (model) text",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) text > (schema) > (property) annotations",
"(resource) beta.threads.messages > (model) text > (schema) > (property) value"
]
},
"(resource) beta.threads.messages > (model) text_content_block > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "Always `text`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "text"
}
],
"oasRef": "#/components/schemas/MessageContentTextObject/properties/type"
},
"oasRef": "#/components/schemas/MessageContentTextObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.messages > (model) text_content_block > (schema) > (property) type > (member) 0"
]
},
"(resource) beta.threads.messages > (model) refusal_content_block > (schema) > (property) refusal": {
"kind": "HttpDeclProperty",
"key": "refusal",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/MessageContentRefusalObject/properties/refusal",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.messages > (model) refusal_content_block > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "Always `refusal`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "refusal"
}
],
"oasRef": "#/components/schemas/MessageContentRefusalObject/properties/type"
},
"oasRef": "#/components/schemas/MessageContentRefusalObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.messages > (model) refusal_content_block > (schema) > (property) type > (member) 0"
]
},
"(resource) beta.threads.messages > (model) message > (schema) > (property) incomplete_details > (property) reason > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "content_filter"
}
},
"(resource) beta.threads.messages > (model) message > (schema) > (property) incomplete_details > (property) reason > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "max_tokens"
}
},
"(resource) beta.threads.messages > (model) message > (schema) > (property) incomplete_details > (property) reason > (member) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "run_cancelled"
}
},
"(resource) beta.threads.messages > (model) message > (schema) > (property) incomplete_details > (property) reason > (member) 3": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "run_expired"
}
},
"(resource) beta.threads.messages > (model) message > (schema) > (property) incomplete_details > (property) reason > (member) 4": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "run_failed"
}
},
"(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The type of tool being defined: `code_interpreter`",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "code_interpreter"
}
],
"oasRef": "#/components/schemas/AssistantToolsCode/properties/type"
},
"oasRef": "#/components/schemas/AssistantToolsCode/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type > (member) 0"
]
},
"(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`",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "file_search"
}
],
"oasRef": "#/components/schemas/AssistantToolsFileSearchTypeOnly/properties/type"
},
"oasRef": "#/components/schemas/AssistantToolsFileSearchTypeOnly/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.messages > (model) message > (schema) > (property) attachments > (items) > (property) tools > (items) > (variant) 1 > (property) type > (member) 0"
]
},
"(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.",
"key": "file_id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/MessageContentImageFileObject/properties/image_file/properties/file_id",
"deprecated": 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`.",
"key": "detail",
"optional": true,
"nullable": false,
"default": "auto",
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "auto"
},
{
"kind": "HttpTypeLiteral",
"literal": "low"
},
{
"kind": "HttpTypeLiteral",
"literal": "high"
}
],
"oasRef": "#/components/schemas/MessageContentImageFileObject/properties/image_file/properties/detail"
},
"oasRef": "#/components/schemas/MessageContentImageFileObject/properties/image_file/properties/detail",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.messages > (model) image_file > (schema) > (property) detail > (member) 0",
"(resource) beta.threads.messages > (model) image_file > (schema) > (property) detail > (member) 1",
"(resource) beta.threads.messages > (model) image_file > (schema) > (property) detail > (member) 2"
]
},
"(resource) beta.threads.messages > (model) image_file > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/MessageContentImageFileObject/properties/image_file",
"ident": "ImageFile",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "file_id"
},
{
"ident": "detail"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) image_file > (schema) > (property) file_id",
"(resource) beta.threads.messages > (model) image_file > (schema) > (property) detail"
]
},
"(resource) beta.threads.messages > (model) image_file_content_block > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "image_file"
}
},
"(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.",
"key": "url",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"constraints": {
"format": "uri"
},
"oasRef": "#/components/schemas/MessageContentImageUrlObject/properties/image_url/properties/url",
"deprecated": 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`",
"key": "detail",
"optional": true,
"nullable": false,
"default": "auto",
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "auto"
},
{
"kind": "HttpTypeLiteral",
"literal": "low"
},
{
"kind": "HttpTypeLiteral",
"literal": "high"
}
],
"oasRef": "#/components/schemas/MessageContentImageUrlObject/properties/image_url/properties/detail"
},
"oasRef": "#/components/schemas/MessageContentImageUrlObject/properties/image_url/properties/detail",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.messages > (model) image_url > (schema) > (property) detail > (member) 0",
"(resource) beta.threads.messages > (model) image_url > (schema) > (property) detail > (member) 1",
"(resource) beta.threads.messages > (model) image_url > (schema) > (property) detail > (member) 2"
]
},
"(resource) beta.threads.messages > (model) image_url > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/MessageContentImageUrlObject/properties/image_url",
"ident": "ImageURL",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "url"
},
{
"ident": "detail"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) image_url > (schema) > (property) url",
"(resource) beta.threads.messages > (model) image_url > (schema) > (property) detail"
]
},
"(resource) beta.threads.messages > (model) image_url_content_block > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "image_url"
}
},
"(resource) beta.threads.messages > (model) text > (schema) > (property) annotations": {
"kind": "HttpDeclProperty",
"key": "annotations",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeArray",
"elementType": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeReference",
"ident": "FileCitationAnnotation",
"$ref": "(resource) beta.threads.messages > (model) file_citation_annotation > (schema)"
},
{
"kind": "HttpTypeReference",
"ident": "FilePathAnnotation",
"$ref": "(resource) beta.threads.messages > (model) file_path_annotation > (schema)"
}
],
"oasRef": "#/components/schemas/MessageContentTextObject/properties/text/properties/annotations/items"
},
"oasRef": "#/components/schemas/MessageContentTextObject/properties/text/properties/annotations"
},
"oasRef": "#/components/schemas/MessageContentTextObject/properties/text/properties/annotations",
"deprecated": false,
"schemaType": "array",
"childrenParentSchema": "union",
"children": [
"(resource) beta.threads.messages > (model) text > (schema) > (property) annotations > (items) > (variant) 0",
"(resource) beta.threads.messages > (model) text > (schema) > (property) annotations > (items) > (variant) 1"
]
},
"(resource) beta.threads.messages > (model) text > (schema) > (property) value": {
"kind": "HttpDeclProperty",
"docstring": "The data that makes up the text.",
"key": "value",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/MessageContentTextObject/properties/text/properties/value",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.messages > (model) text > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/MessageContentTextObject/properties/text",
"ident": "Text",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "annotations"
},
{
"ident": "value"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) text > (schema) > (property) annotations",
"(resource) beta.threads.messages > (model) text > (schema) > (property) value"
]
},
"(resource) beta.threads.messages > (model) text_content_block > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "text"
}
},
"(resource) beta.threads.messages > (model) refusal_content_block > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "refusal"
}
},
"(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "code_interpreter"
}
},
"(resource) beta.threads.messages > (model) message > (schema) > (property) attachments > (items) > (property) tools > (items) > (variant) 1 > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "file_search"
}
},
"(resource) beta.threads.messages > (model) image_file > (schema) > (property) detail > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "auto"
}
},
"(resource) beta.threads.messages > (model) image_file > (schema) > (property) detail > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "low"
}
},
"(resource) beta.threads.messages > (model) image_file > (schema) > (property) detail > (member) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "high"
}
},
"(resource) beta.threads.messages > (model) image_url > (schema) > (property) detail > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "auto"
}
},
"(resource) beta.threads.messages > (model) image_url > (schema) > (property) detail > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "low"
}
},
"(resource) beta.threads.messages > (model) image_url > (schema) > (property) detail > (member) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "high"
}
},
"(resource) beta.threads.messages > (model) text > (schema) > (property) annotations > (items) > (variant) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "FileCitationAnnotation",
"$ref": "(resource) beta.threads.messages > (model) file_citation_annotation > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) end_index",
"(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) file_citation",
"(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) start_index",
"(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) text",
"(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) type"
]
},
"(resource) beta.threads.messages > (model) text > (schema) > (property) annotations > (items) > (variant) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "FilePathAnnotation",
"$ref": "(resource) beta.threads.messages > (model) file_path_annotation > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) end_index",
"(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) file_path",
"(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) start_index",
"(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) text",
"(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) type"
]
},
"(resource) beta.threads.messages > (model) file_citation_annotation > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject",
"ident": "FileCitationAnnotation",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "end_index"
},
{
"ident": "file_citation"
},
{
"ident": "start_index"
},
{
"ident": "text"
},
{
"ident": "type"
}
]
},
"docstring": "A citation within the message that points to a specific quote from a specific File associated with the assistant or the message. Generated when the assistant uses the \"file_search\" tool to search files.",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) end_index",
"(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) file_citation",
"(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) start_index",
"(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) text",
"(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) type"
]
},
"(resource) beta.threads.messages > (model) file_path_annotation > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/MessageContentTextAnnotationsFilePathObject",
"ident": "FilePathAnnotation",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "end_index"
},
{
"ident": "file_path"
},
{
"ident": "start_index"
},
{
"ident": "text"
},
{
"ident": "type"
}
]
},
"docstring": "A URL for the file that's generated when the assistant used the `code_interpreter` tool to generate a file.",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) end_index",
"(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) file_path",
"(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) start_index",
"(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) text",
"(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) type"
]
},
"(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) end_index": {
"kind": "HttpDeclProperty",
"key": "end_index",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"minimum": 0
},
"oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject/properties/end_index",
"deprecated": false,
"schemaType": "integer",
"children": []
},
"(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) file_citation": {
"kind": "HttpDeclProperty",
"key": "file_citation",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "file_id"
}
]
},
"oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject/properties/file_citation",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) file_citation > (property) file_id"
]
},
"(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) start_index": {
"kind": "HttpDeclProperty",
"key": "start_index",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"minimum": 0
},
"oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject/properties/start_index",
"deprecated": false,
"schemaType": "integer",
"children": []
},
"(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) text": {
"kind": "HttpDeclProperty",
"docstring": "The text in the message content that needs to be replaced.",
"key": "text",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject/properties/text",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "Always `file_citation`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "file_citation"
}
],
"oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject/properties/type"
},
"oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) type > (member) 0"
]
},
"(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) end_index": {
"kind": "HttpDeclProperty",
"key": "end_index",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"minimum": 0
},
"oasRef": "#/components/schemas/MessageContentTextAnnotationsFilePathObject/properties/end_index",
"deprecated": false,
"schemaType": "integer",
"children": []
},
"(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) file_path": {
"kind": "HttpDeclProperty",
"key": "file_path",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "file_id"
}
]
},
"oasRef": "#/components/schemas/MessageContentTextAnnotationsFilePathObject/properties/file_path",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) file_path > (property) file_id"
]
},
"(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) start_index": {
"kind": "HttpDeclProperty",
"key": "start_index",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"minimum": 0
},
"oasRef": "#/components/schemas/MessageContentTextAnnotationsFilePathObject/properties/start_index",
"deprecated": 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.",
"key": "text",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/MessageContentTextAnnotationsFilePathObject/properties/text",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "Always `file_path`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "file_path"
}
],
"oasRef": "#/components/schemas/MessageContentTextAnnotationsFilePathObject/properties/type"
},
"oasRef": "#/components/schemas/MessageContentTextAnnotationsFilePathObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) type > (member) 0"
]
},
"(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.",
"key": "file_id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject/properties/file_citation/properties/file_id",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "file_citation"
}
},
"(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.",
"key": "file_id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/MessageContentTextAnnotationsFilePathObject/properties/file_path/properties/file_id",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "file_path"
}
}
}
Example
{}
event
Occurs when a message ends before it is completed.
Schema
Schema name: (resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 22
{
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 22": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/MessageStreamEvent/oneOf/4",
"ident": "UnionMember22",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "data"
},
{
"ident": "event"
}
]
},
"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",
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 22 > (property) event"
]
},
"(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).",
"key": "data",
"optional": false,
"nullable": false,
"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",
"modelImplicit": false,
"modelPath": "(resource) beta.threads.messages > (model) message",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) message > (schema) > (property) id",
"(resource) beta.threads.messages > (model) message > (schema) > (property) assistant_id",
"(resource) beta.threads.messages > (model) message > (schema) > (property) attachments",
"(resource) beta.threads.messages > (model) message > (schema) > (property) completed_at",
"(resource) beta.threads.messages > (model) message > (schema) > (property) content",
"(resource) beta.threads.messages > (model) message > (schema) > (property) created_at",
"(resource) beta.threads.messages > (model) message > (schema) > (property) incomplete_at",
"(resource) beta.threads.messages > (model) message > (schema) > (property) incomplete_details",
"(resource) beta.threads.messages > (model) message > (schema) > (property) metadata",
"(resource) beta.threads.messages > (model) message > (schema) > (property) object",
"(resource) beta.threads.messages > (model) message > (schema) > (property) role",
"(resource) beta.threads.messages > (model) message > (schema) > (property) run_id",
"(resource) beta.threads.messages > (model) message > (schema) > (property) status",
"(resource) beta.threads.messages > (model) message > (schema) > (property) thread_id"
]
},
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 22 > (property) event": {
"kind": "HttpDeclProperty",
"key": "event",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"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,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 22 > (property) event > (member) 0"
]
},
"(resource) beta.threads.messages > (model) message > (schema) > (property) id": {
"kind": "HttpDeclProperty",
"docstring": "The identifier, which can be referenced in API endpoints.",
"key": "id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/MessageObject/properties/id",
"deprecated": 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.",
"key": "assistant_id",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/MessageObject/properties/assistant_id",
"deprecated": false,
"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.",
"key": "attachments",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeArray",
"elementType": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "file_id"
},
{
"ident": "tools"
}
]
},
"oasRef": "#/components/schemas/MessageObject/properties/attachments"
},
"oasRef": "#/components/schemas/MessageObject/properties/attachments",
"deprecated": false,
"schemaType": "array",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) message > (schema) > (property) attachments > (items) > (property) file_id",
"(resource) beta.threads.messages > (model) message > (schema) > (property) attachments > (items) > (property) tools"
]
},
"(resource) beta.threads.messages > (model) message > (schema) > (property) completed_at": {
"kind": "HttpDeclProperty",
"docstring": "The Unix timestamp (in seconds) for when the message was completed.",
"key": "completed_at",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/MessageObject/properties/completed_at",
"deprecated": false,
"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.",
"key": "content",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeArray",
"elementType": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeReference",
"ident": "ImageFileContentBlock",
"$ref": "(resource) beta.threads.messages > (model) image_file_content_block > (schema)"
},
{
"kind": "HttpTypeReference",
"ident": "ImageURLContentBlock",
"$ref": "(resource) beta.threads.messages > (model) image_url_content_block > (schema)"
},
{
"kind": "HttpTypeReference",
"ident": "TextContentBlock",
"$ref": "(resource) beta.threads.messages > (model) text_content_block > (schema)"
},
{
"kind": "HttpTypeReference",
"ident": "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,
"schemaType": "array",
"childrenParentSchema": "union",
"children": [
"(resource) beta.threads.messages > (model) message > (schema) > (property) content > (items) > (variant) 0",
"(resource) beta.threads.messages > (model) message > (schema) > (property) content > (items) > (variant) 1",
"(resource) beta.threads.messages > (model) message > (schema) > (property) content > (items) > (variant) 2",
"(resource) beta.threads.messages > (model) message > (schema) > (property) content > (items) > (variant) 3"
]
},
"(resource) beta.threads.messages > (model) message > (schema) > (property) created_at": {
"kind": "HttpDeclProperty",
"docstring": "The Unix timestamp (in seconds) for when the message was created.",
"key": "created_at",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/MessageObject/properties/created_at",
"deprecated": 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.",
"key": "incomplete_at",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"oasRef": "#/components/schemas/MessageObject/properties/incomplete_at",
"deprecated": false,
"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.",
"key": "incomplete_details",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "reason"
}
]
},
"oasRef": "#/components/schemas/MessageObject/properties/incomplete_details",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) message > (schema) > (property) incomplete_details > (property) reason"
]
},
"(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",
"key": "metadata",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeReference",
"ident": "Metadata",
"$ref": "(resource) $shared > (model) metadata > (schema)"
},
"oasRef": "#/components/schemas/MessageObject/properties/metadata",
"deprecated": false,
"schemaType": "map",
"modelImplicit": false,
"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`.",
"key": "object",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "thread.message"
}
],
"oasRef": "#/components/schemas/MessageObject/properties/object"
},
"oasRef": "#/components/schemas/MessageObject/properties/object",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.messages > (model) message > (schema) > (property) object > (member) 0"
]
},
"(resource) beta.threads.messages > (model) message > (schema) > (property) role": {
"kind": "HttpDeclProperty",
"docstring": "The entity that produced the message. One of `user` or `assistant`.",
"key": "role",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "user"
},
{
"kind": "HttpTypeLiteral",
"literal": "assistant"
}
],
"oasRef": "#/components/schemas/MessageObject/properties/role"
},
"oasRef": "#/components/schemas/MessageObject/properties/role",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.messages > (model) message > (schema) > (property) role > (member) 0",
"(resource) beta.threads.messages > (model) message > (schema) > (property) role > (member) 1"
]
},
"(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.",
"key": "run_id",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/MessageObject/properties/run_id",
"deprecated": false,
"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`.",
"key": "status",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "in_progress"
},
{
"kind": "HttpTypeLiteral",
"literal": "incomplete"
},
{
"kind": "HttpTypeLiteral",
"literal": "completed"
}
],
"oasRef": "#/components/schemas/MessageObject/properties/status"
},
"oasRef": "#/components/schemas/MessageObject/properties/status",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.messages > (model) message > (schema) > (property) status > (member) 0",
"(resource) beta.threads.messages > (model) message > (schema) > (property) status > (member) 1",
"(resource) beta.threads.messages > (model) message > (schema) > (property) status > (member) 2"
]
},
"(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.",
"key": "thread_id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/MessageObject/properties/thread_id",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.messages > (model) message > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/MessageObject",
"ident": "Message",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "id"
},
{
"ident": "assistant_id"
},
{
"ident": "attachments"
},
{
"ident": "completed_at"
},
{
"ident": "content"
},
{
"ident": "created_at"
},
{
"ident": "incomplete_at"
},
{
"ident": "incomplete_details"
},
{
"ident": "metadata"
},
{
"ident": "object"
},
{
"ident": "role"
},
{
"ident": "run_id"
},
{
"ident": "status"
},
{
"ident": "thread_id"
}
]
},
"docstring": "Represents a message within a [thread](/docs/api-reference/threads).",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) message > (schema) > (property) id",
"(resource) beta.threads.messages > (model) message > (schema) > (property) assistant_id",
"(resource) beta.threads.messages > (model) message > (schema) > (property) attachments",
"(resource) beta.threads.messages > (model) message > (schema) > (property) completed_at",
"(resource) beta.threads.messages > (model) message > (schema) > (property) content",
"(resource) beta.threads.messages > (model) message > (schema) > (property) created_at",
"(resource) beta.threads.messages > (model) message > (schema) > (property) incomplete_at",
"(resource) beta.threads.messages > (model) message > (schema) > (property) incomplete_details",
"(resource) beta.threads.messages > (model) message > (schema) > (property) metadata",
"(resource) beta.threads.messages > (model) message > (schema) > (property) object",
"(resource) beta.threads.messages > (model) message > (schema) > (property) role",
"(resource) beta.threads.messages > (model) message > (schema) > (property) run_id",
"(resource) beta.threads.messages > (model) message > (schema) > (property) status",
"(resource) beta.threads.messages > (model) message > (schema) > (property) thread_id"
]
},
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 22 > (property) event > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "thread.message.incomplete"
}
},
"(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.",
"key": "file_id",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/MessageObject/properties/attachments/anyOf/0/items/properties/file_id",
"deprecated": 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.",
"key": "tools",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeArray",
"elementType": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeReference",
"ident": "CodeInterpreterTool",
"$ref": "(resource) beta.assistants > (model) code_interpreter_tool > (schema)"
},
{
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
}
]
}
],
"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,
"schemaType": "array",
"childrenParentSchema": "union",
"children": [
"(resource) beta.threads.messages > (model) message > (schema) > (property) attachments > (items) > (property) tools > (items) > (variant) 0",
"(resource) beta.threads.messages > (model) message > (schema) > (property) attachments > (items) > (property) tools > (items) > (variant) 1"
]
},
"(resource) beta.threads.messages > (model) message > (schema) > (property) content > (items) > (variant) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "ImageFileContentBlock",
"$ref": "(resource) beta.threads.messages > (model) image_file_content_block > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) image_file_content_block > (schema) > (property) image_file",
"(resource) beta.threads.messages > (model) image_file_content_block > (schema) > (property) type"
]
},
"(resource) beta.threads.messages > (model) message > (schema) > (property) content > (items) > (variant) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "ImageURLContentBlock",
"$ref": "(resource) beta.threads.messages > (model) image_url_content_block > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) image_url_content_block > (schema) > (property) image_url",
"(resource) beta.threads.messages > (model) image_url_content_block > (schema) > (property) type"
]
},
"(resource) beta.threads.messages > (model) message > (schema) > (property) content > (items) > (variant) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "TextContentBlock",
"$ref": "(resource) beta.threads.messages > (model) text_content_block > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) text_content_block > (schema) > (property) text",
"(resource) beta.threads.messages > (model) text_content_block > (schema) > (property) type"
]
},
"(resource) beta.threads.messages > (model) message > (schema) > (property) content > (items) > (variant) 3": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "RefusalContentBlock",
"$ref": "(resource) beta.threads.messages > (model) refusal_content_block > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) refusal_content_block > (schema) > (property) refusal",
"(resource) beta.threads.messages > (model) refusal_content_block > (schema) > (property) type"
]
},
"(resource) beta.threads.messages > (model) image_file_content_block > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/MessageContentImageFileObject",
"ident": "ImageFileContentBlock",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "image_file"
},
{
"ident": "type"
}
]
},
"docstring": "References an image [File](/docs/api-reference/files) in the content of a message.",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) image_file_content_block > (schema) > (property) image_file",
"(resource) beta.threads.messages > (model) image_file_content_block > (schema) > (property) type"
]
},
"(resource) beta.threads.messages > (model) image_url_content_block > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/MessageContentImageUrlObject",
"ident": "ImageURLContentBlock",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "image_url"
},
{
"ident": "type"
}
]
},
"docstring": "References an image URL in the content of a message.",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) image_url_content_block > (schema) > (property) image_url",
"(resource) beta.threads.messages > (model) image_url_content_block > (schema) > (property) type"
]
},
"(resource) beta.threads.messages > (model) text_content_block > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/MessageContentTextObject",
"ident": "TextContentBlock",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "text"
},
{
"ident": "type"
}
]
},
"docstring": "The text content that is part of a message.",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) text_content_block > (schema) > (property) text",
"(resource) beta.threads.messages > (model) text_content_block > (schema) > (property) type"
]
},
"(resource) beta.threads.messages > (model) refusal_content_block > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/MessageContentRefusalObject",
"ident": "RefusalContentBlock",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "refusal"
},
{
"ident": "type"
}
]
},
"docstring": "The refusal content generated by the assistant.",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) refusal_content_block > (schema) > (property) refusal",
"(resource) beta.threads.messages > (model) refusal_content_block > (schema) > (property) type"
]
},
"(resource) beta.threads.messages > (model) message > (schema) > (property) incomplete_details > (property) reason": {
"kind": "HttpDeclProperty",
"docstring": "The reason the message is incomplete.",
"key": "reason",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "content_filter"
},
{
"kind": "HttpTypeLiteral",
"literal": "max_tokens"
},
{
"kind": "HttpTypeLiteral",
"literal": "run_cancelled"
},
{
"kind": "HttpTypeLiteral",
"literal": "run_expired"
},
{
"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,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.messages > (model) message > (schema) > (property) incomplete_details > (property) reason > (member) 0",
"(resource) beta.threads.messages > (model) message > (schema) > (property) incomplete_details > (property) reason > (member) 1",
"(resource) beta.threads.messages > (model) message > (schema) > (property) incomplete_details > (property) reason > (member) 2",
"(resource) beta.threads.messages > (model) message > (schema) > (property) incomplete_details > (property) reason > (member) 3",
"(resource) beta.threads.messages > (model) message > (schema) > (property) incomplete_details > (property) reason > (member) 4"
]
},
"(resource) $shared > (model) metadata > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/Metadata",
"ident": "Metadata",
"type": {
"kind": "HttpTypeReference",
"ident": "Record",
"typeParameters": [
{
"kind": "HttpTypeString"
},
{
"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": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "thread.message"
}
},
"(resource) beta.threads.messages > (model) message > (schema) > (property) role > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "user"
}
},
"(resource) beta.threads.messages > (model) message > (schema) > (property) role > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "assistant"
}
},
"(resource) beta.threads.messages > (model) message > (schema) > (property) status > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "in_progress"
}
},
"(resource) beta.threads.messages > (model) message > (schema) > (property) status > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "incomplete"
}
},
"(resource) beta.threads.messages > (model) message > (schema) > (property) status > (member) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "completed"
}
},
"(resource) beta.threads.messages > (model) message > (schema) > (property) attachments > (items) > (property) tools > (items) > (variant) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "CodeInterpreterTool",
"$ref": "(resource) beta.assistants > (model) code_interpreter_tool > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type"
]
},
"(resource) beta.threads.messages > (model) message > (schema) > (property) attachments > (items) > (property) tools > (items) > (variant) 1": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/MessageObject/properties/attachments/anyOf/0/items/properties/tools/items/oneOf/1",
"ident": "FileSearchTool",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) message > (schema) > (property) attachments > (items) > (property) tools > (items) > (variant) 1 > (property) type"
]
},
"(resource) beta.assistants > (model) code_interpreter_tool > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/AssistantToolsCode",
"ident": "CodeInterpreterTool",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type"
]
},
"(resource) beta.threads.messages > (model) image_file_content_block > (schema) > (property) image_file": {
"kind": "HttpDeclProperty",
"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",
"modelImplicit": false,
"modelPath": "(resource) beta.threads.messages > (model) image_file",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) image_file > (schema) > (property) file_id",
"(resource) beta.threads.messages > (model) image_file > (schema) > (property) detail"
]
},
"(resource) beta.threads.messages > (model) image_file_content_block > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "Always `image_file`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "image_file"
}
],
"oasRef": "#/components/schemas/MessageContentImageFileObject/properties/type"
},
"oasRef": "#/components/schemas/MessageContentImageFileObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.messages > (model) image_file_content_block > (schema) > (property) type > (member) 0"
]
},
"(resource) beta.threads.messages > (model) image_url_content_block > (schema) > (property) image_url": {
"kind": "HttpDeclProperty",
"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",
"modelImplicit": false,
"modelPath": "(resource) beta.threads.messages > (model) image_url",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) image_url > (schema) > (property) url",
"(resource) beta.threads.messages > (model) image_url > (schema) > (property) detail"
]
},
"(resource) beta.threads.messages > (model) image_url_content_block > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The type of the content part.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "image_url"
}
],
"oasRef": "#/components/schemas/MessageContentImageUrlObject/properties/type"
},
"oasRef": "#/components/schemas/MessageContentImageUrlObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.messages > (model) image_url_content_block > (schema) > (property) type > (member) 0"
]
},
"(resource) beta.threads.messages > (model) text_content_block > (schema) > (property) text": {
"kind": "HttpDeclProperty",
"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",
"modelImplicit": false,
"modelPath": "(resource) beta.threads.messages > (model) text",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) text > (schema) > (property) annotations",
"(resource) beta.threads.messages > (model) text > (schema) > (property) value"
]
},
"(resource) beta.threads.messages > (model) text_content_block > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "Always `text`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "text"
}
],
"oasRef": "#/components/schemas/MessageContentTextObject/properties/type"
},
"oasRef": "#/components/schemas/MessageContentTextObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.messages > (model) text_content_block > (schema) > (property) type > (member) 0"
]
},
"(resource) beta.threads.messages > (model) refusal_content_block > (schema) > (property) refusal": {
"kind": "HttpDeclProperty",
"key": "refusal",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/MessageContentRefusalObject/properties/refusal",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.messages > (model) refusal_content_block > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "Always `refusal`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "refusal"
}
],
"oasRef": "#/components/schemas/MessageContentRefusalObject/properties/type"
},
"oasRef": "#/components/schemas/MessageContentRefusalObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.messages > (model) refusal_content_block > (schema) > (property) type > (member) 0"
]
},
"(resource) beta.threads.messages > (model) message > (schema) > (property) incomplete_details > (property) reason > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "content_filter"
}
},
"(resource) beta.threads.messages > (model) message > (schema) > (property) incomplete_details > (property) reason > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "max_tokens"
}
},
"(resource) beta.threads.messages > (model) message > (schema) > (property) incomplete_details > (property) reason > (member) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "run_cancelled"
}
},
"(resource) beta.threads.messages > (model) message > (schema) > (property) incomplete_details > (property) reason > (member) 3": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "run_expired"
}
},
"(resource) beta.threads.messages > (model) message > (schema) > (property) incomplete_details > (property) reason > (member) 4": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "run_failed"
}
},
"(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The type of tool being defined: `code_interpreter`",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "code_interpreter"
}
],
"oasRef": "#/components/schemas/AssistantToolsCode/properties/type"
},
"oasRef": "#/components/schemas/AssistantToolsCode/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type > (member) 0"
]
},
"(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`",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "file_search"
}
],
"oasRef": "#/components/schemas/AssistantToolsFileSearchTypeOnly/properties/type"
},
"oasRef": "#/components/schemas/AssistantToolsFileSearchTypeOnly/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.messages > (model) message > (schema) > (property) attachments > (items) > (property) tools > (items) > (variant) 1 > (property) type > (member) 0"
]
},
"(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.",
"key": "file_id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/MessageContentImageFileObject/properties/image_file/properties/file_id",
"deprecated": 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`.",
"key": "detail",
"optional": true,
"nullable": false,
"default": "auto",
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "auto"
},
{
"kind": "HttpTypeLiteral",
"literal": "low"
},
{
"kind": "HttpTypeLiteral",
"literal": "high"
}
],
"oasRef": "#/components/schemas/MessageContentImageFileObject/properties/image_file/properties/detail"
},
"oasRef": "#/components/schemas/MessageContentImageFileObject/properties/image_file/properties/detail",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.messages > (model) image_file > (schema) > (property) detail > (member) 0",
"(resource) beta.threads.messages > (model) image_file > (schema) > (property) detail > (member) 1",
"(resource) beta.threads.messages > (model) image_file > (schema) > (property) detail > (member) 2"
]
},
"(resource) beta.threads.messages > (model) image_file > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/MessageContentImageFileObject/properties/image_file",
"ident": "ImageFile",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "file_id"
},
{
"ident": "detail"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) image_file > (schema) > (property) file_id",
"(resource) beta.threads.messages > (model) image_file > (schema) > (property) detail"
]
},
"(resource) beta.threads.messages > (model) image_file_content_block > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "image_file"
}
},
"(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.",
"key": "url",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"constraints": {
"format": "uri"
},
"oasRef": "#/components/schemas/MessageContentImageUrlObject/properties/image_url/properties/url",
"deprecated": 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`",
"key": "detail",
"optional": true,
"nullable": false,
"default": "auto",
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "auto"
},
{
"kind": "HttpTypeLiteral",
"literal": "low"
},
{
"kind": "HttpTypeLiteral",
"literal": "high"
}
],
"oasRef": "#/components/schemas/MessageContentImageUrlObject/properties/image_url/properties/detail"
},
"oasRef": "#/components/schemas/MessageContentImageUrlObject/properties/image_url/properties/detail",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.messages > (model) image_url > (schema) > (property) detail > (member) 0",
"(resource) beta.threads.messages > (model) image_url > (schema) > (property) detail > (member) 1",
"(resource) beta.threads.messages > (model) image_url > (schema) > (property) detail > (member) 2"
]
},
"(resource) beta.threads.messages > (model) image_url > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/MessageContentImageUrlObject/properties/image_url",
"ident": "ImageURL",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "url"
},
{
"ident": "detail"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) image_url > (schema) > (property) url",
"(resource) beta.threads.messages > (model) image_url > (schema) > (property) detail"
]
},
"(resource) beta.threads.messages > (model) image_url_content_block > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "image_url"
}
},
"(resource) beta.threads.messages > (model) text > (schema) > (property) annotations": {
"kind": "HttpDeclProperty",
"key": "annotations",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeArray",
"elementType": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeReference",
"ident": "FileCitationAnnotation",
"$ref": "(resource) beta.threads.messages > (model) file_citation_annotation > (schema)"
},
{
"kind": "HttpTypeReference",
"ident": "FilePathAnnotation",
"$ref": "(resource) beta.threads.messages > (model) file_path_annotation > (schema)"
}
],
"oasRef": "#/components/schemas/MessageContentTextObject/properties/text/properties/annotations/items"
},
"oasRef": "#/components/schemas/MessageContentTextObject/properties/text/properties/annotations"
},
"oasRef": "#/components/schemas/MessageContentTextObject/properties/text/properties/annotations",
"deprecated": false,
"schemaType": "array",
"childrenParentSchema": "union",
"children": [
"(resource) beta.threads.messages > (model) text > (schema) > (property) annotations > (items) > (variant) 0",
"(resource) beta.threads.messages > (model) text > (schema) > (property) annotations > (items) > (variant) 1"
]
},
"(resource) beta.threads.messages > (model) text > (schema) > (property) value": {
"kind": "HttpDeclProperty",
"docstring": "The data that makes up the text.",
"key": "value",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/MessageContentTextObject/properties/text/properties/value",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.messages > (model) text > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/MessageContentTextObject/properties/text",
"ident": "Text",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "annotations"
},
{
"ident": "value"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) text > (schema) > (property) annotations",
"(resource) beta.threads.messages > (model) text > (schema) > (property) value"
]
},
"(resource) beta.threads.messages > (model) text_content_block > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "text"
}
},
"(resource) beta.threads.messages > (model) refusal_content_block > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "refusal"
}
},
"(resource) beta.assistants > (model) code_interpreter_tool > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "code_interpreter"
}
},
"(resource) beta.threads.messages > (model) message > (schema) > (property) attachments > (items) > (property) tools > (items) > (variant) 1 > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "file_search"
}
},
"(resource) beta.threads.messages > (model) image_file > (schema) > (property) detail > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "auto"
}
},
"(resource) beta.threads.messages > (model) image_file > (schema) > (property) detail > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "low"
}
},
"(resource) beta.threads.messages > (model) image_file > (schema) > (property) detail > (member) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "high"
}
},
"(resource) beta.threads.messages > (model) image_url > (schema) > (property) detail > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "auto"
}
},
"(resource) beta.threads.messages > (model) image_url > (schema) > (property) detail > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "low"
}
},
"(resource) beta.threads.messages > (model) image_url > (schema) > (property) detail > (member) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "high"
}
},
"(resource) beta.threads.messages > (model) text > (schema) > (property) annotations > (items) > (variant) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "FileCitationAnnotation",
"$ref": "(resource) beta.threads.messages > (model) file_citation_annotation > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) end_index",
"(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) file_citation",
"(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) start_index",
"(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) text",
"(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) type"
]
},
"(resource) beta.threads.messages > (model) text > (schema) > (property) annotations > (items) > (variant) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "FilePathAnnotation",
"$ref": "(resource) beta.threads.messages > (model) file_path_annotation > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) end_index",
"(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) file_path",
"(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) start_index",
"(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) text",
"(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) type"
]
},
"(resource) beta.threads.messages > (model) file_citation_annotation > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject",
"ident": "FileCitationAnnotation",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "end_index"
},
{
"ident": "file_citation"
},
{
"ident": "start_index"
},
{
"ident": "text"
},
{
"ident": "type"
}
]
},
"docstring": "A citation within the message that points to a specific quote from a specific File associated with the assistant or the message. Generated when the assistant uses the \"file_search\" tool to search files.",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) end_index",
"(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) file_citation",
"(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) start_index",
"(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) text",
"(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) type"
]
},
"(resource) beta.threads.messages > (model) file_path_annotation > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/MessageContentTextAnnotationsFilePathObject",
"ident": "FilePathAnnotation",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "end_index"
},
{
"ident": "file_path"
},
{
"ident": "start_index"
},
{
"ident": "text"
},
{
"ident": "type"
}
]
},
"docstring": "A URL for the file that's generated when the assistant used the `code_interpreter` tool to generate a file.",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) end_index",
"(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) file_path",
"(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) start_index",
"(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) text",
"(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) type"
]
},
"(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) end_index": {
"kind": "HttpDeclProperty",
"key": "end_index",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"minimum": 0
},
"oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject/properties/end_index",
"deprecated": false,
"schemaType": "integer",
"children": []
},
"(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) file_citation": {
"kind": "HttpDeclProperty",
"key": "file_citation",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "file_id"
}
]
},
"oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject/properties/file_citation",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) file_citation > (property) file_id"
]
},
"(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) start_index": {
"kind": "HttpDeclProperty",
"key": "start_index",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"minimum": 0
},
"oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject/properties/start_index",
"deprecated": false,
"schemaType": "integer",
"children": []
},
"(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) text": {
"kind": "HttpDeclProperty",
"docstring": "The text in the message content that needs to be replaced.",
"key": "text",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject/properties/text",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "Always `file_citation`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "file_citation"
}
],
"oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject/properties/type"
},
"oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) type > (member) 0"
]
},
"(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) end_index": {
"kind": "HttpDeclProperty",
"key": "end_index",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"minimum": 0
},
"oasRef": "#/components/schemas/MessageContentTextAnnotationsFilePathObject/properties/end_index",
"deprecated": false,
"schemaType": "integer",
"children": []
},
"(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) file_path": {
"kind": "HttpDeclProperty",
"key": "file_path",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "file_id"
}
]
},
"oasRef": "#/components/schemas/MessageContentTextAnnotationsFilePathObject/properties/file_path",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) file_path > (property) file_id"
]
},
"(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) start_index": {
"kind": "HttpDeclProperty",
"key": "start_index",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"minimum": 0
},
"oasRef": "#/components/schemas/MessageContentTextAnnotationsFilePathObject/properties/start_index",
"deprecated": 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.",
"key": "text",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/MessageContentTextAnnotationsFilePathObject/properties/text",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "Always `file_path`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "file_path"
}
],
"oasRef": "#/components/schemas/MessageContentTextAnnotationsFilePathObject/properties/type"
},
"oasRef": "#/components/schemas/MessageContentTextAnnotationsFilePathObject/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) type > (member) 0"
]
},
"(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.",
"key": "file_id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/MessageContentTextAnnotationsFileCitationObject/properties/file_citation/properties/file_id",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.messages > (model) file_citation_annotation > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "file_citation"
}
},
"(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.",
"key": "file_id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/MessageContentTextAnnotationsFilePathObject/properties/file_path/properties/file_id",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) beta.threads.messages > (model) file_path_annotation > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "file_path"
}
}
}
Example
{}
event
Occurs when an error occurs. This can happen due to an internal server error or a timeout.
Schema
Schema name: (resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 23
{
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 23": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/AssistantStreamEvent/oneOf/4",
"ident": "ErrorEvent",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "data"
},
{
"ident": "event"
}
]
},
"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",
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 23 > (property) event"
]
},
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 23 > (property) data": {
"kind": "HttpDeclProperty",
"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",
"modelImplicit": false,
"modelPath": "(resource) $shared > (model) error_object",
"childrenParentSchema": "object",
"children": [
"(resource) $shared > (model) error_object > (schema) > (property) code",
"(resource) $shared > (model) error_object > (schema) > (property) message",
"(resource) $shared > (model) error_object > (schema) > (property) param",
"(resource) $shared > (model) error_object > (schema) > (property) type"
]
},
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 23 > (property) event": {
"kind": "HttpDeclProperty",
"key": "event",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "error"
}
],
"oasRef": "#/components/schemas/ErrorEvent/properties/event"
},
"oasRef": "#/components/schemas/ErrorEvent/properties/event",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 23 > (property) event > (member) 0"
]
},
"(resource) $shared > (model) error_object > (schema) > (property) code": {
"kind": "HttpDeclProperty",
"key": "code",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/Error/properties/code",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) $shared > (model) error_object > (schema) > (property) message": {
"kind": "HttpDeclProperty",
"key": "message",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/Error/properties/message",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) $shared > (model) error_object > (schema) > (property) param": {
"kind": "HttpDeclProperty",
"key": "param",
"optional": false,
"nullable": true,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/Error/properties/param",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) $shared > (model) error_object > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/Error/properties/type",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) $shared > (model) error_object > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/Error",
"ident": "ErrorObject",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "code"
},
{
"ident": "message"
},
{
"ident": "param"
},
{
"ident": "type"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) $shared > (model) error_object > (schema) > (property) code",
"(resource) $shared > (model) error_object > (schema) > (property) message",
"(resource) $shared > (model) error_object > (schema) > (property) param",
"(resource) $shared > (model) error_object > (schema) > (property) type"
]
},
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 23 > (property) event > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "error"
}
}
}
Example
{}
event
Occurs when a stream ends.
Schema
Schema name: (resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 24
{
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 24": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/AssistantStreamEvent/oneOf/5",
"ident": "DoneEvent",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "data"
},
{
"ident": "event"
}
]
},
"docstring": "Occurs when a stream ends.",
"childrenParentSchema": "object",
"children": [
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 24 > (property) data",
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 24 > (property) event"
]
},
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 24 > (property) data": {
"kind": "HttpDeclProperty",
"key": "data",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "[DONE]"
}
],
"oasRef": "#/components/schemas/DoneEvent/properties/data"
},
"oasRef": "#/components/schemas/DoneEvent/properties/data",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 24 > (property) data > (member) 0"
]
},
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 24 > (property) event": {
"kind": "HttpDeclProperty",
"key": "event",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "done"
}
],
"oasRef": "#/components/schemas/DoneEvent/properties/event"
},
"oasRef": "#/components/schemas/DoneEvent/properties/event",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 24 > (property) event > (member) 0"
]
},
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 24 > (property) data > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "[DONE]"
}
},
"(resource) beta.assistants > (model) assistant_stream_event > (schema) > (variant) 24 > (property) event > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "done"
}
}
}
Example
{}