OpenAI · Schema

CreateEmbeddingRequest

AIArtificial IntelligenceLarge Language ModelsT1

Properties

Name Type Description
model string ID of the model to use. You can use the List Models API to see all available models, or see the Model overview for descriptions.
input string Input text to embed, encoded as a string or array of tokens. To embed multiple inputs in a single request, pass an array of strings or array of token arrays. The input must not exceed the max input to
encoding_format string The format to return the embeddings in. Can be either float or base64. Defaults to float.
dimensions integer The number of dimensions the resulting output embeddings should have. Only supported in text-embedding-3 and later models.
user string A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse.
View JSON Schema on GitHub

JSON Schema

openai-embeddings-create-embedding-request-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "CreateEmbeddingRequest",
  "type": "object",
  "properties": {
    "model": {
      "type": "string",
      "description": "ID of the model to use. You can use the List Models API to see all available models, or see the Model overview for descriptions."
    },
    "input": {
      "type": "string",
      "description": "Input text to embed, encoded as a string or array of tokens. To embed multiple inputs in a single request, pass an array of strings or array of token arrays. The input must not exceed the max input tokens for the model."
    },
    "encoding_format": {
      "type": "string",
      "description": "The format to return the embeddings in. Can be either float or base64. Defaults to float."
    },
    "dimensions": {
      "type": "integer",
      "description": "The number of dimensions the resulting output embeddings should have. Only supported in text-embedding-3 and later models."
    },
    "user": {
      "type": "string",
      "description": "A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse."
    }
  }
}