通过

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

(Azure AI 搜索 REST API) 列出同义词映射

列出同义词映射操作返回 Azure AI 搜索服务中的同义词映射列表。

GET https://[service name].search.windows.net/synonymmaps?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 密钥字段。 有关详细信息 ，请参阅使用密钥身份验证连接到 Azure AI 搜索 。

请求正文

无。

响应

对于成功的请求：“200 正常”。 下面是响应正文示例：

    {  
      "value" : [  
        {  
          "name": "synonymmap1",  
          "format": "solr",  
          ... other synonym map properties  
        }]  
    }

可以将响应筛选为只筛选出你感兴趣的属性。 例如，如果只需要同义词映射名称的列表，请使用 OData 选择 查询选项：

GET https://[service name].search.windows.net/synonymmaps?api-version=[api-version]&$select=name
api-key: [admin key]

在此情况下，来自上述示例的响应将如下所示：

    {  
      "value" : [ { "name": "synonymmap1" }, ... ]  
    }

注意

如果同义词映射具有 加密密钥，则搜索服务必须有权访问加密密钥，才能检索该同义词映射定义中的加密属性。 如果不访问加密密钥，则返回占 "<encrypted>" 位符来代替加密属性。 还原对密钥的访问允许搜索服务再次检索完整的同义词映射定义。

另请参阅