This version of the Ruby API client has been deprecated in favor of the latest version of the Ruby API client.
Required API Key: any key with the settings ACL
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.
1
2
3
4
5
| $iterator = $index->browseSynonyms();
foreach ($iterator as $synonym) {
var_dump($synonym);
}
|
1
2
3
4
| # Get synonyms by batch
synonyms = index.export_synonyms
# With a block
index.export_synonyms { |synonym| puts synonym }
|
1
2
3
4
5
| index.browseSynonyms({
batch: batch => console.log(batch),
}).then(() => {
// done
});
|
1
2
3
| # Print all synonyms in an index.
for synonym in index.browse_synonyms():
print(synonym)
|
1
2
3
4
5
| index.browseSynonyms { result in
if case .success(let response) = result {
print("Response: \(response)")
}
}
|
1
2
3
4
5
6
| var synonymsIterator = client.BrowseSynonyms();
foreach (var synonym in synonymsIterator)
{
Console.WriteLine(synonym);
}
|
1
2
3
4
5
6
| // Only on Sync
Index<Contact> index = client.initIndex("myIndex", Contact.class);
List<Synonym> synonyms = new ArrayList<>();
SynonymsIterable synonymsIterable = index.browseSynonyms();
synonymsIterable.forEach(synonyms::add);
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
| it, err := index.BrowseSynonyms()
// error handling
for {
synonym, err := it.Next()
if err != nil {
if err == io.EOF {
// all synonyms have been browsed
} else {
// error handling
}
break
}
fmt.Println(synonym)
}
|
1
2
| val helper = AlgoliaSyncHelper(client)
helper.exportSynonyms("myIndex").map(println)
|
1
2
3
| index.browseSynonyms().forEach {
println(it)
}
|
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.
|
Returns a synonym iterator.
