Skip to content

Commit 8726b2e

Browse files
Update query rules UI page (#2633)
Adjusting content to accommodate feedback from @kderusso Feedback was provided in https://github.com/elastic/docs-content/pull/2252/files Also added product id in frontmatter to ensure it helps web team to implement internal search for the page correctly. --------- Co-authored-by: Benjamin Ironside Goldstein <[email protected]>
1 parent 77c67fe commit 8726b2e

File tree

1 file changed

+14
-12
lines changed

1 file changed

+14
-12
lines changed

solutions/search/query-rules-ui.md

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3,40 +3,42 @@ applies_to:
33
stack: ga 9.1
44
serverless: ga
55
elasticsearch:
6+
products:
7+
- id: elasticsearch
68
---
79

810
# Query rules UI
9-
Use query rules to boost, pin, or exclude specific documents when queries contain certain keywords, phrases, or match defined search patterns.
11+
Use query rules to pin or exclude specific documents when queries contain specific keywords or phrases, or match specific search patterns.
1012
The Query rules UI provides a graphical interface to manage these rules without writing API calls or JSON configuration.
1113

1214
The UI enables you to:
1315

14-
- Set keyword triggers and conditions for when rules apply
15-
- Pin, boost, or exclude specific documents in results
16+
- Set keyword or numerical conditions. For a full list of options, refer to [Rule criteria](elasticsearch://reference/elasticsearch/rest-apis/searching-with-query-rules.md#query-rule-criteria).
17+
- Pin or exclude specific documents in results
1618
- Organize rules into rulesets and set execution priority
1719
- Test rules against sample queries before publishing
1820

1921
## UI vs. API: What's the difference?
2022

21-
The Query Rules UI provides the same functionality as the API with one key difference in how documents are pinned:
23+
The Query Rules UI provides the same functionality as the API with one key difference:
2224

23-
* The UI defaults to `docs` for maximum flexibility, but still allows `id`-based pinning for single-index searches through a simplified form.
25+
* The UI defaults to `docs` for creating and editing rules. You cannot edit an `id` based rule that was created through the API.
2426

25-
To see examples of how to search using query rules, refer [Search using Query Rules API](https://www.elastic.co/docs/reference/elasticsearch/rest-apis/searching-with-query-rules).
27+
For examples of how to search using query rules, refer to [Search using Query Rules API](https://www.elastic.co/docs/reference/elasticsearch/rest-apis/searching-with-query-rules).
2628

2729
If you prefer to use the Query Rules API, refer to [Query Rules API]({{es-apis}}group/endpoint-query_rules).
2830

2931
## Requirements
3032

31-
If you want to get full access to the Query Rules UI, you must have the following privileges:
33+
For full access to the Query Rules UI, you need the following privileges:
3234

3335
* Appropriate roles to access Kibana. For more information, refer to [Built-in roles](https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/built-in-roles) or [Kibana privileges](https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/kibana-privileges)
34-
* A custom role with `manage_search_query_rules` cluster privilege
36+
* A role with `manage_search_query_rules` cluster privilege
3537
* `ALL` option for `Query Rules` role privilege in the respective Kibana space
3638

3739
## Accessing the Query Rules UI
3840

39-
Go to your deployment and select **Query Rules** from the left navigation menu under **Relevance**. If you're not able to see the option, contact the administrator to review the role assigned to you.
41+
Go to your deployment and select **Query Rules** from the left navigation menu under **Relevance**. If the option does not appear, contact your administrator to review your privileges.
4042

4143
:::{image} /solutions/images/elasticsearch-query-rules-ui-home.png
4244
:alt: Landing page for Query Rules UI.
@@ -54,13 +56,13 @@ Use the following steps to first create a query ruleset, and then a query rule:
5456
- **Pin**: Pin selected documents to the top of the search results.
5557
- **Exclude**: Exclude selected documents from the results.
5658

57-
For more information on rule types, refer [Rule types](https://www.elastic.co/docs/reference/elasticsearch/rest-apis/searching-with-query-rules#query-rule-type).
59+
For more information on rule types, refer to [Rule types](https://www.elastic.co/docs/reference/elasticsearch/rest-apis/searching-with-query-rules#query-rule-type).
5860
4. Select one or more documents for the rule to apply to.
5961
5. Select one of the following rule criteria:
6062
- **Always**: Apply the rule to all queries
6163
- **Custom**: Define conditions when the rule is applied.
6264

63-
For a full list of options, refer [Rule criteria](elasticsearch://reference/elasticsearch/rest-apis/searching-with-query-rules.md#query-rule-criteria).
65+
For a full list of options, refer to [Rule criteria](elasticsearch://reference/elasticsearch/rest-apis/searching-with-query-rules.md#query-rule-criteria).
6466
6. Select **Create rule**.
6567
7. Select **Save** in the top right corner of the ruleset section.
6668

@@ -118,7 +120,7 @@ To test a query ruleset, do the following:
118120

119121
## Learn more
120122

121-
Following resources can help you understand query rules better:
123+
The following resources can help you understand query rules better:
122124

123125
Blogs:
124126

0 commit comments

Comments
 (0)