Package co.elastic.clients.elasticsearch.ml

Class ClassificationInferenceOptions.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

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

co.elastic.clients.elasticsearch.ml.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

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ClassificationInferenceOptions	build()	Builds a ClassificationInferenceOptions.
final ClassificationInferenceOptions.Builder	numTopClasses(Integer value)	Specifies the number of top class predictions to return.
final ClassificationInferenceOptions.Builder	numTopFeatureImportanceValues(Integer value)	Specifies the maximum number of feature importance values per document.
final ClassificationInferenceOptions.Builder	predictionFieldType(String value)	Specifies the type of the predicted field to write.
final ClassificationInferenceOptions.Builder	resultsField(String value)	The field that is added to incoming documents to contain the inference prediction.
protected ClassificationInferenceOptions.Builder	self()
final ClassificationInferenceOptions.Builder	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

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

numTopClasses

public final ClassificationInferenceOptions.Builder numTopClasses(@Nullable
 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
 Integer value)

Specifies the maximum number of feature importance values per document.

API name: num_top_feature_importance_values

predictionFieldType

public final ClassificationInferenceOptions.Builder predictionFieldType(@Nullable
 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
 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
 String value)

Specifies the field to which the top classes are written. Defaults to top_classes.

API name: top_classes_results_field

self

protected ClassificationInferenceOptions.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<ClassificationInferenceOptions.Builder>

build

public ClassificationInferenceOptions build()

Builds a ClassificationInferenceOptions.

Specified by:

build in interface ObjectBuilder<ClassificationInferenceOptions>

Throws:

NullPointerException - if some of the required fields are null.