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

Class RegressionInferenceOptions

java.lang.Object

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

All Implemented Interfaces:

ToJsonp

public final class RegressionInferenceOptions
extends java.lang.Object
implements ToJsonp

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	RegressionInferenceOptions(RegressionInferenceOptions.Builder builder)

Method Summary

Modifier and Type	Method	Description
java.lang.Number	numTopFeatureImportanceValues()	Specifies the maximum number of feature importance values per document.
java.lang.String	resultsField()	The field that is added to incoming documents to contain the inference prediction.
protected static void	setupRegressionInferenceOptionsDeserializer(DelegatingDeserializer<RegressionInferenceOptions.Builder> op)
void	toJsonp(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	toJsonpInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)

Methods inherited from class java.lang.Object

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

Field Details

DESERIALIZER

public static final JsonpDeserializer<RegressionInferenceOptions> DESERIALIZER

Json deserializer for RegressionInferenceOptions

Constructor Details

RegressionInferenceOptions

protected RegressionInferenceOptions(RegressionInferenceOptions.Builder builder)

Method Details

resultsField

public 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 java.lang.Number 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

toJsonp

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

Serialize this object to JSON.

Specified by:

toJsonp in interface ToJsonp

toJsonpInternal

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

setupRegressionInferenceOptionsDeserializer

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