API client / Methods / Synonyms

Jun. 08, 2023

Replace all synonyms

Required API Key: any key with the editSettings ACL

Method signature

$index->replaceAllSynonyms(array synonyms);
$index->replaceAllSynonyms(array synonyms, [
  'forwardToReplicas' => boolean
]);

index.replace_all_synonyms(Array synonyms)

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

index.replaceAllSynonyms(array synonyms)

index.replaceAllSynonyms(array synonyms, [
  // All the following parameters are optional
  forwardToReplicas: boolean,
  // any other requestOptions
])

index.replace_all_synonyms(list synonyms)
index.replace_all_synonyms(list synonyms, {
    'forwardToReplicas': bool
})

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

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

index.ReplaceAllSynonyms(
  synonyms,

  // All the following parameters are optional
  forwardToReplicas: forwardToReplicas
)

index.replaceAllSynonyms(
  List<Synonym> synonyms
);
index.replaceAllSynonyms(
  List<Synonym> synonyms,
  bool forwardToReplicas
);

index.ReplaceAllSynonyms([]Synonym synonyms)
index.ReplaceAllSynonyms([]Synonym synonyms, opt.ForwardToReplicas(bool forwardToReplicas))

Not implemented yet.

See code examples

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.

About this method

Push a new set of synonyms and erase all previous ones.

This method, like replaceAllObjects, guarantees zero downtime.

All existing synonyms are deleted and replaced with the new ones, in a single, atomic operation.

Examples

Read the Algolia CLI documentation for more information.

Replace all synonyms

Copy

1
2
3
4
5
6
7
8
9
10
11
12
$client = Algolia\AlgoliaSearch\SearchClient::create(
  'YourApplicationID',
  'YourWriteAPIKey'
);

$synonyms = /* Fetch your synonyms */;

$index = $client->initIndex('your_index_name');
$index->replaceAllSynonyms($synonyms);

// Or if you want to also replace synonyms on replicas
$index->replaceAllSynonyms($synonyms, ['forwardToReplicas' => true]);

1
2
3
4
5
6
7
8
9
client = Algolia::Search::Client.create('YourApplicationID', 'YourWriteAPIKey')

synonyms = [] # Fetch your synonyms

index = client.init_index('your_index_name')
index.replace_all_synonyms(synonyms)

# Or if you want to also replace synonyms on replicas
index.replace_all_synonyms(synonyms, { forwardToReplicas: true })

1
2
3
4
5
6
7
8
9
10
11
12
13
14
const client = algoliasearch('YourApplicationID', 'YourWriteAPIKey');

const synonyms = [/* Fetch your synonyms */];

const index = client.initIndex('your_index_name');

index.replaceAllSynonyms(synonyms).then(() => {
  // done
});

// Or if you want to also replace synonyms on replicas
index.replaceAllSynonyms(synonyms, { forwardToReplicas: true }).then(() => {
  // done
});

1
2
3
4
5
6
7
8
9
client = SearchClient.create('YourApplicationID', 'YourWriteAPIKey')

synonyms = [] # Fetch your synonyms

index = client.init_index('your_index_name')
index.replace_all_synonyms(synonyms)

# Or if you want to also replace synonyms on replicas
index.replace_all_synonyms(synonyms, {'forwardToReplicas': True})

1
2
3
4
5
6
7
8
9
10
11
let client = SearchClient(appID: "YourApplicationID", apiKey: "YourWriteAPIKey")
let index = client.index(withName: "your_index_name")

let synonyms: [Synonym] = [/* Fetch your synonyms */]

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

1
2
3
4
5
6
7
8
9
10
11
12
SearchClient client = new SearchClient("YourApplicationID", "YourWriteAPIKey");
SearchIndex index = client.InitIndex("your_index_name");

List<Synonym> synonyms = /* Fetch your synonyms */

index.ReplaceAllSynonyms(synonyms);

// Or if you want to also replace synonyms on replicas
index.ReplaceAllSynonyms(synonyms, forwardToReplicas: true);

// Asynchronous
await index.ReplaceAllSynonymsAsync(synonyms, forwardToReplicas: true);

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
SearchClient client =
DefaultSearchClient.create("YourApplicationID", "YourWriteAPIKey");

SearchIndex index = client.initIndex("your_index_name");

List<Synonym> synonyms = /* Fetch your synonyms */

index.replaceAllSynonyms(synonyms);

// Or if you want to also replace synonyms on replicas
index.replaceAllSynonyms(synonyms, true);

// Async
index.replaceAllSynonymsAsync(synonyms);
index.replaceAllSynonymsAsync(synonyms, true);

1
2
3
4
5
6
7
8
9
10
11
12
13
14
package main

import (
    "github.com/algolia/algoliasearch-client-go/v3/algolia/search"
)

func main() {
    client := search.NewClient("YourApplicationID", "YourAdminKey")
    index := client.InitIndex("your_index_name")

    synonyms := []search.Synonym{ /* Fetch your synonyms */ }

    res, err := index.ReplaceAllSynonyms(synonyms)
}

Parameters

Parameter	Description
`synonyms`	type: list Required A list of synonyms
`forwardToReplicas`	type: boolean default: false Optional Also replace synonyms on replicas
`requestOptions`	type: key/value mapping default: No request options Optional A mapping of `requestOptions` to send along with the request.

Response

This method doesn't return a response.

Did you find this page helpful?