Package co.elastic.clients.elasticsearch.inference

Class SparseEmbeddingRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>

co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<SparseEmbeddingRequest.Builder>

co.elastic.clients.elasticsearch.inference.SparseEmbeddingRequest.Builder

All Implemented Interfaces:

WithJson<SparseEmbeddingRequest.Builder>, ObjectBuilder<SparseEmbeddingRequest>

Enclosing class:

SparseEmbeddingRequest

public static class SparseEmbeddingRequest.Builder
extends RequestBase.AbstractBuilder<SparseEmbeddingRequest.Builder>
implements ObjectBuilder<SparseEmbeddingRequest>

Builder for SparseEmbeddingRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SparseEmbeddingRequest	build()	Builds a SparseEmbeddingRequest.
final SparseEmbeddingRequest.Builder	inferenceId(String value)	Required - The inference Id
final SparseEmbeddingRequest.Builder	input(String value, String... values)	Required - Inference input.
final SparseEmbeddingRequest.Builder	input(List<String> list)	Required - Inference input.
protected SparseEmbeddingRequest.Builder	self()
final SparseEmbeddingRequest.Builder	taskSettings(JsonData value)	Optional task settings
final SparseEmbeddingRequest.Builder	timeout(Time value)	Specifies the amount of time to wait for the inference request to complete.
final SparseEmbeddingRequest.Builder	timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Specifies the amount of time to wait for the inference request to complete.

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

inferenceId

public final SparseEmbeddingRequest.Builder inferenceId(String value)

Required - The inference Id

API name: inference_id

input

public final SparseEmbeddingRequest.Builder input(List<String> list)

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

API name: input

Adds all elements of list to input.

input

public final SparseEmbeddingRequest.Builder input(String value,
 String... values)

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

API name: input

Adds one or more values to input.

taskSettings

public final SparseEmbeddingRequest.Builder taskSettings(@Nullable
 JsonData value)

Optional task settings

API name: task_settings

timeout

public final SparseEmbeddingRequest.Builder timeout(@Nullable
 Time value)

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

API name: timeout

timeout

public final SparseEmbeddingRequest.Builder timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

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

API name: timeout

self

protected SparseEmbeddingRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<SparseEmbeddingRequest.Builder>

build

public SparseEmbeddingRequest build()

Builds a SparseEmbeddingRequest.

Specified by:

build in interface ObjectBuilder<SparseEmbeddingRequest>

Throws:

NullPointerException - if some of the required fields are null.