QueryCaptionType Class

Package:

com.azure.search.documents.models

Maven Artifact:

com.azure:azure-search-documents:11.7.4

• java.lang.Object
• • com.azure.core.util.ExpandableStringEnum<T>
  • • com.azure.search.documents.models.QueryCaptionType

public final class QueryCaptionType
extends 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`.

Field Summary

Modifier and Type	Field and Description
static final QueryCaptionType	EXTRACTIVE Extracts captions from the matching documents that contain passages relevant to the search query.
static final QueryCaptionType	NONE Do not return captions for the query.

Constructor Summary

Constructor	Description
QueryCaptionType()	Deprecated Use the fromString(String name) factory method. Creates a new instance of QueryCaptionType value.

Method Summary

Modifier and Type	Method and Description
static QueryCaptionType	fromString(String name) Creates or finds a QueryCaptionType from its string representation.
static Collection<QueryCaptionType>	values() Gets known QueryCaptionType 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

EXTRACTIVE

public static final QueryCaptionType EXTRACTIVE

Extracts captions from the matching documents that contain passages relevant to the search query.

NONE

public static final QueryCaptionType NONE

Do not return captions for the query.

Constructor Details

QueryCaptionType

@Deprecated
public QueryCaptionType()

Deprecated

Use the fromString(String name) 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 values()

Gets known QueryCaptionType values.

Returns:

known QueryCaptionType values.