Skip to content

Commit 3d47890

Browse files
fixed feedback comments
1 parent c8e2bf7 commit 3d47890

File tree

5 files changed

+25
-17
lines changed

5 files changed

+25
-17
lines changed

explore-analyze/toc.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,6 @@ 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
103102
- file: query-filter/tools/search-profiler.md
104103
- file: query-filter/tools/grok-debugger.md
105104
- file: query-filter/tools/playground.md

explore-analyze/query-filter/tools/query-rules-gui.md renamed to solutions/search/query-rules-ui.md

Lines changed: 24 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,12 @@
22
applies_to:
33
stack: ga 9.1
44
serverless: ga
5+
elasticsearch:
56
---
6-
# Query rules GUI
77

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.
911

1012
Query rules help customize search results, giving you more control over how results are returned based on the contextual information in the query.
1113

@@ -14,31 +16,33 @@ The Query rules UI enables you to:
1416
* Create, edit and delete query rules
1517
* Reorder rules in a query ruleset
1618

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).
1926

2027
## Security privileges
2128

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:
2330

2431
* 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)
2532
* A custom role with `manage_search_query_rules` cluster privilege
2633
* `ALL` option for `Query Rules` role privilege in the respective Kibana space
2734

28-
## GUI vs. API: What's the difference?
35+
## Using the UI
2936

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.
3138

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.
35-
36-
:::{image} /explore-analyze/images/query-rules-gui-home.png
37-
:alt: Landing page for Query Rules GUI.
39+
:::{image} /solutions/images/elasticsearch-query-rules-ui-home.png
40+
:alt: Landing page for Query Rules UI.
3841
:screenshot:
3942
:::
4043

4144
### Create a query rule
45+
Use the following steps to first create a query ruleset, and then a query rule:
4246

4347
1. Select **Query Rules** in the navigation menu under **Relevance**.
4448
2. Select **Create ruleset**:
@@ -62,20 +66,23 @@ Go to your deployment and select **Query Rules** from the left navigation menu.
6266
Each ruleset must contain at least one rule.
6367
:::
6468

65-
:::{image} /explore-analyze/images/elasticsearch-query-rules-create-rule.png
69+
:::{image} /solutions/images/elasticsearch-query-rules-create-rule.png
6670
:alt: Creating a query rule.
6771
:screenshot:
6872
:::
6973

7074
### Delete a ruleset
75+
Use the following steps to delete a query ruleset:
7176
1. Select **Query Rules** in the navigation menu under **Relevance**.
7277
2. Select **Delete** or select it from the action menu (**...**).
7378
3. Select if the ruleset is safe to delete.
7479
4. Select **Delete ruleset**.
7580

7681
### Manage existing rules
82+
The following sections describe how to edit, delete, and re-order rules:
7783

7884
#### Edit a rule
85+
Use the following steps to edit a query rule:
7986
1. Select **Query Rules** in the navigation menu under **Relevance**.
8087
2. Select a ruleset.
8188
3. Select **Edit** from the action menu (**...**).
@@ -89,22 +96,23 @@ Unsaved rules will not be applied even if they're displayed in the UI.
8996
:::
9097

9198
#### Delete a rule
99+
Use the following steps to delete a query rule:
92100
1. Select **Query Rules** in the navigation menu under **Relevance**.
93101
2. Select a ruleset.
94102
3. Select **Delete rule** from the action menu (**...**)
95103
4. Select **Delete rule**.
96104
5. Select **Save** in the top right corner of the ruleset section.
97105

98106
#### Re-order rules
99-
107+
Use the following steps to re-order query rules:
100108
1. Select **Query Rules** in the navigation menu under **Relevance**.
101109
2. Select a ruleset.
102110
3. Drag a rule using the handle icon (≡) on the left.
103111
4. Drop it in the new position.
104112
5. Select **Save** in the top right corner of the ruleset section.
105113

106114
### Test and validate a ruleset
107-
115+
To test a query ruleset, do the following:
108116
1. Select **Query Rules** in the navigation menu under **Relevance**.
109117
2. Select a ruleset.
110118
3. Select **Test in Console**.

solutions/toc.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,7 @@ toc:
8989
- file: search/search-applications/search-application-client.md
9090
- file: search/apis-and-tools.md
9191
- file: search/ai-assistant.md
92+
- file: search/query-rules-ui.md
9293
- file: observability.md
9394
children:
9495
- file: observability/get-started.md

0 commit comments

Comments
 (0)