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
use crate::search::*;
use crate::util::*;
/// Returns documents that match a provided text, number, date or boolean value.
/// The provided text is analyzed before matching.
///
/// The `match` query is the standard query for performing a full-text search,
/// including options for fuzzy matching.
///
/// To create a Match query with numeric values:
/// ```
/// # use elasticsearch_dsl::queries::*;
/// # use elasticsearch_dsl::queries::params::*;
/// # let query =
/// Query::multi_match(vec!["test"], "search text")
/// .boost(2)
/// .name("test");
/// ```
/// <https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-multi-match-query.html>
#[derive(Debug, Clone, PartialEq, Serialize)]
#[serde(remote = "Self")]
pub struct MultiMatchQuery {
#[serde(skip_serializing_if = "ShouldSkip::should_skip")]
fields: Vec<String>,
#[serde(skip_serializing_if = "ShouldSkip::should_skip")]
r#type: Option<TextQueryType>,
#[serde(skip_serializing_if = "ShouldSkip::should_skip")]
tie_breaker: Option<f32>,
#[serde(skip_serializing_if = "ShouldSkip::should_skip")]
query: Text,
#[serde(skip_serializing_if = "ShouldSkip::should_skip")]
analyzer: Option<String>,
#[serde(skip_serializing_if = "ShouldSkip::should_skip")]
auto_generate_synonyms_phrase_query: Option<bool>,
#[serde(skip_serializing_if = "ShouldSkip::should_skip")]
fuzziness: Option<Fuzziness>,
#[serde(skip_serializing_if = "ShouldSkip::should_skip")]
max_expansions: Option<u8>,
#[serde(skip_serializing_if = "ShouldSkip::should_skip")]
prefix_length: Option<u8>,
#[serde(skip_serializing_if = "ShouldSkip::should_skip")]
fuzzy_transpositions: Option<bool>,
#[serde(skip_serializing_if = "ShouldSkip::should_skip")]
fuzzy_rewrite: Option<Rewrite>,
#[serde(skip_serializing_if = "ShouldSkip::should_skip")]
lenient: Option<bool>,
#[serde(skip_serializing_if = "ShouldSkip::should_skip")]
operator: Option<Operator>,
#[serde(skip_serializing_if = "ShouldSkip::should_skip")]
minimum_should_match: Option<String>,
#[serde(skip_serializing_if = "ShouldSkip::should_skip")]
zero_terms_query: Option<ZeroTermsQuery>,
#[serde(skip_serializing_if = "ShouldSkip::should_skip")]
boost: Option<f32>,
#[serde(skip_serializing_if = "ShouldSkip::should_skip")]
_name: Option<String>,
}
impl Query {
/// Creates an instance of [`MultiMatchQuery`]
///
/// - `fields` - Fields you wish to search.
/// - `query` - Text, number, boolean value or date you wish to find in the provided
/// `<field>`. The `match` query
/// [analyzes](https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html)
/// any provided text before performing a search. This means the `match`
/// query can search
/// [`text`](https://www.elastic.co/guide/en/elasticsearch/reference/current/text.html)
/// fields for analyzed tokens rather than an exact term.
pub fn multi_match<F, S>(fields: F, query: S) -> MultiMatchQuery
where
F: IntoIterator,
F::Item: ToString,
S: Into<Text>,
{
MultiMatchQuery {
fields: fields.into_iter().map(|s| s.to_string()).collect(),
r#type: None,
tie_breaker: None,
query: query.into(),
analyzer: None,
auto_generate_synonyms_phrase_query: None,
fuzziness: None,
max_expansions: None,
prefix_length: None,
fuzzy_transpositions: None,
fuzzy_rewrite: None,
lenient: None,
operator: None,
minimum_should_match: None,
zero_terms_query: None,
boost: None,
_name: None,
}
}
}
impl MultiMatchQuery {
/// The way the multi_match query is executed internally depends on the
/// type parameter
pub fn r#type(mut self, r#type: TextQueryType) -> Self {
self.r#type = Some(r#type);
self
}
/// Floating point number between `0` and `1.0` used to increase the
/// [relevance scores](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-filter-context.html#relevance-scores)
/// of documents matching multiple query clauses. Defaults to `0.0`.
///
/// You can use the `tie_breaker` value to assign higher relevance scores to
/// documents that contain the same term in multiple fields than documents that
/// contain this term in only the best of those multiple fields, without
/// confusing this with the better case of two different terms in the multiple
/// fields.
///
/// If a document matches multiple clauses, the `dis_max` query calculates
/// the relevance score for the document as follows:
/// 1. Take the relevance score from a matching clause with the highest score.
/// 2. Multiply the score from any other matching clauses by the tie_breaker value.
/// 3. Add the highest score to the multiplied scores.
///
/// If the `tie_breaker` value is greater than `0.0`, all matching clauses
/// count, but the clause with the highest score counts most.
pub fn tie_breaker(mut self, tie_breaker: f32) -> Self {
self.tie_breaker = Some(tie_breaker);
self
}
/// [Analyzer](https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html)
/// used to convert the text in the `query` value into tokens. Defaults to the
/// [index-time analyzer](https://www.elastic.co/guide/en/elasticsearch/reference/current/specify-analyzer.html#specify-index-time-analyzer)
/// mapped for the `<field>`. If no analyzer is mapped, the index’s default analyzer is used.
pub fn analyzer<T>(mut self, analyzer: T) -> Self
where
T: ToString,
{
self.analyzer = Some(analyzer.to_string());
self
}
/// If `true`,
/// [match phrase](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-query-phrase.html)
/// queries are automatically created for multi-term synonyms. Defaults to `true`.
///
/// See [Use synonyms with match query](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-query.html#query-dsl-match-query-synonyms)
/// for an example.
pub fn auto_generate_synonyms_phrase_query(
mut self,
auto_generate_synonyms_phrase_query: bool,
) -> Self {
self.auto_generate_synonyms_phrase_query = Some(auto_generate_synonyms_phrase_query);
self
}
/// Maximum edit distance allowed for matching.
/// See [Fuzziness](Fuzziness)
/// for valid values and more information. See
/// [Fuzziness in the match query](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-query.html#query-dsl-match-query-fuzziness)
/// for an example.
pub fn fuzziness<T>(mut self, fuzziness: T) -> Self
where
T: Into<Fuzziness>,
{
self.fuzziness = Some(fuzziness.into());
self
}
/// Maximum number of terms to which the query will expand.
/// Defaults to `50`.
pub fn max_expansions(mut self, max_expansions: u8) -> Self {
self.max_expansions = Some(max_expansions);
self
}
/// Number of beginning characters left unchanged for fuzzy matching.
/// Defaults to `0`.
pub fn prefix_length(mut self, prefix_length: u8) -> Self {
self.prefix_length = Some(prefix_length);
self
}
/// If `true`, edits for fuzzy matching include transpositions of two
/// adjacent characters (ab → ba). Defaults to `true`.
pub fn fuzzy_transpositions(mut self, fuzzy_transpositions: bool) -> Self {
self.fuzzy_transpositions = Some(fuzzy_transpositions);
self
}
/// Method used to rewrite the query. See the
/// [`rewrite` parameter](Rewrite) for valid values and
/// more information.
///
/// If the `fuzziness` parameter is not `0`, the match query uses a
/// `fuzzy_rewrite` method of `top_terms_blended_freqs_${max_expansions}`
/// by default.
pub fn fuzzy_rewrite(mut self, fuzzy_rewrite: Rewrite) -> Self {
self.fuzzy_rewrite = Some(fuzzy_rewrite);
self
}
/// If `true`, format-based errors, such as providing a text `query`
/// value for a
/// [numeric](https://www.elastic.co/guide/en/elasticsearch/reference/current/number.html)
/// field, are ignored. Defaults to `false`.
pub fn lenient(mut self, lenient: bool) -> Self {
self.lenient = Some(lenient);
self
}
/// Boolean logic used to interpret text in the `query` value
pub fn operator(mut self, operator: Operator) -> Self {
self.operator = Some(operator);
self
}
/// Minimum number of clauses that must match for a document to be returned. See the
/// `minimum_should_match` parameter for valid values and more information.
pub fn minimum_should_match<T>(mut self, minimum_should_match: T) -> Self
where
T: ToString,
{
self.minimum_should_match = Some(minimum_should_match.to_string());
self
}
/// Indicates whether no documents are returned if the `analyzer` removes
/// all tokens, such as when using a `stop` filter.
pub fn zero_terms_query(mut self, zero_terms_query: ZeroTermsQuery) -> Self {
self.zero_terms_query = Some(zero_terms_query);
self
}
add_boost_and_name!();
}
impl ShouldSkip for MultiMatchQuery {
fn should_skip(&self) -> bool {
self.query.should_skip()
}
}
serialize_with_root!("multi_match": MultiMatchQuery);
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn serialization() {
assert_serialize_query(
Query::multi_match(["test"], "search text"),
json!({
"multi_match": {
"query": "search text",
"fields": ["test"],
}
}),
);
assert_serialize_query(
Query::multi_match(["test"], "search text")
.r#type(TextQueryType::BestFields)
.tie_breaker(0.2)
.analyzer("search_time_analyzer")
.auto_generate_synonyms_phrase_query(true)
.fuzziness(23)
.max_expansions(2)
.prefix_length(3)
.fuzzy_transpositions(false)
.fuzzy_rewrite(Rewrite::ConstantScoreBoolean)
.lenient(true)
.operator(Operator::And)
.minimum_should_match("22")
.zero_terms_query(ZeroTermsQuery::None)
.boost(2)
.name("test"),
json!({
"multi_match": {
"query": "search text",
"fields": ["test"],
"type": "best_fields",
"tie_breaker": 0.2,
"analyzer": "search_time_analyzer",
"auto_generate_synonyms_phrase_query": true,
"fuzziness": 23,
"max_expansions": 2,
"prefix_length": 3,
"fuzzy_transpositions": false,
"fuzzy_rewrite": "constant_score_boolean",
"lenient": true,
"operator": "AND",
"minimum_should_match": "22",
"zero_terms_query": "none",
"boost": 2.0,
"_name": "test",
}
}),
);
}
}