Package dev.langchain4j.model.openai

Class OpenAiEmbeddingModel

java.lang.Object

dev.langchain4j.model.embedding.DimensionAwareEmbeddingModel

dev.langchain4j.model.openai.OpenAiEmbeddingModel

All Implemented Interfaces:

EmbeddingModel, TokenCountEstimator

public class OpenAiEmbeddingModel
extends DimensionAwareEmbeddingModel
implements TokenCountEstimator

Represents an OpenAI embedding model, such as text-embedding-ada-002.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder

Field Summary

Fields inherited from class dev.langchain4j.model.embedding.DimensionAwareEmbeddingModel

dimension

Constructor Summary

Constructors

Constructor	Description
OpenAiEmbeddingModel(String baseUrl, String apiKey, String organizationId, String modelName, Integer dimensions, String user, Duration timeout, Integer maxRetries, Proxy proxy, Boolean logRequests, Boolean logResponses, Tokenizer tokenizer, Map<String,String> customHeaders)

Method Summary

Modifier and Type	Method	Description
static OpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder	builder()
Response<List<Embedding>>	embedAll(List<TextSegment> textSegments)	Embeds the text content of a list of TextSegments.
int	estimateTokenCount(String text)	Estimates the count of tokens in the given text.
protected Integer	knownDimension()	When known (e.g., can be derived from the model name), returns the dimension of the Embedding produced by this embedding model.
String	modelName()
static OpenAiEmbeddingModel	withApiKey(String apiKey)	Deprecated, for removal: This API element is subject to removal in a future version. Please use builder() instead, and explicitly set the model name and, if necessary, other parameters.

Methods inherited from class dev.langchain4j.model.embedding.DimensionAwareEmbeddingModel

dimension

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface dev.langchain4j.model.embedding.EmbeddingModel

embed, embed

Methods inherited from interface dev.langchain4j.model.embedding.TokenCountEstimator

estimateTokenCount, estimateTokenCount

Constructor Details

OpenAiEmbeddingModel

public OpenAiEmbeddingModel(String baseUrl,
 String apiKey,
 String organizationId,
 String modelName,
 Integer dimensions,
 String user,
 Duration timeout,
 Integer maxRetries,
 Proxy proxy,
 Boolean logRequests,
 Boolean logResponses,
 Tokenizer tokenizer,
 Map<String,String> customHeaders)

Method Details

knownDimension

protected Integer knownDimension()

Description copied from class: DimensionAwareEmbeddingModel

When known (e.g., can be derived from the model name), returns the dimension of the Embedding produced by this embedding model. Otherwise, it returns null.

Overrides:

knownDimension in class DimensionAwareEmbeddingModel

Returns:

the known dimension of the Embedding, or null if unknown.

modelName

public String modelName()

embedAll

public Response<List<Embedding>> embedAll(List<TextSegment> textSegments)

Description copied from interface: EmbeddingModel

Embeds the text content of a list of TextSegments.

Specified by:

embedAll in interface EmbeddingModel

Parameters:

textSegments - the text segments to embed.

Returns:

the embeddings.

estimateTokenCount

public int estimateTokenCount(String text)

Description copied from interface: TokenCountEstimator

Estimates the count of tokens in the given text.

Specified by:

estimateTokenCount in interface TokenCountEstimator

Parameters:

text - the text.

Returns:

the estimated count of tokens.

withApiKey

@Deprecated(forRemoval=true)
public static OpenAiEmbeddingModel withApiKey(String apiKey)

Deprecated, for removal: This API element is subject to removal in a future version.

Please use builder() instead, and explicitly set the model name and, if necessary, other parameters. The default value for the model name will be removed in future releases!

builder

public static OpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder builder()