A newer version is available. For the latest information, see the
current release documentation.
Significant Terms Aggregation Usageedit
An aggregation that returns interesting or unusual occurrences of terms in a set.
The significant_terms aggregation can be very heavy when run on large indices. Work is in progress to provide more lightweight sampling techniques. As a result, the API for this feature may change in non-backwards compatible ways
See the Elasticsearch documentation on significant terms aggregation for more detail.
Fluent DSL exampleedit
a => a .SignificantTerms("significant_names", st => st .Field(p => p.Name) .MinimumDocumentCount(10) .MutualInformation(mi => mi .BackgroundIsSuperSet() .IncludeNegatives() ) )
Object Initializer syntax exampleedit
new SignificantTermsAggregation("significant_names") { Field = Field<Project>(p => p.Name), MinimumDocumentCount = 10, MutualInformation = new MutualInformationHeuristic { BackgroundIsSuperSet = true, IncludeNegatives = true } }
Example json output.
{ "significant_names": { "significant_terms": { "field": "name", "min_doc_count": 10, "mutual_information": { "background_is_superset": true, "include_negatives": true } } } }
Handling Responsesedit
response.ShouldBeValid(); var sigNames = response.Aggregations.SignificantTerms("significant_names"); sigNames.Should().NotBeNull(); sigNames.DocCount.Should().BeGreaterThan(0);
Filtering with a regular expression patternedit
Using significant terms aggregation with filtering to include values using a regular expression pattern
Fluent DSL exampleedit
a => a .SignificantTerms("significant_names", st => st .Field(p => p.Name) .MinimumDocumentCount(10) .MutualInformation(mi => mi .BackgroundIsSuperSet() .IncludeNegatives() ) .Include("pi*") )
Object Initializer syntax exampleedit
new SignificantTermsAggregation("significant_names") { Field = Field<Project>(p => p.Name), MinimumDocumentCount = 10, MutualInformation = new MutualInformationHeuristic { BackgroundIsSuperSet = true, IncludeNegatives = true }, Include = new IncludeExclude("pi*") }
Example json output.
{ "significant_names": { "significant_terms": { "field": "name", "min_doc_count": 10, "mutual_information": { "background_is_superset": true, "include_negatives": true }, "include": "pi*" } } }
Handling Responsesedit
response.ShouldBeValid(); var sigNames = response.Aggregations.SignificantTerms("significant_names"); sigNames.Should().NotBeNull(); sigNames.DocCount.Should().BeGreaterThan(0);
Filtering with exact valuesedit
Using significant terms aggregation with filtering to exclude specific values
Fluent DSL exampleedit
a => a .SignificantTerms("significant_names", st => st .Field(p => p.Name) .MinimumDocumentCount(10) .MutualInformation(mi => mi .BackgroundIsSuperSet() .IncludeNegatives() ) .Exclude(new[] { "pierce" }) )
Object Initializer syntax exampleedit
new SignificantTermsAggregation("significant_names") { Field = Field<Project>(p => p.Name), MinimumDocumentCount = 10, MutualInformation = new MutualInformationHeuristic { BackgroundIsSuperSet = true, IncludeNegatives = true }, Exclude = new IncludeExclude(new[] { "pierce" }) }
Example json output.
{ "significant_names": { "significant_terms": { "field": "name", "min_doc_count": 10, "mutual_information": { "background_is_superset": true, "include_negatives": true }, "exclude": [ "pierce" ] } } }
Handling Responsesedit
response.ShouldBeValid(); var sigNames = response.Aggregations.SignificantTerms("significant_names"); sigNames.Should().NotBeNull(); sigNames.DocCount.Should().BeGreaterThan(0);
Numeric fieldsedit
A significant terms aggregation on a numeric field
Fluent DSL exampleedit
a => a .SignificantTerms("commits", st => st .Field(p => p.NumberOfContributors) )
Object Initializer syntax exampleedit
new SignificantTermsAggregation("commits") { Field = Field<Project, int>(p => p.NumberOfContributors) }
Example json output.
{ "commits": { "significant_terms": { "field": "numberOfContributors" } } }
Handling Responsesedit
response.ShouldBeValid(); var commits = response.Aggregations.SignificantTerms<int>("commits"); commits.Should().NotBeNull(); commits.Buckets.Should().NotBeNull(); commits.Buckets.Count.Should().BeGreaterThan(0); foreach (var item in commits.Buckets) { item.Key.Should().BeGreaterThan(0); item.DocCount.Should().BeGreaterOrEqualTo(1); }