mirror of
https://github.com/elastic/elasticsearch.git
synced 2025-04-25 23:57:20 -04:00
1f46a94dec
* Add individual query rule API docs * Update docs/reference/query-rules/apis/get-query-rule.asciidoc Co-authored-by: Liam Thompson <32779855+leemthompo@users.noreply.github.com> * Update docs/reference/query-rules/apis/delete-query-rule.asciidoc Co-authored-by: Liam Thompson <32779855+leemthompo@users.noreply.github.com> * Update docs/reference/query-rules/apis/get-query-rule.asciidoc Co-authored-by: Liam Thompson <32779855+leemthompo@users.noreply.github.com> * PR feedback --------- Co-authored-by: Liam Thompson <32779855+leemthompo@users.noreply.github.com>
36 lines
1.1 KiB
Text
36 lines
1.1 KiB
Text
[[query-rules-apis]]
|
|
== Query rules APIs
|
|
|
|
preview::[]
|
|
|
|
++++
|
|
<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>>
|
|
|
|
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[]
|
|
|