Create a rule

Displays a banner in the search results when rule criteria match.

Blocks one or more documents that match the rule criteria in the search results, where rule criteria is an attribute (for example, Color) and list of values to block.

Blocks one or more documents that match the rule criteria from appearing in the search results, where rule criteria is a field (for example, id) and list of values to block.

Boosts by either simple format (boostParam/boostQuery) or structured format (block_groups_list). When block_groups_list is present, it takes precedence over boostParam/boostQuery.

Boosts one or more documents that match the rule criteria in the search results where rule criteria is a field (for example, id) and list of values to boost.

Buries documents by either bq or by boosting documents that match a user-supplied query.

Downweights one or more documents that match the rule criteria in the search results, where rule criteria is a field (for example, id) and list of values to bury.

Filters one or more documents that match the rule criteria in the search results, where rule criteria is a field (for example, id) and list of values to boost.

Boosts one or more documents within its group in the search response.

Buries one or more documents within its group in the search response.

Like InGroupBoostListRule, but pins a document within a group to a specific position.

Returns an arbitrary JSON blob alongside the response.

Details about the pin rule. Boosts documents and then pins the matching values to absolute positions in the result set.

Returns a URL for the redirect when this rule is triggered.

Common properties shared by all rule request types.

Details about the set facets rule. Configure the behavior of facets for the current query.

Details about the set JSON facets rule. Configure JSON facet API parameters for the current query.

Modify the parameters of the current request.

Displays a banner in the search results when rule criteria match.

Blocks one or more documents that match the rule criteria in the search results, where rule criteria is an attribute (for example, Color) and list of values to block.

Blocks one or more documents that match the rule criteria from appearing in the search results, where rule criteria is a field (for example, id) and list of values to block.

Boosts by either simple format (boostParam/boostQuery) or structured format (block_groups_list). When block_groups_list is present, it takes precedence over boostParam/boostQuery.

Boosts one or more documents that match the rule criteria in the search results where rule criteria is a field (for example, id) and list of values to boost.

Buries documents by either bq or by boosting documents that match a user-supplied query.

Downweights one or more documents that match the rule criteria in the search results, where rule criteria is a field (for example, id) and list of values to bury.

Filters one or more documents that match the rule criteria in the search results, where rule criteria is a field (for example, id) and list of values to boost.

Boosts one or more documents within its group in the search response.

Buries one or more documents within its group in the search response.

Like InGroupBoostListRule, but pins a document within a group to a specific position.

Returns an arbitrary JSON blob alongside the response.

Details about the pin rule. Boosts documents and then pins the matching values to absolute positions in the result set.

Returns a URL for the redirect when this rule is triggered.

Common properties shared by all rule summary types.

Details about the set JSON facets rule. Configure JSON facet API parameters for the current query.

Modify the parameters of the current request.