Interface ChatCompletionStoreMessage

A chat completion message generated by the model.

interface ChatCompletionStoreMessage {
    annotations?: OpenAIClient.Chat.Completions.ChatCompletionMessage.Annotation[];
    audio?: null | ChatCompletionAudio;
    content: null | string;
    function_call?: null | OpenAIClient.Chat.Completions.ChatCompletionMessage.FunctionCall;
    id: string;
    refusal: null | string;
    role: "assistant";
    tool_calls?: ChatCompletionMessageToolCall[];
}

Hierarchy (view full)

Properties

annotations? audio? content function_call? id refusal role tool_calls?

Properties

Optionalannotations

annotations?: OpenAIClient.Chat.Completions.ChatCompletionMessage.Annotation[]

Annotations for the message, when applicable, as when using the web search tool.

Optionalaudio

audio?: null | ChatCompletionAudio

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

content

content: null | string

The contents of the message.

Optionalfunction_call

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

Deprecated

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

id

id: string

The identifier of the chat message.

refusal

refusal: null | string

The refusal message generated by the model.

role

role: "assistant"

The role of the author of this message.

Optionaltool_calls

tool_calls?: ChatCompletionMessageToolCall[]

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

Settings

Member Visibility

On This Page

Properties