你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

(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 参数

参数 说明
服务名称 必需。 将此设置为搜索服务的唯一用户定义名称。
同义词映射名称 必需。 请求 URI 指定要返回的同义词映射的名称。
api-version 必需。 当前稳定版本为 api-version=2020-06-30。 有关更多 版本，请参阅 API 版本。

请求标头

下表介绍必需和可选的请求标头。

字段 说明
Content-Type 必需。 将其设置为 application/json
api-key 如果使用 Azure 角色 并且请求中提供了持有者令牌，则为可选，否则需要密钥。 api-key 是系统生成的唯一字符串，用于对搜索服务的请求进行身份验证。 获取对象定义的请求必须包括设置为管理密钥 (而不是查询密钥) 的 api-key 字段。 有关详细信息 ，请参阅使用密钥身份验证连接到 Azure AI 搜索 。

请求正文

无。

响应

对于成功的响应，返回“状态代码：200 正常”。

该响应类似于 创建同义词映射 (Azure AI 搜索 REST API) 中的示例。

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

注意

如果同义词映射具有 加密密钥，则搜索服务必须有权访问加密密钥才能检索同义词映射定义。 如果不访问加密密钥，则会返回 400 错误请求。 还原对密钥的访问允许搜索服务再次检索同义词映射定义。

另请参阅