Interface Delta

A chat completion delta generated by streamed model responses.

interface Delta {
    content?: null | string;
    function_call?: OpenAIClient.Chat.Completions.ChatCompletionChunk.Choice.Delta.FunctionCall;
    refusal?: null | string;
    role?:
        | "system"
        | "developer"
        | "assistant"
        | "user"
        | "tool";
    tool_calls?: OpenAIClient.Chat.Completions.ChatCompletionChunk.Choice.Delta.ToolCall[];
}

Properties

content? function_call? refusal? role? tool_calls?

Properties

Optionalcontent

content?: null | string

The contents of the chunk message.

Optionalfunction_call

function_call?: OpenAIClient.Chat.Completions.ChatCompletionChunk.Choice.Delta.FunctionCall

Deprecated

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

Optionalrefusal

refusal?: null | string

The refusal message generated by the model.

Optionalrole

role?:
    | "system"
    | "developer"
    | "assistant"
    | "user"
    | "tool"

The role of the author of this message.

Optionaltool_calls

tool_calls?: OpenAIClient.Chat.Completions.ChatCompletionChunk.Choice.Delta.ToolCall[]

Settings

Member Visibility

On This Page

Properties