Skip to content

Commit c4f9ef9

Browse files
committed
[DOCS] Updates terms in machine learning datafeed APIs (#44883)
1 parent 3305a2f commit c4f9ef9

10 files changed

+115
-108
lines changed

docs/java-rest/high-level/ml/delete-datafeed.asciidoc

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,29 +4,30 @@
44
:response: AcknowledgedResponse
55
--
66
[id="{upid}-delete-datafeed"]
7-
=== Delete Datafeed API
7+
=== Delete datafeed API
8+
9+
Deletes an existing datafeed.
810

911
[id="{upid}-{api}-request"]
10-
==== Delete Datafeed Request
12+
==== Delete datafeed request
1113

1214
A +{request}+ object requires a non-null `datafeedId` and can optionally set `force`.
1315

1416
["source","java",subs="attributes,callouts,macros"]
1517
---------------------------------------------------
1618
include-tagged::{doc-tests-file}[{api}-request]
1719
---------------------------------------------------
18-
<1> Use to forcefully delete a started datafeed;
19-
this method is quicker than stopping and deleting the datafeed.
20-
Defaults to `false`.
20+
<1> Use to forcefully delete a started datafeed. This method is quicker than
21+
stopping and deleting the datafeed. Defaults to `false`.
2122

2223
include::../execution.asciidoc[]
2324

2425
[id="{upid}-{api}-response"]
25-
==== Delete Datafeed Response
26+
==== Delete datafeed response
2627

2728
The returned +{response}+ object indicates the acknowledgement of the request:
2829
["source","java",subs="attributes,callouts,macros"]
2930
---------------------------------------------------
3031
include-tagged::{doc-tests-file}[{api}-response]
3132
---------------------------------------------------
32-
<1> `isAcknowledged` was the deletion request acknowledged or not
33+
<1> `isAcknowledged` was the deletion request acknowledged or not.

docs/java-rest/high-level/ml/put-datafeed.asciidoc

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,25 +4,24 @@
44
:response: PutDatafeedResponse
55
--
66
[id="{upid}-{api}"]
7-
=== Put Datafeed API
7+
=== Put datafeed API
88

9-
The Put Datafeed API can be used to create a new {ml} datafeed
10-
in the cluster. The API accepts a +{request}+ object
9+
Creates a new {ml} datafeed in the cluster. The API accepts a +{request}+ object
1110
as a request and returns a +{response}+.
1211

1312
[id="{upid}-{api}-request"]
14-
==== Put Datafeed Request
13+
==== Put datafeed request
1514

1615
A +{request}+ requires the following argument:
1716

1817
["source","java",subs="attributes,callouts,macros"]
1918
--------------------------------------------------
2019
include-tagged::{doc-tests-file}[{api}-request]
2120
--------------------------------------------------
22-
<1> The configuration of the {ml} datafeed to create
21+
<1> The configuration of the {ml} datafeed to create.
2322

2423
[id="{upid}-{api}-config"]
25-
==== Datafeed Configuration
24+
==== Datafeed configuration
2625

2726
The `DatafeedConfig` object contains all the details about the {ml} datafeed
2827
configuration.
@@ -33,10 +32,10 @@ A `DatafeedConfig` requires the following arguments:
3332
--------------------------------------------------
3433
include-tagged::{doc-tests-file}[{api}-config]
3534
--------------------------------------------------
36-
<1> The datafeed ID and the job ID
37-
<2> The indices that contain the data to retrieve and feed into the job
35+
<1> The datafeed ID and the {anomaly-job} ID.
36+
<2> The indices that contain the data to retrieve and feed into the {anomaly-job}.
3837

39-
==== Optional Arguments
38+
==== Optional arguments
4039
The following arguments are optional:
4140

4241
["source","java",subs="attributes,callouts,macros"]
@@ -49,7 +48,8 @@ include-tagged::{doc-tests-file}[{api}-config-set-chunking-config]
4948
--------------------------------------------------
5049
include-tagged::{doc-tests-file}[{api}-config-set-frequency]
5150
--------------------------------------------------
52-
<1> The interval at which scheduled queries are made while the datafeed runs in real time.
51+
<1> The interval at which scheduled queries are made while the datafeed runs in
52+
real time.
5353

5454
["source","java",subs="attributes,callouts,macros"]
5555
--------------------------------------------------
@@ -72,8 +72,9 @@ The window must be larger than the Job's bucket size, but smaller than 24 hours,
7272
and span less than 10,000 buckets.
7373
Defaults to `null`, which causes an appropriate window span to be calculated when
7474
the datafeed runs.
75-
The default `check_window` span calculation is the max between `2h` or `8 * bucket_span`.
76-
To explicitly disable, pass `DelayedDataCheckConfig.disabledDelayedDataCheckConfig()`.
75+
The default `check_window` span calculation is the max between `2h` or
76+
`8 * bucket_span`. To explicitly disable, pass
77+
`DelayedDataCheckConfig.disabledDelayedDataCheckConfig()`.
7778

7879
["source","java",subs="attributes,callouts,macros"]
7980
--------------------------------------------------
@@ -101,4 +102,4 @@ default values:
101102
--------------------------------------------------
102103
include-tagged::{doc-tests-file}[{api}-response]
103104
--------------------------------------------------
104-
<1> The created datafeed
105+
<1> The created datafeed.

docs/java-rest/high-level/ml/start-datafeed.asciidoc

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,13 @@
44
:response: StartDatafeedResponse
55
--
66
[id="{upid}-{api}"]
7-
=== Start Datafeed API
7+
=== Start datafeed API
88

9-
The Start Datafeed API provides the ability to start a {ml} datafeed in the cluster.
10-
It accepts a +{request}+ object and responds
11-
with a +{response}+ object.
9+
Starts a {ml} datafeed in the cluster. It accepts a +{request}+ object and
10+
responds with a +{response}+ object.
1211

1312
[id="{upid}-{api}-request"]
14-
==== Start Datafeed Request
13+
==== Start datafeed request
1514

1615
A +{request}+ object is created referencing a non-null `datafeedId`.
1716
All other fields are optional for the request.
@@ -20,9 +19,9 @@ All other fields are optional for the request.
2019
--------------------------------------------------
2120
include-tagged::{doc-tests-file}[{api}-request]
2221
--------------------------------------------------
23-
<1> Constructing a new request referencing an existing `datafeedId`
22+
<1> Constructing a new request referencing an existing `datafeedId`.
2423

25-
==== Optional Arguments
24+
==== Optional arguments
2625

2726
The following arguments are optional.
2827

docs/java-rest/high-level/ml/update-datafeed.asciidoc

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,13 @@
44
:response: PutDatafeedResponse
55
--
66
[id="{upid}-{api}"]
7-
=== Update Datafeed API
7+
=== Update datafeed API
88

9-
The Update Datafeed API can be used to update a {ml} datafeed
10-
in the cluster. The API accepts a +{request}+ object
9+
Updates a {ml} datafeed in the cluster. The API accepts a +{request}+ object
1110
as a request and returns a +{response}+.
1211

1312
[id="{upid}-{api}-request"]
14-
==== Update Datafeed Request
13+
==== Update datafeed request
1514

1615
A +{request}+ requires the following argument:
1716

@@ -22,7 +21,7 @@ include-tagged::{doc-tests-file}[{api}-request]
2221
<1> The updated configuration of the {ml} datafeed
2322

2423
[id="{upid}-{api}-config"]
25-
==== Updated Datafeed Arguments
24+
==== Updated datafeed arguments
2625

2726
A `DatafeedUpdate` requires an existing non-null `datafeedId` and
2827
allows updating various settings.
@@ -31,12 +30,15 @@ allows updating various settings.
3130
--------------------------------------------------
3231
include-tagged::{doc-tests-file}[{api}-config]
3332
--------------------------------------------------
34-
<1> Mandatory, non-null `datafeedId` referencing an existing {ml} datafeed
35-
<2> Optional, set the datafeed Aggregations for data gathering
36-
<3> Optional, the indices that contain the data to retrieve and feed into the job
33+
<1> Mandatory, non-null `datafeedId` referencing an existing {ml} datafeed.
34+
<2> Optional, set the datafeed aggregations for data gathering.
35+
<3> Optional, the indices that contain the data to retrieve and feed into the
36+
{anomaly-job}.
3737
<4> Optional, specifies how data searches are split into time chunks.
38-
<5> Optional, the interval at which scheduled queries are made while the datafeed runs in real time.
39-
<6> Optional, a query to filter the search results by. Defaults to the `match_all` query.
38+
<5> Optional, the interval at which scheduled queries are made while the
39+
datafeed runs in real time.
40+
<6> Optional, a query to filter the search results by. Defaults to the
41+
`match_all` query.
4042
<7> Optional, the time interval behind real time that data is queried.
4143
<8> Optional, allows the use of script fields.
4244
<9> Optional, the `size` parameter used in the searches.
@@ -55,4 +57,4 @@ the updated {ml} datafeed if it has been successfully updated.
5557
--------------------------------------------------
5658
include-tagged::{doc-tests-file}[{api}-response]
5759
--------------------------------------------------
58-
<1> The updated datafeed
60+
<1> The updated datafeed.

docs/reference/ml/anomaly-detection/apis/delete-datafeed.asciidoc

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -15,29 +15,31 @@ Deletes an existing {dfeed}.
1515

1616
`DELETE _ml/datafeeds/<feed_id>`
1717

18+
[[ml-delete-datafeed-prereqs]]
19+
==== {api-prereq-title}
20+
21+
* If {es} {security-features} are enabled, you must have `manage_ml` or
22+
`manage` cluster privileges to use this API. For more information, see
23+
{stack-ov}/security-privileges.html[Security privileges].
24+
1825
[[ml-delete-datafeed-desc]]
1926
==== {api-description-title}
2027

21-
NOTE: Unless the `force` parameter is used, the {dfeed} must be stopped before it can be deleted.
28+
NOTE: Unless the `force` parameter is used, the {dfeed} must be stopped before
29+
it can be deleted.
2230

2331
[[ml-delete-datafeed-path-parms]]
2432
==== {api-path-parms-title}
2533

26-
`feed_id` (required)::
27-
(string) Identifier for the {dfeed}
34+
`feed_id`::
35+
(Required, string) Identifier for the {dfeed}.
2836

2937
[[ml-delete-datafeed-query-parms]]
3038
==== {api-query-parms-title}
3139

3240
`force`::
33-
(boolean) Use to forcefully delete a started {dfeed}; this method is quicker than
34-
stopping and deleting the {dfeed}.
35-
36-
[[ml-delete-datafeed-prereqs]]
37-
==== {api-prereq-title}
38-
39-
You must have `manage_ml`, or `manage` cluster privileges to use this API.
40-
For more information, see {stack-ov}/security-privileges.html[Security privileges].
41+
(Optional, boolean) Use to forcefully delete a started {dfeed}; this method is
42+
quicker than stopping and deleting the {dfeed}.
4143

4244
[[ml-delete-datafeed-example]]
4345
==== {api-examples-title}

docs/reference/ml/anomaly-detection/apis/preview-datafeed.asciidoc

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,13 @@ Previews a {dfeed}.
1515

1616
`GET _ml/datafeeds/<datafeed_id>/_preview`
1717

18+
[[ml-preview-datafeed-prereqs]]
19+
==== {api-prereq-title}
20+
21+
* If {es} {security-features} are enabled, you must have `monitor_ml`, `monitor`,
22+
`manage_ml`, or `manage` cluster privileges to use this API. For more
23+
information, see {stack-ov}/security-privileges.html[Security privileges].
24+
1825
[[ml-preview-datafeed-desc]]
1926
==== {api-description-title}
2027

@@ -25,19 +32,11 @@ structure of the data that will be passed to the anomaly detection engine.
2532
[[ml-preview-datafeed-path-parms]]
2633
==== {api-path-parms-title}
2734

28-
`datafeed_id` (required)::
29-
(string) Identifier for the {dfeed}
30-
31-
[[ml-preview-datafeed-prereqs]]
32-
==== {api-prereq-title}
33-
34-
If {es} {security-features} are enabled, you must have `monitor_ml`, `monitor`,
35-
`manage_ml`, or `manage` cluster privileges to use this API. For more
36-
information, see
37-
{stack-ov}/security-privileges.html[Security privileges].
35+
`datafeed_id`::
36+
(Required, string) Identifier for the {dfeed}.
3837

3938
[[ml-preview-datafeed-security]]
40-
==== Security Integration
39+
==== Security integration
4140

4241
When {es} {security-features} are enabled, the {dfeed} query is previewed using
4342
the credentials of the user calling the preview {dfeed} API. When the {dfeed}

docs/reference/ml/anomaly-detection/apis/put-datafeed.asciidoc

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,18 @@ Instantiates a {dfeed}.
1515

1616
`PUT _ml/datafeeds/<feed_id>`
1717

18+
[[ml-put-datafeed-prereqs]]
19+
==== {api-prereq-title}
20+
21+
* You must create an {anomaly-job} before you create a {dfeed}.
22+
* If {es} {security-features} are enabled, you must have `manage_ml` or `manage`
23+
cluster privileges to use this API. See
24+
{stack-ov}/security-privileges.html[Security privileges].
25+
1826
[[ml-put-datafeed-desc]]
1927
==== {api-description-title}
2028

21-
You must create a job before you create a {dfeed}. You can associate only one
22-
{dfeed} to each job.
29+
You can associate only one {dfeed} to each {anomaly-job}.
2330

2431
IMPORTANT: You must use {kib} or this API to create a {dfeed}. Do not put a {dfeed}
2532
directly to the `.ml-config` index using the Elasticsearch index API.
@@ -29,8 +36,8 @@ IMPORTANT: You must use {kib} or this API to create a {dfeed}. Do not put a {df
2936
[[ml-put-datafeed-path-parms]]
3037
==== {api-path-parms-title}
3138

32-
`feed_id` (required)::
33-
(string) A numerical character string that uniquely identifies the {dfeed}.
39+
`feed_id`::
40+
(Required, string) A numerical character string that uniquely identifies the {dfeed}.
3441
This identifier can contain lowercase alphanumeric characters (a-z and 0-9),
3542
hyphens, and underscores. It must start and end with alphanumeric characters.
3643

@@ -56,12 +63,13 @@ IMPORTANT: You must use {kib} or this API to create a {dfeed}. Do not put a {df
5663
bucket spans, or, for longer bucket spans, a sensible fraction of the bucket
5764
span. For example: `150s`.
5865

59-
`indices` (required)::
60-
(array) An array of index names. Wildcards are supported. For example:
66+
`indices`::
67+
(Required, array) An array of index names. Wildcards are supported. For example:
6168
`["it_ops_metrics", "server*"]`.
6269

63-
`job_id` (required)::
64-
(string) A numerical character string that uniquely identifies the job.
70+
`job_id`::
71+
(Required, string) A numerical character string that uniquely identifies the
72+
{anomaly-job}.
6573

6674
`query`::
6775
(object) The {es} query domain-specific language (DSL). This value
@@ -90,13 +98,6 @@ IMPORTANT: You must use {kib} or this API to create a {dfeed}. Do not put a {df
9098
For more information about these properties,
9199
see <<ml-datafeed-resource>>.
92100

93-
[[ml-put-datafeed-prereqs]]
94-
==== {api-prereq-title}
95-
96-
If {es} {security-features} are enabled, you must have `manage_ml`, or `manage`
97-
cluster privileges to use this API. For more information, see
98-
{stack-ov}/security-privileges.html[Security privileges].
99-
100101
[[ml-put-datafeed-security]]
101102
==== Security integration
102103

0 commit comments

Comments
 (0)