honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[DOCS] Reformats API parameter details (#44194)

This commit is contained in:
Lisa Cawley 2019-07-12 08:26:31 -07:00 committed by lcawl
parent 4d8bf1c3e3
commit 8fdcf28fac
73 changed files with 696 additions and 692 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/reference/ccr/apis/auto-follow/delete-auto-follow-pattern.asciidoc
View File

@ -54,8 +54,8 @@ This API deletes a configured collection of
[[ccr-delete-auto-follow-pattern-path-parms]]
==== {api-path-parms-title}
`<auto_follow_pattern_name>` (Required)::
(string) Specifies the auto-follow pattern collection to delete.
`<auto_follow_pattern_name>`::
(Required, string) Specifies the auto-follow pattern collection to delete.
[[ccr-delete-auto-follow-pattern-examples]]

6
docs/reference/ccr/apis/auto-follow/get-auto-follow-pattern.asciidoc
View File

@ -68,9 +68,9 @@ This API will return the specified auto-follow pattern collection.
[[ccr-get-auto-follow-pattern-path-parms]]
==== {api-path-parms-title}
`<auto_follow_pattern_name>` (Optional)::
(string) Specifies the auto-follow pattern collection that you want to
retrieve. If you do not specify a name, the API returns information for all
`<auto_follow_pattern_name>`::
(Optional, string) Specifies the auto-follow pattern collection that you want
to retrieve. If you do not specify a name, the API returns information for all
collections.
[[ccr-get-auto-follow-pattern-examples]]

24
docs/reference/ccr/apis/auto-follow/put-auto-follow-pattern.asciidoc
View File

@ -61,24 +61,24 @@ indices.
[[ccr-put-auto-follow-pattern-path-parms]]
==== {api-path-parms-title}
`<auto_follow_pattern_name>` (Required)::
(string) The name of the collection of auto-follow patterns.
`<auto_follow_pattern_name>`::
(Required, string) The name of the collection of auto-follow patterns.
[[ccr-put-auto-follow-pattern-request-body]]
==== {api-request-body-title}
`remote_cluster` (Required)::
(string) The <<modules-remote-clusters,remote cluster>> containing the
leader indices to match against.
`remote_cluster`::
(Required, string) The <<modules-remote-clusters,remote cluster>> containing
the leader indices to match against.
`leader_index_patterns` (Optional)::
(array) An array of simple index patterns to match against indices in the
remote cluster specified by the `remote_cluster` field.
`leader_index_patterns`::
(Optional, array) An array of simple index patterns to match against indices
in the remote cluster specified by the `remote_cluster` field.
`follow_index_pattern` (Optional)::
(string) The name of follower index. The template `{{leader_index}}` can be
used to derive the name of the follower index from the name of the leader
index.
`follow_index_pattern`::
(Optional, string) The name of follower index. The template `{{leader_index}}`
can be used to derive the name of the follower index from the name of the
leader index.
include::../follow-request-body.asciidoc[]

4
docs/reference/ccr/apis/follow/get-follow-info.asciidoc
View File

@ -58,8 +58,8 @@ replication options and whether the follower indices are active or paused.
[[ccr-get-follow-info-path-parms]]
==== {api-path-parms-title}
`<index>` (Required)::
(string) A comma-delimited list of follower index patterns.
`<index>`::
(Required, string) A comma-delimited list of follower index patterns.
[[ccr-get-follow-info-response-body]]
==== {api-response-body-title}

4
docs/reference/ccr/apis/follow/get-follow-stats.asciidoc
View File

@ -57,8 +57,8 @@ following tasks associated with each shard for the specified indices.
[[ccr-get-follow-stats-path-parms]]
==== {api-path-parms-title}
`<index>` (Required)::
(string) A comma-delimited list of index patterns.
`<index>`::
(Required, string) A comma-delimited list of index patterns.
[[ccr-get-follow-stats-response-body]]
==== {api-response-body-title}

24
docs/reference/ccr/apis/follow/post-forget-follower.asciidoc
View File

@ -101,25 +101,25 @@ the <<ccr-post-unfollow,unfollow API>> is invoked.
[[ccr-post-forget-follower-path-parms]]
==== {api-path-parms-title}
`<leader_index>` (Required)::
(string) the name of the leader index
`<leader_index>`::
(Required, string) The name of the leader index.
[[ccr-post-forget-follower-request-body]]
==== {api-request-body-title}
`follower_cluster` (Required)::
(string) The name of the cluster containing the follower index.
`follower_cluster`::
(Required, string) The name of the cluster containing the follower index.
`follower_index` (Required)::
(string) The name of the follower index.
`follower_index`::
(Required, string) The name of the follower index.
`follower_index_uuid` (Required)::
(string) The UUID of the follower index.
`follower_index_uuid`::
(Required, string) The UUID of the follower index.
`leader_remote_cluster` (Required)::
(string) The alias (from the perspective of the cluster containing the
follower index) of the <<modules-remote-clusters,remote cluster>> containing
the leader index.
`leader_remote_cluster`::
(Required, string) The alias (from the perspective of the cluster containing
the follower index) of the <<modules-remote-clusters,remote cluster>>
containing the leader index.
[[ccr-post-forget-follower-examples]]
==== {api-examples-title}

4
docs/reference/ccr/apis/follow/post-pause-follow.asciidoc
View File

@ -53,8 +53,8 @@ following task.
[[ccr-post-pause-follow-path-parms]]
==== {api-path-parms-title}
`<follower_index>` (Required)::
(string) The name of the follower index.
`<follower_index>`::
(Required, string) The name of the follower index.
[[ccr-post-pause-follow-examples]]
==== {api-examples-title}

4
docs/reference/ccr/apis/follow/post-resume-follow.asciidoc
View File

@ -67,8 +67,8 @@ returns, the follower index will resume fetching operations from the leader inde
[[ccr-post-resume-follow-path-parms]]
==== {api-path-parms-title}
`<follower_index>` (Required)::
(string) The name of the follower index.
`<follower_index>`::
(Required, string) The name of the follower index.
[[ccr-post-resume-follow-request-body]]
==== {api-request-body-title}

4
docs/reference/ccr/apis/follow/post-unfollow.asciidoc
View File

@ -60,8 +60,8 @@ irreversible operation.
[[ccr-post-unfollow-path-parms]]
==== {api-path-parms-title}
`<follower_index>` (Required)::
(string) The name of the follower index.
`<follower_index>`::
(Required, string) The name of the follower index.
[[ccr-post-unfollow-examples]]
==== {api-examples-title}

18
docs/reference/ccr/apis/follow/put-follow.asciidoc
View File

@ -56,14 +56,14 @@ referenced leader index. When this API returns, the follower index exists, and
[[ccr-put-follow-path-parms]]
==== {api-path-parms-title}
`<follower_index>` (Required)::
(string) The name of the follower index.
`<follower_index>`::
(Required, string) The name of the follower index.
[[ccr-put-follow-query-params]]
==== {api-query-parms-title}
`wait_for_active_shards` (Optional)::
(integer) Specifies the number of shards to wait on being active before
`wait_for_active_shards`::
(Optional, integer) Specifies the number of shards to wait on being active before
responding. This defaults to waiting on none of the shards to be active. A
shard must be restored from the leader index being active. Restoring a
follower shard requires transferring all the remote Lucene segment files to
@ -73,12 +73,12 @@ referenced leader index. When this API returns, the follower index exists, and
[[ccr-put-follow-request-body]]
==== {api-request-body-title}
`remote_cluster` (Required)::
(string) The <<modules-remote-clusters,remote cluster>> containing the leader
index.
`leader_index`::
(Required, string) The name of the index in the leader cluster to follow.
`leader_index` (Required)::
(string) The name of the index in the leader cluster to follow.
`remote_cluster`::
(Required, string) The <<modules-remote-clusters,remote cluster>> containing
the leader index.
include::../follow-request-body.asciidoc[]

2
docs/reference/data-frames/apis/delete-transform.asciidoc
View File

@ -32,7 +32,7 @@ see {stack-ov}/security-privileges.html[Security privileges] and
==== {api-path-parms-title}
`<data_frame_transform_id>`::
(string) Required. Identifier for the {dataframe-transform}.
(Required, string) Identifier for the {dataframe-transform}.
[[delete-data-frame-transform-examples]]

8
docs/reference/data-frames/apis/get-transform-stats.asciidoc
View File

@ -51,7 +51,7 @@ specifying `*` as the `<data_frame_transform_id>`, or by omitting the
==== {api-path-parms-title}
`<data_frame_transform_id>`::
(string) Optional. Identifier for the {dataframe-transform}. It can be a
(Optional, string) Identifier for the {dataframe-transform}. It can be a
{dataframe-transform} identifier or a wildcard expression. If you do not
specify one of these options, the API returns information for all
{dataframe-transforms}.
@ -61,7 +61,7 @@ specifying `*` as the `<data_frame_transform_id>`, or by omitting the
==== {api-query-parms-title}
`allow_no_match`::
(boolean) Optional. Specifies what to do when the request:
(Optional, boolean) Specifies what to do when the request:
+
--
* Contains wildcard expressions and there are no {dataframe-transforms} that match.
@ -75,11 +75,11 @@ are no matches or only partial matches.
--
`from`::
(integer) Optional. Skips the specified number of {dataframe-transforms}. The
(Optional, integer) Skips the specified number of {dataframe-transforms}. The
default value is `0`.
`size`::
(integer) Optional. Specifies the maximum number of {dataframe-transforms} to obtain. The default value is `100`.
(Optional, integer) Specifies the maximum number of {dataframe-transforms} to obtain. The default value is `100`.
[[get-data-frame-transform-stats-response]]
==== {api-response-body-title}

8
docs/reference/data-frames/apis/get-transform.asciidoc
View File

@ -47,7 +47,7 @@ specifying `*` as the `<data_frame_transform_id>`, or by omitting the
==== {api-path-parms-title}
`<data_frame_transform_id>`::
(string) Optional. Identifier for the {dataframe-transform}. It can be a
(Optional, string) Identifier for the {dataframe-transform}. It can be a
{dataframe-transform} identifier or a wildcard expression. If you do not
specify one of these options, the API returns information for all
{dataframe-transforms}.
@ -56,7 +56,7 @@ specifying `*` as the `<data_frame_transform_id>`, or by omitting the
==== {api-query-parms-title}
`allow_no_match`::
(boolean) Optional. Specifies what to do when the request:
(Optional, boolean) Specifies what to do when the request:
+
--
* Contains wildcard expressions and there are no {dataframe-transforms} that match.
@ -70,11 +70,11 @@ are no matches or only partial matches.
--
`from`::
(integer) Optional. Skips the specified number of {dataframe-transforms}. The
(Optional, integer) Skips the specified number of {dataframe-transforms}. The
default value is `0`.
`size`::
(integer) Optional. Specifies the maximum number of {dataframe-transforms} to obtain. The default value is `100`.
(Optional, integer) Specifies the maximum number of {dataframe-transforms} to obtain. The default value is `100`.
[[get-data-frame-transform-response]]
==== {api-response-body-title}

4
docs/reference/data-frames/apis/preview-transform.asciidoc
View File

@ -40,10 +40,10 @@ on all the current data in the source index.
==== {api-request-body-title}
`source`::
(object) Required. The source index or index pattern.
(Required, object) The source index or index pattern.
`pivot`::
(object) Required. Defines the pivot function `group by` fields and the
(Required, object) Defines the pivot function `group by` fields and the
aggregation to reduce the data. See <<data-frame-transform-pivot>>.
[[preview-data-frame-transform-response]]

12
docs/reference/data-frames/apis/put-transform.asciidoc
View File

@ -41,7 +41,7 @@ IMPORTANT: You must use {kib} or this API to create a {dataframe-transform}.
==== {api-path-parms-title}
`<data_frame_transform_id>`::
(string) Required. Identifier for the {dataframe-transform}. This identifier
(Required, string) Identifier for the {dataframe-transform}. This identifier
can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and
underscores. It must start and end with alphanumeric characters.
@ -49,23 +49,23 @@ IMPORTANT: You must use {kib} or this API to create a {dataframe-transform}.
==== {api-request-body-title}
`description`::
(string) Optional. Free text description of the {dataframe-transform}.
(Optional, string) Free text description of the {dataframe-transform}.
`dest`::
(object) Required. The destination configuration, which consists of `index`
(Required, object) Required. The destination configuration, which consists of `index`
and optionally a `pipeline` id. See <<data-frame-transform-dest>>.
`frequency`::
(time units) Optional. The interval between checks for changes in the source indices
(Optional, time units) The interval between checks for changes in the source indices
when the {dataframe-transform} is running continuously. Defaults to `1m`.
The lowest permitted value is `1s`; the highest `1h`.
`pivot`::
(object) Required. Defines the pivot function `group by` fields and the aggregation to
(Required, object) Defines the pivot function `group by` fields and the aggregation to
reduce the data. See <<data-frame-transform-pivot>>.
`source`::
(object) Required. The source configuration, which consists of `index` and
(Required, object) The source configuration, which consists of `index` and
optionally a `query`. See <<data-frame-transform-source>>.
[[put-data-frame-transform-example]]

2
docs/reference/data-frames/apis/start-transform.asciidoc
View File

@ -31,7 +31,7 @@ have `view_index_metadata` privileges on the source index for the
==== {api-path-parms-title}
`<data_frame_transform_id>`::
(string) Required. Identifier for the {dataframe-transform}. This identifier
(Required, string) Identifier for the {dataframe-transform}. This identifier
can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and
underscores. It must start and end with alphanumeric characters.

8
docs/reference/data-frames/apis/stop-transform.asciidoc
View File

@ -42,7 +42,7 @@ All {dataframe-transforms} can be stopped by using `_all` or `*` as the
==== {api-path-parms-title}
`<data_frame_transform_id>`::
(string) Required. Identifier for the {dataframe-transform}. This identifier
(Required, string) Identifier for the {dataframe-transform}. This identifier
can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and
underscores. It must start and end with alphanumeric characters.
@ -50,7 +50,7 @@ All {dataframe-transforms} can be stopped by using `_all` or `*` as the
==== {api-query-parms-title}
`allow_no_match`::
(boolean) Optional. Specifies what to do when the request:
(Optional, boolean) Specifies what to do when the request:
+
--
* Contains wildcard expressions and there are no {dataframe-transforms} that match.
@ -69,7 +69,7 @@ are no matches or only partial matches.
--
`timeout`::
(time value) Optional. If `wait_for_completion=true`, the API blocks for (at
(Optional, time value) If `wait_for_completion=true`, the API blocks for (at
maximum) the specified duration while waiting for the transform to stop. If
more than `timeout` time has passed, the API throws a timeout exception. Even
if a timeout exception is thrown, the stop request is still processing and
@ -77,7 +77,7 @@ are no matches or only partial matches.
call itself timed out while waiting for the status change. Defaults to `30s`
`wait_for_completion`::
(boolean) Optional. If set to `true`, causes the API to block until the indexer
(Optional, boolean) If set to `true`, causes the API to block until the indexer
state completely stops. If set to `false`, the API returns immediately and the
indexer will be stopped asynchronously in the background. Defaults to `false`.

4
docs/reference/indices/apis/freeze.asciidoc
View File

@ -31,8 +31,8 @@ limitation might be removed in the future.
[[freeze-index-api-path-parms]]
==== {api-path-parms-title}
`<index>` (Required)::
(string) Identifier for the index.
`<index>`::
(Required, string) Identifier for the index.
[[freeze-index-api-examples]]
==== {api-examples-title}

4
docs/reference/indices/apis/unfreeze.asciidoc
View File

@ -30,8 +30,8 @@ limitation might be removed in the future.
[[unfreeze-index-api-path-parms]]
==== {api-path-parms-title}
`<index>` (Required)::
(string) Identifier for the index.
`<index>`::
(Required, string) Identifier for the index.
[[unfreeze-index-api-examples]]
==== {api-examples-title}

16
docs/reference/ml/apis/close-job.asciidoc
View File

@ -57,19 +57,19 @@ results the job might have recently produced or might produce in the future.
[[ml-close-job-path-parms]]
==== {api-path-parms-title}
`<job_id>` (Required)::
(string) Identifier for the job. It can be a job identifier, a group name, or
a wildcard expression.
`<job_id>`::
(Required, string) Identifier for the job. It can be a job identifier, a group
name, or a wildcard expression.
[[ml-close-job-query-parms]]
==== {api-query-parms-title}
`force` (Optional)::
(boolean) Use to close a failed job, or to forcefully close a job which has not
responded to its initial close request.
`force`::
(Optional, boolean) Use to close a failed job, or to forcefully close a job
which has not responded to its initial close request.
`timeout` (Optional)::
(time units) Controls the time to wait until a job has closed.
`timeout`::
(Optional, time units) Controls the time to wait until a job has closed.
The default value is 30 minutes.
[[ml-close-job-example]]

10
docs/reference/ml/apis/delete-calendar-event.asciidoc
View File

@ -30,12 +30,12 @@ events and delete the calendar, see the
[[ml-delete-calendar-event-path-parms]]
==== {api-path-parms-title}
`<calendar_id>` (Required)::
(string) Identifier for the calendar.
`<calendar_id>`::
(Required, string) Identifier for the calendar.
`<event_id>` (Required)::
(string) Identifier for the scheduled event. You can obtain this identifier
by using the <<ml-get-calendar-event,get calendar events API>>.
`<event_id>`::
(Required, string) Identifier for the scheduled event. You can obtain this
identifier by using the <<ml-get-calendar-event,get calendar events API>>.
[[ml-delete-calendar-event-example]]
==== {api-examples-title}

10
docs/reference/ml/apis/delete-calendar-job.asciidoc
View File

@ -23,12 +23,12 @@ Deletes jobs from a calendar.
[[ml-delete-calendar-job-path-parms]]
==== {api-path-parms-title}
`<calendar_id>` (Required)::
(string) Identifier for the calendar.
`<calendar_id>`::
(Required, string) Identifier for the calendar.
`<job_id>` (Required)::
(string) An identifier for the job. It can be a job identifier, a group name,
or a comma-separated list of jobs or groups.
`<job_id>`::
(Required, string) An identifier for the job. It can be a job identifier, a
group name, or a comma-separated list of jobs or groups.
[[ml-delete-calendar-job-example]]
==== {api-examples-title}

4
docs/reference/ml/apis/delete-calendar.asciidoc
View File

@ -29,8 +29,8 @@ calendar.
[[ml-delete-calendar-path-parms]]
==== {api-path-parms-title}
`<calendar_id>` (Required)::
(string) Identifier for the calendar.
`<calendar_id>`::
(Required, string) Identifier for the calendar.
[[ml-delete-calendar-example]]
==== {api-examples-title}

18
docs/reference/ml/apis/delete-datafeed.asciidoc
View File

@ -18,28 +18,24 @@ Deletes an existing {dfeed}.
[[ml-delete-datafeed-prereqs]]
==== {api-prereq-title}
* Unless you use the `force` parameter, you must stop the {dfeed} before you
can delete it.
* If the {es} {security-features} are enabled, you must have `manage_ml` or
`manage` cluster privileges to use this API. See
{stack-ov}/security-privileges.html[Security privileges].
[[ml-delete-datafeed-desc]]
==== {api-description-title}
NOTE: Unless you use the `force` parameter, you must stop the {dfeed} before you
can delete it.
[[ml-delete-datafeed-path-parms]]
==== {api-path-parms-title}
`<feed_id>` (Required)::
(string) Identifier for the {dfeed}.
`<feed_id>`::
(Required, string) Identifier for the {dfeed}.
[[ml-delete-datafeed-query-parms]]
==== {api-query-parms-title}
`force` (Optional)::
(boolean) Use to forcefully delete a started {dfeed}; this method is quicker
than stopping and deleting the {dfeed}.
`force`::
(Optional, boolean) Use to forcefully delete a started {dfeed}; this method is
quicker than stopping and deleting the {dfeed}.
[[ml-delete-datafeed-example]]
==== {api-examples-title}

8
docs/reference/ml/apis/delete-dfanalytics.asciidoc
View File

@ -7,10 +7,10 @@
<titleabbrev>Delete {dfanalytics-jobs}</titleabbrev>
++++
experimental[]
Deletes an existing {dfanalytics-job}.
experimental[]
[[ml-delete-dfanalytics-request]]
==== {api-request-title}
@ -26,8 +26,8 @@ information, see {stack-ov}/security-privileges.html[Security privileges] and
[[ml-delete-dfanalytics-path-params]]
==== {api-path-parms-title}
`<data_frame_analytics_id>` (Required)::
(string) Identifier for the {dfanalytics-job} you want to delete.
`<data_frame_analytics_id>`::
(Required, string) Identifier for the {dfanalytics-job} you want to delete.
[[ml-delete-dfanalytics-example]]
==== {api-examples-title}

4
docs/reference/ml/apis/delete-filter.asciidoc
View File

@ -30,8 +30,8 @@ update or delete the job before you can delete the filter.
[[ml-delete-filter-path-parms]]
==== {api-path-parms-title}
`<filter_id>` (Required)::
(string) Identifier for the filter.
`<filter_id>`::
(Required, string) Identifier for the filter.
[[ml-delete-filter-example]]
==== {api-examples-title}

30
docs/reference/ml/apis/delete-forecast.asciidoc
View File

@ -40,28 +40,28 @@ For more information, see
[[ml-delete-forecast-path-parms]]
==== {api-path-parms-title}
`<job_id>` (Required)::
(string) Identifier for the job.
`forecast_id` (Optional)::
(string) A comma-separated list of forecast identifiers.
`<forecast_id>`::
(Optional, string) A comma-separated list of forecast identifiers.
If you do not specify this optional parameter or if you specify `_all`, the
API deletes all forecasts from the job.
`<job_id>`::
(Required, string) Required. Identifier for the job.
[[ml-delete-forecast-query-parms]]
==== {api-query-parms-title}
`allow_no_forecasts` (Optional)::
(boolean) Specifies whether an error occurs when there are no forecasts. In
particular, if this parameter is set to `false` and there are no forecasts
associated with the job, attempts to delete all forecasts return an error.
The default value is `true`.
`allow_no_forecasts`::
(Optional, boolean) Specifies whether an error occurs when there are no
forecasts. In particular, if this parameter is set to `false` and there are no
forecasts associated with the job, attempts to delete all forecasts return an
error. The default value is `true`.
`timeout` (Optional)::
(time units) Specifies the period of time to wait for the completion of the
delete operation. When this period of time elapses, the API fails and returns
an error. The default value is `30s`. For more information about time units,
see <<time-units>>.
`timeout`::
(Optional, time units) Specifies the period of time to wait for the completion
of the delete operation. When this period of time elapses, the API fails and
returns an error. The default value is `30s`. For more information about time
units, see <<time-units>>.
[[ml-delete-forecast-example]]
==== {api-examples-title}

16
docs/reference/ml/apis/delete-job.asciidoc
View File

@ -40,19 +40,19 @@ separated list.
[[ml-delete-job-path-parms]]
==== {api-path-parms-title}
`<job_id>` (Required)::
(string) Identifier for the job.
`<job_id>`::
(Required, string) Identifier for the job.
[[ml-delete-job-query-parms]]
==== {api-query-parms-title}
`force` (Optional)::
(boolean) Use to forcefully delete an opened job; this method is quicker than
closing and deleting the job.
`force`::
(Optional, boolean) Use to forcefully delete an opened job; this method is
quicker than closing and deleting the job.
`wait_for_completion` (Optional)::
(boolean) Specifies whether the request should return immediately or wait
until the job deletion completes. Defaults to `true`.
`wait_for_completion`::
(Optional, boolean) Specifies whether the request should return immediately or
wait until the job deletion completes. Defaults to `true`.
[[ml-delete-job-example]]
==== {api-examples-title}

8
docs/reference/ml/apis/delete-snapshot.asciidoc
View File

@ -30,11 +30,11 @@ the `model_snapshot_id` in the results from the get jobs API.
[[ml-delete-snapshot-path-parms]]
==== {api-path-parms-title}
`<job_id>` (Required)::
(string) Identifier for the job.
`<job_id>`::
(Required, string) Identifier for the job.
`<snapshot_id>` (Required)::
(string) Identifier for the model snapshot.
`<snapshot_id>`::
(Required, string) Identifier for the model snapshot.
[[ml-delete-snapshot-example]]
==== {api-examples-title}

11
docs/reference/ml/apis/evaluate-dfanalytics.asciidoc
View File

@ -40,13 +40,15 @@ packages together commonly used metrics for various analyses.
[[ml-evaluate-dfanalytics-request-body]]
==== {api-request-body-title}
`index` (Required)::
(object) Defines the `index` in which the evaluation will be performed.
`index`::
(Required, object) Defines the `index` in which the evaluation will be
performed.
`evaluation` (Required)::
(object) Defines the type of evaluation you want to perform. For example:
`evaluation`::
(Required, object) Defines the type of evaluation you want to perform. For example:
`binary_soft_classification`. See <<ml-evaluate-dfanalytics-resources>>.
////
[[ml-evaluate-dfanalytics-results]]
==== {api-response-body-title}
@ -61,6 +63,7 @@ packages together commonly used metrics for various analyses.
`precision`::: TBD
`recall`::: TBD
////
[[ml-evaluate-dfanalytics-example]]
==== {api-examples-title}

2
docs/reference/ml/apis/filterresource.asciidoc
View File

@ -9,7 +9,7 @@ A filter resource has the following properties:
(string) A string that uniquely identifies the filter.
`description`::
(array) A description of the filter.
(string) A description of the filter.
`items`::
(array of strings) An array of strings which is the filter item list.

142
docs/reference/ml/apis/find-file-structure.asciidoc
View File

@ -58,62 +58,64 @@ chosen.
[[ml-find-file-structure-query-parms]]
==== {api-query-parms-title}
`charset` (Optional)::
(string) The file's character set. It must be a character set that is supported
by the JVM that {es} uses. For example, `UTF-8`, `UTF-16LE`, `windows-1252`, or
`EUC-JP`. If this parameter is not specified, the structure finder chooses an
appropriate character set.
`charset`::
(string) Optional. The file's character set. It must be a character set that
is supported by the JVM that {es} uses. For example, `UTF-8`, `UTF-16LE`,
`windows-1252`, or `EUC-JP`. If this parameter is not specified, the structure
finder chooses an appropriate character set.
`column_names` (Optional)::
(string) If you have set `format` to `delimited`, you can specify the column names
in a comma-separated list. If this parameter is not specified, the structure
finder uses the column names from the header row of the file. If the file does
not have a header role, columns are named "column1", "column2", "column3", etc.
`column_names`::
(string) Optional. If you have set `format` to `delimited`, you can specify
the column names in a comma-separated list. If this parameter is not specified,
the structure finder uses the column names from the header row of the file. If
the file does not have a header role, columns are named "column1", "column2",
"column3", etc.
`delimiter` (Optional)::
(string) If you have set `format` to `delimited`, you can specify the character used
to delimit the values in each row. Only a single character is supported; the
delimiter cannot have multiple characters. If this parameter is not specified,
the structure finder considers the following possibilities: comma, tab,
semi-colon, and pipe (`|`).
`delimiter`::
(string) Optional. If you have set `format` to `delimited`, you can specify
the character used to delimit the values in each row. Only a single character
is supported; the delimiter cannot have multiple characters. If this parameter
is not specified, the structure finder considers the following possibilities:
comma, tab, semi-colon, and pipe (`|`).
`explain` (Optional)::
(boolean) If this parameter is set to `true`, the response includes a field
named `explanation`, which is an array of strings that indicate how the
structure finder produced its result. The default value is `false`.
`explain`::
(boolean) Optional. If this parameter is set to `true`, the response includes
a field named `explanation`, which is an array of strings that indicate how
the structure finder produced its result. The default value is `false`.
`format` (Optional)::
(string) The high level structure of the file. Valid values are `ndjson`, `xml`,
`delimited`, and `semi_structured_text`. If this parameter is not specified,
the structure finder chooses one.
`format`::
(string) Optional. The high level structure of the file. Valid values are
`ndjson`, `xml`, `delimited`, and `semi_structured_text`. If this parameter is
not specified, the structure finder chooses one.
`grok_pattern` (Optional)::
(string) If you have set `format` to `semi_structured_text`, you can specify a Grok
pattern that is used to extract fields from every message in the file. The
name of the timestamp field in the Grok pattern must match what is specified
in the `timestamp_field` parameter. If that parameter is not specified, the
name of the timestamp field in the Grok pattern must match "timestamp". If
`grok_pattern` is not specified, the structure finder creates a Grok pattern.
`grok_pattern`::
(string) Optional. If you have set `format` to `semi_structured_text`, you can
specify a Grok pattern that is used to extract fields from every message in
the file. The name of the timestamp field in the Grok pattern must match what
is specified in the `timestamp_field` parameter. If that parameter is not
specified, the name of the timestamp field in the Grok pattern must match
"timestamp". If `grok_pattern` is not specified, the structure finder creates
a Grok pattern.
`has_header_row` (Optional)::
(boolean) If you have set `format` to `delimited`, you can use this parameter to
indicate whether the column names are in the first row of the file. If this
parameter is not specified, the structure finder guesses based on the similarity of
the first row of the file to other rows.
`has_header_row`::
(boolean) Optional. If you have set `format` to `delimited`, you can use this
parameter to indicate whether the column names are in the first row of the
file. If this parameter is not specified, the structure finder guesses based
on the similarity of the first row of the file to other rows.
`line_merge_size_limit` (Optional)::
(unsigned integer) The maximum number of characters in a message when lines are
merged to form messages while analyzing semi-structured files. The default
is 10000. If you have extremely long messages you may need to increase this, but
be aware that this may lead to very long processing times if the way to group
lines into messages is misdetected.
`line_merge_size_limit`::
(unsigned integer) Optional. The maximum number of characters in a message
when lines are merged to form messages while analyzing semi-structured files.
The default is `10000`. If you have extremely long messages you may need to
increase this, but be aware that this may lead to very long processing times
if the way to group lines into messages is misdetected.
`lines_to_sample` (Optional)::
(unsigned integer) The number of lines to include in the structural analysis,
starting from the beginning of the file. The minimum is 2; the default
is 1000. If the value of this parameter is greater than the number of lines in
the file, the analysis proceeds (as long as there are at least two lines in the
file) for all of the lines. +
`lines_to_sample`::
(unsigned integer) Optional. The number of lines to include in the structural
analysis, starting from the beginning of the file. The minimum is 2; the
default is `1000`. If the value of this parameter is greater than the number
of lines in the file, the analysis proceeds (as long as there are at least two
lines in the file) for all of the lines. +
+
--
NOTE: The number of lines and the variation of the lines affects the speed of
@ -124,29 +126,29 @@ efficient to upload a sample file with more variety in the first 1000 lines than
to request analysis of 100000 lines to achieve some variety.
--
`quote` (Optional)::
(string) If you have set `format` to `delimited`, you can specify the character used
to quote the values in each row if they contain newlines or the delimiter
character. Only a single character is supported. If this parameter is not
specified, the default value is a double quote (`"`). If your delimited file
format does not use quoting, a workaround is to set this argument to a
character that does not appear anywhere in the sample.
`quote`::
(string) Optional. If you have set `format` to `delimited`, you can specify
the character used to quote the values in each row if they contain newlines or
the delimiter character. Only a single character is supported. If this
parameter is not specified, the default value is a double quote (`"`). If your
delimited file format does not use quoting, a workaround is to set this
argument to a character that does not appear anywhere in the sample.
`should_trim_fields` (Optional)::
(boolean) If you have set `format` to `delimited`, you can specify whether values
between delimiters should have whitespace trimmed from them. If this parameter
is not specified and the delimiter is pipe (`|`), the default value is `true`.
Otherwise, the default value is `false`.
`should_trim_fields`::
(boolean) Optional. If you have set `format` to `delimited`, you can specify
whether values between delimiters should have whitespace trimmed from them. If
this parameter is not specified and the delimiter is pipe (`|`), the default
value is `true`. Otherwise, the default value is `false`.
`timeout` (Optional)::
(time) Sets the maximum amount of time that the structure analysis make take.
If the analysis is still running when the timeout expires then it will be
aborted. The default value is 25 seconds.
`timeout`::
(time) Optional. Sets the maximum amount of time that the structure analysis
make take. If the analysis is still running when the timeout expires then it
will be aborted. The default value is 25 seconds.
`timestamp_field` (Optional)::
(string) The name of the field that contains the primary timestamp of each
record in the file. In particular, if the file were ingested into an index,
this is the field that would be used to populate the `@timestamp` field. +
`timestamp_field`::
(string) Optional. The name of the field that contains the primary timestamp
of each record in the file. In particular, if the file were ingested into an
index, this is the field that would be used to populate the `@timestamp` field.
+
--
If the `format` is `semi_structured_text`, this field must match the name of the
@ -162,8 +164,8 @@ field (if any) is the primary timestamp field. For structured file formats, it
is not compulsory to have a timestamp in the file.
--
`timestamp_format` (Optional)::
(string) The Java time format of the timestamp field in the file. +
`timestamp_format`::
(string) Optional. The Java time format of the timestamp field in the file. +
+
--
NOTE: Only a subset of Java time format letter groups are supported:

32
docs/reference/ml/apis/flush-job.asciidoc
View File

@ -36,32 +36,32 @@ opened again before analyzing further data.
[[ml-flush-job-path-parms]]
==== {api-path-parms-title}
`<job_id>` (Required)::
(string) Identifier for the job.
`<job_id>`::
(string) Required. Identifier for the job.
[[ml-flush-job-query-parms]]
==== {api-query-parms-title}
`advance_time` (Optional)::
(string) Specifies to advance to a particular time value. Results are
`advance_time`::
(string) Optional. Specifies to advance to a particular time value. Results are
generated and the model is updated for data from the specified time interval.
`calc_interim` (Optional)::
(boolean) If true, calculates the interim results for the most recent bucket
or all buckets within the latency period.
`calc_interim`::
(boolean) Optional. If true, calculates the interim results for the most
recent bucket or all buckets within the latency period.
`end` (Optional)::
(string) When used in conjunction with `calc_interim`, specifies the range
of buckets on which to calculate interim results.
`end`::
(string) Optional. When used in conjunction with `calc_interim`, specifies the
range of buckets on which to calculate interim results.
`skip_time` (Optional)::
(string) Specifies to skip to a particular time value. Results are not
generated and the model is not updated for data from the specified time
`skip_time`::
(string) Optional. Specifies to skip to a particular time value. Results are
not generated and the model is not updated for data from the specified time
interval.
`start` (Optional)::
(string) When used in conjunction with `calc_interim`, specifies the range of
buckets on which to calculate interim results.
`start`::
(string) Optional. When used in conjunction with `calc_interim`, specifies the
range of buckets on which to calculate interim results.
[[ml-flush-job-example]]
==== {api-examples-title}

14
docs/reference/ml/apis/forecast.asciidoc
View File

@ -36,20 +36,20 @@ forecast. For more information about this property, see <<ml-job-resource>>.
[[ml-forecast-path-parms]]
==== {api-path-parms-title}
`<job_id>` (Required)::
(string) Identifier for the job.
`<job_id>`::
(Required, string) Identifier for the job.
[[ml-forecast-request-body]]
==== {api-request-body-title}
`duration` (Optional)::
(time units) A period of time that indicates how far into the future to
forecast. For example, `30d` corresponds to 30 days. The default value is 1
`duration`::
(Optional, time units) A period of time that indicates how far into the future
to forecast. For example, `30d` corresponds to 30 days. The default value is 1
day. The forecast starts at the last record that was processed. For more
information about time units, see <<time-units>>.
`expires_in` (Optional)::
(time units) The period of time that forecast results are retained.
`expires_in`::
(Optional, time units) The period of time that forecast results are retained.
After a forecast expires, the results are deleted. The default value is 14 days.
If set to a value of `0`, the forecast is never automatically deleted.
For more information about time units, see <<time-units>>.

50
docs/reference/ml/apis/get-bucket.asciidoc
View File

@ -35,45 +35,45 @@ bucket.
[[ml-get-bucket-path-parms]]
==== {api-path-parms-title}
`<job_id>` (Required)::
(string) Identifier for the job
`<job_id>`::
(Required, string) Identifier for the job
`<timestamp>` (Optional)::
(string) The timestamp of a single bucket result.
If you do not specify this parameter, the API returns information
about all buckets.
`<timestamp>`::
(Optional, string) The timestamp of a single bucket result. If you do not
specify this parameter, the API returns information about all buckets.
[[ml-get-bucket-request-body]]
==== {api-request-body-title}
`anomaly_score` (Optional)::
(double) Returns buckets with anomaly scores greater or equal than this value.
`anomaly_score`::
(Optional, double) Returns buckets with anomaly scores greater or equal than
this value.
`desc` (Optional)::
(boolean) If true, the buckets are sorted in descending order.
`desc`::
(Optional, boolean) If true, the buckets are sorted in descending order.
`end` (Optional)::
(string) Returns buckets with timestamps earlier than this time.
`end`::
(Optional, string) Returns buckets with timestamps earlier than this time.
`exclude_interim` (Optional)::
(boolean) If true, the output excludes interim results.
By default, interim results are included.
`exclude_interim`::
(Optional, boolean) If true, the output excludes interim results. By default,
interim results are included.
`expand` (Optional)::
(boolean) If true, the output includes anomaly records.
`expand`::
(Optional, boolean) If true, the output includes anomaly records.
`page` (Optional)::
`page`::
`from`:::
(integer) Skips the specified number of buckets.
(Optional, integer) Skips the specified number of buckets.
`size`:::
(integer) Specifies the maximum number of buckets to obtain.
(Optional, integer) Specifies the maximum number of buckets to obtain.
`sort` (Optional)::
(string) Specifies the sort field for the requested buckets.
By default, the buckets are sorted by the `timestamp` field.
`sort`::
(Optional, string) Specifies the sort field for the requested buckets. By
default, the buckets are sorted by the `timestamp` field.
`start` (Optional)::
(string) Returns buckets with timestamps after this time.
`start`::
(Optional, string) Returns buckets with timestamps after this time.
[[ml-get-bucket-results]]
==== {api-response-body-title}

24
docs/reference/ml/apis/get-calendar-event.asciidoc
View File

@ -6,8 +6,7 @@
<titleabbrev>Get scheduled events</titleabbrev>
++++
Retrieves information about the scheduled events in
calendars.
Retrieves information about the scheduled events in calendars.
[[ml-get-calendar-event-request]]
==== {api-request-title}
@ -32,23 +31,24 @@ calendars by using `_all`.
[[ml-get-calendar-event-path-parms]]
==== {api-path-parms-title}
`<calendar_id>` (Required)::
(string) Identifier for the calendar.
`<calendar_id>`::
(Required, string) Identifier for the calendar.
[[ml-get-calendar-event-request-body]]
==== {api-request-body-title}
`end` (Optional)::
(string) Specifies to get events with timestamps earlier than this time.
`end`::
(Optional, string) Specifies to get events with timestamps earlier than this
time.
`from` (Optional)::
(integer) Skips the specified number of events.
`from`::
(Optional, integer) Skips the specified number of events.
`size` (Optional)::
(integer) Specifies the maximum number of events to obtain.
`size`::
(Optional, integer) Specifies the maximum number of events to obtain.
`start` (Optional)::
(string) Specifies to get events with timestamps after this time.
`start`::
(Optional, string) Specifies to get events with timestamps after this time.
[[ml-get-calendar-event-results]]
==== {api-response-body-title}

12
docs/reference/ml/apis/get-calendar.asciidoc
View File

@ -31,18 +31,18 @@ You can get information for a single calendar or for all calendars by using
[[ml-get-calendar-path-parms]]
==== {api-path-parms-title}
`<calendar_id>` (Required)::
(string) Identifier for the calendar.
`<calendar_id>`::
(Required, string) Identifier for the calendar.
[[ml-get-calendar-request-body]]
==== {api-request-body-title}
`page` (Optional)::
`page`::
`from`:::
(integer) Skips the specified number of calendars.
(Optional, integer) Skips the specified number of calendars.
`size` (Optional):::
(integer) Specifies the maximum number of calendars to obtain.
`size`:::
(Optional, integer) Specifies the maximum number of calendars to obtain.
[[ml-get-calendar-results]]
==== {api-response-body-title}

16
docs/reference/ml/apis/get-category.asciidoc
View File

@ -34,21 +34,21 @@ For more information about categories, see
[[ml-get-category-path-parms]]
==== {api-path-parms-title}
`<job_id>` (Required)::
(string) Identifier for the job.
`<job_id>`::
(Required, string) Identifier for the job.
`<category_id>` (Optional)::
(long) Identifier for the category. If you do not specify this parameter,
the API returns information about all categories in the job.
`<category_id>`::
(Optional, long) Identifier for the category. If you do not specify this
parameter, the API returns information about all categories in the job.
[[ml-get-category-request-body]]
==== {api-request-body-title}
`page` (Optional)::
`page`::
`from`:::
(integer) Skips the specified number of categories.
(Optional, integer) Skips the specified number of categories.
`size`:::
(integer) Specifies the maximum number of categories to obtain.
(Optional, integer) Specifies the maximum number of categories to obtain.
[[ml-get-category-results]]
==== {api-response-body-title}

6
docs/reference/ml/apis/get-datafeed-stats.asciidoc
View File

@ -44,9 +44,9 @@ IMPORTANT: This API returns a maximum of 10,000 {dfeeds}.
[[ml-get-datafeed-stats-path-parms]]
==== {api-path-parms-title}
`<feed_id>` (Optional)::
(string) Identifier for the {dfeed}. It can be a {dfeed} identifier or a
wildcard expression. If you do not specify one of these options, the API
`<feed_id>`::
(Optional, string) Identifier for the {dfeed}. It can be a {dfeed} identifier
or a wildcard expression. If you do not specify one of these options, the API
returns statistics for all {dfeeds}.
[[ml-get-datafeed-stats-results]]

6
docs/reference/ml/apis/get-datafeed.asciidoc
View File

@ -41,9 +41,9 @@ IMPORTANT: This API returns a maximum of 10,000 {dfeeds}.
[[ml-get-datafeed-path-parms]]
==== {api-path-parms-title}
`<feed_id>` (Optional)::
(string) Identifier for the {dfeed}. It can be a {dfeed} identifier or a
wildcard expression. If you do not specify one of these options, the API
`<feed_id>`::
(Optional, string) Identifier for the {dfeed}. It can be a {dfeed} identifier
or a wildcard expression. If you do not specify one of these options, the API
returns information about all {dfeeds}.
[[ml-get-datafeed-results]]

29
docs/reference/ml/apis/get-dfanalytics-stats.asciidoc
View File

@ -7,10 +7,10 @@
<titleabbrev>Get {dfanalytics-jobs} stats</titleabbrev>
++++
experimental[]
Retrieves usage information for {dfanalytics-jobs}.
experimental[]
[[ml-get-dfanalytics-stats-request]]
==== {api-request-title}
@ -34,25 +34,26 @@ information, see {stack-ov}/security-privileges.html[Security privileges] and
[[ml-get-dfanalytics-stats-path-params]]
==== {api-path-parms-title}
`<data_frame_analytics_id>` (Optional)::
(string) Identifier for the {dfanalytics-job}. If you do not specify one of
these options, the API returns information for the first hundred
`<data_frame_analytics_id>`::
(Optional, string)Identifier for the {dfanalytics-job}. If you do not specify
one of these options, the API returns information for the first hundred
{dfanalytics-jobs}.
[[ml-get-dfanalytics-stats-query-params]]
==== {api-query-parms-title}
`allow_no_match` (Optional)::
(boolean) If `false` and the `data_frame_analytics_id` does not match any
{dfanalytics-job} an error will be returned. The default value is `true`.
`allow_no_match`::
(Optional, boolean) If `false` and the `data_frame_analytics_id` does not
match any {dfanalytics-job} an error will be returned. The default value is
`true`.
`from` (Optional)::
(integer) Skips the specified number of {dfanalytics-jobs}. The default value
is `0`.
`from`::
(Optional, integer) Skips the specified number of {dfanalytics-jobs}. The
default value is `0`.
`size` (Optional)::
(integer) Specifies the maximum number of {dfanalytics-jobs} to obtain. The
default value is `100`.
`size`::
(Optional, integer) Specifies the maximum number of {dfanalytics-jobs} to
obtain. The default value is `100`.
[[ml-get-dfanalytics-stats-response-body]]
==== {api-response-body-title}

27
docs/reference/ml/apis/get-dfanalytics.asciidoc
View File

@ -7,10 +7,10 @@
<titleabbrev>Get {dfanalytics-jobs}</titleabbrev>
++++
experimental[]
Retrieves configuration information for {dfanalytics-jobs}.
experimental[]
[[ml-get-dfanalytics-request]]
==== {api-request-title}
@ -41,9 +41,9 @@ You can get information for all {dfanalytics-jobs} by using _all, by specifying
[[ml-get-dfanalytics-path-params]]
==== {api-path-parms-title}
`<data_frame_analytics_id>` (Optional)::
(string) Identifier for the {dfanalytics-job}. If you do not specify one of
these options, the API returns information for the first hundred
`<data_frame_analytics_id>`::
(Optional, string) Identifier for the {dfanalytics-job}. If you do not specify
one of these options, the API returns information for the first hundred
{dfanalytics-jobs}.
`allow_no_match` (Optional)::
@ -53,16 +53,17 @@ You can get information for all {dfanalytics-jobs} by using _all, by specifying
[[ml-get-dfanalytics-query-params]]
==== {api-query-parms-title}
`allow_no_match` (Optional)::
(boolean) If `false` and the `data_frame_analytics_id` does not match any
{dfanalytics-job} an error will be returned. The default value is `true`.
`allow_no_match`::
(Optional, boolean) If `false` and the `data_frame_analytics_id` does not
match any {dfanalytics-job} an error will be returned. The default value is
`true`.
`from` (Optional)::
(integer) Skips the specified number of {dfanalytics-jobs}. The default value
is `0`.
`from`::
(Optional, integer) Skips the specified number of {dfanalytics-jobs}. The
default value is `0`.
`size` (Optional)::
(integer) Specifies the maximum number of {dfanalytics-jobs} to obtain. The
`size`::
(Optional, integer) Specifies the maximum number of {dfanalytics-jobs} to obtain. The
default value is `100`.
[[ml-get-dfanalytics-results]]

12
docs/reference/ml/apis/get-filter.asciidoc
View File

@ -31,17 +31,17 @@ You can get a single filter or all filters. For more information, see
[[ml-get-filter-path-parms]]
==== {api-path-parms-title}
`<filter_id>` (Optional)::
(string) Identifier for the filter.
`<filter_id>`::
(Optional, string) Identifier for the filter.
[[ml-get-filter-query-parms]]
==== {api-query-parms-title}
`from` (Optional):::
(integer) Skips the specified number of filters.
`from`:::
(Optional, integer) Skips the specified number of filters.
`size` (Optional):::
(integer) Specifies the maximum number of filters to obtain.
`size`:::
(Optional, integer) Specifies the maximum number of filters to obtain.
[[ml-get-filter-results]]
==== {api-response-body-title}

39
docs/reference/ml/apis/get-influencer.asciidoc
View File

@ -26,37 +26,38 @@ privileges. See {stack-ov}/security-privileges.html[Security privileges] and
[[ml-get-influencer-path-parms]]
==== {api-path-parms-title}
`<job_id>` (Required)::
(string) Identifier for the job.
`<job_id>`::
(Required, string) Identifier for the job.
[[ml-get-influencer-request-body]]
==== {api-request-body-title}
`desc` (Optional)::
(boolean) If true, the results are sorted in descending order.
`desc`::
(Optional, boolean) If true, the results are sorted in descending order.
`end` (Optional)::
(string) Returns influencers with timestamps earlier than this time.
`end`::
(Optional, string) Returns influencers with timestamps earlier than this time.
`exclude_interim` (Optional)::
(boolean) If true, the output excludes interim results.
By default, interim results are included.
`exclude_interim`::
(Optional, boolean) If true, the output excludes interim results. By default,
interim results are included.
`influencer_score` (Optional)::
(double) Returns influencers with anomaly scores greater or equal than this value.
`influencer_score`::
(Optional, double) Returns influencers with anomaly scores greater than or
equal to this value.
`page` (Optional)::
`page`::
`from`:::
(integer) Skips the specified number of influencers.
(Optional, integer) Skips the specified number of influencers.
`size`:::
(integer) Specifies the maximum number of influencers to obtain.
(Optional, integer) Specifies the maximum number of influencers to obtain.
`sort` (Optional)::
(string) Specifies the sort field for the requested influencers.
By default the influencers are sorted by the `influencer_score` value.
`sort`::
(Optional, string) Specifies the sort field for the requested influencers. By
default, the influencers are sorted by the `influencer_score` value.
`start` (Optional)::
(string) Returns influencers with timestamps after this time.
`start`::
(Optional, string) Returns influencers with timestamps after this time.
[[ml-get-influencer-results]]
==== {api-response-body-title}

8
docs/reference/ml/apis/get-job-stats.asciidoc
View File

@ -39,10 +39,10 @@ IMPORTANT: This API returns a maximum of 10,000 jobs.
[[ml-get-job-stats-path-parms]]
==== {api-path-parms-title}
`<job_id>` (Optional)::
(string) An identifier for the job. It can be a job identifier, a group name,
or a wildcard expression. If you do not specify one of these options, the API
returns statistics for all jobs.
`<job_id>`::
(Optional, string) An identifier for the job. It can be a job identifier, a
group name, or a wildcard expression. If you do not specify one of these
options, the API returns statistics for all jobs.
[[ml-get-job-stats-results]]
==== {api-response-body-title}

8
docs/reference/ml/apis/get-job.asciidoc
View File

@ -39,10 +39,10 @@ IMPORTANT: This API returns a maximum of 10,000 jobs.
[[ml-get-job-path-parms]]
==== {api-path-parms-title}
`<job_id> (Optional)`::
(string) Identifier for the job. It can be a job identifier, a group name,
or a wildcard expression. If you do not specify one of these options, the API
returns information for all jobs.
`<job_id>`::
(Optional, string) Identifier for the job. It can be a job identifier, a group
name, or a wildcard expression. If you do not specify one of these options,
the API returns information for all jobs.
[[ml-get-job-results]]
==== {api-response-body-title}

44
docs/reference/ml/apis/get-overall-buckets.asciidoc
View File

@ -56,39 +56,39 @@ overall buckets with a span equal to the largest job's `bucket_span`.
[[ml-get-overall-buckets-path-parms]]
==== {api-path-parms-title}
`<job_id>` (Required)::
(string) Identifier for the job. It can be a job identifier, a group name, a
comma-separated list of jobs or groups, or a wildcard expression.
`<job_id>`::
(Required, string) Identifier for the job. It can be a job identifier, a group
name, a comma-separated list of jobs or groups, or a wildcard expression.
[[ml-get-overall-buckets-request-body]]
==== {api-request-body-title}
`allow_no_jobs` (Optional)::
(boolean) If `false` and the `job_id` does not match any job an error will
be returned. The default value is `true`.
`allow_no_jobs`::
(Optional, boolean) If `false` and the `job_id` does not match any job, an
error occurs. The default value is `true`.
`bucket_span` (Optional)::
(string) The span of the overall buckets. Must be greater or equal
`bucket_span`::
(Optional, string) The span of the overall buckets. Must be greater or equal
to the largest job's `bucket_span`. Defaults to the largest job's `bucket_span`.
`end` (Optional)::
(string) Returns overall buckets with timestamps earlier than this time.
`end`::
(Optional, string) Returns overall buckets with timestamps earlier than this
time.
`exclude_interim` (Optional)::
(boolean) If `true`, the output excludes interim overall buckets.
Overall buckets are interim if any of the job buckets within
the overall bucket interval are interim.
By default, interim results are included.
`exclude_interim`::
(Optional, boolean) If `true`, the output excludes interim overall buckets.
Overall buckets are interim if any of the job buckets within the overall
bucket interval are interim. By default, interim results are included.
`overall_score` (Optional)::
(double) Returns overall buckets with overall scores greater or equal than
this value.
`overall_score`::
(Optional, double) Returns overall buckets with overall scores greater or
equal than this value.
`start` (Optional)::
(string) Returns overall buckets with timestamps after this time.
`start`::
(Optional, string) Returns overall buckets with timestamps after this time.
`top_n` (Optional)::
(integer) The number of top job bucket scores to be used in the
`top_n`::
(Optional, integer) The number of top job bucket scores to be used in the
`overall_score` calculation. The default value is `1`.
[[ml-get-overall-buckets-results]]

39
docs/reference/ml/apis/get-record.asciidoc
View File

@ -26,37 +26,38 @@ privileges. See {stack-ov}/security-privileges.html[Security privileges] and
[[ml-get-record-path-parms]]
==== {api-path-parms-title}
`job_id` (Required)::
(string) Identifier for the job.
`<job_id>`::
(Required, string) Identifier for the job.
[[ml-get-record-request-body]]
==== {api-request-body-title}
`desc` (Optional)::
(boolean) If true, the results are sorted in descending order.
`desc`::
(Optional, boolean) If true, the results are sorted in descending order.
`end` (Optional)::
(string) Returns records with timestamps earlier than this time.
`end`::
(Optional, string) Returns records with timestamps earlier than this time.
`exclude_interim` (Optional)::
(boolean) If true, the output excludes interim results.
By default, interim results are included.
`exclude_interim`::
(Optional, boolean) If true, the output excludes interim results. By default,
interim results are included.
`page` (Optional)::
`page`::
`from`:::
(integer) Skips the specified number of records.
(Optional, integer) Skips the specified number of records.
`size`:::
(integer) Specifies the maximum number of records to obtain.
(Optional, integer) Specifies the maximum number of records to obtain.
`record_score` (Optional)::
(double) Returns records with anomaly scores greater or equal than this value.
`record_score`::
(Optional, double) Returns records with anomaly scores greater or equal than
this value.
`sort` (Optional)::
(string) Specifies the sort field for the requested records.
By default, the records are sorted by the `anomaly_score` value.
`sort`::
(Optional, string) Specifies the sort field for the requested records. By
default, the records are sorted by the `anomaly_score` value.
`start` (Optional)::
(string) Returns records with timestamps after this time.
`start`::
(Optional, string) Returns records with timestamps after this time.
[[ml-get-record-results]]
==== {api-response-body-title}

39
docs/reference/ml/apis/get-snapshot.asciidoc
View File

@ -25,34 +25,34 @@ Retrieves information about model snapshots.
[[ml-get-snapshot-path-parms]]
==== {api-path-parms-title}
`<job_id>` (Required)::
(string) Identifier for the job.
`<job_id>`::
(Required, string) Identifier for the job.
`<snapshot_id>` (Optional)::
(string) Identifier for the model snapshot. If you do not specify this
optional parameter, the API returns information about all model snapshots.
`<snapshot_id>`::
(Optional, string) Identifier for the model snapshot. If you do not specify
this optional parameter, the API returns information about all model snapshots.
[[ml-get-snapshot-request-body]]
==== {api-request-body-title}
`desc` (Optional)::
(boolean) If true, the results are sorted in descending order.
`desc`::
(Optional, boolean) If true, the results are sorted in descending order.
`end` (Optional)::
(date) Returns snapshots with timestamps earlier than this time.
`end`::
(Optional, date) Returns snapshots with timestamps earlier than this time.
`from` (Optional)::
(integer) Skips the specified number of snapshots.
`from`::
(Optional, integer) Skips the specified number of snapshots.
`size` (Optional)::
(integer) Specifies the maximum number of snapshots to obtain.
`size`::
(Optional, integer) Specifies the maximum number of snapshots to obtain.
`sort` (Optional)::
(string) Specifies the sort field for the requested snapshots.
By default, the snapshots are sorted by their timestamp.
`sort`::
(Optional, string) Specifies the sort field for the requested snapshots. By
default, the snapshots are sorted by their timestamp.
`start` (Optional)::
(string) Returns snapshots with timestamps after this time.
`start`::
(Optional, string) Returns snapshots with timestamps after this time.
[[ml-get-snapshot-results]]
==== {api-response-body-title}
@ -66,9 +66,6 @@ The API returns the following information:
[[ml-get-snapshot-example]]
==== {api-examples-title}
The following example gets model snapshot information for the
`it_ops_new_logs` job:
[source,js]
--------------------------------------------------
GET _ml/anomaly_detectors/farequote/model_snapshots

15
docs/reference/ml/apis/open-job.asciidoc
View File

@ -7,8 +7,6 @@
++++
Opens one or more jobs.
A job must be opened in order for it to be ready to receive and analyze data.
A job can be opened and closed multiple times throughout its lifecycle.
[[ml-open-job-request]]
==== {api-request-title}
@ -25,6 +23,9 @@ A job can be opened and closed multiple times throughout its lifecycle.
[[ml-open-job-desc]]
==== {api-description-title}
A job must be opened in order for it to be ready to receive and analyze data.
A job can be opened and closed multiple times throughout its lifecycle.
When you open a new job, it starts with an empty model.
When you open an existing job, the most recent model state is automatically
@ -34,15 +35,15 @@ data is received.
[[ml-open-job-path-parms]]
==== {api-path-parms-title}
`<job_id>` (Required)::
(string) Identifier for the job
`<job_id>`::
(Required, string) Identifier for the job
[[ml-open-job-request-body]]
==== {api-request-body-title}
`timeout` (Optional)::
(time) Controls the time to wait until a job has opened.
The default value is 30 minutes.
`timeout`::
(Optional, time) Controls the time to wait until a job has opened. The default
value is 30 minutes.
[[ml-open-job-example]]
==== {api-examples-title}

12
docs/reference/ml/apis/post-calendar-event.asciidoc
View File

@ -29,16 +29,16 @@ of which must have a start time, end time, and description.
[[ml-post-calendar-event-path-parms]]
==== {api-path-parms-title}
`<calendar_id>` (Required)::
(string) Identifier for the calendar.
`<calendar_id>`::
(Required, string) Identifier for the calendar.
[[ml-post-calendar-event-request-body]]
==== {api-request-body-title}
`events` (Required)::
(array) A list of one of more scheduled events. The event's start and end
times may be specified as integer milliseconds since the epoch or as a string
in ISO 8601 format. See <<ml-event-resource>>.
`events`::
(Required, array) A list of one of more scheduled events. The event's start
and end times may be specified as integer milliseconds since the epoch or as a
string in ISO 8601 format. See <<ml-event-resource>>.
[[ml-post-calendar-event-example]]
==== {api-examples-title}

12
docs/reference/ml/apis/post-data.asciidoc
View File

@ -52,17 +52,17 @@ or a comma-separated list.
[[ml-post-data-path-parms]]
==== {api-path-parms-title}
`<job_id>` (Required)::
(string) Identifier for the job.
`<job_id>`::
(Required, string) Identifier for the job.
[[ml-post-data-query-parms]]
==== {api-query-parms-title}
`reset_start` (Optional)::
(string) Specifies the start of the bucket resetting range.
`reset_start`::
(Optional, string) Specifies the start of the bucket resetting range.
`reset_end` (Optional)::
(string) Specifies the end of the bucket resetting range.
`reset_end`::
(Optional, string) Specifies the end of the bucket resetting range.
[[ml-post-data-request-body]]
==== {api-request-body-title}

4
docs/reference/ml/apis/preview-datafeed.asciidoc
View File

@ -40,8 +40,8 @@ it to ensure it is returning the expected data.
[[ml-preview-datafeed-path-parms]]
==== {api-path-parms-title}
`<datafeed_id>` (Required)::
(string) Identifier for the {dfeed}.
`<datafeed_id>`::
(Required, string) Identifier for the {dfeed}.
[[ml-preview-datafeed-example]]
==== {api-examples-title}

13
docs/reference/ml/apis/put-calendar-job.asciidoc
View File

@ -23,19 +23,16 @@ Adds a job to a calendar.
[[ml-put-calendar-job-path-parms]]
==== {api-path-parms-title}
`<calendar_id>` (Required)::
(string) Identifier for the calendar.
`<calendar_id>`::
(Required, string) Identifier for the calendar.
`<job_id>` (Required)::
(string) An identifier for the job. It can be a job identifier, a group name,
or a comma-separated list of jobs or groups.
`<job_id>`::
(Required, string) An identifier for the job. It can be a job identifier, a
group name, or a comma-separated list of jobs or groups.
[[ml-put-calendar-job-example]]
==== {api-examples-title}
The following example associates the `planned-outages` calendar with the
`total-requests` job:
[source,js]
--------------------------------------------------
PUT _ml/calendars/planned-outages/jobs/total-requests

10
docs/reference/ml/apis/put-calendar.asciidoc
View File

@ -29,20 +29,18 @@ For more information, see
[[ml-put-calendar-path-parms]]
==== {api-path-parms-title}
`<calendar_id>` (Required)::
(string) Identifier for the calendar.
`<calendar_id>`::
(Required, string) Identifier for the calendar.
[[ml-put-calendar-request-body]]
==== {api-request-body-title}
`description` (Optional)::
(string) A description of the calendar.
`description`::
(Optional, string) A description of the calendar.
[[ml-put-calendar-example]]
==== {api-examples-title}
The following example creates the `planned-outages` calendar:
[source,js]
--------------------------------------------------
PUT _ml/calendars/planned-outages

91
docs/reference/ml/apis/put-datafeed.asciidoc
View File

@ -18,6 +18,7 @@ Instantiates a {dfeed}.
[[ml-put-datafeed-prereqs]]
==== {api-prereq-title}
* You must create a job before you create a {dfeed}.
* If {es} {security-features} are enabled, you must have `manage_ml` or `manage`
cluster privileges to use this API. See
{stack-ov}/security-privileges.html[Security privileges].
@ -25,8 +26,7 @@ cluster privileges to use this API. See
[[ml-put-datafeed-desc]]
==== {api-description-title}
You must create a job before you create a {dfeed}. You can associate only one
{dfeed} to each job.
You can associate only one {dfeed} to each job.
[IMPORTANT]
====
@ -42,62 +42,63 @@ those same roles.
[[ml-put-datafeed-path-parms]]
==== {api-path-parms-title}
`<feed_id>` (Required)::
(string) A numerical character string that uniquely identifies the {dfeed}.
This identifier can contain lowercase alphanumeric characters (a-z and 0-9),
hyphens, and underscores. It must start and end with alphanumeric characters.
`<feed_id>`::
(Required, string) A numerical character string that uniquely identifies the
{dfeed}. This identifier can contain lowercase alphanumeric characters (a-z
and 0-9), hyphens, and underscores. It must start and end with alphanumeric
characters.
[[ml-put-datafeed-request-body]]
==== {api-request-body-title}
`aggregations` (Optional)::
(object) If set, the {dfeed} performs aggregation searches.
For more information, see <<ml-datafeed-resource>>.
`aggregations`::
(Optional, object) If set, the {dfeed} performs aggregation searches. For more
information, see <<ml-datafeed-resource>>.
`chunking_config` (Optional)::
(object) Specifies how data searches are split into time chunks.
See <<ml-datafeed-chunking-config>>.
`chunking_config`::
(Optional, object) Specifies how data searches are split into time chunks. See
<<ml-datafeed-chunking-config>>.
`delayed_data_check_config` (Optional)::
(object) Specifies whether the data feed checks for missing data and
the size of the window. See
<<ml-datafeed-delayed-data-check-config>>.
`delayed_data_check_config`::
(Optional, object) Specifies whether the data feed checks for missing data and
the size of the window. See <<ml-datafeed-delayed-data-check-config>>.
`frequency` (Optional)::
(time units) The interval at which scheduled queries are made while the {dfeed}
runs in real time. The default value is either the bucket span for short
bucket spans, or, for longer bucket spans, a sensible fraction of the bucket
span. For example: `150s`.
`frequency`::
(Optional, time units) The interval at which scheduled queries are made while
the {dfeed} runs in real time. The default value is either the bucket span for
short bucket spans, or, for longer bucket spans, a sensible fraction of the
bucket span. For example: `150s`.
`indices` (Required)::
(array) An array of index names. Wildcards are supported. For example:
`["it_ops_metrics", "server*"]`.
`indices`::
(Required, array) An array of index names. Wildcards are supported. For
example: `["it_ops_metrics", "server*"]`.
`job_id` (Required)::
(string) A numerical character string that uniquely identifies the job.
`job_id`::
(Required, string) A numerical character string that uniquely identifies the
job.
`query` (Optional)::
(object) The {es} query domain-specific language (DSL). This value
corresponds to the query object in an {es} search POST body. All the
options that are supported by {Es} can be used, as this object is
passed verbatim to {es}. By default, this property has the following
value: `{"match_all": {"boost": 1}}`.
`query`::
(Optional, object) The {es} query domain-specific language (DSL). This value
corresponds to the query object in an {es} search POST body. All the options
that are supported by {Es} can be used, as this object is passed verbatim to
{es}. By default, this property has the following value:
`{"match_all": {"boost": 1}}`.
`query_delay` (Optional)::
(time units) The number of seconds behind real time that data is queried. For
example, if data from 10:04 a.m. might not be searchable in {es} until
10:06 a.m., set this property to 120 seconds. The default value is `60s`.
`query_delay`::
(Optional, time units) The number of seconds behind real time that data is
queried. For example, if data from 10:04 a.m. might not be searchable in {es}
until 10:06 a.m., set this property to 120 seconds. The default value is `60s`.
`script_fields` (Optional)::
(object) Specifies scripts that evaluate custom expressions and returns
script fields to the {dfeed}.
The <<ml-detectorconfig,detector configuration objects>> in a job can contain
functions that use these script fields. For more information,
see {ref}/search-request-script-fields.html[Script Fields].
`script_fields`::
(Optional, object) Specifies scripts that evaluate custom expressions and
returns script fields to the {dfeed}. The
<<ml-detectorconfig,detector configuration objects>> in a job can contain
functions that use these script fields. For more information, see
<<search-request-script-fields,Script fields>>.
`scroll_size` (Optional)::
(unsigned integer) The `size` parameter that is used in {es} searches.
The default value is `1000`.
`scroll_size`::
(Optional, unsigned integer) The `size` parameter that is used in {es}
searches. The default value is `1000`.
For more information about these properties,
see <<ml-datafeed-resource>>.

30
docs/reference/ml/apis/put-dfanalytics.asciidoc
View File

@ -7,10 +7,10 @@
<titleabbrev>Create {dfanalytics-jobs}</titleabbrev>
++++
experimental[]
Instantiates a {dfanalytics-job}.
experimental[]
[[ml-put-dfanalytics-request]]
==== {api-request-title}
@ -48,30 +48,30 @@ and mappings.
[[ml-put-dfanalytics-path-params]]
==== {api-path-parms-title}
`<data_frame_analytics_id>` (Required)::
(string) A numerical character string that uniquely identifies the
{dfanalytics-job}. This identifier can contain lowercase alphanumeric characters
(a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric
characters.
`<data_frame_analytics_id>`::
(Required, string) A numerical character string that uniquely identifies the
{dfanalytics-job}. This identifier can contain lowercase alphanumeric
characters (a-z and 0-9), hyphens, and underscores. It must start and end with
alphanumeric characters.
[[ml-put-dfanalytics-request-body]]
==== {api-request-body-title}
`analysis` (Required)::
(object) Defines the type of {dfanalytics} you want to perform on your source
`analysis`::
(Required, object) Defines the type of {dfanalytics} you want to perform on your source
index. For example: `outlier_detection`. See <<dfanalytics-types>>.
`analyzed_fields` (Optional)::
(object) You can specify both `includes` and/or `excludes` patterns. If
`analyzed_fields`::
(Optional, object) You can specify both `includes` and/or `excludes` patterns. If
`analyzed_fields` is not set, only the relevant fields will be included. For
example, all the numeric fields for {oldetection}.
`dest` (Required)::
(object) The destination configuration, consisting of `index` and optionally
`dest`::
(Required, object) The destination configuration, consisting of `index` and optionally
`results_field` (`ml` by default). See <<dfanalytics-dest-resources>>.
`source` (Required)::
(object) The source configuration, consisting of `index` and optionally a
`source`::
(Required, object) The source configuration, consisting of `index` and optionally a
`query`. See <<dfanalytics-source-resources>>.
[[ml-put-dfanalytics-example]]

17
docs/reference/ml/apis/put-filter.asciidoc
View File

@ -30,20 +30,19 @@ the `custom_rules` property of <<ml-detectorconfig,detector configuration object
[[ml-put-filter-path-parms]]
==== {api-path-parms-title}
`<filter_id>` (Required)::
(string) Identifier for the filter.
`<filter_id>`::
(Required, string) Identifier for the filter.
[[ml-put-filter-request-body]]
==== {api-request-body-title}
`description` (Optional)::
(string) A description of the filter.
`description`::
(Optional, string) A description of the filter.
`items` (Required)::
(array of strings) The items of the filter.
A wildcard `*` can be used at the beginning
or the end of an item. Up to 10000 items
are allowed in each filter.
`items`::
(Required, array of strings) The items of the filter. A wildcard `*` can be
used at the beginning or the end of an item. Up to 10000 items are allowed in
each filter.
[[ml-put-filter-example]]
==== {api-examples-title}

82
docs/reference/ml/apis/put-job.asciidoc
View File

@ -33,61 +33,65 @@ a job directly to the `.ml-config` index using the {es} index API. If {es}
[[ml-put-job-path-parms]]
==== {api-path-parms-title}
`<job_id>` (Required)::
(string) Identifier for the job. This identifier can contain lowercase
alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must
start and end with alphanumeric characters.
`<job_id>`::
(Required, string) Identifier for the job. This identifier can contain
lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It
must start and end with alphanumeric characters.
[[ml-put-job-request-body]]
==== {api-request-body-title}
`analysis_config` (Required)::
(object) The analysis configuration, which specifies how to analyze the data.
See <<ml-analysisconfig, analysis configuration objects>>.
`analysis_config`::
(Required, object) The analysis configuration, which specifies how to analyze
the data. See <<ml-analysisconfig, analysis configuration objects>>.
`analysis_limits` (Optional)::
(object) Specifies runtime limits for the job. See
`analysis_limits`::
(Optional, object) Specifies runtime limits for the job. See
<<ml-apilimits,analysis limits>>.
`background_persist_interval` (Optional)::
(time units) Advanced configuration option. The time between each periodic
persistence of the model. See <<ml-job-resource>>.
`background_persist_interval`::
(Optional, time units) Advanced configuration option. The time between each
periodic persistence of the model. See <<ml-job-resource>>.
`custom_settings` (Optional)::
(object) Advanced configuration option. Contains custom meta data about the
job. See <<ml-job-resource>>.
`custom_settings`::
(Optional, object) Advanced configuration option. Contains custom meta data
about the job. See <<ml-job-resource>>.
`data_description` (Required)::
(object) Describes the format of the input data. This object is required, but
it can be empty (`{}`). See <<ml-datadescription,data description objects>>.
`data_description`::
(Required, object) Describes the format of the input data. This object is
required, but it can be empty (`{}`). See
<<ml-datadescription,data description objects>>.
`description` (Optional)::
(string) A description of the job.
`description`::
(Optional, string) A description of the job.
`groups` (Optional)::
(array of strings) A list of job groups. See <<ml-job-resource>>.
`groups`::
(Optional, array of strings) A list of job groups. See <<ml-job-resource>>.
`model_plot_config` (Optional)::
(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 <<ml-apimodelplotconfig>>.
`model_plot_config`::
(Optional, 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
<<ml-apimodelplotconfig>>.
`model_snapshot_retention_days` (Optional)::
(long) The time in days that model snapshots are retained for the job.
Older snapshots are deleted. The default value is `1`, which means snapshots
are retained for one day (twenty-four hours).
`model_snapshot_retention_days`::
(Optional, long) The time in days that model snapshots are retained for the
job. Older snapshots are deleted. The default value is `1`, which means
snapshots are retained for one day (twenty-four hours).
`renormalization_window_days` (Optional)::
(long) Advanced configuration option. The period over which adjustments to the
score are applied, as new data is seen. See <<ml-job-resource>>.
`renormalization_window_days`::
(Optional, 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` (Optional)::
(string) A text string that affects the name of the {ml} results index. The
default value is `shared`, which generates an index named `.ml-anomalies-shared`.
`results_index_name`::
(Optional, string) A text string that affects the name of the {ml} results
index. The default value is `shared`, which generates an index named
`.ml-anomalies-shared`.
`results_retention_days` (Optional)::
(long) Advanced configuration option. The number of days for which job results
are retained. See <<ml-job-resource>>.
`results_retention_days`::
(Optional, long) Advanced configuration option. The number of days for which
job results are retained. See <<ml-job-resource>>.
[[ml-put-job-example]]
==== {api-examples-title}

17
docs/reference/ml/apis/revert-snapshot.asciidoc
View File

@ -16,6 +16,7 @@ Reverts to a specific snapshot.
[[ml-revert-snapshot-prereqs]]
==== {api-prereq-title}
* Before you revert to a saved snapshot, you must close the job.
* If the {es} {security-features} are enabled, you must have `manage_ml` or
`manage` cluster privileges to use this API. See
{stack-ov}/security-privileges.html[Security privileges].
@ -31,23 +32,21 @@ then it might be appropriate to reset the model state to a time before this
event. For example, you might consider reverting to a saved snapshot after Black
Friday or a critical system failure.
IMPORTANT: Before you revert to a saved snapshot, you must close the job.
[[ml-revert-snapshot-path-parms]]
==== {api-path-parms-title}
`<job_id>` (Required)::
(string) Identifier for the job.
`<job_id>`::
(Required, string) Identifier for the job.
`<snapshot_id>` (Required)::
(string) Identifier for the model snapshot.
`<snapshot_id>`::
(Required, string) Identifier for the model snapshot.
[[ml-revert-snapshot-request-body]]
==== {api-request-body-title}
`delete_intervening_results` (Optional)::
(boolean) If true, deletes the results in the time period between the
latest results and the time of the reverted snapshot. It also resets the
`delete_intervening_results`::
(Optional, boolean) If true, deletes the results in the time period between
the latest results and the time of the reverted snapshot. It also resets the
model to accept records for this time period. The default value is false.
NOTE: If you choose not to delete intervening results when reverting a snapshot,

11
docs/reference/ml/apis/set-upgrade-mode.asciidoc
View File

@ -61,12 +61,13 @@ IMPORTANT: No new {ml} jobs can be opened while the `upgrade_mode` setting is
[[ml-set-upgrade-mode-query-parms]]
==== {api-query-parms-title}
`enabled` (Optional)::
(boolean) When `true`, this enables `upgrade_mode`. Defaults to `false`
`enabled`::
(Optional, boolean) When `true`, this enables `upgrade_mode`. Defaults to
`false`.
`timeout` (Optional)::
(time) The time to wait for the request to be completed.
The default value is 30 seconds.
`timeout`::
(Optional, time) The time to wait for the request to be completed. The default
value is 30 seconds.
[[ml-set-upgrade-mode-example]]
==== {api-examples-title}

28
docs/reference/ml/apis/start-datafeed.asciidoc
View File

@ -9,8 +9,6 @@
++++
Starts one or more {dfeeds}.
A {dfeed} must be started in order to retrieve data from {es}.
A {dfeed} can be started and stopped multiple times throughout its lifecycle.
[[ml-start-datafeed-request]]
==== {api-request-title}
@ -20,6 +18,8 @@ A {dfeed} can be started and stopped multiple times throughout its lifecycle.
[[ml-start-datafeed-prereqs]]
==== {api-prereq-title}
* Before you can start a {dfeed}, the job must be open. Otherwise, an error
occurs.
* If {es} {security-features} are enabled, you must have `manage_ml` or `manage`
cluster privileges to use this API. See
{stack-ov}/security-privileges.html[Security privileges].
@ -27,8 +27,8 @@ cluster privileges to use this API. See
[[ml-start-datafeed-desc]]
==== {api-description-title}
NOTE: Before you can start a {dfeed}, the job must be open. Otherwise, an error
occurs.
A {dfeed} must be started in order to retrieve data from {es}.
A {dfeed} can be started and stopped multiple times throughout its lifecycle.
When you start a {dfeed}, you can specify a start time. This enables you to
include a training period, providing you have this data available in {es}.
@ -72,22 +72,22 @@ creation/update and runs the query using those same roles.
[[ml-start-datafeed-path-parms]]
==== {api-path-parms-title}
`<feed_id>` (Required)::
(string) Identifier for the {dfeed}.
`<feed_id>`::
(Required, string) Identifier for the {dfeed}.
[[ml-start-datafeed-request-body]]
==== {api-request-body-title}
`end` (Optional)::
(string) The time that the {dfeed} should end. This value is exclusive.
The default value is an empty string.
`end`::
(Optional, string) The time that the {dfeed} should end. This value is
exclusive. The default value is an empty string.
`start` (Optional)::
(string) The time that the {dfeed} should begin. This value is inclusive.
The default value is an empty string.
`start`::
(Optional, string) The time that the {dfeed} should begin. This value is
inclusive. The default value is an empty string.
`timeout` (Optional)::
(time) Controls the amount of time to wait until a {dfeed} starts.
`timeout`::
(Optional, time) Controls the amount of time to wait until a {dfeed} starts.
The default value is 20 seconds.
[[ml-start-datafeed-example]]

20
docs/reference/ml/apis/start-dfanalytics.asciidoc
View File

@ -8,10 +8,10 @@
<titleabbrev>Start {dfanalytics-jobs}</titleabbrev>
++++
experimental[]
Starts a {dfanalytics-job}.
experimental[]
[[ml-start-dfanalytics-request]]
==== {api-request-title}
@ -29,17 +29,17 @@ and {stack-ov}/built-in-roles.html[Built-in roles].
[[ml-start-dfanalytics-path-params]]
==== {api-path-parms-title}
`<data_frame_analytics_id>` (Required)::
(string) Identifier for the {dfanalytics-job}. This identifier can contain
lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It
must start and end with alphanumeric characters.
`<data_frame_analytics_id>`::
(Required, string) Identifier for the {dfanalytics-job}. This identifier can
contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and
underscores. It must start and end with alphanumeric characters.
[[ml-start-dfanalytics-query-params]]
==== {api-query-parms-title}
`timeout` (Optional)::
(time) Controls the amount of time to wait until the {dfanalytics-job} starts.
The default value is 20 seconds.
`timeout`::
(Optional, time) Controls the amount of time to wait until the
{dfanalytics-job} starts. The default value is 20 seconds.
[[ml-start-dfanalytics-example]]
==== {api-examples-title}

14
docs/reference/ml/apis/stop-datafeed.asciidoc
View File

@ -39,18 +39,18 @@ comma-separated list of {dfeeds} or a wildcard expression. You can close all
[[ml-stop-datafeed-path-parms]]
==== {api-path-parms-title}
`<feed_id>` (Required)::
(string) Identifier for the {dfeed}. It can be a {dfeed} identifier or a
wildcard expression.
`<feed_id>`::
(Required, string) Identifier for the {dfeed}. It can be a {dfeed} identifier
or a wildcard expression.
[[ml-stop-datafeed-request-body]]
==== {api-request-body-title}
`force` (Optional)::
(boolean) If true, the {dfeed} is stopped forcefully.
`force`::
(Optional, boolean) If true, the {dfeed} is stopped forcefully.
`timeout` (Optional)::
(time) Controls the amount of time to wait until a {dfeed} stops.
`timeout`::
(Optional, time) Controls the amount of time to wait until a {dfeed} stops.
The default value is 20 seconds.
[[ml-stop-datafeed-example]]

36
docs/reference/ml/apis/stop-dfanalytics.asciidoc
View File

@ -8,10 +8,10 @@
<titleabbrev>Stop {dfanalytics-jobs}</titleabbrev>
++++
experimental[]
Stops one or more {dfanalytics-jobs}.
experimental[]
[[ml-stop-dfanalytics-request]]
==== {api-request-title}
@ -42,24 +42,26 @@ stop all {dfanalytics-job} by using _all or by specifying * as the
[[ml-stop-dfanalytics-path-params]]
==== {api-path-parms-title}
`<data_frame_analytics_id>` (Required)::
(string) Identifier for the {dfanalytics-job}. This identifier can contain
lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It
must start and end with alphanumeric characters.
`<data_frame_analytics_id>`::
(Required, string) Identifier for the {dfanalytics-job}. This identifier can
contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and
underscores. It must start and end with alphanumeric characters.
[[ml-stop-dfanalytics--query-params]]
==== {api-query-parms-title}
[[ml-stop-dfanalytics-query-params]]
==== {api-query-parms-title}
`allow_no_match`::
(Optional, boolean) If `false` and the `data_frame_analytics_id` does not
match any {dfanalytics-job} an error will be returned. The default value is
`true`.
`allow_no_match` (Optional)::
(boolean) If `false` and the `data_frame_analytics_id` does not match any
{dfanalytics-job} an error will be returned. The default value is `true`.
`force`::
(Optional, boolean) If true, the {dfanalytics-job} is stopped forcefully.
`force` (Optional)::
(boolean) If true, the {dfanalytics-job} is stopped forcefully.
`timeout` (Optional)::
Controls the amount of time to wait until the {dfanalytics-job} stops.
The default value is 20 seconds.
`timeout`::
(Optional, time) Controls the amount of time to wait until the
{dfanalytics-job} stops. The default value is 20 seconds.
[[ml-stop-dfanalytics-example]]
==== {api-examples-title}

80
docs/reference/ml/apis/update-datafeed.asciidoc
View File

@ -35,62 +35,62 @@ using those same roles.
[[ml-update-datafeed-path-parms]]
==== {api-path-parms-title}
`<feed_id>` (Required)::
(string) Identifier for the {dfeed}.
`<feed_id>`::
(Required, string) Identifier for the {dfeed}.
[[ml-update-datafeed-request-body]]
==== {api-request-body-title}
The following properties can be updated after the {dfeed} is created:
`aggregations` (Optional)::
(object) If set, the {dfeed} performs aggregation searches.
For more information, see <<ml-datafeed-resource>>.
`aggregations`::
(Optional, object) If set, the {dfeed} performs aggregation searches. For more
information, see <<ml-datafeed-resource>>.
`chunking_config` (Optional)::
(object) Specifies how data searches are split into time chunks.
See <<ml-datafeed-chunking-config>>.
`chunking_config`::
(Optional, object) Specifies how data searches are split into time chunks. See
<<ml-datafeed-chunking-config>>.
`delayed_data_check_config` (Optional)::
(object) Specifies whether the data feed checks for missing data and
`delayed_data_check_config`::
(Optional, object) Specifies whether the data feed checks for missing data and
the size of the window. See <<ml-datafeed-delayed-data-check-config>>.
`frequency` (Optional)::
(time units) The interval at which scheduled queries are made while the
{dfeed} runs in real time. The default value is either the bucket span for short
bucket spans, or, for longer bucket spans, a sensible fraction of the bucket
span. For example: `150s`.
`frequency`::
(Optional, time units) The interval at which scheduled queries are made while
the {dfeed} runs in real time. The default value is either the bucket span for
short bucket spans, or, for longer bucket spans, a sensible fraction of the
bucket span. For example: `150s`.
`indices` (Optional)::
(array) An array of index names. Wildcards are supported. For example:
`["it_ops_metrics", "server*"]`.
`indices`::
(Optional, array) An array of index names. Wildcards are supported. For
example: `["it_ops_metrics", "server*"]`.
`job_id` (Optional)::
(string) A numerical character string that uniquely identifies the job.
`job_id`::
(Optional, string) A numerical character string that uniquely identifies the
job.
`query` (Optional)::
(object) The {es} query domain-specific language (DSL). This value
corresponds to the query object in an {es} search POST body. All the
options that are supported by {es} can be used, as this object is
passed verbatim to {es}. By default, this property has the following
value: `{"match_all": {"boost": 1}}`.
`query`::
(Optional, object) The {es} query domain-specific language (DSL). This value
corresponds to the query object in an {es} search POST body. All the options
that are supported by {es} can be used, as this object is passed verbatim to
{es}. By default, this property has the following value:
`{"match_all": {"boost": 1}}`.
`query_delay` (Optional)::
(time units) The number of seconds behind real-time that data is queried. For
example, if data from 10:04 a.m. might not be searchable in {es} until
10:06 a.m., set this property to 120 seconds. The default value is `60s`.
`query_delay`::
(Optional, time units) The number of seconds behind real-time that data is
queried. For example, if data from 10:04 a.m. might not be searchable in {es}
until 10:06 a.m., set this property to 120 seconds. The default value is `60s`.
`script_fields` (Optional)::
(object) Specifies scripts that evaluate custom expressions and returns
script fields to the {dfeed}.
The <<ml-detectorconfig,detector configuration objects>> in a job can contain
functions that use these script fields.
For more information,
see {ref}/search-request-script-fields.html[Script Fields].
`script_fields`::
(Optional, object) Specifies scripts that evaluate custom expressions and
returns script fields to the {dfeed}. The
<<ml-detectorconfig,detector configuration objects>> in a job can contain
functions that use these script fields. For more information, see
<<search-request-script-fields,Script fields>>.
`scroll_size` (Optional)::
(unsigned integer) The `size` parameter that is used in {es} searches.
The default value is `1000`.
`scroll_size`::
(Optional, unsigned integer) The `size` parameter that is used in {es}
searches. The default value is `1000`.
For more information about these properties,
see <<ml-datafeed-resource>>.

18
docs/reference/ml/apis/update-filter.asciidoc
View File

@ -23,20 +23,20 @@ Updates the description of a filter, adds items, or removes items.
[[ml-update-filter-path-parms]]
==== {api-path-parms-title}
`<filter_id>` (Required)::
(string) Identifier for the filter.
`<filter_id>`::
(Required, string) Identifier for the filter.
[[ml-update-filter-request-body]]
==== {api-request-body-title}
`description` (Optional)::
(string) A description for the filter. See <<ml-filter-resource>>.
`add_items`::
(Optional, array of strings) The items to add to the filter.
`description`::
(Optional, string) A description for the filter. See <<ml-filter-resource>>.
`add_items` (Optional)::
(array of strings) The items to add to the filter.
`remove_items` (Optional)::
(array of strings) The items to remove from the filter.
`remove_items`::
(Optional, array of strings) The items to remove from the filter.
[[ml-update-filter-example]]
==== {api-examples-title}

4
docs/reference/ml/apis/update-job.asciidoc
View File

@ -24,8 +24,8 @@ Updates certain properties of a job.
[[ml-update-job-path-parms]]
==== {api-path-parms-title}
`<job_id>` (Required)::
(string) Identifier for the job.
`<job_id>`::
(Required, string) Identifier for the job.
[[ml-update-job-request-body]]
==== {api-request-body-title}

18
docs/reference/ml/apis/update-snapshot.asciidoc
View File

@ -24,24 +24,24 @@ Updates certain properties of a snapshot.
[[ml-update-snapshot-path-parms]]
==== {api-path-parms-title}
`<job_id>` (Required)::
(string) Identifier for the job.
`<job_id>`::
(Required, string) Identifier for the job.
`<snapshot_id>` (Required)::
(string) Identifier for the model snapshot.
`<snapshot_id>`::
(Required, string) Identifier for the model snapshot.
[[ml-update-snapshot-request-body]]
==== {api-request-body-title}
The following properties can be updated after the model snapshot is created:
`description` (Optional)::
(string) A description of the model snapshot. For example,
`description`::
(Optional, string) A description of the model snapshot. For example,
"Before black friday".
`retain` (Optional)::
(boolean) If true, this snapshot will not be deleted during automatic cleanup
of snapshots older than `model_snapshot_retention_days`.
`retain`::
(Optional, boolean) If true, this snapshot will not be deleted during
automatic cleanup of snapshots older than `model_snapshot_retention_days`.
Note that this snapshot will still be deleted when the job is deleted.
The default value is false.

2
docs/reference/rollup/apis/delete-job.asciidoc
View File

@ -62,7 +62,7 @@ POST my_rollup_index/_delete_by_query
==== {api-path-parms-title}
`<job_id>`::
(string) Required. Identifier for the job.
(Required, string) Identifier for the job.
[[rollup-delete-job-response-codes]]
==== {api-response-codes-title}

14
docs/reference/rollup/apis/put-job.asciidoc
View File

@ -33,33 +33,33 @@ Jobs are created in a `STOPPED` state. You can start them with the
==== {api-path-parms-title}
`job_id`::
(string) Required. Identifier for the {rollup-job}.
(Required, string) Identifier for the {rollup-job}.
[[sample-api-request-body]]
==== {api-request-body-title}
`cron`::
(string) Required. A cron string which defines when the {rollup-job} should be executed.
(Required, string) A cron string which defines when the {rollup-job} should be executed.
`groups`::
(object) Required. Defines the grouping fields that are defined for this
(Required, object) Defines the grouping fields that are defined for this
{rollup-job}. See <<rollup-job-config,{rollup-job} config>>.
`index_pattern`::
(string) Required. The index or index pattern to roll up. Supports
(Required, string) The index or index pattern to roll up. Supports
wildcard-style patterns (`logstash-*`).
`metrics`::
(object) Optional. Defines the metrics to collect for each grouping tuple. See
(Optional, object) Defines the metrics to collect for each grouping tuple. See
<<rollup-job-config,{rollup-job} config>>.
`page_size`::
(integer) Required. The number of bucket results that are processed on each
(Required, integer) The number of bucket results that are processed on each
iteration of the rollup indexer. A larger value tends to execute faster, but
requires more memory during processing.
`rollup_index`::
(string) Required. The index that contains the rollup results. The index can
(Required, string) The index that contains the rollup results. The index can
be shared with other {rollup-jobs}.
For more details about the job configuration, see <<rollup-job-config>>.

2
docs/reference/rollup/apis/start-job.asciidoc
View File

@ -33,7 +33,7 @@ to start a job that is already started, nothing happens.
==== {api-path-parms-title}
`<job_id>`::
(string) Required. Identifier for the {rollup-job}.
(Required, string) Identifier for the {rollup-job}.
[[rollup-start-job-response-codes]]
==== {api-response-codes-title}

6
docs/reference/rollup/apis/stop-job.asciidoc
View File

@ -33,13 +33,13 @@ to stop a job that is already stopped, nothing happens.
==== {api-path-parms-title}
`<job_id>`::
(string) Required. Identifier for the {rollup-job}.
(Required, string) Identifier for the {rollup-job}.
[[rollup-stop-job-query-parms]]
==== {api-query-parms-title}
`timeout`::
(TimeValue) Optional. If `wait_for_completion` is `true`, the API blocks for
(Optional, TimeValue) If `wait_for_completion` is `true`, the API blocks for
(at maximum) the specified duration while waiting for the job to stop. If more
than `timeout` time has passed, the API throws a timeout exception. Defaults
to `30s`.
@ -52,7 +52,7 @@ the API call itself timed out while waiting for the status change.
--
`wait_for_completion`::
(boolean) Optional. If set to `true`, causes the API to block until the
(Optional, boolean) If set to `true`, causes the API to block until the
indexer state completely stops. If set to `false`, the API returns immediately
and the indexer is stopped asynchronously in the background. Defaults to
`false`.