Skip to main content

Fusion

Enum Fusion 

Source
pub enum Fusion {
    Rrf {
        k: u32,
    },
    Weighted {
        weights: Vec<f32>,
    },
}
Expand description

How to combine several ranked SearchHit lists into one — the join point for hybrid retrieval (e.g. a dense branch plus a sparse/lexical branch).

Choose by whether the branches’ scores are comparable. Rrf looks only at ranks, so it is safe when the branches use different similarity measures (cosine vs inner product) or wildly different scales; Weighted sums raw scores and therefore assumes the branches are already on a shared scale.

§Which to use for dense + sparse

A dense branch scores by cosine similarity (range roughly 0.01.0) while a learned-lexical sparse branch scores by inner product (BGE-M3 sparse weights commonly sum to the tens or hundreds). Their scales do not agree, so fusing them with Weighted directly lets the sparse branch dominate regardless of the chosen weights. Prefer Rrf when the branches disagree on scale — it is the default for exactly this reason. If you need Weighted, normalize each branch to a shared scale first (e.g. min-max to [0,1], or softmax over the branch’s scores).

Scores are carried in SearchHit as f32. Inner-product scores are large enough that the f64 → f32 narrowing in the backends can lose precision in the low digits; this does not affect Rrf (rank-only) but is a further reason to normalize before Weighted.

Variants§

§

Rrf

Reciprocal Rank Fusion: score(d) = Σ 1 / (k + rank_i(d)) over the lists containing d, with 1-based ranks. Larger k flattens the advantage of top ranks; 60 is the conventional default.

Fields

§k: u32

Rank damping constant — larger values flatten the advantage held by top-ranked hits. 60 is the conventional default.

§

Weighted

Convex combination of raw scores, one weight per input list. A list that does not contain a hit contributes nothing for it.

All input lists must share a score scale. Do not fuse a cosine branch with a raw inner-product branch without normalizing first — see the type-level docs and Rrf for the scale-safe option.

Fields

§weights: Vec<f32>

One weight per input list, in the same order as the lists passed to fuse.

Implementations§

Source§

impl Fusion

Source

pub fn rrf() -> Self

Reciprocal Rank Fusion with the conventional k = 60.

This is the recommended default for hybrid dense + sparse retrieval: being rank-only, it is unaffected by the mismatched score scales of cosine and inner product. See the Fusion type docs.

Source

pub fn fuse(&self, hit_sets: &[Vec<SearchHit>]) -> Vec<SearchHit>

Fuse ranked lists into a single list, best first.

Every input list is expected to be sorted best-first already — RRF derives its ranks from that order. The result uses the same ordering as SearchHit itself: descending score, then ascending id.

§Panics

Weighted panics when the number of weights differs from the number of lists, mirroring search::weighted_sum_fuse: a mismatch means a branch would be silently dropped from the ranking.

Trait Implementations§

Source§

impl Clone for Fusion

Source§

fn clone(&self) -> Fusion

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 Debug for Fusion

Source§

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

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

impl PartialEq for Fusion

Source§

fn eq(&self, other: &Fusion) -> 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 Fusion

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> ErasedDestructor for T
where T: 'static,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

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

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
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> Scalar for T
where T: 'static + Clone + PartialEq + Debug,

Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more