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

Class ClassificationInferenceOptions.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

All Implemented Interfaces:

ObjectBuilder<ClassificationInferenceOptions>

Enclosing class:

ClassificationInferenceOptions

public static class ClassificationInferenceOptions.Builder
extends ObjectBuilderBase
implements ObjectBuilder<ClassificationInferenceOptions>

Builder for ClassificationInferenceOptions.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ClassificationInferenceOptions	build()	Builds a ClassificationInferenceOptions.
ClassificationInferenceOptions.Builder	numTopClasses(java.lang.Integer value)	Specifies the number of top class predictions to return.
ClassificationInferenceOptions.Builder	numTopFeatureImportanceValues(java.lang.Integer 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 org.opensearch.client.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

Constructor Detail

Builder

public Builder()

Method Detail

numTopClasses

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

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

API name: num_top_classes

numTopFeatureImportanceValues

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

public final 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 final 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 final 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.