---
name: "Search::Elasticsearch::Client::8_0::Direct::Synonyms"
section: "3pm"
platform: "linux"
package: "libsearch-elasticsearch-perl"
version: "8.12-1"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/Search::Elasticsearch::Client::8_0::Direct::Synonyms"
---

# Search::Elasticsearch::Client::8\_0::Direct::Synonyms(3pm)

The synonyms management API provides a convenient way

## NAME

Search::Elasticsearch::Client::8\_0::Direct::Synonyms - The synonyms management API provides a convenient way

## VERSION

version 8.12

### DESCRIPTION

The full documentation for Synonyms API is available here: \<https://www.elastic.co/guide/en/elasticsearch/reference/current/synonyms-apis.html\>

## FOLLOW METHODS

### follow()

```
    my $response = $es->synonyms->put_synonym(
        'id' => 'my-synonyms-set',
        'body'  => {
            synonyms_set' => [
                {
                    'id' => 'test-1',
                    'synonyms' => 'hello, hi'
                },
                {
                    'synonyms' => 'bye, goodbye'
                },
                {
                    'id' => 'test-2',
                    'synonyms' => 'test => check'
                },
            ]
        }
    );
```

An introduction to synonyms in Elasticsearch is available here: \<https://www.elastic.co/blog/update-synonyms-elasticsearch-introducing-synonyms-api\>

## AUTHOR

Enrico Zimuel \<enrico.zimuel@elastic.co\>

## COPYRIGHT AND LICENSE

This software is Copyright (c) 2024 by Elasticsearch BV.

This is free software, licensed under:

```
  The Apache License, Version 2.0, January 2004
```