Class DirectCandidateGeneratorBuilder
java.lang.Object
org.elasticsearch.search.suggest.phrase.DirectCandidateGeneratorBuilder
- All Implemented Interfaces:
Writeable
,ToXContent
,ToXContentObject
,PhraseSuggestionBuilder.CandidateGenerator
public final class DirectCandidateGeneratorBuilder extends java.lang.Object implements PhraseSuggestionBuilder.CandidateGenerator
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params
Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V>
-
Field Summary
Fields Modifier and Type Field Description static ParseField
ACCURACY_FIELD
static ParseField
DIRECT_GENERATOR_FIELD
static ParseField
FIELDNAME_FIELD
static ParseField
MAX_EDITS_FIELD
static ParseField
MAX_INSPECTIONS_FIELD
static ParseField
MAX_TERM_FREQ_FIELD
static ParseField
MIN_DOC_FREQ_FIELD
static ParseField
MIN_WORD_LENGTH_FIELD
static ConstructingObjectParser<DirectCandidateGeneratorBuilder,java.lang.Void>
PARSER
static ParseField
POSTFILTER_FIELD
static ParseField
PREFILTER_FIELD
static ParseField
PREFIX_LENGTH_FIELD
static ParseField
SIZE_FIELD
static ParseField
SORT_FIELD
static ParseField
STRING_DISTANCE_FIELD
static ParseField
SUGGESTMODE_FIELD
-
Constructor Summary
Constructors Constructor Description DirectCandidateGeneratorBuilder(java.lang.String field)
DirectCandidateGeneratorBuilder(StreamInput in)
Read from a stream. -
Method Summary
Modifier and Type Method Description DirectCandidateGeneratorBuilder
accuracy(float accuracy)
Sets how similar the suggested terms at least need to be compared to the original suggest text tokens.org.elasticsearch.search.suggest.phrase.PhraseSuggestionContext.DirectCandidateGenerator
build(MapperService mapperService)
boolean
equals(java.lang.Object obj)
java.lang.String
getType()
gets the type identifier of thisPhraseSuggestionBuilder.CandidateGenerator
int
hashCode()
DirectCandidateGeneratorBuilder
maxEdits(java.lang.Integer maxEdits)
Sets the maximum edit distance candidate suggestions can have in order to be considered as a suggestion.DirectCandidateGeneratorBuilder
maxInspections(java.lang.Integer maxInspections)
A factor that is used to multiply with the size in order to inspect more candidate suggestions.DirectCandidateGeneratorBuilder
maxTermFreq(float maxTermFreq)
Sets a maximum threshold in number of documents a suggest text token can exist in order to be corrected.DirectCandidateGeneratorBuilder
minDocFreq(float minDocFreq)
Sets a minimal threshold in number of documents a suggested term should appear in.DirectCandidateGeneratorBuilder
minWordLength(int minWordLength)
The minimum length a suggest text term must have in order to be corrected.DirectCandidateGeneratorBuilder
postFilter(java.lang.String postFilter)
Sets a filter (analyzer) that is applied to each of the generated tokens before they are passed to the actual phrase scorer.DirectCandidateGeneratorBuilder
preFilter(java.lang.String preFilter)
Sets a filter (analyzer) that is applied to each of the tokens passed to this candidate generator.DirectCandidateGeneratorBuilder
prefixLength(int prefixLength)
Sets the number of minimal prefix characters that must match in order be a candidate suggestion.DirectCandidateGeneratorBuilder
size(int size)
Sets the maximum suggestions to be returned per suggest text term.DirectCandidateGeneratorBuilder
sort(java.lang.String sort)
Sets how to sort the suggest terms per suggest text token.DirectCandidateGeneratorBuilder
stringDistance(java.lang.String stringDistance)
Sets what string distance implementation to use for comparing how similar suggested terms are.DirectCandidateGeneratorBuilder
suggestMode(java.lang.String suggestMode)
The global suggest mode controls what suggested terms are included or controls for what suggest text tokens, terms should be suggested for.java.lang.String
toString()
XContentBuilder
toXContent(XContentBuilder builder, ToXContent.Params params)
void
writeTo(StreamOutput out)
Write this into the StreamOutput.
-
Field Details
-
DIRECT_GENERATOR_FIELD
-
FIELDNAME_FIELD
-
PREFILTER_FIELD
-
POSTFILTER_FIELD
-
SUGGESTMODE_FIELD
-
MIN_DOC_FREQ_FIELD
-
ACCURACY_FIELD
-
SIZE_FIELD
-
SORT_FIELD
-
STRING_DISTANCE_FIELD
-
MAX_EDITS_FIELD
-
MAX_INSPECTIONS_FIELD
-
MAX_TERM_FREQ_FIELD
-
PREFIX_LENGTH_FIELD
-
MIN_WORD_LENGTH_FIELD
-
PARSER
public static final ConstructingObjectParser<DirectCandidateGeneratorBuilder,java.lang.Void> PARSER
-
-
Constructor Details
-
DirectCandidateGeneratorBuilder
public DirectCandidateGeneratorBuilder(java.lang.String field)- Parameters:
field
- Sets from what field to fetch the candidate suggestions from.
-
DirectCandidateGeneratorBuilder
Read from a stream.- Throws:
java.io.IOException
-
-
Method Details
-
writeTo
Description copied from interface:Writeable
Write this into the StreamOutput. -
suggestMode
The global suggest mode controls what suggested terms are included or controls for what suggest text tokens, terms should be suggested for. Three possible values can be specified:missing
- Only suggest terms in the suggest text that aren't in the index. This is the default.popular
- Only suggest terms that occur in more docs then the original suggest text term.always
- Suggest any matching suggest terms based on tokens in the suggest text.
-
accuracy
Sets how similar the suggested terms at least need to be compared to the original suggest text tokens. A value between 0 and 1 can be specified. This value will be compared to the string distance result of each candidate spelling correction.Default is
0.5
-
size
Sets the maximum suggestions to be returned per suggest text term. -
sort
Sets how to sort the suggest terms per suggest text token. Two possible values:score
- Sort should first be based on score, then document frequency and then the term itself.frequency
- Sort should first be based on document frequency, then score and then the term itself.
What the score is depends on the suggester being used.
-
stringDistance
Sets what string distance implementation to use for comparing how similar suggested terms are. Four possible values can be specified:internal
- This is the default and is based ondamerau_levenshtein
, but highly optimized for comparing string distance for terms inside the index.damerau_levenshtein
- String distance algorithm based on Damerau-Levenshtein algorithm.levenshtein
- String distance algorithm based on Levenshtein edit distance algorithm.jaro_winkler
- String distance algorithm based on Jaro-Winkler algorithm.ngram
- String distance algorithm based on character n-grams.
-
maxEdits
Sets the maximum edit distance candidate suggestions can have in order to be considered as a suggestion. Can only be a value between 1 and 2. Any other value result in an bad request error being thrown. Defaults to2
. -
maxInspections
A factor that is used to multiply with the size in order to inspect more candidate suggestions. Can improve accuracy at the cost of performance. Defaults to5
. -
maxTermFreq
Sets a maximum threshold in number of documents a suggest text token can exist in order to be corrected. Can be a relative percentage number (e.g 0.4) or an absolute number to represent document frequencies. If an value higher than 1 is specified then fractional can not be specified. Defaults to0.01
.This can be used to exclude high frequency terms from being suggested. High frequency terms are usually spelled correctly on top of this this also improves the suggest performance.
-
prefixLength
Sets the number of minimal prefix characters that must match in order be a candidate suggestion. Defaults to 1. Increasing this number improves suggest performance. Usually misspellings don't occur in the beginning of terms. -
minWordLength
The minimum length a suggest text term must have in order to be corrected. Defaults to4
. -
minDocFreq
Sets a minimal threshold in number of documents a suggested term should appear in. This can be specified as an absolute number or as a relative percentage of number of documents. This can improve quality by only suggesting high frequency terms. Defaults to 0f and is not enabled. If a value higher than 1 is specified then the number cannot be fractional. -
preFilter
Sets a filter (analyzer) that is applied to each of the tokens passed to this candidate generator. This filter is applied to the original token before candidates are generated. -
postFilter
Sets a filter (analyzer) that is applied to each of the generated tokens before they are passed to the actual phrase scorer. -
getType
public java.lang.String getType()gets the type identifier of thisPhraseSuggestionBuilder.CandidateGenerator
- Specified by:
getType
in interfacePhraseSuggestionBuilder.CandidateGenerator
-
toXContent
public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws java.io.IOException- Specified by:
toXContent
in interfaceToXContent
- Throws:
java.io.IOException
-
build
public org.elasticsearch.search.suggest.phrase.PhraseSuggestionContext.DirectCandidateGenerator build(MapperService mapperService) throws java.io.IOException- Specified by:
build
in interfacePhraseSuggestionBuilder.CandidateGenerator
- Throws:
java.io.IOException
-
toString
public java.lang.String toString()- Overrides:
toString
in classjava.lang.Object
-
hashCode
public int hashCode()- Overrides:
hashCode
in classjava.lang.Object
-
equals
public boolean equals(java.lang.Object obj)- Overrides:
equals
in classjava.lang.Object
-