Skip to main content
Module

x/openai/resources/chat/mod.ts>ChatCompletionChunk.Choice

Deno build of the official Typescript library for the OpenAI API.
Extremely Popular
Go to Latest
namespace ChatCompletionChunk.Choice
import { ChatCompletionChunk } from "https://deno.land/x/openai@v4.21.0/resources/chat/mod.ts";
const { Choice } = ChatCompletionChunk;

Interfaces

A chat completion delta generated by streamed model responses.

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

interface ChatCompletionChunk.Choice
import { type ChatCompletionChunk } from "https://deno.land/x/openai@v4.21.0/resources/chat/mod.ts";
const { Choice } = ChatCompletionChunk;

Properties

A chat completion delta generated by streamed model responses.

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

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: number

The index of the choice in the list of choices.