Microsoft Azure · Schema

ChatCompletionChoice

A chat completion choice.

API ManagementCloudCloud ComputingEnterpriseInfrastructure as a ServicePlatform as a ServiceT1

Properties

Name Type Description
index integer The index of the choice in the list.
message object
finish_reason string The reason the model stopped generating tokens.
View JSON Schema on GitHub

JSON Schema

microsoft-azure-chatcompletionchoice-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ChatCompletionChoice",
  "title": "ChatCompletionChoice",
  "type": "object",
  "description": "A chat completion choice.",
  "properties": {
    "index": {
      "type": "integer",
      "description": "The index of the choice in the list.",
      "example": 10
    },
    "message": {
      "$ref": "#/components/schemas/ChatCompletionMessage"
    },
    "finish_reason": {
      "type": "string",
      "enum": [
        "stop",
        "length",
        "content_filter",
        "tool_calls"
      ],
      "description": "The reason the model stopped generating tokens.",
      "example": "stop"
    }
  },
  "required": [
    "index",
    "message",
    "finish_reason"
  ]
}