Struct RerankedDocument 

pub struct RerankedDocument {
    pub document: Document,
    pub rerank_score: f32,
}

One reranked document paired with the score the Reranker assigned.

Two scores ride together: the inner Document::score carries the original retrieval score from the VectorStore (or None if the store did not surface one), and rerank_score carries the reranker’s own score. Keeping them distinct preserves explainability — UIs and dashboards can show “the embedding ranked this 0.82, the cross-encoder ranked it 0.41 → moved from rank 1 to rank 7” without ambiguity, and downstream filters can threshold on whichever score the deployment trusts.

Fields

document: Document

The reranked document. Its score field still holds the retrieval score from the originating VectorStore — the reranker does not mutate it.

rerank_score: f32

The reranker’s score for this document at this query. Comparable only within a single rerank call. Higher = better per the reranker’s scoring model.

Implementations

impl RerankedDocument

pub const fn new(document: Document, rerank_score: f32) -> RerankedDocument

Build a reranked document from a candidate and a fresh score.

Trait Implementations

impl Clone for RerankedDocument

fn clone(&self) -> RerankedDocument

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RerankedDocument

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RerankedDocument

fn deserialize<__D>( __deserializer: __D, ) -> Result<RerankedDocument, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for RerankedDocument

fn eq(&self, other: &RerankedDocument) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for RerankedDocument

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for RerankedDocument