Search Results for

    Show / Hide Table of Contents

    Class SignificantTextAggregationDescriptor<T>

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

    Inheritance
    object
    BucketAggregationDescriptorBase<SignificantTextAggregationDescriptor<T>, ISignificantTextAggregation, T>
    SignificantTextAggregationDescriptor<T>
    Implements
    IDescriptor
    ISignificantTextAggregation
    IBucketAggregation
    IAggregation
    Inherited Members
    BucketAggregationDescriptorBase<SignificantTextAggregationDescriptor<T>, ISignificantTextAggregation, T>.Self
    BucketAggregationDescriptorBase<SignificantTextAggregationDescriptor<T>, ISignificantTextAggregation, T>.Assign<TValue>(TValue, Action<ISignificantTextAggregation, TValue>)
    BucketAggregationDescriptorBase<SignificantTextAggregationDescriptor<T>, ISignificantTextAggregation, T>.Aggregations(Func<AggregationContainerDescriptor<T>, IAggregationContainer>)
    BucketAggregationDescriptorBase<SignificantTextAggregationDescriptor<T>, ISignificantTextAggregation, T>.Aggregations(AggregationDictionary)
    BucketAggregationDescriptorBase<SignificantTextAggregationDescriptor<T>, ISignificantTextAggregation, T>.Meta(Func<FluentDictionary<string, object>, FluentDictionary<string, object>>)
    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 SignificantTextAggregationDescriptor<T> : BucketAggregationDescriptorBase<SignificantTextAggregationDescriptor<T>, ISignificantTextAggregation, T>, IDescriptor, ISignificantTextAggregation, IBucketAggregation, IAggregation where T : class
    Type Parameters
    Name Description
    T

    Methods

    | Edit this page View Source

    BackgroundFilter(Func<QueryContainerDescriptor<T>, QueryContainer>)

    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 SignificantTextAggregationDescriptor<T> BackgroundFilter(Func<QueryContainerDescriptor<T>, QueryContainer> selector)
    Parameters
    Type Name Description
    Func<QueryContainerDescriptor<T>, QueryContainer> selector
    Returns
    Type Description
    SignificantTextAggregationDescriptor<T>
    | Edit this page View Source

    ChiSquare(Func<ChiSquareHeuristicDescriptor, IChiSquareHeuristic>)

    Use chi square to calculate significance score

    Declaration
    public SignificantTextAggregationDescriptor<T> ChiSquare(Func<ChiSquareHeuristicDescriptor, IChiSquareHeuristic> chiSquareSelector)
    Parameters
    Type Name Description
    Func<ChiSquareHeuristicDescriptor, IChiSquareHeuristic> chiSquareSelector
    Returns
    Type Description
    SignificantTextAggregationDescriptor<T>
    | Edit this page View Source

    Exclude(IEnumerable<string>)

    Exclude term values for which buckets will be created.

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

    Exclude(string)

    Exclude term values for which buckets will be created.

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

    ExecutionHint(TermsAggregationExecutionHint?)

    Determines the mechanism by which aggregations are executed

    Declaration
    public SignificantTextAggregationDescriptor<T> ExecutionHint(TermsAggregationExecutionHint? hint)
    Parameters
    Type Name Description
    TermsAggregationExecutionHint? hint
    Returns
    Type Description
    SignificantTextAggregationDescriptor<T>
    | Edit this page View Source

    Field(Field)

    The field on which to run the aggregation

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

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

    The field on which to run the aggregation

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

    FilterDuplicateText(bool?)

    Whether to filter out near-duplicate text

    Declaration
    public SignificantTextAggregationDescriptor<T> FilterDuplicateText(bool? filterDuplicateText = true)
    Parameters
    Type Name Description
    bool? filterDuplicateText
    Returns
    Type Description
    SignificantTextAggregationDescriptor<T>
    | Edit this page View Source

    GoogleNormalizedDistance(Func<GoogleNormalizedDistanceHeuristicDescriptor, IGoogleNormalizedDistanceHeuristic>)

    Use Google normalized distance to calculate significance score

    Declaration
    public SignificantTextAggregationDescriptor<T> GoogleNormalizedDistance(Func<GoogleNormalizedDistanceHeuristicDescriptor, IGoogleNormalizedDistanceHeuristic> gndSelector)
    Parameters
    Type Name Description
    Func<GoogleNormalizedDistanceHeuristicDescriptor, IGoogleNormalizedDistanceHeuristic> gndSelector
    Returns
    Type Description
    SignificantTextAggregationDescriptor<T>
    | Edit this page View Source

    Include(IEnumerable<string>)

    Include term values for which buckets will be created.

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

    Include(string)

    Include term values for which buckets will be created.

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

    MinimumDocumentCount(long?)

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

    Declaration
    public SignificantTextAggregationDescriptor<T> MinimumDocumentCount(long? minimumDocumentCount)
    Parameters
    Type Name Description
    long? minimumDocumentCount
    Returns
    Type Description
    SignificantTextAggregationDescriptor<T>
    | Edit this page View Source

    MutualInformation(Func<MutualInformationHeuristicDescriptor, IMutualInformationHeuristic>)

    Use mutual information to calculate significance score

    Declaration
    public SignificantTextAggregationDescriptor<T> MutualInformation(Func<MutualInformationHeuristicDescriptor, IMutualInformationHeuristic> mutualInformationSelector = null)
    Parameters
    Type Name Description
    Func<MutualInformationHeuristicDescriptor, IMutualInformationHeuristic> mutualInformationSelector
    Returns
    Type Description
    SignificantTextAggregationDescriptor<T>
    | Edit this page View Source

    PercentageScore(Func<PercentageScoreHeuristicDescriptor, IPercentageScoreHeuristic>)

    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 SignificantTextAggregationDescriptor<T> PercentageScore(Func<PercentageScoreHeuristicDescriptor, IPercentageScoreHeuristic> percentageScoreSelector)
    Parameters
    Type Name Description
    Func<PercentageScoreHeuristicDescriptor, IPercentageScoreHeuristic> percentageScoreSelector
    Returns
    Type Description
    SignificantTextAggregationDescriptor<T>
    | Edit this page View Source

    Script(Func<ScriptedHeuristicDescriptor, IScriptedHeuristic>)

    Use a script to calculate a custom significance score.

    Declaration
    public SignificantTextAggregationDescriptor<T> Script(Func<ScriptedHeuristicDescriptor, IScriptedHeuristic> scriptSelector)
    Parameters
    Type Name Description
    Func<ScriptedHeuristicDescriptor, IScriptedHeuristic> scriptSelector
    Returns
    Type Description
    SignificantTextAggregationDescriptor<T>
    | Edit this page View Source

    ShardMinimumDocumentCount(long?)

    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 SignificantTextAggregationDescriptor<T> ShardMinimumDocumentCount(long? shardMinimumDocumentCount)
    Parameters
    Type Name Description
    long? shardMinimumDocumentCount
    Returns
    Type Description
    SignificantTextAggregationDescriptor<T>
    | Edit this page View Source

    ShardSize(int?)

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

    Declaration
    public SignificantTextAggregationDescriptor<T> ShardSize(int? shardSize)
    Parameters
    Type Name Description
    int? shardSize
    Returns
    Type Description
    SignificantTextAggregationDescriptor<T>
    | Edit this page View Source

    Size(int?)

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

    Declaration
    public SignificantTextAggregationDescriptor<T> Size(int? size)
    Parameters
    Type Name Description
    int? size
    Returns
    Type Description
    SignificantTextAggregationDescriptor<T>
    | Edit this page View Source

    SourceFields(Fields)

    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 SignificantTextAggregationDescriptor<T> SourceFields(Fields sourceFields)
    Parameters
    Type Name Description
    Fields sourceFields
    Returns
    Type Description
    SignificantTextAggregationDescriptor<T>
    | Edit this page View Source

    SourceFields(Func<FieldsDescriptor<T>, IPromise<Fields>>)

    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 SignificantTextAggregationDescriptor<T> SourceFields(Func<FieldsDescriptor<T>, IPromise<Fields>> sourceFields)
    Parameters
    Type Name Description
    Func<FieldsDescriptor<T>, IPromise<Fields>> sourceFields
    Returns
    Type Description
    SignificantTextAggregationDescriptor<T>

    Implements

    IDescriptor
    ISignificantTextAggregation
    IBucketAggregation
    IAggregation

    Extension Methods

    SuffixExtensions.Suffix(object, string)
    • Edit this page
    • View Source
    In this article
    • Methods
      • BackgroundFilter(Func<QueryContainerDescriptor<T>, QueryContainer>)
      • ChiSquare(Func<ChiSquareHeuristicDescriptor, IChiSquareHeuristic>)
      • Exclude(IEnumerable<string>)
      • Exclude(string)
      • ExecutionHint(TermsAggregationExecutionHint?)
      • Field(Field)
      • Field<TValue>(Expression<Func<T, TValue>>)
      • FilterDuplicateText(bool?)
      • GoogleNormalizedDistance(Func<GoogleNormalizedDistanceHeuristicDescriptor, IGoogleNormalizedDistanceHeuristic>)
      • Include(IEnumerable<string>)
      • Include(string)
      • MinimumDocumentCount(long?)
      • MutualInformation(Func<MutualInformationHeuristicDescriptor, IMutualInformationHeuristic>)
      • PercentageScore(Func<PercentageScoreHeuristicDescriptor, IPercentageScoreHeuristic>)
      • Script(Func<ScriptedHeuristicDescriptor, IScriptedHeuristic>)
      • ShardMinimumDocumentCount(long?)
      • ShardSize(int?)
      • Size(int?)
      • SourceFields(Fields)
      • SourceFields(Func<FieldsDescriptor<T>, IPromise<Fields>>)
    • Implements
    • Extension Methods
    Back to top Generated by DocFX