通过

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

重置文档（预览版 REST API）

  • 项目

适用于：2023-07-01-Preview。 此版本不再受支持。 将立即升级到较新版本。

重要

2023-07-01-Preview（无更改）。

2021-04-30-Preview（无更改）。

2020-06-30-Preview（无更改）。

2019-05-06-Preview 添加了对 重置方案的支持。

重置文档是一个异步 API。 它允许有选择地重新处理数据源中的文档。

API 接受两种类型的文档标识符作为输入。 它们是文档键（用于唯一标识搜索索引中的文档的键）和数据源文档标识符（用于唯一标识数据源中的文档的键）。 调用 API 会添加要重置为索引器元数据的文档密钥或数据源文档标识符。 在下一次计划或按需运行索引器时，索引器仅处理重置文档。

  • 对于启用了技能集和增量扩充的索引器，API 将清除缓存并重新运行指定文档的完整技能集。
  • 对于没有技能集的索引器，API 从数据源读取源文档并更新/将内容插入索引中。

如果使用文档键来重置文档，并且文档密钥在索引器字段映射中被引用，索引器将使用字段映射在基础数据源中找到相应的字段。

该 API 适用于所有索引器（无论是否具有技能集）。 可以使用 HTTP POST 请求调用它。 如果调用成功，则会收到 204 NoContent 响应。 指定要在请求 URI 上更新的索引器的名称：

POST https://[service name].search.windows.net/indexers/[indexer name]/resetdocs?api-version=[api-version]
    Content-Type: application/json
    api-key: [admin key]

URI 参数

参数 描述
服务名称 必填。 将此设置为搜索服务的唯一用户定义的名称。
索引器名称 必填。 请求 URI 指定要更新的索引器的名称。
api-version 必填。 有关更多版本，请参阅 API 版本。
改写 自选。 此参数确定是组合还是覆盖连续重置文档操作。 默认值为 false。 如果为 false，则调用的文档密钥或数据源文档标识符的有效负载将添加到已排队等待重新处理的密钥列表中。 如果为 true，则调用的文档键或数据源文档标识符的有效负载将覆盖现有列表，包括清除重置文档列表（如果将密钥设置为 null）。

请求标头

下表描述了必需的和可选的请求标头。

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

请求正文

正文应包含文档键列表或索引器在数据源中查找的数据源文档标识符列表。

以下 JSON 是定义的主要部分的高级表示形式。

{
    "documentKeys" : [
        "key1",
        "key2",
        "key3"
    ],
    "datasourceDocumentIds" : [
        "key1",
        "key2",
        "key3"
    ],
}

请求包含以下属性，请注意，应提供一个和只有一个“documentKeys”和“datasourceDocumentIds”：

财产 描述
documentKeys 这是索引器有选择地从其数据源重新处理的文档键集。 默认情况下，多次调用此操作会将文档键集追加在一起。 此行为可以更改为覆盖，而不是通过覆盖 URI 参数追加（请参阅上文）。 如果希望索引器停止尝试处理重置文档，可以将“documentKeys”设置为空列表“[]”。 这会导致索引器根据高水位标记恢复常规索引。 忽略不存在的文档键或文档键无效。
datasourceDocumentIds 这是索引器有选择地从其数据源重新处理数据源的数据源文档标识符集。 默认情况下，多次调用此操作会将数据源文档标识符集追加在一起。 此行为可以更改为覆盖，而不是通过覆盖 URI 参数追加（请参阅上文）。 如果希望索引器停止尝试处理重置文档，可以将“datasourceDocumentIds”设置为空列表“[]”。 这会导致索引器根据高水位标记恢复常规索引。 忽略不存在的数据源文档标识符或数据源文档标识符无效。

响应

204 没有成功请求的内容。

另请参阅