Package co.elastic.clients.elasticsearch.inference

Class TextEmbeddingRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

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

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

co.elastic.clients.elasticsearch.inference.TextEmbeddingRequest.Builder

All Implemented Interfaces:

WithJson<TextEmbeddingRequest.Builder>, ObjectBuilder<TextEmbeddingRequest>

Enclosing class:

TextEmbeddingRequest

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

Builder for TextEmbeddingRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
TextEmbeddingRequest	build()	Builds a TextEmbeddingRequest.
final TextEmbeddingRequest.Builder	inferenceId(String value)	Required - The inference Id
final TextEmbeddingRequest.Builder	input(String value, String... values)	Required - Inference input.
final TextEmbeddingRequest.Builder	input(List<String> list)	Required - Inference input.
final TextEmbeddingRequest.Builder	inputType(String value)	The input data type for the text embedding model.
protected TextEmbeddingRequest.Builder	self()
final TextEmbeddingRequest.Builder	taskSettings(JsonData value)	Optional task settings
final TextEmbeddingRequest.Builder	timeout(Time value)	Specifies the amount of time to wait for the inference request to complete.
final TextEmbeddingRequest.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 TextEmbeddingRequest.Builder inferenceId(String value)

Required - The inference Id

API name: inference_id

input

public final TextEmbeddingRequest.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 TextEmbeddingRequest.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.

inputType

public final TextEmbeddingRequest.Builder inputType(@Nullable
 String value)

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

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

Optional task settings

API name: task_settings

timeout

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

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

API name: timeout

timeout

public final TextEmbeddingRequest.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 TextEmbeddingRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<TextEmbeddingRequest.Builder>

build

public TextEmbeddingRequest build()

Builds a TextEmbeddingRequest.

Specified by:

build in interface ObjectBuilder<TextEmbeddingRequest>

Throws:

NullPointerException - if some of the required fields are null.