Class JinaEmbeddingModel

java.lang.Object

dev.langchain4j.model.embedding.DimensionAwareEmbeddingModel

dev.langchain4j.model.jina.JinaEmbeddingModel

All Implemented Interfaces:

EmbeddingModel

public class JinaEmbeddingModel
extends DimensionAwareEmbeddingModel

An implementation of an EmbeddingModel that uses Jina Embeddings API.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JinaEmbeddingModel.JinaEmbeddingModelBuilder

Field Summary

Fields inherited from class DimensionAwareEmbeddingModel

dimension

Constructor Summary

Constructors

Constructor	Description
JinaEmbeddingModel(JinaEmbeddingModel.JinaEmbeddingModelBuilder builder)
JinaEmbeddingModel(String baseUrl, String apiKey, String modelName, Duration timeout, Integer maxRetries, Boolean lateChunking, Boolean logRequests, Boolean logResponses)	Deprecated, for removal: This API element is subject to removal in a future version.

Method Summary

Modifier and Type	Method	Description
static JinaEmbeddingModel.JinaEmbeddingModelBuilder	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.

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

JinaEmbeddingModel

@Deprecated(forRemoval=true,
            since="1.4.0")
public JinaEmbeddingModel(String baseUrl,
 String apiKey,
 String modelName,
 Duration timeout,
 Integer maxRetries,
 Boolean lateChunking,
 Boolean logRequests,
 Boolean logResponses)

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

JinaEmbeddingModel

public JinaEmbeddingModel(JinaEmbeddingModel.JinaEmbeddingModelBuilder builder)

Method Details

builder

public static JinaEmbeddingModel.JinaEmbeddingModelBuilder 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