SearchResult Class

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

public final class SearchResult

Contains a document found by a search query, plus associated metadata.

Constructor Summary

Constructor Description
SearchResult(double score)

Constructor of SearchResult.

Method Summary

Modifier and Type Method and Description
T getDocument(Class<T> modelClass)

Get the additionalProperties property: Unmatched properties from the message are deserialized this collection.
Map<String,List<String>> getHighlights()

Get the highlights property: Text fragments from the document that indicate the matching search terms, organized by each applicable field; null if hit highlighting was not enabled for the query.
double getScore()

Get the score property: The relevance score of the document compared to other documents returned by the query.
SemanticSearchResult getSemanticSearch()

Get the semanticSearchResult property: The semantic search results based on the search request.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

SearchResult

public SearchResult(double score)

Constructor of SearchResult.

Parameters:

score - The relevance score of the document compared to other documents returned by the query.

Method Details

getDocument

public T getDocument(Class modelClass)

Get the additionalProperties property: Unmatched properties from the message are deserialized this collection.

Parameters:

modelClass - The model class converts to.

Returns:

the additionalProperties value.

getHighlights

public Map<>> getHighlights()

Get the highlights property: Text fragments from the document that indicate the matching search terms, organized by each applicable field; null if hit highlighting was not enabled for the query.

Returns:

the highlights value.

getScore

public double getScore()

Get the score property: The relevance score of the document compared to other documents returned by the query.

Returns:

the score value.

getSemanticSearch

public SemanticSearchResult getSemanticSearch()

Get the semanticSearchResult property: The semantic search results based on the search request.

If semantic search wasn't requested this will return a SemanticSearchResult with no values.

Returns:

the semanticSearchResult value.

Applies to