Responses
-
OK
Hide response attributes Show response attributes object
-
The identifier, which can be referenced in API endpoints.
-
The object type, which is always
assistant
.Value is
assistant
. -
The Unix timestamp (in seconds) for when the assistant was created.
-
The name of the assistant. The maximum length is 256 characters.
Maximum length is
256
. -
The description of the assistant. The maximum length is 512 characters.
Maximum length is
512
. -
ID of the model to use. You can use the List models API to see all of your available models, or see our Model overview for descriptions of them.
-
The system instructions that the assistant uses. The maximum length is 256,000 characters.
Maximum length is
256000
. -
A list of tool enabled on the assistant. There can be a maximum of 128 tools per assistant. Tools can be of types
code_interpreter
,file_search
, orfunction
.Not more than
128
elements. Default value is[]
(empty).One of: Hide attributes Show attributes
-
The type of tool being defined:
file_search
Value is
file_search
. -
Overrides for the file search tool.
Hide file_search attributes Show file_search attributes object
-
The maximum number of results the file search tool should output. The default is 20 for
gpt-4*
models and 5 forgpt-3.5-turbo
. This number should be between 1 and 50 inclusive.Note that the file search tool may output fewer than
max_num_results
results. See the file search tool documentation for more information.Minimum value is
1
, maximum value is50
. -
The ranking options for the file search. If not specified, the file search tool will use the
auto
ranker and a score_threshold of 0.See the file search tool documentation for more information.
Hide ranking_options attributes Show ranking_options attributes object
-
The ranker to use for the file search. If not specified will use the
auto
ranker.Values are
auto
ordefault_2024_08_21
. -
The score threshold for the file search. All values must be a floating point number between 0 and 1.
Minimum value is
0
, maximum value is1
.
-
-
Hide attributes Show attributes
-
The type of tool being defined:
function
Value is
function
. -
Hide function attributes Show function attributes object
-
A description of what the function does, used by the model to choose when and how to call the function.
-
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.
-
The parameters the functions accepts, described as a JSON Schema object. See the guide for examples, and the JSON Schema reference for documentation about the format.
Omitting
parameters
defines a function with an empty parameter list.Additional properties are allowed.
-
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 whenstrict
istrue
. Learn more about Structured Outputs in the function calling guide.Default value is
false
.
-
-
-
A set of resources that are used by the assistant's tools. The resources are specific to the type of tool. For example, the
code_interpreter
tool requires a list of file IDs, while thefile_search
tool requires a list of vector store IDs.Hide tool_resources attributes Show tool_resources attributes object | null
-
Hide code_interpreter attribute Show code_interpreter attribute object
-
A list of file IDs made available to the
code_interpreter
` tool. There can be a maximum of 20 files associated with the tool.Not more than
20
elements. Default value is[]
(empty).
-
-
Hide file_search attribute Show file_search attribute object
-
The ID of the vector store attached to this assistant. There can be a maximum of 1 vector store attached to the assistant.
Not more than
1
element.
-
-
-
Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard.
Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.
-
What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.
Minimum value is
0
, maximum value is2
. Default value is1
. -
An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered.
We generally recommend altering this or temperature but not both.
Minimum value is
0
, maximum value is1
. Default value is1
. response_format
string | null | object Specifies the format that the model must output. Compatible with GPT-4o, GPT-4 Turbo, and all GPT-3.5 Turbo models since
gpt-3.5-turbo-1106
.Setting to
{ "type": "json_schema", "json_schema": {...} }
enables Structured Outputs which ensures the model will match your supplied JSON schema. Learn more in the Structured Outputs guide.Setting to
{ "type": "json_object" }
enables JSON mode, which ensures the message the model generates is valid JSON.Important: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly "stuck" request. Also note that the message content may be partially cut off if
finish_reason="length"
, which indicates the generation exceededmax_tokens
or the conversation exceeded the max context length.One of: auto
is the default valueValue is
auto
.Default response format. Used to generate text responses.
JSON object response format. An older method of generating JSON responses. Using
json_schema
is recommended for models that support it. Note that the model will not generate JSON without a system or user message instructing it to do so.JSON Schema response format. Used to generate structured JSON responses. Learn more about Structured Outputs.
Hide attributes Show attributes
-
The type of response format being defined. Always
json_schema
.Value is
json_schema
. -
Structured Outputs configuration options, including a JSON Schema.
Hide json_schema attributes Show json_schema attributes object
-
A description of what the response format is for, used by the model to determine how to respond in the format.
-
The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.
-
The schema for the response format, described as a JSON Schema object. Learn how to build JSON schemas here.
Additional properties are allowed.
-
Whether to enable strict schema adherence when generating the output. If set to true, the model will always follow the exact schema defined in the
schema
field. Only a subset of JSON Schema is supported whenstrict
istrue
. To learn more, read the Structured Outputs guide.Default value is
false
.
-
-
-
curl \
--request GET 'https://api.openai.com/v1/assistants/{assistant_id}' \
--header "Authorization: Bearer $ACCESS_TOKEN"
{
"id": "string",
"object": "assistant",
"created_at": 42,
"name": "string",
"description": "string",
"model": "string",
"instructions": "string",
"tools": [
{
"type": "code_interpreter"
}
],
"tool_resources": {
"code_interpreter": {
"file_ids": []
},
"file_search": {
"vector_store_ids": [
"string"
]
}
},
"metadata": {
"additionalProperty1": "string",
"additionalProperty2": "string"
},
"temperature": 1,
"top_p": 1,
"response_format": "auto"
}