Quellcode durchsuchen

[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.
István Zoltán Szabó vor 6 Jahren
Ursprung
Commit
aa7c4030cd
1 geänderte Dateien mit 14 neuen und 21 gelöschten Zeilen
  1. 14 21
      docs/reference/ml/anomaly-detection/apis/update-job.asciidoc

+ 14 - 21
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 <<ml-apilimits>>. | Yes
+|`analysis_limits.model_memory_limit` |The approximate maximum amount of
+memory resources required for analytical processing. See <<ml-apilimits>>. 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 <<ml-job-resource>>. | Yes
@@ -46,11 +49,18 @@ each periodic persistence of the model. See <<ml-job-resource>>. | Yes
 
 |`description` |A description of the job. See <<ml-job-resource>>. | No
 
-|`detectors` |An array of <<ml-detector-update, detector update objects>>. | 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 <<ml-detector-custom-rule, rules>> 
+for the detector. | No
 
 |`groups` |A list of job groups. See <<ml-job-resource>>. | 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 <<ml-apimodelplotconfig>>. | 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 <<ml-detector-custom-rule, rules>> for the detector.
-
-No other detector property can be updated.
 
 [[ml-update-job-example]]
 ==== {api-examples-title}