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

Class ClassificationInferenceOptions

java.lang.Object

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

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class ClassificationInferenceOptions
extends java.lang.Object
implements JsonpSerializable

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ClassificationInferenceOptions.Builder	Builder for ClassificationInferenceOptions.

Field Summary

Fields

Modifier and Type	Field	Description
static JsonpDeserializer<ClassificationInferenceOptions>	_DESERIALIZER	Json deserializer for ClassificationInferenceOptions

Method Summary

Modifier and Type	Method	Description
java.lang.Integer	numTopClasses()	Specifies the number of top class predictions to return.
java.lang.Integer	numTopFeatureImportanceValues()	Specifies the maximum number of feature importance values per document.
static ClassificationInferenceOptions	of(java.util.function.Function<ClassificationInferenceOptions.Builder,ObjectBuilder<ClassificationInferenceOptions>> fn)
java.lang.String	predictionFieldType()	Specifies the type of the predicted field to write.
java.lang.String	resultsField()	The field that is added to incoming documents to contain the inference prediction.
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupClassificationInferenceOptionsDeserializer(ObjectDeserializer<ClassificationInferenceOptions.Builder> op)
java.lang.String	topClassesResultsField()	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

Field Detail

_DESERIALIZER

public static final JsonpDeserializer<ClassificationInferenceOptions> _DESERIALIZER

Json deserializer for ClassificationInferenceOptions

Method Detail

of

public static ClassificationInferenceOptions of(java.util.function.Function<ClassificationInferenceOptions.Builder,ObjectBuilder<ClassificationInferenceOptions>> fn)

numTopClasses

@Nullable
public final java.lang.Integer numTopClasses()

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

API name: num_top_classes

numTopFeatureImportanceValues

@Nullable
public final java.lang.Integer numTopFeatureImportanceValues()

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

@Nullable
public final java.lang.String 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

@Nullable
public final java.lang.String resultsField()

The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.

API name: results_field

topClassesResultsField

@Nullable
public final java.lang.String topClassesResultsField()

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

API name: top_classes_results_field

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
                      JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
                                 JsonpMapper mapper)

setupClassificationInferenceOptionsDeserializer

protected static void setupClassificationInferenceOptionsDeserializer(ObjectDeserializer<ClassificationInferenceOptions.Builder> op)