シノニム マップの更新 (Azure AI Search REST API)
既存のシノニム マップ定義を改訂版で上書きします。
PUT https://[service name].search.windows.net/synonymmaps/[synonymmap name]?api-version=[api-version]
Content-Type: application/json
api-key: [admin key]
パラメーター | 説明 |
---|---|
サービス名 | 必須。 これを検索サービスの一意のユーザー定義名に設定します。 |
シノニム マップ名 | 必須。 要求 URI は、更新するシノニム マップの名前を指定します。 |
api-version | 必須。 現在の安定バージョンは です api-version=2020-06-30 。 その他 のバージョンについては、「API のバージョン 」を参照してください。 |
次の表では、必須と省略可能の要求ヘッダーについて説明します。
フィールド | 説明 |
---|---|
Content-Type | 必須。 これを application/json |
api-key |
Azure ロールを使用していて、要求でベアラー トークンが提供されている場合は省略可能。それ以外の場合はキーが必要です。 api-key は、検索サービスに対する要求を認証する一意のシステム生成文字列です。 更新要求には、(クエリ キーではなく) 管理者キーに設定されたヘッダーを含める api-key 必要があります。 詳細については、「 キー認証を使用して Azure AI Search に接続 する」を参照してください。 |
要求本文の構文は、 シノニム マップの作成と同じです。
既存のシノニム マップを更新すると、定義全体が要求本文の内容に置き換えられます。 一般に、更新に使用する最適なパターンは、GET を使用して定義を取得し、それを変更してから PUT で更新することです。
要求が成功した場合は、新しいシノニム マップが作成された場合は "201 Created"、既存のシノニム マップが更新された場合は "204 コンテンツなし"
既定では、応答本文は空になります。 ただし、要求ヘッダーが Prefer
に return=representation
設定されている場合、応答本文には、更新または作成されたシノニム マップの JSON が含まれます。 この場合、新しいシノニム マップが作成された場合は成功状態コードは "201 Created" になり、既存のシノニム マップが更新された場合は "200 OK" になります。