From 17b4720df73878b31b04c1db4da9c531857a072e Mon Sep 17 00:00:00 2001 From: Lisa Cawley Date: Fri, 18 Aug 2017 13:00:15 -0700 Subject: [PATCH] [DOCS] Add missing ML create job API options (elastic/x-pack-elasticsearch#2268) * [DOCS] Add missing ML create job API options * [DOCS] Small fixes in ML create job API Original commit: elastic/x-pack-elasticsearch@369bd5bfbb95d0a2e255d44acc86219b85f17d5c --- docs/en/rest-api/ml/jobresource.asciidoc | 5 +++++ docs/en/rest-api/ml/put-job.asciidoc | 23 +++++++++++++++++++---- 2 files changed, 24 insertions(+), 4 deletions(-) diff --git a/docs/en/rest-api/ml/jobresource.asciidoc b/docs/en/rest-api/ml/jobresource.asciidoc index 646dd6b1c28..176bd8169ba 100644 --- a/docs/en/rest-api/ml/jobresource.asciidoc +++ b/docs/en/rest-api/ml/jobresource.asciidoc @@ -28,6 +28,11 @@ so do not set the `background_persist_interval` value too low. `create_time`:: (string) The time the job was created. For example, `1491007356077`. +`custom_settings`:: + (object) Advanced configuration option. Contains custom meta data about the + job. For example, it can contain custom URL information as shown in + {xpack-ref}/ml-configuring-url.html[Adding Custom URLs to Machine Learning Results]. + `data_description`:: (object) Describes the data format and how APIs parse timestamp fields. See <>. diff --git a/docs/en/rest-api/ml/put-job.asciidoc b/docs/en/rest-api/ml/put-job.asciidoc index f336e01afc4..52538a890e0 100644 --- a/docs/en/rest-api/ml/put-job.asciidoc +++ b/docs/en/rest-api/ml/put-job.asciidoc @@ -26,6 +26,14 @@ The create job API enables you to instantiate a job. (object) Specifies runtime limits for the job. See <>. +`background_persist_interval`:: + (time units) Advanced configuration option. The time between each periodic + persistence of the model. See <>. + +`custom_settings`:: + (object) Advanced configuration option. Contains custom meta data about the + job. See <>. + `data_description` (required):: (object) Describes the format of the input data. This object is required, but it can be empty (`{}`). See <>. @@ -37,26 +45,33 @@ The create job API enables you to instantiate a job. (array of strings) A list of job groups. See <>. `model_plot`:: - (object) This advanced configuration option stores model information along - with the results. This adds overhead to the performance of the system and is - not feasible for jobs with many entities, see <>. + (object) Advanced configuration option. Specifies to store model information + along with the results. This adds overhead to the performance of the system + and is not feasible for jobs with many entities, see <>. `model_snapshot_retention_days`:: (long) The time in days that model snapshots are retained for the job. Older snapshots are deleted. The default value is 1 day. For more information about model snapshots, see <>. +`renormalization_window_days`:: + (long) Advanced configuration option. The period over which adjustments to the + score are applied, as new data is seen. See <>. + `results_index_name`:: (string) The name of the index in which to store the {ml} results. The default value is `shared`, which corresponds to the index name `.ml-anomalies-shared`. +`results_retention_days`:: + (long) Advanced configuration option. The number of days for which job results + are retained. See <>. ==== Authorization You must have `manage_ml`, or `manage` cluster privileges to use this API. For more information, see {xpack-ref}/security-privileges.html[Security Privileges]. -//<>. + ==== Examples