Clear all synonyms

Remove all synonyms from an index.

Required ACL: editSettings

Don’t use this method to replace all synonyms in your production indices. Doing so causes a short downtime during which the index has no synonyms.

Instead, use saveSynonyms with the replaceExistingSynonyms option to replace all synonyms without downtime.

Examples

C#

index.ClearSynonyms(forwardToReplicas: true);

// Asynchronous
await index.ClearSynonymsAsync(forwardToReplicas: true);

forwardToReplicas := opt.ForwardToReplicas(true)
res, err := index.ClearSynonyms(forwardToReplicas)

boolean forwardToReplicas = true;

index.clearSynonyms(forwardToReplicas);

// Asynchronous
index.clearSynonymsAsync(forwardToReplicas);

index.clearSynonyms({ forwardToReplicas: true }).then(() => {
  // done
});

index.clearSynonyms(forwardToReplicas = true)

$index->clearSynonyms([
  'forwardToReplicas' => true
]);

# Clear synonyms and forward to replicas
index.clear_synonyms({
    'forwardToReplicas': True
})

# Clear synonyms and forward to replicas
index.clear_synonyms({ forwardToReplicas: true })

client.execute {
  clear synonyms of index "index_name" and forwardToReplicas
}

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

Parameters

forwardToReplicas · boolean · default: false

Whether to delete all synonyms from all replicas of the index.

Response

taskID · integer

The task ID used with the waitTask method.

updatedAt · string

Date at which the indexing job has been created.

Response as JSON

This section shows the JSON response returned by the API. Each API client wraps this response in language-specific objects, so the structure may vary. To view the response, use the getLogs method. Don’t rely on the order of properties—JSON objects don’t preserve key order.

JSON

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