Package co.elastic.clients.elasticsearch.ml

Class FillMaskInferenceOptions.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

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

co.elastic.clients.elasticsearch.ml.FillMaskInferenceOptions.Builder

All Implemented Interfaces:

WithJson<FillMaskInferenceOptions.Builder>, ObjectBuilder<FillMaskInferenceOptions>

Enclosing class:

FillMaskInferenceOptions

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

Builder for FillMaskInferenceOptions.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
FillMaskInferenceOptions	build()	Builds a FillMaskInferenceOptions.
final FillMaskInferenceOptions.Builder	maskToken(String value)	The string/token which will be removed from incoming documents and replaced with the inference prediction(s).
final FillMaskInferenceOptions.Builder	numTopClasses(Integer value)	Specifies the number of top class predictions to return.
final FillMaskInferenceOptions.Builder	resultsField(String value)	The field that is added to incoming documents to contain the inference prediction.
protected FillMaskInferenceOptions.Builder	self()
final FillMaskInferenceOptions.Builder	tokenization(TokenizationConfig value)	The tokenization options to update when inferring
final FillMaskInferenceOptions.Builder	tokenization(TokenizationConfigVariant value)	The tokenization options to update when inferring
final FillMaskInferenceOptions.Builder	tokenization(Function<TokenizationConfig.Builder,ObjectBuilder<TokenizationConfig>> fn)	The tokenization options to update when inferring
final FillMaskInferenceOptions.Builder	vocabulary(Vocabulary value)	API name: vocabulary
final FillMaskInferenceOptions.Builder	vocabulary(Function<Vocabulary.Builder,ObjectBuilder<Vocabulary>> fn)	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

maskToken

public final FillMaskInferenceOptions.Builder maskToken(@Nullable
 String value)

The string/token which will be removed from incoming documents and replaced with the inference prediction(s). In a response, this field contains the mask token for the specified model/tokenizer. Each model and tokenizer has a predefined mask token which cannot be changed. Thus, it is recommended not to set this value in requests. However, if this field is present in a request, its value must match the predefined value for that model/tokenizer, otherwise the request will fail.

API name: mask_token

numTopClasses

public final FillMaskInferenceOptions.Builder numTopClasses(@Nullable
 Integer value)

Specifies the number of top class predictions to return. Defaults to 0.

API name: num_top_classes

tokenization

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

The tokenization options to update when inferring

API name: tokenization

tokenization

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

The tokenization options to update when inferring

API name: tokenization

tokenization

public final FillMaskInferenceOptions.Builder tokenization(TokenizationConfigVariant value)

The tokenization options to update when inferring

API name: tokenization

resultsField

public final FillMaskInferenceOptions.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 FillMaskInferenceOptions.Builder vocabulary(@Nullable
 Vocabulary value)

API name: vocabulary

vocabulary

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

API name: vocabulary

self

protected FillMaskInferenceOptions.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<FillMaskInferenceOptions.Builder>

build

public FillMaskInferenceOptions build()

Builds a FillMaskInferenceOptions.

Specified by:

build in interface ObjectBuilder<FillMaskInferenceOptions>

Throws:

NullPointerException - if some of the required fields are null.