Required API Key: any key with the settings ACL

Method signature
index.browse_synonyms()

index.browse_synonyms(Hash opts = {
  # any requestOptions
})

You’re currently reading the Ruby API client v2 documentation. Check the migration guide to learn how to upgrade from v1 to v2. You can still access the v1 documentation.

About this method # A

Retrieve an index’s complete list of synonyms.

The list includes all synonyms - whether created on the dashboard or pushed by the API.

The method returns an iterator.

You can import and export synonyms from the Algolia dashboard.

Examples # A

1
2
3
4
# Get synonyms by batch
synonyms = index.browse_synonyms
# With a block
index.browse_synonyms { |synonym| puts synonym }

Parameters # A

indexName #
type: string
only needed in go, scala, c#

Index name.

requestOptions #
type: key/value mapping
default: No request options
Optional

A mapping of request options to send along with the query.

Response # A

Returns a synonym iterator.

Did you find this page helpful?