Actions52
- Advanced Actions
- Api Keys Actions
- Clusters Actions
- Dictionaries Actions
- Indices Actions
- Records Actions
- Rules Actions
- Search Actions
- Synonyms Actions
- Vaults Actions
Overview
The "Batch dictionary entries" operation in the Dictionaries resource allows users to add or delete multiple entries from language-specific dictionaries such as plurals, stopwords, or compounds. This operation is useful for customizing language processing behavior in search applications by managing custom dictionary entries that affect how text is analyzed and searched.
Typical use cases include:
- Adding new plural forms or stop words specific to your domain.
- Removing outdated or incorrect dictionary entries.
- Replacing all existing custom entries with a new batch of entries.
For example, you might batch update the stopwords dictionary to include industry-specific terms that should be ignored during searches, improving search relevance.
Properties
| Name | Meaning |
|---|---|
| Dictionary Name | Select which dictionary to modify: plurals, stopwords, or compounds. |
| Batch Dictionary Entries Params | Parameters for the batch request, including options to clear existing entries and specify additions/deletions. |
| Clear Existing Dictionary Entries | Boolean flag indicating whether to replace all custom entries in the dictionary with the provided batch. Defaults to false. |
| Requests | JSON array specifying the list of additions and deletions to apply to the dictionary entries. |
Output
The node outputs the response from the API call to batch update dictionary entries. The output is a JSON object containing the result of the batch operation, typically including status information about the success or failure of the request.
No binary data is involved in this operation.
Dependencies
- Requires an API key credential with appropriate permissions to manage dictionaries in the Algolia application.
- The base URL for API requests is constructed using the Algolia application ID from credentials.
- No additional external dependencies are required.
Troubleshooting
Common issues:
- Providing invalid dictionary names or malformed requests in the
requestsproperty may cause API errors. - Attempting to batch update without proper API authentication will fail.
- Setting
Clear Existing Dictionary Entriesto true without providing new entries will clear the dictionary completely.
- Providing invalid dictionary names or malformed requests in the
Error messages:
- Authentication errors indicate missing or invalid API keys.
- Validation errors may occur if the request body does not conform to expected schema (e.g., missing required fields).
- Rate limit errors if too many requests are made in a short period; wait and retry later.
Resolution tips:
- Ensure the API key has dictionary management permissions.
- Validate the JSON structure of the
requestsparameter before sending. - Use the
Clear Existing Dictionary Entriesoption carefully to avoid unintended data loss.