Package co.elastic.clients.elasticsearch.ml

Class DataframeEvaluationClassification

java.lang.Object

co.elastic.clients.elasticsearch.ml.DataframeEvaluationClassification

All Implemented Interfaces:

DataframeEvaluationVariant, JsonpSerializable

@JsonpDeserializable
public class DataframeEvaluationClassification
extends Object
implements DataframeEvaluationVariant, JsonpSerializable

See Also:

• API specification

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
DataframeEvaluation.Kind	_dataframeEvaluationKind()	DataframeEvaluation variant kind.
final String	actualField()	Required - The field of the index which contains the ground truth.
final DataframeEvaluationClassificationMetrics	metrics()	Specifies the metrics that are used for the evaluation.
static DataframeEvaluationClassification	of(Function<DataframeEvaluationClassification.Builder,ObjectBuilder<DataframeEvaluationClassification>> fn)
final String	predictedField()	The field in the index which contains the predicted value, in other words the results of the classification 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	setupDataframeEvaluationClassificationDeserializer(ObjectDeserializer<DataframeEvaluationClassification.Builder> op)
final String	topClassesField()	The field of the index which is an array of documents of the form { "class_name": XXX, "class_probability": YYY }.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface co.elastic.clients.elasticsearch.ml.DataframeEvaluationVariant

_toDataframeEvaluation

Field Details

_DESERIALIZER

public static final JsonpDeserializer<DataframeEvaluationClassification> _DESERIALIZER

Json deserializer for DataframeEvaluationClassification

Method Details

of

public static DataframeEvaluationClassification of(Function<DataframeEvaluationClassification.Builder,ObjectBuilder<DataframeEvaluationClassification>> fn)

_dataframeEvaluationKind

public DataframeEvaluation.Kind _dataframeEvaluationKind()

DataframeEvaluation variant kind.

Specified by:

_dataframeEvaluationKind in interface DataframeEvaluationVariant

actualField

public final String actualField()

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

@Nullable
public final String predictedField()

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

API name: predicted_field

topClassesField

@Nullable
public final String topClassesField()

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

@Nullable
public final DataframeEvaluationClassificationMetrics metrics()

Specifies the metrics that are used for the evaluation.

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)

toString

public String toString()

Overrides:

toString in class Object

setupDataframeEvaluationClassificationDeserializer

protected static void setupDataframeEvaluationClassificationDeserializer(ObjectDeserializer<DataframeEvaluationClassification.Builder> op)