Class CompletionSuggestionBuilder
java.lang.Object
org.elasticsearch.search.suggest.SuggestionBuilder<CompletionSuggestionBuilder>
org.elasticsearch.search.suggest.completion.CompletionSuggestionBuilder
- All Implemented Interfaces:
NamedWriteable
,Writeable
,org.elasticsearch.common.xcontent.ToXContent
,org.elasticsearch.common.xcontent.ToXContentFragment
public class CompletionSuggestionBuilder extends SuggestionBuilder<CompletionSuggestionBuilder>
Defines a suggest command based on a prefix, typically to provide "auto-complete" functionality
for users as they type search terms. The implementation of the completion service uses FSTs that
are created at index-time and so must be defined in the mapping with the type "completion" before
indexing.
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent
org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.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 protected BytesReference
contextBytes
protected FuzzyOptions
fuzzyOptions
protected RegexOptions
regexOptions
protected boolean
skipDuplicates
static java.lang.String
SUGGESTION_NAME
Fields inherited from class org.elasticsearch.search.suggest.SuggestionBuilder
analyzer, ANALYZER_FIELD, field, FIELDNAME_FIELD, prefix, PREFIX_FIELD, regex, REGEX_FIELD, shardSize, SHARDSIZE_FIELD, size, SIZE_FIELD, text, TEXT_FIELD
Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent
EMPTY_PARAMS
-
Constructor Summary
Constructors Constructor Description CompletionSuggestionBuilder(java.lang.String field)
CompletionSuggestionBuilder(StreamInput in)
Read from a stream. -
Method Summary
Modifier and Type Method Description SuggestionSearchContext.SuggestionContext
build(SearchExecutionContext context)
CompletionSuggestionBuilder
contexts(java.util.Map<java.lang.String,java.util.List<? extends org.elasticsearch.common.xcontent.ToXContent>> queryContexts)
Sets query contexts for completionprotected boolean
doEquals(CompletionSuggestionBuilder other)
Indicates whether some otherSuggestionBuilder
of the same type is "equal to" this one.protected int
doHashCode()
HashCode for the subclass ofSuggestionBuilder
to implement.void
doWriteTo(StreamOutput out)
static CompletionSuggestionBuilder
fromXContent(org.elasticsearch.common.xcontent.XContentParser parser)
java.lang.String
getWriteableName()
Returns the name of the writeable objectprotected org.elasticsearch.common.xcontent.XContentBuilder
innerToXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
CompletionSuggestionBuilder
prefix(java.lang.String prefix)
Sets the prefix to provide completions for.CompletionSuggestionBuilder
prefix(java.lang.String prefix, Fuzziness fuzziness)
Same asprefix(String)
with fuzziness offuzziness
CompletionSuggestionBuilder
prefix(java.lang.String prefix, FuzzyOptions fuzzyOptions)
Same asprefix(String)
with full fuzzy options seeFuzzyOptions.Builder
CompletionSuggestionBuilder
regex(java.lang.String regex)
Sets a regular expression pattern for prefixes to provide completions for.CompletionSuggestionBuilder
regex(java.lang.String regex, RegexOptions regexOptions)
Same asregex(String)
with full regular expression options seeRegexOptions.Builder
boolean
skipDuplicates()
Returns whether duplicate suggestions should be filtered out.CompletionSuggestionBuilder
skipDuplicates(boolean skipDuplicates)
Should duplicates be filtered or not.Methods inherited from class org.elasticsearch.search.suggest.SuggestionBuilder
analyzer, analyzer, equals, field, hashCode, populateCommonFields, prefix, regex, shardSize, shardSize, size, size, text, text, toXContent, writeTo
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentFragment
isFragment
-
Field Details
-
SUGGESTION_NAME
public static final java.lang.String SUGGESTION_NAME- See Also:
- Constant Field Values
-
fuzzyOptions
-
regexOptions
-
contextBytes
-
skipDuplicates
protected boolean skipDuplicates
-
-
Constructor Details
-
CompletionSuggestionBuilder
public CompletionSuggestionBuilder(java.lang.String field) -
CompletionSuggestionBuilder
Read from a stream.- Throws:
java.io.IOException
-
-
Method Details
-
doWriteTo
- Specified by:
doWriteTo
in classSuggestionBuilder<CompletionSuggestionBuilder>
- Throws:
java.io.IOException
-
prefix
Sets the prefix to provide completions for. The prefix gets analyzed by the suggest analyzer.- Overrides:
prefix
in classSuggestionBuilder<CompletionSuggestionBuilder>
-
prefix
Same asprefix(String)
with fuzziness offuzziness
-
prefix
Same asprefix(String)
with full fuzzy options seeFuzzyOptions.Builder
-
regex
Sets a regular expression pattern for prefixes to provide completions for.- Overrides:
regex
in classSuggestionBuilder<CompletionSuggestionBuilder>
-
regex
Same asregex(String)
with full regular expression options seeRegexOptions.Builder
-
contexts
public CompletionSuggestionBuilder contexts(java.util.Map<java.lang.String,java.util.List<? extends org.elasticsearch.common.xcontent.ToXContent>> queryContexts)Sets query contexts for completion- Parameters:
queryContexts
- named query contexts seeCategoryQueryContext
andGeoQueryContext
-
skipDuplicates
public boolean skipDuplicates()Returns whether duplicate suggestions should be filtered out. -
skipDuplicates
Should duplicates be filtered or not. Defaults tofalse
. -
innerToXContent
protected org.elasticsearch.common.xcontent.XContentBuilder innerToXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws java.io.IOException- Specified by:
innerToXContent
in classSuggestionBuilder<CompletionSuggestionBuilder>
- Throws:
java.io.IOException
-
fromXContent
public static CompletionSuggestionBuilder fromXContent(org.elasticsearch.common.xcontent.XContentParser parser) throws java.io.IOException- Throws:
java.io.IOException
-
build
public SuggestionSearchContext.SuggestionContext build(SearchExecutionContext context) throws java.io.IOException- Specified by:
build
in classSuggestionBuilder<CompletionSuggestionBuilder>
- Throws:
java.io.IOException
-
getWriteableName
public java.lang.String getWriteableName()Description copied from interface:NamedWriteable
Returns the name of the writeable object -
doEquals
Description copied from class:SuggestionBuilder
Indicates whether some otherSuggestionBuilder
of the same type is "equal to" this one.- Specified by:
doEquals
in classSuggestionBuilder<CompletionSuggestionBuilder>
-
doHashCode
protected int doHashCode()Description copied from class:SuggestionBuilder
HashCode for the subclass ofSuggestionBuilder
to implement.- Specified by:
doHashCode
in classSuggestionBuilder<CompletionSuggestionBuilder>
-