Package co.elastic.clients.elasticsearch.ml

Class DataframeEvaluationClassification.Builder

java.lang.Object

co.elastic.clients.elasticsearch.ml.DataframeEvaluationClassification.Builder

All Implemented Interfaces:

ObjectBuilder<DataframeEvaluationClassification>

Enclosing class:

DataframeEvaluationClassification

public static class DataframeEvaluationClassification.Builder
extends java.lang.Object
implements ObjectBuilder<DataframeEvaluationClassification>

Builder for DataframeEvaluationClassification.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
DataframeEvaluationClassification.Builder	actualField(java.lang.String value)	Required - The field of the index which contains the ground truth.
DataframeEvaluationClassification	build()	Builds a DataframeEvaluationClassification.
DataframeEvaluationClassification.Builder	metrics(DataframeEvaluationClassificationMetrics value)	Specifies the metrics that are used for the evaluation.
DataframeEvaluationClassification.Builder	metrics(java.util.function.Function<DataframeEvaluationClassificationMetrics.Builder,ObjectBuilder<DataframeEvaluationClassificationMetrics>> fn)	Specifies the metrics that are used for the evaluation.
DataframeEvaluationClassification.Builder	predictedField(java.lang.String value)	The field in the index which contains the predicted value, in other words the results of the classification analysis.
DataframeEvaluationClassification.Builder	topClassesField(java.lang.String value)	The field of the index which is an array of documents of the form { "class_name": XXX, "class_probability": YYY }.

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 DataframeEvaluationClassification.Builder actualField(java.lang.String value)

Required - The field of the index which contains the ground truth. The data type of this field can be boolean or integer. If the data type is integer, the value has to be either 0 (false) or 1 (true).

API name: actual_field

predictedField

public DataframeEvaluationClassification.Builder predictedField(@Nullable
java.lang.String value)

The field in the index which contains the predicted value, in other words the results of the classification analysis.

API name: predicted_field

topClassesField

public DataframeEvaluationClassification.Builder topClassesField(@Nullable
java.lang.String value)

The field of the index which is an array of documents of the form { "class_name": XXX, "class_probability": YYY }. This field must be defined as nested in the mappings.

API name: top_classes_field

metrics

public DataframeEvaluationClassification.Builder metrics(@Nullable
DataframeEvaluationClassificationMetrics value)

Specifies the metrics that are used for the evaluation.

API name: metrics

metrics

public DataframeEvaluationClassification.Builder metrics(java.util.function.Function<DataframeEvaluationClassificationMetrics.Builder,ObjectBuilder<DataframeEvaluationClassificationMetrics>> fn)

Specifies the metrics that are used for the evaluation.

API name: metrics

build

public DataframeEvaluationClassification build()

Builds a DataframeEvaluationClassification.

Specified by:

build in interface ObjectBuilder<DataframeEvaluationClassification>

Throws:

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