Package co.elastic.clients.elasticsearch.ml

Class DataframeAnalysisClassification.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>

co.elastic.clients.elasticsearch.ml.DataframeAnalysisBase.AbstractBuilder<DataframeAnalysisClassification.Builder>

co.elastic.clients.elasticsearch.ml.DataframeAnalysisClassification.Builder

All Implemented Interfaces:

WithJson<DataframeAnalysisClassification.Builder>, ObjectBuilder<DataframeAnalysisClassification>

Enclosing class:

DataframeAnalysisClassification

public static class DataframeAnalysisClassification.Builder
extends DataframeAnalysisBase.AbstractBuilder<DataframeAnalysisClassification.Builder>
implements ObjectBuilder<DataframeAnalysisClassification>

Builder for DataframeAnalysisClassification.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
DataframeAnalysisClassification	build()	Builds a DataframeAnalysisClassification.
final DataframeAnalysisClassification.Builder	classAssignmentObjective(String value)	API name: class_assignment_objective
final DataframeAnalysisClassification.Builder	numTopClasses(Integer value)	Defines the number of categories for which the predicted probabilities are reported.
protected DataframeAnalysisClassification.Builder	self()

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

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

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

classAssignmentObjective

public final DataframeAnalysisClassification.Builder classAssignmentObjective(@Nullable
 String value)

API name: class_assignment_objective

numTopClasses

public final DataframeAnalysisClassification.Builder numTopClasses(@Nullable
 Integer value)

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

self

protected DataframeAnalysisClassification.Builder self()

Specified by:

self in class DataframeAnalysisBase.AbstractBuilder<DataframeAnalysisClassification.Builder>

build

public DataframeAnalysisClassification build()

Builds a DataframeAnalysisClassification.

Specified by:

build in interface ObjectBuilder<DataframeAnalysisClassification>

Throws:

NullPointerException - if some of the required fields are null.