Actions52
- Advanced Actions
- Api Keys Actions
- Clusters Actions
- Dictionaries Actions
- Indices Actions
- Records Actions
- Rules Actions
- Search Actions
- Synonyms Actions
- Vaults Actions
Overview
The "Set dictionary settings" operation in the Dictionaries resource allows users to customize language-specific dictionary settings in Algolia. Specifically, it enables turning on or off built-in Algolia stop words for specific languages. This is useful for fine-tuning search behavior by disabling standard entries such as plurals, stopwords, or compounds for selected languages.
Typical use cases include:
- Disabling plural forms for certain languages to improve search precision.
- Turning off stop words removal for specific languages where stop words are important.
- Adjusting compound word handling to better fit the linguistic characteristics of a language.
For example, if you want to disable the standard stop words and plurals for English and French, you can configure these settings accordingly using this node.
Properties
| Name | Meaning |
|---|---|
| Dictionary Settings Params | Select which dictionary settings to modify. Currently supports "Disable Standard Entries". |
| Disable Standard Entries | Choose which standard entries to disable: Plurals, Stopwords, Compounds. These are key-value pairs mapping supported language ISO codes to boolean values indicating whether to disable that entry type for the language. |
| Plurals | Specify plurals disable settings either as an object (key-value pairs of language codes and booleans) or null. |
| Stopwords | Specify stopwords disable settings either as an object (key-value pairs of language codes and booleans) or null. |
| Compounds | Specify compounds disable settings either as an object (key-value pairs of language codes and booleans) or null. |
Details on "Disable Standard Entries" sub-properties:
- Plurals: Can be set as an object with language ISO codes mapped to booleans or null.
- Stopwords: Same as plurals but for stop words.
- Compounds: Same as plurals but for compound words.
These properties allow granular control over which standard dictionary entries are disabled per language.
Output
The node outputs the JSON response from the Algolia API after setting the dictionary settings. The output typically includes confirmation of the updated settings or any error messages returned by the API.
No binary data output is involved in this operation.
Dependencies
- Requires an Algolia API key credential configured in n8n with appropriate permissions to update dictionary settings.
- The node sends HTTP PUT requests to the Algolia API endpoint
/1/dictionaries/*/settings. - Requires the Algolia Application ID and API key to be set in the credentials.
Troubleshooting
- Invalid language codes: Ensure that the language ISO codes used in the disableStandardEntries objects are valid and supported by Algolia. Refer to Algolia's supported languages documentation.
- Permission errors: If the API key lacks permission to modify dictionary settings, the API will return an authorization error. Use an API key with sufficient privileges.
- Malformed JSON: When specifying objects or JSON strings for plurals, stopwords, or compounds, ensure the JSON is well-formed to avoid parsing errors.
- Empty or missing required parameters: The
Dictionary Settings Paramsproperty is required; ensure it is set correctly.
Links and References
- Algolia Dictionaries Documentation
- Supported Languages for Dictionary Settings
- Algolia API Authentication
- n8n Credentials Documentation
This summary covers the static analysis of the "Set dictionary settings" operation within the Dictionaries resource of the Algolia node in n8n, based on the provided source code and property definitions.