Package co.elastic.clients.elasticsearch.inference

Class JinaAITaskSettings.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<JinaAITaskSettings.Builder>

co.elastic.clients.elasticsearch.inference.JinaAITaskSettings.Builder

All Implemented Interfaces:

WithJson<JinaAITaskSettings.Builder>, ObjectBuilder<JinaAITaskSettings>

Enclosing class:

JinaAITaskSettings

public static class JinaAITaskSettings.Builder
extends WithJsonObjectBuilderBase<JinaAITaskSettings.Builder>
implements ObjectBuilder<JinaAITaskSettings>

Builder for JinaAITaskSettings.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
JinaAITaskSettings	build()	Builds a JinaAITaskSettings.
final JinaAITaskSettings.Builder	returnDocuments(Boolean value)	For a rerank task, return the doc text within the results.
protected JinaAITaskSettings.Builder	self()
final JinaAITaskSettings.Builder	task(JinaAITextEmbeddingTask value)	For a text_embedding task, the task passed to the model.
final JinaAITaskSettings.Builder	topN(Integer value)	For a rerank task, the number of most relevant documents to return.

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

returnDocuments

public final JinaAITaskSettings.Builder returnDocuments(@Nullable
 Boolean value)

For a rerank task, return the doc text within the results.

API name: return_documents

task

public final JinaAITaskSettings.Builder task(@Nullable
 JinaAITextEmbeddingTask value)

For a text_embedding task, the task passed to the model. Valid values are:

• classification: Use it for embeddings passed through a text classifier.
• clustering: Use it for the embeddings run through a clustering algorithm.
• ingest: Use it for storing document embeddings in a vector database.
• search: Use it for storing embeddings of search queries run against a vector database to find relevant documents.

API name: task

topN

public final JinaAITaskSettings.Builder topN(@Nullable
 Integer value)

For a rerank task, the number of most relevant documents to return. It defaults to the number of the documents. If this inference endpoint is used in a text_similarity_reranker retriever query and top_n is set, it must be greater than or equal to rank_window_size in the query.

API name: top_n

self

protected JinaAITaskSettings.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<JinaAITaskSettings.Builder>

build

public JinaAITaskSettings build()

Builds a JinaAITaskSettings.

Specified by:

build in interface ObjectBuilder<JinaAITaskSettings>

Throws:

NullPointerException - if some of the required fields are null.