index.asciidoc 953 B

123456789101112131415161718192021222324252627282930
  1. [[query-rules-apis]]
  2. == Query rules APIs
  3. preview::[]
  4. ++++
  5. <titleabbrev>Query rules APIs</titleabbrev>
  6. ++++
  7. ---
  8. <<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.
  9. Query rules are organized into _rulesets_, collections of query rules that are matched against incoming queries.
  10. Query rules are applied using the <<query-dsl-rule-query, rule query>>.
  11. If a query matches one or more rules in the ruleset, the query is re-written to apply the rules before searching.
  12. This allows pinning documents for only queries that match a specific term.
  13. Use the following APIs to manage query rulesets:
  14. * <<put-query-ruleset>>
  15. * <<get-query-ruleset>>
  16. * <<list-query-rulesets>>
  17. * <<delete-query-ruleset>>
  18. include::put-query-ruleset.asciidoc[]
  19. include::get-query-ruleset.asciidoc[]
  20. include::list-query-rulesets.asciidoc[]
  21. include::delete-query-ruleset.asciidoc[]