pub struct FaissIndex { /* private fields */ }Expand description
FAISS vector index implementation
Implementations§
Source§impl FaissIndex
impl FaissIndex
Sourcepub fn new(config: FaissConfig) -> Result<Self>
pub fn new(config: FaissConfig) -> Result<Self>
Create a new FAISS index
Sourcepub fn train(&self, training_vectors: &[Vec<f32>]) -> Result<()>
pub fn train(&self, training_vectors: &[Vec<f32>]) -> Result<()>
Train the FAISS index with sample data
Sourcepub fn add_vectors(
&self,
vectors: Vec<Vec<f32>>,
ids: Vec<String>,
) -> Result<()>
pub fn add_vectors( &self, vectors: Vec<Vec<f32>>, ids: Vec<String>, ) -> Result<()>
Add vectors to the FAISS index
Sourcepub fn search(
&self,
query_vector: &[f32],
params: &FaissSearchParams,
) -> Result<Vec<(String, f32)>>
pub fn search( &self, query_vector: &[f32], params: &FaissSearchParams, ) -> Result<Vec<(String, f32)>>
Search for similar vectors
Sourcepub fn get_statistics(&self) -> Result<FaissStatistics>
pub fn get_statistics(&self) -> Result<FaissStatistics>
Get performance statistics
Sourcepub fn save_index(&self, path: &Path) -> Result<()>
pub fn save_index(&self, path: &Path) -> Result<()>
Save index to disk
Sourcepub fn load_index(&self, path: &Path) -> Result<()>
pub fn load_index(&self, path: &Path) -> Result<()>
Load index from disk
Sourcepub fn get_memory_usage(&self) -> Result<usize>
pub fn get_memory_usage(&self) -> Result<usize>
Get current memory usage
Trait Implementations§
Source§impl VectorIndex for FaissIndex
impl VectorIndex for FaissIndex
Source§fn insert(&mut self, uri: String, vector: Vector) -> Result<()>
fn insert(&mut self, uri: String, vector: Vector) -> Result<()>
Insert a vector with associated URI
Source§fn search_knn(&self, query: &Vector, k: usize) -> Result<Vec<(String, f32)>>
fn search_knn(&self, query: &Vector, k: usize) -> Result<Vec<(String, f32)>>
Find k nearest neighbors
Source§fn search_threshold(
&self,
query: &Vector,
threshold: f32,
) -> Result<Vec<(String, f32)>>
fn search_threshold( &self, query: &Vector, threshold: f32, ) -> Result<Vec<(String, f32)>>
Find all vectors within threshold similarity
Source§fn add_vector(
&mut self,
id: VectorId,
vector: Vector,
_metadata: Option<HashMap<String, String>>,
) -> Result<()>
fn add_vector( &mut self, id: VectorId, vector: Vector, _metadata: Option<HashMap<String, String>>, ) -> Result<()>
Add a vector with associated ID and metadata
Source§fn update_vector(&mut self, id: VectorId, vector: Vector) -> Result<()>
fn update_vector(&mut self, id: VectorId, vector: Vector) -> Result<()>
Update an existing vector
Auto Trait Implementations§
impl Freeze for FaissIndex
impl RefUnwindSafe for FaissIndex
impl Send for FaissIndex
impl Sync for FaissIndex
impl Unpin for FaissIndex
impl UnwindSafe for FaissIndex
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
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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 moreSource§impl<T> Pointable for T
impl<T> Pointable for T
Source§impl<T> PolicyExt for Twhere
T: ?Sized,
impl<T> PolicyExt for Twhere
T: ?Sized,
Source§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
Source§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct
self from the equivalent element of its
superset. Read moreSource§fn is_in_subset(&self) -> bool
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
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
fn from_subset(element: &SS) -> SP
The inclusion map: converts
self to the equivalent element of its superset.