Package co.elastic.clients.elasticsearch.ml

Class TrainedModelConfigMetadata.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

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

co.elastic.clients.elasticsearch.ml.TrainedModelConfigMetadata.Builder

All Implemented Interfaces:

WithJson<TrainedModelConfigMetadata.Builder>, ObjectBuilder<TrainedModelConfigMetadata>

Enclosing class:

TrainedModelConfigMetadata

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

Builder for TrainedModelConfigMetadata.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
TrainedModelConfigMetadata	build()	Builds a TrainedModelConfigMetadata.
final TrainedModelConfigMetadata.Builder	featureImportanceBaseline(String key, String value)	An object that contains the baseline for feature importance values.
final TrainedModelConfigMetadata.Builder	featureImportanceBaseline(Map<String,String> map)	An object that contains the baseline for feature importance values.
final TrainedModelConfigMetadata.Builder	hyperparameters(Hyperparameter value, Hyperparameter... values)	List of the available hyperparameters optimized during the fine_parameter_tuning phase as well as specified by the user.
final TrainedModelConfigMetadata.Builder	hyperparameters(Function<Hyperparameter.Builder,ObjectBuilder<Hyperparameter>> fn)	List of the available hyperparameters optimized during the fine_parameter_tuning phase as well as specified by the user.
final TrainedModelConfigMetadata.Builder	hyperparameters(List<Hyperparameter> list)	List of the available hyperparameters optimized during the fine_parameter_tuning phase as well as specified by the user.
final TrainedModelConfigMetadata.Builder	modelAliases(String value, String... values)	API name: model_aliases
final TrainedModelConfigMetadata.Builder	modelAliases(List<String> list)	API name: model_aliases
protected TrainedModelConfigMetadata.Builder	self()
final TrainedModelConfigMetadata.Builder	totalFeatureImportance(TotalFeatureImportance value, TotalFeatureImportance... values)	An array of the total feature importance for each feature used from the training data set.
final TrainedModelConfigMetadata.Builder	totalFeatureImportance(Function<TotalFeatureImportance.Builder,ObjectBuilder<TotalFeatureImportance>> fn)	An array of the total feature importance for each feature used from the training data set.
final TrainedModelConfigMetadata.Builder	totalFeatureImportance(List<TotalFeatureImportance> list)	An array of the total feature importance for each feature used from the training data set.

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

modelAliases

public final TrainedModelConfigMetadata.Builder modelAliases(List<String> list)

API name: model_aliases

Adds all elements of list to modelAliases.

modelAliases

public final TrainedModelConfigMetadata.Builder modelAliases(String value,
 String... values)

API name: model_aliases

Adds one or more values to modelAliases.

featureImportanceBaseline

public final TrainedModelConfigMetadata.Builder featureImportanceBaseline(Map<String,String> map)

An object that contains the baseline for feature importance values. For regression analysis, it is a single value. For classification analysis, there is a value for each class.

API name: feature_importance_baseline

Adds all entries of map to featureImportanceBaseline.

featureImportanceBaseline

public final TrainedModelConfigMetadata.Builder featureImportanceBaseline(String key,
 String value)

An object that contains the baseline for feature importance values. For regression analysis, it is a single value. For classification analysis, there is a value for each class.

API name: feature_importance_baseline

Adds an entry to featureImportanceBaseline.

hyperparameters

public final TrainedModelConfigMetadata.Builder hyperparameters(List<Hyperparameter> list)

List of the available hyperparameters optimized during the fine_parameter_tuning phase as well as specified by the user.

API name: hyperparameters

Adds all elements of list to hyperparameters.

hyperparameters

public final TrainedModelConfigMetadata.Builder hyperparameters(Hyperparameter value,
 Hyperparameter... values)

List of the available hyperparameters optimized during the fine_parameter_tuning phase as well as specified by the user.

API name: hyperparameters

Adds one or more values to hyperparameters.

hyperparameters

public final TrainedModelConfigMetadata.Builder hyperparameters(Function<Hyperparameter.Builder,ObjectBuilder<Hyperparameter>> fn)

List of the available hyperparameters optimized during the fine_parameter_tuning phase as well as specified by the user.

API name: hyperparameters

Adds a value to hyperparameters using a builder lambda.

totalFeatureImportance

public final TrainedModelConfigMetadata.Builder totalFeatureImportance(List<TotalFeatureImportance> list)

An array of the total feature importance for each feature used from the training data set. This array of objects is returned if data frame analytics trained the model and the request includes total_feature_importance in the include request parameter.

API name: total_feature_importance

Adds all elements of list to totalFeatureImportance.

totalFeatureImportance

public final TrainedModelConfigMetadata.Builder totalFeatureImportance(TotalFeatureImportance value,
 TotalFeatureImportance... values)

An array of the total feature importance for each feature used from the training data set. This array of objects is returned if data frame analytics trained the model and the request includes total_feature_importance in the include request parameter.

API name: total_feature_importance

Adds one or more values to totalFeatureImportance.

totalFeatureImportance

public final TrainedModelConfigMetadata.Builder totalFeatureImportance(Function<TotalFeatureImportance.Builder,ObjectBuilder<TotalFeatureImportance>> fn)

An array of the total feature importance for each feature used from the training data set. This array of objects is returned if data frame analytics trained the model and the request includes total_feature_importance in the include request parameter.

API name: total_feature_importance

Adds a value to totalFeatureImportance using a builder lambda.

self

protected TrainedModelConfigMetadata.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<TrainedModelConfigMetadata.Builder>

build

public TrainedModelConfigMetadata build()

Builds a TrainedModelConfigMetadata.

Specified by:

build in interface ObjectBuilder<TrainedModelConfigMetadata>

Throws:

NullPointerException - if some of the required fields are null.