Package co.elastic.clients.elasticsearch.inference

Class UpdateInferenceRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.inference.UpdateInferenceRequest

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class UpdateInferenceRequest
extends RequestBase
implements JsonpSerializable

Update an inference endpoint.

Modify task_settings, secrets (within service_settings), or num_allocations for an inference endpoint, depending on the specific endpoint service and task_type.

IMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Azure, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face. For built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models. However, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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<UpdateInferenceRequest>	_DESERIALIZER
static final Endpoint<UpdateInferenceRequest,UpdateInferenceResponse,ErrorResponse>	_ENDPOINT	Endpoint "inference.update".

Method Summary

Modifier and Type	Method	Description
protected static JsonpDeserializer<UpdateInferenceRequest>	createUpdateInferenceRequestDeserializer()
final InferenceEndpoint	inferenceConfig()	Required - Request body.
final String	inferenceId()	Required - The unique identifier of the inference endpoint.
static UpdateInferenceRequest	of(Function<UpdateInferenceRequest.Builder,ObjectBuilder<UpdateInferenceRequest>> fn)
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this value to JSON.
final TaskType	taskType()	The type of inference task that the model performs.

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<UpdateInferenceRequest> _DESERIALIZER

_ENDPOINT

public static final Endpoint<UpdateInferenceRequest,UpdateInferenceResponse,ErrorResponse> _ENDPOINT

Endpoint "inference.update".

Method Details

of

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

inferenceId

public final String inferenceId()

Required - The unique identifier of the inference endpoint.

API name: inference_id

taskType

@Nullable
public final TaskType taskType()

The type of inference task that the model performs.

API name: task_type

inferenceConfig

public final InferenceEndpoint inferenceConfig()

Required - Request body.

serialize

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

Serialize this value to JSON.

Specified by:

serialize in interface JsonpSerializable

createUpdateInferenceRequestDeserializer

protected static JsonpDeserializer<UpdateInferenceRequest> createUpdateInferenceRequestDeserializer()