Get a synonym rule

Auth

Get a synonym rule from a synonym set.

Required privileges

set_id string required: The ID of the synonym set to retrieve the synonym rule from.
rule_id string required: The ID of the synonym rule to retrieve.

application/json

id string required: The identifier for the synonym rule. If you do not specify a synonym rule ID when you create a rule, an identifier is created automatically by Elasticsearch.
synonyms string required: The synonyms that conform the synonym rule in Solr format.; Reference

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

GET _synonyms/my-synonyms-set/test-1

JavaScript Elasticsearch JavaScript Client

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

Python Elasticsearch Python Client

resp = client.synonyms.get_synonym_rule(
    set_id="my-synonyms-set",
    rule_id="test-1",
)

curl Shell

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

Java Elasticsearch Java Client

client.synonyms().getSynonymRule(g -> g
    .ruleId("test-1")
    .setId("my-synonyms-set")
);

C# Elasticsearch .NET Client

var response = await client.Synonyms.GetSynonymRuleAsync(setId: "my-synonyms-set", ruleId: "test-1");

PHP Elasticsearch PHP Client

$resp = $client->synonyms()->getSynonymRule([
    "set_id" => "my-synonyms-set",
    "rule_id" => "test-1",
]);

Ruby Elasticsearch Ruby Client

response = client.synonyms.get_synonym_rule(
  set_id: "my-synonyms-set",
  rule_id: "test-1"
)

Response

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

{
  "id": "test-1",
  "synonyms": "hello, hi"
}