VectorStoreIndex

rig::vector_store

Trait VectorStoreIndex 

Source 
pub trait VectorStoreIndex: WasmCompatSend + WasmCompatSync {
    type Filter: SearchFilter + WasmCompatSend + WasmCompatSync;

    // Required methods
    fn top_n<T: for<'a> Deserialize<'a> + WasmCompatSend>(
        &self,
        req: VectorSearchRequest<Self::Filter>,
    ) -> impl Future<Output = Result<Vec<(f64, String, T)>, VectorStoreError>> + WasmCompatSend;
    fn top_n_ids(
        &self,
        req: VectorSearchRequest<Self::Filter>,
    ) -> impl Future<Output = Result<Vec<(f64, String)>, VectorStoreError>> + WasmCompatSend;
}
Expand description

Trait for querying a vector store by similarity.

Required Associated Types§

Source

type Filter: SearchFilter + WasmCompatSend + WasmCompatSync

The filter type for this backend.

Required Methods§

Source

fn top_n<T: for<'a> Deserialize<'a> + WasmCompatSend>( &self, req: VectorSearchRequest<Self::Filter>, ) -> impl Future<Output = Result<Vec<(f64, String, T)>, VectorStoreError>> + WasmCompatSend

Returns the top N most similar documents as (score, id, document) tuples.

Source

fn top_n_ids( &self, req: VectorSearchRequest<Self::Filter>, ) -> impl Future<Output = Result<Vec<(f64, String)>, VectorStoreError>> + WasmCompatSend

Returns the top N most similar document IDs as (score, id) tuples.

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors§