From 57ea5d27ae49e6652c17887242bfc69ab85f16d5 Mon Sep 17 00:00:00 2001 From: Lisa Cawley Date: Fri, 2 Oct 2020 09:42:57 -0700 Subject: [PATCH] [DOCS] Add experimental tag to data frame analytics APIs (#63153) --- .../high-level/ml/delete-data-frame-analytics.asciidoc | 2 ++ docs/java-rest/high-level/ml/delete-trained-models.asciidoc | 2 +- docs/java-rest/high-level/ml/evaluate-data-frame.asciidoc | 2 ++ .../high-level/ml/explain-data-frame-analytics.asciidoc | 2 ++ docs/java-rest/high-level/ml/find-file-structure.asciidoc | 4 +++- .../high-level/ml/get-data-frame-analytics-stats.asciidoc | 2 ++ .../java-rest/high-level/ml/get-data-frame-analytics.asciidoc | 2 ++ .../java-rest/high-level/ml/get-trained-models-stats.asciidoc | 2 +- docs/java-rest/high-level/ml/get-trained-models.asciidoc | 2 +- .../java-rest/high-level/ml/put-data-frame-analytics.asciidoc | 2 ++ docs/java-rest/high-level/ml/put-trained-model.asciidoc | 2 ++ .../high-level/ml/start-data-frame-analytics.asciidoc | 2 ++ .../high-level/ml/stop-data-frame-analytics.asciidoc | 2 ++ .../high-level/ml/update-data-frame-analytics.asciidoc | 2 ++ 14 files changed, 26 insertions(+), 4 deletions(-) diff --git a/docs/java-rest/high-level/ml/delete-data-frame-analytics.asciidoc b/docs/java-rest/high-level/ml/delete-data-frame-analytics.asciidoc index 2874414465f..4967d137894 100644 --- a/docs/java-rest/high-level/ml/delete-data-frame-analytics.asciidoc +++ b/docs/java-rest/high-level/ml/delete-data-frame-analytics.asciidoc @@ -7,6 +7,8 @@ [id="{upid}-{api}"] === Delete {dfanalytics-jobs} API +experimental::[] + Delete an existing {dfanalytics-job}. The API accepts a +{request}+ object as a request and returns a +{response}+. diff --git a/docs/java-rest/high-level/ml/delete-trained-models.asciidoc b/docs/java-rest/high-level/ml/delete-trained-models.asciidoc index 81836808b3d..8d33391f62f 100644 --- a/docs/java-rest/high-level/ml/delete-trained-models.asciidoc +++ b/docs/java-rest/high-level/ml/delete-trained-models.asciidoc @@ -7,7 +7,7 @@ [id="{upid}-{api}"] === Delete trained model API -experimental[] +experimental::[] Deletes a previously saved trained model. The API accepts a +{request}+ object and returns a +{response}+. diff --git a/docs/java-rest/high-level/ml/evaluate-data-frame.asciidoc b/docs/java-rest/high-level/ml/evaluate-data-frame.asciidoc index 3698e919545..22e6bf2924f 100644 --- a/docs/java-rest/high-level/ml/evaluate-data-frame.asciidoc +++ b/docs/java-rest/high-level/ml/evaluate-data-frame.asciidoc @@ -7,6 +7,8 @@ [id="{upid}-{api}"] === Evaluate {dfanalytics} API +experimental::[] + Evaluates the {ml} algorithm that ran on a {dataframe}. The API accepts an +{request}+ object and returns an +{response}+. diff --git a/docs/java-rest/high-level/ml/explain-data-frame-analytics.asciidoc b/docs/java-rest/high-level/ml/explain-data-frame-analytics.asciidoc index 77d289f873f..7d9ac1620ec 100644 --- a/docs/java-rest/high-level/ml/explain-data-frame-analytics.asciidoc +++ b/docs/java-rest/high-level/ml/explain-data-frame-analytics.asciidoc @@ -7,6 +7,8 @@ [id="{upid}-{api}"] === Explain {dfanalytics} API +experimental::[] + Explains the following about a {dataframe-analytics-config}: * field selection: which fields are included or not in the analysis diff --git a/docs/java-rest/high-level/ml/find-file-structure.asciidoc b/docs/java-rest/high-level/ml/find-file-structure.asciidoc index bb0fbea91b3..31bedb0b7fd 100644 --- a/docs/java-rest/high-level/ml/find-file-structure.asciidoc +++ b/docs/java-rest/high-level/ml/find-file-structure.asciidoc @@ -5,7 +5,9 @@ -- [role="xpack"] [id="{upid}-{api}"] -=== Find File Structure API +=== Find file structure API + +experimental::[] The Find File Structure API can be used to find the structure of a text file and other information that will be useful to import its contents to an {es} diff --git a/docs/java-rest/high-level/ml/get-data-frame-analytics-stats.asciidoc b/docs/java-rest/high-level/ml/get-data-frame-analytics-stats.asciidoc index 09023e2c7b7..98fa1815478 100644 --- a/docs/java-rest/high-level/ml/get-data-frame-analytics-stats.asciidoc +++ b/docs/java-rest/high-level/ml/get-data-frame-analytics-stats.asciidoc @@ -7,6 +7,8 @@ [id="{upid}-{api}"] === Get {dfanalytics-jobs} stats API +experimental::[] + Retrieves the operational statistics of one or more {dfanalytics-jobs}. The API accepts a +{request}+ object and returns a +{response}+. diff --git a/docs/java-rest/high-level/ml/get-data-frame-analytics.asciidoc b/docs/java-rest/high-level/ml/get-data-frame-analytics.asciidoc index 2e956d43074..20684c0d020 100644 --- a/docs/java-rest/high-level/ml/get-data-frame-analytics.asciidoc +++ b/docs/java-rest/high-level/ml/get-data-frame-analytics.asciidoc @@ -7,6 +7,8 @@ [id="{upid}-{api}"] === Get {dfanalytics-jobs} API +experimental::[] + Retrieves one or more {dfanalytics-jobs}. The API accepts a +{request}+ object and returns a +{response}+. diff --git a/docs/java-rest/high-level/ml/get-trained-models-stats.asciidoc b/docs/java-rest/high-level/ml/get-trained-models-stats.asciidoc index f61f82949ee..532c3942f0d 100644 --- a/docs/java-rest/high-level/ml/get-trained-models-stats.asciidoc +++ b/docs/java-rest/high-level/ml/get-trained-models-stats.asciidoc @@ -7,7 +7,7 @@ [id="{upid}-{api}"] === Get trained models stats API -experimental[] +experimental::[] Retrieves one or more trained model statistics. The API accepts a +{request}+ object and returns a +{response}+. diff --git a/docs/java-rest/high-level/ml/get-trained-models.asciidoc b/docs/java-rest/high-level/ml/get-trained-models.asciidoc index 275b4c54292..0d93a52b1ea 100644 --- a/docs/java-rest/high-level/ml/get-trained-models.asciidoc +++ b/docs/java-rest/high-level/ml/get-trained-models.asciidoc @@ -7,7 +7,7 @@ [id="{upid}-{api}"] === Get trained models API -experimental[] +experimental::[] Retrieves one or more trained models. The API accepts a +{request}+ object and returns a +{response}+. diff --git a/docs/java-rest/high-level/ml/put-data-frame-analytics.asciidoc b/docs/java-rest/high-level/ml/put-data-frame-analytics.asciidoc index 109aecc5a14..616b828ed00 100644 --- a/docs/java-rest/high-level/ml/put-data-frame-analytics.asciidoc +++ b/docs/java-rest/high-level/ml/put-data-frame-analytics.asciidoc @@ -7,6 +7,8 @@ [id="{upid}-{api}"] === Put {dfanalytics-jobs} API +experimental::[] + Creates a new {dfanalytics-job}. The API accepts a +{request}+ object as a request and returns a +{response}+. diff --git a/docs/java-rest/high-level/ml/put-trained-model.asciidoc b/docs/java-rest/high-level/ml/put-trained-model.asciidoc index 528fa1a39e0..d36ff7cae02 100644 --- a/docs/java-rest/high-level/ml/put-trained-model.asciidoc +++ b/docs/java-rest/high-level/ml/put-trained-model.asciidoc @@ -7,6 +7,8 @@ [id="{upid}-{api}"] === Put trained model API +experimental::[] + Creates a new trained model for inference. The API accepts a +{request}+ object as a request and returns a +{response}+. diff --git a/docs/java-rest/high-level/ml/start-data-frame-analytics.asciidoc b/docs/java-rest/high-level/ml/start-data-frame-analytics.asciidoc index 4b2fa169209..f4ec368c1dc 100644 --- a/docs/java-rest/high-level/ml/start-data-frame-analytics.asciidoc +++ b/docs/java-rest/high-level/ml/start-data-frame-analytics.asciidoc @@ -7,6 +7,8 @@ [id="{upid}-{api}"] === Start {dfanalytics-jobs} API +experimental::[] + Starts an existing {dfanalytics-job}. It accepts a +{request}+ object and responds with a +{response}+ object. diff --git a/docs/java-rest/high-level/ml/stop-data-frame-analytics.asciidoc b/docs/java-rest/high-level/ml/stop-data-frame-analytics.asciidoc index 47a2fc26241..58c66b472fc 100644 --- a/docs/java-rest/high-level/ml/stop-data-frame-analytics.asciidoc +++ b/docs/java-rest/high-level/ml/stop-data-frame-analytics.asciidoc @@ -7,6 +7,8 @@ [id="{upid}-{api}"] === Stop {dfanalytics-jobs} API +experimental::[] + Stops a running {dfanalytics-job}. It accepts a +{request}+ object and responds with a +{response}+ object. diff --git a/docs/java-rest/high-level/ml/update-data-frame-analytics.asciidoc b/docs/java-rest/high-level/ml/update-data-frame-analytics.asciidoc index a110baa49e6..36db38186dc 100644 --- a/docs/java-rest/high-level/ml/update-data-frame-analytics.asciidoc +++ b/docs/java-rest/high-level/ml/update-data-frame-analytics.asciidoc @@ -7,6 +7,8 @@ [id="{upid}-{api}"] === Update {dfanalytics-jobs} API +experimental::[] + Updates an existing {dfanalytics-job}. The API accepts an +{request}+ object as a request and returns an +{response}+.