QueryDebugMode Class

Package:
com.azure.search.documents.models
Maven Artifact:
com.azure:azure-search-documents:12.0.0

public final class QueryDebugMode
extends ExpandableStringEnum<QueryDebugMode>

Enables a debugging tool that can be used to further explore your search results. You can enable multiple debug modes simultaneously by separating them with a | character, for example: semantic|queryRewrites.

Field Summary

Modifier and Type Field and Description
static final QueryDebugMode ALL

Turn on all debug options.
static final QueryDebugMode DISABLED

No query debugging information will be returned.
static final QueryDebugMode INNER_HITS

Allows the user to retrieve scoring information regarding vectors matched within a collection of complex types.
static final QueryDebugMode QUERY_REWRITES

Allows the user to explore the list of query rewrites generated for their search request.
static final QueryDebugMode SEMANTIC

Allows the user to further explore their reranked results.
static final QueryDebugMode VECTOR

Allows the user to further explore their hybrid and vector query results.

Constructor Summary

Constructor Description
QueryDebugMode()

Deprecated

Use the fromString(String name) factory method.

Creates a new instance of QueryDebugMode value.

Method Summary

Modifier and Type Method and Description
static QueryDebugMode fromString(String name)

Creates or finds a QueryDebugMode from its string representation.
static Collection<QueryDebugMode> values()

Gets known QueryDebugMode values.

Methods inherited from ExpandableStringEnum

<T>fromString <T>values equals getValue hashCode toString

Methods inherited from java.lang.Object

clone finalize getClass notify notifyAll wait wait wait

Field Details

ALL

public static final QueryDebugMode ALL

Turn on all debug options.

DISABLED

public static final QueryDebugMode DISABLED

No query debugging information will be returned.

INNER_HITS

public static final QueryDebugMode INNER_HITS

Allows the user to retrieve scoring information regarding vectors matched within a collection of complex types.

QUERY_REWRITES

public static final QueryDebugMode QUERY_REWRITES

Allows the user to explore the list of query rewrites generated for their search request.

SEMANTIC

public static final QueryDebugMode SEMANTIC

Allows the user to further explore their reranked results.

VECTOR

public static final QueryDebugMode VECTOR

Allows the user to further explore their hybrid and vector query results.

Constructor Details

QueryDebugMode

@Deprecated
public QueryDebugMode()

Deprecated

Use the fromString(String name) factory method.

Creates a new instance of QueryDebugMode value.

Method Details

fromString

public static QueryDebugMode fromString(String name)

Creates or finds a QueryDebugMode from its string representation.

Parameters:

name - a name to look for.

Returns:

the corresponding QueryDebugMode.

values

public static Collection<QueryDebugMode> values()

Gets known QueryDebugMode values.

Returns:

known QueryDebugMode values.

Applies to