Skip to content

Commit b0f7017

Browse files
committed
[DOCS] Updates terms in machine learning datafeed APIs (#44883)
1 parent 27ea4d9 commit b0f7017

File tree

7 files changed

+49
-45
lines changed

7 files changed

+49
-45
lines changed

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

+8-7
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

+14-13
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

+6-7
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

+13-11
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/put-datafeed.asciidoc

+3-3
Original file line numberDiff line numberDiff line change
@@ -18,15 +18,15 @@ Instantiates a {dfeed}.
1818
[[ml-put-datafeed-prereqs]]
1919
==== {api-prereq-title}
2020

21-
* You must create a job before you create a {dfeed}.
21+
* You must create an {anomaly-job} before you create a {dfeed}.
2222
* If {es} {security-features} are enabled, you must have `manage_ml` or `manage`
2323
cluster privileges to use this API. See
2424
{stack-ov}/security-privileges.html[Security privileges].
2525

2626
[[ml-put-datafeed-desc]]
2727
==== {api-description-title}
2828

29-
You can associate only one {dfeed} to each job.
29+
You can associate only one {dfeed} to each {anomaly-job}.
3030

3131
[IMPORTANT]
3232
====
@@ -75,7 +75,7 @@ those same roles.
7575

7676
`job_id`::
7777
(Required, string) A numerical character string that uniquely identifies the
78-
job.
78+
{anomaly-job}.
7979

8080
`query`::
8181
(Optional, object) The {es} query domain-specific language (DSL). This value

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

+4-3
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@ Starts one or more {dfeeds}.
1818
[[ml-start-datafeed-prereqs]]
1919
==== {api-prereq-title}
2020

21-
* Before you can start a {dfeed}, the job must be open. Otherwise, an error
22-
occurs.
21+
* Before you can start a {dfeed}, the {anomaly-job} must be open. Otherwise, an
22+
error occurs.
2323
* If {es} {security-features} are enabled, you must have `manage_ml` or `manage`
2424
cluster privileges to use this API. See
2525
{stack-ov}/security-privileges.html[Security privileges].
@@ -36,7 +36,8 @@ If you want to analyze from the beginning of a dataset, you can specify any date
3636
earlier than that beginning date.
3737

3838
If you do not specify a start time and the {dfeed} is associated with a new
39-
job, the analysis starts from the earliest time for which data is available.
39+
{anomaly-job}, the analysis starts from the earliest time for which data is
40+
available.
4041

4142
When you start a {dfeed}, you can also specify an end time. If you do so, the
4243
job analyzes data from the start time until the end time, at which point the

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ The following properties can be updated after the {dfeed} is created:
6767

6868
`job_id`::
6969
(Optional, string) A numerical character string that uniquely identifies the
70-
job.
70+
{anomaly-job}.
7171

7272
`query`::
7373
(Optional, object) The {es} query domain-specific language (DSL). This value

0 commit comments

Comments
 (0)