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

Class RegressionInferenceOptions

java.lang.Object

org.opensearch.client.opensearch._types.aggregations.RegressionInferenceOptions

All Implemented Interfaces:

JsonpSerializable

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

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
java.lang.Integer	numTopFeatureImportanceValues()	Specifies the maximum number of feature importance values per document.
static RegressionInferenceOptions	of(java.util.function.Function<RegressionInferenceOptions.Builder,ObjectBuilder<RegressionInferenceOptions>> fn)
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	setupRegressionInferenceOptionsDeserializer(ObjectDeserializer<RegressionInferenceOptions.Builder> op)

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<RegressionInferenceOptions> _DESERIALIZER

Json deserializer for RegressionInferenceOptions

Method Detail

of

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

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

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

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)

setupRegressionInferenceOptionsDeserializer

protected static void setupRegressionInferenceOptionsDeserializer(ObjectDeserializer<RegressionInferenceOptions.Builder> op)