Interface Delta

A chat completion delta generated by streamed model responses.

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

Index

Properties

content? function_call? role? tool_calls?

Properties

`Optional` content

content?: null | string

The contents of the chunk message.

`Optional` function_call

function_call?: ChatCompletionChunk.Choice.Delta.FunctionCall

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

`Optional` role

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

The role of the author of this message.

`Optional` tool_calls

tool_calls?: ToolCall[]

Generated using TypeDoc