Skip to main content

VectorStore

Struct VectorStore 

Source
pub struct VectorStore { /* private fields */ }
Expand description

Enhanced vector store with embedding management and advanced features

Implementations§

Source§

impl VectorStore

Source

pub fn new() -> Self

Create a new vector store with default memory index

Source

pub fn with_embedding_strategy(strategy: EmbeddingStrategy) -> Result<Self>

Create vector store with specific embedding strategy

Source

pub fn with_index(index: Box<dyn VectorIndex>) -> Self

Create vector store with custom index

Source

pub fn with_index_and_embeddings( index: Box<dyn VectorIndex>, strategy: EmbeddingStrategy, ) -> Result<Self>

Create vector store with custom index and embedding strategy

Source

pub fn with_config(self, config: VectorStoreConfig) -> Self

Set vector store configuration

Source

pub fn index_resource(&mut self, uri: String, content: &str) -> Result<()>

Index a resource with automatic embedding generation

Source

pub fn index_rdf_resource( &mut self, uri: String, label: Option<String>, description: Option<String>, properties: HashMap<String, Vec<String>>, ) -> Result<()>

Index an RDF resource with structured content

Source

pub fn index_vector(&mut self, uri: String, vector: Vector) -> Result<()>

Index a pre-computed vector

Search for similar resources using text query

Source

pub fn similarity_search_vector( &self, query: &Vector, limit: usize, ) -> Result<Vec<(String, f32)>>

Search for similar resources using a vector query

Find resources within similarity threshold

Advanced search with multiple options

Source

pub fn embedding_stats(&self) -> Option<(usize, usize)>

Get embedding manager statistics

Source

pub fn build_vocabulary(&mut self, documents: &[String]) -> Result<()>

Build vocabulary for TF-IDF embeddings

Source

pub fn calculate_similarity(&self, uri1: &str, uri2: &str) -> Result<f32>

Calculate similarity between two resources by their URIs

Source

pub fn get_vector(&self, id: &str) -> Option<&Vector>

Get a vector by its ID (delegates to VectorIndex)

Source

pub fn iter_vectors(&self) -> Vec<(String, Vector)>

Iterate all (id, vector) pairs stored in the underlying index.

Only index types that override VectorIndex::iter_vectors (e.g. MemoryVectorIndex) return a non-empty list; other implementations return an empty Vec by default.

Source

pub fn index_vector_with_metadata( &mut self, uri: String, vector: Vector, _metadata: HashMap<String, String>, ) -> Result<()>

Index a vector with metadata (stub)

Source

pub fn index_resource_with_metadata( &mut self, uri: String, content: &str, _metadata: HashMap<String, String>, ) -> Result<()>

Index a resource with metadata (stub)

Source

pub fn similarity_search_with_params( &self, query: &str, limit: usize, _params: HashMap<String, String>, ) -> Result<Vec<(String, f32)>>

Search with additional parameters (stub)

Source

pub fn vector_search_with_params( &self, query: &Vector, limit: usize, _params: HashMap<String, String>, ) -> Result<Vec<(String, f32)>>

Vector search with additional parameters (stub)

Source

pub fn get_vector_ids(&self) -> Result<Vec<String>>

Get all vector IDs (stub)

Source

pub fn remove_vector(&mut self, uri: &str) -> Result<()>

Remove a vector by its URI (stub)

Source

pub fn get_statistics(&self) -> Result<HashMap<String, String>>

Get store statistics (stub)

Source

pub fn save_to_disk(&self, path: &str) -> Result<()>

Save store to disk.

Creates {path}/metadata.json (config + vector count) and {path}/vectors.json (all (id, Vector) pairs). The embedding manager (in-memory cache only) is not persisted; call with_embedding_strategy again after loading if needed.

Only index types that report VectorIndex::supports_enumeration as true (e.g. MemoryVectorIndex, HnswIndex, IvfIndex, PQIndex) can be saved this way. Index types that cannot enumerate their vectors cause this to return an error rather than silently persisting an empty (and misleading) snapshot.

Source

pub fn load_from_disk(path: &str) -> Result<Self>

Load a store that was previously saved with VectorStore::save_to_disk.

Reconstructs a VectorStore backed by a fresh MemoryVectorIndex and re-inserts all vectors from the saved snapshot. The embedding manager is not restored; create a new one with with_embedding_strategy if needed.

Source

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

Optimize the underlying index (stub)

Trait Implementations§

Source§

impl Default for VectorStore

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl VectorStoreTrait for VectorStore

Source§

fn insert_vector(&mut self, id: VectorId, vector: Vector) -> Result<()>

Insert a vector with metadata
Source§

fn add_vector(&mut self, vector: Vector) -> Result<VectorId>

Add a vector and return its ID
Source§

fn get_vector(&self, id: &VectorId) -> Result<Option<Vector>>

Get a vector by its ID
Source§

fn get_all_vector_ids(&self) -> Result<Vec<VectorId>>

Get all vector IDs
Source§

fn search_similar( &self, query: &Vector, k: usize, ) -> Result<Vec<(VectorId, f32)>>

Search for similar vectors
Source§

fn remove_vector(&mut self, id: &VectorId) -> Result<bool>

Remove a vector by ID
Source§

fn len(&self) -> usize

Get the number of vectors stored
Source§

fn is_empty(&self) -> bool

Check if the store is empty

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<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

Source§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

Source§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

Source§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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<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: Sized + 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: Sized + 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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<R, P> ReadPrimitive<R> for P
where R: Read + ReadEndian<P>, P: Default,

Source§

fn read_from_little_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_little_endian().
Source§

fn read_from_big_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_big_endian().
Source§

fn read_from_native_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_native_endian().
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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> Ungil for T
where T: Send,

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