Package dev.langchain4j.model.openai

Class OpenAiEmbeddingModel

java.lang.Object

dev.langchain4j.model.embedding.DimensionAwareEmbeddingModel

dev.langchain4j.model.openai.OpenAiEmbeddingModel

All Implemented Interfaces:

dev.langchain4j.model.embedding.EmbeddingModel, dev.langchain4j.model.embedding.TokenCountEstimator

public class OpenAiEmbeddingModel
extends dev.langchain4j.model.embedding.DimensionAwareEmbeddingModel
implements dev.langchain4j.model.embedding.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, dev.langchain4j.model.Tokenizer tokenizer, Map<String,String> customHeaders)

Method Summary

Modifier and Type	Method	Description
static OpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder	builder()
dev.langchain4j.model.output.Response<List<dev.langchain4j.data.embedding.Embedding>>	embedAll(List<dev.langchain4j.data.segment.TextSegment> textSegments)
int	estimateTokenCount(String text)
protected Integer	knownDimension()
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,
 dev.langchain4j.model.Tokenizer tokenizer,
 Map<String,String> customHeaders)

Method Details

knownDimension

protected Integer knownDimension()

Overrides:

knownDimension in class dev.langchain4j.model.embedding.DimensionAwareEmbeddingModel

modelName

public String modelName()

embedAll

public dev.langchain4j.model.output.Response<List<dev.langchain4j.data.embedding.Embedding>> embedAll(List<dev.langchain4j.data.segment.TextSegment> textSegments)

Specified by:

embedAll in interface dev.langchain4j.model.embedding.EmbeddingModel

estimateTokenCount

public int estimateTokenCount(String text)

Specified by:

estimateTokenCount in interface dev.langchain4j.model.embedding.TokenCountEstimator

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()