Feb. 26, 2019
Required API Key:
any key with the
settings
ACL
Method signature
$index->browseSynonyms()
About this method #
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.
Examples #
Edit
Copy
1
2
3
4
5
$iterator = $index->browseSynonyms();
foreach ($iterator as $synonym) {
var_dump($synonym);
}
Parameters #
indexName
# |
type: string
only needed in go, scala, c#
Index name. |
Response #
Returns a synonym iterator.