取得 Azure AI 搜尋 REST API (同義字對應)

  • 發行項

取得同義字對應作業會從 Azure AI 搜尋取得同義字對應定義。

GET 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 金鑰欄位， (而不是查詢金鑰) 。 如需詳細資訊 ，請參閱使用金鑰驗證連線到 Azure AI 搜尋 服務。

要求本文

無。

回應

回應成功時會傳回狀態碼：200 OK。

回應類似于 建立同義字對應 (Azure AI 搜尋 REST API) 中的範例。

{
    "name" : "synonymmap1",  
    "format" : "solr",  
    "synonyms" : "United States, United States of America, USA\n
    Washington, Wash. => WA",
    "encryptionKey": null
}

注意

如果同義字對應具有 加密金鑰，搜尋服務必須能夠存取加密金鑰，才能擷取同義字對應定義。 若沒有加密金鑰的存取權，則會傳回 400 不正確的要求。 還原金鑰的存取權可讓搜尋服務再次擷取同義字對應定義。

另請參閱