IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
Delete synonym ruleedit
This functionality is in beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features.
Deletes an individual synonym rule from a synonyms set.
Requestedit
DELETE _synonyms/<synonyms_set>/<synonym_rule>
Prerequisitesedit
Requires the manage_search_synonyms
cluster privilege.
Path parametersedit
-
<synonyms_set>
- (Required, string) Synonyms set identifier to update.
-
<synonym_rule>
- (Required, string) Synonym rule identifier to delete.
Response codesedit
-
404
(Missing resources) -
The
synonyms_set
identifier was not found, or the synonym rule specified bysynonym_rule
was not found in the synonyms set.
Examplesedit
The following example deletes an existing synonym rule called test-1
for the synonyms set my-synonyms-set
:
response = client.synonyms.delete_synonym_rule( set_id: 'my-synonyms-set', rule_id: 'test-1' ) puts 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.