Class DimensionAwareEmbeddingModel

java.lang.Object

dev.langchain4j.model.embedding.DimensionAwareEmbeddingModel

All Implemented Interfaces:

EmbeddingModel

Direct Known Subclasses:

AbstractInProcessEmbeddingModel, AzureOpenAiEmbeddingModel, BedrockCohereEmbeddingModel, BedrockTitanEmbeddingModel, CohereEmbeddingModel, GitHubModelsEmbeddingModel, GoogleAiEmbeddingModel, GoogleGenAiEmbeddingModel, HuggingFaceEmbeddingModel, JinaEmbeddingModel, JlamaEmbeddingModel, LocalAiEmbeddingModel, MistralAiEmbeddingModel, NomicEmbeddingModel, OllamaEmbeddingModel, OpenAiEmbeddingModel, OpenAiOfficialEmbeddingModel, OracleEmbeddingModel, VertexAiEmbeddingModel, VoyageAiEmbeddingModel

public abstract class DimensionAwareEmbeddingModel
extends Object
implements EmbeddingModel

A dimension aware embedding model

Field Summary

Fields

Modifier and Type	Field	Description
protected Integer	dimension	dimension of embedding

Constructor Summary

Constructors

Constructor	Description
DimensionAwareEmbeddingModel()

Method Summary

Modifier and Type	Method	Description
int	dimension()	Returns the dimension of the Embedding produced by this embedding model.
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.

Methods inherited from class Object

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

Methods inherited from interface EmbeddingModel

addListener, addListeners, defaultRequestParameters, doEmbed, embed, embed, embed, embedAll, listeners, modelName, provider, supportedContentTypes, supportedParameters

Field Details

dimension

protected Integer dimension

dimension of embedding

Constructor Details

DimensionAwareEmbeddingModel

public DimensionAwareEmbeddingModel()

Method Details

knownDimension

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. Otherwise, it returns null.

Returns:

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

dimension

public int dimension()

Description copied from interface: EmbeddingModel

Returns the dimension of the Embedding produced by this embedding model.

Specified by:

dimension in interface EmbeddingModel

Returns:

dimension of the embedding