Package co.elastic.clients.elasticsearch.inference

Class RerankRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>

co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<RerankRequest.Builder>

co.elastic.clients.elasticsearch.inference.RerankRequest.Builder

All Implemented Interfaces:

WithJson<RerankRequest.Builder>, ObjectBuilder<RerankRequest>

Enclosing class:

RerankRequest

public static class RerankRequest.Builder
extends RequestBase.AbstractBuilder<RerankRequest.Builder>
implements ObjectBuilder<RerankRequest>

Builder for RerankRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
RerankRequest	build()	Builds a RerankRequest.
final RerankRequest.Builder	inferenceId(String value)	Required - The unique identifier for the inference endpoint.
final RerankRequest.Builder	input(String value, String... values)	Required - The documents to rank.
final RerankRequest.Builder	input(List<String> list)	Required - The documents to rank.
final RerankRequest.Builder	query(String value)	Required - Query input.
final RerankRequest.Builder	returnDocuments(Boolean value)	Include the document text in the response.
protected RerankRequest.Builder	self()
final RerankRequest.Builder	taskSettings(JsonData value)	Task settings for the individual inference request.
final RerankRequest.Builder	timeout(Time value)	The amount of time to wait for the inference request to complete.
final RerankRequest.Builder	timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	The amount of time to wait for the inference request to complete.
final RerankRequest.Builder	topN(Integer value)	Limit the response to the top N documents.

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

inferenceId

public final RerankRequest.Builder inferenceId(String value)

Required - The unique identifier for the inference endpoint.

API name: inference_id

input

public final RerankRequest.Builder input(List<String> list)

Required - The documents to rank.

API name: input

Adds all elements of list to input.

input

public final RerankRequest.Builder input(String value,
 String... values)

Required - The documents to rank.

API name: input

Adds one or more values to input.

query

public final RerankRequest.Builder query(String value)

Required - Query input.

API name: query

returnDocuments

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

Include the document text in the response.

API name: return_documents

taskSettings

public final RerankRequest.Builder taskSettings(@Nullable
 JsonData value)

Task settings for the individual inference request. These settings are specific to the task type you specified and override the task settings specified when initializing the service.

API name: task_settings

timeout

public final RerankRequest.Builder timeout(@Nullable
 Time value)

The amount of time to wait for the inference request to complete.

API name: timeout

timeout

public final RerankRequest.Builder timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

The amount of time to wait for the inference request to complete.

API name: timeout

topN

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

Limit the response to the top N documents.

API name: top_n

self

protected RerankRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<RerankRequest.Builder>

build

public RerankRequest build()

Builds a RerankRequest.

Specified by:

build in interface ObjectBuilder<RerankRequest>

Throws:

NullPointerException - if some of the required fields are null.