Class RareTermsAggregationDescriptor<T>

A multi-bucket value source based aggregation which finds "rare" terms — terms that are at the long-tail of the distribution and are not frequent. Conceptually, this is like a terms aggregation that is sorted by _count ascending.

Inheritance
object
BucketAggregationDescriptorBase<RareTermsAggregationDescriptor<T>, IRareTermsAggregation, T>
RareTermsAggregationDescriptor<T>
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class RareTermsAggregationDescriptor<T> : BucketAggregationDescriptorBase<RareTermsAggregationDescriptor<T>, IRareTermsAggregation, T>, IDescriptor, IRareTermsAggregation, IBucketAggregation, IAggregation where T : class
Type Parameters
Name Description
T

Methods

| Edit this page View Source

Exclude(IEnumerable<string>)

Terms that should be excluded from the aggregation

Declaration
public RareTermsAggregationDescriptor<T> Exclude(IEnumerable<string> values)
Parameters
Type Name Description
IEnumerable<string> values
Returns
Type Description
RareTermsAggregationDescriptor<T>
| Edit this page View Source

Exclude(string)

Terms that should be excluded from the aggregation

Declaration
public RareTermsAggregationDescriptor<T> Exclude(string excludePattern)
Parameters
Type Name Description
string excludePattern
Returns
Type Description
RareTermsAggregationDescriptor<T>
| Edit this page View Source

Field(Field)

The field to find rare terms in

Declaration
public RareTermsAggregationDescriptor<T> Field(Field field)
Parameters
Type Name Description
Field field
Returns
Type Description
RareTermsAggregationDescriptor<T>
| Edit this page View Source

Field<TValue>(Expression<Func<T, TValue>>)

The field to find rare terms in

Declaration
public RareTermsAggregationDescriptor<T> Field<TValue>(Expression<Func<T, TValue>> field)
Parameters
Type Name Description
Expression<Func<T, TValue>> field
Returns
Type Description
RareTermsAggregationDescriptor<T>
Type Parameters
Name Description
TValue
| Edit this page View Source

Include(IEnumerable<string>)

Terms that should be included in the aggregation

Declaration
public RareTermsAggregationDescriptor<T> Include(IEnumerable<string> values)
Parameters
Type Name Description
IEnumerable<string> values
Returns
Type Description
RareTermsAggregationDescriptor<T>
| Edit this page View Source

Include(long, long)

Terms that should be included in the aggregation

Declaration
public RareTermsAggregationDescriptor<T> Include(long partition, long numberOfPartitions)
Parameters
Type Name Description
long partition
long numberOfPartitions
Returns
Type Description
RareTermsAggregationDescriptor<T>
| Edit this page View Source

Include(string)

Terms that should be included in the aggregation

Declaration
public RareTermsAggregationDescriptor<T> Include(string includePattern)
Parameters
Type Name Description
string includePattern
Returns
Type Description
RareTermsAggregationDescriptor<T>
| Edit this page View Source

MaximumDocumentCount(long?)

The maximum number of documents a term should appear in. Defaults to 1

Declaration
public RareTermsAggregationDescriptor<T> MaximumDocumentCount(long? maximumDocumentCount)
Parameters
Type Name Description
long? maximumDocumentCount
Returns
Type Description
RareTermsAggregationDescriptor<T>
| Edit this page View Source

Missing(object)

The value that should be used if a document does not have the field being aggregated

Declaration
public RareTermsAggregationDescriptor<T> Missing(object missing)
Parameters
Type Name Description
object missing
Returns
Type Description
RareTermsAggregationDescriptor<T>
| Edit this page View Source

Precision(double?)

The precision of the internal CuckooFilters. Smaller precision leads to better approximation, but higher memory usage. Cannot be smaller than 0.00001. Defaults to 0.01

Declaration
public RareTermsAggregationDescriptor<T> Precision(double? precision)
Parameters
Type Name Description
double? precision
Returns
Type Description
RareTermsAggregationDescriptor<T>

Implements

Extension Methods