Class: Dina::SearchAutocomplete

Inherits:
BaseSearch show all
Defined in:
lib/dina/search/search_autocomplete.rb

Class Method Summary collapse

Methods inherited from BaseSearch

endpoint, index_name, verify_ssl

Methods inherited from BaseModel

custom_headers, find_by_group, #initialize, properties, site

Constructor Details

This class inherits a constructor from Dina::BaseModel

Class Method Details

.endpoint_path ⇒ Object 



6
7
8
 
# File 'lib/dina/search/search_autocomplete.rb', line 6

def self.endpoint_path
  "search-api/search-ws/auto-complete"
end

.execute(term:, index:, field: nil, group: nil) ⇒ Hash

Executes an autocomplete search

Known field values (dependent on chosen index):

agent: data.attributes.displayName
material_sample: included.attributes.dwcRecordedBy, included.attributes.verbatimDeterminer
object_store: none

Parameters:

  • term (String) —

    the search term

  • index (String) —

    the index, accepted value is one of “agent”, “material_sample”, “object_store”

  • field (String) (defaults to: nil)
  • group (String) (defaults to: nil) —

    the DINA group name

Returns:

  • (Hash) —

    the search result with symbolized keys



23
24
25
26
27
28
29
30
31
 
# File 'lib/dina/search/search_autocomplete.rb', line 23

def self.execute(term:, index:, field: nil, group: nil)
  params = {
    prefix: term,
    indexName: index_name(index: index),
    autoCompleteField: field,
    group: group
  }
  super(params.compact)[:hits]
end