Struct ParentDocumentRetriever 

pub struct ParentDocumentRetriever { /* private fields */ }

Splits parent documents into children, stores both, and returns parent documents when child chunks match a query.

Accepts a splitting function Fn(&str) -> Vec<String> to avoid circular dependencies on synapse-splitters.

Implementations

impl ParentDocumentRetriever

pub fn new( child_retriever: Arc<dyn Retriever>, splitter: impl Fn(&str) -> Vec<String> + Send + Sync + 'static, ) -> Self

pub async fn add_documents(&self, parents: Vec<Document>) -> Vec<Document>

Add parent documents: splits each into children and stores mappings. Returns the child documents for indexing into the child retriever.

Trait Implementations

impl Retriever for ParentDocumentRetriever

fn retrieve<'life0, 'life1, 'async_trait>( &'life0 self, query: &'life1 str, top_k: usize, ) -> Pin<Box<dyn Future<Output = Result<Vec<Document>, SynapseError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,