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 synonyms set List synonyms sets »
Elastic Docs ›Elasticsearch Guide [8.11] ›REST APIs ›Synonyms APIs

Get synonyms set

edit

Get synonyms set

edit

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.

Retrieves a synonyms set.

Request

edit

GET _synonyms/<synonyms_set>

Prerequisites

edit

Requires the manage_search_synonyms cluster privilege.

Path parameters

edit
<synonyms_set>
(Required, string) Synonyms set identifier to retrieve.

Query parameters

edit
from
(Optional, integer) Starting offset for synonyms rules to retrieve. Defaults to 0.
size
(Optional, integer) Specifies the maximum number of synonyms rules to retrieve. Defaults to 10.

Response codes

edit
400
The synonyms_set identifier was not provided.
404 (Missing resources)
No synonyms set with the identifier synonyms_set was found.

Examples

edit

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

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"
    }
  ]
}
« Create or update synonyms set List synonyms sets »