Create or update a synonym set

PUT /_synonyms/{id}

Synonyms sets are limited to a maximum of 10,000 synonym rules per set. If you need to manage more synonym rules, you can create multiple synonym sets.

When an existing synonyms set is updated, the search analyzers that use the synonyms set are reloaded automatically for all indices. This is equivalent to invoking the reload search analyzers API for all indices that use the synonyms set.

Required authorization

Cluster privileges: manage_search_synonyms

Path Parameters

id string Id required: The ID of the synonyms set to be created or updated.

Request

synonyms_set union oneOf required: The synonym rules definitions for the synonyms set.; SynonymRule or SynonymRule[]

Response

application/json

Examples

Request Console 1 / 6 languages

Console Kibana Dev Tools

PUT _synonyms/my-synonyms-set

JavaScript Elasticsearch JavaScript Client

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

Python Elasticsearch Python Client

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

curl Shell

curl -X PUT "$ELASTICSEARCH_URL/_synonyms/my-synonyms-set" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

PHP Elasticsearch PHP Client

$resp = $client->synonyms()->putSynonym([
    "id" => "my-synonyms-set",
]);

Ruby Elasticsearch Ruby Client

response = client.synonyms.put_synonym(
  id: "my-synonyms-set"
)

Response

No example