Package co.elastic.clients.elasticsearch.inference

Class EmbeddingRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.inference.EmbeddingRequest

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class EmbeddingRequest
extends RequestBase
implements JsonpSerializable

Perform dense embedding inference on the service.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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<EmbeddingRequest>	_DESERIALIZER
static final Endpoint<EmbeddingRequest,EmbeddingResponse,ErrorResponse>	_ENDPOINT	Endpoint "inference.embedding".

Method Summary

Modifier and Type	Method	Description
protected static JsonpDeserializer<EmbeddingRequest>	createEmbeddingRequestDeserializer()
final RequestEmbedding	embedding()	Required - Request body.
final String	inferenceId()	Required - The inference Id
static EmbeddingRequest	of(Function<EmbeddingRequest.Builder,ObjectBuilder<EmbeddingRequest>> fn)
EmbeddingRequest.Builder	rebuild()
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this value to JSON.
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<EmbeddingRequest> _DESERIALIZER

_ENDPOINT

public static final Endpoint<EmbeddingRequest,EmbeddingResponse,ErrorResponse> _ENDPOINT

Endpoint "inference.embedding".

Method Details

of

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

inferenceId

public final String inferenceId()

Required - The inference Id

API name: inference_id

timeout

@Nullable
public final Time timeout()

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

API name: timeout

embedding

public final RequestEmbedding embedding()

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

rebuild

public EmbeddingRequest.Builder rebuild()

Returns:

New EmbeddingRequest.Builder initialized with field values of this instance

createEmbeddingRequestDeserializer

protected static JsonpDeserializer<EmbeddingRequest> createEmbeddingRequestDeserializer()