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()
Response<List<Embedding>>	embedAll(List<TextSegment> textSegments)	Embeds the text content of a list of TextSegments.
String	modelName()	Returns the name of the underlying embedding model.
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

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

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.

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