Skip to content

Commit

Permalink
[DOCS] Changes level offset in data frame analytics APIs (#59919) (#5…
Browse files Browse the repository at this point in the history
…9923)
  • Loading branch information
lcawl authored Jul 20, 2020
1 parent ff8a042 commit 8f8d24b
Show file tree
Hide file tree
Showing 15 changed files with 155 additions and 155 deletions.
12 changes: 6 additions & 6 deletions docs/reference/ml/df-analytics/apis/delete-dfanalytics.asciidoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[role="xpack"]
[testenv="platinum"]
[[delete-dfanalytics]]
=== Delete {dfanalytics-jobs} API
= Delete {dfanalytics-jobs} API
[subs="attributes"]
++++
<titleabbrev>Delete {dfanalytics-jobs}</titleabbrev>
Expand All @@ -13,13 +13,13 @@ experimental[]


[[ml-delete-dfanalytics-request]]
==== {api-request-title}
== {api-request-title}

`DELETE _ml/data_frame/analytics/<data_frame_analytics_id>`


[[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:

Expand All @@ -30,14 +30,14 @@ For more information, see <<security-privileges>> and <<built-in-roles>>.


[[ml-delete-dfanalytics-path-params]]
==== {api-path-parms-title}
== {api-path-parms-title}

`<data_frame_analytics_id>`::
(Required, string)
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-data-frame-analytics]

[[ml-delete-dfanalytics-query-params]]
==== {api-query-parms-title}
== {api-query-parms-title}

`force`::
(Optional, boolean) If `true`, it deletes a job that is not stopped; this method is
Expand All @@ -50,7 +50,7 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-data-frame-analytics]


[[ml-delete-dfanalytics-example]]
==== {api-examples-title}
== {api-examples-title}

The following example deletes the `loganalytics` {dfanalytics-job}:

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[role="xpack"]
[testenv="basic"]
[[delete-inference]]
=== Delete {infer} trained model API
= Delete {infer} trained model API
[subs="attributes"]
++++
<titleabbrev>Delete {infer} trained model</titleabbrev>
Expand All @@ -14,13 +14,13 @@ experimental[]


[[ml-delete-inference-request]]
==== {api-request-title}
== {api-request-title}

`DELETE _ml/inference/<model_id>`


[[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:

Expand All @@ -31,23 +31,23 @@ For more information, see <<security-privileges>> and <<built-in-roles>>.


[[ml-delete-inference-path-params]]
==== {api-path-parms-title}
== {api-path-parms-title}

`<model_id>`::
(Optional, string)
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=model-id]


[[ml-delete-inference-response-codes]]
==== {api-response-codes-title}
== {api-response-codes-title}

`409`::
The code indicates that the trained {infer} model is referenced by an ingest
pipeline and cannot be deleted.


[[ml-delete-inference-example]]
==== {api-examples-title}
== {api-examples-title}

The following example deletes the `regression-job-one-1574775307356` trained
model:
Expand Down
28 changes: 14 additions & 14 deletions docs/reference/ml/df-analytics/apis/evaluate-dfanalytics.asciidoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[role="xpack"]
[testenv="platinum"]
[[evaluate-dfanalytics]]
=== Evaluate {dfanalytics} API
= Evaluate {dfanalytics} API

[subs="attributes"]
++++
Expand All @@ -14,13 +14,13 @@ experimental[]


[[ml-evaluate-dfanalytics-request]]
==== {api-request-title}
== {api-request-title}

`POST _ml/data_frame/_evaluate`


[[ml-evaluate-dfanalytics-prereq]]
==== {api-prereq-title}
== {api-prereq-title}

If the {es} {security-features} are enabled, you must have the following privileges:

Expand All @@ -30,7 +30,7 @@ For more information, see <<security-privileges>> and <<built-in-roles>>.


[[ml-evaluate-dfanalytics-desc]]
==== {api-description-title}
== {api-description-title}

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
Expand All @@ -39,7 +39,7 @@ result field to be present.


[[ml-evaluate-dfanalytics-request-body]]
==== {api-request-body-title}
== {api-request-body-title}

`evaluation`::
(Required, object) Defines the type of evaluation you want to perform.
Expand All @@ -63,10 +63,10 @@ performed.
source index. See <<query-dsl>>.

[[ml-evaluate-dfanalytics-resources]]
==== {dfanalytics-cap} evaluation resources
== {dfanalytics-cap} evaluation 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
the probability that each document belongs to a certain class. For example, in
Expand Down Expand Up @@ -108,7 +108,7 @@ document is an outlier.


[[regression-evaluation-resources]]
===== {regression-cap} evaluation objects
=== {regression-cap} evaluation objects

{regression-cap} evaluation evaluates the results of a {regression} analysis
which outputs a prediction of values.
Expand Down Expand Up @@ -144,7 +144,7 @@ which outputs a prediction of values.


[[classification-evaluation-resources]]
==== {classification-cap} evaluation objects
== {classification-cap} evaluation objects

{classification-cap} evaluation evaluates the results of a {classanalysis} which
outputs a prediction that identifies to which of the classes each document
Expand Down Expand Up @@ -177,7 +177,7 @@ belongs.

////
[[ml-evaluate-dfanalytics-results]]
==== {api-response-body-title}
== {api-response-body-title}
`binary_soft_classification`::
(object) If you chose to do binary soft classification, the API returns the
Expand All @@ -194,11 +194,11 @@ belongs.


[[ml-evaluate-dfanalytics-example]]
==== {api-examples-title}
== {api-examples-title}


[[ml-evaluate-binary-soft-class-example]]
===== Binary soft classification
=== Binary soft classification

[source,console]
--------------------------------------------------
Expand Down Expand Up @@ -260,7 +260,7 @@ The API returns the following results:


[[ml-evaluate-regression-example]]
===== {regression-cap}
=== {regression-cap}

[source,console]
--------------------------------------------------
Expand Down Expand Up @@ -374,7 +374,7 @@ calculated by the {reganalysis}.


[[ml-evaluate-classification-example]]
===== {classification-cap}
=== {classification-cap}


[source,console]
Expand Down
16 changes: 8 additions & 8 deletions docs/reference/ml/df-analytics/apis/explain-dfanalytics.asciidoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[role="xpack"]
[testenv="platinum"]
[[explain-dfanalytics]]
=== Explain {dfanalytics} API
= Explain {dfanalytics} API

[subs="attributes"]
++++
Expand All @@ -14,7 +14,7 @@ experimental[]


[[ml-explain-dfanalytics-request]]
==== {api-request-title}
== {api-request-title}

`GET _ml/data_frame/analytics/_explain` +

Expand All @@ -26,7 +26,7 @@ experimental[]


[[ml-explain-dfanalytics-prereq]]
==== {api-prereq-title}
== {api-prereq-title}

If the {es} {security-features} are enabled, you must have the following privileges:

Expand All @@ -36,7 +36,7 @@ For more information, see <<security-privileges>> and <<built-in-roles>>.


[[ml-explain-dfanalytics-desc]]
==== {api-description-title}
== {api-description-title}

This API provides explanations for a {dataframe-analytics-config} that either
exists already or one that has not been created yet.
Expand All @@ -51,21 +51,21 @@ they are not included in the explanation.


[[ml-explain-dfanalytics-path-params]]
==== {api-path-parms-title}
== {api-path-parms-title}

`<data_frame_analytics_id>`::
(Optional, string)
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-data-frame-analytics]

[[ml-explain-dfanalytics-request-body]]
==== {api-request-body-title}
== {api-request-body-title}

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.

[role="child_attributes"]
[[ml-explain-dfanalytics-results]]
==== {api-response-body-title}
== {api-response-body-title}

The API returns a response that contains the following:

Expand Down Expand Up @@ -118,7 +118,7 @@ memory needed to perform {dfanalytics}.


[[ml-explain-dfanalytics-example]]
==== {api-examples-title}
== {api-examples-title}

[source,console]
--------------------------------------------------
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[role="xpack"]
[testenv="platinum"]
[[get-dfanalytics-stats]]
=== Get {dfanalytics-jobs} statistics API
= Get {dfanalytics-jobs} statistics API
[subs="attributes"]
++++
<titleabbrev>Get {dfanalytics-jobs} stats</titleabbrev>
Expand All @@ -12,7 +12,7 @@ Retrieves usage information for {dfanalytics-jobs}.
experimental[]

[[ml-get-dfanalytics-stats-request]]
==== {api-request-title}
== {api-request-title}

`GET _ml/data_frame/analytics/<data_frame_analytics_id>/_stats` +

Expand All @@ -26,7 +26,7 @@ experimental[]


[[ml-get-dfanalytics-stats-prereq]]
==== {api-prereq-title}
== {api-prereq-title}

If the {es} {security-features} are enabled, you must have the following privileges:

Expand All @@ -35,15 +35,15 @@ If the {es} {security-features} are enabled, you must have the following privile
For more information, see <<security-privileges>> and <<built-in-roles>>.

[[ml-get-dfanalytics-stats-path-params]]
==== {api-path-parms-title}
== {api-path-parms-title}

`<data_frame_analytics_id>`::
(Optional, string)
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-data-frame-analytics-default]


[[ml-get-dfanalytics-stats-query-params]]
==== {api-query-parms-title}
== {api-query-parms-title}

`allow_no_match`::
(Optional, boolean)
Expand All @@ -63,7 +63,7 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=verbose]

[role="child_attributes"]
[[ml-get-dfanalytics-stats-response-body]]
==== {api-response-body-title}
== {api-response-body-title}

`data_frame_analytics`::
(array)
Expand Down Expand Up @@ -521,15 +521,15 @@ values: `analyzing`, `failed`, `reindexing`, `started`, `starting`, `stopped`,
//End of data_frame_analytics

[[ml-get-dfanalytics-stats-response-codes]]
==== {api-response-codes-title}
== {api-response-codes-title}

`404` (Missing resources)::
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.


[[ml-get-dfanalytics-stats-example]]
==== {api-examples-title}
== {api-examples-title}

The following API retrieves usage information for the
{ml-docs}/ecommerce-outliers.html[{oldetection} {dfanalytics-job} example]:
Expand Down
Loading

0 comments on commit 8f8d24b

Please sign in to comment.