CreateEmbeddingRequest

Request body for creating embeddings.

API ManagementCloudCloud ComputingEnterpriseInfrastructure as a ServicePlatform as a ServiceT1

Properties

Name	Type	Description
input	object	Input text to embed, encoded as a string or array of strings.
user	string	A unique identifier representing your end-user.
input_type	string	The input type for the embedding request.
encoding_format	string	The format to return the embeddings in.
dimensions	integer	The number of dimensions the resulting output embeddings should have.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CreateEmbeddingRequest",
  "title": "CreateEmbeddingRequest",
  "type": "object",
  "description": "Request body for creating embeddings.",
  "properties": {
    "input": {
      "description": "Input text to embed, encoded as a string or array of strings.",
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "array",
          "items": {
            "type": "string"
          },
          "minItems": 1
        }
      ],
      "example": "example_value"
    },
    "user": {
      "type": "string",
      "description": "A unique identifier representing your end-user.",
      "example": "example_value"
    },
    "input_type": {
      "type": "string",
      "description": "The input type for the embedding request.",
      "example": "example_value"
    },
    "encoding_format": {
      "type": "string",
      "enum": [
        "float",
        "base64"
      ],
      "description": "The format to return the embeddings in.",
      "example": "float"
    },
    "dimensions": {
      "type": "integer",
      "minimum": 1,
      "description": "The number of dimensions the resulting output embeddings should have.",
      "example": 10
    }
  },
  "required": [
    "input"
  ]
}