Skip to main content

MultiVectorRetriever

Struct MultiVectorRetriever 

Source
pub struct MultiVectorRetriever<E: MultiVectorEmbedder> { /* private fields */ }
Expand description

Multi-vector retriever using WARP index for ColBERT-style late interaction.

This retriever uses token-level embeddings and MaxSim scoring for fine-grained semantic matching. Unlike single-vector dense retrieval, multi-vector approaches represent documents and queries as multiple token embeddings.

§Example

use trueno_rag::multivector::{
    WarpIndexConfig, WarpSearchConfig,
    MockMultiVectorEmbedder, MultiVectorRetriever,
};

let config = WarpIndexConfig::new(2, 256, 128);
let embedder = MockMultiVectorEmbedder::new(128, 512);
let mut retriever = MultiVectorRetriever::new(config, embedder);

// Train on sample documents
retriever.train(&sample_chunks)?;

// Index documents
for chunk in chunks {
    retriever.index(chunk)?;
}
retriever.build()?;

// Search
let results = retriever.retrieve("What is machine learning?", 10)?;

Implementations§

Source§

impl<E: MultiVectorEmbedder> MultiVectorRetriever<E>

Source

pub fn new(config: WarpIndexConfig, embedder: E) -> Self

Create a new multi-vector retriever with the given configuration and embedder.

§Arguments
  • config - WARP index configuration (nbits, num_centroids, token_dim)
  • embedder - Multi-vector embedder for generating token embeddings
Source

pub fn with_search_config(self, config: WarpSearchConfig) -> Self

Set the search configuration.

Source

pub fn train(&mut self, sample_chunks: &[Chunk]) -> Result<()>

Train the WARP index on sample chunks.

This builds the residual quantization codec by learning centroids from the provided sample embeddings. Should be called before indexing.

§Arguments
  • sample_chunks - Representative chunks for training the codec
Source

pub fn index(&mut self, chunk: Chunk) -> Result<()>

Index a single chunk.

The chunk is embedded and compressed using the trained codec. Call train() before indexing.

Source

pub fn index_batch(&mut self, chunks: Vec<Chunk>) -> Result<()>

Index multiple chunks.

Source

pub fn build(&mut self) -> Result<()>

Build the index for efficient search.

This compacts the index by organizing embeddings by centroid (IVF structure). Call after all chunks have been indexed.

Source

pub fn retrieve(&self, query: &str, k: usize) -> Result<Vec<RetrievalResult>>

Retrieve relevant chunks for a query using multi-vector MaxSim scoring.

§Arguments
  • query - Query text
  • k - Number of results to return
Source

pub fn len(&self) -> usize

Get the number of indexed chunks.

Source

pub fn is_empty(&self) -> bool

Check if the retriever is empty.

Source

pub fn warp_index(&self) -> &WarpIndex

Get the underlying WARP index.

Source

pub fn embedder(&self) -> &E

Get the embedder.

Source

pub fn memory_usage(&self) -> usize

Get memory usage statistics.

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<T> Downcast<T> for T

Source§

fn downcast(&self) -> &T

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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<F, T> IntoSample<T> for F
where T: FromSample<F>,

Source§

fn into_sample(self) -> T

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: 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: 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> Same for T

Source§

type Output = T

Should always be Self
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<T> Upcast<T> for T

Source§

fn upcast(&self) -> Option<&T>

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

impl<T> WasmNotSend for T
where T: Send,

Source§

impl<T> WasmNotSendSync for T

Source§

impl<T> WasmNotSync for T
where T: Sync,