CreateEmbeddingResponse

Response from the embeddings API.

API ManagementCloudCloud ComputingEnterpriseInfrastructure as a ServicePlatform as a ServiceT1

Properties

Name	Type	Description
object	string	The object type.
data	array	The list of embeddings generated.
model	string	The model used to generate the embeddings.
usage	object

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CreateEmbeddingResponse",
  "title": "CreateEmbeddingResponse",
  "type": "object",
  "description": "Response from the embeddings API.",
  "properties": {
    "object": {
      "type": "string",
      "enum": [
        "list"
      ],
      "description": "The object type.",
      "example": "list"
    },
    "data": {
      "type": "array",
      "description": "The list of embeddings generated.",
      "items": {
        "type": "object",
        "properties": {
          "index": {
            "type": "integer",
            "description": "The index of the embedding."
          },
          "object": {
            "type": "string",
            "enum": [
              "embedding"
            ],
            "description": "The object type."
          },
          "embedding": {
            "type": "array",
            "items": {
              "type": "number"
            },
            "description": "The embedding vector."
          }
        },
        "required": [
          "index",
          "object",
          "embedding"
        ]
      },
      "example": []
    },
    "model": {
      "type": "string",
      "description": "The model used to generate the embeddings.",
      "example": "example_value"
    },
    "usage": {
      "$ref": "#/components/schemas/Usage"
    }
  },
  "required": [
    "object",
    "data",
    "model",
    "usage"
  ]
}