Module: Searchkick::Search

Defined in:
lib/searchkick/search.rb

Instance Method Summary collapse

Instance Method Details

#search(term, options = {}) ⇒ Object



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
# File 'lib/searchkick/search.rb', line 4

def search(term, options = {})
  term = term.to_s
  fields =
    if options[:fields]
      if options[:autocomplete]
        options[:fields].map{|f| "#{f}.autocomplete" }
      else
        options[:fields].map{|f| "#{f}.analyzed" }
      end
    else
      if options[:autocomplete]
        (searchkick_options[:autocomplete] || []).map{|f| "#{f}.autocomplete" }
      else
        ["_all"]
      end
    end

  operator = options[:partial] ? "or" : "and"

  # model and eagar loading
  load = options[:load].nil? ? true : options[:load]
  load = (options[:include] ? {include: options[:include]} : true) if load

  # pagination
  page = [options[:page].to_i, 1].max
  per_page = (options[:limit] || options[:per_page] || 100000).to_i
  offset = options[:offset] || (page - 1) * per_page
  index_name = options[:index_name] || searchkick_index.name

  conversions_field = searchkick_options[:conversions]
  personalize_field = searchkick_options[:personalize]

  all = term == "*"

  if options[:similar]
    payload = {
      more_like_this: {
        fields: fields,
        like_text: term,
        min_doc_freq: 1,
        min_term_freq: 1,
        analyzer: "searchkick_search2"
      }
    }
  elsif all
    payload = {
      match_all: {}
    }
  else
    if options[:autocomplete]
      payload = {
        multi_match: {
          fields: fields,
          query: term,
          analyzer: "searchkick_autocomplete_search"
        }
      }
    else
      shared_options = {
        fields: fields,
        query: term,
        use_dis_max: false,
        operator: operator
      }
      queries = [
        {multi_match: shared_options.merge(boost: 10, analyzer: "searchkick_search")},
        {multi_match: shared_options.merge(boost: 10, analyzer: "searchkick_search2")}
      ]
      if options[:misspellings] != false
        distance = (options[:misspellings].is_a?(Hash) && options[:misspellings][:distance]) || 1
        queries.concat [
          {multi_match: shared_options.merge(fuzziness: distance, max_expansions: 3, analyzer: "searchkick_search")},
          {multi_match: shared_options.merge(fuzziness: distance, max_expansions: 3, analyzer: "searchkick_search2")}
        ]
      end
      payload = {
        dis_max: {
          queries: queries
        }
      }
    end

    if conversions_field and options[:conversions] != false
      # wrap payload in a bool query
      payload = {
        bool: {
          must: payload,
          should: {
            nested: {
              path: conversions_field,
              score_mode: "total",
              query: {
                custom_score: {
                  query: {
                    match: {
                      query: term
                    }
                  },
                  script: "doc['count'].value"
                }
              }
            }
          }
        }
      }
    end
  end

  custom_filters = []

  if options[:boost]
    custom_filters << {
      filter: {
        exists: {
          field: options[:boost]
        }
      },
      script: "log(doc['#{options[:boost]}'].value + 2.718281828)"
    }
  end

  if options[:user_id] and personalize_field
    custom_filters << {
      filter: {
        term: {
          personalize_field => options[:user_id]
        }
      },
      boost: 100
    }
  end

  if custom_filters.any?
    payload = {
      custom_filters_score: {
        query: payload,
        filters: custom_filters,
        score_mode: "total"
      }
    }
  end

  payload = {
    query: payload,
    size: per_page,
    from: offset
  }
  payload[:explain] = options[:explain] if options[:explain]

  # order
  if options[:order]
    order = options[:order].is_a?(Enumerable) ? options[:order] : {options[:order] => :asc}
    payload[:sort] = order
  end

  # where
  where_filters =
    proc do |where|
      filters = []
      (where || {}).each do |field, value|
        field = :_id if field.to_s == "id"

        if field == :or
          value.each do |or_clause|
            filters << {or: or_clause.map{|or_statement| {and: where_filters.call(or_statement)} }}
          end
        else
          # expand ranges
          if value.is_a?(Range)
            value = {gte: value.first, (value.exclude_end? ? :lt : :lte) => value.last}
          end

          if value.is_a?(Array) # in query
            filters << {terms: {field => value}}
          elsif value.is_a?(Hash)
            if value[:near]
              filters << {
                geo_distance: {
                  field => value.delete(:near).map(&:to_f).reverse,
                  distance: value.delete(:within) || "50mi"
                }
              }
            end

            if value[:top_left]
              filters << {
                geo_bounding_box: {
                  field => {
                    top_left: value.delete(:top_left).map(&:to_f).reverse,
                    bottom_right: value.delete(:bottom_right).map(&:to_f).reverse
                  }
                }
              }
            end

            value.each do |op, op_value|
              if op == :not # not equal
                if op_value.is_a?(Array)
                  filters << {not: {terms: {field => op_value}}}
                else
                  filters << {not: {term: {field => op_value}}}
                end
              elsif op == :all
                filters << {terms: {field => op_value, execution: "and"}}
              else
                range_query =
                  case op
                  when :gt
                    {from: op_value, include_lower: false}
                  when :gte
                    {from: op_value, include_lower: true}
                  when :lt
                    {to: op_value, include_upper: false}
                  when :lte
                    {to: op_value, include_upper: true}
                  else
                    raise "Unknown where operator"
                  end
                filters << {range: {field => range_query}}
              end
            end
          else
            if value.nil?
              filters << {missing: {"field" => field, existence: true, null_value: true}}
            else
              filters << {term: {field => value}}
            end
          end
        end
      end
      filters
    end

  # filters
  filters = where_filters.call(options[:where])
  if filters.any?
    payload[:filter] = {
      and: filters
    }
  end

  # facets
  facet_limits = {}
  if options[:facets]
    facets = options[:facets] || {}
    if facets.is_a?(Array) # convert to more advanced syntax
      facets = Hash[ facets.map{|f| [f, {}] } ]
    end

    payload[:facets] = {}
    facets.each do |field, facet_options|
      # ask for extra facets due to
      # https://github.com/elasticsearch/elasticsearch/issues/1305

      if facet_options[:ranges]
        payload[:facets][field] = {
          range: {
            field.to_sym => facet_options[:ranges]
          }
        }
      else
        payload[:facets][field] = {
          terms: {
            field: field,
            size: facet_options[:limit] ? facet_options[:limit] + 150 : 100000
          }
        }
      end

      facet_limits[field] = facet_options[:limit] if facet_options[:limit]

      # offset is not possible
      # http://elasticsearch-users.115913.n3.nabble.com/Is-pagination-possible-in-termsStatsFacet-td3422943.html

      facet_filters = where_filters.call(facet_options[:where])
      if facet_filters.any?
        payload[:facets][field][:facet_filter] = {
          and: {
            filters: facet_filters
          }
        }
      end
    end
  end

  # suggestions
  if options[:suggest]
    suggest_fields = (searchkick_options[:suggest] || []).map(&:to_s)
    # intersection
    suggest_fields = suggest_fields & options[:fields].map(&:to_s) if options[:fields]
    if suggest_fields.any?
      payload[:suggest] = {text: term}
      suggest_fields.each do |field|
        payload[:suggest][field] = {
          phrase: {
            field: "#{field}.suggest"
          }
        }
      end
    end
  end

  # highlight
  if options[:highlight]
    payload[:highlight] = {
      fields: Hash[ fields.map{|f| [f, {}] } ]
    }
    if options[:highlight].is_a?(Hash) and tag = options[:highlight][:tag]
      payload[:highlight][:pre_tags] = [tag]
      payload[:highlight][:post_tags] = [tag.to_s.gsub(/\A</, "</")]
    end
  end

  # An empty array will cause only the _id and _type for each hit to be returned
  # http://www.elasticsearch.org/guide/reference/api/search/fields/
  payload[:fields] = [] if load

  tire_options = {load: load, payload: payload, size: per_page, from: offset}
  tire_options[:type] = document_type if self != searchkick_klass
  search = Tire::Search::Search.new(index_name, tire_options)
  begin
    response = search.json
  rescue Tire::Search::SearchRequestFailed => e
    status_code = e.message[0..3].to_i
    if status_code == 404
      raise "Index missing - run #{searchkick_klass.name}.reindex"
    elsif status_code == 500 and (e.message.include?("IllegalArgumentException[minimumSimilarity >= 1]") or e.message.include?("No query registered for [multi_match]"))
      raise "Upgrade Elasticsearch to 0.90.0 or greater"
    else
      raise e
    end
  end

  # apply facet limit in client due to
  # https://github.com/elasticsearch/elasticsearch/issues/1305
  facet_limits.each do |field, limit|
    field = field.to_s
    facet = response["facets"][field]
    response["facets"][field]["terms"] = facet["terms"].first(limit)
    response["facets"][field]["other"] = facet["total"] - facet["terms"].sum{|term| term["count"] }
  end

  Searchkick::Results.new(response, search.options.merge(term: term))
end