同義語セットのリスト

定義されたすべての同義語セットの概要を取得します。

このAPIは、定義された同義語セットの総数を取得することを可能にします。各同義語セットについて、その識別子と定義された同義語ルールの総数が返されます。

リクエスト

GET _synonyms

前提条件

manage_search_synonyms クラスター権限が必要です。

クエリパラメータ

  • from
  • (オプション、整数)取得する同義語セットの開始オフセット。デフォルトは 0 です。
  • size
  • (オプション、整数)取得する同義語セットの最大数を指定します。デフォルトは 10 です。

以下の例は、定義されたすべての同義語セットを取得します:

Python

  1. resp = client.synonyms.get_synonyms_sets()
  2. print(resp)

Ruby

  1. response = client.synonyms.get_synonyms_sets
  2. puts response

Js

  1. const response = await client.synonyms.getSynonymsSets();
  2. console.log(response);

コンソール

  1. GET _synonyms

サンプルレスポンス:

コンソール-結果

  1. {
  2. "count": 3,
  3. "results": [
  4. {
  5. "synonyms_set": "ecommerce-synonyms",
  6. "count": 2
  7. },
  8. {
  9. "synonyms_set": "my-synonyms-set",
  10. "count": 3
  11. },
  12. {
  13. "synonyms_set": "new-ecommerce-synonyms",
  14. "count": 1
  15. }
  16. ]
  17. }