From 6f4b7e9a7fa38917d410ceb2dfbcdaaee7acd2a0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Istv=C3=A1n=20Zolt=C3=A1n=20Szab=C3=B3?= Date: Wed, 9 Oct 2019 18:13:33 +0200 Subject: [PATCH] [DOCS] Extends the analyzed_fields description in the PUT DFA API docs (#47791) --- .../ml/df-analytics/apis/put-dfanalytics.asciidoc | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/docs/reference/ml/df-analytics/apis/put-dfanalytics.asciidoc b/docs/reference/ml/df-analytics/apis/put-dfanalytics.asciidoc index 2dbf178d4a333..d423e4be85f19 100644 --- a/docs/reference/ml/df-analytics/apis/put-dfanalytics.asciidoc +++ b/docs/reference/ml/df-analytics/apis/put-dfanalytics.asciidoc @@ -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 <>. + (Required, object) Defines the type of {dfanalytics} you want to perform on + your source index. For example: `outlier_detection`. See + <>. `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.