Class DisabledEmbeddingModel

java.lang.Object

dev.langchain4j.model.embedding.DisabledEmbeddingModel

All Implemented Interfaces:

EmbeddingModel

public class DisabledEmbeddingModel
extends Object
implements EmbeddingModel

An EmbeddingModel which throws a ModelDisabledException for all of its methods

This could be used in tests, or in libraries that extend this one to conditionally enable or disable functionality.

Constructor Summary

Constructors

Constructor	Description
DisabledEmbeddingModel()

Method Summary

Modifier and Type	Method	Description
Response<Embedding>	embed(TextSegment textSegment)	Embed the text content of a TextSegment.
Response<Embedding>	embed(String text)	Embed a text.
Response<List<Embedding>>	embedAll(List<TextSegment> textSegments)	Embeds the text content of a list of TextSegments.

Methods inherited from class Object

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

Methods inherited from interface EmbeddingModel

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

Constructor Details

DisabledEmbeddingModel

public DisabledEmbeddingModel()

Method Details

embed

public Response<Embedding> embed(String text)

Description copied from interface: EmbeddingModel

Embed a text.

Specified by:

embed in interface EmbeddingModel

Parameters:

text - the text to embed.

Returns:

the embedding.

embed

public Response<Embedding> embed(TextSegment textSegment)

Description copied from interface: EmbeddingModel

Embed the text content of a TextSegment.

This is a convenience method over EmbeddingModel.embed(EmbeddingRequest), so listeners are notified and the model's default per-call parameters are applied here too.

Specified by:

embed in interface EmbeddingModel

Parameters:

textSegment - the text segment to embed.

Returns:

the embedding.

embedAll

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

Description copied from interface: EmbeddingModel

Embeds the text content of a list of TextSegments.

This is a convenience method over EmbeddingModel.embed(EmbeddingRequest), so listeners are notified and the model's default per-call parameters are applied here too. A provider implements its embedding logic by overriding EmbeddingModel.doEmbed(EmbeddingRequest) (preferred); it may still override this method for batch-specific behavior that the request/response API does not carry (for example applying a document title from TextSegment metadata).

Specified by:

embedAll in interface EmbeddingModel

Parameters:

textSegments - the text segments to embed.

Returns:

the embeddings.