khive-storage 0.2.8

Storage capability traits: SqlAccess, VectorStore, TextSearch. Zero implementations — only contracts.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40

//! Sparse vector storage and lexical-semantic search capability.

use async_trait::async_trait;
use uuid::Uuid;

use khive_types::SubstrateKind;

use crate::types::{
    BatchWriteSummary, SparseRecord, SparseSearchHit, SparseSearchRequest, SparseVector,
    StorageResult,
};

/// Sparse vector storage and lexical-semantic search capability.
#[async_trait]
pub trait SparseStore: Send + Sync + 'static {
    /// Insert a single sparse vector for a subject.
    async fn insert_sparse(
        &self,
        subject_id: Uuid,
        kind: SubstrateKind,
        namespace: &str,
        field: &str,
        vector: SparseVector,
    ) -> StorageResult<()>;

    /// Insert a batch of sparse vector records.
    async fn insert_batch(&self, records: Vec<SparseRecord>) -> StorageResult<BatchWriteSummary>;

    /// Delete the sparse vector for a subject.
    async fn delete(&self, subject_id: Uuid) -> StorageResult<bool>;

    /// Search over sparse vectors using a sparse query.
    async fn search_sparse(
        &self,
        request: SparseSearchRequest,
    ) -> StorageResult<Vec<SparseSearchHit>>;

    /// Count total sparse vector entries.
    async fn count(&self) -> StorageResult<u64>;
}