Package co.elastic.clients.elasticsearch.inference

Class SparseEmbeddingRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.inference.SparseEmbeddingRequest

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class SparseEmbeddingRequest
extends RequestBase
implements JsonpSerializable

Perform sparse embedding inference on the service.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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

Method Summary

Modifier and Type	Method	Description
final String	inferenceId()	Required - The inference Id
final List<String>	input()	Required - Inference input.
static SparseEmbeddingRequest	of(Function<SparseEmbeddingRequest.Builder,ObjectBuilder<SparseEmbeddingRequest>> fn)
SparseEmbeddingRequest.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	setupSparseEmbeddingRequestDeserializer(ObjectDeserializer<SparseEmbeddingRequest.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<SparseEmbeddingRequest> _DESERIALIZER

Json deserializer for SparseEmbeddingRequest

_ENDPOINT

public static final Endpoint<SparseEmbeddingRequest,SparseEmbeddingResponse,ErrorResponse> _ENDPOINT

Endpoint "inference.sparse_embedding".

Method Details

of

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

Returns:

New SparseEmbeddingRequest.Builder initialized with field values of this instance

setupSparseEmbeddingRequestDeserializer

protected static void setupSparseEmbeddingRequestDeserializer(ObjectDeserializer<SparseEmbeddingRequest.Builder> op)