Class JinaEmbeddingFilter

java.lang.Object

org.apache.tika.metadata.filter.MetadataFilter

org.apache.tika.inference.AbstractEmbeddingFilter

org.apache.tika.inference.OpenAIEmbeddingFilter

org.apache.tika.inference.JinaEmbeddingFilter

All Implemented Interfaces:

Closeable, Serializable, AutoCloseable

public class JinaEmbeddingFilter
extends OpenAIEmbeddingFilter

Extends OpenAIEmbeddingFilter for Jina AI v5 text embeddings.

The only difference from the standard OpenAI format is an optional "task" field in the request body that instructs the Jina model how to optimise the embedding. Supported values include retrieval.passage (default, for indexing documents), retrieval.query (for query-time embeddings), text-matching, classification, and separation.

Configuration key: "jina-embedding-filter"

Since:

Apache Tika 4.0

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
JinaEmbeddingFilter()
JinaEmbeddingFilter(InferenceConfig config)

Method Summary

Modifier and Type	Method	Description
String	getTask()
void	setTask(String task)	Set the Jina task type.

Methods inherited from class OpenAIEmbeddingFilter

embed, getApiKeyHeaderName, getApiKeyPrefix, getEmbeddingsPath, setApiKeyHeaderName, setApiKeyPrefix, setEmbeddingsPath

Methods inherited from class AbstractEmbeddingFilter

filter, getApiKey, getBaseUrl, getContentField, getDefaultConfig, getMaxBatchSize, getMaxChunkChars, getMaxChunks, getModel, getOutputField, getOverlapChars, getTimeoutSeconds, isClearContentAfterChunking, isSkipEmbedding, setApiKey, setBaseUrl, setClearContentAfterChunking, setContentField, setMaxBatchSize, setMaxChunkChars, setMaxChunks, setModel, setOutputField, setOverlapChars, setSkipEmbedding, setTimeoutSeconds

Methods inherited from class MetadataFilter

close, filter

Methods inherited from class Object

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

Constructor Details

JinaEmbeddingFilter

public JinaEmbeddingFilter()

JinaEmbeddingFilter

public JinaEmbeddingFilter(InferenceConfig config)

Method Details

getTask

public String getTask()

setTask

public void setTask(String task)

Set the Jina task type. Default is retrieval.passage. Use retrieval.query when embedding search queries.