Class SignificantTextAggregation.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.aggregations.AggregationBase.AbstractBuilder<BuilderT>
co.elastic.clients.elasticsearch._types.aggregations.BucketAggregationBase.AbstractBuilder<SignificantTextAggregation.Builder>
co.elastic.clients.elasticsearch._types.aggregations.SignificantTextAggregation.Builder
- All Implemented Interfaces:
WithJson<SignificantTextAggregation.Builder>
,ObjectBuilder<SignificantTextAggregation>
- Enclosing class:
- SignificantTextAggregation
public static class SignificantTextAggregation.Builder
extends BucketAggregationBase.AbstractBuilder<SignificantTextAggregation.Builder>
implements ObjectBuilder<SignificantTextAggregation>
Builder for
SignificantTextAggregation
.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbackgroundFilter
(Query value) A background filter that can be used to focus in on significant terms within a narrower context, instead of the entire index.A background filter that can be used to focus in on significant terms within a narrower context, instead of the entire index.build()
Builds aSignificantTextAggregation
.chiSquare
(ChiSquareHeuristic value) Use Chi square, as described in "Information Retrieval", Manning et al., Chapter 13.5.2, as the significance score.Use Chi square, as described in "Information Retrieval", Manning et al., Chapter 13.5.2, as the significance score.exclude
(TermsExclude value) Values to exclude.Values to exclude.Determines whether the aggregation will use field values directly or global ordinals.The field from which to return significant text.filterDuplicateText
(Boolean value) Whether to out duplicate text to deal with noisy data.Use Google normalized distance as described in "The Google Similarity Distance", Cilibrasi and Vitanyi, 2007, as the significance score.gnd
(Function<GoogleNormalizedDistanceHeuristic.Builder, ObjectBuilder<GoogleNormalizedDistanceHeuristic>> fn) Use Google normalized distance as described in "The Google Similarity Distance", Cilibrasi and Vitanyi, 2007, as the significance score.include
(TermsInclude value) Values to include.Values to include.jlh
(EmptyObject value) Use JLH score as the significance score.Use JLH score as the significance score.minDocCount
(Long value) Only return values that are found in more thanmin_doc_count
hits.Use mutual information as described in "Information Retrieval", Manning et al., Chapter 13.5.1, as the significance score.mutualInformation
(Function<MutualInformationHeuristic.Builder, ObjectBuilder<MutualInformationHeuristic>> fn) Use mutual information as described in "Information Retrieval", Manning et al., Chapter 13.5.1, as the 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.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.scriptHeuristic
(ScriptedHeuristic value) Customized score, implemented via a script.Customized score, implemented via a script.protected SignificantTextAggregation.Builder
self()
shardMinDocCount
(Long value) Regulates the certainty a shard has if the values should actually be added to the candidate list or not with respect to the min_doc_count.The number of candidate terms produced by each shard.The number of buckets returned out of the overall terms list.sourceFields
(String value, String... values) Overrides the JSON_source
fields from which text will be analyzed.sourceFields
(List<String> list) Overrides the JSON_source
fields from which text will be analyzed.Methods inherited from class co.elastic.clients.elasticsearch._types.aggregations.AggregationBase.AbstractBuilder
meta, meta, name
Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase
withJson
Methods inherited from class co.elastic.clients.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
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
-
backgroundFilter
public final SignificantTextAggregation.Builder backgroundFilter(Function<Query.Builder, ObjectBuilder<Query>> fn) 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
Use Chi square, as described in "Information Retrieval", Manning et al., Chapter 13.5.2, as the significance score.API name:
chi_square
-
chiSquare
public final SignificantTextAggregation.Builder chiSquare(Function<ChiSquareHeuristic.Builder, ObjectBuilder<ChiSquareHeuristic>> fn) Use Chi square, as described in "Information Retrieval", Manning et al., Chapter 13.5.2, as the significance score.API name:
chi_square
-
exclude
Values to exclude.API name:
exclude
-
exclude
public final SignificantTextAggregation.Builder exclude(Function<TermsExclude.Builder, ObjectBuilder<TermsExclude>> fn) Values to exclude.API name:
exclude
-
executionHint
public final SignificantTextAggregation.Builder executionHint(@Nullable TermsAggregationExecutionHint value) Determines whether the aggregation will use field values directly or global ordinals.API name:
execution_hint
-
field
The field from which to return significant text.API name:
field
-
filterDuplicateText
Whether to out duplicate text to deal with noisy data.API name:
filter_duplicate_text
-
gnd
public final SignificantTextAggregation.Builder gnd(@Nullable GoogleNormalizedDistanceHeuristic value) Use Google normalized distance as described in "The Google Similarity Distance", Cilibrasi and Vitanyi, 2007, as the significance score.API name:
gnd
-
gnd
public final SignificantTextAggregation.Builder gnd(Function<GoogleNormalizedDistanceHeuristic.Builder, ObjectBuilder<GoogleNormalizedDistanceHeuristic>> fn) Use Google normalized distance as described in "The Google Similarity Distance", Cilibrasi and Vitanyi, 2007, as the significance score.API name:
gnd
-
include
Values to include.API name:
include
-
include
public final SignificantTextAggregation.Builder include(Function<TermsInclude.Builder, ObjectBuilder<TermsInclude>> fn) Values to include.API name:
include
-
jlh
Use JLH score as the significance score.API name:
jlh
-
jlh
public final SignificantTextAggregation.Builder jlh(Function<EmptyObject.Builder, ObjectBuilder<EmptyObject>> fn) Use JLH score as the significance score.API name:
jlh
-
minDocCount
Only return values that are found in more thanmin_doc_count
hits.API name:
min_doc_count
-
mutualInformation
public final SignificantTextAggregation.Builder mutualInformation(@Nullable MutualInformationHeuristic value) Use mutual information as described in "Information Retrieval", Manning et al., Chapter 13.5.1, as the significance score.API name:
mutual_information
-
mutualInformation
public final SignificantTextAggregation.Builder mutualInformation(Function<MutualInformationHeuristic.Builder, ObjectBuilder<MutualInformationHeuristic>> fn) Use mutual information as described in "Information Retrieval", Manning et al., Chapter 13.5.1, as the significance score.API name:
mutual_information
-
percentage
public final SignificantTextAggregation.Builder percentage(@Nullable PercentageScoreHeuristic value) 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
-
percentage
public final SignificantTextAggregation.Builder percentage(Function<PercentageScoreHeuristic.Builder, ObjectBuilder<PercentageScoreHeuristic>> fn) 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
Customized score, implemented via a script.API name:
script_heuristic
-
scriptHeuristic
public final SignificantTextAggregation.Builder scriptHeuristic(Function<ScriptedHeuristic.Builder, ObjectBuilder<ScriptedHeuristic>> fn) Customized score, implemented via a script.API name:
script_heuristic
-
shardMinDocCount
Regulates the certainty a shard has if the values should actually be added to the candidate list or not with respect to the min_doc_count. Values will only be considered if their local shard frequency within the set is higher than theshard_min_doc_count
.API name:
shard_min_doc_count
-
shardSize
The number of candidate terms produced by each shard. By default,shard_size
will be automatically estimated based on the number of shards and thesize
parameter.API name:
shard_size
-
size
The number of buckets returned out of the overall terms list.API name:
size
-
sourceFields
Overrides the JSON_source
fields from which text will be analyzed.API name:
source_fields
Adds all elements of
list
tosourceFields
. -
sourceFields
Overrides the JSON_source
fields from which text will be analyzed.API name:
source_fields
Adds one or more values to
sourceFields
. -
self
- Specified by:
self
in classAggregationBase.AbstractBuilder<SignificantTextAggregation.Builder>
-
build
Builds aSignificantTextAggregation
.- Specified by:
build
in interfaceObjectBuilder<SignificantTextAggregation>
- Throws:
NullPointerException
- if some of the required fields are null.
-