Class QueryCaptionType

java.lang.Object
com.azure.core.util.ExpandableStringEnum<QueryCaptionType>
com.azure.search.documents.models.QueryCaptionType
All Implemented Interfaces:
com.azure.core.util.ExpandableEnum<String>
public final class QueryCaptionType extends com.azure.core.util.ExpandableStringEnum<QueryCaptionType>
This parameter is only valid if the query type is `semantic`. If set, the query returns captions extracted from key passages in the highest ranked documents. When Captions is set to `extractive`, highlighting is enabled by default, and can be configured by appending the pipe character `|` followed by the `highlight-<true/false>` option, such as `extractive|highlight-true`. Defaults to `None`. The maximum character length of captions can be configured by appending the pipe character '|' followed by the 'count-<number of maximum character length>', such as 'extractive|maxcharlength-600'.

  • Field Details

    • NONE

      public static final QueryCaptionType NONE
      Do not return captions for the query.

    • EXTRACTIVE

      public static final QueryCaptionType EXTRACTIVE
      Extracts captions from the matching documents that contain passages relevant to the search query.

  • Constructor Details

    • QueryCaptionType

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

  • Method Details

    • fromString

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

    • values

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