diff --git a/docs/reference/ml/apis/ml-api.asciidoc b/docs/reference/ml/apis/ml-api.asciidoc index b22debec63c..2014d058125 100644 --- a/docs/reference/ml/apis/ml-api.asciidoc +++ b/docs/reference/ml/apis/ml-api.asciidoc @@ -1,12 +1,14 @@ [role="xpack"] [testenv="platinum"] [[ml-apis]] -== Machine learning APIs +== {ml-cap} {anomaly-detect} APIs -You can use the following APIs to perform {ml} activities. -See <> for the resource definitions used by the +You can use the following APIs to perform {ml} {anomaly-detect} activities. See +<> for the resource definitions used by the machine learning APIs and in advanced job configuration options in Kibana. +See also <>. + [discrete] [[ml-api-anomaly-job-endpoint]] === {anomaly-jobs-cap} @@ -48,23 +50,11 @@ machine learning APIs and in advanced job configuration options in Kibana. * <> * <> -[discrete] -[[ml-api-dfanalytics-endpoint]] -=== {dfanalytics-cap} APIs - -* <> or -<> -* <> or -<> -* <> or <> -* <> - - [discrete] [[ml-api-job-endpoint]] === Jobs -See <> and <>. +See <>. [discrete] [[ml-api-snapshot-endpoint]] @@ -120,7 +110,6 @@ include::put-job.asciidoc[] include::put-calendar.asciidoc[] include::put-datafeed.asciidoc[] include::put-filter.asciidoc[] -include::put-dfanalytics.asciidoc[] //DELETE include::delete-calendar.asciidoc[] include::delete-datafeed.asciidoc[] @@ -131,9 +120,6 @@ include::delete-job.asciidoc[] include::delete-calendar-job.asciidoc[] include::delete-snapshot.asciidoc[] include::delete-expired-data.asciidoc[] -include::delete-dfanalytics.asciidoc[] -//EVALUATE -include::evaluate-dfanalytics.asciidoc[] //FIND include::find-file-structure.asciidoc[] //FLUSH @@ -144,8 +130,6 @@ include::forecast.asciidoc[] include::get-bucket.asciidoc[] include::get-calendar.asciidoc[] include::get-category.asciidoc[] -include::get-dfanalytics.asciidoc[] -include::get-dfanalytics-stats.asciidoc[] include::get-datafeed.asciidoc[] include::get-datafeed-stats.asciidoc[] include::get-influencer.asciidoc[] @@ -168,9 +152,7 @@ include::revert-snapshot.asciidoc[] //SET/START/STOP include::set-upgrade-mode.asciidoc[] include::start-datafeed.asciidoc[] -include::start-dfanalytics.asciidoc[] include::stop-datafeed.asciidoc[] -include::stop-dfanalytics.asciidoc[] //UPDATE include::update-datafeed.asciidoc[] include::update-filter.asciidoc[] diff --git a/docs/reference/ml/apis/delete-dfanalytics.asciidoc b/docs/reference/ml/df-analytics/apis/delete-dfanalytics.asciidoc similarity index 100% rename from docs/reference/ml/apis/delete-dfanalytics.asciidoc rename to docs/reference/ml/df-analytics/apis/delete-dfanalytics.asciidoc diff --git a/docs/reference/ml/apis/dfanalyticsresources.asciidoc b/docs/reference/ml/df-analytics/apis/dfanalyticsresources.asciidoc similarity index 100% rename from docs/reference/ml/apis/dfanalyticsresources.asciidoc rename to docs/reference/ml/df-analytics/apis/dfanalyticsresources.asciidoc diff --git a/docs/reference/ml/apis/evaluate-dfanalytics.asciidoc b/docs/reference/ml/df-analytics/apis/evaluate-dfanalytics.asciidoc similarity index 100% rename from docs/reference/ml/apis/evaluate-dfanalytics.asciidoc rename to docs/reference/ml/df-analytics/apis/evaluate-dfanalytics.asciidoc diff --git a/docs/reference/ml/apis/get-dfanalytics-stats.asciidoc b/docs/reference/ml/df-analytics/apis/get-dfanalytics-stats.asciidoc similarity index 100% rename from docs/reference/ml/apis/get-dfanalytics-stats.asciidoc rename to docs/reference/ml/df-analytics/apis/get-dfanalytics-stats.asciidoc diff --git a/docs/reference/ml/apis/get-dfanalytics.asciidoc b/docs/reference/ml/df-analytics/apis/get-dfanalytics.asciidoc similarity index 100% rename from docs/reference/ml/apis/get-dfanalytics.asciidoc rename to docs/reference/ml/df-analytics/apis/get-dfanalytics.asciidoc diff --git a/docs/reference/ml/df-analytics/apis/index.asciidoc b/docs/reference/ml/df-analytics/apis/index.asciidoc new file mode 100644 index 00000000000..416e11f146b --- /dev/null +++ b/docs/reference/ml/df-analytics/apis/index.asciidoc @@ -0,0 +1,30 @@ +[role="xpack"] +[testenv="platinum"] +[[ml-df-analytics-apis]] +== {ml-cap} {dfanalytics} APIs + +You can use the following APIs to perform {ml} {dfanalytics} activities. + +* <> +* <> +* <> +* <> +* <> +* <> +* <> + +See also <>. + +//CREATE +include::put-dfanalytics.asciidoc[] +//DELETE +include::delete-dfanalytics.asciidoc[] +//EVALUATE +include::evaluate-dfanalytics.asciidoc[] +//GET +include::get-dfanalytics.asciidoc[] +include::get-dfanalytics-stats.asciidoc[] +//SET/START/STOP +include::start-dfanalytics.asciidoc[] +include::stop-dfanalytics.asciidoc[] + diff --git a/docs/reference/ml/apis/put-dfanalytics.asciidoc b/docs/reference/ml/df-analytics/apis/put-dfanalytics.asciidoc similarity index 100% rename from docs/reference/ml/apis/put-dfanalytics.asciidoc rename to docs/reference/ml/df-analytics/apis/put-dfanalytics.asciidoc diff --git a/docs/reference/ml/apis/start-dfanalytics.asciidoc b/docs/reference/ml/df-analytics/apis/start-dfanalytics.asciidoc similarity index 100% rename from docs/reference/ml/apis/start-dfanalytics.asciidoc rename to docs/reference/ml/df-analytics/apis/start-dfanalytics.asciidoc diff --git a/docs/reference/ml/apis/stop-dfanalytics.asciidoc b/docs/reference/ml/df-analytics/apis/stop-dfanalytics.asciidoc similarity index 100% rename from docs/reference/ml/apis/stop-dfanalytics.asciidoc rename to docs/reference/ml/df-analytics/apis/stop-dfanalytics.asciidoc diff --git a/docs/reference/rest-api/defs.asciidoc b/docs/reference/rest-api/defs.asciidoc index 8acd59dbf19..34edfc389ef 100644 --- a/docs/reference/rest-api/defs.asciidoc +++ b/docs/reference/rest-api/defs.asciidoc @@ -17,7 +17,7 @@ These resource definitions are used in APIs related to {ml-features} and * <> include::{es-repo-dir}/ml/apis/datafeedresource.asciidoc[] -include::{es-repo-dir}/ml/apis/dfanalyticsresources.asciidoc[] +include::{es-repo-dir}/ml/df-analytics/apis/dfanalyticsresources.asciidoc[] include::{es-repo-dir}/data-frames/apis/transformresource.asciidoc[] include::{es-repo-dir}/ml/apis/evaluateresources.asciidoc[] include::{es-repo-dir}/ml/apis/jobresource.asciidoc[] diff --git a/docs/reference/rest-api/index.asciidoc b/docs/reference/rest-api/index.asciidoc index 78aa0f7e7d4..7d706088802 100644 --- a/docs/reference/rest-api/index.asciidoc +++ b/docs/reference/rest-api/index.asciidoc @@ -19,7 +19,8 @@ not be included yet. * <> * <> * <> -* <> +* <> +* <> * <> * <> * <> @@ -37,6 +38,7 @@ include::{es-repo-dir}/indices/apis/index.asciidoc[] include::{es-repo-dir}/licensing/index.asciidoc[] include::{es-repo-dir}/migration/migration.asciidoc[] include::{es-repo-dir}/ml/apis/ml-api.asciidoc[] +include::{es-repo-dir}/ml/df-analytics/apis/index.asciidoc[] include::{es-repo-dir}/rollup/rollup-api.asciidoc[] include::{xes-repo-dir}/rest-api/security.asciidoc[] include::{xes-repo-dir}/rest-api/watcher.asciidoc[]