Skip to content

Commit 0c4b77b

Browse files
add query rules gui page and the menu option
1 parent 7a05cfe commit 0c4b77b

File tree

3 files changed

+44
-0
lines changed

3 files changed

+44
-0
lines changed
402 KB
Loading
Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
applies_to:
3+
stack: ga 9.1
4+
serverless: ga
5+
---
6+
# Query rules GUI
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.
9+
10+
11+
Query rules help customize search results, giving you more control over how results are returned based on the contextual information in the query. For more information on query rules, refer to our [Query Rules blog](https://www.elastic.co/search-labs/blog/elasticsearch-query-rules-generally-available).
12+
13+
You can do the following using the GUI without the need of any API calls:
14+
15+
* For a new deployment setup, create new rules
16+
* For an existing deployment setup, edit and delete rules
17+
18+
19+
20+
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).
21+
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).
22+
23+
## Security privileges
24+
25+
If you want to get full access to the Query Rules GUI, you must have the following privileges:
26+
27+
* 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)
28+
* A custom role with `manage_search_query_rules` cluster privilege
29+
* `ALL` option for `Query Rules` role privileges in the respective Kibana space
30+
31+
## GUI vs. API: What's the difference?
32+
33+
All the functionality in the GUI works the same as in API calls. The only difference is that the Query Rules GUI will create the pinning action by `docs` instead of the `ids` for the new rulesets. However, you'll be able to edit or delete existing rulesets which use pinning by `ids`. 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).
34+
35+
## Using the GUI
36+
37+
Go to your hosted 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 cloud hosted setup.
38+
39+
:::{image} /explore-analyze/images/query-rules-gui-home.png
40+
41+
42+
43+

explore-analyze/toc.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,7 @@ toc:
9999
children:
100100
- file: query-filter/tools/saved-queries.md
101101
- file: query-filter/tools/console.md
102+
- file: query-filter/tools/query-rules-gui.md
102103
- file: query-filter/tools/search-profiler.md
103104
- file: query-filter/tools/grok-debugger.md
104105
- file: query-filter/tools/playground.md

0 commit comments

Comments
 (0)