Spec-Zone.ru › Elasticsearch 8
›Elasticsearch Guide [8.17] ›REST API ›API правил запросов

Тестирование набора правил запроса

Новая справка по API

Для получения самых последних данных по API обратитесь к API правил запросов.

Оценивает критерии соответствия набора правил запроса, чтобы определить правила, которые соответствуют этим критериям.

Эта функциональность находится в техническом предварительном просмотре и может быть изменена или удалена в будущих выпусках. Elastic будет работать над исправлением любых проблем, но функции в техническом предварительном просмотре не подпадают под SLA поддержки официальных функций GA.

Запрос

POST _query_rules/<ruleset_id>/_test

Предварительные условия

Требуется привилегия manage_search_query_rules.

Параметры пути

<ruleset_id>
(Обязательно, строка)

Тело запроса

match_criteria
(Обязательно, объект) Определяет критерии соответствия, которые нужно применить к правилам в заданном наборе правил запроса. Критерии соответствия должны соответствовать ключам, определенным в поле criteria.metadata правила.

Коды ответов

400
Критерии ruleset_id или match_criteria не были указаны.
404 (Отсутствующие ресурсы)
Не удалось найти набор правил запроса, соответствующий ruleset_id.

Примеры

Для проверки набора правил предоставьте критерии соответствия, которые вы хотите проверить:

resp = client.query_rules.test(
    ruleset_id="my-ruleset",
    match_criteria={
        "query_string": "puggles"
    },
)
print(resp)
const response = await client.transport.request({
  method: "POST",
  path: "/_query_rules/my-ruleset/_test",
  body: {
    match_criteria: {
      query_string: "puggles",
    },
  },
});
console.log(response);
POST _query_rules/my-ruleset/_test
{
    "match_criteria": {
        "query_string": "puggles"
    }
}

Пример ответа:

{
    "total_matched_rules": 1,
    "matched_rules": [
        {
            "ruleset_id": "my-ruleset",
            "rule_id": "my-rule1"
        }
    ]
}

© 2023-2025 Elasticsearch
As of September 2024, Elasticsearch is available under a choice of three licenses: the Server Side Public License (SSPL), the Elastic License, or the AGPLv3 (OSI approved).
Elasticsearch and the Elasticsearch logo are trademarks of Elasticsearch B.V., registered in the U.S. and in other countries.
https://www.elastic.co/guide/en/elasticsearch/reference/8.17/test-query-ruleset.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API