Composition API client

The Composition API client is part of the algoliasearch-client-php package. To install this package, run:

Copy

1
composer require algolia/algoliasearch-client-php

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

Copy

1
use Algolia\AlgoliaSearch\Api\CompositionClient;

To create an instance of the client:

Copy

1
$client = 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.searchForFacetValues	Search for facet values

client.listCompositions	List compositions
client.getComposition	Retrieve a composition
client.putComposition	Upsert a composition
client.deleteComposition	Delete a composition
client.multipleBatch	Batch action to multiple compositions

client.getRule	Retrieve a rule
client.putCompositionRule	Upsert a composition rule
client.deleteCompositionRule	Delete a Composition Rule
client.saveRules	Create or update or delete composition rules
client.searchCompositionRules	Search for composition rules

Check task status