elasticsearch/docs/reference/query-rules/apis/index.asciidoc
Kathleen DeRusso df62bcfce1
Add a query rules tester API call (#114168) (#114747)
* Add a query rules tester API call

* Update docs/changelog/114168.yaml

* Wrap client call in async with origin

* Remove unused param

* PR feedback

* Remove redundant test

* CI workaround - add ent-search as ml dependency so it can find node features
2024-10-15 05:04:25 +11:00

36 lines
1.2 KiB
Text

[[query-rules-apis]]
== Query rules APIs
++++
<titleabbrev>Query rules APIs</titleabbrev>
++++
---
<<search-using-query-rules,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 <<query-dsl-rule-query, 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>>
include::put-query-ruleset.asciidoc[]
include::get-query-ruleset.asciidoc[]
include::list-query-rulesets.asciidoc[]
include::delete-query-ruleset.asciidoc[]
include::put-query-rule.asciidoc[]
include::get-query-rule.asciidoc[]
include::delete-query-rule.asciidoc[]
include::test-query-ruleset.asciidoc[]