Skip to content

Commit 098eb51

Browse files
[DOCS] Add query rules UI links to reference content (#133219)
* add links to Query rules GUI * rephrase words * rephrase words * Update docs/reference/elasticsearch/rest-apis/searching-with-query-rules.md Co-authored-by: Liam Thompson <[email protected]> * Update docs/reference/elasticsearch/rest-apis/searching-with-query-rules.md Co-authored-by: Liam Thompson <[email protected]> * Update docs/reference/elasticsearch/rest-apis/searching-with-query-rules.md Co-authored-by: Liam Thompson <[email protected]> * Update docs/reference/elasticsearch/rest-apis/searching-with-query-rules.md Co-authored-by: Liam Thompson <[email protected]> --------- Co-authored-by: Liam Thompson <[email protected]>
1 parent 1307aca commit 098eb51

File tree

1 file changed

+10
-3
lines changed

1 file changed

+10
-3
lines changed

docs/reference/elasticsearch/rest-apis/searching-with-query-rules.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,16 +16,21 @@ $$$query-rules$$$
1616
* Personalized metadata about users (e.g. country, language, etc)
1717
* A particular topic
1818
* A referring site
19-
* etc.
19+
2020

2121
Query rules define a metadata key that will be used to match the metadata provided in the [rule retriever](/reference/elasticsearch/rest-apis/retrievers/rule-retriever.md) with the criteria specified in the rule.
2222

2323
When a query rule matches the rule metadata according to its defined criteria, the query rule action is applied to the underlying `organic` query.
2424

2525
For example, a query rule could be defined to match a user-entered query string of `pugs` and a country `us` and promote adoptable shelter dogs if the rule query met both criteria.
2626

27-
Rules are defined using the [query rules API](https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-query_rules) and searched using the [rule retriever](/reference/elasticsearch/rest-apis/retrievers/rule-retriever.md) or the [rule query](/reference/query-languages/query-dsl/query-dsl-rule-query.md).
27+
You can create and manage query rules using either:
28+
- [Query rules API]({{es-apis}}v9/group/endpoint-query_rules)
29+
- [Query Rules UI](docs-content://solutions/search/query-rules-ui.md)
2830

31+
You can search with query rules using either:
32+
- [Retrievers syntax](/reference/elasticsearch/rest-apis/retrievers/rule-retriever.md)
33+
- [Query DSL syntax](/reference/query-languages/query-dsl/query-dsl-rule-query.md)
2934

3035
## Rule definition [query-rule-definition]
3136

@@ -68,7 +73,7 @@ The actions to take when the rule matches a query:
6873
Use `ids` when searching over a single index, and `docs` when searching over multiple indices. `ids` and `docs` cannot be combined in the same query.
6974

7075

71-
## Add query rules [add-query-rules]
76+
## Manage query rules [manage-query-rules]
7277

7378
You can add query rules using the [Create or update query ruleset](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-query-rules-put-ruleset) call. This adds a ruleset containing one or more query rules that will be applied to queries that match their specified criteria.
7479

@@ -145,6 +150,8 @@ There is a limit of 100 rules per ruleset. This can be increased up to 1000 usin
145150

146151
You can use the [Get query ruleset](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-query-rules-get-ruleset) call to retrieve the ruleset you just created, the [List query rulesets](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-query-rules-list-rulesets) call to retrieve a summary of all query rulesets, and the [Delete query ruleset](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-query-rules-delete-ruleset) call to delete a query ruleset.
147152

153+
To manage rules using the Query Rules UI, refer to [Manage query rules](https://www.elastic.co/docs/solutions/search/query-rules-ui#manage-existing-rules).
154+
148155

149156
## Search using query rules [rule-query-search]
150157

0 commit comments

Comments
 (0)