API Reference / API Methods / Synonyms / Batch synonyms

Feb. 26, 2019

Batch 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.batch_synonyms(
  Hash synonyms,
  Boolean forwardToReplicas,
  Boolean replaceExistingSynonyms
)

index.batchSynonyms(
  array synonyms,
  {
    forwardToReplicas: boolean,
    replaceExistingSynonyms: boolean
  },
  callback
)

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

This method is not available in mobile API clients.

Synonyms need to be configured via
the Algolia Dashboard or with one of our backend API clients.

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

This method is not available in mobile API clients.

Synonyms need to be configured via
the Algolia Dashboard or with one of our backend API clients.

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

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.

Note that each synonym object counts as a single indexing operation.

Examples

Batch synonyms

Copy

// Batch synonyms,
// with replica forwarding and atomic replacement of existing synonyms

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

# Batch synonyms, with replica forwarding and atomic replacement of existing synonyms
forward_to_replicas = true
replace_existing_synonyms = true

index.batch_synonyms([{
  objectID: 'a-unique-identifier',
  type: 'synonym',
  synonyms: ['car', 'vehicle', 'auto']
}, {
  objectID: 'another-unique-identifier',
  type: 'synonym',
  synonyms: ['street', 'st']
}], forward_to_replicas, replace_existing_synonyms)

// Batch synonyms, with replica forwarding and atomic replacement of existing synonyms
const synonyms = [{
  objectID: 'a-unique-identifier',
  type: 'synonym',
  synonyms: ['car', 'vehicle', 'auto']
}, {
  objectID: 'another-unique-identifier',
  type: 'synonym',
  synonyms: ['street', 'st']
}];

index.batchSynonyms(synonyms, {
  forwardToReplicas: true,
  replaceExistingSynonyms: true
}, (err, content) => {
  if (err) throw err;

  console.log(content);
});

# Batch synonyms, with replica forwarding and atomic replacement of existing synonyms
index.save_synonyms(
    [
        {
            'objectID': 'a-unique-identifier',
            'type': 'synonym',
            'synonyms': ['car', 'vehicle', 'auto']
        },
        {
            'objectID': 'another-unique-identifier',
            'type': 'synonym',
            'synonyms': ['street', 'st']
        }
    ],
    {
        'forwardToReplicas': True,
        'replaceExistingSynonyms': True
    }
)

List<Synonym> synonyms = new List<Synonym>
{
    new Synonym
    {
      ObjectID = "a-unique-identifier",
      Type = "synonym",
      Synonyms = new List<string> { "car", "vehicle", "auto" }
    },
    new Synonym
    {
      ObjectID = "another-unique-identifier",
      Type = "synonym",
      Synonyms = new List<string> { "street", "st" }
    }
};

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

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

// 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("a-unique-identifier")
      .setSynonyms(Arrays.asList("car", "vehicle", "auto")),
    new Synonym()
      .setObjectID("another-unique-identifier")
      .setSynonyms(Arrays.asList("street", "st")));

index.saveSynonyms(synonyms, forwardToReplicas, replaceExistingSynonyms);

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

opts := []interface{}{
	opt.ForwardToReplicas(true),
	opt.ReplaceExistingSynonyms(true),
}

synonyms := []search.Synonym{
	search.NewRegularSynonym("a-unique-identifier", "car", "vehicle", "auto"),
	search.NewRegularSynonym("another-unique-identifier", "street", "st"),
}

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

// Batch synonyms, with replica forwarding
// and atomic replacement of existing synonyms
client.execute {
  save synonyms Seq(
    Synonym(
      "a-unique-identifier",
      Seq("car", "vehicle", "auto")
    ),
    Synonym(
      "another-unique-identifier",
      Seq("street", "st")
    )
  ) inIndex "index_name" and forwardToReplicas and replaceExistingSynonyms
}

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)

Parameters


            synonyms

type: list

Required

Array of synonym.


            forwardToReplicas

type: boolean

default: false

optional

Sends synonyms to all replicas.

Without this parameter, or by setting it to false, the method will apply the change only to the specified index. If you want to forward your synonyms to replicas you will need to set this parameter to true.


            replaceExistingSynonyms

type: boolean

default: false

optional

Forces the engine to replace all synonyms, using an atomic save.

Normally, to replace all synonyms on an index, you would first clear the synonyms, using clearAllSynonyms, and then create a new list. However, between the clear and the add, your index will have no synonyms. This is where replaceExistingSynonyms comes into play.

By adding this parameter, you do not need to use clearAllSynonyms, it’s done for you. This parameter tells the engine to delete all existing synonyms before recreating a new list from the synonyms listed in the current call. This is the only way to avoid having no synonyms, ensuring that your index will always provide a full list of synonyms to your end-users.

Response

In this section we document the JSON response returned by the API. Each language will encapsulate this response inside objects specific to the language and/or the implementation. So the actual type in your language might differ from what is documented.

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.

Building Search UI

Building Search UI

Building Search UI

Building Search UI

Building Search UI

Building Search UI

PHP

Ruby

JavaScript

Python

iOS

Kotlin

Android

.NET

Java

Golang

Scala

InstantSearch.js

React InstantSearch

Vue InstantSearch

Angular InstantSearch

iOS InstantSearch

Android InstantSearch

Index settings and search parameters

A full reference of API Endpoints

Rails

Symfony

Django

Laravel

Magento 1

Magento 2

WordPress

Shopify

Batch Synonyms

About this method

Examples

Batch synonyms

Parameters

Response

JSON format

Did you find this page helpful?

On this page