QueryResultDocumentSubscores Class

Package:
com.azure.search.documents.models
Maven Artifact:
com.azure:azure-search-documents:12.0.0
  • java.lang.Object
    • com.azure.search.documents.models.QueryResultDocumentSubscores

Implements

JsonSerializable<QueryResultDocumentSubscores>

public final class QueryResultDocumentSubscores
implements 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.

Method Summary

Modifier and Type Method and Description
static QueryResultDocumentSubscores fromJson(JsonReader jsonReader)

Reads an instance of QueryResultDocumentSubscores from the JsonReader.
Double getDocumentBoost()

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

Get the text property: The BM25 or Classic score for the text portion of the query.
List<Map<String,SingleVectorFieldResult>> getVectors()

Get the vectors property: The vector similarity and.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Method Details

fromJson

public static QueryResultDocumentSubscores fromJson(JsonReader jsonReader)

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.

getDocumentBoost

public Double getDocumentBoost()

Get the documentBoost property: The BM25 or Classic score for the text portion of the query.

Returns:

the documentBoost value.

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.

Returns:

the vectors value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to