Struct VectorIndex 

pub struct VectorIndex { /* private fields */ }

One path holding an embedding, and the collection its vectors live in.

The collection is keyed by document id, so an answer from it is a document id and the caller never sees a second numbering.

Implementations

impl VectorIndex

pub fn path(&self) -> &[u8]

The path the embedding is read from.

pub fn dim(&self) -> usize

How many coordinates a vector here has.

pub fn metric(&self) -> Metric

What nearness means here.

pub fn len(&self) -> usize

How many documents have a vector filed.

A document with nothing at the path is not in here, so the difference between this and the collection’s length is how many documents the index does not cover.

pub fn is_empty(&self) -> bool

Whether none do.

pub fn memory_bytes(&self) -> usize

What the index costs.

pub fn collection(&self) -> &Collection

The collection underneath, for a caller that wants the vector API rather than the document one.

Trait Implementations

impl Debug for VectorIndex

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

Formats the value using the given formatter.