Package co.elastic.clients.elasticsearch.ml

Class DataframeAnalysisClassification

java.lang.Object

co.elastic.clients.elasticsearch.ml.DataframeAnalysisBase

co.elastic.clients.elasticsearch.ml.DataframeAnalysisClassification

All Implemented Interfaces:

DataframeAnalysisVariant, JsonpSerializable

@JsonpDeserializable
public class DataframeAnalysisClassification
extends DataframeAnalysisBase
implements DataframeAnalysisVariant

See Also:

• API specification

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch.ml.DataframeAnalysisBase

DataframeAnalysisBase.AbstractBuilder<BuilderT extends DataframeAnalysisBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
DataframeAnalysis.Kind	_dataframeAnalysisKind()	DataframeAnalysis variant kind.
final String	classAssignmentObjective()	API name: class_assignment_objective
final Integer	numTopClasses()	Defines the number of categories for which the predicted probabilities are reported.
static DataframeAnalysisClassification	of(Function<DataframeAnalysisClassification.Builder,ObjectBuilder<DataframeAnalysisClassification>> fn)
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupDataframeAnalysisClassificationDeserializer(ObjectDeserializer<DataframeAnalysisClassification.Builder> op)

Methods inherited from class co.elastic.clients.elasticsearch.ml.DataframeAnalysisBase

alpha, dependentVariable, downsampleFactor, earlyStoppingEnabled, eta, etaGrowthRatePerTree, featureBagFraction, featureProcessors, gamma, lambda, maxOptimizationRoundsPerHyperparameter, maxTrees, numTopFeatureImportanceValues, predictionFieldName, randomizeSeed, serialize, setupDataframeAnalysisBaseDeserializer, softTreeDepthLimit, softTreeDepthTolerance, toString, trainingPercent

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

_toDataframeAnalysis

Field Details

_DESERIALIZER

public static final JsonpDeserializer<DataframeAnalysisClassification> _DESERIALIZER

Json deserializer for DataframeAnalysisClassification

Method Details

of

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

_dataframeAnalysisKind

public DataframeAnalysis.Kind _dataframeAnalysisKind()

DataframeAnalysis variant kind.

Specified by:

_dataframeAnalysisKind in interface DataframeAnalysisVariant

classAssignmentObjective

@Nullable
public final String classAssignmentObjective()

API name: class_assignment_objective

numTopClasses

@Nullable
public final Integer numTopClasses()

Defines the number of categories for which the predicted probabilities are reported. It must be non-negative or -1. If it is -1 or greater than the total number of categories, probabilities are reported for all categories; if you have a large number of categories, there could be a significant effect on the size of your destination index. NOTE: To use the AUC ROC evaluation method, num_top_classes must be set to -1 or a value greater than or equal to the total number of categories.

API name: num_top_classes

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Overrides:

serializeInternal in class DataframeAnalysisBase

setupDataframeAnalysisClassificationDeserializer

protected static void setupDataframeAnalysisClassificationDeserializer(ObjectDeserializer<DataframeAnalysisClassification.Builder> op)