Interface ChatCompletionChoiceModel

Describes a single choice in a chat completion response.

ChoiceModel

interface ChatCompletionChoiceModel {
    finishReason?: string;
    index?: number;
    message?: ChatMessageModel;
}

Properties

finishReason?: string

Indicates why the chat response generation stopped. This signals the end of the response.

  • stop: The model finished generating the response.

  • length: Generation was cut off because the maximum number of tokens allowed was reached.

  • content_filter: Generation stopped because content was blocked by content filtering rules. (for example, content that contains hate speech or violent material).

  • tool_calls: Generation stopped because a tool call was triggered.

ChoiceModel

index?: number

The index of this choice in the list of returned choices.

ChoiceModel

ChoiceModel