Skip to content

Commit

Permalink
[DOCS] Extends the analyzed_fields description in the PUT DFA API docs (
Browse files Browse the repository at this point in the history
  • Loading branch information
szabosteve committed Oct 9, 2019
1 parent 02622c1 commit 6f4b7e9
Showing 1 changed file with 8 additions and 5 deletions.
13 changes: 8 additions & 5 deletions docs/reference/ml/df-analytics/apis/put-dfanalytics.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -61,19 +61,22 @@ and mappings.
==== {api-request-body-title}

`analysis`::
(Required, object) Defines the type of {dfanalytics} you want to perform on your source
index. For example: `outlier_detection`. See <<dfanalytics-types>>.
(Required, object) Defines the type of {dfanalytics} you want to perform on
your source index. For example: `outlier_detection`. See
<<dfanalytics-types>>.

`analyzed_fields`::
(Optional, object) You can specify both `includes` and/or `excludes` patterns.
If `analyzed_fields` is not set, only the relevant fields will be included.
For example, all the numeric fields for {oldetection}.
For example, all the numeric fields for {oldetection}. For the potential field
type limitations, see
{stack-ov}/ml-dfa-limitations.html[{dfanalytics} limitations].

`analyzed_fields.includes`:::
`includes`:::
(Optional, array) An array of strings that defines the fields that will be
included in the analysis.

`analyzed_fields.excludes`:::
`excludes`:::
(Optional, array) An array of strings that defines the fields that will be
excluded from the analysis.

Expand Down

0 comments on commit 6f4b7e9

Please sign in to comment.