ChatCompletionResponseMessage
objectA chat completion message generated by the model.
The contents of the message.
The refusal message generated by the model.
The tool calls generated by the model, such as function calls.
Show Child Parameters
The role of the author of this message.
Allowed values:assistant
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
If the audio output modality is requested, this object contains data
about the audio response from the model. Learn more.
Show Child Parameters
ChatCompletionRole
stringThe role of the author of a message
Allowed values:developersystemuserassistanttoolfunction
ChatCompletionStreamOptions
objectOptions for streaming response. Only set this when you set stream: true.
Default:null
If set, an additional chunk will be streamed before the data: [DONE] message. The usage field on this chunk shows the token usage statistics for the entire request, and the choices field will always be an empty array. All other chunks will also include a usage field, but with a null value.
ChatCompletionStreamResponseDelta
objectA chat completion delta generated by streamed model responses.
The contents of the chunk message.
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
Show Child Parameters
The role of the author of this message.
Allowed values:developersystemuserassistanttool
The refusal message generated by the model.
ChatCompletionTokenLogprob
objectThe token.
The log probability of this token, if it is within the top 20 most likely tokens. Otherwise, the value -9999.0 is used to signify that the token is very unlikely.
A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be null if there is no bytes representation for the token.
List of the most likely tokens and their log probability, at this token position. In rare cases, there may be fewer than the number of requested top_logprobs returned.