Sep 20, 2024
Create or replace a synonym
If a synonym with the specified object ID doesn’t exist, Algolia adds a new one.
Otherwise, the existing synonym is replaced.
To add multiple synonyms in a single API request, use the batch
operation.
Usage
Required ACL:
editSettings
Copy
1
2
3
4
5
6
7
8
9
10
11
import { algoliasearch } from 'algoliasearch';
//
const client = algoliasearch('ALGOLIA_APPLICATION_ID', 'ALGOLIA_API_KEY');
const response = await client.saveSynonym({
indexName: 'indexName',
objectID: 'id1',
synonymHit: { objectID: 'id1', type: 'synonym', synonyms: ['car', 'vehicule', 'auto'] },
forwardToReplicas: true,
});
Did you find this page helpful?