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
|
// Copyright 2012-2015 Oliver Eilhard. All rights reserved.
// Use of this source code is governed by a MIT-license.
// See http://olivere.mit-license.org/license.txt for details.
package elastic
import (
"fmt"
"strings"
)
// MultiMatchQuery builds on the MatchQuery to allow multi-field queries.
//
// For more details, see
// https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-multi-match-query.html
type MultiMatchQuery struct {
text interface{}
fields []string
fieldBoosts map[string]*float64
typ string // best_fields, boolean, most_fields, cross_fields, phrase, phrase_prefix
operator string // AND or OR
analyzer string
boost *float64
slop *int
fuzziness string
prefixLength *int
maxExpansions *int
minimumShouldMatch string
rewrite string
fuzzyRewrite string
tieBreaker *float64
lenient *bool
cutoffFrequency *float64
zeroTermsQuery string
queryName string
}
// MultiMatchQuery creates and initializes a new MultiMatchQuery.
func NewMultiMatchQuery(text interface{}, fields ...string) *MultiMatchQuery {
q := &MultiMatchQuery{
text: text,
fields: make([]string, 0),
fieldBoosts: make(map[string]*float64),
}
q.fields = append(q.fields, fields...)
return q
}
// Field adds a field to run the multi match against.
func (q *MultiMatchQuery) Field(field string) *MultiMatchQuery {
q.fields = append(q.fields, field)
return q
}
// FieldWithBoost adds a field to run the multi match against with a specific boost.
func (q *MultiMatchQuery) FieldWithBoost(field string, boost float64) *MultiMatchQuery {
q.fields = append(q.fields, field)
q.fieldBoosts[field] = &boost
return q
}
// Type can be "best_fields", "boolean", "most_fields", "cross_fields",
// "phrase", or "phrase_prefix".
func (q *MultiMatchQuery) Type(typ string) *MultiMatchQuery {
var zero = float64(0.0)
var one = float64(1.0)
switch strings.ToLower(typ) {
default: // best_fields / boolean
q.typ = "best_fields"
q.tieBreaker = &zero
case "most_fields":
q.typ = "most_fields"
q.tieBreaker = &one
case "cross_fields":
q.typ = "cross_fields"
q.tieBreaker = &zero
case "phrase":
q.typ = "phrase"
q.tieBreaker = &zero
case "phrase_prefix":
q.typ = "phrase_prefix"
q.tieBreaker = &zero
}
return q
}
// Operator sets the operator to use when using boolean query.
// It can be either AND or OR (default).
func (q *MultiMatchQuery) Operator(operator string) *MultiMatchQuery {
q.operator = operator
return q
}
// Analyzer sets the analyzer to use explicitly. It defaults to use explicit
// mapping config for the field, or, if not set, the default search analyzer.
func (q *MultiMatchQuery) Analyzer(analyzer string) *MultiMatchQuery {
q.analyzer = analyzer
return q
}
// Boost sets the boost for this query.
func (q *MultiMatchQuery) Boost(boost float64) *MultiMatchQuery {
q.boost = &boost
return q
}
// Slop sets the phrase slop if evaluated to a phrase query type.
func (q *MultiMatchQuery) Slop(slop int) *MultiMatchQuery {
q.slop = &slop
return q
}
// Fuzziness sets the fuzziness used when evaluated to a fuzzy query type.
// It defaults to "AUTO".
func (q *MultiMatchQuery) Fuzziness(fuzziness string) *MultiMatchQuery {
q.fuzziness = fuzziness
return q
}
// PrefixLength for the fuzzy process.
func (q *MultiMatchQuery) PrefixLength(prefixLength int) *MultiMatchQuery {
q.prefixLength = &prefixLength
return q
}
// MaxExpansions is the number of term expansions to use when using fuzzy
// or prefix type query. It defaults to unbounded so it's recommended
// to set it to a reasonable value for faster execution.
func (q *MultiMatchQuery) MaxExpansions(maxExpansions int) *MultiMatchQuery {
q.maxExpansions = &maxExpansions
return q
}
// MinimumShouldMatch represents the minimum number of optional should clauses
// to match.
func (q *MultiMatchQuery) MinimumShouldMatch(minimumShouldMatch string) *MultiMatchQuery {
q.minimumShouldMatch = minimumShouldMatch
return q
}
func (q *MultiMatchQuery) Rewrite(rewrite string) *MultiMatchQuery {
q.rewrite = rewrite
return q
}
func (q *MultiMatchQuery) FuzzyRewrite(fuzzyRewrite string) *MultiMatchQuery {
q.fuzzyRewrite = fuzzyRewrite
return q
}
// TieBreaker for "best-match" disjunction queries (OR queries).
// The tie breaker capability allows documents that match more than one
// query clause (in this case on more than one field) to be scored better
// than documents that match only the best of the fields, without confusing
// this with the better case of two distinct matches in the multiple fields.
//
// A tie-breaker value of 1.0 is interpreted as a signal to score queries as
// "most-match" queries where all matching query clauses are considered for scoring.
func (q *MultiMatchQuery) TieBreaker(tieBreaker float64) *MultiMatchQuery {
q.tieBreaker = &tieBreaker
return q
}
// Lenient indicates whether format based failures will be ignored.
func (q *MultiMatchQuery) Lenient(lenient bool) *MultiMatchQuery {
q.lenient = &lenient
return q
}
// CutoffFrequency sets a cutoff value in [0..1] (or absolute number >=1)
// representing the maximum threshold of a terms document frequency to be
// considered a low frequency term.
func (q *MultiMatchQuery) CutoffFrequency(cutoff float64) *MultiMatchQuery {
q.cutoffFrequency = &cutoff
return q
}
// ZeroTermsQuery can be "all" or "none".
func (q *MultiMatchQuery) ZeroTermsQuery(zeroTermsQuery string) *MultiMatchQuery {
q.zeroTermsQuery = zeroTermsQuery
return q
}
// QueryName sets the query name for the filter that can be used when
// searching for matched filters per hit.
func (q *MultiMatchQuery) QueryName(queryName string) *MultiMatchQuery {
q.queryName = queryName
return q
}
// Source returns JSON for the query.
func (q *MultiMatchQuery) Source() (interface{}, error) {
//
// {
// "multi_match" : {
// "query" : "this is a test",
// "fields" : [ "subject", "message" ]
// }
// }
source := make(map[string]interface{})
multiMatch := make(map[string]interface{})
source["multi_match"] = multiMatch
multiMatch["query"] = q.text
if len(q.fields) > 0 {
fields := make([]string, 0)
for _, field := range q.fields {
if boost, found := q.fieldBoosts[field]; found {
if boost != nil {
fields = append(fields, fmt.Sprintf("%s^%f", field, *boost))
} else {
fields = append(fields, field)
}
} else {
fields = append(fields, field)
}
}
multiMatch["fields"] = fields
}
if q.typ != "" {
multiMatch["type"] = q.typ
}
if q.operator != "" {
multiMatch["operator"] = q.operator
}
if q.analyzer != "" {
multiMatch["analyzer"] = q.analyzer
}
if q.boost != nil {
multiMatch["boost"] = *q.boost
}
if q.slop != nil {
multiMatch["slop"] = *q.slop
}
if q.fuzziness != "" {
multiMatch["fuzziness"] = q.fuzziness
}
if q.prefixLength != nil {
multiMatch["prefix_length"] = *q.prefixLength
}
if q.maxExpansions != nil {
multiMatch["max_expansions"] = *q.maxExpansions
}
if q.minimumShouldMatch != "" {
multiMatch["minimum_should_match"] = q.minimumShouldMatch
}
if q.rewrite != "" {
multiMatch["rewrite"] = q.rewrite
}
if q.fuzzyRewrite != "" {
multiMatch["fuzzy_rewrite"] = q.fuzzyRewrite
}
if q.tieBreaker != nil {
multiMatch["tie_breaker"] = *q.tieBreaker
}
if q.lenient != nil {
multiMatch["lenient"] = *q.lenient
}
if q.cutoffFrequency != nil {
multiMatch["cutoff_frequency"] = *q.cutoffFrequency
}
if q.zeroTermsQuery != "" {
multiMatch["zero_terms_query"] = q.zeroTermsQuery
}
if q.queryName != "" {
multiMatch["_name"] = q.queryName
}
return source, nil
}
|