Get synonyms set

GET _synonyms/<synonyms_set>

Requires the manage_search_synonyms cluster privilege.

The following example retrieves a synonyms set called my-synonyms-set:

resp = client.synonyms.get_synonym(
    id="my-synonyms-set",
)
print(resp)

response = client.synonyms.get_synonym(
  id: 'my-synonyms-set'
)
puts response

const response = await client.synonyms.getSynonym({
  id: "my-synonyms-set",
});
console.log(response);

GET _synonyms/my-synonyms-set

The synonyms set information returned will include the total number of synonyms rules that the synonyms set contains, and the synonyms rules according to the from and size parameters.

A sample response:

{
  "count": 3,
  "synonyms_set": [
    {
      "id": "test-1",
      "synonyms": "hello, hi"
    },
    {
      "id": "test-2",
      "synonyms": "bye, goodbye"
    },
    {
      "id": "test-3",
      "synonyms": "test => check"
    }
  ]
}