Create or replace synonyms

If a synonym with the objectID doesn’t exist, Algolia adds a new one. Otherwise, existing synonyms are replaced.

This operation is subject to indexing rate limits.

Usage

Required ACL: editSettings
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
use Algolia\AlgoliaSearch\Api\SearchClient;

$client = SearchClient::create('ALGOLIA_APPLICATION_ID', 'ALGOLIA_API_KEY');

$response = $client->saveSynonyms(
    'ALGOLIA_INDEX_NAME',
    [
        ['objectID' => 'id1',
            'type' => 'synonym',
            'synonyms' => [
                'car',

                'vehicule',

                'auto',
            ],
        ],

        ['objectID' => 'id2',
            'type' => 'onewaysynonym',
            'input' => 'iphone',
            'synonyms' => [
                'ephone',

                'aphone',

                'yphone',
            ],
        ],
    ],
    true,
    true,
);
Did you find this page helpful?
PHP API clients v4