Package com.azure.search.documents.models

Enum AutocompleteMode

java.lang.Object

java.lang.Enum<AutocompleteMode>

com.azure.search.documents.models.AutocompleteMode

All Implemented Interfaces:

Serializable, Comparable<AutocompleteMode>, java.lang.constant.Constable

public enum AutocompleteMode
extends Enum<AutocompleteMode>

Specifies the mode for Autocomplete. The default is 'oneTerm'. Use 'twoTerms' to get shingles and 'oneTermWithContext' to use the current context in producing autocomplete terms.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ONE_TERM	Only one term is suggested.
ONE_TERM_WITH_CONTEXT	Completes the last term in a query with two or more terms, where the last two terms are a phrase that exists in the index.
TWO_TERMS	Matching two-term phrases in the index will be suggested.

Method Summary

Modifier and Type	Method	Description
static AutocompleteMode	fromString(String value)	Parses a serialized value to a AutocompleteMode instance.
String	toString()
static AutocompleteMode	valueOf(String name)	Returns the enum constant of this type with the specified name.
static AutocompleteMode[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ONE_TERM

public static final AutocompleteMode ONE_TERM

Only one term is suggested. If the query has two terms, only the last term is completed. For example, if the input is 'washington medic', the suggested terms could include 'medicaid', 'medicare', and 'medicine'.

TWO_TERMS

public static final AutocompleteMode TWO_TERMS

Matching two-term phrases in the index will be suggested. For example, if the input is 'medic', the suggested terms could include 'medicare coverage' and 'medical assistant'.

ONE_TERM_WITH_CONTEXT

public static final AutocompleteMode ONE_TERM_WITH_CONTEXT

Completes the last term in a query with two or more terms, where the last two terms are a phrase that exists in the index. For example, if the input is 'washington medic', the suggested terms could include 'washington medicaid' and 'washington medical'.

Method Details

values

public static AutocompleteMode[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static AutocompleteMode valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

fromString

public static AutocompleteMode fromString(String value)

Parses a serialized value to a AutocompleteMode instance.

Parameters:

value - the serialized value to parse.

Returns:

the parsed AutocompleteMode object, or null if unable to parse.

toString

public String toString()

Overrides:

toString in class Enum<AutocompleteMode>