Package com.azure.search.documents.models

Class QueryCaptionType

java.lang.Object

com.azure.core.util.ExpandableStringEnum<QueryCaptionType>

com.azure.search.documents.models.QueryCaptionType

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

Field Summary

Fields

Modifier and Type	Field	Description
static final QueryCaptionType	EXTRACTIVE	Static value extractive for QueryCaptionType.
static final QueryCaptionType	NONE	Static value none for QueryCaptionType.

Constructor Summary

Constructors

Constructor	Description
QueryCaptionType()

Method Summary

Modifier and Type	Method	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 class com.azure.core.util.ExpandableStringEnum

equals, fromString, hashCode, toString, values

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

NONE

public static final QueryCaptionType NONE

Static value none for QueryCaptionType.

EXTRACTIVE

public static final QueryCaptionType EXTRACTIVE

Static value extractive for QueryCaptionType.

Constructor Details

QueryCaptionType

public QueryCaptionType()

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.