You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: solutions/search/query-rules-ui.md
+9-7Lines changed: 9 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,24 +3,26 @@ applies_to:
3
3
stack: ga 9.1
4
4
serverless: ga
5
5
elasticsearch:
6
+
products:
7
+
- id: elasticsearch
6
8
---
7
9
8
10
# 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 certain keywords, phrases, or match defined search patterns.
10
12
The Query rules UI provides a graphical interface to manage these rules without writing API calls or JSON configuration.
11
13
12
14
The UI enables you to:
13
15
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 such as less than or greater than when rules apply
17
+
- Pin or exclude specific documents in results
16
18
- Organize rules into rulesets and set execution priority
17
19
- Test rules against sample queries before publishing
18
20
19
21
## UI vs. API: What's the difference?
20
22
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:
22
24
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.
24
26
25
27
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).
26
28
@@ -31,12 +33,12 @@ If you prefer to use the Query Rules API, refer to [Query Rules API]({{es-apis}}
31
33
If you want to get full access to the Query Rules UI, you must have the following privileges:
32
34
33
35
* 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
35
37
*`ALL` option for `Query Rules` role privilege in the respective Kibana space
36
38
37
39
## Accessing the Query Rules UI
38
40
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 you're not able to see the option, contact your administrator to review the role assigned to you.
0 commit comments