Interface Choice

interface Choice {
    delta: Delta;
    finish_reason: null | "length" | "stop" | "tool_calls" | "content_filter" | "function_call";
    index: number;
    logprobs?: null | ChatCompletionChunk.Choice.Logprobs;
}

Properties

delta finish_reason index logprobs?

Properties

delta

delta: Delta

A chat completion delta generated by streamed model responses.

finish_reason

finish_reason: null | "length" | "stop" | "tool_calls" | "content_filter" | "function_call"

The reason the model stopped generating tokens. This will be stop if the model hit a natural stop point or a provided stop sequence, length if the maximum number of tokens specified in the request was reached, content_filter if content was omitted due to a flag from our content filters, tool_calls if the model called a tool, or function_call (deprecated) if the model called a function.

index

index: number

The index of the choice in the list of choices.

Optional logprobs

logprobs?: null | ChatCompletionChunk.Choice.Logprobs

Log probability information for the choice.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc