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"
        | "assistant"
        | "user"
        | "tool";
    tool_calls?: OpenAIClient.Chat.Completions.ChatCompletionChunk.Choice.Delta.ToolCall[];
}

Properties

content?: null | string

The contents of the chunk message.

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

refusal?: null | string

The refusal message generated by the model.

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

The role of the author of this message.