Package com.azure.search.documents.models

Class QueryDebugMode

java.lang.Object
com.azure.core.util.ExpandableStringEnum<QueryDebugMode>
com.azure.search.documents.models.QueryDebugMode
All Implemented Interfaces:
com.azure.core.util.ExpandableEnum<String>
public final class QueryDebugMode extends com.azure.core.util.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 Details

    • DISABLED

      public static final QueryDebugMode DISABLED
      No query debugging information will be returned.

    • 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.

    • QUERY_REWRITES

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

    • ALL

      public static final QueryDebugMode ALL
      Turn on all debug options.

  • Constructor Details

    • QueryDebugMode

      @Deprecated public QueryDebugMode()
      Deprecated.
      Use the fromString(String) 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.