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

重置文档 (预览版 REST API)

  • 项目

适用于：2023-07-01-Preview、2021-04-30-Preview、2020-06-30-Preview、2019-05-06-Preview

重要

2023-07-01-预览版 () 无更改。

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 必需。 当前预览版本为 2023-07-01-Preview。 有关更多 版本，请参阅 API 版本。
overwrite 可选。 此参数确定是合并还是覆盖连续的“重置文档”操作。 默认值为 false。 如果为 false，则调用的文档键或数据源文档标识符的有效负载将添加到已排队等待重新处理的键列表中。 如果为 true，则调用的文档键或数据源文档标识符的有效负载将覆盖现有列表，包括在将键设置为 null 的情况下清除重置文档列表。

请求标头

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

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

请求正文

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

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

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

请求包含以下属性，请注意，应提供“documentKeys”和“datasourceDocumentIds”中的一个且唯一的属性：

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

响应

204 成功请求的无内容。

另请参阅