Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions docs/overlays/elasticsearch-shared-overlays.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -197,9 +197,10 @@ actions:

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.
Alternatively, you can use the [Query Rules UI](https://www.elastic.co/docs/solutions/search/query-rules-ui) to manage query rules.
externalDocs:
url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-rule-query
description: Learn more about the rule query.
url: https://www.elastic.co/docs/reference/elasticsearch/rest-apis/searching-with-query-rules
description: Learn more about searching with query rules.
# R
- name: rollup
x-displayName: Rollup
Expand Down
5 changes: 5 additions & 0 deletions specification/_doc_ids/table.csv
Original file line number Diff line number Diff line change
Expand Up @@ -598,6 +598,11 @@ query-ruleset-get,https://www.elastic.co/docs/api/doc/elasticsearch/operation/op
query-ruleset-list,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-query-rules-list-rulesets,https://www.elastic.co/guide/en/elasticsearch/reference/8.18/list-query-rulesets.html,
query-ruleset-put,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-query-rules-put-ruleset,https://www.elastic.co/guide/en/elasticsearch/reference/8.18/put-query-ruleset.html,
query-ruleset-test,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-query-rules-test,https://www.elastic.co/guide/en/elasticsearch/reference/8.18/test-query-ruleset.html,
create-query-rule-from-ui,https://www.elastic.co/docs/solutions/search/query-rules-ui#create-a-query-rule,,Create rules and rulesets from the Query Rules UI
edit-query-rule-from-ui,https://www.elastic.co/docs/solutions/search/query-rules-ui#edit-a-rule,,Edit rules and rulesets from the Query Rules UI
delete-query-rule-from-ui,https://www.elastic.co/docs/solutions/search/query-rules-ui#delete-a-rule,,Delete a rule from the Query Rules UI
list-query-rules-in-ui,https://www.elastic.co/docs/solutions/search/query-rules-ui#accessing-the-query-rules-ui,,See rules and rulesets in Query Rules UI
delete-query-ruleset-from-ui,https://www.elastic.co/docs/solutions/search/query-rules-ui#delete-a-ruleset,,Delete a ruleset from the Query Rules UI
realtime,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-get,https://www.elastic.co/guide/en/elasticsearch/reference/8.18/docs-get.html,
redact-processor,https://www.elastic.co/docs/reference/enrich-processor/redact-processor,,
regexp-syntax,https://www.elastic.co/docs/reference/query-languages/query-dsl/regexp-syntax,,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ import { Id } from '@_types/common'
* @availability serverless stability=stable visibility=public
* @cluster_privileges manage_search_query_rules
* @doc_id query-rule-delete
* @ext_doc_id delete-query-rule-from-ui
*/
export interface Request extends RequestBase {
urls: [
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ import { Id } from '@_types/common'
* @availability serverless stability=stable visibility=public
* @cluster_privileges manage_search_query_rules
* @doc_id query-ruleset-delete
* @ext_doc_id delete-query-ruleset-from-ui
*/
export interface Request extends RequestBase {
urls: [
Expand Down
2 changes: 1 addition & 1 deletion specification/query_rules/get_rule/QueryRuleGetRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ import { Id } from '@_types/common'
* @availability serverless stability=stable visibility=public
* @cluster_privileges manage_search_query_rules
* @doc_id query-rule-get
* @ext_doc_id query-rule
* @ext_doc_id list-query-rules-in-ui
*/
export interface Request extends RequestBase {
urls: [
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ import { Id } from '@_types/common'
* @availability serverless stability=stable visibility=public
* @cluster_privileges manage_search_query_rules
* @doc_id query-ruleset-get
* @ext_doc_id list-query-rules-in-ui
*/
export interface Request extends RequestBase {
urls: [
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ import { integer } from '@_types/Numeric'
* @availability serverless stability=stable visibility=public
* @cluster_privileges manage_search_query_rules
* @doc_id query-ruleset-list
* @ext_doc_id list-query-rules-in-ui
*/
export interface Request extends RequestBase {
urls: [
Expand Down
1 change: 1 addition & 0 deletions specification/query_rules/put_rule/QueryRulePutRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ import {
* @availability serverless stability=stable visibility=public
* @cluster_privileges manage_search_query_rules
* @doc_id query-rule-put
* @ext_doc_id edit-query-rule-from-ui
*/
export interface Request extends RequestBase {
urls: [
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ import { QueryRule } from '../_types/QueryRuleset'
* @availability serverless stability=stable visibility=public
* @cluster_privileges manage_search_query_rules
* @doc_id query-ruleset-put
* @ext_doc_id query-rule
* @ext_doc_id edit-query-rule-from-ui
*/
export interface Request extends RequestBase {
urls: [
Expand Down