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 rules" operation in the Algolia node deletes all rules from a specified index. Rules in Algolia are conditional statements used to customize search results by applying specific consequences when certain conditions are met. Clearing all rules is useful when you want to reset or remove all customizations related to search result curation for an index.
Common scenarios:
- Resetting an index's search behavior by removing all existing rules.
- Preparing an index for a fresh set of rules without residual effects from previous configurations.
- Automating cleanup processes in workflows where rules need to be cleared before batch updates.
Practical example:
You have an index with multiple merchandising and personalization rules applied. Before deploying a new campaign, you want to clear all existing rules to avoid conflicts. Using this operation, you can programmatically clear all rules from the index in your workflow.
Properties
| Name | Meaning |
|---|---|
| Index Name | The name of the Algolia index from which all rules will be cleared. |
| Forward To Replicas | Boolean option indicating whether the clear operation should also apply to replica indices. |
Output
The output contains the JSON response from the Algolia API after clearing the rules. This typically includes task information confirming the request was accepted and may include status or task ID for tracking asynchronous operations.
No binary data is output by this operation.
Dependencies
- Requires an Algolia application with appropriate API credentials (API key and Application ID).
- The node must be configured with these credentials to authenticate requests.
- The index specified must exist in the Algolia application.
Troubleshooting
- Invalid Index Name: If the provided index name does not exist, the API may return an error. Ensure the index name is correct and accessible with the provided credentials.
- Insufficient Permissions: The API key used must have permissions to modify rules on the specified index. Lack of permissions will cause authorization errors.
- Forward To Replicas Option: If enabled, ensure that replica indices exist and are accessible; otherwise, the operation might fail or partially succeed.
- Rate Limits: Algolia enforces rate limits on indexing operations. Frequent clearing of rules may hit these limits, causing temporary failures.