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

[DOCS] Clarify null behaviour in ML resources (elastic/x-pack-elasticsearch#2090) 

* [DOCS] Clarify null behaviour in ML resources

* [DOCS] Add category error information

Original commit: elastic/x-pack-elasticsearch@21cdb4fb36
This commit is contained in:
Lisa Cawley 2017-07-27 08:02:46 -07:00 committed by GitHub
parent b95d3f7bf4
commit 449064337d
2 changed files with 11 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/en/ml/categories.asciidoc
View File

@ -44,8 +44,9 @@ PUT _xpack/ml/anomaly_detectors/it_ops_new_logs
//CONSOLE
<1> The `categorization_field_name` property indicates which field will be
categorized.
<2> The resulting categories can be used in a detector by setting `by_field_name`,
`over_field_name`, or `partition_field_name` to the keyword `mlcategory`.
<2> The resulting categories are used in a detector by setting `by_field_name`,
`over_field_name`, or `partition_field_name` to the keyword `mlcategory`. If you
do not specify this keyword in one of those properties, the API request fails.
The optional `categorization_examples_limit` property specifies the
maximum number of examples that are stored in memory and in the results data

16
docs/en/rest-api/ml/jobresource.asciidoc
View File

@ -82,10 +82,10 @@ An analysis configuration object has the following properties:
typically between `5m` and `1h`. The default value is `5m`.
`categorization_field_name`::
(string) If not null, the values of the specified field will be categorized.
The resulting categories can be used in a detector by setting `by_field_name`,
`over_field_name`, or `partition_field_name` to the keyword `mlcategory`.
For more information, see
(string) If this property is specified, the values of the specified field will
be categorized. The resulting categories must be used in a detector by setting
`by_field_name`, `over_field_name`, or `partition_field_name` to the keyword
`mlcategory`. For more information, see
{xpack-ref}/ml-configuring-categories.html[Categorizing Log Messages].
//<<ml-configuring-categories>>.
@ -138,10 +138,10 @@ NOTE: To use the `multivariate_by_fields` property, you must also specify
`by_field_name` in your detector.
`summary_count_field_name`::
(string) If not null, the data that is fed to the job is expected to be
pre-summarized. This property value is the name of the field that contains
the count of raw data points that have been summarized.
The same `summary_count_field_name` applies to all detectors in the job. +
(string) If this property is specified, the data that is fed to the job is
expected to be pre-summarized. This property value is the name of the field
that contains the count of raw data points that have been summarized. The same
`summary_count_field_name` applies to all detectors in the job. +
NOTE: The `summary_count_field_name` property cannot be used with the `metric`
function.