Blob tique/src/queryparser/parser.rs
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 |
use super::raw::{parse_query, FieldNameValidator, RawQuery};
use crate::DisMaxQuery;
use tantivy::{
self,
query::{AllQuery, BooleanQuery, BoostQuery, Occur, PhraseQuery, Query, TermQuery},
schema::{Field, IndexRecordOption},
tokenizer::TextAnalyzer,
Index, Result, Term,
};
/// Parse queries from arbitrary end-user input
///
/// Words and phrases are supported as usual. For a query like:
///
/// > apple "peanut butter"
///
/// Every document that contains the word "apple" **or** the phrase
/// "peanut butter" will be a candidate for collection.
///
/// You may make items required or prohibited:
///
/// > -"deep fry" +bacon
///
/// Now documents *must* contain "bacon" and must *not* contain
/// the phrase "deep fry"
///
/// And you can limit which fields are looked at by prefixing an
/// item with the field name:
///
/// > cake butter -ingredients:egg
///
/// Which ends up prohibiting documents with "egg" in the "ingredients"
/// field from showing up.
///
pub struct QueryParser {
state: Vec<(Option<String>, Option<f32>, Interpreter)>,
default_indices: Vec<usize>,
}
impl QueryParser {
/// Create a QueryParser that knows about the given fields and queries
/// them by default.
///
/// # Errors
///
/// Will yield an error if any of `fields` is not known by the given
/// `index`
pub fn new(index: &Index, fields: Vec<Field>) -> Result<Self> {
let schema = index.schema();
let mut parser = QueryParser {
default_indices: (0..fields.len()).collect(),
state: Vec::with_capacity(fields.len()),
};
for field in fields {
parser.state.push((
Some(schema.get_field_name(field).to_owned()),
None,
Interpreter {
field,
analyzer: index.tokenizer_for_field(field)?,
},
));
}
Ok(parser)
}
/// Configure the importance of a field
///
/// By default, every field has a boost of `None`, which is equivalent
/// to a boost of `Some(1.0)`. Less than 1.0 means lower importance,
/// greater means higher.
pub fn set_boost(&mut self, field: Field, boost: Option<f32>) {
if let Some(row) = self
.position_by_field(field)
.and_then(|pos| self.state.get_mut(pos))
{
row.1 = boost;
}
}
/// Change/disable how to query a specific field
///
/// The QueryParser uses the field name present in the index schema
/// as the field name, so if you have a field named "body", the parser
/// knows to only look at that field when searching for `body:potato`.
///
/// You can use this to change how (or make it impossible) to address
/// any field from a query.
pub fn set_name(&mut self, field: Field, name: Option<String>) {
if let Some(row) = self
.position_by_field(field)
.and_then(|pos| self.state.get_mut(pos))
{
row.0 = name;
}
}
/// Configure which fields are queried by default
///
/// When a query input doesn't specify a field name explicitly, the
/// parser uses these fields by default. So if you have a parser
/// with default fields `a` and `b`, a query like "foo b:bar" ends
/// up searching for "foo" in both fields, but "bar" only on `b`.
pub fn set_default_fields(&mut self, fields: Vec<Field>) {
let mut indices = Vec::with_capacity(fields.len());
for field in fields {
if let Some(idx) = self.position_by_field(field) {
indices.push(idx);
}
}
indices.sort();
self.default_indices = indices;
}
/// Parse arbitrary user input into a tantivy query
///
/// `None` may happen when the input is empty or the field analyzers end up
/// emitting no tokens. Example: an analyzer that filters stop words would
/// return `None` for a query like "the is at which".
pub fn parse(&self, input: &str) -> Option<Box<dyn Query>> {
self.parse_inner(input, |queries| {
Box::new(BooleanQuery::from(
queries
.into_iter()
.map(|q| (Occur::Should, q))
.collect::<Vec<_>>(),
))
})
}
/// Parse a query, taking multiple fields with similar vocabularies into
/// account.
///
/// Behaves like `QueryParser::parse`, but uses `DisMaxQuery` when searching
/// over multiple fields.
///
/// The `tiebreaker` parameter governs the importance of appearing in more
/// than one field and a small value like `0.1` or even `0` is a reasonable
/// starting point.
///
/// Panics when `tiebreaker` is lower than zero or greater than one.
///
/// Refer to DisMaxQuery's docs for more details.
pub fn parse_dixmax(&self, input: &str, tiebreaker: f32) -> Option<Box<dyn Query>> {
assert!(
(0.0..=1.0).contains(&tiebreaker),
"tiebreaker must be between 0 and 1.0"
);
self.parse_inner(input, |queries| {
Box::new(DisMaxQuery::new(queries, tiebreaker))
})
}
fn parse_inner<F: Fn(Vec<Box<dyn Query>>) -> Box<dyn Query>>(
&self,
input: &str,
// Guaranteed to receive a vec of len > 1 if called
many_handler: F,
) -> Option<Box<dyn Query>> {
let (_, parsed) = parse_query(input, self).ok()?;
let mut clauses = Vec::new();
let mut num_must_not = 0;
parsed
.into_iter()
.map(|raw| (self.queries_from_raw(&raw), raw))
.filter(|(queries, _)| !queries.is_empty())
.for_each(|(queries, raw)| {
if raw.occur == Occur::MustNot {
for query in queries {
num_must_not += 1;
clauses.push((Occur::MustNot, query));
}
} else if queries.len() == 1 {
clauses.push((raw.occur, queries.into_iter().next().unwrap()));
} else {
// Now we have multiple positive queries that were generated
// out of a single raw query.
clauses.push((raw.occur, many_handler(queries)));
}
});
match clauses.len() {
0 => None,
1 => {
let (occur, query) = clauses.into_iter().next().unwrap();
if occur == Occur::MustNot {
Some(Box::new(BooleanQuery::from(vec![
(Occur::MustNot, query),
(Occur::Must, Box::new(AllQuery)),
])))
} else {
Some(query)
}
}
num_clauses => {
if num_clauses == num_must_not {
clauses.push((Occur::Must, Box::new(AllQuery)));
}
Some(Box::new(BooleanQuery::from(clauses)))
}
}
}
fn queries_from_raw(&self, raw_query: &RawQuery) -> Vec<Box<dyn Query>> {
let indices = if let Some(position) = raw_query
.field_name
.and_then(|field_name| self.position_by_name(field_name))
{
vec![position]
} else {
self.default_indices.clone()
};
indices
.into_iter()
.flat_map(|i| self.state.get(i))
.flat_map(|(_, boost, interpreter)| {
interpreter.to_query(raw_query).map(|query| {
if let Some(val) = boost {
Box::new(BoostQuery::new(query, *val))
} else {
query
}
})
})
.collect()
}
fn position_by_name(&self, field_name: &str) -> Option<usize> {
self.state
.iter()
.position(|(opt_name, _opt_boost, _interpreter)| {
opt_name.as_ref().map_or(false, |name| name == field_name)
})
}
fn position_by_field(&self, field: Field) -> Option<usize> {
self.state
.iter()
.position(|(_opt_name, _opt_boost, interpreter)| interpreter.field == field)
}
}
impl FieldNameValidator for QueryParser {
fn check(&self, field_name: &str) -> bool {
self.state
.iter()
.any(|(opt_name, _opt_boost, _interpreter)| {
opt_name.as_ref().map_or(false, |name| name == field_name)
})
}
}
struct Interpreter {
field: Field,
analyzer: TextAnalyzer,
}
impl Interpreter {
fn to_query(&self, raw_query: &RawQuery) -> Option<Box<dyn Query>> {
let mut terms = Vec::new();
let mut stream = self.analyzer.token_stream(raw_query.input);
stream.process(&mut |token| {
terms.push(Term::from_field_text(self.field, &token.text));
});
if terms.is_empty() {
return None;
}
let query: Box<dyn Query> = if terms.len() == 1 {
Box::new(TermQuery::new(
terms.pop().unwrap(),
IndexRecordOption::WithFreqs,
))
} else if raw_query.is_phrase {
Box::new(PhraseQuery::new(terms))
} else {
// An analyzer might emit multiple tokens even if the
// raw parser only got one (say: raw takes "word", but
// analyzer is actually a char tokenizer)
Box::new(BooleanQuery::new_multiterms_query(terms))
};
Some(query)
}
}
#[cfg(test)]
mod tests {
use super::*;
use tantivy::tokenizer::TokenizerManager;
fn test_interpreter() -> Interpreter {
Interpreter {
field: Field::from_field_id(0),
analyzer: TokenizerManager::default().get("en_stem").unwrap(),
}
}
#[test]
fn empty_raw_is_none() {
assert!(test_interpreter().to_query(&RawQuery::new("")).is_none());
}
#[test]
fn simple_raw_is_termquery() {
let query = test_interpreter()
.to_query(&RawQuery::new("word"))
.expect("parses to a Some(Query)");
assert!(query.as_any().downcast_ref::<TermQuery>().is_some());
}
#[test]
fn phrase_raw_is_phrasequery() {
let query = test_interpreter()
.to_query(&RawQuery::new("sweet potato").phrase())
.expect("parses to a Some(Query)");
assert!(query.as_any().downcast_ref::<PhraseQuery>().is_some());
}
#[test]
fn single_word_raw_phrase_is_termquery() {
let query = test_interpreter()
.to_query(&RawQuery::new("single").phrase())
.expect("parses to a Some(Query)");
assert!(query.as_any().downcast_ref::<TermQuery>().is_some());
}
fn single_field_test_parser() -> QueryParser {
QueryParser {
default_indices: vec![0],
state: vec![(
None,
None,
Interpreter {
field: Field::from_field_id(0),
analyzer: TokenizerManager::default().get("en_stem").unwrap(),
},
)],
}
}
#[test]
fn empty_query_results_in_none() {
assert!(single_field_test_parser().parse("").is_none());
}
use tantivy::{
collector::TopDocs,
doc,
schema::{SchemaBuilder, TEXT},
DocAddress,
};
#[test]
fn index_integration() -> Result<()> {
let mut builder = SchemaBuilder::new();
let title = builder.add_text_field("title", TEXT);
let plot = builder.add_text_field("plot", TEXT);
let index = Index::create_in_ram(builder.build());
let mut writer = index.writer_with_num_threads(1, 3_000_000)?;
let doc_across = DocAddress(0, 0);
writer.add_document(doc!(
title => "Across the Universe",
plot => "Musical based on The Beatles songbook and set in the 60s England, \
America, and Vietnam. The love story of Lucy and Jude is intertwined \
with the anti-war movement and social protests of the 60s."
));
let doc_moulin = DocAddress(0, 1);
writer.add_document(doc!(
title => "Moulin Rouge!",
plot => "A poet falls for a beautiful courtesan whom a jealous duke covets in \
this stylish musical, with music drawn from familiar 20th century sources."
));
let doc_once = DocAddress(0, 2);
writer.add_document(doc!(
title => "Once",
plot => "A modern-day musical about a busker and an immigrant and their eventful\
week in Dublin, as they write, rehearse and record songs that tell their \
love story."
));
writer.commit()?;
let reader = index.reader()?;
let searcher = reader.searcher();
let parser = QueryParser::new(&index, vec![title, plot])?;
let search = |input, limit| {
let query = parser.parse(input).expect("given input yields Some()");
searcher
.search(&query, &TopDocs::with_limit(limit))
.expect("working index")
};
let found = search("+title:Once musical", 2);
// Even if "musical" matches every document,
// there's a MUST query that only one matches
assert_eq!(1, found.len());
assert_eq!(doc_once, found[0].1);
let found = search("\"the beatles\"", 1);
assert!(!found.is_empty());
assert_eq!(doc_across, found[0].1);
// Purely negative queries should work too
for input in &["-love", "-story -love", "-\"love story\""] {
let found = search(input, 3);
assert_eq!(1, found.len(), "input [{}] found more than one", input);
assert_eq!(doc_moulin, found[0].1);
}
Ok(())
}
#[test]
fn field_boosting() -> Result<()> {
let mut builder = SchemaBuilder::new();
let field_a = builder.add_text_field("a", TEXT);
let field_b = builder.add_text_field("b", TEXT);
let index = Index::create_in_ram(builder.build());
let mut writer = index.writer_with_num_threads(1, 3_000_000)?;
writer.add_document(doc!(
field_a => "bar",
field_b => "foo baz",
));
writer.add_document(doc!(
field_a => "foo",
field_b => "bar",
));
writer.add_document(doc!(
field_a => "bar",
field_b => "foo",
));
writer.commit()?;
let mut parser = QueryParser::new(&index, vec![field_a, field_b])?;
let input = "foo baz";
let normal_query = parser.parse(&input).unwrap();
let reader = index.reader()?;
let searcher = reader.searcher();
let found = searcher.search(&normal_query, &TopDocs::with_limit(3))?;
assert_eq!(3, found.len());
// the first doc matches perfectly on `field_b`
assert_eq!(DocAddress(0, 0), found[0].1);
parser.set_boost(field_a, Some(1.5));
let boosted_query = parser.parse(&input).unwrap();
let found = searcher.search(&boosted_query, &TopDocs::with_limit(3))?;
assert_eq!(3, found.len());
// the first doc matches perfectly on field_b
// but now matching on `field_a` is super important
assert_eq!(DocAddress(0, 1), found[0].1);
Ok(())
}
}
|