Package com.azure.search.documents.models

Class QueryResultDocumentInnerHit

java.lang.Object
com.azure.search.documents.models.QueryResultDocumentInnerHit
All Implemented Interfaces:
com.azure.json.JsonSerializable<QueryResultDocumentInnerHit>
public final class QueryResultDocumentInnerHit extends Object implements com.azure.json.JsonSerializable<QueryResultDocumentInnerHit>
Detailed scoring information for an individual element of a complex collection.

  • Constructor Summary

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

  • Method Summary

    Modifier and Type
    Method
    Description
    static QueryResultDocumentInnerHit
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of QueryResultDocumentInnerHit from the JsonReader.
    Long
    getOrdinal()
    Get the ordinal property: Position of this specific matching element within it's original collection.
    List<Map<String,SingleVectorFieldResult>>
    getVectors()
    Get the vectors property: Detailed scoring information for an individual element of a complex collection that matched a vector query.
    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

    • QueryResultDocumentInnerHit

      public QueryResultDocumentInnerHit()
      Creates an instance of QueryResultDocumentInnerHit class.

  • Method Details

    • getOrdinal

      public Long getOrdinal()
      Get the ordinal property: Position of this specific matching element within it's original collection. Position starts at 0.
      Returns:
      the ordinal value.

    • getVectors

      public List<Map<String,SingleVectorFieldResult>> getVectors()
      Get the vectors property: Detailed scoring information for an individual element of a complex collection that matched a vector query.
      Returns:
      the vectors value.

    • toJson

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

    • fromJson

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