SearchResult<T> Class

Definition

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

public class SearchResult<T>
type SearchResult<'T> = class
Public Class SearchResult(Of T)

Type Parameters

T

The .NET type that maps to the index schema. Instances of this type can be retrieved as documents from the index.

Inheritance
SearchResult<T>

Properties

Captions

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.

Document

The document found by the search query.

Highlights

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.

RerankerScore

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.

Score

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

Applies to