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
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds aFillMaskInferenceOptions
.The string/token which will be removed from incoming documents and replaced with the inference prediction(s).numTopClasses
(Integer value) Specifies the number of top class predictions to return.resultsField
(String value) The field that is added to incoming documents to contain the inference prediction.protected FillMaskInferenceOptions.Builder
self()
tokenization
(TokenizationConfig value) The tokenization options to update when inferringThe tokenization options to update when inferringMethods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase
withJson
Methods inherited from class co.elastic.clients.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
maskToken
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
Specifies the number of top class predictions to return. Defaults to 0.API name:
num_top_classes
-
tokenization
The tokenization options to update when inferringAPI name:
tokenization
-
tokenization
public final FillMaskInferenceOptions.Builder tokenization(Function<TokenizationConfig.Builder, ObjectBuilder<TokenizationConfig>> fn) The tokenization options to update when inferringAPI name:
tokenization
-
resultsField
The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.API name:
results_field
-
self
- Specified by:
self
in classWithJsonObjectBuilderBase<FillMaskInferenceOptions.Builder>
-
build
Builds aFillMaskInferenceOptions
.- Specified by:
build
in interfaceObjectBuilder<FillMaskInferenceOptions>
- Throws:
NullPointerException
- if some of the required fields are null.
-