OpenAI API

ChatCompletionRequestUserMessageContentPart

One Of
typestringrequired

The type of the content part.

Allowed values:text

textstringrequired

The text content.

Example

ChatCompletionResponseMessage

object

A chat completion message generated by the model.

contentstringrequired

The contents of the message.

refusalstringrequired

The refusal message generated by the model.

tool_callsarray[object]

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

Show Child Parameters
rolestringrequired

The role of the author of this message.

Allowed values:assistant

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
audioobject

If the audio output modality is requested, this object contains data
about the audio response from the model. Learn more.

Show Child Parameters
Example

ChatCompletionRole

string

The role of the author of a message

Allowed values:developersystemuserassistanttoolfunction

ChatCompletionStreamOptions

object

Options for streaming response. Only set this when you set stream: true.

Default:null

include_usageboolean

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.

Example

ChatCompletionStreamResponseDelta

object

A chat completion delta generated by streamed model responses.

contentstring

The contents of the chunk message.

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
tool_callsarray[object]
Show Child Parameters
rolestring

The role of the author of this message.

Allowed values:developersystemuserassistanttool

refusalstring

The refusal message generated by the model.

Example