API Reference / API Methods / Synonyms / Save synonyms

Aug. 16, 2022

Save Synonyms

Required API Key: any key with the editSettings ACL

Method signature

$index->saveSynonyms(array synonyms)

$index->saveSynonyms(array synonyms), [
  // All the following parameters are optional
  'forwardToReplicas' => boolean,
  'replaceExistingSynonyms' => boolean
])

index.save_synonyms(
  Array synonyms,
  Hash opts = {
    Boolean forwardToReplicas: false,
    Boolean replaceExistingSynonyms: false
  }
)

index.saveSynonyms(array synonyms)

index.saveSynonyms(array synonyms, {
  // All the following parameters are optional
  forwardToReplicas: boolean,
  replaceExistingSynonyms: boolean
})

index.save_synonyms(list synonyms, {
    // All the following parameters are optional
    'forwardToReplicas': bool,
    'replaceExistingSynonyms': bool
})

index.saveSynonyms(
  _ synonyms: [Synonym],
  forwardToReplicas: Bool? = nil,
  replaceExistingSynonyms: Bool? = nil,
  requestOptions: RequestOptions? = nil,
  completion: Result<IndexRevision> -> Void
)

suspend fun Index.saveSynonyms(
    synonyms: List<Synonym>,
    forwardToReplicas: Boolean? = null,
    replaceExistingSynonyms: Boolean? = null,
    requestOptions: RequestOptions? = null
): RevisionIndex

index.SaveSynonyms(
  IEnumerable<Synonym> synonyms,

  // All the following parameters are optional
  forwardToReplicas: bool,
  replaceExistingSynonyms: bool
)

index.saveSyonyms(
  List<Synonym> synonyms,
  bool forwardToReplicas,
  bool replaceExistingSynonyms
)

index.SaveSynonyms([]Synonym synonyms)
index.SaveSynonyms([]Synonym synonyms, opt.ForwardToReplicas(bool forwardToReplicas))
index.SaveSynonyms([]Synonym synonyms, opt.ReplaceExistingSynonyms(bool replaceExistingSynonyms))

save.synonyms(List<Synonym> synonyms)
  .inIndex("index_name")
  .and(bool forwardToReplicas)
  .and(bool replaceExistingSynonyms)

See code examples

About this method

We released a new version of the PHP API client in public beta. Read the beta documentation for more information.

We released a new version of the JavaScript API client in public beta. Read the beta documentation for more information.

We released a new version of the Java API client in public beta. Read the beta documentation for more information.

You’re currently reading the JavaScript API client v4 documentation. Check the migration guide to learn how to upgrade from v3 to v4. You can still access the v3 documentation.

You’re currently reading the Ruby API client v2 documentation. Check the migration guide to learn how to upgrade from v1 to v2. You can still access the v1 documentation.

Create or update multiple synonyms.

This method enables you to create or update one or more synonyms in a single call.

You can also recreate your entire set of synonyms by using the replaceExistingSynonyms parameter.

Each synonym object counts as a single indexing operation.

Examples

Read the Algolia CLI documentation for more information.

Save synonyms

Copy

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
// Batch synonyms,
// with replica forwarding and atomic replacement of existing synonyms

$index->saveSynonyms(
  [
    [
      "objectID" => "synonymID1",
      "type" => "synonym",
      "synonyms" => ["car", "vehicle", "auto"]
    ],
    [
      "objectID" => "synonymID2",
      "type" => "synonym",
      "synonyms" => ["street", "st"]
    ]
  ], [
    'forwardToReplicas' => true,
    'replaceExistingSynonyms' => true
  ]
);

1
2
3
4
5
6
7
8
9
10
# Batch synonyms, with replica forwarding and atomic replacement of existing synonyms
index.save_synonyms([{
  objectID: 'synonymID1',
  type: 'synonym',
  synonyms: ['car', 'vehicle', 'auto']
}, {
  objectID: 'synonymID2',
  type: 'synonym',
  synonyms: ['street', 'st']
}], { forwardToReplicas: true, replaceExistingSynonyms: true })

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
// Batch synonyms, with replica forwarding and atomic replacement of existing synonyms
const synonyms = [{
  objectID: 'synonymID1',
  type: 'synonym',
  synonyms: ['car', 'vehicle', 'auto']
}, {
  objectID: 'synonymID2',
  type: 'synonym',
  synonyms: ['street', 'st']
}];

index.saveSynonyms(synonyms, {
  forwardToReplicas: true,
  replaceExistingSynonyms: true
}).then(() => {
  // done
});

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
# Batch synonyms, with replica forwarding and atomic replacement of existing synonyms
index.save_synonyms(
    [
        {
            'objectID': 'synonymID1',
            'type': 'synonym',
            'synonyms': ['car', 'vehicle', 'auto']
        },
        {
            'objectID': 'synonymID2',
            'type': 'synonym',
            'synonyms': ['street', 'st']
        }
    ],
    {
        'forwardToReplicas': True,
        'replaceExistingSynonyms': True
    }
)

1
2
3
4
5
6
7
8
9
10
let synonyms: [Synonym] = [
  .multiWay(objectID: "synonymID1", synonyms: ["car", "vehicle", "auto"]),
  .multiWay(objectID: "synonymID2", synonyms: ["street", "st"])
]

index.saveSynonyms(synonyms, forwardToReplicas: true, replaceExistingSynonyms: false) { result in
  if case .success(let response) = result {
    print("Response: \(response)")
  }
}

1
2
3
4
5
6
7
8
9
10
11
val synonyms = listOf(
    Synonym.MultiWay(
        objectID = ObjectID("myID1"),
        synonyms = listOf("car", "vehicle", "auto")
    ),
    Synonym.MultiWay(
        objectID = ObjectID("myID2"),
        synonyms = listOf("street", "st")
    )
)
index.saveSynonyms(synonyms, forwardToReplicas = true, clearExistingSynonyms = true)

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
List<Synonym> synonyms = new List<Synonym>
{
    new Synonym
    {
      ObjectID = "synonymID1",
      Type = "synonym",
      Synonyms = new List<string> { "car", "vehicle", "auto" }
    },
    new Synonym
    {
      ObjectID = "synonymID2",
      Type = "synonym",
      Synonyms = new List<string> { "street", "st" }
    }
};

index.SaveSynonyms(synonyms, forwardToreplicas: true, replaceExistingSynonyms: true);

// Asynchronous
await index.SaveSynonymsAsync(synonyms, forwardToreplicas: true, replaceExistingSynonyms: true);

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
// Batch synonyms, with replica forwarding
// and atomic replacement of existing synonyms

boolean forwardToReplicas = true;
boolean replaceExistingSynonyms = true;

List<Synonym> synonyms = Arrays.asList(
    new Synonym()
      .setObjectID("synonymID1")
      .setSynonyms(Arrays.asList("car", "vehicle", "auto")),
    new Synonym()
      .setObjectID("synonymID2")
      .setSynonyms(Arrays.asList("street", "st")));

index.saveSynonyms(synonyms, forwardToReplicas, replaceExistingSynonyms);

// Asynchronous
index.saveSynonymsAsync(synonyms, forwardToReplicas, replaceExistingSynonyms);

1
2
3
4
5
6
7
8
9
10
11
opts := []interface{}{
	opt.ForwardToReplicas(true),
	opt.ReplaceExistingSynonyms(true),
}

synonyms := []search.Synonym{
	search.NewRegularSynonym("synonymID1", "car", "vehicle", "auto"),
	search.NewRegularSynonym("synonymID2", "street", "st"),
}

res, err := index.SaveSynonyms(synonyms, opts...)

1
2
3
4
5
6
7
8
9
10
11
12
13
14
// Batch synonyms, with replica forwarding
// and atomic replacement of existing synonyms
client.execute {
  save synonyms Seq(
    Synonym(
      "synonymID1",
      Seq("car", "vehicle", "auto")
    ),
    Synonym(
      "synonymID2",
      Seq("street", "st")
    )
  ) inIndex "index_name" and forwardToReplicas and replaceExistingSynonyms
}

1
2
3
4
5
6
7
# Add synonyms to "indexName" from a newline delimited JSON file (see https://github.com/ndjson/ndjson-spec)
algolia synonym import indexName --file synonyms.ndjson

# Add synonyms to "indexName" from the command line
echo ' { "objectID": "synonymID1", "type": "synonym", "synonyms": [ "iphone", "apple phone"] }\n \
{ "objectID": "synonymID2", "type": "synonym", "synonyms": [ "street", "st"] }\n' | \
algolia synonym import indexName --file -

1
2
3
4
5
6
7
8
9
10
11
12
13
14
curl -X POST \
    -H "X-Algolia-API-Key: ${API_KEY}" \
    -H "X-Algolia-Application-Id: ${APPLICATION_ID}" \
    --data-binary '[{
      "objectID": "synonymID1",
      "type": "synonym",
      "synonyms": ["iphone", "ephone", "aphone", "yphone", "apple phone"]
    },{
      "objectID": "synonymID2",
      "type": "onewaysynonym",
      "input": "iphone",
      "synonyms": ["ephone", "aphone", "yphone", "apple phone"]
  }] ' \
  "https://${APPLICATION_ID}.algolia.net/1/indexes/{indexName}/synonyms/batch"

Parameters


            synonyms

type: list

Required

Array of synonym.


            forwardToReplicas

type: boolean

default: false

optional

Sends synonyms to all replicas. Set this parameter to:

false to apply the change only to the specified index.
true to forward your synonyms to replicas.


            replaceExistingSynonyms

type: boolean

default: false

optional

This parameter forces the engine to replace all synonyms.

You can first clear the existing synonyms, using the clearSynonyms method, and then create a new list. However, between clearing and adding the synonyms, your index will have no synonyms.

The replaceExistingSynonyms parameter tells the engine to delete all existing synonyms before recreating new ones from the list in the current call. You don’t need to use clearAllSynonyms. `replaceExistingSynonyms is the only way to ensure that your index will always provide synonyms to your users.

Response

This section shows the JSON response returned by the API. Since each language encapsulates this response inside objects specific to that language and/or implementation, the actual type in your language might differ from what’s written here. You can view the response in the logs (using the getLogs method).

JSON format

Copy

          {
  "updatedAt":"2013-01-18T15:33:13.556Z",
  "taskID": 678
}

        

`updatedAt`	string Date at which the indexing job has been created.
`taskID`	integer The taskID used with the waitTask method.

Did you find this page helpful?