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
+24-16Lines changed: 24 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,10 +2,12 @@
2
2
applies_to:
3
3
stack: ga 9.1
4
4
serverless: ga
5
+
elasticsearch:
5
6
---
6
-
# Query rules GUI
7
7
8
-
Query rules GUI is a user interface that helps you create, edit, and delete query rules. The interface is implemented on top of the existing Query Rules API and provides non-technical users with an intuitive, streamlined interface to manage query rules.
8
+
# Query rules UI
9
+
10
+
Query rules UI is a user interface that helps you create, edit, and delete query rules. The interface is implemented on top of the existing Query Rules API and provides non-technical users with an intuitive, streamlined interface to manage query rules.
9
11
10
12
Query rules help customize search results, giving you more control over how results are returned based on the contextual information in the query.
11
13
@@ -14,31 +16,33 @@ The Query rules UI enables you to:
14
16
* Create, edit and delete query rules
15
17
* Reorder rules in a query ruleset
16
18
17
-
If you'd still prefer to use the Query Rules API, refer to [Query Rules API](https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-query_rules).
18
-
For examples 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).
19
+
## UI vs. API: What's the difference?
20
+
21
+
All the functionality in the UI works the same as in API calls. The only difference is that the Query Rules UI will create pinning by `docs` over `ids`. It'll still allow edits in a simple form for `id` pinning. For more information on Rule actions, refer [Rule actions](https://www.elastic.co/docs/reference/elasticsearch/rest-apis/searching-with-query-rules#query-rule-actions).
22
+
23
+
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).
24
+
25
+
If you prefer to use the Query Rules API, refer to [Query Rules API](https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-query_rules).
19
26
20
27
## Security privileges
21
28
22
-
If you want to get full access to the Query Rules GUI, you must have the following privileges:
29
+
If you want to get full access to the Query Rules UI, you must have the following privileges:
23
30
24
31
* 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)
25
32
* A custom role with `manage_search_query_rules` cluster privilege
26
33
*`ALL` option for `Query Rules` role privilege in the respective Kibana space
27
34
28
-
## GUI vs. API: What's the difference?
35
+
## Using the UI
29
36
30
-
All the functionality in the GUI works the same as in API calls. The only difference is that the Query Rules GUI will create pinning by `docs` over `ids`. It'll still allow edits in a simple form for `id` pinning. For more information on Rule actions, refer [Rule actions](https://www.elastic.co/docs/reference/elasticsearch/rest-apis/searching-with-query-rules#query-rule-actions).
37
+
Go to your deployment and select **Query Rules** from the left navigation menu. If you're not able to see the option, contact the administrator to review the role assigned to you. The following screenshot shows the UI for a new deployment setup.
31
38
32
-
## Using the GUI
33
-
34
-
Go to your deployment and select **Query Rules** from the left navigation menu. If you're not able to see the option, contact the administrator to review the role assigned to you. The following screenshot shows the GUI for a new deployment setup.
0 commit comments