Microsoft Azure · Schema

CreateCompletionResponse

Represents a completion response from the API.

API ManagementCloudCloud ComputingEnterpriseInfrastructure as a ServicePlatform as a ServiceT1

Properties

Name Type Description
id string A unique identifier for the completion.
object string The object type.
created integer The Unix timestamp of when the completion was created.
model string The model used for completion.
choices array The list of completion choices.
usage object
View JSON Schema on GitHub

JSON Schema

microsoft-azure-createcompletionresponse-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CreateCompletionResponse",
  "title": "CreateCompletionResponse",
  "type": "object",
  "description": "Represents a completion response from the API.",
  "properties": {
    "id": {
      "type": "string",
      "description": "A unique identifier for the completion.",
      "example": "abc123"
    },
    "object": {
      "type": "string",
      "enum": [
        "text_completion"
      ],
      "description": "The object type.",
      "example": "text_completion"
    },
    "created": {
      "type": "integer",
      "description": "The Unix timestamp of when the completion was created.",
      "example": 10
    },
    "model": {
      "type": "string",
      "description": "The model used for completion.",
      "example": "example_value"
    },
    "choices": {
      "type": "array",
      "description": "The list of completion choices.",
      "items": {
        "type": "object",
        "properties": {
          "text": {
            "type": "string",
            "description": "The generated text."
          },
          "index": {
            "type": "integer",
            "description": "The index of the choice."
          },
          "finish_reason": {
            "type": "string",
            "enum": [
              "stop",
              "length",
              "content_filter"
            ],
            "description": "The reason the model stopped generating tokens."
          }
        }
      },
      "example": []
    },
    "usage": {
      "$ref": "#/components/schemas/Usage"
    }
  },
  "required": [
    "id",
    "object",
    "created",
    "model",
    "choices"
  ]
}