Package co.elastic.clients.elasticsearch.ml

Class InferTrainedModelRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.ml.InferTrainedModelRequest

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class InferTrainedModelRequest
extends RequestBase
implements JsonpSerializable

Evaluates a trained model.

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	InferTrainedModelRequest.Builder	Builder for InferTrainedModelRequest.

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<InferTrainedModelRequest>	_DESERIALIZER	Json deserializer for InferTrainedModelRequest
static final Endpoint<InferTrainedModelRequest,InferTrainedModelResponse,ErrorResponse>	_ENDPOINT	Endpoint "ml.infer_trained_model".

Method Summary

Modifier and Type	Method	Description
final List<Map<String,JsonData>>	docs()	Required - An array of objects to pass to the model for inference.
final InferenceConfigUpdate	inferenceConfig()	The inference configuration updates to apply on the API call
final String	modelId()	Required - The unique identifier of the trained model.
static InferTrainedModelRequest	of(Function<InferTrainedModelRequest.Builder,ObjectBuilder<InferTrainedModelRequest>> fn)
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupInferTrainedModelRequestDeserializer(ObjectDeserializer<InferTrainedModelRequest.Builder> op)
final Time	timeout()	Controls the amount of time to wait for inference results.

Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase

toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

_DESERIALIZER

public static final JsonpDeserializer<InferTrainedModelRequest> _DESERIALIZER

Json deserializer for InferTrainedModelRequest

_ENDPOINT

public static final Endpoint<InferTrainedModelRequest,InferTrainedModelResponse,ErrorResponse> _ENDPOINT

Endpoint "ml.infer_trained_model".

Method Details

of

public static InferTrainedModelRequest of(Function<InferTrainedModelRequest.Builder,ObjectBuilder<InferTrainedModelRequest>> fn)

docs

public final List<Map<String,JsonData>> docs()

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

inferenceConfig

@Nullable
public final InferenceConfigUpdate inferenceConfig()

The inference configuration updates to apply on the API call

API name: inference_config

modelId

public final String modelId()

Required - The unique identifier of the trained model.

API name: model_id

timeout

@Nullable
public final Time timeout()

Controls the amount of time to wait for inference results.

API name: timeout

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

setupInferTrainedModelRequestDeserializer

protected static void setupInferTrainedModelRequestDeserializer(ObjectDeserializer<InferTrainedModelRequest.Builder> op)