Sep 20, 2024
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
Copy
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
from algoliasearch.search.client import SearchClientSync
# In an asynchronous context, you can use SearchClient instead, which exposes the exact same methods.
client = SearchClientSync("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY")
response = client.save_synonyms(
index_name="ALGOLIA_INDEX_NAME",
synonym_hit=[
{
"objectID": "id1",
"type": "synonym",
"synonyms": [
"car",
"vehicule",
"auto",
],
},
{
"objectID": "id2",
"type": "onewaysynonym",
"input": "iphone",
"synonyms": [
"ephone",
"aphone",
"yphone",
],
},
],
forward_to_replicas=True,
replace_existing_synonyms=True,
)
Did you find this page helpful?