Trait VectorStoreIndex 

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

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

Trait for querying a vector store by similarity.

Required Associated Types

type Filter: SearchFilter + WasmCompatSend + WasmCompatSync

The filter type for this backend.

Required Methods

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

where T: for<'a> Deserialize<'a> + WasmCompatSend,

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

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".

Implementors

impl VectorStoreIndex for BarrierMockToolIndex

Available on crate feature test-utils only.

type Filter = Filter<Value>

impl VectorStoreIndex for MockToolIndex

Available on crate feature test-utils only.

type Filter = Filter<Value>

impl<M, D> VectorStoreIndex for InMemoryVectorIndex<M, D>

where M: EmbeddingModel + Sync, D: Serialize + Sync + Send + Eq,

type Filter = Filter<Value>