IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
Get synonym rule
editGet synonym rule
editRetrieves a synonym rule from a synonyms set.
Request
editGET _synonyms/<synonyms_set>/<synonym_rule>
Prerequisites
editRequires the manage_search_synonyms
cluster privilege.
Path parameters
edit-
<synonyms_set>
- (Required, string) Synonyms set identifier to retrieve the synonym rule from.
-
<synonym_rule>
- (Required, string) Synonym rule identifier to retrieve.
Response codes
edit-
404
(Missing resources) -
The
synonyms_set
identifier was not found, or the synonym rule specified bysynonym_rule
was not found in the synonyms set.
Examples
editThe following example retrieves an existing synonym rule called test-1
for the synonyms set my-synonyms-set
:
response = client.synonyms.get_synonym_rule( set_id: 'my-synonyms-set', rule_id: 'test-1' ) puts response
GET _synonyms/my-synonyms-set/test-1
{ "id": "test-1", "synonyms": "hello, hi" }