honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[DOCS] Changes level offset in data frame analytics APIs (#59919) (#59923)

This commit is contained in:
Lisa Cawley 2020-07-20 13:06:29 -07:00 committed by GitHub
parent ff8a042580
commit 8f8d24b3c1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
15 changed files with 155 additions and 155 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/reference/ml/df-analytics/apis/delete-dfanalytics.asciidoc
View File

@ -1,7 +1,7 @@
[role="xpack"] [role="xpack"]
[testenv="platinum"] [testenv="platinum"]
[[delete-dfanalytics]] [[delete-dfanalytics]]
=== Delete {dfanalytics-jobs} API = Delete {dfanalytics-jobs} API
[subs="attributes"] [subs="attributes"]
++++ ++++
<titleabbrev>Delete {dfanalytics-jobs}</titleabbrev> <titleabbrev>Delete {dfanalytics-jobs}</titleabbrev>
@ -13,13 +13,13 @@ experimental[]
[[ml-delete-dfanalytics-request]] [[ml-delete-dfanalytics-request]]
==== {api-request-title} == {api-request-title}
`DELETE _ml/data_frame/analytics/<data_frame_analytics_id>` `DELETE _ml/data_frame/analytics/<data_frame_analytics_id>`
[[ml-delete-dfanalytics-prereq]] [[ml-delete-dfanalytics-prereq]]
==== {api-prereq-title} == {api-prereq-title}
If the {es} {security-features} are enabled, you must have the following built-in roles or equivalent privileges: If the {es} {security-features} are enabled, you must have the following built-in roles or equivalent privileges:
@ -30,14 +30,14 @@ For more information, see <<security-privileges>> and <<built-in-roles>>.
[[ml-delete-dfanalytics-path-params]] [[ml-delete-dfanalytics-path-params]]
==== {api-path-parms-title} == {api-path-parms-title}
`<data_frame_analytics_id>`:: `<data_frame_analytics_id>`::
(Required, string) (Required, string)
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-data-frame-analytics] include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-data-frame-analytics]
[[ml-delete-dfanalytics-query-params]] [[ml-delete-dfanalytics-query-params]]
==== {api-query-parms-title} == {api-query-parms-title}
`force`:: `force`::
(Optional, boolean) If `true`, it deletes a job that is not stopped; this method is (Optional, boolean) If `true`, it deletes a job that is not stopped; this method is
@ -50,7 +50,7 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-data-frame-analytics]
[[ml-delete-dfanalytics-example]] [[ml-delete-dfanalytics-example]]
==== {api-examples-title} == {api-examples-title}
The following example deletes the `loganalytics` {dfanalytics-job}: The following example deletes the `loganalytics` {dfanalytics-job}:

12
docs/reference/ml/df-analytics/apis/delete-inference-trained-model.asciidoc
View File

@ -1,7 +1,7 @@
[role="xpack"] [role="xpack"]
[testenv="basic"] [testenv="basic"]
[[delete-inference]] [[delete-inference]]
=== Delete {infer} trained model API = Delete {infer} trained model API
[subs="attributes"] [subs="attributes"]
++++ ++++
<titleabbrev>Delete {infer} trained model</titleabbrev> <titleabbrev>Delete {infer} trained model</titleabbrev>
@ -14,13 +14,13 @@ experimental[]
[[ml-delete-inference-request]] [[ml-delete-inference-request]]
==== {api-request-title} == {api-request-title}
`DELETE _ml/inference/<model_id>` `DELETE _ml/inference/<model_id>`
[[ml-delete-inference-prereq]] [[ml-delete-inference-prereq]]
==== {api-prereq-title} == {api-prereq-title}
If the {es} {security-features} are enabled, you must have the following built-in roles or equivalent privileges: If the {es} {security-features} are enabled, you must have the following built-in roles or equivalent privileges:
@ -31,7 +31,7 @@ For more information, see <<security-privileges>> and <<built-in-roles>>.
[[ml-delete-inference-path-params]] [[ml-delete-inference-path-params]]
==== {api-path-parms-title} == {api-path-parms-title}
`<model_id>`:: `<model_id>`::
(Optional, string) (Optional, string)
@ -39,7 +39,7 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=model-id]
[[ml-delete-inference-response-codes]] [[ml-delete-inference-response-codes]]
==== {api-response-codes-title} == {api-response-codes-title}
`409`:: `409`::
The code indicates that the trained {infer} model is referenced by an ingest The code indicates that the trained {infer} model is referenced by an ingest
@ -47,7 +47,7 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=model-id]
[[ml-delete-inference-example]] [[ml-delete-inference-example]]
==== {api-examples-title} == {api-examples-title}
The following example deletes the `regression-job-one-1574775307356` trained The following example deletes the `regression-job-one-1574775307356` trained
model: model:

28
docs/reference/ml/df-analytics/apis/evaluate-dfanalytics.asciidoc
View File

@ -1,7 +1,7 @@
[role="xpack"] [role="xpack"]
[testenv="platinum"] [testenv="platinum"]
[[evaluate-dfanalytics]] [[evaluate-dfanalytics]]
=== Evaluate {dfanalytics} API = Evaluate {dfanalytics} API
[subs="attributes"] [subs="attributes"]
++++ ++++
@ -14,13 +14,13 @@ experimental[]
[[ml-evaluate-dfanalytics-request]] [[ml-evaluate-dfanalytics-request]]
==== {api-request-title} == {api-request-title}
`POST _ml/data_frame/_evaluate` `POST _ml/data_frame/_evaluate`
[[ml-evaluate-dfanalytics-prereq]] [[ml-evaluate-dfanalytics-prereq]]
==== {api-prereq-title} == {api-prereq-title}
If the {es} {security-features} are enabled, you must have the following privileges: If the {es} {security-features} are enabled, you must have the following privileges:
@ -30,7 +30,7 @@ For more information, see <<security-privileges>> and <<built-in-roles>>.
[[ml-evaluate-dfanalytics-desc]] [[ml-evaluate-dfanalytics-desc]]
==== {api-description-title} == {api-description-title}
The API packages together commonly used evaluation metrics for various types of The API packages together commonly used evaluation metrics for various types of
machine learning features. This has been designed for use on indexes created by machine learning features. This has been designed for use on indexes created by
@ -39,7 +39,7 @@ result field to be present.
[[ml-evaluate-dfanalytics-request-body]] [[ml-evaluate-dfanalytics-request-body]]
==== {api-request-body-title} == {api-request-body-title}
`evaluation`:: `evaluation`::
(Required, object) Defines the type of evaluation you want to perform. (Required, object) Defines the type of evaluation you want to perform.
@ -63,10 +63,10 @@ performed.
source index. See <<query-dsl>>. source index. See <<query-dsl>>.
[[ml-evaluate-dfanalytics-resources]] [[ml-evaluate-dfanalytics-resources]]
==== {dfanalytics-cap} evaluation resources == {dfanalytics-cap} evaluation resources
[[binary-sc-resources]] [[binary-sc-resources]]
===== Binary soft classification evaluation objects === Binary soft classification evaluation objects
Binary soft classification evaluates the results of an analysis which outputs Binary soft classification evaluates the results of an analysis which outputs
the probability that each document belongs to a certain class. For example, in the probability that each document belongs to a certain class. For example, in
@ -108,7 +108,7 @@ document is an outlier.
[[regression-evaluation-resources]] [[regression-evaluation-resources]]
===== {regression-cap} evaluation objects === {regression-cap} evaluation objects
{regression-cap} evaluation evaluates the results of a {regression} analysis {regression-cap} evaluation evaluates the results of a {regression} analysis
which outputs a prediction of values. which outputs a prediction of values.
@ -144,7 +144,7 @@ which outputs a prediction of values.
[[classification-evaluation-resources]] [[classification-evaluation-resources]]
==== {classification-cap} evaluation objects == {classification-cap} evaluation objects
{classification-cap} evaluation evaluates the results of a {classanalysis} which {classification-cap} evaluation evaluates the results of a {classanalysis} which
outputs a prediction that identifies to which of the classes each document outputs a prediction that identifies to which of the classes each document
@ -177,7 +177,7 @@ belongs.
//// ////
[[ml-evaluate-dfanalytics-results]] [[ml-evaluate-dfanalytics-results]]
==== {api-response-body-title} == {api-response-body-title}
`binary_soft_classification`:: `binary_soft_classification`::
(object) If you chose to do binary soft classification, the API returns the (object) If you chose to do binary soft classification, the API returns the
@ -194,11 +194,11 @@ belongs.
[[ml-evaluate-dfanalytics-example]] [[ml-evaluate-dfanalytics-example]]
==== {api-examples-title} == {api-examples-title}
[[ml-evaluate-binary-soft-class-example]] [[ml-evaluate-binary-soft-class-example]]
===== Binary soft classification === Binary soft classification
[source,console] [source,console]
-------------------------------------------------- --------------------------------------------------
@ -260,7 +260,7 @@ The API returns the following results:
[[ml-evaluate-regression-example]] [[ml-evaluate-regression-example]]
===== {regression-cap} === {regression-cap}
[source,console] [source,console]
-------------------------------------------------- --------------------------------------------------
@ -374,7 +374,7 @@ calculated by the {reganalysis}.
[[ml-evaluate-classification-example]] [[ml-evaluate-classification-example]]
===== {classification-cap} === {classification-cap}
[source,console] [source,console]

16
docs/reference/ml/df-analytics/apis/explain-dfanalytics.asciidoc
View File

@ -1,7 +1,7 @@
[role="xpack"] [role="xpack"]
[testenv="platinum"] [testenv="platinum"]
[[explain-dfanalytics]] [[explain-dfanalytics]]
=== Explain {dfanalytics} API = Explain {dfanalytics} API
[subs="attributes"] [subs="attributes"]
++++ ++++
@ -14,7 +14,7 @@ experimental[]
[[ml-explain-dfanalytics-request]] [[ml-explain-dfanalytics-request]]
==== {api-request-title} == {api-request-title}
`GET _ml/data_frame/analytics/_explain` + `GET _ml/data_frame/analytics/_explain` +
@ -26,7 +26,7 @@ experimental[]
[[ml-explain-dfanalytics-prereq]] [[ml-explain-dfanalytics-prereq]]
==== {api-prereq-title} == {api-prereq-title}
If the {es} {security-features} are enabled, you must have the following privileges: If the {es} {security-features} are enabled, you must have the following privileges:
@ -36,7 +36,7 @@ For more information, see <<security-privileges>> and <<built-in-roles>>.
[[ml-explain-dfanalytics-desc]] [[ml-explain-dfanalytics-desc]]
==== {api-description-title} == {api-description-title}
This API provides explanations for a {dataframe-analytics-config} that either This API provides explanations for a {dataframe-analytics-config} that either
exists already or one that has not been created yet. exists already or one that has not been created yet.
@ -51,21 +51,21 @@ they are not included in the explanation.
[[ml-explain-dfanalytics-path-params]] [[ml-explain-dfanalytics-path-params]]
==== {api-path-parms-title} == {api-path-parms-title}
`<data_frame_analytics_id>`:: `<data_frame_analytics_id>`::
(Optional, string) (Optional, string)
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-data-frame-analytics] include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-data-frame-analytics]
[[ml-explain-dfanalytics-request-body]] [[ml-explain-dfanalytics-request-body]]
==== {api-request-body-title} == {api-request-body-title}
A {dataframe-analytics-config} as described in <<put-dfanalytics>>. A {dataframe-analytics-config} as described in <<put-dfanalytics>>.
Note that `id` and `dest` don't need to be provided in the context of this API. Note that `id` and `dest` don't need to be provided in the context of this API.
[role="child_attributes"] [role="child_attributes"]
[[ml-explain-dfanalytics-results]] [[ml-explain-dfanalytics-results]]
==== {api-response-body-title} == {api-response-body-title}
The API returns a response that contains the following: The API returns a response that contains the following:
@ -118,7 +118,7 @@ memory needed to perform {dfanalytics}.
[[ml-explain-dfanalytics-example]] [[ml-explain-dfanalytics-example]]
==== {api-examples-title} == {api-examples-title}
[source,console] [source,console]
-------------------------------------------------- --------------------------------------------------

16
docs/reference/ml/df-analytics/apis/get-dfanalytics-stats.asciidoc
View File

@ -1,7 +1,7 @@
[role="xpack"] [role="xpack"]
[testenv="platinum"] [testenv="platinum"]
[[get-dfanalytics-stats]] [[get-dfanalytics-stats]]
=== Get {dfanalytics-jobs} statistics API = Get {dfanalytics-jobs} statistics API
[subs="attributes"] [subs="attributes"]
++++ ++++
<titleabbrev>Get {dfanalytics-jobs} stats</titleabbrev> <titleabbrev>Get {dfanalytics-jobs} stats</titleabbrev>
@ -12,7 +12,7 @@ Retrieves usage information for {dfanalytics-jobs}.
experimental[] experimental[]
[[ml-get-dfanalytics-stats-request]] [[ml-get-dfanalytics-stats-request]]
==== {api-request-title} == {api-request-title}
`GET _ml/data_frame/analytics/<data_frame_analytics_id>/_stats` + `GET _ml/data_frame/analytics/<data_frame_analytics_id>/_stats` +
@ -26,7 +26,7 @@ experimental[]
[[ml-get-dfanalytics-stats-prereq]] [[ml-get-dfanalytics-stats-prereq]]
==== {api-prereq-title} == {api-prereq-title}
If the {es} {security-features} are enabled, you must have the following privileges: If the {es} {security-features} are enabled, you must have the following privileges:
@ -35,7 +35,7 @@ If the {es} {security-features} are enabled, you must have the following privile
For more information, see <<security-privileges>> and <<built-in-roles>>. For more information, see <<security-privileges>> and <<built-in-roles>>.
[[ml-get-dfanalytics-stats-path-params]] [[ml-get-dfanalytics-stats-path-params]]
==== {api-path-parms-title} == {api-path-parms-title}
`<data_frame_analytics_id>`:: `<data_frame_analytics_id>`::
(Optional, string) (Optional, string)
@ -43,7 +43,7 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-data-frame-analytics-def
[[ml-get-dfanalytics-stats-query-params]] [[ml-get-dfanalytics-stats-query-params]]
==== {api-query-parms-title} == {api-query-parms-title}
`allow_no_match`:: `allow_no_match`::
(Optional, boolean) (Optional, boolean)
@ -63,7 +63,7 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=verbose]
[role="child_attributes"] [role="child_attributes"]
[[ml-get-dfanalytics-stats-response-body]] [[ml-get-dfanalytics-stats-response-body]]
==== {api-response-body-title} == {api-response-body-title}
`data_frame_analytics`:: `data_frame_analytics`::
(array) (array)
@ -521,7 +521,7 @@ values: `analyzing`, `failed`, `reindexing`, `started`, `starting`, `stopped`,
//End of data_frame_analytics //End of data_frame_analytics
[[ml-get-dfanalytics-stats-response-codes]] [[ml-get-dfanalytics-stats-response-codes]]
==== {api-response-codes-title} == {api-response-codes-title}
`404` (Missing resources):: `404` (Missing resources)::
If `allow_no_match` is `false`, this code indicates that there are no If `allow_no_match` is `false`, this code indicates that there are no
@ -529,7 +529,7 @@ values: `analyzing`, `failed`, `reindexing`, `started`, `starting`, `stopped`,
[[ml-get-dfanalytics-stats-example]] [[ml-get-dfanalytics-stats-example]]
==== {api-examples-title} == {api-examples-title}
The following API retrieves usage information for the The following API retrieves usage information for the
{ml-docs}/ecommerce-outliers.html[{oldetection} {dfanalytics-job} example]: {ml-docs}/ecommerce-outliers.html[{oldetection} {dfanalytics-job} example]:

18
docs/reference/ml/df-analytics/apis/get-dfanalytics.asciidoc
View File

@ -1,7 +1,7 @@
[role="xpack"] [role="xpack"]
[testenv="platinum"] [testenv="platinum"]
[[get-dfanalytics]] [[get-dfanalytics]]
=== Get {dfanalytics-jobs} API = Get {dfanalytics-jobs} API
[subs="attributes"] [subs="attributes"]
++++ ++++
<titleabbrev>Get {dfanalytics-jobs}</titleabbrev> <titleabbrev>Get {dfanalytics-jobs}</titleabbrev>
@ -13,7 +13,7 @@ experimental[]
[[ml-get-dfanalytics-request]] [[ml-get-dfanalytics-request]]
==== {api-request-title} == {api-request-title}
`GET _ml/data_frame/analytics/<data_frame_analytics_id>` + `GET _ml/data_frame/analytics/<data_frame_analytics_id>` +
@ -25,7 +25,7 @@ experimental[]
[[ml-get-dfanalytics-prereq]] [[ml-get-dfanalytics-prereq]]
==== {api-prereq-title} == {api-prereq-title}
If the {es} {security-features} are enabled, you must have the following privileges: If the {es} {security-features} are enabled, you must have the following privileges:
@ -35,14 +35,14 @@ For more information, see <<security-privileges>> and <<built-in-roles>>.
[[ml-get-dfanalytics-desc]] [[ml-get-dfanalytics-desc]]
==== {api-description-title} == {api-description-title}
You can get information for multiple {dfanalytics-jobs} in a single API request You can get information for multiple {dfanalytics-jobs} in a single API request
by using a comma-separated list of {dfanalytics-jobs} or a wildcard expression. by using a comma-separated list of {dfanalytics-jobs} or a wildcard expression.
[[ml-get-dfanalytics-path-params]] [[ml-get-dfanalytics-path-params]]
==== {api-path-parms-title} == {api-path-parms-title}
`<data_frame_analytics_id>`:: `<data_frame_analytics_id>`::
(Optional, string) (Optional, string)
@ -56,7 +56,7 @@ You can get information for all {dfanalytics-jobs} by using _all, by specifying
[[ml-get-dfanalytics-query-params]] [[ml-get-dfanalytics-query-params]]
==== {api-query-parms-title} == {api-query-parms-title}
`allow_no_match`:: `allow_no_match`::
(Optional, boolean) (Optional, boolean)
@ -72,7 +72,7 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=size]
[role="child_attributes"] [role="child_attributes"]
[[ml-get-dfanalytics-results]] [[ml-get-dfanalytics-results]]
==== {api-response-body-title} == {api-response-body-title}
`data_frame_analytics`:: `data_frame_analytics`::
(array) (array)
@ -165,7 +165,7 @@ destination.
[[ml-get-dfanalytics-response-codes]] [[ml-get-dfanalytics-response-codes]]
==== {api-response-codes-title} == {api-response-codes-title}
`404` (Missing resources):: `404` (Missing resources)::
If `allow_no_match` is `false`, this code indicates that there are no If `allow_no_match` is `false`, this code indicates that there are no
@ -173,7 +173,7 @@ destination.
[[ml-get-dfanalytics-example]] [[ml-get-dfanalytics-example]]
==== {api-examples-title} == {api-examples-title}
The following example gets configuration information for the `loganalytics` The following example gets configuration information for the `loganalytics`
{dfanalytics-job}: {dfanalytics-job}:

18
docs/reference/ml/df-analytics/apis/get-inference-trained-model-stats.asciidoc
View File

@ -1,7 +1,7 @@
[role="xpack"] [role="xpack"]
[testenv="basic"] [testenv="basic"]
[[get-inference-stats]] [[get-inference-stats]]
=== Get {infer} trained model statistics API = Get {infer} trained model statistics API
[subs="attributes"] [subs="attributes"]
++++ ++++
<titleabbrev>Get {infer} trained model stats</titleabbrev> <titleabbrev>Get {infer} trained model stats</titleabbrev>
@ -13,7 +13,7 @@ experimental[]
[[ml-get-inference-stats-request]] [[ml-get-inference-stats-request]]
==== {api-request-title} == {api-request-title}
`GET _ml/inference/_stats` + `GET _ml/inference/_stats` +
@ -27,7 +27,7 @@ experimental[]
[[ml-get-inference-stats-prereq]] [[ml-get-inference-stats-prereq]]
==== {api-prereq-title} == {api-prereq-title}
Required privileges which should be added to a custom role: Required privileges which should be added to a custom role:
@ -37,14 +37,14 @@ For more information, see <<security-privileges>> and <<built-in-roles>>.
[[ml-get-inference-stats-desc]] [[ml-get-inference-stats-desc]]
==== {api-description-title} == {api-description-title}
You can get usage information for multiple trained models in a single API You can get usage information for multiple trained models in a single API
request by using a comma-separated list of model IDs or a wildcard expression. request by using a comma-separated list of model IDs or a wildcard expression.
[[ml-get-inference-stats-path-params]] [[ml-get-inference-stats-path-params]]
==== {api-path-parms-title} == {api-path-parms-title}
`<model_id>`:: `<model_id>`::
(Optional, string) (Optional, string)
@ -52,7 +52,7 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=model-id]
[[ml-get-inference-stats-query-params]] [[ml-get-inference-stats-query-params]]
==== {api-query-parms-title} == {api-query-parms-title}
`allow_no_match`:: `allow_no_match`::
(Optional, boolean) (Optional, boolean)
@ -68,7 +68,7 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=size]
[role="child_attributes"] [role="child_attributes"]
[[ml-get-inference-stats-results]] [[ml-get-inference-stats-results]]
==== {api-response-body-title} == {api-response-body-title}
`count`:: `count`::
(integer) (integer)
@ -136,14 +136,14 @@ section in <<cluster-nodes-stats>>.
==== ====
[[ml-get-inference-stats-response-codes]] [[ml-get-inference-stats-response-codes]]
==== {api-response-codes-title} == {api-response-codes-title}
`404` (Missing resources):: `404` (Missing resources)::
If `allow_no_match` is `false`, this code indicates that there are no If `allow_no_match` is `false`, this code indicates that there are no
resources that match the request or only partial matches for the request. resources that match the request or only partial matches for the request.
[[ml-get-inference-stats-example]] [[ml-get-inference-stats-example]]
==== {api-examples-title} == {api-examples-title}
The following example gets usage information for all the trained models: The following example gets usage information for all the trained models:

18
docs/reference/ml/df-analytics/apis/get-inference-trained-model.asciidoc
View File

@ -1,7 +1,7 @@
[role="xpack"] [role="xpack"]
[testenv="basic"] [testenv="basic"]
[[get-inference]] [[get-inference]]
=== Get {infer} trained model API = Get {infer} trained model API
[subs="attributes"] [subs="attributes"]
++++ ++++
<titleabbrev>Get {infer} trained model</titleabbrev> <titleabbrev>Get {infer} trained model</titleabbrev>
@ -13,7 +13,7 @@ experimental[]
[[ml-get-inference-request]] [[ml-get-inference-request]]
==== {api-request-title} == {api-request-title}
`GET _ml/inference/` + `GET _ml/inference/` +
@ -27,7 +27,7 @@ experimental[]
[[ml-get-inference-prereq]] [[ml-get-inference-prereq]]
==== {api-prereq-title} == {api-prereq-title}
Required privileges which should be added to a custom role: Required privileges which should be added to a custom role:
@ -37,14 +37,14 @@ For more information, see <<security-privileges>> and <<built-in-roles>>.
[[ml-get-inference-desc]] [[ml-get-inference-desc]]
==== {api-description-title} == {api-description-title}
You can get information for multiple trained models in a single API request by You can get information for multiple trained models in a single API request by
using a comma-separated list of model IDs or a wildcard expression. using a comma-separated list of model IDs or a wildcard expression.
[[ml-get-inference-path-params]] [[ml-get-inference-path-params]]
==== {api-path-parms-title} == {api-path-parms-title}
`<model_id>`:: `<model_id>`::
(Optional, string) (Optional, string)
@ -52,7 +52,7 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=model-id]
[[ml-get-inference-query-params]] [[ml-get-inference-query-params]]
==== {api-query-parms-title} == {api-query-parms-title}
`allow_no_match`:: `allow_no_match`::
(Optional, boolean) (Optional, boolean)
@ -89,7 +89,7 @@ and then added to another cluster. Default is false.
[role="child_attributes"] [role="child_attributes"]
[[ml-get-inference-results]] [[ml-get-inference-results]]
==== {api-response-body-title} == {api-response-body-title}
`trained_model_configs`:: `trained_model_configs`::
(array) (array)
@ -148,7 +148,7 @@ The {es} version number in which the trained model was created.
==== ====
[[ml-get-inference-response-codes]] [[ml-get-inference-response-codes]]
==== {api-response-codes-title} == {api-response-codes-title}
`400`:: `400`::
If `include_model_definition` is `true`, this code indicates that more than If `include_model_definition` is `true`, this code indicates that more than
@ -160,7 +160,7 @@ The {es} version number in which the trained model was created.
[[ml-get-inference-example]] [[ml-get-inference-example]]
==== {api-examples-title} == {api-examples-title}
The following example gets configuration information for all the trained models: The following example gets configuration information for all the trained models:

55
docs/reference/ml/df-analytics/apis/index.asciidoc
View File

@ -1,48 +1,21 @@
[role="xpack"] include::ml-df-analytics-apis.asciidoc[leveloffset=+1]
[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}>>
* <<update-dfanalytics,Update {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}>>
* <<explain-dfanalytics,Explain {dfanalytics}>>
You can use the following APIs to perform {infer} operations.
* <<put-inference>>
* <<get-inference>>
* <<get-inference-stats>>
* <<delete-inference>>
See also <<ml-apis>>.
//CREATE //CREATE
include::put-dfanalytics.asciidoc[] include::put-dfanalytics.asciidoc[leveloffset=+2]
include::put-inference.asciidoc[] include::put-inference.asciidoc[leveloffset=+2]
//UPDATE //UPDATE
include::update-dfanalytics.asciidoc[] include::update-dfanalytics.asciidoc[leveloffset=+2]
//DELETE //DELETE
include::delete-dfanalytics.asciidoc[] include::delete-dfanalytics.asciidoc[leveloffset=+2]
include::delete-inference-trained-model.asciidoc[] include::delete-inference-trained-model.asciidoc[leveloffset=+2]
//EVALUATE //EVALUATE
include::evaluate-dfanalytics.asciidoc[] include::evaluate-dfanalytics.asciidoc[leveloffset=+2]
//ESTIMATE_MEMORY_USAGE //ESTIMATE_MEMORY_USAGE
include::explain-dfanalytics.asciidoc[] include::explain-dfanalytics.asciidoc[leveloffset=+2]
//GET //GET
include::get-dfanalytics.asciidoc[] include::get-dfanalytics.asciidoc[leveloffset=+2]
include::get-dfanalytics-stats.asciidoc[] include::get-dfanalytics-stats.asciidoc[leveloffset=+2]
include::get-inference-trained-model.asciidoc[] include::get-inference-trained-model.asciidoc[leveloffset=+2]
include::get-inference-trained-model-stats.asciidoc[] include::get-inference-trained-model-stats.asciidoc[leveloffset=+2]
//SET/START/STOP //SET/START/STOP
include::start-dfanalytics.asciidoc[] include::start-dfanalytics.asciidoc[leveloffset=+2]
include::stop-dfanalytics.asciidoc[] include::stop-dfanalytics.asciidoc[leveloffset=+2]

27
docs/reference/ml/df-analytics/apis/ml-df-analytics-apis.asciidoc Normal file
View File

@ -0,0 +1,27 @@
[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}>>
* <<update-dfanalytics,Update {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}>>
* <<explain-dfanalytics,Explain {dfanalytics}>>
You can use the following APIs to perform {infer} operations.
* <<put-inference>>
* <<get-inference>>
* <<get-inference-stats>>
* <<delete-inference>>
See also <<ml-apis>>.

22
docs/reference/ml/df-analytics/apis/put-dfanalytics.asciidoc
View File

@ -1,7 +1,7 @@
[role="xpack"] [role="xpack"]
[testenv="platinum"] [testenv="platinum"]
[[put-dfanalytics]] [[put-dfanalytics]]
=== Create {dfanalytics-jobs} API = Create {dfanalytics-jobs} API
[subs="attributes"] [subs="attributes"]
++++ ++++
<titleabbrev>Create {dfanalytics-jobs}</titleabbrev> <titleabbrev>Create {dfanalytics-jobs}</titleabbrev>
@ -12,13 +12,13 @@ Instantiates a {dfanalytics-job}.
experimental[] experimental[]
[[ml-put-dfanalytics-request]] [[ml-put-dfanalytics-request]]
==== {api-request-title} == {api-request-title}
`PUT _ml/data_frame/analytics/<data_frame_analytics_id>` `PUT _ml/data_frame/analytics/<data_frame_analytics_id>`
[[ml-put-dfanalytics-prereq]] [[ml-put-dfanalytics-prereq]]
==== {api-prereq-title} == {api-prereq-title}
If the {es} {security-features} are enabled, you must have the following built-in roles and privileges: If the {es} {security-features} are enabled, you must have the following built-in roles and privileges:
@ -39,7 +39,7 @@ those same roles. If you provide
those credentials are used instead. those credentials are used instead.
[[ml-put-dfanalytics-desc]] [[ml-put-dfanalytics-desc]]
==== {api-description-title} == {api-description-title}
This API creates a {dfanalytics-job} that performs an analysis on the source This API creates a {dfanalytics-job} that performs an analysis on the source
indices and stores the outcome in a destination index. indices and stores the outcome in a destination index.
@ -52,7 +52,7 @@ If you supply only a subset of the {regression} or {classification} parameters,
determines a value for each of the undefined parameters. determines a value for each of the undefined parameters.
[[ml-put-dfanalytics-path-params]] [[ml-put-dfanalytics-path-params]]
==== {api-path-parms-title} == {api-path-parms-title}
`<data_frame_analytics_id>`:: `<data_frame_analytics_id>`::
(Required, string) (Required, string)
@ -60,7 +60,7 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-data-frame-analytics-def
[role="child_attributes"] [role="child_attributes"]
[[ml-put-dfanalytics-request-body]] [[ml-put-dfanalytics-request-body]]
==== {api-request-body-title} == {api-request-body-title}
`allow_lazy_start`:: `allow_lazy_start`::
(Optional, boolean) (Optional, boolean)
@ -386,11 +386,11 @@ the destination.
[[ml-put-dfanalytics-example]] [[ml-put-dfanalytics-example]]
==== {api-examples-title} == {api-examples-title}
[[ml-put-dfanalytics-example-preprocess]] [[ml-put-dfanalytics-example-preprocess]]
===== Preprocessing actions example === Preprocessing actions example
The following example shows how to limit the scope of the analysis to certain The following example shows how to limit the scope of the analysis to certain
fields, specify excluded fields in the destination index, and use a query to fields, specify excluded fields in the destination index, and use a query to
@ -461,7 +461,7 @@ excluded field by the `excludes` parameter of the `analyzed_fields` object.
[[ml-put-dfanalytics-example-od]] [[ml-put-dfanalytics-example-od]]
===== {oldetection-cap} example === {oldetection-cap} example
The following example creates the `loganalytics` {dfanalytics-job}, the analysis The following example creates the `loganalytics` {dfanalytics-job}, the analysis
type is `outlier_detection`: type is `outlier_detection`:
@ -525,7 +525,7 @@ The API returns the following result:
[[ml-put-dfanalytics-example-r]] [[ml-put-dfanalytics-example-r]]
===== {regression-cap} examples === {regression-cap} examples
The following example creates the `house_price_regression_analysis` The following example creates the `house_price_regression_analysis`
{dfanalytics-job}, the analysis type is `regression`: {dfanalytics-job}, the analysis type is `regression`:
@ -614,7 +614,7 @@ PUT _ml/data_frame/analytics/student_performance_mathematics_0.3
[[ml-put-dfanalytics-example-c]] [[ml-put-dfanalytics-example-c]]
===== {classification-cap} example === {classification-cap} example
The following example creates the `loan_classification` {dfanalytics-job}, the The following example creates the `loan_classification` {dfanalytics-job}, the
analysis type is `classification`: analysis type is `classification`:

22
docs/reference/ml/df-analytics/apis/put-inference.asciidoc
View File

@ -1,7 +1,7 @@
[role="xpack"] [role="xpack"]
[testenv="basic"] [testenv="basic"]
[[put-inference]] [[put-inference]]
=== Create {infer} trained model API = Create {infer} trained model API
[subs="attributes"] [subs="attributes"]
++++ ++++
<titleabbrev>Create {infer} trained model</titleabbrev> <titleabbrev>Create {infer} trained model</titleabbrev>
@ -19,13 +19,13 @@ experimental[]
[[ml-put-inference-request]] [[ml-put-inference-request]]
==== {api-request-title} == {api-request-title}
`PUT _ml/inference/<model_id>` `PUT _ml/inference/<model_id>`
[[ml-put-inference-prereq]] [[ml-put-inference-prereq]]
==== {api-prereq-title} == {api-prereq-title}
If the {es} {security-features} are enabled, you must have the following If the {es} {security-features} are enabled, you must have the following
built-in roles and privileges: built-in roles and privileges:
@ -36,14 +36,14 @@ For more information, see <<security-privileges>> and <<built-in-roles>>.
[[ml-put-inference-desc]] [[ml-put-inference-desc]]
==== {api-description-title} == {api-description-title}
The create {infer} trained model API enables you to supply a trained model that The create {infer} trained model API enables you to supply a trained model that
is not created by {dfanalytics}. is not created by {dfanalytics}.
[[ml-put-inference-path-params]] [[ml-put-inference-path-params]]
==== {api-path-parms-title} == {api-path-parms-title}
`<model_id>`:: `<model_id>`::
(Required, string) (Required, string)
@ -51,7 +51,7 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=model-id]
[role="child_attributes"] [role="child_attributes"]
[[ml-put-inference-request-body]] [[ml-put-inference-request-body]]
==== {api-request-body-title} == {api-request-body-title}
`compressed_definition`:: `compressed_definition`::
(Required, string) (Required, string)
@ -449,10 +449,10 @@ An array of tags to organize the model.
[[ml-put-inference-example]] [[ml-put-inference-example]]
==== {api-examples-title} == {api-examples-title}
[[ml-put-inference-preprocessor-example]] [[ml-put-inference-preprocessor-example]]
===== Preprocessor examples === Preprocessor examples
The example below shows a `frequency_encoding` preprocessor object: The example below shows a `frequency_encoding` preprocessor object:
@ -519,7 +519,7 @@ This example shows a `target_mean_encoding` preprocessor object:
[[ml-put-inference-model-example]] [[ml-put-inference-model-example]]
===== Model examples === Model examples
The first example shows a `trained_model` object: The first example shows a `trained_model` object:
@ -603,7 +603,7 @@ The following example shows an `ensemble` model object:
[[ml-put-inference-aggregated-output-example]] [[ml-put-inference-aggregated-output-example]]
===== Aggregated output example === Aggregated output example
Example of a `logistic_regression` object: Example of a `logistic_regression` object:
@ -658,7 +658,7 @@ Example of an `exponent` object:
[[ml-put-inference-json-schema]] [[ml-put-inference-json-schema]]
===== {infer-cap} JSON schema === {infer-cap} JSON schema
For the full JSON schema of model {infer}, For the full JSON schema of model {infer},
https://github.com/elastic/ml-json-schemas[click here]. https://github.com/elastic/ml-json-schemas[click here].

16
docs/reference/ml/df-analytics/apis/start-dfanalytics.asciidoc
View File

@ -1,7 +1,7 @@
[role="xpack"] [role="xpack"]
[testenv="platinum"] [testenv="platinum"]
[[start-dfanalytics]] [[start-dfanalytics]]
=== Start {dfanalytics-jobs} API = Start {dfanalytics-jobs} API
[subs="attributes"] [subs="attributes"]
++++ ++++
@ -13,12 +13,12 @@ Starts a {dfanalytics-job}.
experimental[] experimental[]
[[ml-start-dfanalytics-request]] [[ml-start-dfanalytics-request]]
==== {api-request-title} == {api-request-title}
`POST _ml/data_frame/analytics/<data_frame_analytics_id>/_start` `POST _ml/data_frame/analytics/<data_frame_analytics_id>/_start`
[[ml-start-dfanalytics-prereq]] [[ml-start-dfanalytics-prereq]]
==== {api-prereq-title} == {api-prereq-title}
If the {es} {security-features} are enabled, you must have the following built-in roles and privileges: If the {es} {security-features} are enabled, you must have the following built-in roles and privileges:
@ -32,7 +32,7 @@ If the {es} {security-features} are enabled, you must have the following built-i
For more information, see <<security-privileges>> and <<built-in-roles>>. For more information, see <<security-privileges>> and <<built-in-roles>>.
[[ml-start-dfanalytics-desc]] [[ml-start-dfanalytics-desc]]
==== {api-description-title} == {api-description-title}
A {dfanalytics-job} can be started and stopped multiple times throughout its A {dfanalytics-job} can be started and stopped multiple times throughout its
lifecycle. lifecycle.
@ -54,21 +54,21 @@ provided <<http-clients-secondary-authorization,secondary authorization headers>
when you created the job, those credentials are used. when you created the job, those credentials are used.
[[ml-start-dfanalytics-path-params]] [[ml-start-dfanalytics-path-params]]
==== {api-path-parms-title} == {api-path-parms-title}
`<data_frame_analytics_id>`:: `<data_frame_analytics_id>`::
(Required, string) (Required, string)
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-data-frame-analytics-define] include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-data-frame-analytics-define]
[[ml-start-dfanalytics-query-params]] [[ml-start-dfanalytics-query-params]]
==== {api-query-parms-title} == {api-query-parms-title}
`timeout`:: `timeout`::
(Optional, <<time-units,time units>>) (Optional, <<time-units,time units>>)
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=timeout-start] include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=timeout-start]
[[ml-start-dfanalytics-response-body]] [[ml-start-dfanalytics-response-body]]
==== {api-response-body-title} == {api-response-body-title}
`acknowledged`:: `acknowledged`::
(boolean) For a successful response, this value is always `true`. On failure, an (boolean) For a successful response, this value is always `true`. On failure, an
@ -79,7 +79,7 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=timeout-start]
If the job is allowed to open lazily and has not yet been assigned to a node, this value is an empty string. If the job is allowed to open lazily and has not yet been assigned to a node, this value is an empty string.
[[ml-start-dfanalytics-example]] [[ml-start-dfanalytics-example]]
==== {api-examples-title} == {api-examples-title}
The following example starts the `loganalytics` {dfanalytics-job}: The following example starts the `loganalytics` {dfanalytics-job}:

14
docs/reference/ml/df-analytics/apis/stop-dfanalytics.asciidoc
View File

@ -1,7 +1,7 @@
[role="xpack"] [role="xpack"]
[testenv="platinum"] [testenv="platinum"]
[[stop-dfanalytics]] [[stop-dfanalytics]]
=== Stop {dfanalytics-jobs} API = Stop {dfanalytics-jobs} API
[subs="attributes"] [subs="attributes"]
++++ ++++
@ -13,7 +13,7 @@ Stops one or more {dfanalytics-jobs}.
experimental[] experimental[]
[[ml-stop-dfanalytics-request]] [[ml-stop-dfanalytics-request]]
==== {api-request-title} == {api-request-title}
`POST _ml/data_frame/analytics/<data_frame_analytics_id>/_stop` + `POST _ml/data_frame/analytics/<data_frame_analytics_id>/_stop` +
@ -22,7 +22,7 @@ experimental[]
`POST _ml/data_frame/analytics/_all/_stop` `POST _ml/data_frame/analytics/_all/_stop`
[[ml-stop-dfanalytics-prereq]] [[ml-stop-dfanalytics-prereq]]
==== {api-prereq-title} == {api-prereq-title}
If the {es} {security-features} are enabled, you must have the following built-in roles or equivalent privileges: If the {es} {security-features} are enabled, you must have the following built-in roles or equivalent privileges:
@ -33,7 +33,7 @@ For more information, see <<security-privileges>> and <<built-in-roles>>.
[[ml-stop-dfanalytics-desc]] [[ml-stop-dfanalytics-desc]]
==== {api-description-title} == {api-description-title}
A {dfanalytics-job} can be started and stopped multiple times throughout its A {dfanalytics-job} can be started and stopped multiple times throughout its
lifecycle. lifecycle.
@ -44,14 +44,14 @@ stop all {dfanalytics-job} by using _all or by specifying * as the
<data_frame_analytics_id>. <data_frame_analytics_id>.
[[ml-stop-dfanalytics-path-params]] [[ml-stop-dfanalytics-path-params]]
==== {api-path-parms-title} == {api-path-parms-title}
`<data_frame_analytics_id>`:: `<data_frame_analytics_id>`::
(Required, string) (Required, string)
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-data-frame-analytics-define] include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-data-frame-analytics-define]
[[ml-stop-dfanalytics-query-params]] [[ml-stop-dfanalytics-query-params]]
==== {api-query-parms-title} == {api-query-parms-title}
`allow_no_match`:: `allow_no_match`::
(Optional, boolean) (Optional, boolean)
@ -67,7 +67,7 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=timeout-stop]
[[ml-stop-dfanalytics-example]] [[ml-stop-dfanalytics-example]]
==== {api-examples-title} == {api-examples-title}
The following example stops the `loganalytics` {dfanalytics-job}: The following example stops the `loganalytics` {dfanalytics-job}:

16
docs/reference/ml/df-analytics/apis/update-dfanalytics.asciidoc
View File

@ -1,7 +1,7 @@
[role="xpack"] [role="xpack"]
[testenv="platinum"] [testenv="platinum"]
[[update-dfanalytics]] [[update-dfanalytics]]
=== Update {dfanalytics-jobs} API = Update {dfanalytics-jobs} API
[subs="attributes"] [subs="attributes"]
++++ ++++
<titleabbrev>Update {dfanalytics-jobs}</titleabbrev> <titleabbrev>Update {dfanalytics-jobs}</titleabbrev>
@ -12,13 +12,13 @@ Updates an existing {dfanalytics-job}.
experimental[] experimental[]
[[ml-update-dfanalytics-request]] [[ml-update-dfanalytics-request]]
==== {api-request-title} == {api-request-title}
`POST _ml/data_frame/analytics/<data_frame_analytics_id>/_update` `POST _ml/data_frame/analytics/<data_frame_analytics_id>/_update`
[[ml-update-dfanalytics-prereq]] [[ml-update-dfanalytics-prereq]]
==== {api-prereq-title} == {api-prereq-title}
If the {es} {security-features} are enabled, you must have the following If the {es} {security-features} are enabled, you must have the following
built-in roles and privileges: built-in roles and privileges:
@ -40,14 +40,14 @@ those same roles. If you provide
those credentials are used instead. those credentials are used instead.
[[ml-update-dfanalytics-desc]] [[ml-update-dfanalytics-desc]]
==== {api-description-title} == {api-description-title}
This API updates an existing {dfanalytics-job} that performs an analysis on the source This API updates an existing {dfanalytics-job} that performs an analysis on the source
indices and stores the outcome in a destination index. indices and stores the outcome in a destination index.
[[ml-update-dfanalytics-path-params]] [[ml-update-dfanalytics-path-params]]
==== {api-path-parms-title} == {api-path-parms-title}
`<data_frame_analytics_id>`:: `<data_frame_analytics_id>`::
(Required, string) (Required, string)
@ -55,7 +55,7 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-data-frame-analytics-def
[role="child_attributes"] [role="child_attributes"]
[[ml-update-dfanalytics-request-body]] [[ml-update-dfanalytics-request-body]]
==== {api-request-body-title} == {api-request-body-title}
`allow_lazy_start`:: `allow_lazy_start`::
(Optional, boolean) (Optional, boolean)
@ -89,10 +89,10 @@ setting, an error occurs when you try to create {dfanalytics-jobs} that have
<<ml-settings>>. <<ml-settings>>.
[[ml-update-dfanalytics-example]] [[ml-update-dfanalytics-example]]
==== {api-examples-title} == {api-examples-title}
[[ml-update-dfanalytics-example-preprocess]] [[ml-update-dfanalytics-example-preprocess]]
===== Updating model memory limit example === Updating model memory limit example
The following example shows how to update the model memory limit for the existing {dfanalytics} configuration. The following example shows how to update the model memory limit for the existing {dfanalytics} configuration.