Skip to content

Commit 59d2aa3

Browse files
kderussoelasticmachineleemthompoMikep86
committed
Add documentation for query rules retriever (#115696)
* Add initial query rules retriever docs * Add docs tests * Apply suggestions from code review Co-authored-by: Liam Thompson <[email protected]> * PR feedback * Make query rules guide retriever-first * Add warning to DSL doc * Update docs/reference/search/retriever.asciidoc Co-authored-by: Mike Pellegrini <[email protected]> * Update docs/reference/search/retriever.asciidoc Co-authored-by: Mike Pellegrini <[email protected]> * Apply suggestions from code review Co-authored-by: Mike Pellegrini <[email protected]> * Give parameters subheading an explicit id * Fix formatting --------- Co-authored-by: Elastic Machine <[email protected]> Co-authored-by: Liam Thompson <[email protected]> Co-authored-by: Mike Pellegrini <[email protected]> (cherry picked from commit 14a7b8f)
1 parent 8936459 commit 59d2aa3

File tree

4 files changed

+303
-75
lines changed

4 files changed

+303
-75
lines changed

docs/reference/query-dsl/rule-query.asciidoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,12 @@
1212
The old syntax using `rule_query` and `ruleset_id` is deprecated and will be removed in a future release, so it is strongly advised to migrate existing rule queries to the new API structure.
1313
====
1414

15+
[TIP]
16+
====
17+
The rule query is not supported for use alongside reranking.
18+
If you want to use query rules in conjunction with reranking, use the <<rule-retriever, rule retriever>> instead.
19+
====
20+
1521
Applies <<query-rules-apis,query rules>> to the query before returning results.
1622
Query rules can be used to promote documents in the manner of a <<query-dsl-pinned-query>> based on matching defined rules, or to identify specific documents to exclude from a contextual result set.
1723
If no matching query rules are defined, the "organic" matches for the query are returned.

0 commit comments

Comments
 (0)