Package org.opensearch.client.opensearch._types.aggregations

Class ClassificationInferenceOptions.Builder

java.lang.Object

org.opensearch.client.opensearch._types.aggregations.ClassificationInferenceOptions.Builder

All Implemented Interfaces:

ObjectBuilder<ClassificationInferenceOptions>

Enclosing class:

ClassificationInferenceOptions

public static class ClassificationInferenceOptions.Builder
extends java.lang.Object
implements ObjectBuilder<ClassificationInferenceOptions>

Builder for ClassificationInferenceOptions.

Nested Class Summary

Nested classes/interfaces inherited from interface org.opensearch.client.util.ObjectBuilder

ObjectBuilder.Constant<V>

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ClassificationInferenceOptions	build()	Builds a ClassificationInferenceOptions.
ClassificationInferenceOptions.Builder	numTopClasses(java.lang.Number value)	Specifies the number of top class predictions to return.
ClassificationInferenceOptions.Builder	numTopFeatureImportanceValues(java.lang.Number value)	Specifies the maximum number of feature importance values per document.
ClassificationInferenceOptions.Builder	predictionFieldType(java.lang.String value)	Specifies the type of the predicted field to write.
ClassificationInferenceOptions.Builder	resultsField(java.lang.String value)	The field that is added to incoming documents to contain the inference prediction.
ClassificationInferenceOptions.Builder	topClassesResultsField(java.lang.String value)	Specifies the field to which the top classes are written.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

numTopClasses

public ClassificationInferenceOptions.Builder numTopClasses(@Nullable java.lang.Number value)

Specifies the number of top class predictions to return. Defaults to 0. API name: num_top_classes

numTopFeatureImportanceValues

public ClassificationInferenceOptions.Builder numTopFeatureImportanceValues(@Nullable java.lang.Number 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

public ClassificationInferenceOptions.Builder predictionFieldType(@Nullable java.lang.String value)

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

public ClassificationInferenceOptions.Builder resultsField(@Nullable java.lang.String value)

The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. API name: results_field

topClassesResultsField

public ClassificationInferenceOptions.Builder topClassesResultsField(@Nullable java.lang.String value)

Specifies the field to which the top classes are written. Defaults to top_classes. API name: top_classes_results_field

build

public ClassificationInferenceOptions build()

Builds a ClassificationInferenceOptions.

Specified by:

build in interface ObjectBuilder<ClassificationInferenceOptions>

Throws:

java.lang.NullPointerException - if some of the required fields are null.