Actions52
- Advanced Actions
- Api Keys Actions
- Clusters Actions
- Dictionaries Actions
- Indices Actions
- Records Actions
- Rules Actions
- Search Actions
- Synonyms Actions
- Vaults Actions
Overview
The "Clear synonyms" operation in the Synonyms resource allows users to delete all synonyms from a specified Algolia index. This operation is useful when you want to reset or remove all synonym mappings for an index, effectively clearing any custom synonym rules that have been set up.
Common scenarios where this node would be beneficial include:
- Resetting the synonym list before uploading a new set of synonyms.
- Cleaning up an index's synonyms to troubleshoot search relevance issues.
- Automating maintenance tasks to keep synonym data fresh and relevant.
For example, if you have an index with outdated or incorrect synonyms affecting search results, you can use this operation to clear all synonyms and then add updated ones.
Properties
| Name | Meaning |
|---|---|
| Index Name | The name of the Algolia index from which all synonyms will be cleared. |
| Forward To Replicas | Boolean option indicating whether the clear operation should also be forwarded to replica indices of the main index. |
Output
The output of this operation typically contains JSON data representing the response from the Algolia API after clearing synonyms. This response usually includes task status information confirming that the synonyms have been cleared successfully.
No binary data is output by this operation.
Dependencies
- Requires an Algolia account with access to the specified index.
- Requires an API key credential with permissions to manage synonyms on the target index.
- The node must be configured with the appropriate Algolia application ID and API key credentials.
- Network access to Algolia's API endpoint (https://[appId].algolia.net).
Troubleshooting
- Invalid Index Name: If the specified index does not exist, the API may return an error. Ensure the index name is correct and exists in your Algolia application.
- Insufficient Permissions: If the API key used lacks permissions to modify synonyms, the operation will fail. Use an API key with appropriate rights.
- Forward to Replicas Issues: If forwarding to replicas is enabled but replicas are misconfigured or unavailable, the operation might partially fail. Verify replica indices' health.
- API Rate Limits: Clearing synonyms is subject to Algolia's rate limits. If you hit these limits, wait and retry later.
Links and References
This summary describes the functionality and usage of the "Clear synonyms" operation within the Algolia node for n8n workflows based on static analysis of the provided source code and property definitions.