Custom dictionaries API client methods
This is documentation for v3 of the PHP API clients, which is not the latest version. To see the documentation for the latest version, see PHP v4.
This is documentation for v2 of the Ruby API clients, which is not the latest version. To see the documentation for the latest version, see Ruby v3.
This is documentation for v4 of the JavaScript API clients, which is not the latest version. To see the documentation for the latest version, see JavaScript v5.
This is documentation for v3 of the Python API clients, which is not the latest version. To see the documentation for the latest version, see Python v4.
This is documentation for v8 of the Swift API clients, which is not the latest version. To see the documentation for the latest version, see Swift v9.
This is documentation for v2 of the Kotlin API clients, which is not the latest version. To see the documentation for the latest version, see Kotlin v3.
This is documentation for v6 of the C# API clients, which is not the latest version. To see the documentation for the latest version, see C# v7.
This is documentation for v3 of the Java API clients, which is not the latest version. To see the documentation for the latest version, see Java v4.
This is documentation for v3 of the Go API clients, which is not the latest version. To see the documentation for the latest version, see Go v4.
This is documentation for v1 of the Scala API clients, which is not the latest version. To see the documentation for the latest version, see Scala v2.
| Save dictionary entries |
Send a batch of entries to a dictionary. |
| Replace dictionary entries |
Replace a batch of dictionary entries. |
| Delete dictionary entries |
Delete a batch of dictionary entries. |
| Clear dictionary entries |
Remove all words from a custom dictionary. |
| Search dictionary entries |
Search for entries in a dictionary. |
| Set dictionary settings |
Turn standard dictionary entries on or off. |
| Get dictionary settings |
Retrieve the dictionary override settings for plurals, stop words, and compound words. |
How to manage your dictionaries
You can manage your dictionaries from the Algolia dashboard as well as using the API.
- Words Ignored: stop words
- Plurals & Other Declensions: plurals
- Word Segmentation: compounds
For each of these settings, Algolia provides a standard dictionary. In the dashboard, you can add your own words to custom dictionaries, and you can turn off individual words in the standard dictionary.
