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
use crate::search::*;
use crate::util::*;
/// Returns documents matching one or more wrapped queries, called query clauses or clauses.
///
/// If a returned document matches multiple query clauses, the `dis_max` query assigns the document
/// the highest relevance score from any matching clause, plus a tie breaking increment for any
/// additional matching subqueries.
///
/// You can use the `dis_max` to search for a term in fields mapped with different
/// [boost](https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-boost.html)
/// factors.
///
/// To create disjunction max query:
/// ```
/// # use elasticsearch_dsl::queries::*;
/// # use elasticsearch_dsl::queries::params::*;
/// # let query =
/// Query::dis_max()
/// .query(Query::r#match("t1", "text"))
/// .query(Query::r#match("t2", "text"))
/// .tie_breaker(0.5)
/// .boost(3)
/// .name("test");
/// ```
/// <https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-dis-max-query.html>
#[derive(Debug, Clone, Default, PartialEq, Serialize)]
pub struct DisMaxQuery {
#[serde(rename = "dis_max")]
inner: Inner,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize)]
struct Inner {
queries: Vec<Query>,
#[serde(skip_serializing_if = "ShouldSkip::should_skip")]
tie_breaker: Option<TieBreaker>,
#[serde(skip_serializing_if = "ShouldSkip::should_skip")]
boost: Option<Boost>,
#[serde(skip_serializing_if = "ShouldSkip::should_skip")]
_name: Option<String>,
}
impl Query {
/// Creates an instance of [`DisMaxQuery`]
pub fn dis_max() -> DisMaxQuery {
DisMaxQuery::default()
}
}
impl DisMaxQuery {
/// Contains one or more query clauses. Returned documents
/// **must match one or more** of these queries. If a document matches multiple queries,
/// Elasticsearch uses the highest
/// [relevance score](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-filter-context.html)
pub fn query(mut self, query: impl Into<Option<Query>>) -> Self {
let query = query.into();
if let Some(query) = query {
if !query.should_skip() {
self.inner.queries.push(query);
}
}
self
}
/// Contains one or more query clauses. Returned documents
/// **must match one or more** of these queries. If a document matches multiple queries,
/// Elasticsearch uses the highest
/// [relevance score](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-filter-context.html)
pub fn queries<I>(mut self, queries: I) -> Self
where
I: IntoIterator,
I::Item: Into<Query>,
{
for query in queries.into_iter().map(Into::into) {
if !query.should_skip() {
self.inner.queries.push(query);
}
}
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: impl Into<TieBreaker>) -> Self {
self.inner.tie_breaker = Some(tie_breaker.into());
self
}
add_boost_and_name!();
}
impl ShouldSkip for DisMaxQuery {
fn should_skip(&self) -> bool {
self.inner.queries.should_skip()
}
}
#[cfg(test)]
mod tests {
use super::*;
test_serialization! {
with_required_fields(
Query::dis_max()
.query(Query::r#match("t1", "text"))
.query(Query::r#match("t2", "text")),
json!({
"dis_max": {
"queries": [
{
"match": {
"t1": {
"query": "text"
}
}
},
{
"match": {
"t2": {
"query": "text"
}
}
}
]
}
})
);
with_multiple_queries(
Query::dis_max()
.queries([Query::r#match("t1", "text"), Query::r#match("t2", "text")]),
json!({
"dis_max": {
"queries": [
{
"match": {
"t1": {
"query": "text"
}
}
},
{
"match": {
"t2": {
"query": "text"
}
}
}
]
}
})
);
with_all_fields(
Query::dis_max()
.query(Query::r#match("t1", "text"))
.query(Query::r#match("t2", "text"))
.tie_breaker(0.5)
.boost(3)
.name("test"),
json!({
"dis_max": {
"queries": [
{
"match": {
"t1": {
"query": "text"
}
}
},
{
"match": {
"t2": {
"query": "text"
}
}
}
],
"tie_breaker": 0.5,
"boost": 3,
"_name": "test"
}
})
);
}
}