2.4 KiB
2.4 KiB
AggregationsTermsAggregation [interface-AggregationsTermsAggregation]
| Name | Type | Description |
|---|---|---|
collect_mode |
AggregationsTermsAggregationCollectMode | Determines how child aggregations should be calculated: breadth-first or depth-first. |
exclude |
AggregationsTermsExclude | Values to exclude. Accepts regular expressions and partitions. |
execution_hint |
AggregationsTermsAggregationExecutionHint | Determines whether the aggregation will use field values directly or global ordinals. |
field |
Field | The field from which to return terms. |
format |
string | |
include |
AggregationsTermsInclude | Values to include. Accepts regular expressions and partitions. |
min_doc_count |
integer | Only return values that are found in more than min_doc_count hits. |
missing_bucket |
boolean | |
missing_order |
AggregationsMissingOrder | |
missing |
AggregationsMissing | The value to apply to documents that do not have a value. By default, documents without a value are ignored. |
order |
AggregationsAggregateOrder | Specifies the sort order of the buckets. Defaults to sorting by descending document count. |
script |
Script | ScriptSource |
shard_min_doc_count |
long | Regulates the certainty a shard has if the term should actually be added to the candidate list or not with respect to the min_doc_count. Terms will only be considered if their local shard frequency within the set is higher than the shard_min_doc_count. |
shard_size |
integer | The number of candidate terms produced by each shard. By default, shard_size will be automatically estimated based on the number of shards and the size parameter. |
show_term_doc_count_error |
boolean | Set to true to return the doc_count_error_upper_bound, which is an upper bound to the error on the doc_count returned by each shard. |
size |
integer | The number of buckets returned out of the overall terms list. |
value_type |
string | Coerced unmapped fields into the specified type. |