SemanticSearchResult Class

  • Reference
Package:
com.azure.search.documents.models
Maven Artifact:
com.azure:azure-search-documents:11.7.3
  • java.lang.Object
    • com.azure.search.documents.models.SemanticSearchResult

public final class SemanticSearchResult

The document-level results for a SEMANTIC search.

Method Summary

Modifier and Type Method and Description
List<QueryCaptionResult> getQueryCaptions()

Get the queryCaptions property: Captions are the most representative passages from the document relatively to the search query.
Double getRerankerScore()

Get the rerankerScore property: The relevance score computed by the semantic ranker for the top search results.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Method Details

getQueryCaptions

public List getQueryCaptions()

Get the queryCaptions property: Captions are the most representative passages from the document relatively to the search query. They are often used as document summary. Captions are only returned for queries of type 'semantic'.

Returns:

the captions value.

getRerankerScore

public Double getRerankerScore()

Get the rerankerScore property: The relevance score computed by the semantic ranker for the top search results. Search results are sorted by the RerankerScore first and then by the Score. RerankerScore is only returned for queries of type 'semantic'.

Returns:

the rerankerScore value.

Applies to