QueryResultDocumentInnerHit Class

  • java.lang.Object
    • com.azure.search.documents.models.QueryResultDocumentInnerHit

Implements

public final class QueryResultDocumentInnerHit
implements JsonSerializable<QueryResultDocumentInnerHit>

Detailed scoring information for an individual element of a complex collection.

Constructor Summary

Constructor Description
QueryResultDocumentInnerHit()

Creates an instance of QueryResultDocumentInnerHit class.

Method Summary

Modifier and Type Method and Description
static QueryResultDocumentInnerHit fromJson(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.

JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

Constructor Details

QueryResultDocumentInnerHit

public QueryResultDocumentInnerHit()

Creates an instance of QueryResultDocumentInnerHit class.

Method Details

fromJson

public static QueryResultDocumentInnerHit fromJson(JsonReader jsonReader)

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.

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 JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to