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
12
13
14
15
16
import algoliasearch.api.SearchClient
import algoliasearch.config.*
import algoliasearch.extension.SearchClientExtensions
val client = SearchClient(appId = "ALGOLIA_APPLICATION_ID", apiKey = "ALGOLIA_API_KEY")
val response = client.saveSynonym(
indexName = "ALGOLIA_INDEX_NAME",
objectID = "id1",
synonymHit = SynonymHit(
objectID = "id1",
`type` = SynonymType.withName("synonym"),
synonyms = Some(Seq("car", "vehicule", "auto"))
),
forwardToReplicas = Some(true)
)
Did you find this page helpful?
