Package co.elastic.clients.elasticsearch.ml

Class TextEmbeddingInferenceOptions.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<TextEmbeddingInferenceOptions.Builder>

co.elastic.clients.elasticsearch.ml.TextEmbeddingInferenceOptions.Builder

All Implemented Interfaces:

WithJson<TextEmbeddingInferenceOptions.Builder>, ObjectBuilder<TextEmbeddingInferenceOptions>

Enclosing class:

TextEmbeddingInferenceOptions

public static class TextEmbeddingInferenceOptions.Builder
extends WithJsonObjectBuilderBase<TextEmbeddingInferenceOptions.Builder>
implements ObjectBuilder<TextEmbeddingInferenceOptions>

Builder for TextEmbeddingInferenceOptions.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
TextEmbeddingInferenceOptions	build()	Builds a TextEmbeddingInferenceOptions.
final TextEmbeddingInferenceOptions.Builder	embeddingSize(Integer value)	The number of dimensions in the embedding output
final TextEmbeddingInferenceOptions.Builder	resultsField(String value)	The field that is added to incoming documents to contain the inference prediction.
protected TextEmbeddingInferenceOptions.Builder	self()
final TextEmbeddingInferenceOptions.Builder	tokenization(TokenizationConfig value)	The tokenization options
final TextEmbeddingInferenceOptions.Builder	tokenization(TokenizationConfigVariant value)	The tokenization options
final TextEmbeddingInferenceOptions.Builder	tokenization(Function<TokenizationConfig.Builder,ObjectBuilder<TokenizationConfig>> fn)	The tokenization options
final TextEmbeddingInferenceOptions.Builder	vocabulary(Vocabulary value)	Required - API name: vocabulary
final TextEmbeddingInferenceOptions.Builder	vocabulary(Function<Vocabulary.Builder,ObjectBuilder<Vocabulary>> fn)	Required - API name: vocabulary

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

embeddingSize

public final TextEmbeddingInferenceOptions.Builder embeddingSize(@Nullable
 Integer value)

The number of dimensions in the embedding output

API name: embedding_size

tokenization

public final TextEmbeddingInferenceOptions.Builder tokenization(@Nullable
 TokenizationConfig value)

The tokenization options

API name: tokenization

tokenization

public final TextEmbeddingInferenceOptions.Builder tokenization(Function<TokenizationConfig.Builder,ObjectBuilder<TokenizationConfig>> fn)

The tokenization options

API name: tokenization

tokenization

public final TextEmbeddingInferenceOptions.Builder tokenization(TokenizationConfigVariant value)

The tokenization options

API name: tokenization

resultsField

public final TextEmbeddingInferenceOptions.Builder resultsField(@Nullable
 String value)

The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.

API name: results_field

vocabulary

public final TextEmbeddingInferenceOptions.Builder vocabulary(Vocabulary value)

Required - API name: vocabulary

vocabulary

public final TextEmbeddingInferenceOptions.Builder vocabulary(Function<Vocabulary.Builder,ObjectBuilder<Vocabulary>> fn)

Required - API name: vocabulary

self

protected TextEmbeddingInferenceOptions.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<TextEmbeddingInferenceOptions.Builder>

build

public TextEmbeddingInferenceOptions build()

Builds a TextEmbeddingInferenceOptions.

Specified by:

build in interface ObjectBuilder<TextEmbeddingInferenceOptions>

Throws:

NullPointerException - if some of the required fields are null.