AssistantsApiResponseFormatOption
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 exceeded max_tokens or the conversation exceeded the max context length.
One OfAssistantsApiToolChoiceOption
Controls which (if any) tool is called by the model.
none means the model will not call any tools and instead generates a message.
auto is the default value and means the model can pick between generating a message or calling one or more tools.
required means the model must call one or more tools before responding to the user.
Specifying a particular tool like {"type": "file_search"} or {"type": "function", "function": {"name": "my_function"}} forces the model to call that tool.
One OfAssistantsNamedToolChoice
objectSpecifies a tool the model should use. Use to force the model to call a specific tool.
The type of the tool. If type is function, the function name must be set
Allowed values:functioncode_interpreterfile_search
Show Child Parameters
AudioResponseFormat
stringThe format of the output, in one of these options: json, text, srt, verbose_json, or vtt.
Allowed values:jsontextsrtverbose_jsonvtt
Default:json
AuditLog
objectA log of a user action or configuration change within this organization.
The ID of this log.
The event type.
Allowed values:api_key.createdapi_key.updatedapi_key.deletedinvite.sentinvite.acceptedinvite.deletedlogin.succeededlogin.failedlogout.succeededlogout.failedorganization.updatedproject.createdproject.updatedproject.archivedservice_account.createdservice_account.updatedservice_account.deletedrate_limit.updatedrate_limit.deleteduser.addeduser.updateduser.deleted
The Unix timestamp (in seconds) of the event.
The project that the action was scoped to. Absent for actions not scoped to projects.
Show Child Parameters
The actor who performed the audit logged action.
Show Child Parameters
The details for events with this type.
Show Child Parameters
The details for events with this type.
Show Child Parameters
The details for events with this type.
Show Child Parameters
The details for events with this type.
Show Child Parameters
The details for events with this type.
Show Child Parameters
The details for events with this type.
Show Child Parameters
The details for events with this type.
Show Child Parameters
The details for events with this type.
Show Child Parameters
The details for events with this type.
Show Child Parameters
The details for events with this type.
Show Child Parameters
The details for events with this type.
Show Child Parameters
The details for events with this type.
Show Child Parameters
The details for events with this type.
Show Child Parameters
The details for events with this type.
Show Child Parameters
The details for events with this type.
Show Child Parameters
The details for events with this type.
Show Child Parameters
The details for events with this type.
Show Child Parameters
The details for events with this type.
Show Child Parameters
The details for events with this type.
Show Child Parameters
The details for events with this type.