mirror of
https://github.com/elastic/elasticsearch.git
synced 2025-04-25 07:37:19 -04:00
bfc87d46c0
* Update example in query rules docs * Ensure GET docs are also consistent * Update docs/reference/query-rules/apis/put-query-ruleset.asciidoc Co-authored-by: Liam Thompson <32779855+leemthompo@users.noreply.github.com> --------- Co-authored-by: Liam Thompson <32779855+leemthompo@users.noreply.github.com>
157 lines
3.4 KiB
Text
157 lines
3.4 KiB
Text
[role="xpack"]
|
|
[[get-query-ruleset]]
|
|
=== Get query ruleset
|
|
|
|
preview::[]
|
|
|
|
++++
|
|
<titleabbrev>Get query ruleset</titleabbrev>
|
|
++++
|
|
|
|
Retrieves information about a query ruleset.
|
|
|
|
[[get-query-ruleset-request]]
|
|
==== {api-request-title}
|
|
|
|
`GET _query_rules/<ruleset_id>`
|
|
|
|
[[get-query-ruleset-prereq]]
|
|
==== {api-prereq-title}
|
|
|
|
Requires the `manage_search_query_rules` privilege.
|
|
|
|
[[get-query-ruleset-path-params]]
|
|
==== {api-path-parms-title}
|
|
|
|
`<ruleset_id>`::
|
|
(Required, string)
|
|
|
|
[[get-query-ruleset-response-codes]]
|
|
==== {api-response-codes-title}
|
|
|
|
`400`::
|
|
The `ruleset_id` was not provided.
|
|
|
|
`404` (Missing resources)::
|
|
No query ruleset matching `ruleset_id` could be found.
|
|
|
|
[[get-query-ruleset-example]]
|
|
==== {api-examples-title}
|
|
|
|
The following example gets the query ruleset named `my-ruleset`:
|
|
|
|
////
|
|
|
|
[source,console]
|
|
--------------------------------------------------
|
|
PUT _query_rules/my-ruleset
|
|
{
|
|
"rules": [
|
|
{
|
|
"rule_id": "my-rule1",
|
|
"type": "pinned",
|
|
"criteria": [
|
|
{
|
|
"type": "contains",
|
|
"metadata": "query_string",
|
|
"values": [ "pugs", "puggles" ]
|
|
}
|
|
],
|
|
"actions": {
|
|
"ids": [
|
|
"id1",
|
|
"id2"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"rule_id": "my-rule2",
|
|
"type": "pinned",
|
|
"criteria": [
|
|
{
|
|
"type": "fuzzy",
|
|
"metadata": "query_string",
|
|
"values": [ "rescue dogs" ]
|
|
}
|
|
],
|
|
"actions": {
|
|
"docs": [
|
|
{
|
|
"_index": "index1",
|
|
"_id": "id3"
|
|
},
|
|
{
|
|
"_index": "index2",
|
|
"_id": "id4"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
--------------------------------------------------
|
|
// TESTSETUP
|
|
|
|
[source,console]
|
|
--------------------------------------------------
|
|
DELETE _query_rules/my-ruleset
|
|
--------------------------------------------------
|
|
// TEARDOWN
|
|
|
|
////
|
|
|
|
[source,console]
|
|
----
|
|
GET _query_rules/my-ruleset/
|
|
----
|
|
|
|
A sample response:
|
|
|
|
[source,console-result]
|
|
----
|
|
{
|
|
"ruleset_id": "my-ruleset",
|
|
"rules": [
|
|
{
|
|
"rule_id": "my-rule1",
|
|
"type": "pinned",
|
|
"criteria": [
|
|
{
|
|
"type": "contains",
|
|
"metadata": "query_string",
|
|
"values": [ "pugs", "puggles" ]
|
|
}
|
|
],
|
|
"actions": {
|
|
"ids": [
|
|
"id1",
|
|
"id2"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"rule_id": "my-rule2",
|
|
"type": "pinned",
|
|
"criteria": [
|
|
{
|
|
"type": "fuzzy",
|
|
"metadata": "query_string",
|
|
"values": [ "rescue dogs" ]
|
|
}
|
|
],
|
|
"actions": {
|
|
"docs": [
|
|
{
|
|
"_index": "index1",
|
|
"_id": "id3"
|
|
},
|
|
{
|
|
"_index": "index2",
|
|
"_id": "id4"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
----
|