Skip to main content
Module

x/openai/resources/chat/completions.ts>ChatCompletion.Choice

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

Interfaces

Log probability information for the choice.

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

Properties

finish_reason:
| "stop"
| "length"
| "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: number

The index of the choice in the list of choices.

logprobs: Choice.Logprobs | null

Log probability information for the choice.

message: ChatCompletionsAPI.ChatCompletionMessage

A chat completion message generated by the model.