Export Synonyms
settings
ACL
$index->browseSynonyms()
About this method # A
You’re currently reading the JavaScript API client v4 documentation. Check the migration guide to learn how to upgrade from v3 to v4. You can still access the v3 documentation.
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.
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 batch import and export synonyms from the dashboard with a configuration file.
Examples # A
1
2
3
4
5
$iterator = $index->browseSynonyms();
foreach ($iterator as $synonym) {
var_dump($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 |
Response # A
Returns a synonym iterator.