Module: SwiftypeAppSearch::Client::SearchSettings

Included in:
SwiftypeAppSearch::Client
Defined in:
lib/swiftype-app-search/client/search_settings.rb

Instance Method Summary collapse

Instance Method Details

#reset_settings(engine_name) ⇒ Hash

Reset Engine’s Search Settings to default values.

Parameters:

  • engine_name (String) —

    the unique Engine name

Returns:

  • (Hash) —

    default Search Settings



30
31
32
 
# File 'lib/swiftype-app-search/client/search_settings.rb', line 30

def reset_settings(engine_name)
  post("engines/#{engine_name}/search_settings/reset")
end

#show_settings(engine_name) ⇒ Hash

Show all Weights and Boosts applied to the search fields of an Engine.

Parameters:

  • engine_name (String) —

    the unique Engine name

Returns:

  • (Hash) —

    current Search Settings



11
12
13
 
# File 'lib/swiftype-app-search/client/search_settings.rb', line 11

def show_settings(engine_name)
  get("engines/#{engine_name}/search_settings")
end

#update_settings(engine_name, settings) ⇒ Hash

Update Weights or Boosts for search fields of an Engine.

Parameters:

  • engine_name (String) —

    the unique Engine name

  • settings (Hash) —

    new Search Settings Hash

Returns:

  • (Hash) —

    new Search Settings



21
22
23
 
# File 'lib/swiftype-app-search/client/search_settings.rb', line 21

def update_settings(engine_name, settings)
  put("engines/#{engine_name}/search_settings", settings)
end