Replace All Rules and Synonyms

In Algolia, you can replace all existing rules and synonyms by leveraging the appropriate methods. This guide will show you how to use saveRules and saveSynonyms methods to achieve this.

Replace All Rules

To replace all existing rules in Algolia, you can use the saveRules method with the clearExistingRules parameter set to true.

C#

await client.saveRules({
  indexName,
  rules,
  clearExistingRules: true,
});

Dart

php

// TODO

Go

client.saveRulesAsync(
  indexName,
  rules,
  false, // forwardToReplicas (defaults to false)
  true // clearExistingRules
);

Java

client.saveRules(
    indexName = indexName,
    rules = rules,
    forwardToReplicas = false,
    clearExistingRules = true
)

JavaScript

await client.saveRules(
  indexName: indexName,
  rules: rules,
  forwardToReplicas: false,
  clearExistingRules: true,
);

Kotlin

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

indexName := "<INDEX_NAME>"
appID := "<APPLICATION_ID>"
apiKey := "<API_KEY>"

searchClient, _ := search.NewClient(appID, apiKey)

response, err := searchClient.SaveRules(
  searchClient.NewApiSaveRulesRequest(
    indexName,
    []search.Rule{/* ... */},
  ).WithClearExistingRules(true),
)
if err != nil {
  return 0
}

taskResponse, err := searchClient.WaitForTask(
  indexName,
  response.TaskID,
  nil,
  nil,
  nil,
)
if err != nil {
  panic(err)
}

PHP

using Algolia.Search.Clients;

var client = new SearchClient("<YOUR_APP_ID>", "<YOUR_API_KEY>");
await client.SaveRulesAsync("<YOUR_INDEX_NAME>", rules, forwardToReplicas: false, clearExistingRules: true);

The rules parameter should contain the array of rules you want to save. By executing the above code, all existing rules will be removed, and the new rules provided will be saved to your Algolia index.

Replace All Synonyms

To replace all existing synonyms in Algolia, you can use the saveSynonyms method with the replaceExistingSynonyms parameter set to true.

C#

await client.saveSynonyms({
  indexName,
  synonymHit,
  replaceExistingSynonyms: true,
});

Dart

php

// TODO

Go

client.saveSynonymsAsync(
  indexName,
  synonymHits,
  false, // forwardToReplicas (defaults to false)
  true // replaceExistingSynonyms
);

Java

client.saveSynonyms(
    indexName = indexName,
    synonymHit = synonymHits,
    forwardToReplicas = false,
    replaceExistingSynonyms = true
)

JavaScript

await client.saveSynonyms(
  indexName: indexName,
  synonymHit: synonymHits,
  forwardToReplicas: false,
  replaceExistingSynonyms: true,
);

Kotlin

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

indexName := "<INDEX_NAME>"
appID := "<APPLICATION_ID>"
apiKey := "<API_KEY>"

searchClient, _ := search.NewClient(appID, apiKey)

response, err := searchClient.SaveSynonyms(
  searchClient.NewApiSaveSynonymsRequest(
    indexName,
    []search.SynonymHit{ /* ... */ },
  ).WithReplaceExistingSynonyms(true),
)
if err != nil {
  return 0
}

taskResponse, err := searchClient.WaitForTask(
  indexName,
  response.TaskID,
  nil,
  nil,
  nil,
)
if err != nil {
  panic(err)
}

PHP

using Algolia.Search.Clients;

var client = new SearchClient("<YOUR_APP_ID>", "<YOUR_API_KEY>");
await client.SaveSynonymsAsync("<YOUR_INDEX_NAME>", synonyms, forwardToReplicas: false, replaceExistingSynonyms: true);

The synonymHitparameter should contain the synonyms you want to save. By executing the above code, all existing synonyms will be replaced with the new synonyms provided.

That’s it! You have learned how to replace all existing rules and synonyms in Algolia using the saveRules and saveSynonyms methods respectively.