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

[DOCS] Extends the analyzed_fields description in the PUT DFA API docs (#47791)

This commit is contained in:
István Zoltán Szabó 2019-10-09 18:13:33 +02:00
parent 02622c1ef9
commit 6f4b7e9a7f
1 changed files with 8 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -61,19 +61,22 @@ and mappings.
==== {api-request-body-title} ==== {api-request-body-title}
`analysis`:: `analysis`::
(Required, object) Defines the type of {dfanalytics} you want to perform on your source (Required, object) Defines the type of {dfanalytics} you want to perform on
index. For example: `outlier_detection`. See <<dfanalytics-types>>. your source index. For example: `outlier_detection`. See
<<dfanalytics-types>>.
`analyzed_fields`:: `analyzed_fields`::
(Optional, object) You can specify both `includes` and/or `excludes` patterns. (Optional, object) You can specify both `includes` and/or `excludes` patterns.
If `analyzed_fields` is not set, only the relevant fields will be included. 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 (Optional, array) An array of strings that defines the fields that will be
included in the analysis. included in the analysis.
`analyzed_fields.excludes`::: `excludes`:::
(Optional, array) An array of strings that defines the fields that will be (Optional, array) An array of strings that defines the fields that will be
excluded from the analysis. excluded from the analysis.