[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@369bd5bfbb
This commit is contained in:
parent
d76969a431
commit
17b4720df7
|
@ -28,6 +28,11 @@ so do not set the `background_persist_interval` value too low.
|
||||||
`create_time`::
|
`create_time`::
|
||||||
(string) The time the job was created. For example, `1491007356077`.
|
(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`::
|
`data_description`::
|
||||||
(object) Describes the data format and how APIs parse timestamp fields.
|
(object) Describes the data format and how APIs parse timestamp fields.
|
||||||
See <<ml-datadescription,data description objects>>.
|
See <<ml-datadescription,data description objects>>.
|
||||||
|
|
|
@ -26,6 +26,14 @@ The create job API enables you to instantiate a job.
|
||||||
(object) Specifies runtime limits for the job. See
|
(object) Specifies runtime limits for the job. See
|
||||||
<<ml-apilimits,analysis limits>>.
|
<<ml-apilimits,analysis limits>>.
|
||||||
|
|
||||||
|
`background_persist_interval`::
|
||||||
|
(time units) Advanced configuration option. The time between each periodic
|
||||||
|
persistence of the model. See <<ml-job-resource>>.
|
||||||
|
|
||||||
|
`custom_settings`::
|
||||||
|
(object) Advanced configuration option. Contains custom meta data about the
|
||||||
|
job. See <<ml-job-resource>>.
|
||||||
|
|
||||||
`data_description` (required)::
|
`data_description` (required)::
|
||||||
(object) Describes the format of the input data. This object is required, but
|
(object) Describes the format of the input data. This object is required, but
|
||||||
it can be empty (`{}`). See <<ml-datadescription,data description objects>>.
|
it can be empty (`{}`). See <<ml-datadescription,data description objects>>.
|
||||||
|
@ -37,26 +45,33 @@ The create job API enables you to instantiate a job.
|
||||||
(array of strings) A list of job groups. See <<ml-job-resource>>.
|
(array of strings) A list of job groups. See <<ml-job-resource>>.
|
||||||
|
|
||||||
`model_plot`::
|
`model_plot`::
|
||||||
(object) This advanced configuration option stores model information along
|
(object) Advanced configuration option. Specifies to store model information
|
||||||
with the results. This adds overhead to the performance of the system and is
|
along with the results. This adds overhead to the performance of the system
|
||||||
not feasible for jobs with many entities, see <<ml-apimodelplotconfig>>.
|
and is not feasible for jobs with many entities, see <<ml-apimodelplotconfig>>.
|
||||||
|
|
||||||
`model_snapshot_retention_days`::
|
`model_snapshot_retention_days`::
|
||||||
(long) The time in days that model snapshots are retained for the job.
|
(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
|
Older snapshots are deleted. The default value is 1 day. For more information
|
||||||
about model snapshots, see <<ml-snapshot-resource>>.
|
about model snapshots, see <<ml-snapshot-resource>>.
|
||||||
|
|
||||||
|
`renormalization_window_days`::
|
||||||
|
(long) Advanced configuration option. The period over which adjustments to the
|
||||||
|
score are applied, as new data is seen. See <<ml-job-resource>>.
|
||||||
|
|
||||||
`results_index_name`::
|
`results_index_name`::
|
||||||
(string) The name of the index in which to store the {ml} results. The default
|
(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`.
|
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 <<ml-job-resource>>.
|
||||||
|
|
||||||
==== Authorization
|
==== Authorization
|
||||||
|
|
||||||
You must have `manage_ml`, or `manage` cluster privileges to use this API.
|
You must have `manage_ml`, or `manage` cluster privileges to use this API.
|
||||||
For more information, see
|
For more information, see
|
||||||
{xpack-ref}/security-privileges.html[Security Privileges].
|
{xpack-ref}/security-privileges.html[Security Privileges].
|
||||||
//<<privileges-list-cluster>>.
|
|
||||||
|
|
||||||
==== Examples
|
==== Examples
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue