IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« Create or update synonym rule Delete synonym rule »

› › ›

Get synonym rule

edit

IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

Get synonym rule

edit

Retrieves a synonym rule from a synonyms set.

Request

edit

GET _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 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 by synonym_rule was not found in the synonyms set.

Examples

edit

The 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"
}

« Create or update synonym rule Delete synonym rule »