Search
K
OpenAI API

Error

object
codestringrequired
messagestringrequired
paramstringrequired
typestringrequired
Example

ErrorEvent

object

Occurs when an error occurs. This can happen due to an internal server error or a timeout.

eventstringrequired

Allowed values:error

dataobjectrequired
Show Child Parameters
Example

ErrorResponse

object
errorobjectrequired
Show Child Parameters
Example

File search tool call ranking options

object

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.

rankerstring

The ranker to use for the file search. If not specified will use the auto ranker.

Allowed values:autodefault_2024_08_21

score_thresholdnumberrequired

The score threshold for the file search. All values must be a floating point number between 0 and 1.

>= 0<= 1

Example

FineTuneChatCompletionRequestAssistantMessage

weightinteger

Controls whether the assistant message is trained against (0 or 1)

Allowed values:1

contentOne Of
Text contentstring

The contents of the assistant message.

refusalstring

The refusal message by the assistant.

rolestringrequired

The role of the messages author, in this case assistant.

Allowed values:assistant

namestring

An optional name for the participant. Provides the model information to differentiate between participants of the same role.

audioobject

Data about a previous audio response from the model.
Learn more.

Show Child Parameters
tool_callsarray[object]

The tool calls generated by the model, such as function calls.

Show Child Parameters
function_callobjectDEPRECATED

Deprecated and replaced by tool_calls. The name and arguments of a function that should be called, as generated by the model.

Show Child Parameters
Example