Search Results for

    Show / Hide Table of Contents

    Class SignificantTextAggregation

    An aggregation that returns interesting or unusual occurrences of free-text terms in a set.

    Inheritance
    object
    AggregationBase
    BucketAggregationBase
    SignificantTextAggregation
    Implements
    ISignificantTextAggregation
    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 SignificantTextAggregation : BucketAggregationBase, ISignificantTextAggregation, IBucketAggregation, IAggregation

    Constructors

    | Edit this page View Source

    SignificantTextAggregation(string)

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

    Properties

    | Edit this page View Source

    BackgroundFilter

    The default source of statistical information for background term frequencies is the entire index. This scope can be narrowed through the use of a background filter to focus in on significant terms within a narrower context

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

    ChiSquare

    Use chi square to calculate significance score

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

    Exclude

    Exclude term values for which buckets will be created.

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

    ExecutionHint

    Determines the mechanism by which aggregations are executed

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

    Field

    The field on which to run the aggregation

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

    FilterDuplicateText

    Whether to filter out near-duplicate text

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

    GoogleNormalizedDistance

    Use Google normalized distance to calculate significance score

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

    Include

    Include term values for which buckets will be created.

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

    MinimumDocumentCount

    Return only terms that match equal to or more than a configurable number of hits

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

    MutualInformation

    Use mutual information to calculate significance score

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

    PercentageScore

    Use percentage to calculate significance score.

    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. By default this produces a score greater than zero and less than one.

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

    Script

    Use a script to calculate a custom significance score.

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

    ShardMinimumDocumentCount

    Regulates the certainty a shard has if the term should actually be added to the candidate list or not with respect to the MinimumDocumentCount. Terms will only be considered if their local shard frequency within the set is higher than the ShardMinimumDocumentCount.

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

    ShardSize

    Controls the number of candidate terms produced by each shard from which the Size of terms is selected.

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

    Size

    Defines how many term buckets should be returned out of the overall terms list

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

    SourceFields

    Ordinarily the indexed field name and the original JSON field being retrieved share the same name. However with more complex field mappings using features like copy_to the source JSON field(s) and the indexed field being aggregated can differ. In these cases it is possible to list the JSON _source fields from which text will be analyzed using SourceFields

    Declaration
    public Fields SourceFields { get; set; }
    Property Value
    Type Description
    Fields

    Implements

    ISignificantTextAggregation
    IBucketAggregation
    IAggregation

    Extension Methods

    SuffixExtensions.Suffix(object, string)
    • Edit this page
    • View Source
    In this article
    • Constructors
      • SignificantTextAggregation(string)
    • Properties
      • BackgroundFilter
      • ChiSquare
      • Exclude
      • ExecutionHint
      • Field
      • FilterDuplicateText
      • GoogleNormalizedDistance
      • Include
      • MinimumDocumentCount
      • MutualInformation
      • PercentageScore
      • Script
      • ShardMinimumDocumentCount
      • ShardSize
      • Size
      • SourceFields
    • Implements
    • Extension Methods
    Back to top Generated by DocFX