daimon 0.16.0

A Rust-native AI agent framework
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
41
42
43

//! The Retriever trait and object-safe wrapper.

use std::future::Future;
use std::pin::Pin;
use std::sync::Arc;

use crate::error::Result;
use crate::retriever::types::Document;

/// Trait for document retrieval backends (vector stores, search engines, etc.).
///
/// Implement this for your storage backend, then wrap with
/// [`RetrieverTool`](super::RetrieverTool) to expose it to agents.
pub trait Retriever: Send + Sync {
    /// Retrieves up to `top_k` documents relevant to `query`.
    fn retrieve(
        &self,
        query: &str,
        top_k: usize,
    ) -> impl Future<Output = Result<Vec<Document>>> + Send;
}

/// Object-safe wrapper for [`Retriever`].
pub trait ErasedRetriever: Send + Sync {
    fn retrieve_erased<'a>(
        &'a self,
        query: &'a str,
        top_k: usize,
    ) -> Pin<Box<dyn Future<Output = Result<Vec<Document>>> + Send + 'a>>;
}

impl<T: Retriever> ErasedRetriever for T {
    fn retrieve_erased<'a>(
        &'a self,
        query: &'a str,
        top_k: usize,
    ) -> Pin<Box<dyn Future<Output = Result<Vec<Document>>> + Send + 'a>> {
        Box::pin(self.retrieve(query, top_k))
    }
}

/// Shared ownership of a retriever.
pub type SharedRetriever = Arc<dyn ErasedRetriever>;