Package co.elastic.clients.elasticsearch.inference

Class OpenShiftAiTaskSettings.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

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

co.elastic.clients.elasticsearch.inference.OpenShiftAiTaskSettings.Builder

All Implemented Interfaces:

WithJson<OpenShiftAiTaskSettings.Builder>, ObjectBuilder<OpenShiftAiTaskSettings>

Enclosing class:

OpenShiftAiTaskSettings

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

Builder for OpenShiftAiTaskSettings.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
OpenShiftAiTaskSettings	build()	Builds a OpenShiftAiTaskSettings.
final OpenShiftAiTaskSettings.Builder	returnDocuments(Boolean value)	For a rerank task, whether to return the source documents in the response.
protected OpenShiftAiTaskSettings.Builder	self()
final OpenShiftAiTaskSettings.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 OpenShiftAiTaskSettings.Builder returnDocuments(@Nullable
 Boolean value)

For a rerank task, whether to return the source documents in the response.

API name: return_documents

topN

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

For a rerank task, the number of most relevant documents to return.

API name: top_n

self

protected OpenShiftAiTaskSettings.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<OpenShiftAiTaskSettings.Builder>

build

public OpenShiftAiTaskSettings build()

Builds a OpenShiftAiTaskSettings.

Specified by:

build in interface ObjectBuilder<OpenShiftAiTaskSettings>

Throws:

NullPointerException - if some of the required fields are null.