更新 Azure AI 搜尋服務 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 參數

參數 Description
服務名稱 必要。 將此設定為搜尋服務的唯一使用者定義名稱。
同義字對應名稱 必要。 要求 URI 指定要更新的同義字對應名稱。
api-version 必要。 目前的穩定版本是 api-version=2020-06-30 。 如需更多版本，請參閱 API 版本 。

要求標頭

下表說明必要及選用的要求標頭。

欄位 Description
Content-Type 必要。 請設為 application/json
api-key 如果您使用 Azure 角色 ，並在要求上提供持有人權杖，則為選擇性，否則需要金鑰。 API 金鑰是唯一的系統產生字串，可驗證對搜尋服務的要求。 更新要求必須包含 api-key 設定為系統管理員金鑰的標頭 (，而不是查詢金鑰) 。 如需詳細資訊，請參閱 使用金鑰驗證連線到 Azure AI 搜尋 服務。

要求本文

要求本文語法與 建立同義字對應相同。

更新現有的同義字對應時，整個定義會取代為要求本文的內容。 一般而言，用於更新的最佳模式是使用 GET 擷取定義、修改定義，然後使用 PUT 進行更新。

回應

針對成功的要求，如果已建立新的同義字對應，則為 「201 Created」，如果現有的同義字對應已更新，則為 「204 No Content」

根據預設，回應本文將是空白。 不過，如果 Prefer 要求標頭設定為 return=representation ，回應本文將會包含已更新或建立之同義字對應的 JSON。 在此情況下，如果已建立新的同義字對應，則成功狀態碼會是 「201 Created」，如果現有的同義字對應已更新，則會是 「200 OK」。

另請參閱