同義語セットの取得（Get synonyms set）

同義語セットの取得

同義語セットを取得します。

リクエスト

GET _synonyms/<synonyms_set>

前提条件

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

パスパラメータ

• <synonyms_set>
• (必須、文字列) 取得する同義語セットの識別子。

クエリパラメータ

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

レスポンスコード

• 400
• synonyms_set 識別子が提供されていませんでした。
• 404 (リソースが不足しています)
• 識別子 synonyms_set の同義語セットは見つかりませんでした。

例

次の例は、my-synonyms-set という同義語セットを取得します:

Python

resp = client.synonyms.get_synonym(
   id="my-synonyms-set",
)
print(resp)

Ruby

response = client.synonyms.get_synonym(
  id: 'my-synonyms-set'
)
puts response

Js

const response = await client.synonyms.getSynonym({
  id: "my-synonyms-set",
});
console.log(response);

コンソール

GET _synonyms/my-synonyms-set

返された同義語セットの情報には、同義語セットに含まれる同義語ルールの総数と、from および size パラメータに基づく同義語ルールが含まれます。

サンプルレスポンス:

コンソール-結果

{
  "count": 3,
  "synonyms_set": [
   {
   "id": "test-1",
   "synonyms": "hello, hi"
   },
   {
   "id": "test-2",
   "synonyms": "bye, goodbye"
   },
   {
   "id": "test-3",
   "synonyms": "test => check"
   }
  ]
}