Package com.azure.search.documents.models

Class QueryAnswerResult

java.lang.Object
com.azure.search.documents.models.QueryAnswerResult
All Implemented Interfaces:
com.azure.json.JsonSerializable<QueryAnswerResult>
public final class QueryAnswerResult extends Object implements com.azure.json.JsonSerializable<QueryAnswerResult>
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.

  • Constructor Summary

    Constructors
    Constructor
    Description
    QueryAnswerResult()
    Creates an instance of QueryAnswerResult class.

  • Method Summary

    Modifier and Type
    Method
    Description
    static QueryAnswerResult
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of QueryAnswerResult from the JsonReader.
    Map<String,Object>
    getAdditionalProperties()
    Get the additionalProperties property: An answer is a text passage extracted from the contents of the most relevant documents that matched the query.
    String
    getHighlights()
    Get the highlights property: Same text passage as in the Text property with highlighted text phrases most relevant to the query.
    String
    getKey()
    Get the key property: The key of the document the answer was extracted from.
    Double
    getScore()
    Get the score property: The score value represents how relevant the answer is to the query relative to other answers returned for the query.
    String
    getText()
    Get the text property: The text passage extracted from the document contents as the answer.
    com.azure.json.JsonWriter
    toJson(com.azure.json.JsonWriter jsonWriter)

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface com.azure.json.JsonSerializable

    toJson, toJson, toJsonBytes, toJsonString

  • Constructor Details

    • QueryAnswerResult

      public QueryAnswerResult()
      Creates an instance of QueryAnswerResult class.

  • Method Details

    • getScore

      public Double getScore()
      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:
      the score value.

    • getKey

      public String getKey()
      Get the key property: The key of the document the answer was extracted from.
      Returns:
      the key value.

    • getText

      public String getText()
      Get the text property: The text passage extracted from the document contents as the answer.
      Returns:
      the text value.

    • getHighlights

      public String getHighlights()
      Get the highlights property: Same text passage as in the Text property with highlighted text phrases most relevant to the query.
      Returns:
      the highlights value.

    • getAdditionalProperties

      public Map<String,Object> getAdditionalProperties()
      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:
      the additionalProperties value.

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<QueryAnswerResult>
      Throws:
      IOException

    • fromJson

      public static QueryAnswerResult fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of QueryAnswerResult from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of QueryAnswerResult if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
      Throws:
      IOException - If an error occurs while reading the QueryAnswerResult.