Skip to main content

Module vector

Module vector 

Source
Expand description

Vector search implementation using approximate nearest neighbor algorithms.

This module provides vector (semantic) search functionality through various index structures (Flat, HNSW, IVF), supporting cosine similarity, Euclidean distance, and other distance metrics.

§Module Structure

  • core: Core data structures (vector, distance, quantization)
  • index: Index management (config, factory, traits, flat, hnsw, ivf)
  • search: Search execution (similarity, ranking, result processing)
  • store: High-level store interface
  • writer: Index writer trait

Re-exports§

pub use core::distance::DistanceMetric;
pub use core::field::FieldOption;
pub use core::field::FlatOption;
pub use core::field::HnswOption;
pub use core::field::IvfOption;
pub use core::vector::StoredVector;
pub use core::vector::Vector;
pub use index::config::FlatIndexConfig;
pub use index::config::HnswIndexConfig;
pub use index::config::IvfIndexConfig;
pub use index::flat::searcher::FlatVectorSearcher;
pub use index::flat::writer::FlatIndexWriter;
pub use index::hnsw::reader::HnswIndexReader;
pub use index::hnsw::searcher::HnswSearcher;
pub use index::hnsw::writer::HnswIndexWriter;
pub use index::ivf::searcher::IvfSearcher;
pub use query::VectorQueryParser;
pub use query::VectorSearchRequestBuilder;
pub use search::searcher::VectorIndexQuery;
pub use search::searcher::VectorIndexQueryResults;
pub use search::searcher::VectorIndexSearcher;
pub use search::searcher::VectorSearchQuery;
pub use search::searcher::VectorSearchRequest;
pub use store::VectorStore;
pub use store::config::VectorFieldConfig;
pub use store::config::VectorIndexConfig;
pub use store::request::QueryVector;
pub use store::request::VectorScoreMode;
pub use store::response::VectorSearchResults;
pub use writer::VectorIndexWriter;
pub use writer::VectorIndexWriterConfig;

Modules§

core
Core data structures for vector search.
index
Vector indexing module for building and maintaining vector indexes.
query
Vector query module.
reader
Vector index reader traits and implementations.
search
Vector search module for executing similarity searches on vector indexes.
store
VectorStore: Simplified vector storage following LexicalStore pattern.
writer
Vector index writer trait and common types.