Package co.elastic.clients.elasticsearch.inference

Class PutRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.inference.PutRequest

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class PutRequest
extends RequestBase
implements JsonpSerializable

Create an inference endpoint.

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, Mistral, Azure OpenAI, 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	PutRequest.Builder	Builder for PutRequest.

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<PutRequest>	_DESERIALIZER
static final Endpoint<PutRequest,PutResponse,ErrorResponse>	_ENDPOINT	Endpoint "inference.put".

Method Summary

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

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

_ENDPOINT

public static final Endpoint<PutRequest,PutResponse,ErrorResponse> _ENDPOINT

Endpoint "inference.put".

Method Details

of

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

inferenceId

public final String inferenceId()

Required - The inference Id

API name: inference_id

taskType

@Nullable
public final TaskType taskType()

The task type

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

createPutRequestDeserializer

protected static JsonpDeserializer<PutRequest> createPutRequestDeserializer()