Class CohereEmbeddingModel

java.lang.Object

dev.langchain4j.model.embedding.DimensionAwareEmbeddingModel

dev.langchain4j.model.cohere.CohereEmbeddingModel

All Implemented Interfaces:

EmbeddingModel

public class CohereEmbeddingModel
extends DimensionAwareEmbeddingModel

An implementation of an EmbeddingModel that uses Cohere Embed API.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CohereEmbeddingModel.CohereEmbeddingModelBuilder

Field Summary

Fields inherited from class DimensionAwareEmbeddingModel

dimension

Constructor Summary

Constructors

Constructor	Description
CohereEmbeddingModel(CohereEmbeddingModel.CohereEmbeddingModelBuilder builder)
CohereEmbeddingModel(String baseUrl, String apiKey, String modelName, String inputType, Duration timeout, Boolean logRequests, Boolean logResponses, Integer maxSegmentsPerBatch)	Deprecated, for removal: This API element is subject to removal in a future version.

Method Summary

Modifier and Type	Method	Description
static CohereEmbeddingModel.CohereEmbeddingModelBuilder	builder()
EmbeddingResponse	doEmbed(EmbeddingRequest request)	Embeds via Cohere's v2 embed endpoint (/v2/embed), which handles both text and images (Embed v4).
Response<List<Embedding>>	embedAll(List<TextSegment> textSegments)	Embeds the text content of a list of TextSegments.
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<ContentType>	supportedContentTypes()	The input content types this model can embed.
Set<EmbeddingParameter<?>>	supportedParameters()	The per-call parameters this model honors.
static CohereEmbeddingModel	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 DimensionAwareEmbeddingModel

dimension, knownDimension

Methods inherited from class Object

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

Methods inherited from interface EmbeddingModel

addListener, addListeners, defaultRequestParameters, embed, embed, embed

Constructor Details

CohereEmbeddingModel

@Deprecated(forRemoval=true,
            since="1.4.0")
public CohereEmbeddingModel(String baseUrl,
 String apiKey,
 String modelName,
 String inputType,
 Duration timeout,
 Boolean logRequests,
 Boolean logResponses,
 Integer maxSegmentsPerBatch)

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

CohereEmbeddingModel

public CohereEmbeddingModel(CohereEmbeddingModel.CohereEmbeddingModelBuilder 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.

withApiKey

@Deprecated(forRemoval=true)
public static CohereEmbeddingModel 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.

builder

public static CohereEmbeddingModel.CohereEmbeddingModelBuilder builder()

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

Parameters:

textSegments - the text segments to embed.

Returns:

the embeddings.

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

supportedContentTypes

public Set<ContentType> supportedContentTypes()

Description copied from interface: EmbeddingModel

The input content types this model can embed. A request whose inputs use a content type outside this set is rejected by EmbeddingModel.embed(EmbeddingRequest) with an UnsupportedFeatureException. Defaults to {TEXT}; a multimodal model overrides this to also accept, for example, images.

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

doEmbed

public EmbeddingResponse doEmbed(EmbeddingRequest request)

Embeds via Cohere's v2 embed endpoint (/v2/embed), which handles both text and images (Embed v4). Each EmbeddingInput may interleave text and image parts into a single embedding.

Parameters:

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

Returns:

the response.