1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

use async_trait::async_trait;

use crate::semantic_router::{IndexError, Router};

#[async_trait]
pub trait Index {
    async fn add(&mut self, router: &[Router]) -> Result<(), IndexError>;

    async fn delete(&mut self, route_name: &str) -> Result<(), IndexError>;

    /// Query the index with a vector and return the top_k most similar routes.
    /// Returns a list of tuples with the route name and the similarity score.
    /// Result<Vec<(route_name,similarity_score)>>
    async fn query(&self, vector: &[f64], top_k: usize) -> Result<Vec<(String, f64)>, IndexError>;

    async fn get_routers(&self) -> Result<Vec<Router>, IndexError>;

    async fn get_router(&self, route_name: &str) -> Result<Router, IndexError>;

    async fn delete_index(&mut self) -> Result<(), IndexError>;
}