Class ClassificationInferenceOptions.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<ClassificationInferenceOptions.Builder>
co.elastic.clients.elasticsearch._types.aggregations.ClassificationInferenceOptions.Builder
- All Implemented Interfaces:
WithJson<ClassificationInferenceOptions.Builder>
,ObjectBuilder<ClassificationInferenceOptions>
- Enclosing class:
- ClassificationInferenceOptions
public static class ClassificationInferenceOptions.Builder
extends WithJsonObjectBuilderBase<ClassificationInferenceOptions.Builder>
implements ObjectBuilder<ClassificationInferenceOptions>
Builder for
ClassificationInferenceOptions
.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds aClassificationInferenceOptions
.numTopClasses
(Integer value) Specifies the number of top class predictions to return.Specifies the maximum number of feature importance values per document.predictionFieldType
(String value) Specifies the type of the predicted field to write.resultsField
(String value) The field that is added to incoming documents to contain the inference prediction.protected ClassificationInferenceOptions.Builder
self()
topClassesResultsField
(String value) Specifies the field to which the top classes are written.Methods 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
-
numTopClasses
Specifies the number of top class predictions to return. Defaults to 0.API name:
num_top_classes
-
numTopFeatureImportanceValues
public final ClassificationInferenceOptions.Builder numTopFeatureImportanceValues(@Nullable Integer value) Specifies the maximum number of feature importance values per document. By default, it is zero and no feature importance calculation occurs.API name:
num_top_feature_importance_values
-
predictionFieldType
Specifies the type of the predicted field to write. Acceptable values are: string, number, boolean. When boolean is provided 1.0 is transformed to true and 0.0 to false.API name:
prediction_field_type
-
resultsField
The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.API name:
results_field
-
topClassesResultsField
Specifies the field to which the top classes are written. Defaults to top_classes.API name:
top_classes_results_field
-
self
- Specified by:
self
in classWithJsonObjectBuilderBase<ClassificationInferenceOptions.Builder>
-
build
Builds aClassificationInferenceOptions
.- Specified by:
build
in interfaceObjectBuilder<ClassificationInferenceOptions>
- Throws:
NullPointerException
- if some of the required fields are null.
-