azure-docs-sdk-java/docs-ref-autogen/com.azure.search.documents.models.QueryAnswerResult.yml

### YamlMime:JavaType
uid: "com.azure.search.documents.models.QueryAnswerResult"
fullName: "com.azure.search.documents.models.QueryAnswerResult"
name: "QueryAnswerResult"
nameWithType: "QueryAnswerResult"
summary: "An answer is a text passage extracted from the contents of the most relevant documents that matched the 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 **QueryAnswerResult**</br> implements <xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.search.documents.models.QueryAnswerResult?alt=com.azure.search.documents.models.QueryAnswerResult&text=QueryAnswerResult\" data-throw-if-not-resolved=\"False\" />&gt;"
constructors:
- uid: "com.azure.search.documents.models.QueryAnswerResult.QueryAnswerResult()"
  fullName: "com.azure.search.documents.models.QueryAnswerResult.QueryAnswerResult()"
  name: "QueryAnswerResult()"
  nameWithType: "QueryAnswerResult.QueryAnswerResult()"
  summary: "Creates an instance of Query<wbr>Answer<wbr>Result class."
  syntax: "public QueryAnswerResult()"
  desc: "Creates an instance of QueryAnswerResult class."
methods:
- uid: "com.azure.search.documents.models.QueryAnswerResult.fromJson(com.azure.json.JsonReader)"
  fullName: "com.azure.search.documents.models.QueryAnswerResult.fromJson(JsonReader jsonReader)"
  name: "fromJson(JsonReader jsonReader)"
  nameWithType: "QueryAnswerResult.fromJson(JsonReader jsonReader)"
  summary: "Reads an instance of Query<wbr>Answer<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 QueryAnswerResult fromJson(JsonReader jsonReader)"
  exceptions:
  - description: "If an error occurs while reading the QueryAnswerResult."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
  desc: "Reads an instance of QueryAnswerResult from the JsonReader."
  returns:
    description: "An instance of QueryAnswerResult 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.QueryAnswerResult?alt=com.azure.search.documents.models.QueryAnswerResult&text=QueryAnswerResult\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.models.QueryAnswerResult.getAdditionalProperties()"
  fullName: "com.azure.search.documents.models.QueryAnswerResult.getAdditionalProperties()"
  name: "getAdditionalProperties()"
  nameWithType: "QueryAnswerResult.getAdditionalProperties()"
  summary: "Get the additional<wbr>Properties property: An answer is a text passage extracted from the contents of the most relevant documents that matched the query."
  syntax: "public Map<String,Object> getAdditionalProperties()"
  desc: "Get the additionalProperties property: An answer is a text passage extracted from the contents of the most relevant documents that matched the query. Answers are extracted from the top search results. Answer candidates are scored and the top answers are selected."
  returns:
    description: "the additionalProperties value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a>&lt;<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>&gt;"
- uid: "com.azure.search.documents.models.QueryAnswerResult.getHighlights()"
  fullName: "com.azure.search.documents.models.QueryAnswerResult.getHighlights()"
  name: "getHighlights()"
  nameWithType: "QueryAnswerResult.getHighlights()"
  summary: "Get the highlights property: Same text passage as in the Text property with highlighted text 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 text 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.QueryAnswerResult.getKey()"
  fullName: "com.azure.search.documents.models.QueryAnswerResult.getKey()"
  name: "getKey()"
  nameWithType: "QueryAnswerResult.getKey()"
  summary: "Get the key property: The key of the document the answer was extracted from."
  syntax: "public String getKey()"
  desc: "Get the key property: The key of the document the answer was extracted from."
  returns:
    description: "the key value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.search.documents.models.QueryAnswerResult.getScore()"
  fullName: "com.azure.search.documents.models.QueryAnswerResult.getScore()"
  name: "getScore()"
  nameWithType: "QueryAnswerResult.getScore()"
  summary: "Get the score property: The score value represents how relevant the answer is to the query relative to other answers returned for the query."
  syntax: "public Double getScore()"
  desc: "Get the score property: The score value represents how relevant the answer is to the query relative to other answers returned for the query."
  returns:
    description: "the score value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Double.html\">Double</a>"
- uid: "com.azure.search.documents.models.QueryAnswerResult.getText()"
  fullName: "com.azure.search.documents.models.QueryAnswerResult.getText()"
  name: "getText()"
  nameWithType: "QueryAnswerResult.getText()"
  summary: "Get the text property: The text passage extracted from the document contents as the answer."
  syntax: "public String getText()"
  desc: "Get the text property: The text passage extracted from the document contents as the answer."
  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.QueryAnswerResult.toJson(com.azure.json.JsonWriter)"
  fullName: "com.azure.search.documents.models.QueryAnswerResult.toJson(JsonWriter jsonWriter)"
  name: "toJson(JsonWriter jsonWriter)"
  nameWithType: "QueryAnswerResult.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: "An answer is a text passage extracted from the contents of the most relevant documents that matched the query. Answers are extracted from the top search results. Answer candidates are scored and the top answers are selected."
implements:
- "<xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.search.documents.models.QueryAnswerResult?alt=com.azure.search.documents.models.QueryAnswerResult&text=QueryAnswerResult\" data-throw-if-not-resolved=\"False\" />&gt;"
metadata: {}
package: "com.azure.search.documents.models"
artifact: com.azure:azure-search-documents:11.7.3