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
import com.algolia.api.SearchClient;
import com.algolia.model.search.*;

SearchClient client = new SearchClient("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY");

client.saveSynonyms(
  "ALGOLIA_INDEX_NAME",
  Arrays.asList(
    new SynonymHit().setObjectID("id1").setType(SynonymType.SYNONYM).setSynonyms(Arrays.asList("car", "vehicule", "auto")),
    new SynonymHit()
      .setObjectID("id2")
      .setType(SynonymType.ONEWAYSYNONYM)
      .setInput("iphone")
      .setSynonyms(Arrays.asList("ephone", "aphone", "yphone"))
  ),
  true,
  true
);
Did you find this page helpful?
Java API clients v4