diff --git a/docs/overlays/elasticsearch-shared-overlays.yaml b/docs/overlays/elasticsearch-shared-overlays.yaml index 07574f53c0..e000f5faae 100644 --- a/docs/overlays/elasticsearch-shared-overlays.yaml +++ b/docs/overlays/elasticsearch-shared-overlays.yaml @@ -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 diff --git a/specification/_doc_ids/table.csv b/specification/_doc_ids/table.csv index 6e4281cd88..9286ae6d95 100644 --- a/specification/_doc_ids/table.csv +++ b/specification/_doc_ids/table.csv @@ -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,, diff --git a/specification/query_rules/delete_rule/QueryRuleDeleteRequest.ts b/specification/query_rules/delete_rule/QueryRuleDeleteRequest.ts index 08b07c6f55..54aa6805a7 100644 --- a/specification/query_rules/delete_rule/QueryRuleDeleteRequest.ts +++ b/specification/query_rules/delete_rule/QueryRuleDeleteRequest.ts @@ -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: [ diff --git a/specification/query_rules/delete_ruleset/QueryRulesetDeleteRequest.ts b/specification/query_rules/delete_ruleset/QueryRulesetDeleteRequest.ts index f779eee8cb..79ca7d7b2c 100644 --- a/specification/query_rules/delete_ruleset/QueryRulesetDeleteRequest.ts +++ b/specification/query_rules/delete_ruleset/QueryRulesetDeleteRequest.ts @@ -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: [ diff --git a/specification/query_rules/get_rule/QueryRuleGetRequest.ts b/specification/query_rules/get_rule/QueryRuleGetRequest.ts index b1a8699e3b..b4fc43268a 100644 --- a/specification/query_rules/get_rule/QueryRuleGetRequest.ts +++ b/specification/query_rules/get_rule/QueryRuleGetRequest.ts @@ -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: [ diff --git a/specification/query_rules/get_ruleset/QueryRulesetGetRequest.ts b/specification/query_rules/get_ruleset/QueryRulesetGetRequest.ts index 60a639002a..dc567ce945 100644 --- a/specification/query_rules/get_ruleset/QueryRulesetGetRequest.ts +++ b/specification/query_rules/get_ruleset/QueryRulesetGetRequest.ts @@ -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: [ diff --git a/specification/query_rules/list_rulesets/QueryRulesetListRequest.ts b/specification/query_rules/list_rulesets/QueryRulesetListRequest.ts index 53715beb06..49df46ccbf 100644 --- a/specification/query_rules/list_rulesets/QueryRulesetListRequest.ts +++ b/specification/query_rules/list_rulesets/QueryRulesetListRequest.ts @@ -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: [ diff --git a/specification/query_rules/put_rule/QueryRulePutRequest.ts b/specification/query_rules/put_rule/QueryRulePutRequest.ts index 8b20e7c497..b705b3e2a5 100644 --- a/specification/query_rules/put_rule/QueryRulePutRequest.ts +++ b/specification/query_rules/put_rule/QueryRulePutRequest.ts @@ -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: [ diff --git a/specification/query_rules/put_ruleset/QueryRulesetPutRequest.ts b/specification/query_rules/put_ruleset/QueryRulesetPutRequest.ts index 410083430d..ed0d208b3d 100644 --- a/specification/query_rules/put_ruleset/QueryRulesetPutRequest.ts +++ b/specification/query_rules/put_ruleset/QueryRulesetPutRequest.ts @@ -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: [