Package co.elastic.clients.elasticsearch._types.aggregations

Class SignificantTermsAggregation

java.lang.Object
co.elastic.clients.elasticsearch._types.aggregations.AggregationBase
co.elastic.clients.elasticsearch._types.aggregations.BucketAggregationBase
co.elastic.clients.elasticsearch._types.aggregations.SignificantTermsAggregation
All Implemented Interfaces:
AggregationVariant, JsonpSerializable
@JsonpDeserializable public class SignificantTermsAggregation extends BucketAggregationBase implements AggregationVariant, JsonpSerializable
See Also:

  • Field Details

  • Method Details

    • of

      public static SignificantTermsAggregation of(Function<SignificantTermsAggregation.Builder,ObjectBuilder<SignificantTermsAggregation>> fn)

    • _aggregationKind

      public Aggregation.Kind _aggregationKind()
      Aggregation variant kind.
      Specified by:
      _aggregationKind in interface AggregationVariant

    • backgroundFilter

      @Nullable public final Query backgroundFilter()
      A background filter that can be used to focus in on significant terms within a narrower context, instead of the entire index.

      API name: background_filter

    • chiSquare

      @Nullable public final ChiSquareHeuristic chiSquare()
      Use Chi square, as described in "Information Retrieval", Manning et al., Chapter 13.5.2, as the significance score.

      API name: chi_square

    • exclude

      @Nullable public final TermsExclude exclude()
      Terms to exclude.

      API name: exclude

    • executionHint

      @Nullable public final TermsAggregationExecutionHint executionHint()
      Mechanism by which the aggregation should be executed: using field values directly or using global ordinals.

      API name: execution_hint

    • field

      @Nullable public final String field()
      The field from which to return significant terms.

      API name: field

    • gnd

      @Nullable public final GoogleNormalizedDistanceHeuristic gnd()
      Use Google normalized distance as described in "The Google Similarity Distance", Cilibrasi and Vitanyi, 2007, as the significance score.

      API name: gnd

    • include

      @Nullable public final TermsInclude include()
      Terms to include.

      API name: include

    • jlh

      @Nullable public final EmptyObject jlh()
      Use JLH score as the significance score.

      API name: jlh

    • minDocCount

      @Nullable public final Long minDocCount()
      Only return terms that are found in more than min_doc_count hits.

      API name: min_doc_count

    • mutualInformation

      @Nullable public final MutualInformationHeuristic mutualInformation()
      Use mutual information as described in "Information Retrieval", Manning et al., Chapter 13.5.1, as the significance score.

      API name: mutual_information

    • percentage

      @Nullable public final PercentageScoreHeuristic percentage()
      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.

      API name: percentage

    • scriptHeuristic

      @Nullable public final ScriptedHeuristic scriptHeuristic()
      Customized score, implemented via a script.

      API name: script_heuristic

    • shardMinDocCount

      @Nullable public final Long shardMinDocCount()
      Regulates the certainty a shard has if the term should actually be added to the candidate list or not with respect to the min_doc_count. Terms will only be considered if their local shard frequency within the set is higher than the shard_min_doc_count.

      API name: shard_min_doc_count

    • shardSize

      @Nullable public final Integer shardSize()
      Can be used to control the volumes of candidate terms produced by each shard. By default, shard_size will be automatically estimated based on the number of shards and the size parameter.

      API name: shard_size

    • size

      @Nullable public final Integer size()
      The number of buckets returned out of the overall terms list.

      API name: size

    • serialize

      public void serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
      Serialize this object to JSON.
      Specified by:
      serialize in interface JsonpSerializable

    • serializeInternal

      protected void serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • setupSignificantTermsAggregationDeserializer

      protected static void setupSignificantTermsAggregationDeserializer(ObjectDeserializer<SignificantTermsAggregation.Builder> op)