Package com.azure.search.documents.models

Class QueryResultDocumentSubscores

java.lang.Object
com.azure.search.documents.models.QueryResultDocumentSubscores
All Implemented Interfaces:
com.azure.json.JsonSerializable<QueryResultDocumentSubscores>
public final class QueryResultDocumentSubscores extends Object implements com.azure.json.JsonSerializable<QueryResultDocumentSubscores>
The breakdown of subscores between the text and vector query components of the search query for this document. Each vector query is shown as a separate object in the same order they were received.

  • Constructor Details

    • QueryResultDocumentSubscores

      public QueryResultDocumentSubscores()
      Creates an instance of QueryResultDocumentSubscores class.

  • Method Details

    • getText

      public TextResult getText()
      Get the text property: The BM25 or Classic score for the text portion of the query.
      Returns:
      the text value.

    • getVectors

      public List<Map<String,SingleVectorFieldResult>> getVectors()
      Get the vectors property: The vector similarity and @search.score values for each vector query.
      Returns:
      the vectors value.

    • getDocumentBoost

      public Double getDocumentBoost()
      Get the documentBoost property: The BM25 or Classic score for the text portion of the query.
      Returns:
      the documentBoost value.

    • toJson

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

    • fromJson

      public static QueryResultDocumentSubscores fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of QueryResultDocumentSubscores from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of QueryResultDocumentSubscores 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 QueryResultDocumentSubscores.