Package co.elastic.clients.elasticsearch.ml

Class DataframeEvaluationClassification.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<DataframeEvaluationClassification.Builder>

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

All Implemented Interfaces:

WithJson<DataframeEvaluationClassification.Builder>, ObjectBuilder<DataframeEvaluationClassification>

Enclosing class:

DataframeEvaluationClassification

public static class DataframeEvaluationClassification.Builder
extends WithJsonObjectBuilderBase<DataframeEvaluationClassification.Builder>
implements ObjectBuilder<DataframeEvaluationClassification>

Builder for DataframeEvaluationClassification.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final DataframeEvaluationClassification.Builder	actualField(String value)	Required - The field of the index which contains the ground truth.
DataframeEvaluationClassification	build()	Builds a DataframeEvaluationClassification.
final DataframeEvaluationClassification.Builder	metrics(DataframeEvaluationClassificationMetrics value)	Specifies the metrics that are used for the evaluation.
final DataframeEvaluationClassification.Builder	metrics(Function<DataframeEvaluationClassificationMetrics.Builder,ObjectBuilder<DataframeEvaluationClassificationMetrics>> fn)	Specifies the metrics that are used for the evaluation.
final DataframeEvaluationClassification.Builder	predictedField(String value)	The field in the index which contains the predicted value, in other words the results of the classification analysis.
protected DataframeEvaluationClassification.Builder	self()
final DataframeEvaluationClassification.Builder	topClassesField(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 co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

actualField

public final DataframeEvaluationClassification.Builder actualField(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 final DataframeEvaluationClassification.Builder predictedField(@Nullable
 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 final DataframeEvaluationClassification.Builder topClassesField(@Nullable
 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 final DataframeEvaluationClassification.Builder metrics(@Nullable
 DataframeEvaluationClassificationMetrics value)

Specifies the metrics that are used for the evaluation.

API name: metrics

metrics

public final DataframeEvaluationClassification.Builder metrics(Function<DataframeEvaluationClassificationMetrics.Builder,ObjectBuilder<DataframeEvaluationClassificationMetrics>> fn)

Specifies the metrics that are used for the evaluation.

API name: metrics

self

protected DataframeEvaluationClassification.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<DataframeEvaluationClassification.Builder>

build

public DataframeEvaluationClassification build()

Builds a DataframeEvaluationClassification.

Specified by:

build in interface ObjectBuilder<DataframeEvaluationClassification>

Throws:

NullPointerException - if some of the required fields are null.