IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« Stop data frame analytics jobs API Machine learning trained model APIs »

› › ›

Update data frame analytics jobs API

edit

Update data frame analytics jobs API

edit

Updates an existing data frame analytics job.

Request

edit

POST _ml/data_frame/analytics/<data_frame_analytics_id>/_update

Prerequisites

edit

Requires the following privileges:

cluster: manage_ml (the machine_learning_admin built-in role grants this privilege)
source indices: read, view_index_metadata
destination index: read, create_index, manage and index

The data frame analytics job remembers which roles the user who updated it had at the time of the update. When you start the job, it performs the analysis using those same roles. If you provide secondary authorization headers, those credentials are used instead.

Description

edit

This API updates an existing data frame analytics job that performs an analysis on the source indices and stores the outcome in a destination index.

Path parameters

edit

<data_frame_analytics_id>: (Required, string) 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 body

edit

allow_lazy_start: (Optional, Boolean) Specifies whether this job can start when there is insufficient machine learning node capacity for it to be immediately assigned to a node. The default is false; if a machine learning node with capacity to run the job cannot immediately be found, the API returns an error. However, this is also subject to the cluster-wide xpack.ml.max_lazy_ml_nodes setting. See Advanced machine learning settings. If this option is set to true, the API does not return an error and the job waits in the starting state until sufficient machine learning node capacity is available.
description: (Optional, string) A description of the job.
max_num_threads: (Optional, integer) The maximum number of threads to be used by the analysis. The default value is 1. 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.
_meta: (Optional, object) Advanced configuration option. Contains custom metadata about the job. For example, it can contain custom URL information.
model_memory_limit: (Optional, string) The approximate maximum amount of memory resources that are permitted for analytical processing. The default value for data frame analytics jobs is 1gb. If you specify a value for the xpack.ml.max_model_memory_limit setting, an error occurs when you try to create jobs that have model_memory_limit values greater than that setting value. For more information, see Machine learning settings.

Examples

edit

Updating model memory limit example

edit

The following example shows how to update the model memory limit for the existing data frame analytics configuration.

POST _ml/data_frame/analytics/loganalytics/_update
{
  "model_memory_limit": "200mb"
}

When the job is updated, the response contains its configuration with the updated values. For example:

{
  "id" : "loganalytics",
  "create_time" : 1656364565517,
  "version" : "8.4.0",
  "authorization" : {
    "roles" : [
      "superuser"
    ]
  },
  "description" : "Outlier detection on log data",
  "source" : {
    "index" : [
      "logdata"
    ],
    "query" : {
      "match_all" : { }
    }
  },
  "dest" : {
    "index" : "logdata_out",
    "results_field" : "ml"
  },
  "analysis" : {
    "outlier_detection" : {
      "compute_feature_influence" : true,
      "outlier_fraction" : 0.05,
      "standardization_enabled" : true
    }
  },
  "model_memory_limit" : "200mb",
  "allow_lazy_start" : false,
  "max_num_threads" : 1
}

« Stop data frame analytics jobs API Machine learning trained model APIs »