Composition API client

The Composition API client is part of the algolia gem. To install this gem, run:

Copy

1
gem install algolia

To use the Composition client, add this import to your files:

Copy

1
require "algolia"

To create an instance of the client:

Copy

1
client = Algolia::CompositionClient.create("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY")

List of methods

Each method makes one request to the Composition API.

client.search	Run a Composition
client.search_for_facet_values	Search for facet values

client.list_compositions	List compositions
client.get_composition	Retrieve a composition
client.put_composition	Upsert a composition
client.delete_composition	Delete a composition
client.multiple_batch	Batch action to multiple compositions

client.get_rule	Retrieve a rule
client.put_composition_rule	Upsert a composition rule
client.delete_composition_rule	Delete a Composition Rule
client.save_rules	Create or update or delete composition rules
client.search_composition_rules	Search for composition rules

Check task status