mirror of
https://github.com/honeymoose/OpenSearch.git
synced 2025-02-07 13:38:49 +00:00
6ba144ae31
Adds a new single-value metrics aggregation that computes the weighted average of numeric values that are extracted from the aggregated documents. These values can be extracted from specific numeric fields in the documents. When calculating a regular average, each datapoint has an equal "weight"; it contributes equally to the final value. In contrast, weighted averages scale each datapoint differently. The amount that each datapoint contributes to the final value is extracted from the document, or provided by a script. As a formula, a weighted average is the `∑(value * weight) / ∑(weight)` A regular average can be thought of as a weighted average where every value has an implicit weight of `1`. Closes #15731
53 lines
1.7 KiB
Plaintext
53 lines
1.7 KiB
Plaintext
[[search-aggregations-metrics]]
|
|
== Metrics Aggregations
|
|
|
|
The aggregations in this family compute metrics based on values extracted in one way or another from the documents that
|
|
are being aggregated. The values are typically extracted from the fields of the document (using the field data), but
|
|
can also be generated using scripts.
|
|
|
|
Numeric metrics aggregations are a special type of metrics aggregation which output numeric values. Some aggregations output
|
|
a single numeric metric (e.g. `avg`) and are called `single-value numeric metrics aggregation`, others generate multiple
|
|
metrics (e.g. `stats`) and are called `multi-value numeric metrics aggregation`. The distinction between single-value and
|
|
multi-value numeric metrics aggregations plays a role when these aggregations serve as direct sub-aggregations of some
|
|
bucket aggregations (some bucket aggregations enable you to sort the returned buckets based on the numeric metrics in each bucket).
|
|
|
|
include::metrics/avg-aggregation.asciidoc[]
|
|
|
|
include::metrics/weighted-avg-aggregation.asciidoc[]
|
|
|
|
include::metrics/cardinality-aggregation.asciidoc[]
|
|
|
|
include::metrics/extendedstats-aggregation.asciidoc[]
|
|
|
|
include::metrics/geobounds-aggregation.asciidoc[]
|
|
|
|
include::metrics/geocentroid-aggregation.asciidoc[]
|
|
|
|
include::metrics/max-aggregation.asciidoc[]
|
|
|
|
include::metrics/min-aggregation.asciidoc[]
|
|
|
|
include::metrics/percentile-aggregation.asciidoc[]
|
|
|
|
include::metrics/percentile-rank-aggregation.asciidoc[]
|
|
|
|
include::metrics/scripted-metric-aggregation.asciidoc[]
|
|
|
|
include::metrics/stats-aggregation.asciidoc[]
|
|
|
|
include::metrics/sum-aggregation.asciidoc[]
|
|
|
|
include::metrics/tophits-aggregation.asciidoc[]
|
|
|
|
include::metrics/valuecount-aggregation.asciidoc[]
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|