浏览代码

[DOCS] Move ML info and upgrade APIs (#84005)

Lisa Cawley 3 年之前
父节点
当前提交
458ef91066

+ 1 - 1
docs/reference/migration/migrate_8_0/rest-api-changes.asciidoc

@@ -679,7 +679,7 @@ The {ml} {ref}/ml-post-data.html[post data to jobs API] is deprecated starting i
 and will be removed in a future major version.
 
 *Impact* +
-Use {ref}/ml-apis.html#ml-api-datafeed-endpoint[{dfeeds}] instead.
+Use {ref}/ml-ad-apis.html#ml-api-datafeed-endpoint[{dfeeds}] instead.
 ====
 
 .The `job_id` property of the Update {dfeeds} API has been removed.

+ 1 - 3
docs/reference/ml/anomaly-detection/apis/index.asciidoc

@@ -1,4 +1,4 @@
-include::ml-apis.asciidoc[leveloffset=+1]
+include::ml-ad-apis.asciidoc[leveloffset=+1]
 //ADD
 include::post-calendar-event.asciidoc[leveloffset=+2]
 include::put-calendar-job.asciidoc[leveloffset=+2]
@@ -34,7 +34,6 @@ include::get-datafeed-stats.asciidoc[leveloffset=+2]
 include::get-influencer.asciidoc[leveloffset=+2]
 include::get-job.asciidoc[leveloffset=+2]
 include::get-job-stats.asciidoc[leveloffset=+2]
-include::get-ml-info.asciidoc[leveloffset=+2]
 include::get-snapshot.asciidoc[leveloffset=+2]
 include::get-job-model-snapshot-upgrade-stats.asciidoc[leveloffset=+2]
 include::get-overall-buckets.asciidoc[leveloffset=+2]
@@ -52,7 +51,6 @@ include::reset-job.asciidoc[leveloffset=+2]
 //REVERT
 include::revert-snapshot.asciidoc[leveloffset=+2]
 //SET/START/STOP
-include::set-upgrade-mode.asciidoc[leveloffset=+2]
 include::start-datafeed.asciidoc[leveloffset=+2]
 include::stop-datafeed.asciidoc[leveloffset=+2]
 //UPDATE

+ 2 - 13
docs/reference/ml/anomaly-detection/apis/ml-apis.asciidoc → docs/reference/ml/anomaly-detection/apis/ml-ad-apis.asciidoc

@@ -1,10 +1,10 @@
 [role="xpack"]
-[[ml-apis]]
+[[ml-ad-apis]]
 = {ml-cap} {anomaly-detect} APIs
 
 You can use the following APIs to perform {ml} {anomaly-detect} activities.
 
-See also <<ml-df-analytics-apis>>.
+See also <<ml-apis>>, <<ml-df-analytics-apis>>,  <<ml-df-trained-models-apis>>.
 
 [discrete]
 [[ml-api-anomaly-job-endpoint]]
@@ -70,20 +70,9 @@ See also <<ml-df-analytics-apis>>.
 * <<ml-get-influencer,Get influencers>>
 * <<ml-get-record,Get records>>
 
-[discrete]
-[[ml-api-ml-info-endpoint]]
-== Info
-
-* <<get-ml-info,Machine learning info>>
-
 [discrete]
 [[ml-api-delete-expired-data-endpoint]]
 == Delete expired data
 
 * <<ml-delete-expired-data,Delete expired data>>
 
-[discrete]
-[[ml-set-upgrade-mode-endpoint]]
-== Set upgrade mode
-
-* <<ml-set-upgrade-mode, Set upgrade mode>>

+ 0 - 0
docs/reference/ml/anomaly-detection/apis/get-ml-info.asciidoc → docs/reference/ml/common/apis/get-ml-info.asciidoc


+ 6 - 0
docs/reference/ml/common/apis/index.asciidoc

@@ -0,0 +1,6 @@
+include::ml-apis.asciidoc[leveloffset=+1]
+//GET
+include::get-ml-info.asciidoc[leveloffset=+2]
+//SET
+include::set-upgrade-mode.asciidoc[leveloffset=+2]
+

+ 19 - 0
docs/reference/ml/common/apis/ml-apis.asciidoc

@@ -0,0 +1,19 @@
+[role="xpack"]
+[[ml-apis]]
+= {ml-cap} APIs
+
+You can use the following APIs to retrieve information related to the {stack-ml-features}.
+
+See also <<ml-ad-apis>>, <<ml-df-analytics-apis>>, and <<ml-df-trained-models-apis>>.
+
+[discrete]
+[[ml-api-ml-info-endpoint]]
+== Info
+
+* <<get-ml-info,Machine learning info>>
+
+[discrete]
+[[ml-set-upgrade-mode-endpoint]]
+== Set upgrade mode
+
+* <<ml-set-upgrade-mode,Set upgrade mode>>

+ 0 - 0
docs/reference/ml/anomaly-detection/apis/set-upgrade-mode.asciidoc → docs/reference/ml/common/apis/set-upgrade-mode.asciidoc


+ 3 - 1
docs/reference/rest-api/index.asciidoc

@@ -31,7 +31,8 @@ not be included yet.
 * <<info-api,Info API>>
 * <<licensing-apis,Licensing APIs>>
 * <<logstash-apis,Logstash APIs>>
-* <<ml-apis,{ml-cap} {anomaly-detect} APIs>>
+* <<ml-apis,{ml-cap} APIs>>
+* <<ml-ad-apis,{ml-cap} {anomaly-detect} APIs>>
 * <<ml-df-analytics-apis,{ml-cap} {dfanalytics} APIs>>
 * <<ml-df-trained-models-apis,{ml-cap} trained model APIs>>
 * <<migration-api,Migration APIs>>
@@ -72,6 +73,7 @@ include::{es-repo-dir}/ingest/apis/index.asciidoc[]
 include::info.asciidoc[]
 include::{es-repo-dir}/licensing/index.asciidoc[]
 include::{xes-repo-dir}/rest-api/logstash/index.asciidoc[]
+include::{es-repo-dir}/ml/common/apis/index.asciidoc[]
 include::{es-repo-dir}/ml/anomaly-detection/apis/index.asciidoc[]
 include::{es-repo-dir}/ml/df-analytics/apis/index.asciidoc[]
 include::{es-repo-dir}/ml/trained-models/apis/index.asciidoc[]