Files
log10py/docs/models/components/choices.md
Niklas Nielsen ebd24efca7 Initial commit
2024-05-24 19:20:08 -07:00

11 lines
9.5 KiB
Markdown

# Choices
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `finish_reason` | [components.FinishReason](../../models/components/finishreason.md) | :heavy_check_mark: | The reason the model stopped generating tokens. This will be `stop` if the model hit a natural stop point or a provided stop sequence,<br/>`length` if the maximum number of tokens specified in the request was reached,<br/>`content_filter` if content was omitted due to a flag from our content filters,<br/>`tool_calls` if the model called a tool, or `function_call` (deprecated) if the model called a function.<br/> |
| `index` | *int* | :heavy_check_mark: | The index of the choice in the list of choices. |
| `message` | [components.ChatCompletionResponseMessage](../../models/components/chatcompletionresponsemessage.md) | :heavy_check_mark: | A chat completion message generated by the model. |
| `logprobs` | [Optional[components.Logprobs]](../../models/components/logprobs.md) | :heavy_check_mark: | Log probability information for the choice. |