honeymoose/OpenSearch
1
0
Fork 0
mirror of https://github.com/honeymoose/OpenSearch.git synced 2025-02-08 22:14:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

[DOCS] Clarifies bucket span in overall buckets API (#45110)

Browse Source
This commit is contained in:
Lisa Cawley 2019-08-02 08:36:39 -07:00 committed by lcawl
parent 47386d4f0a
commit 09bd6c4692
1 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
docs/reference/ml/anomaly-detection/apis/get-overall-buckets.asciidoc
View File

@ -34,8 +34,10 @@ privileges. See {stack-ov}/security-privileges.html[Security privileges] and
You can summarize the bucket results for all {anomaly-jobs} by using `_all` or You can summarize the bucket results for all {anomaly-jobs} by using `_all` or
by specifying `*` as the `<job_id>`. by specifying `*` as the `<job_id>`.
An overall bucket has a span equal to the largest `bucket_span` value for the By default, an overall bucket has a span equal to the largest bucket span of the
specified {anomaly-jobs}. specified {anomaly-jobs}. To override that behavior, use the optional
`bucket_span` parameter. To learn more about the concept of buckets, see
{stack-ov}/ml-buckets.html[Buckets].
The `overall_score` is calculated by combining the scores of all the buckets The `overall_score` is calculated by combining the scores of all the buckets
within the overall bucket span. First, the maximum `anomaly_score` per within the overall bucket span. First, the maximum `anomaly_score` per
@ -43,14 +45,12 @@ within the overall bucket span. First, the maximum `anomaly_score` per
scores are averaged to result in the `overall_score`. This means that you can scores are averaged to result in the `overall_score`. This means that you can
fine-tune the `overall_score` so that it is more or less sensitive to the number fine-tune the `overall_score` so that it is more or less sensitive to the number
of jobs that detect an anomaly at the same time. For example, if you set `top_n` of jobs that detect an anomaly at the same time. For example, if you set `top_n`
to `1`, the `overall_score` is the maximum bucket score in the overall bucket. Alternatively, if you set `top_n` to the number of jobs, the `overall_score` is to `1`, the `overall_score` is the maximum bucket score in the overall bucket.
high only when all jobs detect anomalies in that overall bucket. Alternatively, if you set `top_n` to the number of jobs, the `overall_score` is
high only when all jobs detect anomalies in that overall bucket. If you set
In addition, the optional parameter `bucket_span` may be used in order the `bucket_span` parameter (to a value greater than its default), the
to request overall buckets that span longer than the `bucket_span` of the `overall_score` is the maximum `overall_score` of the overall buckets that have
largest {anomaly-job}. When set, the `overall_score` will be the max a span equal to the jobs' largest bucket span.
`overall_score` of the corresponding overall buckets with a span equal to the
`bucket_span` of the largest {anomaly-job}.
[[ml-get-overall-buckets-path-parms]] [[ml-get-overall-buckets-path-parms]]
==== {api-path-parms-title} ==== {api-path-parms-title}
@ -69,8 +69,8 @@ largest {anomaly-job}. When set, the `overall_score` will be the max
`bucket_span`:: `bucket_span`::
(Optional, string) The span of the overall buckets. Must be greater or equal (Optional, string) The span of the overall buckets. Must be greater or equal
to the `bucket_span` of the largest {anomaly-job}. Defaults to the to the largest bucket span of the specified {anomaly-jobs}, which is the
`bucket_span` of the largest {anomaly-job}. default value.
`end`:: `end`::
(Optional, string) Returns overall buckets with timestamps earlier than this (Optional, string) Returns overall buckets with timestamps earlier than this