Package co.elastic.clients.elasticsearch.ml

Class DataframeEvaluationRegression.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.elasticsearch.ml.DataframeEvaluationRegression.Builder

All Implemented Interfaces:

ObjectBuilder<DataframeEvaluationRegression>

Enclosing class:

DataframeEvaluationRegression

public static class DataframeEvaluationRegression.Builder
extends ObjectBuilderBase
implements ObjectBuilder<DataframeEvaluationRegression>

Builder for DataframeEvaluationRegression.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
DataframeEvaluationRegression.Builder	actualField(java.lang.String value)	Required - The field of the index which contains the ground truth.
DataframeEvaluationRegression	build()	Builds a DataframeEvaluationRegression.
DataframeEvaluationRegression.Builder	metrics(DataframeEvaluationRegressionMetrics value)	Specifies the metrics that are used for the evaluation.
DataframeEvaluationRegression.Builder	metrics(java.util.function.Function<DataframeEvaluationRegressionMetrics.Builder,ObjectBuilder<DataframeEvaluationRegressionMetrics>> fn)	Specifies the metrics that are used for the evaluation.
DataframeEvaluationRegression.Builder	predictedField(java.lang.String value)	Required - The field in the index that contains the predicted value, in other words the results of the regression analysis.

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

Constructor Details

Builder

public Builder()

Method Details

actualField

public final DataframeEvaluationRegression.Builder actualField(java.lang.String value)

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 final DataframeEvaluationRegression.Builder predictedField(java.lang.String value)

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

public final DataframeEvaluationRegression.Builder metrics(@Nullable
DataframeEvaluationRegressionMetrics value)

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

metrics

public final DataframeEvaluationRegression.Builder metrics(java.util.function.Function<DataframeEvaluationRegressionMetrics.Builder,ObjectBuilder<DataframeEvaluationRegressionMetrics>> fn)

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

build

public DataframeEvaluationRegression build()

Builds a DataframeEvaluationRegression.

Specified by:

build in interface ObjectBuilder<DataframeEvaluationRegression>

Throws:

java.lang.NullPointerException - if some of the required fields are null.