Create embeddings

CreateEmbeddingResponse embeddings().create(, )

POST/embeddings

Creates an embedding vector representing the input text.

ParametersExpand Collapse

EmbeddingCreateParams params

Input input

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

List<String>

List<long>

List<List<long>>

EmbeddingModel model

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.

TEXT_EMBEDDING_ADA_002("text-embedding-ada-002")

TEXT_EMBEDDING_3_SMALL("text-embedding-3-small")

TEXT_EMBEDDING_3_LARGE("text-embedding-3-large")

Optional<Long> dimensions

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

minimum1

Optional<EncodingFormat> encodingFormat

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

FLOAT("float")

BASE64("base64")

Optional<String> user

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

ReturnsExpand Collapse

class CreateEmbeddingResponse:

List<Embedding> data

The list of embeddings generated by the model.

List<double> embedding

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

long index

The index of the embedding in the list of embeddings.

JsonValue; object_

The object type, which is always "embedding".

String model

The name of the model used to generate the embedding.

JsonValue; object_

The object type, which is always "list".

Usage usage

The usage information for the request.

long promptTokens

The number of tokens used by the prompt.

long totalTokens

The total number of tokens used by the request.

Create embeddings

package com.openai.example;

import com.openai.client.OpenAIClient;
import com.openai.client.okhttp.OpenAIOkHttpClient;
import com.openai.models.embeddings.CreateEmbeddingResponse;
import com.openai.models.embeddings.EmbeddingCreateParams;
import com.openai.models.embeddings.EmbeddingModel;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        OpenAIClient client = OpenAIOkHttpClient.fromEnv();

        EmbeddingCreateParams params = EmbeddingCreateParams.builder()
            .input("The quick brown fox jumped over the lazy dog")
            .model(EmbeddingModel.TEXT_EMBEDDING_3_SMALL)
            .build();
        CreateEmbeddingResponse createEmbeddingResponse = client.embeddings().create(params);
    }
}

{
  "object": "list",
  "data": [
    {
      "object": "embedding",
      "embedding": [
        0.0023064255,
        -0.009327292,
        .... (1536 floats total for ada-002)
        -0.0028842222,
      ],
      "index": 0
    }
  ],
  "model": "text-embedding-ada-002",
  "usage": {
    "prompt_tokens": 8,
    "total_tokens": 8
  }
}

Returns Examples

{
  "object": "list",
  "data": [
    {
      "object": "embedding",
      "embedding": [
        0.0023064255,
        -0.009327292,
        .... (1536 floats total for ada-002)
        -0.0028842222,
      ],
      "index": 0
    }
  ],
  "model": "text-embedding-ada-002",
  "usage": {
    "prompt_tokens": 8,
    "total_tokens": 8
  }
}