// TODO: put primitive query part in here use std::borrow::Cow; use std::mem; use std::ops::RangeInclusive; use charabia::normalizer::NormalizedTokenIter; use charabia::{SeparatorKind, TokenKind}; use fst::automaton::Str; use fst::{Automaton, IntoStreamer, Streamer}; use heed::types::DecodeIgnore; use heed::RoTxn; use itertools::Itertools; use crate::search::fst_utils::{Complement, Intersection, StartsWith, Union}; use crate::search::{build_dfa, get_first}; use crate::{CboRoaringBitmapLenCodec, Index, Result}; #[derive(Debug, Default, Clone)] pub struct Phrase { pub words: Vec>, } impl Phrase { pub fn description(&self) -> String { self.words.iter().flatten().join(" ") } } #[derive(Debug, Clone)] pub struct WordDerivations { pub original: String, // TODO: pub prefix_of: Vec, pub synonyms: Vec, pub split_words: Option<(String, String)>, pub zero_typo: Vec, pub one_typo: Vec, pub two_typos: Vec, pub use_prefix_db: bool, } impl WordDerivations { pub fn all_derivations_except_prefix_db(&self) -> impl Iterator + Clone { self.zero_typo.iter().chain(self.one_typo.iter()).chain(self.two_typos.iter()) } fn is_empty(&self) -> bool { self.zero_typo.is_empty() && self.one_typo.is_empty() && self.two_typos.is_empty() && !self.use_prefix_db } } pub fn word_derivations( index: &Index, txn: &RoTxn, word: &str, max_typo: u8, is_prefix: bool, fst: &fst::Set>, ) -> Result { let use_prefix_db = is_prefix && index.word_prefix_docids.remap_data_type::().get(txn, word)?.is_some(); let mut zero_typo = vec![]; let mut one_typo = vec![]; let mut two_typos = vec![]; if max_typo == 0 { if is_prefix && !use_prefix_db { let prefix = Str::new(word).starts_with(); let mut stream = fst.search(prefix).into_stream(); while let Some(word) = stream.next() { let word = std::str::from_utf8(word)?; zero_typo.push(word.to_string()); } } else if fst.contains(word) { zero_typo.push(word.to_string()); } } else if max_typo == 1 { let dfa = build_dfa(word, 1, is_prefix); let starts = StartsWith(Str::new(get_first(word))); let mut stream = fst.search_with_state(Intersection(starts, &dfa)).into_stream(); while let Some((word, state)) = stream.next() { let word = std::str::from_utf8(word)?; let d = dfa.distance(state.1); match d.to_u8() { 0 => { zero_typo.push(word.to_string()); } 1 => { one_typo.push(word.to_string()); } _ => panic!(), } } } else { let starts = StartsWith(Str::new(get_first(word))); let first = Intersection(build_dfa(word, 1, is_prefix), Complement(&starts)); let second_dfa = build_dfa(word, 2, is_prefix); let second = Intersection(&second_dfa, &starts); let automaton = Union(first, &second); let mut stream = fst.search_with_state(automaton).into_stream(); while let Some((found_word, state)) = stream.next() { let found_word = std::str::from_utf8(found_word)?; // in the case the typo is on the first letter, we know the number of typo // is two if get_first(found_word) != get_first(word) { two_typos.push(found_word.to_string()); } else { // Else, we know that it is the second dfa that matched and compute the // correct distance let d = second_dfa.distance((state.1).0); match d.to_u8() { 0 => { zero_typo.push(found_word.to_string()); } 1 => { one_typo.push(found_word.to_string()); } 2 => { two_typos.push(found_word.to_string()); } _ => panic!(), } } } } let split_words = split_best_frequency(index, txn, word)?; let synonyms = index.synonyms(txn)?; let synonyms = synonyms .get(&vec![word.to_owned()]) .cloned() .unwrap_or_default() .into_iter() .map(|words| Phrase { words: words.into_iter().map(Some).collect() }) .collect(); Ok(WordDerivations { original: word.to_owned(), synonyms, split_words, zero_typo, one_typo, two_typos, use_prefix_db, }) } fn split_best_frequency( index: &Index, txn: &RoTxn, original: &str, ) -> Result> { let chars = original.char_indices().skip(1); let mut best = None; for (i, _) in chars { let (left, right) = original.split_at(i); let key = (1, left, right); let frequency = index .word_pair_proximity_docids .remap_data_type::() .get(txn, &key)? .unwrap_or(0); if frequency != 0 && best.map_or(true, |(old, _, _)| frequency > old) { best = Some((frequency, left, right)); } } Ok(best.map(|(_, left, right)| (left.to_owned(), right.to_owned()))) } #[derive(Debug, Clone)] pub enum QueryTerm { // TODO: should there be SplitWord, NGram2, and NGram3 variants? // NGram2 can have 1 typo and synonyms // NGram3 cannot have typos but can have synonyms // SplitWords are a phrase // Can NGrams be prefixes? Phrase { phrase: Phrase }, Word { derivations: WordDerivations }, } impl QueryTerm { pub fn original_single_word(&self) -> Option<&str> { match self { QueryTerm::Phrase { phrase: _ } => None, QueryTerm::Word { derivations } => { if derivations.is_empty() { None } else { Some(derivations.original.as_str()) } } } } } #[derive(Debug, Clone)] pub struct LocatedQueryTerm { pub value: QueryTerm, pub positions: RangeInclusive, } impl LocatedQueryTerm { pub fn is_empty(&self) -> bool { match &self.value { QueryTerm::Phrase { phrase: _ } => false, QueryTerm::Word { derivations, .. } => derivations.is_empty(), } } } pub fn located_query_terms_from_string<'transaction>( index: &Index, txn: &'transaction RoTxn, query: NormalizedTokenIter>, words_limit: Option, ) -> Result> { let authorize_typos = index.authorize_typos(txn)?; let min_len_one_typo = index.min_word_len_one_typo(txn)?; let min_len_two_typos = index.min_word_len_two_typos(txn)?; let exact_words = index.exact_words(txn)?; let fst = index.words_fst(txn)?; let nbr_typos = |word: &str| { if !authorize_typos || word.len() < min_len_one_typo as usize || exact_words.as_ref().map_or(false, |fst| fst.contains(word)) { 0 } else if word.len() < min_len_two_typos as usize { 1 } else { 2 } }; let derivations = |word: &str, is_prefix: bool| { word_derivations(index, txn, word, nbr_typos(word), is_prefix, &fst) }; let mut primitive_query = Vec::new(); let mut phrase = Vec::new(); let mut quoted = false; let parts_limit = words_limit.unwrap_or(usize::MAX); let mut position = -1i8; let mut phrase_start = -1i8; let mut phrase_end = -1i8; let mut peekable = query.peekable(); while let Some(token) = peekable.next() { // early return if word limit is exceeded if primitive_query.len() >= parts_limit { return Ok(primitive_query); } match token.kind { TokenKind::Word | TokenKind::StopWord => { position += 1; // 1. if the word is quoted we push it in a phrase-buffer waiting for the ending quote, // 2. if the word is not the last token of the query and is not a stop_word we push it as a non-prefix word, // 3. if the word is the last token of the query we push it as a prefix word. if quoted { phrase_end = position; if phrase.is_empty() { phrase_start = position; } if let TokenKind::StopWord = token.kind { phrase.push(None); } else { // TODO: in a phrase, check that every word exists // otherwise return WordDerivations::Empty phrase.push(Some(token.lemma().to_string())); } } else if peekable.peek().is_some() { match token.kind { TokenKind::Word => { let derivations = derivations(token.lemma(), false)?; let located_term = LocatedQueryTerm { value: QueryTerm::Word { derivations }, positions: position..=position, }; primitive_query.push(located_term); } TokenKind::StopWord | TokenKind::Separator(_) | TokenKind::Unknown => {} } } else { let derivations = derivations(token.lemma(), true)?; let located_term = LocatedQueryTerm { value: QueryTerm::Word { derivations }, positions: position..=position, }; primitive_query.push(located_term); } } TokenKind::Separator(separator_kind) => { match separator_kind { SeparatorKind::Hard => { position += 1; } SeparatorKind::Soft => { position += 0; } } let quote_count = token.lemma().chars().filter(|&s| s == '"').count(); // swap quoted state if we encounter a double quote if quote_count % 2 != 0 { quoted = !quoted; } // if there is a quote or a hard separator we close the phrase. if !phrase.is_empty() && (quote_count > 0 || separator_kind == SeparatorKind::Hard) { let located_query_term = LocatedQueryTerm { value: QueryTerm::Phrase { phrase: Phrase { words: mem::take(&mut phrase) }, }, positions: phrase_start..=phrase_end, }; primitive_query.push(located_query_term); } } _ => (), } } // If a quote is never closed, we consider all of the end of the query as a phrase. if !phrase.is_empty() { let located_query_term = LocatedQueryTerm { value: QueryTerm::Phrase { phrase: Phrase { words: mem::take(&mut phrase) } }, positions: phrase_start..=phrase_end, }; primitive_query.push(located_query_term); } Ok(primitive_query) } // TODO: return a word derivations instead? pub fn ngram2(x: &LocatedQueryTerm, y: &LocatedQueryTerm) -> Option<(String, RangeInclusive)> { if *x.positions.end() != y.positions.start() - 1 { return None; } match (&x.value.original_single_word(), &y.value.original_single_word()) { (Some(w1), Some(w2)) => { let term = (format!("{w1}{w2}"), *x.positions.start()..=*y.positions.end()); Some(term) } _ => None, } } pub fn ngram3( x: &LocatedQueryTerm, y: &LocatedQueryTerm, z: &LocatedQueryTerm, ) -> Option<(String, RangeInclusive)> { if *x.positions.end() != y.positions.start() - 1 || *y.positions.end() != z.positions.start() - 1 { return None; } match ( &x.value.original_single_word(), &y.value.original_single_word(), &z.value.original_single_word(), ) { (Some(w1), Some(w2), Some(w3)) => { let term = (format!("{w1}{w2}{w3}"), *x.positions.start()..=*z.positions.end()); Some(term) } _ => None, } }