Skip to main content

功能概述

对于已经处理完成的文件拆分任务,如果发现拆分后的子文件类别不正确,或者需要调整子文件的页码范围,可以使用 修改文件类别 接口修改拆分后的文件类别和页码。
此接口用于修改文件拆分任务(task_type = 2,父任务)产生的子文件的类别和页码。需要先获取父任务的 task_id

使用场景

  1. 拆分类别修正:自动拆分后,某些子文件的类别识别错误,需要手动修正
  2. 页码调整:拆分后的页码范围需要调整,例如将多个子文件合并或重新划分

API 接口

接口地址POST /api/app-api/sip/platform/v2/file/amend_category

请求参数

split_tasks 参数说明

参数说明

  • task_id:父任务的ID(task_type = 2),可以通过 file/fetch 接口获取
  • category:新文件类别名称,必须是已在 DocFlow 空间配置过的文件类别。如果某个子文件不需要修改类别,可以保持原有类别不变
  • pages:页码数组,表示该子文件包含的原文件页码。例如 [0, 1] 表示包含第1页和第2页(从0开始计数)。如果某个子文件不需要修改页码,可以保持原有页码不变
重要split_tasks 数组中必须包含所有拆分后的子文件信息,即使部分子文件的类别或页码不需要修改。如果只提交部分子文件信息,会导致未包含的子文件被删除或处理异常。

示例代码

获取父任务ID和子文件信息

在修改文件类别之前,需要先获取父任务的 task_id 和子文件信息。可以通过 file/fetch 接口查询:

返回结果

成功修改文件类别后,接口会返回成功响应:

完整示例

以下是一个完整的示例,展示如何查询文件拆分任务信息,然后修改子文件的类别和页码:
Python

页码说明

  • 页码从 0 开始计数,即第1页对应页码 0,第2页对应页码 1,以此类推
  • pages 数组中的页码表示该子文件包含的原文件页码

注意事项

  1. 必须包含所有子文件split_tasks 数组中必须包含所有拆分后的子文件信息,即使部分子文件的类别或页码不需要修改。如果只提交部分子文件信息,会导致未包含的子文件被删除或处理异常
  2. 任务类型限制:只有文件拆分父任务(task_type = 2)才支持使用 split_tasks 参数
  3. 类别必须存在:指定的 category 必须在 DocFlow 空间中已经配置过,否则会返回错误
  4. 类别名称匹配:类别名称必须与配置时完全一致(区分大小写)
  5. 页码范围:确保 pages 数组中的页码在有效范围内(0 到原文件总页数-1),且页码不能重复
  6. 页码不重复:每个页码只能出现在一个子文件中,不能有重叠
  7. 修改后重新处理:修改文件类别和页码后,系统会根据新的类别和页码范围重新进行数据处理