index.asciidoc

Query rules APIs

Query rules APIs

---

New API reference

For the most up-to-date API details, refer to {api-es}/group/endpoint-query_rules[Query rules APIs].

Query rules allow you to configure per-query rules that are applied at query time to queries that match the specific rule. Query rules are organized into rulesets, collections of query rules that are matched against incoming queries. Query rules are applied using the rule query.

If a query matches one or more rules in the ruleset, the query is re-written to apply the rules before searching. This allows pinning documents for only queries that match a specific term.

Use the following APIs to manage query rulesets:

• [put-query-ruleset]

• [get-query-ruleset]

• [list-query-rulesets]

• [delete-query-ruleset]

• [put-query-rule]

• [get-query-rule]

• [delete-query-rule]

• preview:[] [test-query-ruleset]

put-query-ruleset.asciidoc get-query-ruleset.asciidoc list-query-rulesets.asciidoc delete-query-ruleset.asciidoc put-query-rule.asciidoc get-query-rule.asciidoc delete-query-rule.asciidoc test-query-ruleset.asciidoc