Package co.elastic.clients.elasticsearch.ml

Class DataframeEvaluationRegression

java.lang.Object

co.elastic.clients.elasticsearch.ml.DataframeEvaluationRegression

All Implemented Interfaces:

DataframeEvaluationVariant, JsonpSerializable, UnionVariant

@JsonpDeserializable
public final class DataframeEvaluationRegression
extends java.lang.Object
implements DataframeEvaluationVariant, JsonpSerializable

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
DataframeEvaluationRegression(DataframeEvaluationRegression.Builder builder)
DataframeEvaluationRegression(java.util.function.Function<DataframeEvaluationRegression.Builder,DataframeEvaluationRegression.Builder> fn)

Method Summary

Modifier and Type	Method	Description
java.lang.String	_variantType()	DataframeEvaluation variant type
java.lang.String	actualField()	Required - The field of the index which contains the ground truth.
DataframeEvaluationRegressionMetrics	metrics()	Specifies the metrics that are used for the evaluation.
java.lang.String	predictedField()	Required - The field in the index that contains the predicted value, in other words the results of the regression analysis.
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	setupDataframeEvaluationRegressionDeserializer(DelegatingDeserializer<DataframeEvaluationRegression.Builder> op)

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.elasticsearch.ml.DataframeEvaluationVariant

_toDataframeEvaluation

Field Details

_DESERIALIZER

public static final JsonpDeserializer<DataframeEvaluationRegression> _DESERIALIZER

Json deserializer for DataframeEvaluationRegression

Constructor Details

DataframeEvaluationRegression

public DataframeEvaluationRegression(DataframeEvaluationRegression.Builder builder)

DataframeEvaluationRegression

public DataframeEvaluationRegression(java.util.function.Function<DataframeEvaluationRegression.Builder,DataframeEvaluationRegression.Builder> fn)

Method Details

_variantType

public java.lang.String _variantType()

DataframeEvaluation variant type

Specified by:

_variantType in interface UnionVariant

actualField

public java.lang.String actualField()

Required - The field of the index which contains the ground truth. The data type of this field must be numerical.

API name: actual_field

predictedField

public java.lang.String predictedField()

Required - The field in the index that contains the predicted value, in other words the results of the regression analysis.

API name: predicted_field

metrics

@Nullable
public DataframeEvaluationRegressionMetrics metrics()

Specifies the metrics that are used for the evaluation. For more information on mse, msle, and huber, consult the Jupyter notebook on regression loss functions.

API name: metrics

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)

setupDataframeEvaluationRegressionDeserializer

protected static void setupDataframeEvaluationRegressionDeserializer(DelegatingDeserializer<DataframeEvaluationRegression.Builder> op)