ChatChoiceOutput interface

The representation of a single prompt completion as part of an overall chat completions request. Generally, n choices are generated per provided prompt with a default value of 1. Token limits and other settings may limit the number of choices generated.

Properties

finish_reason

The reason that this chat completions choice completed its generated.

index

The ordered index associated with this chat completions choice.

message

The chat message for a given chat completions prompt.

Property Details

finish_reason

The reason that this chat completions choice completed its generated.

finish_reason: null | string

Property Value

null | string

index

The ordered index associated with this chat completions choice.

index: number

Property Value

number

message

The chat message for a given chat completions prompt.

message: ChatResponseMessageOutput

Property Value