[DOCS] Separates data frame analytics APIs (#44451)

This commit is contained in:
Lisa Cawley 2019-07-16 13:22:27 -07:00 committed by lcawl
parent 3220709b0a
commit 53514b0477
12 changed files with 40 additions and 26 deletions

View File

@ -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 <<ml-api-definitions, Definitions>> for the resource definitions used by the
You can use the following APIs to perform {ml} {anomaly-detect} activities. See
<<ml-api-definitions, Definitions>> for the resource definitions used by the
machine learning APIs and in advanced job configuration options in Kibana.
See also <<ml-df-analytics-apis>>.
[discrete]
[[ml-api-anomaly-job-endpoint]]
=== {anomaly-jobs-cap}
@ -48,23 +50,11 @@ machine learning APIs and in advanced job configuration options in Kibana.
* <<ml-preview-datafeed,Preview {dfeed}>>
* <<ml-update-datafeed,Update {dfeed}>>
[discrete]
[[ml-api-dfanalytics-endpoint]]
=== {dfanalytics-cap} APIs
* <<put-dfanalytics,Create>> or
<<delete-dfanalytics,delete {dfanalytics-jobs}>>
* <<get-dfanalytics,Get {dfanalytics-jobs} info>> or
<<get-dfanalytics-stats,statistics>>
* <<start-dfanalytics,Start>> or <<stop-dfanalytics,stop {dfanalytics-jobs}>>
* <<evaluate-dfanalytics,Evaluate {dfanalytics}>>
[discrete]
[[ml-api-job-endpoint]]
=== Jobs
See <<ml-api-anomaly-job-endpoint>> and <<ml-api-dfanalytics-endpoint>>.
See <<ml-api-anomaly-job-endpoint>>.
[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[]

View File

@ -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.
* <<put-dfanalytics,Create {dfanalytics-jobs}>>
* <<delete-dfanalytics,Delete {dfanalytics-jobs}>>
* <<get-dfanalytics,Get {dfanalytics-jobs} info>>
* <<get-dfanalytics-stats,Get {dfanalytics-jobs} statistics>>
* <<start-dfanalytics,Start {dfanalytics-jobs}>>
* <<stop-dfanalytics,Stop {dfanalytics-jobs}>>
* <<evaluate-dfanalytics,Evaluate {dfanalytics}>>
See also <<ml-apis>>.
//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[]

View File

@ -17,7 +17,7 @@ These resource definitions are used in APIs related to {ml-features} and
* <<role-mapping-resources,Role mappings>>
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[]

View File

@ -19,7 +19,8 @@ not be included yet.
* <<index-lifecycle-management-api,Index lifecycle management APIs>>
* <<snapshot-lifecycle-management-api,Snapshot lifecycle management APIs>>
* <<licensing-apis,Licensing APIs>>
* <<ml-apis,Machine Learning APIs>>
* <<ml-apis,{ml-cap} {anomaly-detect} APIs>>
* <<ml-df-analytics-apis,{ml-cap} {dfanalytics} APIs>>
* <<security-api,Security APIs>>
* <<watcher-api,Watcher APIs>>
* <<rollup-apis,Rollup APIs>>
@ -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[]