searchengines-web/MeiliSearch
searchengines-web/MeiliSearch
1
0
Fork 0
mirror of https://github.com/meilisearch/MeiliSearch synced 2024-11-10 23:18:55 +01:00
Code Issues Releases Wiki Activity

implement matches

Browse Source
This commit is contained in:
marin postma 2021-06-21 23:38:59 +02:00 committed by Tamo
parent db7215eaa9
commit 97ef4a6c22
No known key found for this signature in database
GPG Key ID: 20CD8020AFA88D69
2 changed files with 309 additions and 107 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

414
meilisearch-http/src/index/search.rs
View File

@ -6,7 +6,7 @@ use either::Either;
use heed::RoTxn;
use indexmap::IndexMap;
use meilisearch_tokenizer::{Analyzer, AnalyzerConfig, Token};
use milli::{FilterCondition, FieldId, FieldsIdsMap, MatchingWords};
use milli::{FieldId, FieldsIdsMap, FilterCondition, MatchingWords};
use serde::{Deserialize, Serialize};
use serde_json::Value;
@ -16,6 +16,13 @@ use super::error::Result;
use super::Index;
pub type Document = IndexMap<String, Value>;
type MatchesInfo = BTreeMap<String, Vec<MatchInfo>>;
#[derive(Serialize, Debug, Clone)]
pub struct MatchInfo {
start: usize,
length: usize,
}
pub const DEFAULT_SEARCH_LIMIT: usize = 20;
const fn default_search_limit() -> usize {
@ -39,7 +46,9 @@ pub struct SearchQuery {
#[serde(default = "default_crop_length")]
pub crop_length: usize,
pub attributes_to_highlight: Option<HashSet<String>>,
pub matches: Option<bool>,
// Default to false
#[serde(default = "Default::default")]
pub matches: bool,
pub filter: Option<Value>,
pub facet_distributions: Option<Vec<String>>,
}
@ -50,6 +59,8 @@ pub struct SearchHit {
pub document: Document,
#[serde(rename = "_formatted", skip_serializing_if = "Document::is_empty")]
pub formatted: Document,
#[serde(rename = "_MatchesInfo", skip_serializing_if = "Option::is_none")]
pub matches_info: Option<MatchesInfo>,
}
#[derive(Serialize)]
@ -134,13 +145,9 @@ impl Index {
.cloned()
.collect();
let attr_to_highlight = query
.attributes_to_highlight
.unwrap_or_default();
let attr_to_highlight = query.attributes_to_highlight.unwrap_or_default();
let attr_to_crop = query
.attributes_to_crop
.unwrap_or_default();
let attr_to_crop = query.attributes_to_crop.unwrap_or_default();
// Attributes in `formatted_options` correspond to the attributes that will be in `_formatted`
// These attributes are:
@ -157,8 +164,7 @@ impl Index {
);
let stop_words = fst::Set::default();
let formatter =
Formatter::new(&stop_words, (String::from("<em>"), String::from("</em>")));
let formatter = Formatter::new(&stop_words, (String::from("<em>"), String::from("</em>")));
let mut documents = Vec::new();
@ -166,6 +172,9 @@ impl Index {
for (_id, obkv) in documents_iter {
let document = make_document(&to_retrieve_ids, &fields_ids_map, obkv)?;
let matches_info = query.matches.then(|| compute_matches(&matching_words, &document));
let formatted = format_fields(
&fields_ids_map,
obkv,
@ -177,6 +186,7 @@ impl Index {
let hit = SearchHit {
document,
formatted,
matches_info,
};
documents.push(hit);
}
@ -210,6 +220,53 @@ impl Index {
}
}
fn compute_matches(matcher: &impl Matcher, document: &Document) -> MatchesInfo {
let stop_words = fst::Set::default();
let mut matches = BTreeMap::new();
let mut config = AnalyzerConfig::default();
config.stop_words(&stop_words);
let analyzer = Analyzer::new(config);
for (key, value) in document {
let mut infos = Vec::new();
compute_value_matches(&mut infos, value, matcher, &analyzer);
if !infos.is_empty() {
matches.insert(key.clone(), infos);
}
}
matches
}
fn compute_value_matches<'a, A: AsRef<[u8]>>(
infos: &mut Vec<MatchInfo>,
value: &Value,
matcher: &impl Matcher,
analyzer: &Analyzer<'a, A>,
) {
match value {
Value::String(s) => {
let analyzed = analyzer.analyze(s);
let mut start = 0;
for (word, token) in analyzed.reconstruct() {
if token.is_word() {
if let Some(length) = matcher.matches(token.text()) {
infos.push(MatchInfo { start, length });
}
}
start += word.len();
}
}
Value::Array(vals) => vals
.iter()
.for_each(|val| compute_value_matches(infos, val, matcher, analyzer)),
Value::Object(vals) => vals
.values()
.for_each(|val| compute_value_matches(infos, val, matcher, analyzer)),
_ => (),
}
}
fn compute_formatted_options(
attr_to_highlight: &HashSet<String>,
attr_to_crop: &[String],
@ -217,8 +274,7 @@ fn compute_formatted_options(
to_retrieve_ids: &BTreeSet<u8>,
fields_ids_map: &FieldsIdsMap,
displayed_ids: &BTreeSet<u8>,
) -> BTreeMap<FieldId, FormatOptions> {
) -> BTreeMap<FieldId, FormatOptions> {
let mut formatted_options = BTreeMap::new();
add_highlight_to_formatted_options(
@ -238,10 +294,7 @@ fn compute_formatted_options(
// Should not return `_formatted` if no valid attributes to highlight/crop
if !formatted_options.is_empty() {
add_non_formatted_ids_to_formatted_options(
&mut formatted_options,
to_retrieve_ids,
);
add_non_formatted_ids_to_formatted_options(&mut formatted_options, to_retrieve_ids);
}
formatted_options
@ -287,7 +340,7 @@ fn add_crop_to_formatted_options(
Some((len, name)) => {
let crop_len = len.parse::<usize>().unwrap_or(crop_length);
(name, crop_len)
},
}
None => (attr.as_str(), crop_length),
};
@ -319,15 +372,13 @@ fn add_crop_to_formatted_options(
fn add_non_formatted_ids_to_formatted_options(
formatted_options: &mut BTreeMap<FieldId, FormatOptions>,
to_retrieve_ids: &BTreeSet<u8>
to_retrieve_ids: &BTreeSet<u8>,
) {
for id in to_retrieve_ids {
formatted_options
.entry(*id)
.or_insert(FormatOptions {
highlight: false,
crop: None,
});
formatted_options.entry(*id).or_insert(FormatOptions {
highlight: false,
crop: None,
});
}
}
@ -337,6 +388,7 @@ fn make_document(
obkv: obkv::KvReader,
) -> Result<Document> {
let mut document = Document::new();
for attr in attributes_to_retrieve {
if let Some(value) = obkv.get(*attr) {
let value = serde_json::from_slice(value)?;
@ -367,11 +419,7 @@ fn format_fields<A: AsRef<[u8]>>(
if let Some(value) = obkv.get(*id) {
let mut value: Value = serde_json::from_slice(value)?;
value = formatter.format_value(
value,
matching_words,
*format,
);
value = formatter.format_value(value, matching_words, *format);
// This unwrap must be safe since we got the ids from the fields_ids_map just
// before.
@ -428,20 +476,40 @@ impl<'a, A: AsRef<[u8]>> Formatter<'a, A> {
) -> Value {
match value {
Value::String(old_string) => {
let value =
self.format_string(old_string, matcher, format_options);
let value = self.format_string(old_string, matcher, format_options);
Value::String(value)
}
Value::Array(values) => Value::Array(
values
.into_iter()
.map(|v| self.format_value(v, matcher, FormatOptions { highlight: format_options.highlight, crop: None }))
.map(|v| {
self.format_value(
v,
matcher,
FormatOptions {
highlight: format_options.highlight,
crop: None,
},
)
})
.collect(),
),
Value::Object(object) => Value::Object(
object
.into_iter()
.map(|(k, v)| (k, self.format_value(v, matcher, FormatOptions { highlight: format_options.highlight, crop: None })))
.map(|(k, v)| {
(
k,
self.format_value(
v,
matcher,
FormatOptions {
highlight: format_options.highlight,
crop: None,
},
),
)
})
.collect(),
),
value => value,
@ -461,7 +529,9 @@ impl<'a, A: AsRef<[u8]>> Formatter<'a, A> {
let mut buffer = Vec::new();
let mut tokens = analyzed.reconstruct().peekable();
while let Some((word, token)) = tokens.next_if(|(_, token)| matcher.matches(token.text()).is_none()) {
while let Some((word, token)) =
tokens.next_if(|(_, token)| matcher.matches(token.text()).is_none())
{
buffer.push((word, token));
}
@ -474,19 +544,16 @@ impl<'a, A: AsRef<[u8]>> Formatter<'a, A> {
});
let mut taken_after = 0;
let after_iter = tokens
.take_while(move |(word, _)| {
let after_iter = tokens.take_while(move |(word, _)| {
let take = taken_after < crop_len;
taken_after += word.chars().count();
take
});
let iter = before_iter
.chain(Some(token))
.chain(after_iter);
let iter = before_iter.chain(Some(token)).chain(after_iter);
Box::new(iter)
},
}
// If no word matches in the attribute
None => {
let mut count = 0;
@ -505,16 +572,19 @@ impl<'a, A: AsRef<[u8]>> Formatter<'a, A> {
tokens
.map(|(word, token)| {
// Check if we need to do highlighting or computed matches before calling
// Matcher::match since the call is expensive.
if format_options.highlight && token.is_word() {
if let Some(match_len) = matcher.matches(token.text()) {
let mut new_word = String::new();
if let Some(length) = matcher.matches(token.text()) {
if format_options.highlight {
let mut new_word = String::new();
new_word.push_str(&self.marks.0);
new_word.push_str(&word[..length]);
new_word.push_str(&self.marks.1);
new_word.push_str(&word[length..]);
new_word.push_str(&self.marks.0);
new_word.push_str(&word[..match_len]);
new_word.push_str(&self.marks.1);
new_word.push_str(&word[match_len..]);
return Cow::Owned(new_word)
return Cow::Owned(new_word);
}
}
}
Cow::Borrowed(word)
@ -573,8 +643,7 @@ mod test {
#[test]
fn no_ids_no_formatted() {
let stop_words = fst::Set::default();
let formatter =
Formatter::new(&stop_words, (String::from("<em>"), String::from("</em>")));
let formatter = Formatter::new(&stop_words, (String::from("<em>"), String::from("</em>")));
let mut fields = FieldsIdsMap::new();
let id = fields.insert("test").unwrap();
@ -606,8 +675,7 @@ mod test {
#[test]
fn formatted_with_highlight_in_word() {
let stop_words = fst::Set::default();
let formatter =
Formatter::new(&stop_words, (String::from("<em>"), String::from("</em>")));
let formatter = Formatter::new(&stop_words, (String::from("<em>"), String::from("</em>")));
let mut fields = FieldsIdsMap::new();
let title = fields.insert("title").unwrap();
@ -615,19 +683,39 @@ mod test {
let mut buf = Vec::new();
let mut obkv = obkv::KvWriter::new(&mut buf);
obkv.insert(title, Value::String("The Hobbit".into()).to_string().as_bytes())
.unwrap();
obkv.insert(
title,
Value::String("The Hobbit".into()).to_string().as_bytes(),
)
.unwrap();
obkv.finish().unwrap();
obkv = obkv::KvWriter::new(&mut buf);
obkv.insert(author, Value::String("J. R. R. Tolkien".into()).to_string().as_bytes())
.unwrap();
obkv.insert(
author,
Value::String("J. R. R. Tolkien".into())
.to_string()
.as_bytes(),
)
.unwrap();
obkv.finish().unwrap();
let obkv = obkv::KvReader::new(&buf);
let mut formatted_options = BTreeMap::new();
formatted_options.insert(title, FormatOptions { highlight: true, crop: None });
formatted_options.insert(author, FormatOptions { highlight: false, crop: None });
formatted_options.insert(
title,
FormatOptions {
highlight: true,
crop: None,
},
);
formatted_options.insert(
author,
FormatOptions {
highlight: false,
crop: None,
},
);
let mut matching_words = BTreeMap::new();
matching_words.insert("hobbit", Some(3));
@ -648,8 +736,7 @@ mod test {
#[test]
fn formatted_with_crop_2() {
let stop_words = fst::Set::default();
let formatter =
Formatter::new(&stop_words, (String::from("<em>"), String::from("</em>")));
let formatter = Formatter::new(&stop_words, (String::from("<em>"), String::from("</em>")));
let mut fields = FieldsIdsMap::new();
let title = fields.insert("title").unwrap();
@ -657,19 +744,39 @@ mod test {
let mut buf = Vec::new();
let mut obkv = obkv::KvWriter::new(&mut buf);
obkv.insert(title, Value::String("Harry Potter and the Half-Blood Prince".into()).to_string().as_bytes())
.unwrap();
obkv.insert(
title,
Value::String("Harry Potter and the Half-Blood Prince".into())
.to_string()
.as_bytes(),
)
.unwrap();
obkv.finish().unwrap();
obkv = obkv::KvWriter::new(&mut buf);
obkv.insert(author, Value::String("J. K. Rowling".into()).to_string().as_bytes())
.unwrap();
obkv.insert(
author,
Value::String("J. K. Rowling".into()).to_string().as_bytes(),
)
.unwrap();
obkv.finish().unwrap();
let obkv = obkv::KvReader::new(&buf);
let mut formatted_options = BTreeMap::new();
formatted_options.insert(title, FormatOptions { highlight: false, crop: Some(2) });
formatted_options.insert(author, FormatOptions { highlight: false, crop: None });
formatted_options.insert(
title,
FormatOptions {
highlight: false,
crop: Some(2),
},
);
formatted_options.insert(
author,
FormatOptions {
highlight: false,
crop: None,
},
);
let mut matching_words = BTreeMap::new();
matching_words.insert("potter", Some(6));
@ -690,8 +797,7 @@ mod test {
#[test]
fn formatted_with_crop_10() {
let stop_words = fst::Set::default();
let formatter =
Formatter::new(&stop_words, (String::from("<em>"), String::from("</em>")));
let formatter = Formatter::new(&stop_words, (String::from("<em>"), String::from("</em>")));
let mut fields = FieldsIdsMap::new();
let title = fields.insert("title").unwrap();
@ -699,19 +805,39 @@ mod test {
let mut buf = Vec::new();
let mut obkv = obkv::KvWriter::new(&mut buf);
obkv.insert(title, Value::String("Harry Potter and the Half-Blood Prince".into()).to_string().as_bytes())
.unwrap();
obkv.insert(
title,
Value::String("Harry Potter and the Half-Blood Prince".into())
.to_string()
.as_bytes(),
)
.unwrap();
obkv.finish().unwrap();
obkv = obkv::KvWriter::new(&mut buf);
obkv.insert(author, Value::String("J. K. Rowling".into()).to_string().as_bytes())
.unwrap();
obkv.insert(
author,
Value::String("J. K. Rowling".into()).to_string().as_bytes(),
)
.unwrap();
obkv.finish().unwrap();
let obkv = obkv::KvReader::new(&buf);
let mut formatted_options = BTreeMap::new();
formatted_options.insert(title, FormatOptions { highlight: false, crop: Some(10) });
formatted_options.insert(author, FormatOptions { highlight: false, crop: None });
formatted_options.insert(
title,
FormatOptions {
highlight: false,
crop: Some(10),
},
);
formatted_options.insert(
author,
FormatOptions {
highlight: false,
crop: None,
},
);
let mut matching_words = BTreeMap::new();
matching_words.insert("potter", Some(6));
@ -732,8 +858,7 @@ mod test {
#[test]
fn formatted_with_crop_0() {
let stop_words = fst::Set::default();
let formatter =
Formatter::new(&stop_words, (String::from("<em>"), String::from("</em>")));
let formatter = Formatter::new(&stop_words, (String::from("<em>"), String::from("</em>")));
let mut fields = FieldsIdsMap::new();
let title = fields.insert("title").unwrap();
@ -741,19 +866,39 @@ mod test {
let mut buf = Vec::new();
let mut obkv = obkv::KvWriter::new(&mut buf);
obkv.insert(title, Value::String("Harry Potter and the Half-Blood Prince".into()).to_string().as_bytes())
.unwrap();
obkv.insert(
title,
Value::String("Harry Potter and the Half-Blood Prince".into())
.to_string()
.as_bytes(),
)
.unwrap();
obkv.finish().unwrap();
obkv = obkv::KvWriter::new(&mut buf);
obkv.insert(author, Value::String("J. K. Rowling".into()).to_string().as_bytes())
.unwrap();
obkv.insert(
author,
Value::String("J. K. Rowling".into()).to_string().as_bytes(),
)
.unwrap();
obkv.finish().unwrap();
let obkv = obkv::KvReader::new(&buf);
let mut formatted_options = BTreeMap::new();
formatted_options.insert(title, FormatOptions { highlight: false, crop: Some(0) });
formatted_options.insert(author, FormatOptions { highlight: false, crop: None });
formatted_options.insert(
title,
FormatOptions {
highlight: false,
crop: Some(0),
},
);
formatted_options.insert(
author,
FormatOptions {
highlight: false,
crop: None,
},
);
let mut matching_words = BTreeMap::new();
matching_words.insert("potter", Some(6));
@ -774,8 +919,7 @@ mod test {
#[test]
fn formatted_with_crop_and_no_match() {
let stop_words = fst::Set::default();
let formatter =
Formatter::new(&stop_words, (String::from("<em>"), String::from("</em>")));
let formatter = Formatter::new(&stop_words, (String::from("<em>"), String::from("</em>")));
let mut fields = FieldsIdsMap::new();
let title = fields.insert("title").unwrap();
@ -783,19 +927,39 @@ mod test {
let mut buf = Vec::new();
let mut obkv = obkv::KvWriter::new(&mut buf);
obkv.insert(title, Value::String("Harry Potter and the Half-Blood Prince".into()).to_string().as_bytes())
.unwrap();
obkv.insert(
title,
Value::String("Harry Potter and the Half-Blood Prince".into())
.to_string()
.as_bytes(),
)
.unwrap();
obkv.finish().unwrap();
obkv = obkv::KvWriter::new(&mut buf);
obkv.insert(author, Value::String("J. K. Rowling".into()).to_string().as_bytes())
.unwrap();
obkv.insert(
author,
Value::String("J. K. Rowling".into()).to_string().as_bytes(),
)
.unwrap();
obkv.finish().unwrap();
let obkv = obkv::KvReader::new(&buf);
let mut formatted_options = BTreeMap::new();
formatted_options.insert(title, FormatOptions { highlight: false, crop: Some(6) });
formatted_options.insert(author, FormatOptions { highlight: false, crop: Some(20) });
formatted_options.insert(
title,
FormatOptions {
highlight: false,
crop: Some(6),
},
);
formatted_options.insert(
author,
FormatOptions {
highlight: false,
crop: Some(20),
},
);
let mut matching_words = BTreeMap::new();
matching_words.insert("rowling", Some(3));
@ -816,8 +980,7 @@ mod test {
#[test]
fn formatted_with_crop_and_highlight() {
let stop_words = fst::Set::default();
let formatter =
Formatter::new(&stop_words, (String::from("<em>"), String::from("</em>")));
let formatter = Formatter::new(&stop_words, (String::from("<em>"), String::from("</em>")));
let mut fields = FieldsIdsMap::new();
let title = fields.insert("title").unwrap();
@ -825,19 +988,39 @@ mod test {
let mut buf = Vec::new();
let mut obkv = obkv::KvWriter::new(&mut buf);
obkv.insert(title, Value::String("Harry Potter and the Half-Blood Prince".into()).to_string().as_bytes())
.unwrap();
obkv.insert(
title,
Value::String("Harry Potter and the Half-Blood Prince".into())
.to_string()
.as_bytes(),
)
.unwrap();
obkv.finish().unwrap();
obkv = obkv::KvWriter::new(&mut buf);
obkv.insert(author, Value::String("J. K. Rowling".into()).to_string().as_bytes())
.unwrap();
obkv.insert(
author,
Value::String("J. K. Rowling".into()).to_string().as_bytes(),
)
.unwrap();
obkv.finish().unwrap();
let obkv = obkv::KvReader::new(&buf);
let mut formatted_options = BTreeMap::new();
formatted_options.insert(title, FormatOptions { highlight: true, crop: Some(1) });
formatted_options.insert(author, FormatOptions { highlight: false, crop: None });
formatted_options.insert(
title,
FormatOptions {
highlight: true,
crop: Some(1),
},
);
formatted_options.insert(
author,
FormatOptions {
highlight: false,
crop: None,
},
);
let mut matching_words = BTreeMap::new();
matching_words.insert("and", Some(3));
@ -858,8 +1041,7 @@ mod test {
#[test]
fn formatted_with_crop_and_highlight_in_word() {
let stop_words = fst::Set::default();
let formatter =
Formatter::new(&stop_words, (String::from("<em>"), String::from("</em>")));
let formatter = Formatter::new(&stop_words, (String::from("<em>"), String::from("</em>")));
let mut fields = FieldsIdsMap::new();
let title = fields.insert("title").unwrap();
@ -867,19 +1049,39 @@ mod test {
let mut buf = Vec::new();
let mut obkv = obkv::KvWriter::new(&mut buf);
obkv.insert(title, Value::String("Harry Potter and the Half-Blood Prince".into()).to_string().as_bytes())
.unwrap();
obkv.insert(
title,
Value::String("Harry Potter and the Half-Blood Prince".into())
.to_string()
.as_bytes(),
)
.unwrap();
obkv.finish().unwrap();
obkv = obkv::KvWriter::new(&mut buf);
obkv.insert(author, Value::String("J. K. Rowling".into()).to_string().as_bytes())
.unwrap();
obkv.insert(
author,
Value::String("J. K. Rowling".into()).to_string().as_bytes(),
)
.unwrap();
obkv.finish().unwrap();
let obkv = obkv::KvReader::new(&buf);
let mut formatted_options = BTreeMap::new();
formatted_options.insert(title, FormatOptions { highlight: true, crop: Some(9) });
formatted_options.insert(author, FormatOptions { highlight: false, crop: None });
formatted_options.insert(
title,
FormatOptions {
highlight: true,
crop: Some(9),
},
);
formatted_options.insert(
author,
FormatOptions {
highlight: false,
crop: None,
},
);
let mut matching_words = BTreeMap::new();
matching_words.insert("blood", Some(3));

2
meilisearch-http/src/routes/search.rs
View File

@ -66,7 +66,7 @@ impl From<SearchQueryGet> for SearchQuery {
crop_length: other.crop_length,
attributes_to_highlight,
filter,
matches: Some(other.matches),
matches: other.matches.unwrap_or_default(),
facet_distributions,
}
}