Skip to main content
The latest major version of the algolia gem is version 3. This page lists the breaking changes introduced since the previous major release, version 2.

​
Method changes overview

The following table has links for all methods and their replacements

​
Search API client

Version 2 (legacy)Version 3 (current)
client.add_api_key→client.add_api_key
client.add_api_key.wait→client.wait_for_api_key
client.clear_dictionary_entries→client.batch_dictionary_entries
client.copy_index→client.operation_index
client.copy_rules→client.operation_index
client.copy_synonyms→client.operation_index
client.delete_api_key→client.delete_api_key
client.delete_dictionary_entries→client.batch_dictionary_entries
client.generate_secured_api_key→client.generate_secured_api_key
client.get_api_key→client.get_api_key
client.get_secured_api_key_remaining_validity→client.get_secured_api_key_remaining_validity
client.get_top_user_id→client.get_top_user_ids
client.list_api_keys→client.list_api_keys
client.list_indexes→client.list_indices
client.move_index→client.operation_index
client.multiple_batch→client.multiple_batch
client.multiple_queries→client.search
client.replace_dictionary_entries→client.batch_dictionary_entries
client.restore_api_key→client.restore_api_key
client.save_dictionary_entries→client.batch_dictionary_entries
client.update_api_key→client.update_api_key
index.batch→client.batch
index.browse_objects→client.browse_objects
index.browse_rules→client.browse_rules
index.browse_synonyms→client.browse_synonyms
index.clear_objects→client.clear_objects
index.clear_rules→client.clear_rules
index.clear_synonyms→client.clear_synonyms
index.copy_settings→client.operation_index
index.delete→client.delete_index
index.delete_by→client.delete_by
index.delete_object→client.delete_object
index.delete_objects→client.delete_objects
index.delete_rule→client.delete_rule
index.delete_synonym→client.delete_synonym
index.find_object→client.search_single_index
index.get_object→client.get_object
index.get_objects→client.get_objects
index.get_rule→client.get_rule
index.get_settings→client.get_settings
index.get_synonym→client.get_synonym
index.get_task→client.get_task
index.partial_update_object→client.partial_update_object
index.partial_update_objects→client.partial_update_objects
index.replace_all_objects→client.replace_all_objects
index.replace_all_rules→client.save_rules
index.replace_all_synonyms→client.save_synonyms
index.save_object→client.save_object
index.save_objects→client.save_objects
index.save_rule→client.save_rule
index.save_rules→client.save_rules
index.save_synonym→client.save_synonym
index.save_synonyms→client.save_synonyms
index.search→client.search_single_index
index.search_for_facet_values→client.search_for_facet_values
index.search_rules→client.search_rules
index.search_synonyms→client.search_synonyms
index.set_settings→client.set_settings
index.{operation}.wait→client.wait_for_task

​
Recommend API client

Version 2 (legacy)Version 3 (current)
client.get_frequently_bought_together→client.get_recommendations
client.get_recommendations→client.get_recommendations
client.get_related_products→client.get_recommendations

​
Client imports

The class names for the API clients changed.
Ruby
# Search API
Algolia::SearchClient
# Recommend API
Algolia::RecommendClient
# A/B testing
Algolia::AbtestingClient
# Analytics API
Algolia::AnalyticsClient
# Ingestion API
Algolia::IngestionClient
# Insights API
Algolia::InsightsClient
# Monitoring API
Algolia::MonitoringClient
# Personalization API
Algolia::PersonalizationClient
# Query Suggestions API
Algolia::QuerySuggestionsClient
# Usage API
Algolia::UsageClient

​
Removal of init_index

All methods are methods of a client instance. The init_index method of the SearchClient has been removed. Instead, all methods require a index_name parameter.
Ruby
# version 2
client = Algolia::Search::Client.create("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY")
index = client.init_index("ALGOLIA_INDEX_NAME")
index.search("QUERY")

# version 3
client = Algolia::Search::Client.create("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY")
client.search_single_index("ALGOLIA_INDEX_NAME", {query: "QUERY"})

​
Wait for tasks

The wait method has been removed. Instead, use one of the following helpers:

​
Copy or move indices, settings, synonyms, or rules

Use the operation_index method, which replaces the following methods:
  • copy_index
  • move_index
  • copy_rules
  • copy_synonyms
  • copy_settings