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

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

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

请求标头

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

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

请求正文

请求正文语法与 创建同义词映射的语法相同。

更新现有同义词映射时,整个定义将替换为请求正文的内容。 通常,用于更新的最佳模式是使用 GET 检索定义,对其进行修改,然后使用 PUT 更新定义。

响应

对于成功的请求,如果创建了新的同义词映射,则为“201 已创建”;如果已更新现有同义词映射,则为“204 无内容”

默认情况下,响应正文将为空。 但是,如果 Prefer 请求标头设置为 return=representation,则响应正文将包含已更新或创建的同义词映射的 JSON。 在这种情况下,如果创建了新的同义词映射,则成功状态代码将为“201 已创建”;如果更新了现有同义词映射,则为“200 正常”。

另请参阅