Package co.elastic.clients.elasticsearch.inference

Class TextEmbeddingRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.inference.TextEmbeddingRequest

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class TextEmbeddingRequest
extends RequestBase
implements JsonpSerializable

Perform text embedding inference on the service

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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

Method Summary

Modifier and Type	Method	Description
final String	inferenceId()	Required - The inference Id
final List<String>	input()	Required - Inference input.
final String	inputType()	The input data type for the text embedding model.
static TextEmbeddingRequest	of(Function<TextEmbeddingRequest.Builder,ObjectBuilder<TextEmbeddingRequest>> 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)
protected static void	setupTextEmbeddingRequestDeserializer(ObjectDeserializer<TextEmbeddingRequest.Builder> op)
final JsonData	taskSettings()	Optional task settings
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<TextEmbeddingRequest> _DESERIALIZER

Json deserializer for TextEmbeddingRequest

_ENDPOINT

public static final Endpoint<TextEmbeddingRequest,TextEmbeddingResponse,ErrorResponse> _ENDPOINT

Endpoint "inference.text_embedding".

Method Details

of

public static TextEmbeddingRequest of(Function<TextEmbeddingRequest.Builder,ObjectBuilder<TextEmbeddingRequest>> 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

inputType

@Nullable
public final String inputType()

The input data type for the text embedding model. Possible values include:

• SEARCH
• INGEST
• CLASSIFICATION
• CLUSTERING Not all services support all values. Unsupported values will trigger a validation exception. Accepted values depend on the configured inference service, refer to the relevant service-specific documentation for more info.

info The input_type parameter specified on the root level of the request body will take precedence over the input_type parameter specified in task_settings.

API name: input_type

taskSettings

@Nullable
public final JsonData taskSettings()

Optional task settings

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)

setupTextEmbeddingRequestDeserializer

protected static void setupTextEmbeddingRequestDeserializer(ObjectDeserializer<TextEmbeddingRequest.Builder> op)