Package co.elastic.clients.elasticsearch.inference

Class InferenceRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.inference.InferenceRequest

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class InferenceRequest
extends RequestBase
implements JsonpSerializable

Perform inference on the service

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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

Method Summary

Modifier and Type	Method	Description
final String	inferenceId()	Required - The inference Id
final List<String>	input()	Required - Text input to the model.
static InferenceRequest	of(Function<InferenceRequest.Builder,ObjectBuilder<InferenceRequest>> fn)
final String	query()	Query input, required for rerank task.
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	setupInferenceRequestDeserializer(ObjectDeserializer<InferenceRequest.Builder> op)
final JsonData	taskSettings()	Optional task settings
final TaskType	taskType()	The task type
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<InferenceRequest> _DESERIALIZER

Json deserializer for InferenceRequest

_ENDPOINT

public static final Endpoint<InferenceRequest,InferenceResponse,ErrorResponse> _ENDPOINT

Endpoint "inference.inference".

Method Details

of

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

inferenceId

public final String inferenceId()

Required - The inference Id

API name: inference_id

input

public final List<String> input()

Required - Text input to the model. Either a string or an array of strings.

API name: input

query

@Nullable
public final String query()

Query input, required for rerank task. Not required for other tasks.

API name: query

taskSettings

@Nullable
public final JsonData taskSettings()

Optional task settings

API name: task_settings

taskType

@Nullable
public final TaskType taskType()

The task type

API name: task_type

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)

setupInferenceRequestDeserializer

protected static void setupInferenceRequestDeserializer(ObjectDeserializer<InferenceRequest.Builder> op)