List of methods
Create or update a single rule.
Create or update a specified set of rules, or all rules.
Get the object/definition of a specific rule.
Delete a specific rule using its id.
Delete all rules in an index.
Search for rules matching various criteria.
Push a new set of rules and erase all previous ones.
Copy the rules of an index to another index on the same app.
Retrieve an index’s full list of rules using an iterator.
Query Rules allows performing pre- and post-processing on queries matching specific patterns. For more details, please refer to our Rules guide.
As its name implies, Query Rules is applied at query time. Therefore, some search parameters can be used to control how the rules are applied.
Most of the methods manipulate queryRule objects, as described in detail in the different Query Rules methods.
Just like for objects or synonyms, write methods for rules are asynchronous: they return a
taskID that can be used by Wait for operations.
Did you find this page helpful?
We're always looking for advice to help improve our documentation!
Please let us know what's working (or what's not!).
We're constantly iterating thanks to the feedback we receive.