Package co.elastic.clients.elasticsearch.inference

Class PutElasticsearchRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.inference.PutElasticsearchRequest

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class PutElasticsearchRequest
extends RequestBase
implements JsonpSerializable

Create an Elasticsearch inference endpoint.

Create an inference endpoint to perform an inference task with the elasticsearch service.

info Your Elasticsearch deployment contains preconfigured ELSER and E5 inference endpoints, you only need to create the enpoints using the API if you want to customize the settings.

If you use the ELSER or the E5 model through the elasticsearch service, the API request will automatically download and deploy the model if it isn't downloaded yet.

info You might see a 502 bad gateway error in the response when using the Kibana Console. This error usually just reflects a timeout, while the model downloads in the background. You can check the download progress in the Machine Learning UI. If using the Python client, you can set the timeout parameter to a higher value.

After creating the endpoint, wait for the model deployment to complete before using it. To verify the deployment status, use the get trained model statistics API. Look for "state": "fully_allocated" in the response and ensure that the "allocation_count" matches the "target_allocation_count". Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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<PutElasticsearchRequest>	_DESERIALIZER	Json deserializer for PutElasticsearchRequest
static final Endpoint<PutElasticsearchRequest,PutElasticsearchResponse,ErrorResponse>	_ENDPOINT	Endpoint "inference.put_elasticsearch".

Method Summary

Modifier and Type	Method	Description
final InferenceChunkingSettings	chunkingSettings()	The chunking configuration object.
final String	elasticsearchInferenceId()	Required - The unique identifier of the inference endpoint.
static PutElasticsearchRequest	of(Function<PutElasticsearchRequest.Builder,ObjectBuilder<PutElasticsearchRequest>> 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)
final ElasticsearchServiceType	service()	Required - The type of service supported for the specified task type.
final ElasticsearchServiceSettings	serviceSettings()	Required - Settings used to install the inference model.
protected static void	setupPutElasticsearchRequestDeserializer(ObjectDeserializer<PutElasticsearchRequest.Builder> op)
final ElasticsearchTaskSettings	taskSettings()	Settings to configure the inference task.
final ElasticsearchTaskType	taskType()	Required - The type of the inference task that the model will perform.
final Time	timeout()	Specifies the amount of time to wait for the inference endpoint to be created.

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

Json deserializer for PutElasticsearchRequest

_ENDPOINT

public static final Endpoint<PutElasticsearchRequest,PutElasticsearchResponse,ErrorResponse> _ENDPOINT

Endpoint "inference.put_elasticsearch".

Method Details

of

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

chunkingSettings

@Nullable
public final InferenceChunkingSettings chunkingSettings()

The chunking configuration object.

API name: chunking_settings

elasticsearchInferenceId

public final String elasticsearchInferenceId()

Required - The unique identifier of the inference endpoint. The must not match the model_id.

API name: elasticsearch_inference_id

service

public final ElasticsearchServiceType service()

Required - The type of service supported for the specified task type. In this case, elasticsearch.

API name: service

serviceSettings

public final ElasticsearchServiceSettings serviceSettings()

Required - Settings used to install the inference model. These settings are specific to the elasticsearch service.

API name: service_settings

taskSettings

@Nullable
public final ElasticsearchTaskSettings taskSettings()

Settings to configure the inference task. These settings are specific to the task type you specified.

API name: task_settings

taskType

public final ElasticsearchTaskType taskType()

Required - The type of the inference task that the model will perform.

API name: task_type

timeout

@Nullable
public final Time timeout()

Specifies the amount of time to wait for the inference endpoint to be created.

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)

setupPutElasticsearchRequestDeserializer

protected static void setupPutElasticsearchRequestDeserializer(ObjectDeserializer<PutElasticsearchRequest.Builder> op)