Struct RecallSample 

#[non_exhaustive]
pub struct RecallSample {
    pub query: String,
    pub expected: Vec<String>,
    pub returned_ids: Vec<String>,
}

One scored query — the question, the ground-truth ids that should land in the top-K, and the actual ranked id list returned by the recall pipeline (top result first).

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

query: String

Query text (used only for trace output; not consumed by the metrics).

expected: Vec<String>

Ground-truth ids that should land in the top-K window.

returned_ids: Vec<String>

Actual ranked id list returned by the recall pipeline (top result first).

Implementations

impl RecallSample

pub fn new( query: impl Into<String>, expected: Vec<String>, returned_ids: Vec<String>, ) -> Self

Construct a sample. An empty expected makes recall and NDCG undefined — filter such samples before scoring with score_recall.

Trait Implementations

impl Clone for RecallSample

fn clone(&self) -> RecallSample

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RecallSample

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

Formats the value using the given formatter.