Api clients / Ruby / V1 / Methods

Jun. 25, 2024

Replace All Synonyms | Ruby API Client V1 (Deprecated)

A

Deprecated content

This documentation is for a deprecated version of Ruby API client . Some features and settings may be missing or their usage may have changed. Refer to the documentation for the latest version of Ruby API client for up-to-date information.

Required API Key: any key with the editSettings ACL

Method signature

index.replace_all_synonyms(Array synonyms)
index.replace_all_synonyms(Array synonyms, {
  'forwardToReplicas': Boolean
})

See code examples

About this method# A

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# A

Replace all synonyms#

Copy

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

$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
10
11
12
client = Algolia::Client.new({
    :application_id => 'AJ0P3S7DWQ',
    :api_key => '••••••••••••••••••••ce1181300d403d21311d5bca9ef1e6fb'
})

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('AJ0P3S7DWQ', '••••••••••••••••••••ce1181300d403d21311d5bca9ef1e6fb');

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('AJ0P3S7DWQ', '••••••••••••••••••••ce1181300d403d21311d5bca9ef1e6fb')

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: "AJ0P3S7DWQ", apiKey: "••••••••••••••••••••ce1181300d403d21311d5bca9ef1e6fb")
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("AJ0P3S7DWQ", "••••••••••••••••••••ce1181300d403d21311d5bca9ef1e6fb");
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("AJ0P3S7DWQ", "••••••••••••••••••••ce1181300d403d21311d5bca9ef1e6fb");

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("AJ0P3S7DWQ", "YourAdminKey")
    index := client.InitIndex("your_index_name")

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

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

Parameters# A

`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 request options to send along with the request.

Response# A

No response.

Did you find this page helpful?