Enum QueryType

java.lang.Object

java.lang.Enum<QueryType>

com.azure.search.documents.models.QueryType

All Implemented Interfaces:

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

public enum QueryType
extends Enum<QueryType>

Specifies the syntax of the search query. The default is 'simple'. Use 'full' if your query uses the Lucene query syntax and 'semantic' if query syntax is not needed.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
FULL	Uses the full Lucene query syntax for searches.
SEMANTIC	Best suited for queries expressed in natural language as opposed to keywords.
SIMPLE	Uses the simple query syntax for searches.

Method Summary

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

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

SIMPLE

public static final QueryType SIMPLE

Uses the simple query syntax for searches. Search text is interpreted using a simple query language that allows for symbols such as +, * and "". Queries are evaluated across all searchable fields by default, unless the searchFields parameter is specified.

FULL

public static final QueryType FULL

Uses the full Lucene query syntax for searches. Search text is interpreted using the Lucene query language which allows field-specific and weighted searches, as well as other advanced features.

SEMANTIC

public static final QueryType SEMANTIC

Best suited for queries expressed in natural language as opposed to keywords. Improves precision of search results by re-ranking the top search results using a ranking model trained on the Web corpus.

Method Details

values

public static QueryType[] 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 QueryType 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 QueryType fromString(String value)

Parses a serialized value to a QueryType instance.

Parameters:

value - the serialized value to parse.

Returns:

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

toString

public String toString()

Overrides:

toString in class Enum<QueryType>