Package co.elastic.clients.elasticsearch.inference

Class HuggingFaceTaskSettings.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

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

co.elastic.clients.elasticsearch.inference.HuggingFaceTaskSettings.Builder

All Implemented Interfaces:

WithJson<HuggingFaceTaskSettings.Builder>, ObjectBuilder<HuggingFaceTaskSettings>

Enclosing class:

HuggingFaceTaskSettings

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

Builder for HuggingFaceTaskSettings.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
HuggingFaceTaskSettings	build()	Builds a HuggingFaceTaskSettings.
final HuggingFaceTaskSettings.Builder	returnDocuments(Boolean value)	For a rerank task, return doc text within the results.
protected HuggingFaceTaskSettings.Builder	self()
final HuggingFaceTaskSettings.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 HuggingFaceTaskSettings.Builder returnDocuments(@Nullable
 Boolean value)

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

API name: return_documents

topN

public final HuggingFaceTaskSettings.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.

API name: top_n

self

protected HuggingFaceTaskSettings.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<HuggingFaceTaskSettings.Builder>

build

public HuggingFaceTaskSettings build()

Builds a HuggingFaceTaskSettings.

Specified by:

build in interface ObjectBuilder<HuggingFaceTaskSettings>

Throws:

NullPointerException - if some of the required fields are null.