Package co.elastic.clients.elasticsearch.inference

Class ContextualAITaskSettings.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

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

co.elastic.clients.elasticsearch.inference.ContextualAITaskSettings.Builder

All Implemented Interfaces:

WithJson<ContextualAITaskSettings.Builder>, ObjectBuilder<ContextualAITaskSettings>

Enclosing class:

ContextualAITaskSettings

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

Builder for ContextualAITaskSettings.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ContextualAITaskSettings	build()	Builds a ContextualAITaskSettings.
final ContextualAITaskSettings.Builder	instruction(String value)	Instructions for the reranking model.
final ContextualAITaskSettings.Builder	returnDocuments(Boolean value)	Whether to return the source documents in the response.
protected ContextualAITaskSettings.Builder	self()
final ContextualAITaskSettings.Builder	topK(Integer value)	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

instruction

public final ContextualAITaskSettings.Builder instruction(@Nullable
 String value)

Instructions for the reranking model. Refer to https://docs.contextual.ai/api-reference/rerank/rerank#body-instruction Only for the rerank task type.

API name: instruction

returnDocuments

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

Whether to return the source documents in the response. Only for the rerank task type.

API name: return_documents

topK

public final ContextualAITaskSettings.Builder topK(@Nullable
 Integer value)

The number of most relevant documents to return. If not specified, the reranking results of all documents will be returned. Only for the rerank task type.

API name: top_k

self

protected ContextualAITaskSettings.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<ContextualAITaskSettings.Builder>

build

public ContextualAITaskSettings build()

Builds a ContextualAITaskSettings.

Specified by:

build in interface ObjectBuilder<ContextualAITaskSettings>

Throws:

NullPointerException - if some of the required fields are null.