Interface ChatsAssistantMessage

An assistant message in a chat.

interface ChatsAssistantMessage {
    audio?: ChatsAssistantAudio;
    content?: string | ChatsTextContentPart[];
    function_call?: FunctionCall;
    name?: string;
    refusal?: string;
    role: "assistant";
    tool_calls?: ChatsToolCall[];
}

Properties

audio? content? function_call? name? refusal? role tool_calls?

Properties

Optional audio

audio?: ChatsAssistantAudio

Data about a previous audio response from the model.

Optional content

content?: string | ChatsTextContentPart[]

Content of an assistant message. Required unless tool_calls or function_call are specified.

Optional function_call

function_call?: FunctionCall

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

Deprecated: function_call has been deprecated by OpenAI and replaced by tool_calls.

Optional name

name?: string

Name for the participant. Provides the model information to differentiate between participants of the same role.

Optional refusal

refusal?: string

Refusal message by the assistant.

role

role: "assistant"

Role of the messages author, in this case should always be "assistant".

Optional tool_calls

tool_calls?: ChatsToolCall[]

Array of tool calls generated by the model, such as function calls.

Settings

Member Visibility

Theme

On This Page

audiocontentfunction_callnamerefusalroletool_calls