API clients / Dart / Search

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

import 'package:algolia_client_search/algolia_client_search.dart';

final client =
    SearchClient(appId: 'ALGOLIA_APPLICATION_ID', apiKey: 'ALGOLIA_API_KEY');

final response = await client.saveSynonyms(
  indexName: "ALGOLIA_INDEX_NAME",
  synonymHit: [
    SynonymHit(
      objectID: "id1",
      type: SynonymType.fromJson("synonym"),
      synonyms: [
        "car",
        "vehicule",
        "auto",
      ],
    ),
    SynonymHit(
      objectID: "id2",
      type: SynonymType.fromJson("onewaysynonym"),
      input: "iphone",
      synonyms: [
        "ephone",
        "aphone",
        "yphone",
      ],
    ),
  ],
  forwardToReplicas: true,
  replaceExistingSynonyms: true,
);
See full API reference
Did you find this page helpful?