Package co.elastic.clients.elasticsearch.ml

Class InferTrainedModelRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

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

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

co.elastic.clients.elasticsearch.ml.InferTrainedModelRequest.Builder

All Implemented Interfaces:

WithJson<InferTrainedModelRequest.Builder>, ObjectBuilder<InferTrainedModelRequest>

Enclosing class:

InferTrainedModelRequest

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

Builder for InferTrainedModelRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
InferTrainedModelRequest	build()	Builds a InferTrainedModelRequest.
final InferTrainedModelRequest.Builder	docs(List<Map<String,JsonData>> list)	Required - An array of objects to pass to the model for inference.
final InferTrainedModelRequest.Builder	docs(Map<String,JsonData> value, Map<String,JsonData>... values)	Required - An array of objects to pass to the model for inference.
final InferTrainedModelRequest.Builder	inferenceConfig(InferenceConfigUpdate value)	The inference configuration updates to apply on the API call
final InferTrainedModelRequest.Builder	inferenceConfig(Function<InferenceConfigUpdate.Builder,ObjectBuilder<InferenceConfigUpdate>> fn)	The inference configuration updates to apply on the API call
final InferTrainedModelRequest.Builder	modelId(String value)	Required - The unique identifier of the trained model.
protected InferTrainedModelRequest.Builder	self()
final InferTrainedModelRequest.Builder	timeout(Time value)	Controls the amount of time to wait for inference results.
final InferTrainedModelRequest.Builder	timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Controls the amount of time to wait for inference results.

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

docs

public final InferTrainedModelRequest.Builder docs(List<Map<String,JsonData>> list)

Required - An array of objects to pass to the model for inference. The objects should contain a fields matching your configured trained model input. Typically, for NLP models, the field name is text_field. Currently, for NLP models, only a single value is allowed.

API name: docs

Adds all elements of list to docs.

docs

public final InferTrainedModelRequest.Builder docs(Map<String,JsonData> value,
 Map<String,JsonData>... values)

Required - An array of objects to pass to the model for inference. The objects should contain a fields matching your configured trained model input. Typically, for NLP models, the field name is text_field. Currently, for NLP models, only a single value is allowed.

API name: docs

Adds one or more values to docs.

inferenceConfig

public final InferTrainedModelRequest.Builder inferenceConfig(@Nullable
 InferenceConfigUpdate value)

The inference configuration updates to apply on the API call

API name: inference_config

inferenceConfig

public final InferTrainedModelRequest.Builder inferenceConfig(Function<InferenceConfigUpdate.Builder,ObjectBuilder<InferenceConfigUpdate>> fn)

The inference configuration updates to apply on the API call

API name: inference_config

modelId

public final InferTrainedModelRequest.Builder modelId(String value)

Required - The unique identifier of the trained model.

API name: model_id

timeout

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

Controls the amount of time to wait for inference results.

API name: timeout

timeout

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

Controls the amount of time to wait for inference results.

API name: timeout

self

protected InferTrainedModelRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<InferTrainedModelRequest.Builder>

build

public InferTrainedModelRequest build()

Builds a InferTrainedModelRequest.

Specified by:

build in interface ObjectBuilder<InferTrainedModelRequest>

Throws:

NullPointerException - if some of the required fields are null.