Package com.azure.search.documents.models

Class HybridCountAndFacetMode

java.lang.Object
com.azure.core.util.ExpandableStringEnum<HybridCountAndFacetMode>
com.azure.search.documents.models.HybridCountAndFacetMode
All Implemented Interfaces:
com.azure.core.util.ExpandableEnum<String>
public final class HybridCountAndFacetMode extends com.azure.core.util.ExpandableStringEnum<HybridCountAndFacetMode>
Determines whether the count and facets should includes all documents that matched the search query, or only the documents that are retrieved within the 'maxTextRecallSize' window. The default value is 'countAllResults'.

  • Field Details

    • COUNT_RETRIEVABLE_RESULTS

      public static final HybridCountAndFacetMode COUNT_RETRIEVABLE_RESULTS
      Only include documents that were matched within the 'maxTextRecallSize' retrieval window when computing 'count' and 'facets'.

    • COUNT_ALL_RESULTS

      public static final HybridCountAndFacetMode COUNT_ALL_RESULTS
      Include all documents that were matched by the search query when computing 'count' and 'facets', regardless of whether or not those documents are within the 'maxTextRecallSize' retrieval window.

  • Constructor Details

    • HybridCountAndFacetMode

      @Deprecated public HybridCountAndFacetMode()
      Deprecated.
      Use the fromString(String) factory method.
      Creates a new instance of HybridCountAndFacetMode value.

  • Method Details

    • fromString

      public static HybridCountAndFacetMode fromString(String name)
      Creates or finds a HybridCountAndFacetMode from its string representation.
      Parameters:
      name - a name to look for.
      Returns:
      the corresponding HybridCountAndFacetMode.

    • values

      public static Collection<HybridCountAndFacetMode> values()
      Gets known HybridCountAndFacetMode values.
      Returns:
      known HybridCountAndFacetMode values.