Package org.opensearch.search.suggest.completion

Class CompletionSuggestionBuilder

java.lang.Object

org.opensearch.search.suggest.SuggestionBuilder<CompletionSuggestionBuilder>

org.opensearch.search.suggest.completion.CompletionSuggestionBuilder

All Implemented Interfaces:

org.opensearch.core.common.io.stream.NamedWriteable, org.opensearch.core.common.io.stream.Writeable, org.opensearch.core.xcontent.ToXContent, org.opensearch.core.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.

Opensearch.internal:

Nested Class Summary

Nested classes/interfaces inherited from interface org.opensearch.core.xcontent.ToXContent

org.opensearch.core.xcontent.ToXContent.DelegatingMapParams, org.opensearch.core.xcontent.ToXContent.MapParams, org.opensearch.core.xcontent.ToXContent.Params

Nested classes/interfaces inherited from interface org.opensearch.core.common.io.stream.Writeable

org.opensearch.core.common.io.stream.Writeable.Reader<V>, org.opensearch.core.common.io.stream.Writeable.WriteableRegistry, org.opensearch.core.common.io.stream.Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
protected org.opensearch.core.common.bytes.BytesReference	contextBytes
protected FuzzyOptions	fuzzyOptions
protected RegexOptions	regexOptions
protected boolean	skipDuplicates
static final String	SUGGESTION_NAME

Fields inherited from class org.opensearch.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.opensearch.core.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
CompletionSuggestionBuilder(String field)
CompletionSuggestionBuilder(org.opensearch.core.common.io.stream.StreamInput in)	Read from a stream.

Method Summary

Modifier and Type	Method	Description
SuggestionSearchContext.SuggestionContext	build(QueryShardContext context)
CompletionSuggestionBuilder	contexts(Map<String,List<? extends org.opensearch.core.xcontent.ToXContent>> queryContexts)	Sets query contexts for completion
protected boolean	doEquals(CompletionSuggestionBuilder other)	Indicates whether some other SuggestionBuilder of the same type is "equal to" this one.
protected int	doHashCode()	HashCode for the subclass of SuggestionBuilder to implement.
void	doWriteTo(org.opensearch.core.common.io.stream.StreamOutput out)
static CompletionSuggestionBuilder	fromXContent(org.opensearch.core.xcontent.XContentParser parser)
String	getWriteableName()
protected org.opensearch.core.xcontent.XContentBuilder	innerToXContent(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params)
CompletionSuggestionBuilder	prefix(String prefix)	Sets the prefix to provide completions for.
CompletionSuggestionBuilder	prefix(String prefix, Fuzziness fuzziness)	Same as prefix(String) with fuzziness of fuzziness
CompletionSuggestionBuilder	prefix(String prefix, FuzzyOptions fuzzyOptions)	Same as prefix(String) with full fuzzy options see FuzzyOptions.Builder
CompletionSuggestionBuilder	regex(String regex)	Sets a regular expression pattern for prefixes to provide completions for.
CompletionSuggestionBuilder	regex(String regex, RegexOptions regexOptions)	Same as regex(String) with full regular expression options see RegexOptions.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.opensearch.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.opensearch.core.xcontent.ToXContentFragment

isFragment

Field Details

SUGGESTION_NAME

public static final String SUGGESTION_NAME

See Also:

• Constant Field Values

fuzzyOptions

protected FuzzyOptions fuzzyOptions

regexOptions

protected RegexOptions regexOptions

contextBytes

protected org.opensearch.core.common.bytes.BytesReference contextBytes

skipDuplicates

protected boolean skipDuplicates

Constructor Details

CompletionSuggestionBuilder

public CompletionSuggestionBuilder(String field)

CompletionSuggestionBuilder

public CompletionSuggestionBuilder(org.opensearch.core.common.io.stream.StreamInput in)
                            throws IOException

Read from a stream.

Throws:

IOException

Method Details

doWriteTo

public void doWriteTo(org.opensearch.core.common.io.stream.StreamOutput out)
               throws IOException

Specified by:

doWriteTo in class SuggestionBuilder<CompletionSuggestionBuilder>

Throws:

IOException

prefix

public CompletionSuggestionBuilder prefix(String prefix)

Sets the prefix to provide completions for. The prefix gets analyzed by the suggest analyzer.

Overrides:

prefix in class SuggestionBuilder<CompletionSuggestionBuilder>

prefix

public CompletionSuggestionBuilder prefix(String prefix,
 Fuzziness fuzziness)

Same as prefix(String) with fuzziness of fuzziness

prefix

public CompletionSuggestionBuilder prefix(String prefix,
 FuzzyOptions fuzzyOptions)

Same as prefix(String) with full fuzzy options see FuzzyOptions.Builder

regex

public CompletionSuggestionBuilder regex(String regex)

Sets a regular expression pattern for prefixes to provide completions for.

Overrides:

regex in class SuggestionBuilder<CompletionSuggestionBuilder>

regex

public CompletionSuggestionBuilder regex(String regex,
 RegexOptions regexOptions)

Same as regex(String) with full regular expression options see RegexOptions.Builder

contexts

public CompletionSuggestionBuilder contexts(Map<String,List<? extends org.opensearch.core.xcontent.ToXContent>> queryContexts)

Sets query contexts for completion

Parameters:

queryContexts - named query contexts see CategoryQueryContext and GeoQueryContext

skipDuplicates

public boolean skipDuplicates()

Returns whether duplicate suggestions should be filtered out.

skipDuplicates

public CompletionSuggestionBuilder skipDuplicates(boolean skipDuplicates)

Should duplicates be filtered or not. Defaults to false.

innerToXContent

protected org.opensearch.core.xcontent.XContentBuilder innerToXContent(org.opensearch.core.xcontent.XContentBuilder builder,
 org.opensearch.core.xcontent.ToXContent.Params params)
                                                                throws IOException

Specified by:

innerToXContent in class SuggestionBuilder<CompletionSuggestionBuilder>

Throws:

IOException

fromXContent

public static CompletionSuggestionBuilder fromXContent(org.opensearch.core.xcontent.XContentParser parser)
                                                throws IOException

Throws:

IOException

build

public SuggestionSearchContext.SuggestionContext build(QueryShardContext context)
                                                throws IOException

Specified by:

build in class SuggestionBuilder<CompletionSuggestionBuilder>

Throws:

IOException

getWriteableName

public String getWriteableName()

doEquals

protected boolean doEquals(CompletionSuggestionBuilder other)

Description copied from class: SuggestionBuilder

Indicates whether some other SuggestionBuilder of the same type is "equal to" this one.

Specified by:

doEquals in class SuggestionBuilder<CompletionSuggestionBuilder>

doHashCode

protected int doHashCode()

Description copied from class: SuggestionBuilder

HashCode for the subclass of SuggestionBuilder to implement.

Specified by:

doHashCode in class SuggestionBuilder<CompletionSuggestionBuilder>