Interface ChatCompletionAssistantMessageParam

Messages sent by the model in response to user messages.

interface ChatCompletionAssistantMessageParam {
    audio?: null | OpenAIClient.Chat.Completions.ChatCompletionAssistantMessageParam.Audio;
    content?: null | string | (ChatCompletionContentPartText | ChatCompletionContentPartRefusal)[];
    function_call?: null | OpenAIClient.Chat.Completions.ChatCompletionAssistantMessageParam.FunctionCall;
    name?: string;
    refusal?: null | string;
    role: "assistant";
    tool_calls?: ChatCompletionMessageToolCall[];
}

Properties

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

Properties

Optionalaudio

audio?: null | OpenAIClient.Chat.Completions.ChatCompletionAssistantMessageParam.Audio

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

Optionalcontent

content?: null | string | (ChatCompletionContentPartText | ChatCompletionContentPartRefusal)[]

The contents of the assistant message. Required unless tool_calls or function_call is specified.

Optionalfunction_call

function_call?: null | OpenAIClient.Chat.Completions.ChatCompletionAssistantMessageParam.FunctionCall

Deprecated

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

Optionalname

name?: string

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

Optionalrefusal

refusal?: null | string

The refusal message by the assistant.

role

role: "assistant"

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

Optionaltool_calls

tool_calls?: ChatCompletionMessageToolCall[]

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

Settings

Member Visibility

On This Page

Properties