98 строки
7.3 KiB
YAML
98 строки
7.3 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.search.documents.models.QueryCaptionType"
|
|
fullName: "com.azure.search.documents.models.QueryCaptionType"
|
|
name: "QueryCaptionType"
|
|
nameWithType: "QueryCaptionType"
|
|
summary: "This parameter is only valid if the query type is \\`semantic\\`."
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.core.util.ExpandableStringEnum?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- classRef: "<xref href=\"com.azure.core.util.ExpandableStringEnum?alt=com.azure.core.util.ExpandableStringEnum&text=ExpandableStringEnum\" data-throw-if-not-resolved=\"False\" />"
|
|
methodsRef:
|
|
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.<T>fromString(java.lang.String,java.lang.Class<T>)?alt=com.azure.core.util.ExpandableStringEnum.<T>fromString&text=<T>fromString\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.<T>values(java.lang.Class<T>)?alt=com.azure.core.util.ExpandableStringEnum.<T>values&text=<T>values\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.equals(java.lang.Object)?alt=com.azure.core.util.ExpandableStringEnum.equals&text=equals\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.hashCode()?alt=com.azure.core.util.ExpandableStringEnum.hashCode&text=hashCode\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.toString()?alt=com.azure.core.util.ExpandableStringEnum.toString&text=toString\" data-throw-if-not-resolved=\"False\" />"
|
|
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
|
methodsRef:
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
|
syntax: "public final class **QueryCaptionType**</br> extends <xref href=\"com.azure.core.util.ExpandableStringEnum?alt=com.azure.core.util.ExpandableStringEnum&text=ExpandableStringEnum\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.search.documents.models.QueryCaptionType?alt=com.azure.search.documents.models.QueryCaptionType&text=QueryCaptionType\" data-throw-if-not-resolved=\"False\" />>"
|
|
constructors:
|
|
- uid: "com.azure.search.documents.models.QueryCaptionType.QueryCaptionType()"
|
|
fullName: "com.azure.search.documents.models.QueryCaptionType.QueryCaptionType()"
|
|
name: "QueryCaptionType()"
|
|
nameWithType: "QueryCaptionType.QueryCaptionType()"
|
|
summary: "Creates a new instance of Query<wbr>Caption<wbr>Type value."
|
|
deprecatedTag: "Use the <xref uid=\"com.azure.search.documents.models.QueryCaptionType.fromString(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#fromString(String)\"></xref> factory method."
|
|
syntax: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html\">@Deprecated</a></br>public QueryCaptionType()"
|
|
desc: "Creates a new instance of QueryCaptionType value."
|
|
hasDeprecatedTag: true
|
|
fields:
|
|
- uid: "com.azure.search.documents.models.QueryCaptionType.EXTRACTIVE"
|
|
fullName: "com.azure.search.documents.models.QueryCaptionType.EXTRACTIVE"
|
|
name: "EXTRACTIVE"
|
|
nameWithType: "QueryCaptionType.EXTRACTIVE"
|
|
summary: "Extracts captions from the matching documents that contain passages relevant to the search query."
|
|
modifiers:
|
|
- "static"
|
|
- "final"
|
|
field:
|
|
type: "<xref href=\"com.azure.search.documents.models.QueryCaptionType?alt=com.azure.search.documents.models.QueryCaptionType&text=QueryCaptionType\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public static final QueryCaptionType EXTRACTIVE"
|
|
desc: "Extracts captions from the matching documents that contain passages relevant to the search query."
|
|
- uid: "com.azure.search.documents.models.QueryCaptionType.NONE"
|
|
fullName: "com.azure.search.documents.models.QueryCaptionType.NONE"
|
|
name: "NONE"
|
|
nameWithType: "QueryCaptionType.NONE"
|
|
summary: "Do not return captions for the query."
|
|
modifiers:
|
|
- "static"
|
|
- "final"
|
|
field:
|
|
type: "<xref href=\"com.azure.search.documents.models.QueryCaptionType?alt=com.azure.search.documents.models.QueryCaptionType&text=QueryCaptionType\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public static final QueryCaptionType NONE"
|
|
desc: "Do not return captions for the query."
|
|
methods:
|
|
- uid: "com.azure.search.documents.models.QueryCaptionType.fromString(java.lang.String)"
|
|
fullName: "com.azure.search.documents.models.QueryCaptionType.fromString(String name)"
|
|
name: "fromString(String name)"
|
|
nameWithType: "QueryCaptionType.fromString(String name)"
|
|
summary: "Creates or finds a Query<wbr>Caption<wbr>Type from its string representation."
|
|
modifiers:
|
|
- "static"
|
|
parameters:
|
|
- description: "a name to look for."
|
|
name: "name"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public static QueryCaptionType fromString(String name)"
|
|
desc: "Creates or finds a QueryCaptionType from its string representation."
|
|
returns:
|
|
description: "the corresponding QueryCaptionType."
|
|
type: "<xref href=\"com.azure.search.documents.models.QueryCaptionType?alt=com.azure.search.documents.models.QueryCaptionType&text=QueryCaptionType\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.documents.models.QueryCaptionType.values()"
|
|
fullName: "com.azure.search.documents.models.QueryCaptionType.values()"
|
|
name: "values()"
|
|
nameWithType: "QueryCaptionType.values()"
|
|
summary: "Gets known Query<wbr>Caption<wbr>Type values."
|
|
modifiers:
|
|
- "static"
|
|
syntax: "public static Collection<QueryCaptionType> values()"
|
|
desc: "Gets known QueryCaptionType values."
|
|
returns:
|
|
description: "known QueryCaptionType values."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html\">Collection</a><<xref href=\"com.azure.search.documents.models.QueryCaptionType?alt=com.azure.search.documents.models.QueryCaptionType&text=QueryCaptionType\" data-throw-if-not-resolved=\"False\" />>"
|
|
type: "class"
|
|
desc: "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\\`."
|
|
metadata: {}
|
|
package: "com.azure.search.documents.models"
|
|
artifact: com.azure:azure-search-documents:11.7.1
|