List synonyms setsedit
Retrieves a summary of all defined synonyms sets.
This API allows to retrieve the total number of synonyms sets defined. For each synonyms set, its identifier and the total number of defined synonym rules is returned.
Requestedit
GET _synonyms
Prerequisitesedit
Requires the manage_search_synonyms cluster privilege.
Query parametersedit
-
from -
(Optional, integer) Starting offset for synonyms sets to retrieve. Defaults to
0. -
size -
(Optional, integer) Specifies the maximum number of synonyms sets to retrieve. Defaults to
10.
Examplesedit
The following example retrieves all defined synonyms sets:
response = client.synonyms.get_synonyms_sets puts response
GET _synonyms
A sample response:
{
"count": 3,
"results": [
{
"synonyms_set": "ecommerce-synonyms",
"count": 2
},
{
"synonyms_set": "my-synonyms-set",
"count": 3
},
{
"synonyms_set": "new-ecommerce-synonyms",
"count": 1
}
]
}