Struct FilesRetrievalTool 

pub struct FilesRetrievalTool { /* private fields */ }

Retrieval tool that searches through local text files.

Performs simple substring matching over file contents and returns relevant file chunks as retrieval results.

Implementations

impl FilesRetrievalTool

pub fn new(files: Vec<PathBuf>) -> Self

Create a new files retrieval tool.

pub fn with_chunk_size(self, size: usize) -> Self

Set the chunk size for splitting files.

pub fn with_chunk_overlap(self, overlap: usize) -> Self

Set the overlap between chunks.

Trait Implementations

impl BaseRetrievalTool for FilesRetrievalTool

fn name(&self) -> &str

The name of this retrieval tool.

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

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

Search the corpus with a query and return ranked results.

impl Clone for FilesRetrievalTool

fn clone(&self) -> FilesRetrievalTool

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for FilesRetrievalTool

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.