Skip to main content

SearchExplain

Struct SearchExplain 

Source
pub struct SearchExplain {
    pub route: &'static str,
    pub exact_candidates: usize,
    pub ann_candidates: usize,
    pub bm25_candidates: usize,
    pub graph_candidates: usize,
    pub fusion_mode: &'static str,
    pub rerank_source: RerankSourceKind,
    pub recall_estimate: f32,
}
Expand description

ADDITIVE per-search provenance, attached to every SearchResult. zero format bytes, no URNA_FORMAT_VERSION bump: it is computed entirely in the runtime from the search path and the open file. feeds the lens --disclose explain honesty line and the agent-native retrieve() answer-pack. the load-bearing field is rerank_source.

candidate counts are the per-path candidate-set sizes the rerank saw (0 when that path did not run). recall_estimate is 1.0 only on the exact path (the recall=1.0 ground truth) and NaN on every candidate- generating path (ann/hybrid/graph), mirroring SearchResult::recall: we never claim a recall we did not measure.

Fields§

§route: &'static str

the route taken: “exact” | “hnsw” | “graph” | “hybrid”.

§exact_candidates: usize

exact-flat candidates considered (the whole corpus on the exact path and the graph seed path; 0 when the path used an ann shortlist).

§ann_candidates: usize

ann shortlist size (hnsw / hybrid vector path); 0 otherwise.

§bm25_candidates: usize

bm25 lexical shortlist size (hybrid path); 0 otherwise.

§graph_candidates: usize

graph bfs frontier union size (graph path); 0 otherwise.

§fusion_mode: &'static str

how the candidate lists were combined: “none” | “rrf”.

§rerank_source: RerankSourceKind

the precision the mandatory exact rerank read from. the honesty backbone: see RerankSourceKind.

§recall_estimate: f32

1.0 on the exact path, NaN on every candidate-generating path (we never claim a recall we did not measure).

Trait Implementations§

Source§

impl Clone for SearchExplain

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for SearchExplain

Source§

impl Debug for SearchExplain

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for SearchExplain

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for SearchExplain

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.