Create a data frame analytics job
- PUT /_ml/data_frame/analytics/{id}
This API creates a data frame analytics job that performs an analysis on the
source indices and stores the outcome in a destination index.
By default, the query used in the source configuration is {"match_all": {}}.
If the destination index does not exist, it is created automatically when you start the job.
If you supply only a subset of the regression or classification parameters, hyperparameter optimization occurs. It determines a value for each of the undefined parameters.
- Index privileges:
create_index,index,manage,read,view_index_metadata - Cluster privileges:
manage_ml
Path Parameters
-
idstring Idrequired -
Identifier for the data frame analytics job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters.
Request
-
allow_lazy_startboolean · default: false -
Specifies whether this job can start when there is insufficient machine learning node capacity for it to be immediately assigned to a node. If set to
falseand a machine learning node with capacity to run the job cannot be immediately found, the API returns an error. If set totrue, the API does not return an error; the job waits in thestartingstate until sufficient machine learning node capacity is available. This behavior is also affected by the cluster-widexpack.ml.max_lazy_ml_nodessetting. -
analysisDataframeAnalysisContainerrequired -
The analysis configuration, which contains the information necessary to perform one of the following types of analysis: classification, outlier detection, or regression.
-
classificationDataframeAnalysisClassification -
The configuration information necessary to perform classification.
-
alphanumber -
Advanced configuration option. Machine learning uses loss guided tree growing, which means that the decision trees grow where the regularized loss decreases most quickly. This parameter affects loss calculations by acting as a multiplier of the tree depth. Higher alpha values result in shallower trees and faster training times. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to zero.
-
dependent_variablestringrequired -
Defines which field of the document is to be predicted. It must match one of the fields in the index being used to train. If this field is missing from a document, then that document will not be used for training, but a prediction with the trained model will be generated for it. It is also known as continuous target variable. For classification analysis, the data type of the field must be numeric (
integer,short,long,byte), categorical (iporkeyword), orboolean. There must be no more than 30 different values in this field. For regression analysis, the data type of the field must be numeric. -
downsample_factornumber -
Advanced configuration option. Controls the fraction of data that is used to compute the derivatives of the loss function for tree training. A small value results in the use of a small fraction of the data. If this value is set to be less than 1, accuracy typically improves. However, too small a value may result in poor convergence for the ensemble and so require more trees. By default, this value is calculated during hyperparameter optimization. It must be greater than zero and less than or equal to 1.
-
early_stopping_enabledboolean · default: true -
Advanced configuration option. Specifies whether the training process should finish if it is not finding any better performing models. If disabled, the training process can take significantly longer and the chance of finding a better performing model is unremarkable.
-
etanumber -
Advanced configuration option. The shrinkage applied to the weights. Smaller values result in larger forests which have a better generalization error. However, larger forests cause slower training. By default, this value is calculated during hyperparameter optimization. It must be a value between 0.001 and 1.
-
eta_growth_rate_per_treenumber -
Advanced configuration option. Specifies the rate at which
etaincreases for each new tree that is added to the forest. For example, a rate of 1.05 increasesetaby 5% for each extra tree. By default, this value is calculated during hyperparameter optimization. It must be between 0.5 and 2. -
feature_bag_fractionnumber -
Advanced configuration option. Defines the fraction of features that will be used when selecting a random bag for each candidate split. By default, this value is calculated during hyperparameter optimization.
-
feature_processorsDataframeAnalysisFeatureProcessor -
Advanced configuration option. A collection of feature preprocessors that modify one or more included fields. The analysis uses the resulting one or more features instead of the original document field. However, these features are ephemeral; they are not stored in the destination index. Multiple
feature_processorsentries can refer to the same document fields. Automatic categorical feature encoding still occurs for the fields that are unprocessed by a custom processor or that have categorical values. Use this property only if you want to override the automatic feature encoding of the specified fields. -
frequency_encodingDataframeAnalysisFeatureProcessorFrequencyEncoding -
The configuration information necessary to perform frequency encoding.
-
feature_namestring Namerequired -
The resulting feature name.
-
fieldstring Fieldrequired -
frequency_mapmap string to numberrequired -
The resulting frequency map for the field value. If the field value is missing from the frequency_map, the resulting value is 0.
-
multi_encodingDataframeAnalysisFeatureProcessorMultiEncoding -
The configuration information necessary to perform multi encoding. It allows multiple processors to be changed together. This way the output of a processor can then be passed to another as an input.
-
processorsnumberrequired -
The ordered array of custom processors to execute. Must be more than 1.
-
n_gram_encodingDataframeAnalysisFeatureProcessorNGramEncoding -
The configuration information necessary to perform n-gram encoding. Features created by this encoder have the following name format: <feature_prefix>.
-
feature_prefixstring -
The feature name prefix. Defaults to ngram_
-
fieldstring Fieldrequired -
The name of the text field to encode.
-
lengthnumber -
Specifies the length of the n-gram substring. Defaults to 50. Must be greater than 0.
-
n_gramsnumberrequired -
Specifies which n-grams to gather. It’s an array of integer values where the minimum value is 1, and a maximum value is 5.
-
startnumber -
Specifies the zero-indexed start of the n-gram substring. Negative values are allowed for encoding n-grams of string suffixes. Defaults to 0.
-
customboolean -
one_hot_encodingDataframeAnalysisFeatureProcessorOneHotEncoding -
The configuration information necessary to perform one hot encoding.
-
target_mean_encodingDataframeAnalysisFeatureProcessorTargetMeanEncoding -
The configuration information necessary to perform target mean encoding.
-
default_valuenumberrequired -
The default value if field value is not found in the target_map.
-
feature_namestring Namerequired -
The resulting feature name.
-
fieldstring Fieldrequired -
The name of the field to encode.
-
target_mapmap string to objectrequired -
The field value to target mean transition map.
-
gammanumber -
Advanced configuration option. Regularization parameter to prevent overfitting on the training data set. Multiplies a linear penalty associated with the size of individual trees in the forest. A high gamma value causes training to prefer small trees. A small gamma value results in larger individual trees and slower training. By default, this value is calculated during hyperparameter optimization. It must be a nonnegative value.
-
lambdanumber -
Advanced configuration option. Regularization parameter to prevent overfitting on the training data set. Multiplies an L2 regularization term which applies to leaf weights of the individual trees in the forest. A high lambda value causes training to favor small leaf weights. This behavior makes the prediction function smoother at the expense of potentially not being able to capture relevant relationships between the features and the dependent variable. A small lambda value results in large individual trees and slower training. By default, this value is calculated during hyperparameter optimization. It must be a nonnegative value.
-
max_optimization_rounds_per_hyperparameternumber -
Advanced configuration option. A multiplier responsible for determining the maximum number of hyperparameter optimization steps in the Bayesian optimization procedure. The maximum number of steps is determined based on the number of undefined hyperparameters times the maximum optimization rounds per hyperparameter. By default, this value is calculated during hyperparameter optimization.
-
max_treesnumber -
Advanced configuration option. Defines the maximum number of decision trees in the forest. The maximum value is 2000. By default, this value is calculated during hyperparameter optimization.
-
num_top_feature_importance_valuesnumber · default: 0 -
Advanced configuration option. Specifies the maximum number of feature importance values per document to return. By default, no feature importance calculation occurs.
-
prediction_field_namestring Field -
Defines the name of the prediction field in the results. Defaults to
<dependent_variable>_prediction. -
randomize_seednumber -
Defines the seed for the random generator that is used to pick training data. By default, it is randomly generated. Set it to a specific value to use the same training data each time you start a job (assuming other related parameters such as
sourceandanalyzed_fieldsare the same). -
soft_tree_depth_limitnumber -
Advanced configuration option. Machine learning uses loss guided tree growing, which means that the decision trees grow where the regularized loss decreases most quickly. This soft limit combines with the
soft_tree_depth_toleranceto penalize trees that exceed the specified depth; the regularized loss increases quickly beyond this depth. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to 0. -
soft_tree_depth_tolerancenumber -
Advanced configuration option. This option controls how quickly the regularized loss increases when the tree depth exceeds
soft_tree_depth_limit. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to 0.01. -
training_percentnumber | string Percentage · default: 100 -
Defines what percentage of the eligible documents that will be used for training. Documents that are ignored by the analysis (for example those that contain arrays with more than one value) won’t be included in the calculation for used percentage.
-
class_assignment_objectivestring -
num_top_classesnumber · default: 2 -
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_classesmust be set to -1 or a value greater than or equal to the total number of categories. -
outlier_detectionDataframeAnalysisOutlierDetection -
The configuration information necessary to perform outlier detection. NOTE: Advanced parameters are for fine-tuning classification analysis. They are set automatically by hyperparameter optimization to give the minimum validation error. It is highly recommended to use the default values unless you fully understand the function of these parameters.
-
compute_feature_influenceboolean · default: true -
Specifies whether the feature influence calculation is enabled.
-
feature_influence_thresholdnumber · default: 0.1 -
The minimum outlier score that a document needs to have in order to calculate its feature influence score. Value range: 0-1.
-
methodstring · default: ensemble -
The method that outlier detection uses. Available methods are
lof,ldof,distance_kth_nn,distance_knn, andensemble. The default value is ensemble, which means that outlier detection uses an ensemble of different methods and normalises and combines their individual outlier scores to obtain the overall outlier score. -
n_neighborsnumber -
Defines the value for how many nearest neighbors each method of outlier detection uses to calculate its outlier score. When the value is not set, different values are used for different ensemble members. This default behavior helps improve the diversity in the ensemble; only override it if you are confident that the value you choose is appropriate for the data set.
-
outlier_fractionnumber -
The proportion of the data set that is assumed to be outlying prior to outlier detection. For example, 0.05 means it is assumed that 5% of values are real outliers and 95% are inliers.
-
standardization_enabledboolean · default: true -
If true, the following operation is performed on the columns before computing outlier scores:
(x_i - mean(x_i)) / sd(x_i). -
regressionDataframeAnalysisRegression -
The configuration information necessary to perform regression. NOTE: Advanced parameters are for fine-tuning regression analysis. They are set automatically by hyperparameter optimization to give the minimum validation error. It is highly recommended to use the default values unless you fully understand the function of these parameters.
-
alphanumber -
Advanced configuration option. Machine learning uses loss guided tree growing, which means that the decision trees grow where the regularized loss decreases most quickly. This parameter affects loss calculations by acting as a multiplier of the tree depth. Higher alpha values result in shallower trees and faster training times. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to zero.
-
dependent_variablestringrequired -
Defines which field of the document is to be predicted. It must match one of the fields in the index being used to train. If this field is missing from a document, then that document will not be used for training, but a prediction with the trained model will be generated for it. It is also known as continuous target variable. For classification analysis, the data type of the field must be numeric (
integer,short,long,byte), categorical (iporkeyword), orboolean. There must be no more than 30 different values in this field. For regression analysis, the data type of the field must be numeric. -
downsample_factornumber -
Advanced configuration option. Controls the fraction of data that is used to compute the derivatives of the loss function for tree training. A small value results in the use of a small fraction of the data. If this value is set to be less than 1, accuracy typically improves. However, too small a value may result in poor convergence for the ensemble and so require more trees. By default, this value is calculated during hyperparameter optimization. It must be greater than zero and less than or equal to 1.
-
early_stopping_enabledboolean · default: true -
Advanced configuration option. Specifies whether the training process should finish if it is not finding any better performing models. If disabled, the training process can take significantly longer and the chance of finding a better performing model is unremarkable.
-
etanumber -
Advanced configuration option. The shrinkage applied to the weights. Smaller values result in larger forests which have a better generalization error. However, larger forests cause slower training. By default, this value is calculated during hyperparameter optimization. It must be a value between 0.001 and 1.
-
eta_growth_rate_per_treenumber -
Advanced configuration option. Specifies the rate at which
etaincreases for each new tree that is added to the forest. For example, a rate of 1.05 increasesetaby 5% for each extra tree. By default, this value is calculated during hyperparameter optimization. It must be between 0.5 and 2. -
feature_bag_fractionnumber -
Advanced configuration option. Defines the fraction of features that will be used when selecting a random bag for each candidate split. By default, this value is calculated during hyperparameter optimization.
-
feature_processorsDataframeAnalysisFeatureProcessor -
Advanced configuration option. A collection of feature preprocessors that modify one or more included fields. The analysis uses the resulting one or more features instead of the original document field. However, these features are ephemeral; they are not stored in the destination index. Multiple
feature_processorsentries can refer to the same document fields. Automatic categorical feature encoding still occurs for the fields that are unprocessed by a custom processor or that have categorical values. Use this property only if you want to override the automatic feature encoding of the specified fields. -
gammanumber -
Advanced configuration option. Regularization parameter to prevent overfitting on the training data set. Multiplies a linear penalty associated with the size of individual trees in the forest. A high gamma value causes training to prefer small trees. A small gamma value results in larger individual trees and slower training. By default, this value is calculated during hyperparameter optimization. It must be a nonnegative value.
-
lambdanumber -
Advanced configuration option. Regularization parameter to prevent overfitting on the training data set. Multiplies an L2 regularization term which applies to leaf weights of the individual trees in the forest. A high lambda value causes training to favor small leaf weights. This behavior makes the prediction function smoother at the expense of potentially not being able to capture relevant relationships between the features and the dependent variable. A small lambda value results in large individual trees and slower training. By default, this value is calculated during hyperparameter optimization. It must be a nonnegative value.
-
max_optimization_rounds_per_hyperparameternumber -
Advanced configuration option. A multiplier responsible for determining the maximum number of hyperparameter optimization steps in the Bayesian optimization procedure. The maximum number of steps is determined based on the number of undefined hyperparameters times the maximum optimization rounds per hyperparameter. By default, this value is calculated during hyperparameter optimization.
-
max_treesnumber -
Advanced configuration option. Defines the maximum number of decision trees in the forest. The maximum value is 2000. By default, this value is calculated during hyperparameter optimization.
-
num_top_feature_importance_valuesnumber · default: 0 -
Advanced configuration option. Specifies the maximum number of feature importance values per document to return. By default, no feature importance calculation occurs.
-
prediction_field_namestring Field -
Defines the name of the prediction field in the results. Defaults to
<dependent_variable>_prediction. -
randomize_seednumber -
Defines the seed for the random generator that is used to pick training data. By default, it is randomly generated. Set it to a specific value to use the same training data each time you start a job (assuming other related parameters such as
sourceandanalyzed_fieldsare the same). -
soft_tree_depth_limitnumber -
Advanced configuration option. Machine learning uses loss guided tree growing, which means that the decision trees grow where the regularized loss decreases most quickly. This soft limit combines with the
soft_tree_depth_toleranceto penalize trees that exceed the specified depth; the regularized loss increases quickly beyond this depth. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to 0. -
soft_tree_depth_tolerancenumber -
Advanced configuration option. This option controls how quickly the regularized loss increases when the tree depth exceeds
soft_tree_depth_limit. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to 0.01. -
training_percentnumber | string Percentage · default: 100 -
Defines what percentage of the eligible documents that will be used for training. Documents that are ignored by the analysis (for example those that contain arrays with more than one value) won’t be included in the calculation for used percentage.
-
loss_functionstring · default: mse -
The loss function used during regression. Available options are
mse(mean squared error),msle(mean squared logarithmic error),huber(Pseudo-Huber loss). -
loss_function_parameternumber -
A positive number that is used as a parameter to the
loss_function. -
analyzed_fieldsDataframeAnalysisAnalyzedFields -
Specifies
includesand/orexcludespatterns to select which fields will be included in the analysis. The patterns specified inexcludesare applied last, thereforeexcludestakes precedence. In other words, if the same field is specified in bothincludesandexcludes, then the field will not be included in the analysis. Ifanalyzed_fieldsis not set, only the relevant fields will be included. For example, all the numeric fields for outlier detection. The supported fields vary for each type of analysis. Outlier detection requires numeric orbooleandata to analyze. The algorithms don’t support missing values therefore fields that have data types other than numeric or boolean are ignored. Documents where included fields contain missing values, null values, or an array are also ignored. Therefore thedestindex may contain documents that don’t have an outlier score. Regression supports fields that are numeric,boolean,text,keyword, andipdata types. It is also tolerant of missing values. Fields that are supported are included in the analysis, other fields are ignored. Documents where included fields contain an array with two or more values are also ignored. Documents in thedestindex that don’t contain a results field are not included in the regression analysis. Classification supports fields that are numeric,boolean,text,keyword, andipdata types. It is also tolerant of missing values. Fields that are supported are included in the analysis, other fields are ignored. Documents where included fields contain an array with two or more values are also ignored. Documents in thedestindex that don’t contain a results field are not included in the classification analysis. Classification analysis can be improved by mapping ordinal variable values to a single number. For example, in case of age ranges, you can model the values as0-14 = 0,15-24 = 1,25-34 = 2, and so on. -
includesstringrequired -
An array of strings that defines the fields that will be excluded from the analysis. You do not need to add fields with unsupported data types to excludes, these fields are excluded from the analysis automatically.
-
excludesstringrequired -
An array of strings that defines the fields that will be included in the analysis.
-
descriptionstring -
A description of the job.
-
destDataframeAnalyticsDestinationrequired -
The destination configuration.
-
indexstring IndexNamerequired -
Defines the destination index to store the results of the data frame analytics job.
-
results_fieldstring Field -
Defines the name of the field in which to store the results of the analysis. Defaults to
ml. -
max_num_threadsnumber · default: 1 -
The maximum number of threads to be used by the analysis. Using more threads may decrease the time necessary to complete the analysis at the cost of using more CPU. Note that the process may use additional threads for operational functionality other than the analysis itself.
-
_metaMetadata -
model_memory_limitstring · default: 1gb -
The approximate maximum amount of memory resources that are permitted for analytical processing. If your
elasticsearch.ymlfile contains anxpack.ml.max_model_memory_limitsetting, an error occurs when you try to create data frame analytics jobs that havemodel_memory_limitvalues greater than that setting. -
sourceDataframeAnalyticsSourcerequired -
The configuration of how to source the analysis data.
-
indexstring Indicesrequired -
Index or indices on which to perform the analysis. It can be a single index or index pattern as well as an array of indices or patterns. NOTE: If your source indices contain documents with the same IDs, only the document that is indexed last appears in the destination index.
-
runtime_mappingsRuntimeFields -
Definitions of runtime fields that will become part of the mapping of the destination index.
-
_sourceDataframeAnalysisAnalyzedFields -
Specify
includesand/or `excludes patterns to select which fields will be present in the destination. Fields that are excluded cannot be included in the analysis. -
includesstringrequired -
An array of strings that defines the fields that will be excluded from the analysis. You do not need to add fields with unsupported data types to excludes, these fields are excluded from the analysis automatically.
-
excludesstringrequired -
An array of strings that defines the fields that will be included in the analysis.
-
queryobject -
The Elasticsearch query domain-specific language (DSL). This value corresponds to the query object in an Elasticsearch search POST body. All the options that are supported by Elasticsearch can be used, as this object is passed verbatim to Elasticsearch. By default, this property has the following value:
{"match_all": {}}. - Query DSL
-
headersHttpHeaders -
versionstring
Response
-
If an API key was used for the most recent update to the job, its name and identifier are listed in the response.
-
The identifier for the API key.
-
The name of the API key.
-
If a user ID was used for the most recent update to the job, its roles at the time of the update are listed in the response.
-
If a service account was used for the most recent update to the job, the account name is listed in the response.
-
allow_lazy_startbooleanrequired -
analysisDataframeAnalysisContainerrequired -
analyzed_fieldsDataframeAnalysisAnalyzedFields -
includesstringrequired -
An array of strings that defines the fields that will be excluded from the analysis. You do not need to add fields with unsupported data types to excludes, these fields are excluded from the analysis automatically.
-
excludesstringrequired -
An array of strings that defines the fields that will be included in the analysis.
-
create_timeEpochTimeUnitMillisrequired -
descriptionstring -
destDataframeAnalyticsDestinationrequired -
indexstring IndexNamerequired -
Defines the destination index to store the results of the data frame analytics job.
-
results_fieldstring Field -
Defines the name of the field in which to store the results of the analysis. Defaults to
ml. -
idstring Idrequired -
max_num_threadsnumberrequired -
_metaMetadata -
model_memory_limitstringrequired -
sourceDataframeAnalyticsSourcerequired -
indexstring Indicesrequired -
Index or indices on which to perform the analysis. It can be a single index or index pattern as well as an array of indices or patterns. NOTE: If your source indices contain documents with the same IDs, only the document that is indexed last appears in the destination index.
-
runtime_mappingsRuntimeFields -
Definitions of runtime fields that will become part of the mapping of the destination index.
-
_sourceDataframeAnalysisAnalyzedFields -
Specify
includesand/or `excludes patterns to select which fields will be present in the destination. Fields that are excluded cannot be included in the analysis. -
includesstringrequired -
An array of strings that defines the fields that will be excluded from the analysis. You do not need to add fields with unsupported data types to excludes, these fields are excluded from the analysis automatically.
-
excludesstringrequired -
An array of strings that defines the fields that will be included in the analysis.
-
queryobject -
The Elasticsearch query domain-specific language (DSL). This value corresponds to the query object in an Elasticsearch search POST body. All the options that are supported by Elasticsearch can be used, as this object is passed verbatim to Elasticsearch. By default, this property has the following value:
{"match_all": {}}. - Query DSL
-
versionstringrequired