Skip to content

Commit ab08c0c

Browse files
authored
[DOCS] Extends the analyzed_fields description in the PUT DFA API docs (#47791)
1 parent d946f9d commit ab08c0c

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

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

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -61,19 +61,22 @@ and mappings.
6161
==== {api-request-body-title}
6262

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

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

72-
`analyzed_fields.includes`:::
75+
`includes`:::
7376
(Optional, array) An array of strings that defines the fields that will be
7477
included in the analysis.
7578

76-
`analyzed_fields.excludes`:::
79+
`excludes`:::
7780
(Optional, array) An array of strings that defines the fields that will be
7881
excluded from the analysis.
7982

0 commit comments

Comments
 (0)