[DOCS] Add experimental tag to data frame analytics APIs (#63153)

This commit is contained in:
Lisa Cawley 2020-10-02 09:42:57 -07:00 committed by lcawl
parent 3cac996373
commit 57ea5d27ae
14 changed files with 26 additions and 4 deletions

View File

@ -7,6 +7,8 @@
[id="{upid}-{api}"] [id="{upid}-{api}"]
=== Delete {dfanalytics-jobs} API === Delete {dfanalytics-jobs} API
experimental::[]
Delete an existing {dfanalytics-job}. Delete an existing {dfanalytics-job}.
The API accepts a +{request}+ object as a request and returns a +{response}+. The API accepts a +{request}+ object as a request and returns a +{response}+.

View File

@ -7,7 +7,7 @@
[id="{upid}-{api}"] [id="{upid}-{api}"]
=== Delete trained model API === Delete trained model API
experimental[] experimental::[]
Deletes a previously saved trained model. Deletes a previously saved trained model.
The API accepts a +{request}+ object and returns a +{response}+. The API accepts a +{request}+ object and returns a +{response}+.

View File

@ -7,6 +7,8 @@
[id="{upid}-{api}"] [id="{upid}-{api}"]
=== Evaluate {dfanalytics} API === Evaluate {dfanalytics} API
experimental::[]
Evaluates the {ml} algorithm that ran on a {dataframe}. Evaluates the {ml} algorithm that ran on a {dataframe}.
The API accepts an +{request}+ object and returns an +{response}+. The API accepts an +{request}+ object and returns an +{response}+.

View File

@ -7,6 +7,8 @@
[id="{upid}-{api}"] [id="{upid}-{api}"]
=== Explain {dfanalytics} API === Explain {dfanalytics} API
experimental::[]
Explains the following about a {dataframe-analytics-config}: Explains the following about a {dataframe-analytics-config}:
* field selection: which fields are included or not in the analysis * field selection: which fields are included or not in the analysis

View File

@ -5,7 +5,9 @@
-- --
[role="xpack"] [role="xpack"]
[id="{upid}-{api}"] [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 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} and other information that will be useful to import its contents to an {es}

View File

@ -7,6 +7,8 @@
[id="{upid}-{api}"] [id="{upid}-{api}"]
=== Get {dfanalytics-jobs} stats API === Get {dfanalytics-jobs} stats API
experimental::[]
Retrieves the operational statistics of one or more {dfanalytics-jobs}. Retrieves the operational statistics of one or more {dfanalytics-jobs}.
The API accepts a +{request}+ object and returns a +{response}+. The API accepts a +{request}+ object and returns a +{response}+.

View File

@ -7,6 +7,8 @@
[id="{upid}-{api}"] [id="{upid}-{api}"]
=== Get {dfanalytics-jobs} API === Get {dfanalytics-jobs} API
experimental::[]
Retrieves one or more {dfanalytics-jobs}. Retrieves one or more {dfanalytics-jobs}.
The API accepts a +{request}+ object and returns a +{response}+. The API accepts a +{request}+ object and returns a +{response}+.

View File

@ -7,7 +7,7 @@
[id="{upid}-{api}"] [id="{upid}-{api}"]
=== Get trained models stats API === Get trained models stats API
experimental[] experimental::[]
Retrieves one or more trained model statistics. Retrieves one or more trained model statistics.
The API accepts a +{request}+ object and returns a +{response}+. The API accepts a +{request}+ object and returns a +{response}+.

View File

@ -7,7 +7,7 @@
[id="{upid}-{api}"] [id="{upid}-{api}"]
=== Get trained models API === Get trained models API
experimental[] experimental::[]
Retrieves one or more trained models. Retrieves one or more trained models.
The API accepts a +{request}+ object and returns a +{response}+. The API accepts a +{request}+ object and returns a +{response}+.

View File

@ -7,6 +7,8 @@
[id="{upid}-{api}"] [id="{upid}-{api}"]
=== Put {dfanalytics-jobs} API === Put {dfanalytics-jobs} API
experimental::[]
Creates a new {dfanalytics-job}. Creates a new {dfanalytics-job}.
The API accepts a +{request}+ object as a request and returns a +{response}+. The API accepts a +{request}+ object as a request and returns a +{response}+.

View File

@ -7,6 +7,8 @@
[id="{upid}-{api}"] [id="{upid}-{api}"]
=== Put trained model API === Put trained model API
experimental::[]
Creates a new trained model for inference. Creates a new trained model for inference.
The API accepts a +{request}+ object as a request and returns a +{response}+. The API accepts a +{request}+ object as a request and returns a +{response}+.

View File

@ -7,6 +7,8 @@
[id="{upid}-{api}"] [id="{upid}-{api}"]
=== Start {dfanalytics-jobs} API === Start {dfanalytics-jobs} API
experimental::[]
Starts an existing {dfanalytics-job}. Starts an existing {dfanalytics-job}.
It accepts a +{request}+ object and responds with a +{response}+ object. It accepts a +{request}+ object and responds with a +{response}+ object.

View File

@ -7,6 +7,8 @@
[id="{upid}-{api}"] [id="{upid}-{api}"]
=== Stop {dfanalytics-jobs} API === Stop {dfanalytics-jobs} API
experimental::[]
Stops a running {dfanalytics-job}. Stops a running {dfanalytics-job}.
It accepts a +{request}+ object and responds with a +{response}+ object. It accepts a +{request}+ object and responds with a +{response}+ object.

View File

@ -7,6 +7,8 @@
[id="{upid}-{api}"] [id="{upid}-{api}"]
=== Update {dfanalytics-jobs} API === Update {dfanalytics-jobs} API
experimental::[]
Updates an existing {dfanalytics-job}. Updates an existing {dfanalytics-job}.
The API accepts an +{request}+ object as a request and returns an +{response}+. The API accepts an +{request}+ object as a request and returns an +{response}+.