Trait VectorStoreIndex 

pub trait VectorStoreIndex: Send + Sync {
    // Required methods
    fn top_n<T: for<'a> Deserialize<'a> + Send>(
        &self,
        query: &str,
        n: usize,
    ) -> impl Future<Output = Result<Vec<(f64, String, T)>, VectorStoreError>> + Send;
    fn top_n_ids(
        &self,
        query: &str,
        n: usize,
    ) -> impl Future<Output = Result<Vec<(f64, String)>, VectorStoreError>> + Send;
}

Trait for vector store indexes

Required Methods

fn top_n<T: for<'a> Deserialize<'a> + Send>( &self, query: &str, n: usize, ) -> impl Future<Output = Result<Vec<(f64, String, T)>, VectorStoreError>> + Send

Get the top n documents based on the distance to the given query. The result is a list of tuples of the form (score, id, document)

fn top_n_ids( &self, query: &str, n: usize, ) -> impl Future<Output = Result<Vec<(f64, String)>, VectorStoreError>> + Send

Same as top_n but returns the document ids only.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementors

impl<M: EmbeddingModel + Sync, D: Serialize + Sync + Send + Eq> VectorStoreIndex for InMemoryVectorIndex<M, D>