Struct Collection 

pub struct Collection { /* private fields */ }

A collection of vectors with associated metadata.

Implementations

impl Collection

pub fn create( path: PathBuf, dimension: usize, metric: DistanceMetric, ) -> Result<Self>

Creates a new collection at the specified path.

Errors

Returns an error if the directory cannot be created or the config cannot be saved.

pub fn open(path: PathBuf) -> Result<Self>

Opens an existing collection from the specified path.

Errors

Returns an error if the config file cannot be read or parsed.

pub fn config(&self) -> CollectionConfig

Returns the collection configuration.

pub fn upsert(&self, points: Vec<Point>) -> Result<()>

Inserts or updates points in the collection.

Errors

Returns an error if any point has a mismatched dimension.

pub fn get(&self, ids: &[u64]) -> Vec<Option<Point>>

Retrieves points by their IDs.

pub fn delete(&self, ids: &[u64]) -> Result<()>

Deletes points by their IDs.

Errors

Returns an error if storage operations fail.

pub fn search(&self, query: &[f32], k: usize) -> Result<Vec<SearchResult>>

Searches for the k nearest neighbors of the query vector.

Uses HNSW index for fast approximate nearest neighbor search.

Errors

Returns an error if the query vector dimension doesn’t match the collection.

pub fn len(&self) -> usize

Returns the number of points in the collection.

pub fn is_empty(&self) -> bool

Returns true if the collection is empty.

pub fn flush(&self) -> Result<()>

Saves the collection configuration and index to disk.

Errors

Returns an error if storage operations fail.

pub fn text_search(&self, query: &str, k: usize) -> Vec<SearchResult>

Performs full-text search using BM25.

Arguments

• query - Text query to search for
• k - Maximum number of results to return

Returns

Vector of search results sorted by BM25 score (descending).

pub fn hybrid_search( &self, vector_query: &[f32], text_query: &str, k: usize, vector_weight: Option<f32>, ) -> Result<Vec<SearchResult>>

Performs hybrid search combining vector similarity and full-text search.

Uses Reciprocal Rank Fusion (RRF) to combine results from both searches.

Arguments

• vector_query - Query vector for similarity search
• text_query - Text query for BM25 search
• k - Maximum number of results to return
• vector_weight - Weight for vector results (0.0-1.0, default 0.5)

Errors

Returns an error if the query vector dimension doesn’t match.

Trait Implementations

impl Clone for Collection

fn clone(&self) -> Collection

Returns a duplicate of the value.

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

Performs copy-assignment from source.