Package co.elastic.clients.elasticsearch.inference

Class CompletionRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.inference.CompletionRequest

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class CompletionRequest
extends RequestBase
implements JsonpSerializable

Perform completion inference on the service.

Get responses for completion tasks. This API works only with the completion 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.

This API requires the monitor_inference cluster privilege (the built-in inference_admin and inference_user roles grant this privilege).

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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<CompletionRequest>	_DESERIALIZER	Json deserializer for CompletionRequest
static final Endpoint<CompletionRequest,CompletionResponse,ErrorResponse>	_ENDPOINT	Endpoint "inference.completion".

Method Summary

Modifier and Type	Method	Description
final String	inferenceId()	Required - The inference Id
final List<String>	input()	Required - Inference input.
static CompletionRequest	of(Function<CompletionRequest.Builder,ObjectBuilder<CompletionRequest>> fn)
CompletionRequest.Builder	rebuild()
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	setupCompletionRequestDeserializer(ObjectDeserializer<CompletionRequest.Builder> op)
final JsonData	taskSettings()	Task settings for the individual inference request.
final Time	timeout()	Specifies the amount of time to wait for the inference request to complete.

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

Json deserializer for CompletionRequest

_ENDPOINT

public static final Endpoint<CompletionRequest,CompletionResponse,ErrorResponse> _ENDPOINT

Endpoint "inference.completion".

Method Details

of

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

inferenceId

public final String inferenceId()

Required - The inference Id

API name: inference_id

input

public final List<String> input()

Required - Inference input. Either a string or an array of strings.

API name: input

taskSettings

@Nullable
public final JsonData taskSettings()

Task settings for the individual inference request. These settings are specific to the <task_type> you specified and override the task settings specified when initializing the service.

API name: task_settings

timeout

@Nullable
public final Time timeout()

Specifies the amount of time to wait for the inference request to complete.

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)

rebuild

public CompletionRequest.Builder rebuild()

Returns:

New CompletionRequest.Builder initialized with field values of this instance

setupCompletionRequestDeserializer

protected static void setupCompletionRequestDeserializer(ObjectDeserializer<CompletionRequest.Builder> op)