Class: Searchkick::IndexOptions

Inherits:
Object
  • Object
show all
Defined in:
lib/searchkick/index_options.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(index) ⇒ IndexOptions

Returns a new instance of IndexOptions.



5
6
7
 
# File 'lib/searchkick/index_options.rb', line 5

def initialize(index)
  @options = index.options
end

Instance Attribute Details

#options ⇒ Object (readonly)

Returns the value of attribute options.



3
4
5
 
# File 'lib/searchkick/index_options.rb', line 3

def options
  @options
end

Instance Method Details

#add_search_synonyms(settings) ⇒ Object 



565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
 
# File 'lib/searchkick/index_options.rb', line 565

def add_search_synonyms(settings)
  search_synonyms = options[:search_synonyms] || []
  search_synonyms = search_synonyms.call if search_synonyms.respond_to?(:call)
  if search_synonyms.is_a?(String) || search_synonyms.any?
    if search_synonyms.is_a?(String)
      synonym_graph = {
        type: "synonym_graph",
        synonyms_path: search_synonyms
      }
      synonym_graph[:updateable] = true unless below73?
    else
      synonym_graph = {
        type: "synonym_graph",
        # TODO confirm this is correct
        synonyms: search_synonyms.select { |s| s.size > 1 }.map { |s| s.is_a?(Array) ? s.join(",") : s }.map(&:downcase)
      }
    end
    settings[:analysis][:filter][:searchkick_synonym_graph] = synonym_graph

    if ["japanese", "japanese2"].include?(options[:language])
      [:searchkick_search, :searchkick_search2].each do |analyzer|
        settings[:analysis][:analyzer][analyzer][:filter].insert(4, "searchkick_synonym_graph")
      end
    else
      [:searchkick_search2, :searchkick_word_search].each do |analyzer|
        unless settings[:analysis][:analyzer][analyzer].key?(:filter)
          raise Error, "Search synonyms are not supported yet for language"
        end

        settings[:analysis][:analyzer][analyzer][:filter].insert(2, "searchkick_synonym_graph")
      end
    end
  end
end

#add_synonyms(settings) ⇒ Object 



539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
 
# File 'lib/searchkick/index_options.rb', line 539

def add_synonyms(settings)
  synonyms = options[:synonyms] || []
  synonyms = synonyms.call if synonyms.respond_to?(:call)
  if synonyms.any?
    settings[:analysis][:filter][:searchkick_synonym] = {
      type: "synonym",
      # only remove a single space from synonyms so three-word synonyms will fail noisily instead of silently
      synonyms: synonyms.select { |s| s.size > 1 }.map { |s| s.is_a?(Array) ? s.map { |s2| s2.sub(/\s+/, "") }.join(",") : s }.map(&:downcase)
    }
    # choosing a place for the synonym filter when stemming is not easy
    # https://groups.google.com/forum/#!topic/elasticsearch/p7qcQlgHdB8
    # TODO use a snowball stemmer on synonyms when creating the token filter

    # http://elasticsearch-users.115913.n3.nabble.com/synonym-multi-words-search-td4030811.html
    # I find the following approach effective if you are doing multi-word synonyms (synonym phrases):
    # - Only apply the synonym expansion at index time
    # - Don't have the synonym filter applied search
    # - Use directional synonyms where appropriate. You want to make sure that you're not injecting terms that are too general.
    settings[:analysis][:analyzer][default_analyzer][:filter].insert(2, "searchkick_synonym")

    %w(word_start word_middle word_end).each do |type|
      settings[:analysis][:analyzer]["searchkick_#{type}_index".to_sym][:filter].insert(2, "searchkick_synonym")
    end
  end
end

#below73? ⇒ Boolean

Returns:

  • (Boolean) 


623
624
625
 
# File 'lib/searchkick/index_options.rb', line 623

def below73?
  Searchkick.server_below?("7.3.0")
end

#default_analyzer ⇒ Object 



619
620
621
 
# File 'lib/searchkick/index_options.rb', line 619

def default_analyzer
  :searchkick_index
end

#default_type ⇒ Object 



615
616
617
 
# File 'lib/searchkick/index_options.rb', line 615

def default_type
  "text"
end

#generate_mappings ⇒ Object 



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
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
 
# File 'lib/searchkick/index_options.rb', line 358

def generate_mappings
  mapping = {}

  keyword_mapping = {type: "keyword"}
  keyword_mapping[:ignore_above] = options[:ignore_above] || 30000

  # conversions
  Array(options[:conversions]).each do |conversions_field|
    mapping[conversions_field] = {
      type: "nested",
      properties: {
        query: {type: default_type, analyzer: "searchkick_keyword"},
        count: {type: "integer"}
      }
    }
  end

  mapping_options =
    [:suggest, :word, :text_start, :text_middle, :text_end, :word_start, :word_middle, :word_end, :highlight, :searchable, :filterable]
      .to_h { |type| [type, (options[type] || []).map(&:to_s)] }

  word = options[:word] != false && (!options[:match] || options[:match] == :word)

  mapping_options[:searchable].delete("_all")

  analyzed_field_options = {type: default_type, index: true, analyzer: default_analyzer.to_s}

  mapping_options.values.flatten.uniq.each do |field|
    fields = {}

    if options.key?(:filterable) && !mapping_options[:filterable].include?(field)
      fields[field] = {type: default_type, index: false}
    else
      fields[field] = keyword_mapping
    end

    if !options[:searchable] || mapping_options[:searchable].include?(field)
      if word
        fields[:analyzed] = analyzed_field_options

        if mapping_options[:highlight].include?(field)
          fields[:analyzed][:term_vector] = "with_positions_offsets"
        end
      end

      mapping_options.except(:highlight, :searchable, :filterable, :word).each do |type, f|
        if options[:match] == type || f.include?(field)
          fields[type] = {type: default_type, index: true, analyzer: "searchkick_#{type}_index"}
        end
      end
    end

    mapping[field] = fields[field].merge(fields: fields.except(field))
  end

  (options[:locations] || []).map(&:to_s).each do |field|
    mapping[field] = {
      type: "geo_point"
    }
  end

  options[:geo_shape] = options[:geo_shape].product([{}]).to_h if options[:geo_shape].is_a?(Array)
  (options[:geo_shape] || {}).each do |field, shape_options|
    mapping[field] = shape_options.merge(type: "geo_shape")
  end

  (options[:knn] || []).each do |field, knn_options|
    distance = knn_options[:distance]

    if Searchkick.opensearch?
      if distance.nil?
        # avoid server crash if method not specified
        raise ArgumentError, "Must specify a distance for OpenSearch"
      end

      vector_options = {
        type: "knn_vector",
        dimension: knn_options[:dimensions]
      }

      if !distance.nil?
        space_type =
          case distance
          when "cosine"
            "cosinesimil"
          when "euclidean"
            "l2"
          when "inner_product"
            "innerproduct"
          else
            raise ArgumentError, "Unknown distance: #{distance}"
          end

        vector_options[:method] = {
          name: "hnsw",
          space_type: space_type,
          engine: "lucene"
        }
      end

      mapping[field.to_s] = vector_options
    else
      vector_options = {
        type: "dense_vector",
        dims: knn_options[:dimensions],
        index: !distance.nil?
      }

      if !distance.nil?
        vector_options[:similarity] =
          case distance
          when "cosine"
            "cosine"
          when "euclidean"
            "l2_norm"
          when "inner_product"
            "max_inner_product"
          else
            raise ArgumentError, "Unknown distance: #{distance}"
          end
      end

      mapping[field.to_s] = vector_options
    end
  end

  if options[:inheritance]
    mapping[:type] = keyword_mapping
  end

  routing = {}
  if options[:routing]
    routing = {required: true}
    unless options[:routing] == true
      routing[:path] = options[:routing].to_s
    end
  end

  dynamic_fields = {
    # analyzed field must be the default field for include_in_all
    # http://www.elasticsearch.org/guide/reference/mapping/multi-field-type/
    # however, we can include the not_analyzed field in _all
    # and the _all index analyzer will take care of it
    "{name}" => keyword_mapping
  }

  if options.key?(:filterable)
    dynamic_fields["{name}"] = {type: default_type, index: false}
  end

  unless options[:searchable]
    if options[:match] && options[:match] != :word
      dynamic_fields[options[:match]] = {type: default_type, index: true, analyzer: "searchkick_#{options[:match]}_index"}
    end

    if word
      dynamic_fields[:analyzed] = analyzed_field_options
    end
  end

  # http://www.elasticsearch.org/guide/reference/mapping/multi-field-type/
  multi_field = dynamic_fields["{name}"].merge(fields: dynamic_fields.except("{name}"))

  mappings = {
    properties: mapping,
    _routing: routing,
    # https://gist.github.com/kimchy/2898285
    dynamic_templates: [
      {
        string_template: {
          match: "*",
          match_mapping_type: "string",
          mapping: multi_field
        }
      }
    ]
  }

  mappings
end

#generate_settings ⇒ Object

Raises:

  • (ArgumentError) 


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

def generate_settings
  language = options[:language]
  language = language.call if language.respond_to?(:call)

  settings = {
    analysis: {
      analyzer: {
        searchkick_keyword: {
          type: "custom",
          tokenizer: "keyword",
          filter: ["lowercase"] + (options[:stem_conversions] ? ["searchkick_stemmer"] : [])
        },
        default_analyzer => {
          type: "custom",
          # character filters -> tokenizer -> token filters
          # https://www.elastic.co/guide/en/elasticsearch/guide/current/analysis-intro.html
          char_filter: ["ampersand"],
          tokenizer: "standard",
          # synonym should come last, after stemming and shingle
          # shingle must come before searchkick_stemmer
          filter: ["lowercase", "asciifolding", "searchkick_index_shingle", "searchkick_stemmer"]
        },
        searchkick_search: {
          type: "custom",
          char_filter: ["ampersand"],
          tokenizer: "standard",
          filter: ["lowercase", "asciifolding", "searchkick_search_shingle", "searchkick_stemmer"]
        },
        searchkick_search2: {
          type: "custom",
          char_filter: ["ampersand"],
          tokenizer: "standard",
          filter: ["lowercase", "asciifolding", "searchkick_stemmer"]
        },
        # https://github.com/leschenko/elasticsearch_autocomplete/blob/master/lib/elasticsearch_autocomplete/analyzers.rb
        searchkick_autocomplete_search: {
          type: "custom",
          tokenizer: "keyword",
          filter: ["lowercase", "asciifolding"]
        },
        searchkick_word_search: {
          type: "custom",
          tokenizer: "standard",
          filter: ["lowercase", "asciifolding"]
        },
        searchkick_suggest_index: {
          type: "custom",
          tokenizer: "standard",
          filter: ["lowercase", "asciifolding", "searchkick_suggest_shingle"]
        },
        searchkick_text_start_index: {
          type: "custom",
          tokenizer: "keyword",
          filter: ["lowercase", "asciifolding", "searchkick_edge_ngram"]
        },
        searchkick_text_middle_index: {
          type: "custom",
          tokenizer: "keyword",
          filter: ["lowercase", "asciifolding", "searchkick_ngram"]
        },
        searchkick_text_end_index: {
          type: "custom",
          tokenizer: "keyword",
          filter: ["lowercase", "asciifolding", "reverse", "searchkick_edge_ngram", "reverse"]
        },
        searchkick_word_start_index: {
          type: "custom",
          tokenizer: "standard",
          filter: ["lowercase", "asciifolding", "searchkick_edge_ngram"]
        },
        searchkick_word_middle_index: {
          type: "custom",
          tokenizer: "standard",
          filter: ["lowercase", "asciifolding", "searchkick_ngram"]
        },
        searchkick_word_end_index: {
          type: "custom",
          tokenizer: "standard",
          filter: ["lowercase", "asciifolding", "reverse", "searchkick_edge_ngram", "reverse"]
        }
      },
      filter: {
        searchkick_index_shingle: {
          type: "shingle",
          token_separator: ""
        },
        # lucky find https://web.archiveorange.com/archive/v/AAfXfQ17f57FcRINsof7
        searchkick_search_shingle: {
          type: "shingle",
          token_separator: "",
          output_unigrams: false,
          output_unigrams_if_no_shingles: true
        },
        searchkick_suggest_shingle: {
          type: "shingle",
          max_shingle_size: 5
        },
        searchkick_edge_ngram: {
          type: "edge_ngram",
          min_gram: 1,
          max_gram: 50
        },
        searchkick_ngram: {
          type: "ngram",
          min_gram: 1,
          max_gram: 50
        },
        searchkick_stemmer: {
          # use stemmer if language is lowercase, snowball otherwise
          type: language == language.to_s.downcase ? "stemmer" : "snowball",
          language: language || "English"
        }
      },
      char_filter: {
        # https://www.elastic.co/guide/en/elasticsearch/guide/current/custom-analyzers.html
        # &_to_and
        ampersand: {
          type: "mapping",
          mappings: ["&=> and "]
        }
      }
    }
  }

  raise ArgumentError, "Can't pass both language and stemmer" if options[:stemmer] && language
  update_language(settings, language)
  update_stemming(settings)

  if Searchkick.env == "test"
    settings[:number_of_shards] = 1
    settings[:number_of_replicas] = 0
  end

  if options[:similarity]
    settings[:similarity] = {default: {type: options[:similarity]}}
  end

  settings[:index] = {
    max_ngram_diff: 49,
    max_shingle_diff: 4
  }

  if options[:knn]
    unless Searchkick.knn_support?
      if Searchkick.opensearch?
        raise Error, "knn requires OpenSearch 2.4+"
      else
        raise Error, "knn requires Elasticsearch 8.6+"
      end
    end

    if Searchkick.opensearch? && options[:knn].any? { |_, v| !v[:distance].nil? }
      # only enable if doing approximate search
      settings[:index][:knn] = true
    end
  end

  if options[:case_sensitive]
    settings[:analysis][:analyzer].each do |_, analyzer|
      analyzer[:filter].delete("lowercase")
    end
  end

  add_synonyms(settings)
  add_search_synonyms(settings)

  if options[:special_characters] == false
    settings[:analysis][:analyzer].each_value do |analyzer_settings|
      analyzer_settings[:filter].reject! { |f| f == "asciifolding" }
    end
  end

  settings
end

#index_options ⇒ Object 



9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
 
# File 'lib/searchkick/index_options.rb', line 9

def index_options
  # mortal symbols are garbage collected in Ruby 2.2+
  custom_settings = (options[:settings] || {}).deep_symbolize_keys
  custom_mappings = (options[:mappings] || {}).deep_symbolize_keys

  if options[:mappings] && !options[:merge_mappings]
    settings = custom_settings
    mappings = custom_mappings
  else
    settings = generate_settings.deep_symbolize_keys.deep_merge(custom_settings)
    mappings = generate_mappings.deep_symbolize_keys.deep_merge(custom_mappings)
  end

  set_deep_paging(settings) if options[:deep_paging] || options[:max_result_window]

  {
    settings: settings,
    mappings: mappings
  }
end

#index_type ⇒ Object 



607
608
609
610
611
612
613
 
# File 'lib/searchkick/index_options.rb', line 607

def index_type
  @index_type ||= begin
    index_type = options[:_type]
    index_type = index_type.call if index_type.respond_to?(:call)
    index_type
  end
end

#set_deep_paging(settings) ⇒ Object 



600
601
602
603
604
605
 
# File 'lib/searchkick/index_options.rb', line 600

def set_deep_paging(settings)
  if !settings.dig(:index, :max_result_window) && !settings[:"index.max_result_window"]
    settings[:index] ||= {}
    settings[:index][:max_result_window] = options[:max_result_window] || 1_000_000_000
  end
end

#update_language(settings, language) ⇒ Object 



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

def update_language(settings, language)
  case language
  when "chinese"
    settings[:analysis][:analyzer].merge!(
      default_analyzer => {
        type: "ik_smart"
      },
      searchkick_search: {
        type: "ik_smart"
      },
      searchkick_search2: {
        type: "ik_max_word"
      }
    )
  when "chinese2", "smartcn"
    settings[:analysis][:analyzer].merge!(
      default_analyzer => {
        type: "smartcn"
      },
      searchkick_search: {
        type: "smartcn"
      },
      searchkick_search2: {
        type: "smartcn"
      }
    )
  when "japanese", "japanese2"
    analyzer = {
      type: "custom",
      tokenizer: "kuromoji_tokenizer",
      filter: [
        "kuromoji_baseform",
        "kuromoji_part_of_speech",
        "cjk_width",
        "ja_stop",
        "searchkick_stemmer",
        "lowercase"
      ]
    }
    settings[:analysis][:analyzer].merge!(
      default_analyzer => analyzer.deep_dup,
      searchkick_search: analyzer.deep_dup,
      searchkick_search2: analyzer.deep_dup
    )
    settings[:analysis][:filter][:searchkick_stemmer] = {
      type: "kuromoji_stemmer"
    }
  when "korean"
    settings[:analysis][:analyzer].merge!(
      default_analyzer => {
        type: "openkoreantext-analyzer"
      },
      searchkick_search: {
        type: "openkoreantext-analyzer"
      },
      searchkick_search2: {
        type: "openkoreantext-analyzer"
      }
    )
  when "korean2"
    settings[:analysis][:analyzer].merge!(
      default_analyzer => {
        type: "nori"
      },
      searchkick_search: {
        type: "nori"
      },
      searchkick_search2: {
        type: "nori"
      }
    )
  when "vietnamese"
    settings[:analysis][:analyzer].merge!(
      default_analyzer => {
        type: "vi_analyzer"
      },
      searchkick_search: {
        type: "vi_analyzer"
      },
      searchkick_search2: {
        type: "vi_analyzer"
      }
    )
  when "polish", "ukrainian"
    settings[:analysis][:analyzer].merge!(
      default_analyzer => {
        type: language
      },
      searchkick_search: {
        type: language
      },
      searchkick_search2: {
        type: language
      }
    )
  end
end

#update_stemming(settings) ⇒ Object 



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

def update_stemming(settings)
  if options[:stemmer]
    stemmer = options[:stemmer]
    # could also support snowball and stemmer
    case stemmer[:type]
    when "hunspell"
      # supports all token filter options
      settings[:analysis][:filter][:searchkick_stemmer] = stemmer
    else
      raise ArgumentError, "Unknown stemmer: #{stemmer[:type]}"
    end
  end

  stem = options[:stem]

  # language analyzer used
  stem = false if settings[:analysis][:analyzer][default_analyzer][:type] != "custom"

  if stem == false
    settings[:analysis][:filter].delete(:searchkick_stemmer)
    settings[:analysis][:analyzer].each do |_, analyzer|
      analyzer[:filter].delete("searchkick_stemmer") if analyzer[:filter]
    end
  end

  if options[:stemmer_override]
    stemmer_override = {
      type: "stemmer_override"
    }
    if options[:stemmer_override].is_a?(String)
      stemmer_override[:rules_path] = options[:stemmer_override]
    else
      stemmer_override[:rules] = options[:stemmer_override]
    end
    settings[:analysis][:filter][:searchkick_stemmer_override] = stemmer_override

    settings[:analysis][:analyzer].each do |_, analyzer|
      stemmer_index = analyzer[:filter].index("searchkick_stemmer") if analyzer[:filter]
      analyzer[:filter].insert(stemmer_index, "searchkick_stemmer_override") if stemmer_index
    end
  end

  if options[:stem_exclusion]
    settings[:analysis][:filter][:searchkick_stem_exclusion] = {
      type: "keyword_marker",
      keywords: options[:stem_exclusion]
    }

    settings[:analysis][:analyzer].each do |_, analyzer|
      stemmer_index = analyzer[:filter].index("searchkick_stemmer") if analyzer[:filter]
      analyzer[:filter].insert(stemmer_index, "searchkick_stem_exclusion") if stemmer_index
    end
  end
end