Skip to content

Commit 503b494

Browse files
committed
[DOCS] Separates data frame analytics APIs (#44451)
1 parent ba37dce commit 503b494

12 files changed

+40
-26
lines changed

docs/reference/ml/apis/ml-api.asciidoc

Lines changed: 6 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
11
[role="xpack"]
22
[testenv="platinum"]
33
[[ml-apis]]
4-
== Machine learning APIs
4+
== {ml-cap} {anomaly-detect} APIs
55

6-
You can use the following APIs to perform {ml} activities.
7-
See <<ml-api-definitions, Definitions>> for the resource definitions used by the
6+
You can use the following APIs to perform {ml} {anomaly-detect} activities. See
7+
<<ml-api-definitions, Definitions>> for the resource definitions used by the
88
machine learning APIs and in advanced job configuration options in Kibana.
99

10+
See also <<ml-df-analytics-apis>>.
11+
1012
[discrete]
1113
[[ml-api-anomaly-job-endpoint]]
1214
=== {anomaly-jobs-cap}
@@ -48,23 +50,11 @@ machine learning APIs and in advanced job configuration options in Kibana.
4850
* <<ml-preview-datafeed,Preview {dfeed}>>
4951
* <<ml-update-datafeed,Update {dfeed}>>
5052

51-
[discrete]
52-
[[ml-api-dfanalytics-endpoint]]
53-
=== {dfanalytics-cap} APIs
54-
55-
* <<put-dfanalytics,Create>> or
56-
<<delete-dfanalytics,delete {dfanalytics-jobs}>>
57-
* <<get-dfanalytics,Get {dfanalytics-jobs} info>> or
58-
<<get-dfanalytics-stats,statistics>>
59-
* <<start-dfanalytics,Start>> or <<stop-dfanalytics,stop {dfanalytics-jobs}>>
60-
* <<evaluate-dfanalytics,Evaluate {dfanalytics}>>
61-
62-
6353
[discrete]
6454
[[ml-api-job-endpoint]]
6555
=== Jobs
6656

67-
See <<ml-api-anomaly-job-endpoint>> and <<ml-api-dfanalytics-endpoint>>.
57+
See <<ml-api-anomaly-job-endpoint>>.
6858

6959
[discrete]
7060
[[ml-api-snapshot-endpoint]]
@@ -120,7 +110,6 @@ include::put-job.asciidoc[]
120110
include::put-calendar.asciidoc[]
121111
include::put-datafeed.asciidoc[]
122112
include::put-filter.asciidoc[]
123-
include::put-dfanalytics.asciidoc[]
124113
//DELETE
125114
include::delete-calendar.asciidoc[]
126115
include::delete-datafeed.asciidoc[]
@@ -131,9 +120,6 @@ include::delete-job.asciidoc[]
131120
include::delete-calendar-job.asciidoc[]
132121
include::delete-snapshot.asciidoc[]
133122
include::delete-expired-data.asciidoc[]
134-
include::delete-dfanalytics.asciidoc[]
135-
//EVALUATE
136-
include::evaluate-dfanalytics.asciidoc[]
137123
//FIND
138124
include::find-file-structure.asciidoc[]
139125
//FLUSH
@@ -144,8 +130,6 @@ include::forecast.asciidoc[]
144130
include::get-bucket.asciidoc[]
145131
include::get-calendar.asciidoc[]
146132
include::get-category.asciidoc[]
147-
include::get-dfanalytics.asciidoc[]
148-
include::get-dfanalytics-stats.asciidoc[]
149133
include::get-datafeed.asciidoc[]
150134
include::get-datafeed-stats.asciidoc[]
151135
include::get-influencer.asciidoc[]
@@ -168,9 +152,7 @@ include::revert-snapshot.asciidoc[]
168152
//SET/START/STOP
169153
include::set-upgrade-mode.asciidoc[]
170154
include::start-datafeed.asciidoc[]
171-
include::start-dfanalytics.asciidoc[]
172155
include::stop-datafeed.asciidoc[]
173-
include::stop-dfanalytics.asciidoc[]
174156
//UPDATE
175157
include::update-datafeed.asciidoc[]
176158
include::update-filter.asciidoc[]
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
[role="xpack"]
2+
[testenv="platinum"]
3+
[[ml-df-analytics-apis]]
4+
== {ml-cap} {dfanalytics} APIs
5+
6+
You can use the following APIs to perform {ml} {dfanalytics} activities.
7+
8+
* <<put-dfanalytics,Create {dfanalytics-jobs}>>
9+
* <<delete-dfanalytics,Delete {dfanalytics-jobs}>>
10+
* <<get-dfanalytics,Get {dfanalytics-jobs} info>>
11+
* <<get-dfanalytics-stats,Get {dfanalytics-jobs} statistics>>
12+
* <<start-dfanalytics,Start {dfanalytics-jobs}>>
13+
* <<stop-dfanalytics,Stop {dfanalytics-jobs}>>
14+
* <<evaluate-dfanalytics,Evaluate {dfanalytics}>>
15+
16+
See also <<ml-apis>>.
17+
18+
//CREATE
19+
include::put-dfanalytics.asciidoc[]
20+
//DELETE
21+
include::delete-dfanalytics.asciidoc[]
22+
//EVALUATE
23+
include::evaluate-dfanalytics.asciidoc[]
24+
//GET
25+
include::get-dfanalytics.asciidoc[]
26+
include::get-dfanalytics-stats.asciidoc[]
27+
//SET/START/STOP
28+
include::start-dfanalytics.asciidoc[]
29+
include::stop-dfanalytics.asciidoc[]
30+

docs/reference/rest-api/defs.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ These resource definitions are used in APIs related to {ml-features} and
1717
* <<role-mapping-resources,Role mappings>>
1818

1919
include::{es-repo-dir}/ml/apis/datafeedresource.asciidoc[]
20-
include::{es-repo-dir}/ml/apis/dfanalyticsresources.asciidoc[]
20+
include::{es-repo-dir}/ml/df-analytics/apis/dfanalyticsresources.asciidoc[]
2121
include::{es-repo-dir}/data-frames/apis/transformresource.asciidoc[]
2222
include::{es-repo-dir}/ml/apis/evaluateresources.asciidoc[]
2323
include::{es-repo-dir}/ml/apis/jobresource.asciidoc[]

docs/reference/rest-api/index.asciidoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,8 @@ not be included yet.
1818
* <<indices-reload-analyzers,Reload Search Analyzers API>>
1919
* <<index-lifecycle-management-api,Index lifecycle management APIs>>
2020
* <<licensing-apis,Licensing APIs>>
21-
* <<ml-apis,Machine Learning APIs>>
21+
* <<ml-apis,{ml-cap} {anomaly-detect} APIs>>
22+
* <<ml-df-analytics-apis,{ml-cap} {dfanalytics} APIs>>
2223
* <<security-api,Security APIs>>
2324
* <<watcher-api,Watcher APIs>>
2425
* <<rollup-apis,Rollup APIs>>
@@ -35,6 +36,7 @@ include::{es-repo-dir}/indices/apis/index.asciidoc[]
3536
include::{es-repo-dir}/licensing/index.asciidoc[]
3637
include::{es-repo-dir}/migration/migration.asciidoc[]
3738
include::{es-repo-dir}/ml/apis/ml-api.asciidoc[]
39+
include::{es-repo-dir}/ml/df-analytics/apis/index.asciidoc[]
3840
include::{es-repo-dir}/rollup/rollup-api.asciidoc[]
3941
include::{xes-repo-dir}/rest-api/security.asciidoc[]
4042
include::{xes-repo-dir}/rest-api/watcher.asciidoc[]

0 commit comments

Comments
 (0)