pub struct KeyValueHNSWIndex { /* private fields */ }Implementations§
Source§impl KeyValueHNSWIndex
impl KeyValueHNSWIndex
pub fn create( store: Arc<dyn KeyValueStore>, table: impl Into<String>, field: impl Into<String>, dimensions: u32, params: HNSWIndexParams, ) -> StorageBackendResult<Self>
pub fn restore( store: Arc<dyn KeyValueStore>, table: impl Into<String>, field: impl Into<String>, dimensions: u32, params: HNSWIndexParams, ) -> StorageBackendResult<Self>
Trait Implementations§
Source§impl VectorIndex for KeyValueHNSWIndex
impl VectorIndex for KeyValueHNSWIndex
Source§fn contains_document(&self, doc_id: DocId) -> StorageBackendResult<bool>
fn contains_document(&self, doc_id: DocId) -> StorageBackendResult<bool>
Test canonical membership at this handle’s visibility boundary without searching or materializing the corpus. Empty tensor replacements have no membership. This is a maintenance probe, not a logical query observation.
fn dimensions(&self) -> u32
fn index_kind(&self) -> &'static str
fn add(&mut self, doc_id: DocId, vector: Vec<f32>) -> StorageBackendResult<()>
fn add_many( &mut self, doc_id: DocId, vectors: Vec<Vec<f32>>, ) -> StorageBackendResult<()>
fn delete(&mut self, doc_id: DocId) -> StorageBackendResult<()>
fn clear(&mut self) -> StorageBackendResult<()>
fn search_knn( &self, query: &[f32], k: usize, ) -> StorageBackendResult<PostingList>
fn search_threshold( &self, query: &[f32], threshold: f32, ) -> StorageBackendResult<PostingList>
fn count(&self) -> StorageBackendResult<usize>
Source§fn initialize(&mut self) -> StorageBackendResult<()>
fn initialize(&mut self) -> StorageBackendResult<()>
Build any auxiliary physical metadata required by this index from its
current vector contents. Brute-force indexes need no extra work;
persistent IVF and HNSW implementations use this during explicit
index creation, while restore paths deliberately skip it.
Source§fn snapshot(&self) -> StorageBackendResult<Arc<dyn VectorIndex>>
fn snapshot(&self) -> StorageBackendResult<Arc<dyn VectorIndex>>
Read-only handle suitable for an
ExecutionContext.Source§fn search_knn_with_control(
&self,
query: &[f32],
k: usize,
control: &StorageReadControl,
) -> StorageBackendResult<PostingList>
fn search_knn_with_control( &self, query: &[f32], k: usize, control: &StorageReadControl, ) -> StorageBackendResult<PostingList>
Request a controlled search. The default checks cancellation and delegates to the provider’s existing read boundary; in-memory physical algorithms override it to charge query workspace to the supplied allowance.
Source§fn search_threshold_with_control(
&self,
query: &[f32],
threshold: f32,
control: &StorageReadControl,
) -> StorageBackendResult<PostingList>
fn search_threshold_with_control( &self, query: &[f32], threshold: f32, control: &StorageReadControl, ) -> StorageBackendResult<PostingList>
Controlled threshold search keeps the same result and caller-owned posting boundary as ordinary search.
Source§fn snapshot_with_control(
&self,
control: &StorageReadControl,
) -> StorageBackendResult<Arc<dyn VectorIndex>>
fn snapshot_with_control( &self, control: &StorageReadControl, ) -> StorageBackendResult<Arc<dyn VectorIndex>>
Capture using the caller’s retention allowance and cancellation. Owners that copy index data override this method to reserve construction before allocation. The default preserves the provider’s existing snapshot and its independently retained control.
Source§fn writable_snapshot(&self) -> StorageBackendResult<Box<dyn VectorIndex>>
fn writable_snapshot(&self) -> StorageBackendResult<Box<dyn VectorIndex>>
Independent writable copy used by in-memory engine rollback. The
default keeps third-party and persistent implementations source
compatible; only indexes hosted by a memory engine need to support it.
Auto Trait Implementations§
impl !Freeze for KeyValueHNSWIndex
impl !RefUnwindSafe for KeyValueHNSWIndex
impl !UnwindSafe for KeyValueHNSWIndex
impl Send for KeyValueHNSWIndex
impl Sync for KeyValueHNSWIndex
impl Unpin for KeyValueHNSWIndex
impl UnsafeUnpin for KeyValueHNSWIndex
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more