クエリルールセットの取得

クエリルールセットに関する情報を取得します。

リクエスト

GET _query_rules/<ruleset_id>

前提条件

manage_search_query_rules 権限が必要です。

パスパラメータ

  • <ruleset_id>
  • (必須、文字列)

レスポンスコード

  • 400
  • ruleset_id が提供されていません。
  • 404 (リソースが不足しています)
  • ruleset_id に一致するクエリルールセットが見つかりませんでした。

以下の例は、my-ruleset という名前のクエリルールセットを取得します:

Python

  1. resp = client.query_rules.get_ruleset(
  2. ruleset_id="my-ruleset",
  3. )
  4. print(resp)

Js

  1. const response = await client.transport.request({
  2. method: "GET",
  3. path: "/_query_rules/my-ruleset",
  4. });
  5. console.log(response);

コンソール

  1. GET _query_rules/my-ruleset/

サンプルレスポンス:

コンソール-結果

  1. {
  2. "ruleset_id": "my-ruleset",
  3. "rules": [
  4. {
  5. "rule_id": "my-rule1",
  6. "type": "pinned",
  7. "criteria": [
  8. {
  9. "type": "contains",
  10. "metadata": "query_string",
  11. "values": [ "pugs", "puggles" ]
  12. }
  13. ],
  14. "actions": {
  15. "ids": [
  16. "id1",
  17. "id2"
  18. ]
  19. }
  20. },
  21. {
  22. "rule_id": "my-rule2",
  23. "type": "pinned",
  24. "criteria": [
  25. {
  26. "type": "fuzzy",
  27. "metadata": "query_string",
  28. "values": [ "rescue dogs" ]
  29. }
  30. ],
  31. "actions": {
  32. "docs": [
  33. {
  34. "_index": "index1",
  35. "_id": "id3"
  36. },
  37. {
  38. "_index": "index2",
  39. "_id": "id4"
  40. }
  41. ]
  42. }
  43. }
  44. ]
  45. }