[DOCS] [PUT DFA] Documents inline the child params of source and dest (#45649)
* [DOCS] [PUT DFA] Documents inline the child params of source and dest. * [DOCS] Fixes indentation issues and amends dfa definitions.
This commit is contained in:
parent
d9be906afb
commit
a75348d1fb
|
@ -19,6 +19,15 @@
|
||||||
`analyzed_fields` is not set, only the relevant fields will be included. For
|
`analyzed_fields` is not set, only the relevant fields will be included. For
|
||||||
example all the numeric fields for {oldetection}.
|
example all the numeric fields for {oldetection}.
|
||||||
|
|
||||||
|
`analyzed_fields.includes`:::
|
||||||
|
(array) An array of strings that defines the fields that will be included in
|
||||||
|
the analysis.
|
||||||
|
|
||||||
|
`analyzed_fields.excludes`:::
|
||||||
|
(array) An array of strings that defines the fields that will be excluded
|
||||||
|
from the analysis.
|
||||||
|
|
||||||
|
|
||||||
[source,js]
|
[source,js]
|
||||||
--------------------------------------------------
|
--------------------------------------------------
|
||||||
PUT _ml/data_frame/analytics/loganalytics
|
PUT _ml/data_frame/analytics/loganalytics
|
||||||
|
@ -46,11 +55,15 @@ PUT _ml/data_frame/analytics/loganalytics
|
||||||
(Optional, string) A description of the job.
|
(Optional, string) A description of the job.
|
||||||
|
|
||||||
`dest`::
|
`dest`::
|
||||||
(object) The destination configuration of the analysis. The `index` property
|
(object) The destination configuration of the analysis.
|
||||||
(string) is the name of the index in which to store the results of the
|
|
||||||
{dfanalytics-job}. The `results_field` (string) property defines the name of
|
`index`:::
|
||||||
the field in which to store the results of the analysis. The default value is
|
(Required, string) Defines the _destination index_ to store the results of
|
||||||
`ml`.
|
the {dfanalytics-job}.
|
||||||
|
|
||||||
|
`results_field`:::
|
||||||
|
(Optional, string) Defines the name of the field in which to store the
|
||||||
|
results of the analysis. Default to `ml`.
|
||||||
|
|
||||||
`id`::
|
`id`::
|
||||||
(string) The unique identifier for the {dfanalytics-job}. This identifier can
|
(string) The unique identifier for the {dfanalytics-job}. This identifier can
|
||||||
|
@ -67,14 +80,20 @@ PUT _ml/data_frame/analytics/loganalytics
|
||||||
that setting. For more information, see <<ml-settings>>.
|
that setting. For more information, see <<ml-settings>>.
|
||||||
|
|
||||||
`source`::
|
`source`::
|
||||||
(object) The source configuration, consisting of `index` (array) which is an
|
(object) The source configuration consisting an `index` and optionally a
|
||||||
array of index names on which to perform the analysis. It can be a single
|
`query` object.
|
||||||
index or index pattern as well as an array of indices or patterns. Optionally,
|
|
||||||
`source` can have a `query` (object) property. The {es} query domain-specific
|
`index`:::
|
||||||
language (DSL). This value corresponds to the query object in an {es} search
|
(Required, string or array) Index or indices on which to perform the
|
||||||
POST body. All the options that are supported by {es} can be used, as this
|
analysis. It can be a single index or index pattern as well as an array of
|
||||||
object is passed verbatim to {es}. By default, this property has the following
|
indices or patterns.
|
||||||
value: `{"match_all": {}}`.
|
|
||||||
|
`query`:::
|
||||||
|
(Optional, object) The {es} query domain-specific language
|
||||||
|
(<<query-dsl,DSL>>). This value corresponds to the query object in an {es}
|
||||||
|
search POST body. All the options that are supported by {es} can be used,
|
||||||
|
as this object is passed verbatim to {es}. By default, this property has
|
||||||
|
the following value: `{"match_all": {}}`.
|
||||||
|
|
||||||
[[dfanalytics-types]]
|
[[dfanalytics-types]]
|
||||||
==== Analysis objects
|
==== Analysis objects
|
||||||
|
|
|
@ -16,6 +16,7 @@ experimental[]
|
||||||
|
|
||||||
`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}
|
||||||
|
|
||||||
|
@ -25,6 +26,7 @@ also have `read` and `view_index_metadata` privileges on the source index and
|
||||||
more information, see {stack-ov}/security-privileges.html[Security privileges]
|
more information, see {stack-ov}/security-privileges.html[Security privileges]
|
||||||
and {stack-ov}/built-in-roles.html[Built-in roles].
|
and {stack-ov}/built-in-roles.html[Built-in roles].
|
||||||
|
|
||||||
|
|
||||||
[[ml-put-dfanalytics-desc]]
|
[[ml-put-dfanalytics-desc]]
|
||||||
==== {api-description-title}
|
==== {api-description-title}
|
||||||
|
|
||||||
|
@ -45,6 +47,7 @@ If the destination index already exists, then it will be use as is. This makes
|
||||||
it possible to set up the destination index in advance with custom settings
|
it possible to set up the destination index in advance with custom settings
|
||||||
and mappings.
|
and mappings.
|
||||||
|
|
||||||
|
|
||||||
[[ml-put-dfanalytics-path-params]]
|
[[ml-put-dfanalytics-path-params]]
|
||||||
==== {api-path-parms-title}
|
==== {api-path-parms-title}
|
||||||
|
|
||||||
|
@ -54,6 +57,7 @@ and mappings.
|
||||||
characters (a-z and 0-9), hyphens, and underscores. It must start and end with
|
characters (a-z and 0-9), hyphens, and underscores. It must start and end with
|
||||||
alphanumeric characters.
|
alphanumeric characters.
|
||||||
|
|
||||||
|
|
||||||
[[ml-put-dfanalytics-request-body]]
|
[[ml-put-dfanalytics-request-body]]
|
||||||
==== {api-request-body-title}
|
==== {api-request-body-title}
|
||||||
|
|
||||||
|
@ -62,17 +66,32 @@ and mappings.
|
||||||
index. For example: `outlier_detection`. See <<dfanalytics-types>>.
|
index. For example: `outlier_detection`. See <<dfanalytics-types>>.
|
||||||
|
|
||||||
`analyzed_fields`::
|
`analyzed_fields`::
|
||||||
(Optional, object) You can specify both `includes` and/or `excludes` patterns. If
|
(Optional, object) You can specify both `includes` and/or `excludes` patterns.
|
||||||
`analyzed_fields` is not set, only the relevant fields will be included. For
|
If `analyzed_fields` is not set, only the relevant fields will be included.
|
||||||
example, all the numeric fields for {oldetection}.
|
For example, all the numeric fields for {oldetection}.
|
||||||
|
|
||||||
|
`analyzed_fields.includes`:::
|
||||||
|
(Optional, array) An array of strings that defines the fields that will be
|
||||||
|
included in the analysis.
|
||||||
|
|
||||||
|
`analyzed_fields.excludes`:::
|
||||||
|
(Optional, array) An array of strings that defines the fields that will be
|
||||||
|
excluded from the analysis.
|
||||||
|
|
||||||
`description`::
|
`description`::
|
||||||
(Optional, string) A description of the job.
|
(Optional, string) A description of the job.
|
||||||
|
|
||||||
`dest`::
|
`dest`::
|
||||||
(Required, object) The destination configuration, consisting of `index` and
|
(Required, object) The destination configuration, consisting of `index` and
|
||||||
optionally `results_field` (`ml` by default). See
|
optionally `results_field` (`ml` by default).
|
||||||
<<ml-dfanalytics-properties,{dfanalytics} properties>>.
|
|
||||||
|
`index`:::
|
||||||
|
(Required, string) Defines the _destination index_ to store the results of
|
||||||
|
the {dfanalytics-job}.
|
||||||
|
|
||||||
|
`results_field`:::
|
||||||
|
(Optional, string) Defines the name of the field in which to store the
|
||||||
|
results of the analysis. Default to `ml`.
|
||||||
|
|
||||||
`model_memory_limit`::
|
`model_memory_limit`::
|
||||||
(Optional, string) The approximate maximum amount of memory resources that are
|
(Optional, string) The approximate maximum amount of memory resources that are
|
||||||
|
@ -84,8 +103,20 @@ and mappings.
|
||||||
|
|
||||||
`source`::
|
`source`::
|
||||||
(Required, object) The source configuration, consisting of `index` and
|
(Required, object) The source configuration, consisting of `index` and
|
||||||
optionally a `query`. See
|
optionally a `query`.
|
||||||
<<ml-dfanalytics-properties,{dfanalytics} properties>>.
|
|
||||||
|
`index`:::
|
||||||
|
(Required, string or array) Index or indices on which to perform the
|
||||||
|
analysis. It can be a single index or index pattern as well as an array of
|
||||||
|
indices or patterns.
|
||||||
|
|
||||||
|
`query`:::
|
||||||
|
(Optional, object) The {es} query domain-specific language
|
||||||
|
(<<query-dsl,DSL>>). This value corresponds to the query object in an {es}
|
||||||
|
search POST body. All the options that are supported by {es} can be used,
|
||||||
|
as this object is passed verbatim to {es}. By default, this property has
|
||||||
|
the following value: `{"match_all": {}}`.
|
||||||
|
|
||||||
|
|
||||||
[[ml-put-dfanalytics-example]]
|
[[ml-put-dfanalytics-example]]
|
||||||
==== {api-examples-title}
|
==== {api-examples-title}
|
||||||
|
@ -113,6 +144,7 @@ PUT _ml/data_frame/analytics/loganalytics
|
||||||
// CONSOLE
|
// CONSOLE
|
||||||
// TEST[setup:setup_logdata]
|
// TEST[setup:setup_logdata]
|
||||||
|
|
||||||
|
|
||||||
The API returns the following result:
|
The API returns the following result:
|
||||||
|
|
||||||
[source,js]
|
[source,js]
|
||||||
|
|
Loading…
Reference in New Issue