Struct SearchEngine 

pub struct SearchEngine<K, D: TokenEmbedder = u32, T = DefaultTokenizer> { /* private fields */ }

A search engine that ranks documents with BM25. K is the type of the document id, D is the type of the token embedder and T is the type of the tokenizer.

Implementations

impl<K, D, T> SearchEngine<K, D, T>

where K: Hash + Eq + Clone, D: TokenEmbedder, D::EmbeddingSpace: Eq + Hash + Clone, T: Tokenizer,

pub fn upsert(&mut self, document: impl Into<Document<K>>)

Upserts a document into the search engine. If a document with the same id already exists, it will be replaced. Note that upserting a document will change the true value of avgdl. The more avgdl drifts from its true value, the less accurate the BM25 scores will be.

pub fn remove(&mut self, document_id: &K)

Removes a document from the search engine if it exists.

pub fn get(&self, document_id: &K) -> Option<Document<K>>

Gets the contents of a document by its id.

pub fn iter(&self) -> impl Iterator<Item = Document<K>> + '_

Returns an iterator over the documents in the search engine.

pub fn search( &self, query: &str, limit: impl Into<Option<usize>>, ) -> Vec<SearchResult<K>>

Searches the documents for the given query and returns the top limit results. Only the document contents are searched, not the document ids.

Trait Implementations

impl<K: Debug, D: TokenEmbedder + Debug, T: Debug> Debug for SearchEngine<K, D, T>

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

Formats the value using the given formatter.