101 строка
7.7 KiB
YAML
101 строка
7.7 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.search.documents.models.QueryCaptionResult"
|
|
fullName: "com.azure.search.documents.models.QueryCaptionResult"
|
|
name: "QueryCaptionResult"
|
|
nameWithType: "QueryCaptionResult"
|
|
summary: "Captions are the most representative passages from the document relatively to the search query."
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- 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#equals-java.lang.Object-\">equals</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#hashCode--\">hashCode</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#toString--\">toString</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 **QueryCaptionResult**</br> implements <xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.search.documents.models.QueryCaptionResult?alt=com.azure.search.documents.models.QueryCaptionResult&text=QueryCaptionResult\" data-throw-if-not-resolved=\"False\" />>"
|
|
constructors:
|
|
- uid: "com.azure.search.documents.models.QueryCaptionResult.QueryCaptionResult()"
|
|
fullName: "com.azure.search.documents.models.QueryCaptionResult.QueryCaptionResult()"
|
|
name: "QueryCaptionResult()"
|
|
nameWithType: "QueryCaptionResult.QueryCaptionResult()"
|
|
summary: "Creates an instance of Query<wbr>Caption<wbr>Result class."
|
|
syntax: "public QueryCaptionResult()"
|
|
desc: "Creates an instance of QueryCaptionResult class."
|
|
methods:
|
|
- uid: "com.azure.search.documents.models.QueryCaptionResult.fromJson(com.azure.json.JsonReader)"
|
|
fullName: "com.azure.search.documents.models.QueryCaptionResult.fromJson(JsonReader jsonReader)"
|
|
name: "fromJson(JsonReader jsonReader)"
|
|
nameWithType: "QueryCaptionResult.fromJson(JsonReader jsonReader)"
|
|
summary: "Reads an instance of Query<wbr>Caption<wbr>Result from the Json<wbr>Reader."
|
|
modifiers:
|
|
- "static"
|
|
parameters:
|
|
- description: "The JsonReader being read."
|
|
name: "jsonReader"
|
|
type: "<xref href=\"com.azure.json.JsonReader?alt=com.azure.json.JsonReader&text=JsonReader\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public static QueryCaptionResult fromJson(JsonReader jsonReader)"
|
|
exceptions:
|
|
- description: "If an error occurs while reading the QueryCaptionResult."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Reads an instance of QueryCaptionResult from the JsonReader."
|
|
returns:
|
|
description: "An instance of QueryCaptionResult if the JsonReader was pointing to an instance of it, or null if it was\n pointing to JSON null."
|
|
type: "<xref href=\"com.azure.search.documents.models.QueryCaptionResult?alt=com.azure.search.documents.models.QueryCaptionResult&text=QueryCaptionResult\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.documents.models.QueryCaptionResult.getAdditionalProperties()"
|
|
fullName: "com.azure.search.documents.models.QueryCaptionResult.getAdditionalProperties()"
|
|
name: "getAdditionalProperties()"
|
|
nameWithType: "QueryCaptionResult.getAdditionalProperties()"
|
|
summary: "Get the additional<wbr>Properties property: Captions are the most representative passages from the document relatively to the search query."
|
|
syntax: "public Map<String,Object> getAdditionalProperties()"
|
|
desc: "Get the additionalProperties property: Captions are the most representative passages from the document relatively to the search query. They are often used as document summary. Captions are only returned for queries of type \\`semantic\\`."
|
|
returns:
|
|
description: "the additionalProperties value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>>"
|
|
- uid: "com.azure.search.documents.models.QueryCaptionResult.getHighlights()"
|
|
fullName: "com.azure.search.documents.models.QueryCaptionResult.getHighlights()"
|
|
name: "getHighlights()"
|
|
nameWithType: "QueryCaptionResult.getHighlights()"
|
|
summary: "Get the highlights property: Same text passage as in the Text property with highlighted phrases most relevant to the query."
|
|
syntax: "public String getHighlights()"
|
|
desc: "Get the highlights property: Same text passage as in the Text property with highlighted phrases most relevant to the query."
|
|
returns:
|
|
description: "the highlights value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.search.documents.models.QueryCaptionResult.getText()"
|
|
fullName: "com.azure.search.documents.models.QueryCaptionResult.getText()"
|
|
name: "getText()"
|
|
nameWithType: "QueryCaptionResult.getText()"
|
|
summary: "Get the text property: A representative text passage extracted from the document most relevant to the search query."
|
|
syntax: "public String getText()"
|
|
desc: "Get the text property: A representative text passage extracted from the document most relevant to the search query."
|
|
returns:
|
|
description: "the text value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.search.documents.models.QueryCaptionResult.toJson(com.azure.json.JsonWriter)"
|
|
fullName: "com.azure.search.documents.models.QueryCaptionResult.toJson(JsonWriter jsonWriter)"
|
|
name: "toJson(JsonWriter jsonWriter)"
|
|
nameWithType: "QueryCaptionResult.toJson(JsonWriter jsonWriter)"
|
|
parameters:
|
|
- name: "jsonWriter"
|
|
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public JsonWriter toJson(JsonWriter jsonWriter)"
|
|
exceptions:
|
|
- type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
returns:
|
|
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "Captions are the most representative passages from the document relatively to the search query. They are often used as document summary. Captions are only returned for queries of type \\`semantic\\`."
|
|
implements:
|
|
- "<xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.search.documents.models.QueryCaptionResult?alt=com.azure.search.documents.models.QueryCaptionResult&text=QueryCaptionResult\" data-throw-if-not-resolved=\"False\" />>"
|
|
metadata: {}
|
|
package: "com.azure.search.documents.models"
|
|
artifact: com.azure:azure-search-documents:11.7.1
|