This documentation contains work-in-progress information for future Elastic Stack and Cloud releases. Use the version selector to view supported release docs. It also contains some Elastic Cloud serverless information. Check out our serverless docs for more details.

« Get synonym rule Text structure APIs »

› › ›

Delete synonym rule

edit

Delete synonym rule

edit

Deletes an individual synonym rule from a synonyms set.

Request

edit

DELETE _synonyms/<synonyms_set>/<synonym_rule>

Prerequisites

edit

Requires the manage_search_synonyms cluster privilege.

Path parameters

edit

<synonyms_set>: (Required, string) Synonyms set identifier to update.
<synonym_rule>: (Required, string) Synonym rule identifier to delete.

Response codes

edit

404 (Missing resources): The synonyms_set identifier was not found, or the synonym rule specified by synonym_rule was not found in the synonyms set.

Examples

edit

The following example deletes an existing synonym rule called test-1 for the synonyms set my-synonyms-set:

resp = client.synonyms.delete_synonym_rule(
    set_id="my-synonyms-set",
    rule_id="test-1",
)
print(resp)

response = client.synonyms.delete_synonym_rule(
  set_id: 'my-synonyms-set',
  rule_id: 'test-1'
)
puts response

const response = await client.synonyms.deleteSynonymRule({
  set_id: "my-synonyms-set",
  rule_id: "test-1",
});
console.log(response);

DELETE _synonyms/my-synonyms-set/test-1

{
  "result": "deleted",
  "reload_analyzers_details": {
    "_shards": {
      "total": 2,
      "successful": 1,
      "failed": 0
    },
    "reload_details": [
      {
        "index": "test-index",
        "reloaded_analyzers": [
          "my_search_analyzer"
        ],
        "reloaded_node_ids": [
          "1wYFZzq8Sxeu_Jvt9mlbkg"
        ]
      }
    ]
  }
}

All analyzers using this synonyms set will be reloaded automatically to reflect the rule being deleted.

« Get synonym rule Text structure APIs »