Package co.elastic.clients.elasticsearch.inference

Class InferenceRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

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

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

co.elastic.clients.elasticsearch.inference.InferenceRequest.Builder

All Implemented Interfaces:

WithJson<InferenceRequest.Builder>, ObjectBuilder<InferenceRequest>

Enclosing class:

InferenceRequest

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

Builder for InferenceRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
InferenceRequest	build()	Builds a InferenceRequest.
final InferenceRequest.Builder	inferenceId(String value)	Required - The unique identifier for the inference endpoint.
final InferenceRequest.Builder	input(String value, String... values)	Required - The text on which you want to perform the inference task.
final InferenceRequest.Builder	input(List<String> list)	Required - The text on which you want to perform the inference task.
final InferenceRequest.Builder	query(String value)	The query input, which is required only for the rerank task.
protected InferenceRequest.Builder	self()
final InferenceRequest.Builder	taskSettings(JsonData value)	Task settings for the individual inference request.
final InferenceRequest.Builder	taskType(TaskType value)	The type of inference task that the model performs.
final InferenceRequest.Builder	timeout(Time value)	The amount of time to wait for the inference request to complete.
final InferenceRequest.Builder	timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	The amount of time to wait for the inference request to complete.

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 InferenceRequest.Builder inferenceId(String value)

Required - The unique identifier for the inference endpoint.

API name: inference_id

input

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

Required - The text on which you want to perform the inference task. It can be a single string or an array.

info Inference endpoints for the completion task type currently only support a single string as input.

API name: input

Adds all elements of list to input.

input

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

Required - The text on which you want to perform the inference task. It can be a single string or an array.

info Inference endpoints for the completion task type currently only support a single string as input.

API name: input

Adds one or more values to input.

query

public final InferenceRequest.Builder query(@Nullable
 String value)

The query input, which is required only for the rerank task. It is not required for other tasks.

API name: query

taskSettings

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

taskType

public final InferenceRequest.Builder taskType(@Nullable
 TaskType value)

The type of inference task that the model performs.

API name: task_type

timeout

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

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

API name: timeout

timeout

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

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

API name: timeout

self

protected InferenceRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<InferenceRequest.Builder>

build

public InferenceRequest build()

Builds a InferenceRequest.

Specified by:

build in interface ObjectBuilder<InferenceRequest>

Throws:

NullPointerException - if some of the required fields are null.