From 1cecbd0cd3a5b0a6e066898f7d157fd42085c017 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Istv=C3=A1n=20Zolt=C3=A1n=20Szab=C3=B3?= Date: Wed, 2 Oct 2019 10:04:35 +0200 Subject: [PATCH] [DOCS] Fine tunes update anomaly detection job API documentation (#47280) * [DOCS] Fine tunes update anomaly detection job API documentation. * [DOCS] Removes delimiter to fix the table. --- .../apis/update-job.asciidoc | 35 ++++++++----------- 1 file changed, 14 insertions(+), 21 deletions(-) diff --git a/docs/reference/ml/anomaly-detection/apis/update-job.asciidoc b/docs/reference/ml/anomaly-detection/apis/update-job.asciidoc index cb77d9e2733..53bec1a1941 100644 --- a/docs/reference/ml/anomaly-detection/apis/update-job.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/update-job.asciidoc @@ -36,8 +36,11 @@ The following properties can be updated after the job is created: |======================================================================= |Name |Description |Requires Restart -|`analysis_limits`: `model_memory_limit` |The approximate maximum amount of -memory resources required for analytical processing. See <>. | Yes +|`analysis_limits.model_memory_limit` |The approximate maximum amount of +memory resources required for analytical processing. See <>. You +can update the `analysis_limits` only while the job is closed. The +`model_memory_limit` property value cannot be decreased below the current usage. +| Yes |`background_persist_interval` |Advanced configuration option. The time between each periodic persistence of the model. See <>. | Yes @@ -46,11 +49,18 @@ each periodic persistence of the model. See <>. | Yes |`description` |A description of the job. See <>. | No -|`detectors` |An array of <>. | No +|`detectors` |An array of detector update objects. | No + +|`detector_index` |The identifier of the detector to update (integer).| No + +|`detectors.description` |The new description for the detector.| No + +|`detectors.custom_rules` |The new list of <> +for the detector. | No |`groups` |A list of job groups. See <>. | No -|`model_plot_config`: `enabled` |If true, enables calculation and storage of the +|`model_plot_config.enabled` |If true, enables calculation and storage of the model bounds for each entity that is being analyzed. See <>. | No @@ -73,28 +83,11 @@ effect. [NOTE] -- -* You can update the `analysis_limits` only while the job is closed. -* The `model_memory_limit` property value cannot be decreased below the current usage. * If the `memory_status` property in the `model_size_stats` object has a value of `hard_limit`, this means that it was unable to process some data. You might want to re-run this job with an increased `model_memory_limit`. -- -[[ml-detector-update]] -==== Detector update objects - -A detector update object has the following properties: - -`detector_index`:: - (integer) The identifier of the detector to update. - -`description`:: - (string) The new description for the detector. - -`custom_rules`:: - (array) The new list of <> for the detector. - -No other detector property can be updated. [[ml-update-job-example]] ==== {api-examples-title}