Search Results for

    Show / Hide Table of Contents

    Interface IRareTermsAggregation

    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.

    Inherited Members
    IBucketAggregation.Aggregations
    IAggregation.Meta
    IAggregation.Name
    Namespace: OpenSearch.Client
    Assembly: OpenSearch.Client.dll
    Syntax
    public interface IRareTermsAggregation : IBucketAggregation, IAggregation

    Properties

    | Edit this page View Source

    Exclude

    Terms that should be excluded from the aggregation

    Declaration
    [DataMember(Name = "exclude")]
    TermsExclude Exclude { get; set; }
    Property Value
    Type Description
    TermsExclude
    | Edit this page View Source

    Field

    The field to find rare terms in

    Declaration
    [DataMember(Name = "field")]
    Field Field { get; set; }
    Property Value
    Type Description
    Field
    | Edit this page View Source

    Include

    Terms that should be included in the aggregation

    Declaration
    [DataMember(Name = "include")]
    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
    [DataMember(Name = "max_doc_count")]
    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
    [DataMember(Name = "missing")]
    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
    [DataMember(Name = "precision")]
    double? Precision { get; set; }
    Property Value
    Type Description
    double?

    Extension Methods

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