Embeddings

Create embeddings

embeddings.create(**kwargs) -> CreateEmbeddingResponse

post /embeddings

Creates an embedding vector representing the input text.

Parameters

• input: String | Array[String] | Array[Integer] | Array[Array[Integer]]

  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 (8192 tokens for all embedding models), cannot be an empty string, and any array must be 2048 dimensions or less. Example Python code for counting tokens. In addition to the per-input token limit, all embedding models enforce a maximum of 300,000 tokens summed across all inputs in a single request.

  • String = String

    The string that will be turned into an embedding.

  • ArrayOfStrings = Array[String]

    The array of strings that will be turned into an embedding.

  • ArrayOfTokens = Array[Integer]

    The array of integers that will be turned into an embedding.

  • ArrayOfTokenArrays = Array[Array[Integer]]

    The array of arrays containing integers that will be turned into an embedding.

• model: String | EmbeddingModel

  ID of the model to use. You can use the List models API to see all of your available models, or see our Model overview for descriptions of them.

  • String = String

  • EmbeddingModel = :"text-embedding-ada-002" | :"text-embedding-3-small" | :"text-embedding-3-large"

    • :"text-embedding-ada-002"

    • :"text-embedding-3-small"

    • :"text-embedding-3-large"

• dimensions: Integer

  The number of dimensions the resulting output embeddings should have. Only supported in text-embedding-3 and later models.

• encoding_format: :float | :base64

  The format to return the embeddings in. Can be either float or base64.

  • :float

  • :base64

• user: String

  A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. Learn more.

Returns

• class CreateEmbeddingResponse

  • data: Array[Embedding]

    The list of embeddings generated by the model.

    • embedding: Array[Float]

      The embedding vector, which is a list of floats. The length of vector depends on the model as listed in the embedding guide.

    • index: Integer

      The index of the embedding in the list of embeddings.

    • object: :embedding

      The object type, which is always "embedding".

      • :embedding

  • model: String

    The name of the model used to generate the embedding.

  • object: :list

    The object type, which is always "list".

    • :list

  • usage: Usage{ prompt_tokens, total_tokens}

    The usage information for the request.

    • prompt_tokens: Integer

      The number of tokens used by the prompt.

    • total_tokens: Integer

      The total number of tokens used by the request.

Example

require "openai"

openai = OpenAI::Client.new(api_key: "My API Key")

create_embedding_response = openai.embeddings.create(
  input: "The quick brown fox jumped over the lazy dog",
  model: :"text-embedding-3-small"
)

puts(create_embedding_response)

Response

{
  "data": [
    {
      "embedding": [
        0
      ],
      "index": 0,
      "object": "embedding"
    }
  ],
  "model": "model",
  "object": "list",
  "usage": {
    "prompt_tokens": 0,
    "total_tokens": 0
  }
}

Domain Types

Create Embedding Response

• class CreateEmbeddingResponse

  • data: Array[Embedding]

    The list of embeddings generated by the model.

    • embedding: Array[Float]

      The embedding vector, which is a list of floats. The length of vector depends on the model as listed in the embedding guide.

    • index: Integer

      The index of the embedding in the list of embeddings.

    • object: :embedding

      The object type, which is always "embedding".

      • :embedding

  • model: String

    The name of the model used to generate the embedding.

  • object: :list

    The object type, which is always "list".

    • :list

  • usage: Usage{ prompt_tokens, total_tokens}

    The usage information for the request.

    • prompt_tokens: Integer

      The number of tokens used by the prompt.

    • total_tokens: Integer

      The total number of tokens used by the request.

Embedding

• class Embedding

  Represents an embedding vector returned by embedding endpoint.

  • embedding: Array[Float]

    The embedding vector, which is a list of floats. The length of vector depends on the model as listed in the embedding guide.

  • index: Integer

    The index of the embedding in the list of embeddings.

  • object: :embedding

    The object type, which is always "embedding".

    • :embedding

Embedding Model

• EmbeddingModel = :"text-embedding-ada-002" | :"text-embedding-3-small" | :"text-embedding-3-large"

  • :"text-embedding-ada-002"

  • :"text-embedding-3-small"

  • :"text-embedding-3-large"