Class RerankedResult<TRaw>

Overview

Represents a single document returned from some generic findAndRerank operation on the Data API. This is the individual item type emitted by a FindAndRerankCursor.

Each result contains:

• the original document returned by the Data API (after projection), and
• an optional set of scores yielded during reranking (if includeScores was set on the cursor).

---

Reranking

When hybrid search is performed using the $hybrid operator, the Data API returns candidate documents based on vector and/or lexical similarity, before reranking them using a reranking model.

If includeScores was enabled when the cursor was created, then the scores from each stage of the ranking pipeline will be included in the scores object for every result.

---

Example

const cursor = collection.findAndRerank({}, {
  sort: { $hybrid: 'What is a tree?' },
  includeScores: true,
});

for await (const result of cursor) {
  console.log(result.document); // The document
  console.log(result.scores);   // { $rerank: .12, $vector: .78, ... }
}
Copy

See

FindAndRerankCursor