列出查询规则集

编辑

返回有关所有存储的查询规则集的信息。将返回每个规则集规则数量的摘要信息,可以使用获取查询规则集命令返回完整详细信息。

请求

编辑

GET _query_rules/

先决条件

编辑

需要 manage_search_query_rules 权限。

路径参数

编辑
size
(可选,整数)要检索的最大结果数。
from
(可选,整数)从第一个结果开始获取的偏移量。

示例

编辑

以下示例列出所有已配置的查询规则集

resp = client.query_rules.list_rulesets()
print(resp)
const response = await client.transport.request({
  method: "GET",
  path: "/_query_rules",
});
console.log(response);
GET _query_rules/

以下示例列出前三个查询规则集

resp = client.query_rules.list_rulesets(
    from_="0",
    size="3",
)
print(resp)
const response = await client.transport.request({
  method: "GET",
  path: "/_query_rules",
  querystring: {
    from: "0",
    size: "3",
  },
});
console.log(response);
GET _query_rules/?from=0&size=3

示例响应

{
    "count": 3,
    "results": [
        {
            "ruleset_id": "ruleset-1",
            "rule_total_count": 1,
            "rule_criteria_types_counts": {
                "exact": 1
            },
            "rule_type_counts": {
                "pinned": 1
            }
        },
        {
            "ruleset_id": "ruleset-2",
            "rule_total_count": 2,
            "rule_criteria_types_counts": {
                "exact": 1,
                "fuzzy": 1
            },
            "rule_type_counts": {
                "pinned": 2
            }
        },
        {
            "ruleset_id": "ruleset-3",
            "rule_total_count": 3,
            "rule_criteria_types_counts": {
                "exact": 1,
                "fuzzy": 2
            },
            "rule_type_counts": {
                "pinned": 2,
                "exclude": 1
            }
        }
    ]
}

rule_criteria_types_counts 中的计数可能大于 rule_total_count 的值,因为一个规则可能具有多个条件。