Struct SearchFilters 

pub struct SearchFilters { /* private fields */ }

Metadata narrowing applied to search hits after ranking.

Neither the vector index nor BM25 knows about languages or chunk kinds, so narrowing happens here, against the chunk each hit resolves to. Because it runs after ranking, the ranker has to be asked for more candidates than the caller wants - see fetch_size.

use semtree_rag::SearchFilters;

let filters = SearchFilters::default()
    .with_language_names(["rust"])?
    .with_kind_names(["fn"])?
    .with_path("src/");

Implementations

impl SearchFilters

pub fn with_languages( self, languages: impl IntoIterator<Item = Language>, ) -> Self

Keep only chunks in these languages. Empty means “any”.

pub fn with_kinds(self, kinds: impl IntoIterator<Item = ChunkKind>) -> Self

Keep only chunks of these kinds. Empty means “any”.

pub fn with_path(self, needle: impl Into<String>) -> Self

Keep only chunks whose path contains needle.

pub fn with_language_names<S: AsRef<str>>( self, names: impl IntoIterator<Item = S>, ) -> Result<Self, RagError>

Like with_languages, from user-supplied names. An unrecognized name is an error rather than a filter that matches nothing, so a typo surfaces instead of looking like an empty index.

pub fn with_kind_names<S: AsRef<str>>( self, names: impl IntoIterator<Item = S>, ) -> Result<Self, RagError>

Like with_kinds, from user-supplied names.

pub fn is_empty(&self) -> bool

Whether every hit passes untouched.

pub fn matches(&self, chunk: &Chunk) -> bool

Whether chunk survives the filters.

pub fn fetch_size(&self, top_k: usize) -> usize

How many candidates the ranker should return so that top_k survive the filters. Unfiltered searches ask for exactly what they need.

Trait Implementations

impl Clone for SearchFilters

fn clone(&self) -> SearchFilters

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SearchFilters

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

Formats the value using the given formatter.

impl Default for SearchFilters

fn default() -> SearchFilters

Returns the “default value” for a type.