Struct Index 

pub struct Index {
    pub params: IndexParams,
    pub codec: ResidualCodec,
    pub doc_ids: Vec<u64>,
    pub doc_tokens: Vec<Vec<EncodedVector>>,
    pub ivf: InvertedFile,
}

A fully-built PLAID index over a corpus of multi-vector embeddings.

Holds the trained codec, the encoded token embeddings of every document, and an inverted file mapping centroids back to the tokens clustered in them. Future layers (search) will read from this state directly without mutating it.

Fields

params: IndexParams

codec: ResidualCodec

doc_ids: Vec<u64>

doc_tokens: Vec<Vec<EncodedVector>>

doc_tokens[i] is the encoded token sequence of the i-th document.

ivf: InvertedFile

Centroid → tokens inverted file used for candidate generation.

Implementations

impl Index

pub fn num_documents(&self) -> usize

Number of documents currently stored in the index.

pub fn num_tokens(&self) -> usize

Total number of encoded tokens across all documents.

pub fn position_of(&self, doc_id: u64) -> Option<usize>

Find the position of a document inside Index::doc_ids.

Trait Implementations

impl Clone for Index

fn clone(&self) -> Index

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Index

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

Formats the value using the given formatter.