Class OpenAiEmbeddingModel

java.lang.Object

dev.langchain4j.model.embedding.DimensionAwareEmbeddingModel

dev.langchain4j.model.openai.OpenAiEmbeddingModel

All Implemented Interfaces:

EmbeddingModel

public class OpenAiEmbeddingModel
extends DimensionAwareEmbeddingModel

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 DimensionAwareEmbeddingModel

dimension

Constructor Summary

Constructors

Constructor	Description
OpenAiEmbeddingModel(OpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder builder)

Method Summary

Modifier and Type	Method	Description
static OpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder	builder()
EmbeddingRequestParameters	defaultRequestParameters()	The parameters applied to every request unless overridden by the request itself, typically derived from the model's builder-time configuration.
EmbeddingResponse	doEmbed(EmbeddingRequest request)	Performs the embedding for EmbeddingModel.embed(EmbeddingRequest).
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.
List<EmbeddingModelListener>	listeners()	The EmbeddingModelListeners that are notified around EmbeddingModel.embed(EmbeddingRequest).
String	modelName()	Returns the name of the underlying embedding model.
ModelProvider	provider()	The ModelProvider of this embedding model (for example ModelProvider.OPEN_AI).
Set<EmbeddingParameter<?>>	supportedParameters()	The per-call parameters this model honors.

Methods inherited from class DimensionAwareEmbeddingModel

dimension

Methods inherited from class Object

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

Methods inherited from interface EmbeddingModel

addListener, addListeners, embed, embed, embed, embedAll, supportedContentTypes

Constructor Details

OpenAiEmbeddingModel

public OpenAiEmbeddingModel(OpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder builder)

Method Details

listeners

public List<EmbeddingModelListener> listeners()

Description copied from interface: EmbeddingModel

The EmbeddingModelListeners that are notified around EmbeddingModel.embed(EmbeddingRequest). Configure them on the model's builder (via listeners(...)). Defaults to an empty list.

provider

public ModelProvider provider()

Description copied from interface: EmbeddingModel

The ModelProvider of this embedding model (for example ModelProvider.OPEN_AI). It is made available to listeners through the request, response and error contexts. Defaults to ModelProvider.OTHER.

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

Description copied from interface: EmbeddingModel

Returns the name of the underlying embedding model.

Implementations are encouraged to override this method and provide the actual model name. The default implementation returns "unknown", which indicates that the model name is unknown.

Returns:

the model name or a fallback value if not provided

supportedParameters

public Set<EmbeddingParameter<?>> supportedParameters()

Description copied from interface: EmbeddingModel

The per-call parameters this model honors. A request that populates a parameter outside this set is rejected by EmbeddingModel.embed(EmbeddingRequest) with an UnsupportedFeatureException, so a parameter a model cannot apply is never silently ignored. Defaults to an empty set (the model accepts no per-call parameters).

defaultRequestParameters

public EmbeddingRequestParameters defaultRequestParameters()

Description copied from interface: EmbeddingModel

The parameters applied to every request unless overridden by the request itself, typically derived from the model's builder-time configuration. The default is EmbeddingRequestParameters.EMPTY.

doEmbed

public EmbeddingResponse doEmbed(EmbeddingRequest request)

Description copied from interface: EmbeddingModel

Performs the embedding for EmbeddingModel.embed(EmbeddingRequest). This is the low-level method a provider overrides to build the actual API call; EmbeddingModel.embed(EmbeddingRequest) handles per-call parameter validation and listener dispatch around it.

An implementation must override either this method (preferred) or EmbeddingModel.embedAll(List) — the two have mutually-recursive defaults, so overriding neither leads to infinite recursion. The default implementation embeds the text of each input via EmbeddingModel.embedAll(List), which keeps implementations that only provide EmbeddingModel.embedAll(List) working.

When this method is called, the request's parameters have already been merged with EmbeddingModel.defaultRequestParameters() and validated against EmbeddingModel.supportedParameters() and EmbeddingModel.supportedContentTypes().

Parameters:

request - the request, with parameters already merged and validated.

Returns:

the response.

builder

public static OpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder builder()