Package co.elastic.clients.elasticsearch.ml

Class DataframeEvaluationOutlierDetection.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

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

co.elastic.clients.elasticsearch.ml.DataframeEvaluationOutlierDetection.Builder

All Implemented Interfaces:

WithJson<DataframeEvaluationOutlierDetection.Builder>, ObjectBuilder<DataframeEvaluationOutlierDetection>

Enclosing class:

DataframeEvaluationOutlierDetection

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

Builder for DataframeEvaluationOutlierDetection.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
DataframeEvaluationOutlierDetection.Builder	actualField(java.lang.String value)	Required - The field of the index which contains the ground truth.
DataframeEvaluationOutlierDetection	build()	Builds a DataframeEvaluationOutlierDetection.
DataframeEvaluationOutlierDetection.Builder	metrics(DataframeEvaluationOutlierDetectionMetrics value)	Specifies the metrics that are used for the evaluation.
DataframeEvaluationOutlierDetection.Builder	metrics(java.util.function.Function<DataframeEvaluationOutlierDetectionMetrics.Builder,ObjectBuilder<DataframeEvaluationOutlierDetectionMetrics>> fn)	Specifies the metrics that are used for the evaluation.
DataframeEvaluationOutlierDetection.Builder	predictedProbabilityField(java.lang.String value)	Required - The field of the index that defines the probability of whether the item belongs to the class in question or not.
protected DataframeEvaluationOutlierDetection.Builder	self()

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 DataframeEvaluationOutlierDetection.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

predictedProbabilityField

public final DataframeEvaluationOutlierDetection.Builder predictedProbabilityField(java.lang.String value)

Required - The field of the index that defines the probability of whether the item belongs to the class in question or not. It’s the field that contains the results of the analysis.

API name: predicted_probability_field

metrics

public final DataframeEvaluationOutlierDetection.Builder metrics(@Nullable
DataframeEvaluationOutlierDetectionMetrics value)

Specifies the metrics that are used for the evaluation.

API name: metrics

metrics

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

Specifies the metrics that are used for the evaluation.

API name: metrics

self

protected DataframeEvaluationOutlierDetection.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<DataframeEvaluationOutlierDetection.Builder>

build

public DataframeEvaluationOutlierDetection build()

Builds a DataframeEvaluationOutlierDetection.

Specified by:

build in interface ObjectBuilder<DataframeEvaluationOutlierDetection>

Throws:

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