Create or update a synonym rule

PUT /_synonyms/{set_id}/{rule_id}

Auth

Create or update a synonym rule in a synonym set.

If any of the synonym rules included is invalid, the API returns an error.

When you update a synonym rule, all analyzers using the synonyms set will be reloaded automatically to reflect the new rule.

Required authorization

Cluster privileges manage_search_synonyms

Path parameters

set_id string required: The ID of the synonym set.
rule_id string required: The ID of the synonym rule to be updated or created.

Query parameters

refresh boolean · default: true: If true, the request will refresh the analyzers with the new synonym rule and wait for the new synonyms to be available before returning. If false, analyzers will not be reloaded with the new synonym rule

Request body

synonyms string required: The synonym rule information definition, which must be in Solr format.; Reference

Response

application/json

result enum required: The update operation result.; Values: created updated deleted not_found noop
reload_analyzers_details object: Updating synonyms in a synonym set can reload the associated analyzers in case refresh is set to true. This information is the analyzers reloading result.

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

PUT _synonyms/my-synonyms-set/test-1
{
  "synonyms": "hello, hi, howdy"
}

JavaScript Elasticsearch JavaScript Client

const response = await client.synonyms.putSynonymRule({
  set_id: "my-synonyms-set",
  rule_id: "test-1",
  synonyms: "hello, hi, howdy",
});

Python Elasticsearch Python Client

resp = client.synonyms.put_synonym_rule(
    set_id="my-synonyms-set",
    rule_id="test-1",
    synonyms="hello, hi, howdy",
)

curl Shell

curl -X PUT "$ELASTICSEARCH_URL/_synonyms/my-synonyms-set/test-1" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "synonyms": "hello, hi, howdy"
  }'

Java Elasticsearch Java Client

client.synonyms().putSynonymRule(p -> p
    .ruleId("test-1")
    .setId("my-synonyms-set")
    .synonyms("hello, hi, howdy")
);

C# Elasticsearch .NET Client

var response = await client.Synonyms
    .PutSynonymRuleAsync(setId: "my-synonyms-set", ruleId: "test-1", d1 => d1
        .Synonyms("hello, hi, howdy")
    );

PHP Elasticsearch PHP Client

$resp = $client->synonyms()->putSynonymRule([
    "set_id" => "my-synonyms-set",
    "rule_id" => "test-1",
    "body" => [
        "synonyms" => "hello, hi, howdy",
    ],
]);

Ruby Elasticsearch Ruby Client

response = client.synonyms.put_synonym_rule(
  set_id: "my-synonyms-set",
  rule_id: "test-1",
  body: {
    "synonyms": "hello, hi, howdy"
  }
)

Response

A successful response from PUT _synonyms/my-synonyms-set/test-1.

{
  "result": "updated",
  "reload_analyzers_details": {
    "_shards": {
      "total": 2,
      "successful": 1,
      "failed": 0
    },
    "reload_details": [
      {
        "index": "test-index",
        "reloaded_analyzers": [
          "my_search_analyzer"
        ],
        "reloaded_node_ids": [
          "1wYFZzq8Sxeu_Jvt9mlbkg"
        ]
      }
    ]
  }
}