getRankingInfo
parameter adds extra information about rules:
- Promoted hits are labelled with a
"promoted": true
field inside the_rankingInfo
object. This field is omitted from regular hits. - The list of applied Rules is available inside the
appliedRules
top-level field. This field is omitted when no rule has been applied (even ifenableRules
is true).
params
response field also has search parameters after Rule application,
and as such reflects the side-effects of the rules.
When in doubt, you can always run the same query with
enableRules=false
and compare the results you get with and without rules.Improve accuracy of rules
Sometimes, creating rules can lead to lower search accuracy. The following table lists common causes for a lower-than-expected search accuracy when applying rules.Cause of less accurate results | Solution |
---|---|
Not adding a βremove wordβ consequence when turning search phrases into query parameters | Add a remove word consequence after any add query parameter consequence |
Not creating an optional filter as a facet | If you want to use an attribute as an optional filter, declare it as a facet |
Not taking advantage of βadd search parameterβ consequences | See some common uses for this consequence |