Files
elasticsearch-js/docs/reference/api/AggregationsSignificantTermsAggregation.md
2025-05-28 10:02:30 -05:00

2.7 KiB

AggregationsSignificantTermsAggregation [interface-AggregationsSignificantTermsAggregation]

Name Type Description
background_filter QueryDslQueryContainer A background filter that can be used to focus in on significant terms within a narrower context, instead of the entire index.
chi_square AggregationsChiSquareHeuristic Use Chi square, as described in "Information Retrieval", Manning et al., Chapter 13.5.2, as the significance score.
exclude AggregationsTermsExclude Terms to exclude.
execution_hint AggregationsTermsAggregationExecutionHint Mechanism by which the aggregation should be executed: using field values directly or using global ordinals.
field Field The field from which to return significant terms.
gnd AggregationsGoogleNormalizedDistanceHeuristic Use Google normalized distance as described in "The Google Similarity Distance", Cilibrasi and Vitanyi, 2007, as the significance score.
include AggregationsTermsInclude Terms to include.
jlh EmptyObject Use JLH score as the significance score.
min_doc_count long Only return terms that are found in more than min_doc_count hits.
mutual_information AggregationsMutualInformationHeuristic Use mutual information as described in "Information Retrieval", Manning et al., Chapter 13.5.1, as the significance score.
percentage AggregationsPercentageScoreHeuristic A simple calculation of the number of documents in the foreground sample with a term divided by the number of documents in the background with the term.
script_heuristic AggregationsScriptedHeuristic Customized score, implemented via a script.
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 Can be used to control the volumes 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.
size integer The number of buckets returned out of the overall terms list.