Search Results for

    Show / Hide Table of Contents

    Class RareTermsAggregation

    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
    AggregationBase
    BucketAggregationBase
    RareTermsAggregation
    Implements
    IRareTermsAggregation
    IBucketAggregation
    IAggregation
    Inherited Members
    BucketAggregationBase.Aggregations
    AggregationBase.Meta
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: OpenSearch.Client
    Assembly: OpenSearch.Client.dll
    Syntax
    public class RareTermsAggregation : BucketAggregationBase, IRareTermsAggregation, IBucketAggregation, IAggregation

    Constructors

    | Edit this page View Source

    RareTermsAggregation(string)

    Declaration
    public RareTermsAggregation(string name)
    Parameters
    Type Name Description
    string name

    Properties

    | Edit this page View Source

    Exclude

    Terms that should be excluded from the aggregation

    Declaration
    public TermsExclude Exclude { get; set; }
    Property Value
    Type Description
    TermsExclude
    | Edit this page View Source

    Field

    The field to find rare terms in

    Declaration
    public Field Field { get; set; }
    Property Value
    Type Description
    Field
    | Edit this page View Source

    Include

    Terms that should be included in the aggregation

    Declaration
    public TermsInclude Include { get; set; }
    Property Value
    Type Description
    TermsInclude
    | Edit this page View Source

    MaximumDocumentCount

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

    Declaration
    public long? MaximumDocumentCount { get; set; }
    Property Value
    Type Description
    long?
    | Edit this page View Source

    Missing

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

    Declaration
    public object Missing { get; set; }
    Property Value
    Type Description
    object
    | Edit this page View Source

    Precision

    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 double? Precision { get; set; }
    Property Value
    Type Description
    double?

    Implements

    IRareTermsAggregation
    IBucketAggregation
    IAggregation

    Extension Methods

    SuffixExtensions.Suffix(object, string)
    • Edit this page
    • View Source
    In this article
    • Constructors
      • RareTermsAggregation(string)
    • Properties
      • Exclude
      • Field
      • Include
      • MaximumDocumentCount
      • Missing
      • Precision
    • Implements
    • Extension Methods
    Back to top Generated by DocFX