DemoAPI 参考文档FAQ

PDF 生成模板编辑器

开源可视化 PDF 生成引擎，支持自定义模板，并提供面向开发者的 API，灵活构建文档生成流程。

查看 GitHub

开放 API 接口参考 ​

本文档介绍ComPDF AI开放API的认证方式、请求参数、响应结构、任务状态、调用流程和错误处理。所有接口路径使用/api/v2前缀，API基地址由部署环境提供。

1. 服务地址与鉴权 ​

接口路径统一使用/api/v2前缀。请求示例中的API_BASE_URL填写部署环境提供的API基地址，不重复包含/api/v2；API_KEY填写有效的Service API Key。

字段说明
X-API-Key填写Service API Key原值。
Authorization可替代X-API-Key，格式为Bearer <API_KEY>。
Content-TypeJSON请求使用application/json；文件上传使用multipart/form-data，boundary由客户端生成。
Accept-Version / parser_version适用的结果接口支持v2和v3；同时提供时，两者必须一致。解析版本与result_format分别控制解析结构和抽取展示格式。

API Key绑定租户和资源访问范围。共享默认模板的使用权限与管理权限分别控制，可通过usable和manageable等响应字段读取。密钥仅放在请求头中。X-Request-ID用于关联错误响应与服务日志。

curl示例中的服务地址和密钥请替换为当前部署提供的实际值。

2. 接口总览 ​

方法路径功能
POST/api/v2/files/upload上传文件（异步处理）
DELETE/api/v2/files删除文件
PUT/api/v2/files/{fileId}/template修改文件模板类别
GET/api/v2/batches/{batchId}/tasks查询批次任务
POST/api/v2/tasks/{taskId}/retry重试/重新处理任务
DELETE/api/v2/tasks/取消任务
GET/api/v2/templates获取模板列表
GET/api/v2/templates/{id}/fields获取模板字段
POST/api/v2/templates创建模板
PUT/api/v2/templates/更新模板
DELETE/api/v2/templates/删除模板
POST/api/v2/templates/samples上传创建模板前的样本
POST/api/v2/templates/{templateId}/samples上传/替换模板样本
GET/api/v2/templates/{templateId}/samples获取模板样本列表
DELETE/api/v2/templates/{templateId}/samples/删除模板样本
POST/api/v2/extract/{fileId}/fields自定义字段抽取
GET/api/v2/tasks/获取文件处理结果
PUT/api/v2/tasks/更新文件处理结果
GET/api/v2/classify/{taskId}/result获取文件分类
POST/api/v2/rules创建提醒规则
PUT/api/v2/rules/更新提醒规则
GET/api/v2/rules获取提醒规则列表
GET/api/v2/rules/获取提醒规则详情
PATCH/api/v2/rules/{rule_id}/status启停提醒规则
DELETE/api/v2/rules/删除提醒规则
GET/api/v2/assets获取资产信息

3. 通用约定 ​

3.1 响应格式 ​

接口/字段格式说明
文件、任务、模板、资产HTTP 200; code=200code为数字，data根据接口返回对象、数组、字符串或null。
提醒规则code=0; HTTP 200/201创建返回HTTP201；删除返回HTTP204且无响应体。
错误响应HTTP状态与业务code同时读取HTTP状态、code/error_code和error_detail。带前导零的业务码保持字符串类型。
error_detail.request_idstring错误关联标识，对应X-Request-ID响应头。

3.2 时间、分页和字段命名 ​

无UTC偏移的日期时间字段按服务配置的时区解释。提醒规则时间使用带Z的UTC ISO8601格式。expectedUpdateDate应使用最近一次查询返回的updateDate原文，保持时区表示和精度。

样本列表使用page和page_size分页；其他列表按各接口列出的筛选参数调用。字段名称和大小写以参数表为准。点号表示对象层级，[]表示数组项，<name>表示动态业务键。

JSON请求体只包含业务对象，请求头单独发送。curl示例使用Bash；调用时替换示例ID、时间、密钥和文件。请求体与响应示例随各接口列出。

3.3 异步处理与重试 ​

上传、重试和重新抽取操作返回提交结果。处理进度通过批次或任务查询接口读取；后续操作应满足任务状态要求。写入请求超时后，先查询资源状态，再决定是否重试。回调和通知通过配置的渠道异步投递。

3.4 状态与业务规则 ​

S1 任务状态、阶段和重试 ​

批次筛选、分类和重试响应使用pending、processing、completed、failed、cancelled。任务详情status使用pending_parsing、parsing、parsing_failed、pending_classification、classifying、classification_failed、pending_extraction、extracting、extraction_completed、extraction_failed、cancelled。任务从等待进入处理，随后完成、失败或取消。重试沿用原taskId，返回createdNewTask=false，并重新进入等待状态。重试读取最新已保存模板，固定为本次处理快照。调用前读取任务状态，等待正在处理的任务结束。

S2 批次聚合与查询 ​

批次状态为pending、processing、completed、failed、partial_failed、cancelled、empty。存在处理中任务时为processing；其次，存在等待任务时为pending。全部完成、全部失败或全部取消时采用对应终态；混合终态为partial_failed；无任务为empty。任务列表筛选不改变批次聚合状态。上传响应返回提交时的状态，后续通过批次或任务查询获取处理进度。回调按管理员配置的订阅和投递规则执行。

S3 模板与样本 ​

模板列表使用active/inactive筛选，模板对象status使用0表示停用、1表示启用、2表示删除。每个模板最多关联5份样本，删除后至少保留1份。样本和画像的处理状态包括processing、active、failed；结合版本字段和classificationNeedsSave判断当前状态。

S4 资产、预锁定与释放 ​

写入操作受API Key、租户、许可和产品额度控制。文件处理按模式、阶段及页数预锁定资源；处理成功后结算实际用量，失败或取消时释放未结算预占。额度面板随异步结算更新。删除和取消保留已结算用量。资产查询返回当前可用量、预占量、已用量及无限额度标记。usageExact为null表示历史用量未知。

S5 删除与取消 ​

DELETE /tasks/{taskId}取消等待或处理中的任务。文件删除使用文件ID、创建时间范围或metadata条件；多个顶层条件取并集，metadata对象内的条件需同时满足。deletePermanently默认为false；true执行永久清理。批量删除按文件返回处理结果，通过deletedCount、failedCount、failedIds和failedReasons读取结果。重复请求仍会执行资源和状态校验。

S6 结果编辑、版本与确认 ​

处理状态、confirmStatus与评分状态相互独立。已完成且pending的结果可编辑；已确认结果需先通过管理流程撤销确认，再GET最新值。fields/tables/parse_result至少一项，各提交部分为完整替换，遗漏的字段或元素可被删除。confirm默认true；false只是本次不主动确认，评分仍可能自动确认。expectedUpdateDate是可选的精确比较令牌，必须使用GET原文，不改时区或精度；冲突应先重读并合并，不盲目重放。保存不自动重新抽取；重新抽取使用已定义的重试/自定义字段接口。

S7 提醒触发、重复与失败 ​

规则状态为active/inactive，创建后默认为active。更新时省略的字段保持原值，合并后的配置会重新校验。review_status条件使用pending/confirmed，processing_status使用S1中的细阶段值，score使用1–100。daily/hourly由服务调度执行。相同规则与来源使用24小时触发去重，更新可重置该规则的去重记录。邮件及回调通过配置的渠道异步投递；投递取决于接收人有效性和渠道状态，无有效接收人时跳过，失败时按渠道重试策略处理。删除规则保留已发送通知。

4. 开放 API ​

4.1 概述 ​

本章按文件管理、任务管理、模板与文件处理、提醒规则及资产信息组织接口。各接口分别说明参数位置、类型、必填条件、默认值、请求示例和响应字段。

4.2 文件管理 ​

上传文件接口提交文件并返回批次和任务标识；处理进度与处理结果通过任务接口查询。

1. 上传文件（异步处理） ​

上传本地文件或公开URL并提交异步处理任务。该地址返回batchId、fileIds和taskIds，不等待最终处理结果；提交成功后，通过查询批次任务或获取文件处理结果接口查询进度和结果。

请求 ​
项目内容
方法POST
地址<API_BASE_URL>/api/v2/files/upload
鉴权X-API-Key；本租户可访问/可管理资源
Content-Typemultipart/form-data
请求头 ​
字段类型必填默认枚举格式/限制业务含义/依赖示例
X-API-Keystring是；可用Bearer替代无无不放在URL或Body验证Key租户与归属<API_KEY>
表单参数 ​
字段类型必填默认枚举格式/限制业务含义/依赖示例
filebinary or binary[]与 url 必须选一个无无每文件不超过104857600字节；pdf/doc/docx/xls/xlsx/png/jpg/jpeg/bmp/tif/tiff。网关或许可可有更低限制。实际文件内容；选择文件，而不是填写本地路径。可一次上传多文件。@invoice.pdf
urlstring与 file 必须选一个无无连接10秒、读取30秒；最多4轮HTTP请求，最多3次重定向后成功下载；每次重定向重新检查主机。公开可下载的HTTP/HTTPS文件URL；拒绝本机、内网、链路本地及组播地址。https://files.example.com/invoice.pdf
modestring是无VisualExtract：视觉抽取；LayoutExtract：先解析再抽取—选择文件处理方式；大小写按枚举填写。VisualExtract
template_idstring否自动分类无—预先指定模板时跳过自动模板分类；使用本租户可用模板。template_example
metadatastring否无无受服务端请求体大小和存储限制。调用方业务标签。以JSON文本字符串传入；任务响应保持文本，不是上传表单中的object。
user_idstring否当前Key的组织身份无—上传文件的归属用户ID。提供时校验组织归属；省略时归属当前API Key的组织。user_example
user_emailstring否无无—上传者邮箱记录字段。文件归属由user_id及API Key确定。[email protected]
enable_scoringboolean否truetrue启用；false停用—是否启用任务评分；兼容别名enableScoring。false
请求示例 ​

执行示例前，替换服务地址、密钥、资源ID、时间和文件。

bash
curl --request POST "<API_BASE_URL>/api/v2/files/upload" \
  --header "X-API-Key: <API_KEY>" \
  --form "[email protected]" \
  --form "mode=VisualExtract" \
  --form "template_id=template_example" \
  --form 'metadata={"source":"api"}'

URL方式请删除file表单项，替换为：

bash
  --form "url=https://files.example.com/invoice.pdf"
成功响应 ​

HTTP 200

以下为成功响应示例。字段是否有值取决于任务状态、接口版本及资源可用性；业务字段名称由模板定义。

json
{
  "code": 200,
  "message": "success",
  "data": {
    "batchId": "batch_example",
    "fileIds": [
      "task_example"
    ],
    "taskIds": [
      "task_example"
    ],
    "tasks": [
      {
        "taskId": "task_example",
        "fileId": "task_example",
        "status": "pending_extraction",
        "phase": "extracting",
        "failureCode": null,
        "error": null
      }
    ],
    "uploadStatus": "processing"
  }
}
响应字段 ​
字段类型必返枚举出现条件含义
codeinteger是—JSON成功响应文件、任务、模板和资产接口成功码为200；提醒规则为0，均为数字。
messagestring是—JSON成功响应英文系统结果说明，通常success。
dataobject是；可为null—按任务状态、版本及资源可用性；null不等于空内容或0。本接口的数据，结构见以下字段；无返回内容时为null。
data.batchIdstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。一次上传的批次标识；历史任务可能为空。
data.fileIdsarray父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。本次上传生成的文件/任务标识列表；按相同顺序对应。
data.fileIds[]string父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。本次上传生成的文件/任务标识列表；按相同顺序对应。
data.taskIdsarray父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。本次上传生成的文件/任务标识列表；按相同顺序对应。
data.taskIds[]string父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。本次上传生成的文件/任务标识列表；按相同顺序对应。
data.tasksarray父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。当前批次内各任务的状态信息。
data.tasks[]object父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。当前批次内各任务的状态信息。
data.tasks[].taskIdstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。任务标识，后续查询使用。
data.tasks[].fileIdstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。文件标识；业务任务中通常与taskId相同，样本文件则不同。
data.tasks[].statusstring父对象存在时；可选投影见条件按对象区分，见S1/S3父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。当前对象状态；任务、样本、会话与规则的枚举不同，见S1/S2/S3。
data.tasks[].phasestring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。处理阶段：parsing/classifying/extracting；无对应阶段时为空。
data.tasks[].failureCodestring | null父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。失败信息；非失败状态通常为空。使用稳定错误码/阶段，不解析文案判状态。
data.tasks[].errorstring | null父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。失败信息；非失败状态通常为空。使用稳定错误码/阶段，不解析文案判状态。
data.uploadStatusstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。上传提交状态，返回processing。各文件的处理进度通过tasks及任务查询接口读取。
接口特有说明 ​
  • 前置条件：file/url二选一；有效Key、许可与额度；不强制user_id/user_email二选一。
  • 副作用：每次成功提交创建批次和任务；不能把重复上传当幂等操作。
  • 规则：S1, S4
适用错误 ​

E-AUTH, E-RESOURCE, E-INTERNAL, E-PARAM, E-QUOTA, E-FORMAT

后续调用 ​

2. 删除文件 ​

按显式选择条件删除文件及对应结果。

请求 ​
项目内容
方法DELETE
地址<API_BASE_URL>/api/v2/files
鉴权X-API-Key；本租户可访问/可管理资源
Content-Typeapplication/json
请求头 ​
字段类型必填默认枚举格式/限制业务含义/依赖示例
X-API-Keystring是；可用Bearer替代无无不放在URL或Body验证Key租户与归属<API_KEY>
JSON请求体 ​
字段类型必填默认枚举格式/限制业务含义/依赖示例
fileIdsarray<string>三种筛选条件至少一个无无—指定要删除的文件ID。兼容字段名file_ids。["task_example"]
dateRangeobject三种筛选条件至少一个无无—按文件创建时间选择，兼容date_range。与其他顶层条件取并集。
dateRange.start / dateRange.endstring使用范围时至少提供一端无无—包含边界的本地日期时间字符串；无时区偏移，按部署约定解释。2026-10-23T08:00:00
metadataConditionsobject三种筛选条件至少一个无无—匹配metadata键值；对象内条件为AND，顶层选择方式之间为OR。兼容metadata_conditions。
deletePermanentlyboolean否false无—false进入回收/逻辑删除；true永久清理。兼容delete_permanently。false
请求示例 ​

执行示例前，替换服务地址、密钥、资源ID、时间和文件。

bash
curl --request DELETE "<API_BASE_URL>/api/v2/files" \
  --header "X-API-Key: <API_KEY>" \
  --header "Content-Type: application/json" \
  --data-raw '{
  "fileIds": [
    "task_example"
  ],
  "deletePermanently": false
}'

纯JSON Body：

json
{
  "fileIds": [
    "task_example"
  ],
  "deletePermanently": false
}
成功响应 ​

HTTP 200

以下为成功响应示例。字段是否有值取决于任务状态、接口版本及资源可用性；业务字段名称由模板定义。

json
{
  "code": 200,
  "message": "success",
  "data": {
    "deletedCount": 1,
    "failedCount": 0,
    "failedIds": [],
    "failedReasons": {}
  }
}
响应字段 ​
字段类型必返枚举出现条件含义
codeinteger是—JSON成功响应文件、任务、模板和资产接口成功码为200；提醒规则为0，均为数字。
messagestring是—JSON成功响应英文系统结果说明，通常success。
dataobject是；可为null—按任务状态、版本及资源可用性；null不等于空内容或0。本接口的数据，结构见以下字段；无返回内容时为null。
data.deletedCountinteger父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。本次批量删除成功或失败的数量。
data.failedCountinteger父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。本次批量删除成功或失败的数量。
data.failedIdsarray父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。删除失败的文件ID及对应原因。通过failedCount判断是否存在失败项。
data.failedReasonsobject父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。删除失败的文件ID及对应原因。通过failedCount判断是否存在失败项。
data.failedIds[]string有失败项时无对应失败记录存在单个删除失败文件ID。
data.failedReasons.<fileId>string有失败项时无对应失败记录存在按文件ID索引的失败原因。
接口特有说明 ​
  • 前置条件：至少提供一个有效删除条件。多个顶层条件取并集；使用fileIds可精确指定文件。
  • 副作用：可逻辑删除或永久清理；检查failedCount和failedReasons，已完成删除不会仅因日志失败而回滚。
  • 规则：S4, S5
适用错误 ​

E-AUTH, E-RESOURCE, E-INTERNAL, E-PARAM

后续调用 ​

3. 修改文件模板类别 ​

更换文件所用模板并触发重新处理。

请求 ​
项目内容
方法PUT
地址<API_BASE_URL>/api/v2/files/{fileId}/template
鉴权X-API-Key；本租户可访问/可管理资源
Content-Typeapplication/json
请求头 ​
字段类型必填默认枚举格式/限制业务含义/依赖示例
X-API-Keystring是；可用Bearer替代无无不放在URL或Body验证Key租户与归属<API_KEY>
路径参数 ​
字段类型必填默认枚举格式/限制业务含义/依赖示例
fileIdstring是无无—文件ID；此任务体系通常与taskId相同。task_example
JSON请求体 ​
字段类型必填默认枚举格式/限制业务含义/依赖示例
groupTemplateIdstring是无无—模板分组关联ID，不是模板id；来自模板列表groupTemplateId。兼容group_template_id。group_example
enableScoringboolean否保留任务设置无—本次重新处理是否评分；兼容enable_scoring。true
请求示例 ​

执行示例前，替换服务地址、密钥、资源ID、时间和文件。

bash
curl --request PUT "<API_BASE_URL>/api/v2/files/task_example/template" \
  --header "X-API-Key: <API_KEY>" \
  --header "Content-Type: application/json" \
  --data-raw '{
  "groupTemplateId": "group_example",
  "enableScoring": false
}'

纯JSON Body：

json
{
  "groupTemplateId": "group_example",
  "enableScoring": false
}
成功响应 ​

HTTP 200

以下为成功响应示例。字段是否有值取决于任务状态、接口版本及资源可用性；业务字段名称由模板定义。

json
{
  "code": 200,
  "message": "success",
  "data": {
    "fileId": "task_example",
    "templateId": "template_example",
    "groupTemplateId": "group_example",
    "taskId": "task_example"
  }
}
响应字段 ​
字段类型必返枚举出现条件含义
codeinteger是—JSON成功响应文件、任务、模板和资产接口成功码为200；提醒规则为0，均为数字。
messagestring是—JSON成功响应英文系统结果说明，通常success。
dataobject是；可为null—按任务状态、版本及资源可用性；null不等于空内容或0。本接口的数据，结构见以下字段；无返回内容时为null。
data.fileIdstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。文件标识；业务任务中通常与taskId相同，样本文件则不同。
data.templateIdstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。关联模板标识；自动分类完成前可能为空。
data.groupTemplateIdstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。模板分组关联标识，不等同templateId。
data.taskIdstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。任务标识，后续查询使用。
接口特有说明 ​
  • 前置条件：提供有效groupTemplateId及本租户可用模板；不是templateId。
  • 副作用：清除/重置相关抽取结果并按模式重新排队；不可当纯字段编辑。
  • 规则：S1, S4
适用错误 ​

E-AUTH, E-RESOURCE, E-INTERNAL, E-PARAM, E-QUOTA

后续调用 ​

4.3 任务管理 ​

4. 查询批次任务 ​

查询一个上传批次的聚合状态和任务快照。

请求 ​
项目内容
方法GET
地址<API_BASE_URL>/api/v2/batches/{batchId}/tasks
鉴权X-API-Key；本租户可访问/可管理资源
Content-Type无Body，无需Content-Type
请求头 ​
字段类型必填默认枚举格式/限制业务含义/依赖示例
X-API-Keystring是；可用Bearer替代无无不放在URL或Body验证Key租户与归属<API_KEY>
路径参数 ​
字段类型必填默认枚举格式/限制业务含义/依赖示例
batchIdstring是无无—上传返回的batchId。batch_example
查询参数 ​
字段类型必填默认枚举格式/限制业务含义/依赖示例
statusstring否全部pending/processing/completed/failed/cancelled—仅筛选本批次任务；不是细阶段status。无分页参数。failed
请求示例 ​

执行示例前，替换服务地址、密钥、资源ID、时间和文件。

bash
curl --request GET "<API_BASE_URL>/api/v2/batches/batch_example/tasks" \
  --header "X-API-Key: <API_KEY>"
成功响应 ​

HTTP 200

以下为成功响应示例。字段是否有值取决于任务状态、接口版本及资源可用性；业务字段名称由模板定义。

json
{
  "code": 200,
  "message": "success",
  "data": {
    "batchId": "batch_example",
    "batchStatus": "completed",
    "tasks": [
      {
        "taskId": "task_example",
        "fileId": "task_example",
        "fileName": "invoice.pdf",
        "batchId": "batch_example",
        "taskType": "WORKFLOW_VISUAL_EXTRACT",
        "templateId": "template_example",
        "groupTemplateId": "group_example",
        "templateName": "Invoice Template",
        "status": "extraction_completed",
        "phase": null,
        "conversionStatus": "completed",
        "confirmStatus": "pending",
        "metadata": "{\"source\":\"api\"}",
        "error": null,
        "failureCode": null,
        "failureStage": null,
        "createdAt": "2026-10-23T08:00:00",
        "completedAt": "2026-10-23T08:00:00",
        "updateDate": "2026-10-23T08:00:00",
        "output": null,
        "layoutOutput": null,
        "apiVersion": null,
        "fieldExceptions": "[]",
        "updatedFields": null,
        "extractionResult": null,
        "parsingResult": null,
        "parseResult": null,
        "parseResultStatus": null,
        "fieldExceptionDetails": [],
        "score": null,
        "confidence": null,
        "input": {
          "fileId": "task_example",
          "templateId": "template_example",
          "groupTemplateId": "group_example",
          "templateName": "Invoice Template",
          "mode": "VisualExtract"
        },
        "consumption": {
          "pages": 1
        },
        "originalFile": null,
        "artifacts": null,
        "customJsonExport": null,
        "jsonExportError": null,
        "extractionSource": null,
        "parseResultUpdated": null
      }
    ]
  }
}
响应字段 ​
字段类型必返枚举出现条件含义
codeinteger是—JSON成功响应文件、任务、模板和资产接口成功码为200；提醒规则为0，均为数字。
messagestring是—JSON成功响应英文系统结果说明，通常success。
dataobject是；可为null—按任务状态、版本及资源可用性；null不等于空内容或0。本接口的数据，结构见以下字段；无返回内容时为null。
data.batchIdstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。一次上传的批次标识；历史任务可能为空。
data.batchStatusstring父对象存在时；可选投影见条件pending / processing / completed / failed / partial_failed / cancelled / empty父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。批次聚合状态，见S2。
data.tasksarray父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。当前批次内各任务的状态信息。
data.tasks[]object父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。当前批次内各任务的状态信息。
data.tasks[].taskIdstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。任务标识，后续查询使用。
data.tasks[].fileIdstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。文件标识；业务任务中通常与taskId相同，样本文件则不同。
data.tasks[].fileNamestring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。文件名；sourceFileName为原始来源名。
data.tasks[].batchIdstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。一次上传的批次标识；历史任务可能为空。
data.tasks[].taskTypestring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。既有任务类型标识，例如WORKFLOW_VISUAL_EXTRACT/WORKFLOW_LAYOUT_EXTRACT；历史类型保留。
data.tasks[].templateIdstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。关联模板标识；自动分类完成前可能为空。
data.tasks[].groupTemplateIdstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。模板分组关联标识，不等同templateId。
data.tasks[].templateNamestring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。对象或模板名称，业务内容保持原语言。
data.tasks[].statusstring父对象存在时；可选投影见条件按对象区分，见S1/S3父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。当前对象状态；任务、样本、会话与规则的枚举不同，见S1/S2/S3。
data.tasks[].phasestring | null父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。处理阶段：parsing/classifying/extracting；无对应阶段时为空。
data.tasks[].conversionStatusstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。文件转换状态信息；以服务返回值为准，不代替任务阶段。
data.tasks[].confirmStatusstring父对象存在时；可选投影见条件pending / confirmed父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。结果确认状态：pending待确认、confirmed已确认，与处理状态独立。
data.tasks[].metadatastring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。原上传的业务元数据文本；不是自动转换后的object。
data.tasks[].errorstring | null父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。失败信息；非失败状态通常为空。使用稳定错误码/阶段，不解析文案判状态。
data.tasks[].failureCodestring | null父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。失败信息；非失败状态通常为空。使用稳定错误码/阶段，不解析文案判状态。
data.tasks[].failureStagestring | null父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。处理阶段：parsing/classifying/extracting；无对应阶段时为空。
data.tasks[].createdAtstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。Java本地日期时间字符串，无显式时区偏移；未知/尚未完成可为空。updateDate用于精确版本比较。
data.tasks[].completedAtstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。已完成任务的更新时间。后续结果修改会更新此时间。
data.tasks[].updateDatestring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。Java本地日期时间字符串，无显式时区偏移；未知/尚未完成可为空。updateDate用于精确版本比较。
data.tasks[].outputJSON | null父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。抽取结果。output保留兼容形态；extractionResult为结构化字段、表格、排序与分页视图。
data.tasks[].layoutOutputstring | null父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。兼容解析结果JSON字符串；需要再解析一次，不能当作object直接使用。
data.tasks[].apiVersionstring | null父对象存在时；可选投影见条件v2 / v3父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。本响应采用的解析版本v2/v3，与根解析文档的api_version命名不同。
data.tasks[].fieldExceptionsstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。兼容校验异常JSON字符串。
data.tasks[].updatedFieldsarray | null父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。本次保存涉及的抽取字段名称列表；不是完整变更审计。
data.tasks[].extractionResultobject | null父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。抽取结果。output保留兼容形态；extractionResult为结构化字段、表格、排序与分页视图。
data.tasks[].parsingResultobject | null父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。同一公共解析文档的兼容对象字段；无归档/读取失败时可为空。
data.tasks[].parseResultobject | null父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。同一公共解析文档的兼容对象字段；无归档/读取失败时可为空。
data.tasks[].parseResultStatusstring | null父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。available可用、not_available无归档、read_failed读取失败。
data.tasks[].fieldExceptionDetailsarray父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。结构化字段异常明细；条目由具体校验结果决定。
data.tasks[].scoreobject | null父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。兼容评分对象：状态、总分、风险和字段映射；缺失时不伪造0分。
data.tasks[].confidenceobject | null父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。任务中为兼容新增的评分展示对象；分类结果中是可能为空的数值置信度。
data.tasks[].inputobject父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。任务输入摘要；可用来确认实际模式和模板。
data.tasks[].input.fileIdstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。文件标识；业务任务中通常与taskId相同，样本文件则不同。
data.tasks[].input.templateIdstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。关联模板标识；自动分类完成前可能为空。
data.tasks[].input.groupTemplateIdstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。模板分组关联标识，不等同templateId。
data.tasks[].input.templateNamestring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。对象或模板名称，业务内容保持原语言。
data.tasks[].input.modestring父对象存在时；可选投影见条件VisualExtract / LayoutExtract父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。本次处理模式：VisualExtract或LayoutExtract。
data.tasks[].consumptionobject父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。当前任务的资源使用信息。
data.tasks[].consumption.pagesinteger父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。在consumption下是页数；在结果下是页面数组，含分页字段/表格或解析页信息。
data.tasks[].originalFileobject | null父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。原文件信息及现有链接字段。
data.tasks[].artifactsobject | null父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。结果归档的可用性信息。
data.tasks[].customJsonExportboolean | null父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。是否已应用自定义JSON导出结构。
data.tasks[].jsonExportErrorstring | null父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。导出结构应用失败的信息；正常时为空。
data.tasks[].extractionSourceJSON | null父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。自定义导出需要时保留的原抽取结果；普通请求可为空。
data.tasks[].parseResultUpdatedboolean | null父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。仅结果更新响应用于指示本次是否修改解析部分。
data.tasks[].score.reasonstring否无服务实际提供对应诊断时评分不可用或失败的原因，例如scoring_disabled。
data.tasks[].score.modelFileScoreinteger否无服务实际提供对应诊断时模型诊断分数。整体评分读取fileScore。
data.tasks[].score.scoredFieldCountinteger否无服务实际提供对应诊断时模型附带的已评分字段数量；可不出现。
接口特有说明 ​
  • 前置条件：batchId来自上传；仅支持status筛选，无page/page_size/sort参数。
  • 副作用：不会因为列表返回就自动补齐每个任务的结果文档；详情用P11。
  • 规则：S1, S2
适用错误 ​

E-AUTH, E-RESOURCE, E-INTERNAL

后续调用 ​

5. 重试/重新处理任务 ​

重新执行文件任务处理。

请求 ​
项目内容
方法POST
地址<API_BASE_URL>/api/v2/tasks/{taskId}/retry
鉴权X-API-Key；本租户可访问/可管理资源
Content-Type无Body，无需Content-Type
请求头 ​
字段类型必填默认枚举格式/限制业务含义/依赖示例
X-API-Keystring是；可用Bearer替代无无不放在URL或Body验证Key租户与归属<API_KEY>
路径参数 ​
字段类型必填默认枚举格式/限制业务含义/依赖示例
taskIdstring是无无—任务ID；来自上传返回taskIds。task_example
查询参数 ​
字段类型必填默认枚举格式/限制业务含义/依赖示例
enable_scoringboolean否保留原值无—本次重新处理是否评分；兼容enableScoring。false
请求示例 ​

执行示例前，替换服务地址、密钥、资源ID、时间和文件。

bash
curl --request POST "<API_BASE_URL>/api/v2/tasks/task_example/retry" \
  --header "X-API-Key: <API_KEY>"
成功响应 ​

HTTP 200

以下为成功响应示例。字段是否有值取决于任务状态、接口版本及资源可用性；业务字段名称由模板定义。

json
{
  "code": 200,
  "message": "success",
  "data": {
    "taskId": "task_example",
    "fileId": "task_example",
    "batchId": null,
    "status": "pending",
    "mode": "VisualExtract",
    "startPhase": "extracting",
    "createdNewTask": false
  }
}
响应字段 ​
字段类型必返枚举出现条件含义
codeinteger是—JSON成功响应文件、任务、模板和资产接口成功码为200；提醒规则为0，均为数字。
messagestring是—JSON成功响应英文系统结果说明，通常success。
dataobject是；可为null—按任务状态、版本及资源可用性；null不等于空内容或0。本接口的数据，结构见以下字段；无返回内容时为null。
data.taskIdstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。任务标识，后续查询使用。
data.fileIdstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。文件标识；业务任务中通常与taskId相同，样本文件则不同。
data.batchIdstring | null父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。一次上传的批次标识；历史任务可能为空。
data.statusstring父对象存在时；可选投影见条件按对象区分，见S1/S3父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。当前对象状态；任务、样本、会话与规则的枚举不同，见S1/S2/S3。
data.modestring父对象存在时；可选投影见条件VisualExtract / LayoutExtract父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。本次处理模式：VisualExtract或LayoutExtract。
data.startPhasestring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。处理阶段：parsing/classifying/extracting；无对应阶段时为空。
data.createdNewTaskboolean父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。是否创建新任务。任务重试返回false，并沿用原taskId。
接口特有说明 ​
  • 前置条件：任务存在且可访问，关联模板可用，并具有所需资源额度。已取消任务不可重试。
  • 副作用：复用原taskId/fileId，createdNewTask=false；加载最新已保存模板快照，清旧输出并重新排队。无retried状态。
  • 规则：S1, S4
适用错误 ​

E-AUTH, E-RESOURCE, E-INTERNAL, E-PARAM, E-QUOTA, E-STATE

后续调用 ​

6. 取消任务 ​

取消待处理或正在处理的任务。

请求 ​
项目内容
方法DELETE
地址<API_BASE_URL>/api/v2/tasks/
鉴权X-API-Key；本租户可访问/可管理资源
Content-Type无Body，无需Content-Type
请求头 ​
字段类型必填默认枚举格式/限制业务含义/依赖示例
X-API-Keystring是；可用Bearer替代无无不放在URL或Body验证Key租户与归属<API_KEY>
路径参数 ​
字段类型必填默认枚举格式/限制业务含义/依赖示例
taskIdstring是无无—任务ID；来自上传返回taskIds。task_example
请求示例 ​

执行示例前，替换服务地址、密钥、资源ID、时间和文件。

bash
curl --request DELETE "<API_BASE_URL>/api/v2/tasks/task_example" \
  --header "X-API-Key: <API_KEY>"
成功响应 ​

HTTP 200

以下为成功响应示例。字段是否有值取决于任务状态、接口版本及资源可用性；业务字段名称由模板定义。

json
{
  "code": 200,
  "message": "success",
  "data": null
}
响应字段 ​
字段类型必返枚举出现条件含义
codeinteger是—JSON成功响应文件、任务、模板和资产接口成功码为200；提醒规则为0，均为数字。
messagestring是—JSON成功响应英文系统结果说明，通常success。
datanull是；可为null—按任务状态、版本及资源可用性；null不等于空内容或0。本接口的数据，结构见以下字段；无返回内容时为null。
接口特有说明 ​
  • 前置条件：仅pending/processing可取消；并发状态改变可能拒绝。
  • 副作用：标记取消并释放未结算预占；不等同永久删除或退还已实扣用量。
  • 规则：S1, S4, S5
适用错误 ​

E-AUTH, E-RESOURCE, E-INTERNAL, E-PARAM, E-STATE

后续调用 ​

4.4 模板与文件处理 ​

7. 获取模板列表 ​

获取当前身份可使用的模板列表。

请求 ​
项目内容
方法GET
地址<API_BASE_URL>/api/v2/templates
鉴权X-API-Key；本租户可访问/可管理资源
Content-Type无Body，无需Content-Type
请求头 ​
字段类型必填默认枚举格式/限制业务含义/依赖示例
X-API-Keystring是；可用Bearer替代无无不放在URL或Body验证Key租户与归属<API_KEY>
查询参数 ​
字段类型必填默认枚举格式/限制业务含义/依赖示例
searchstring否不筛选无—按模板名称包含文字筛选。Invoice
statusstring否全部active启用；inactive停用—按模板启停筛选。active

嵌入输出配置结构及限制。id/status/owner等返回字段不是越权或启停控制参数。

请求示例 ​

执行示例前，替换服务地址、密钥、资源ID、时间和文件。

bash
curl --request GET "<API_BASE_URL>/api/v2/templates" \
  --header "X-API-Key: <API_KEY>"
成功响应 ​

HTTP 200

以下为成功响应示例。字段是否有值取决于任务状态、接口版本及资源可用性；业务字段名称由模板定义。

json
{
  "code": 200,
  "message": "success",
  "data": [
    {
      "keys": {
        "invoice_number": {
          "prompt": "Read the invoice number",
          "mapping": "invoice_number",
          "aliases": [
            "Invoice No."
          ]
        },
        "invoice_total": {
          "prompt": "Read total amount",
          "mapping": null,
          "aliases": []
        }
      },
      "name": "Invoice Template",
      "id": "template_example",
      "fileId": "sample_file_example",
      "enableScoring": false,
      "page": 1,
      "status": 1,
      "source": "organization",
      "editable": true,
      "statusEditable": true,
      "lifecycle": "published",
      "pinned": null,
      "groupTemplateId": "group_example",
      "ownerType": "tenant",
      "ownerUserId": null,
      "createdByUserId": "user_example",
      "usable": true,
      "manageable": true,
      "tableHeaders": {
        "Items": {
          "name": {
            "prompt": "Item name",
            "mapping": null,
            "aliases": []
          },
          "qty": {
            "prompt": "Quantity",
            "mapping": null,
            "aliases": []
          }
        }
      },
      "outputConfigs": null,
      "tableOutputConfigs": null,
      "elementOrder": [
        {
          "type": "key",
          "name": "invoice_number",
          "columnOrder": null
        },
        {
          "type": "key",
          "name": "invoice_total",
          "columnOrder": null
        },
        {
          "type": "table",
          "name": "Items",
          "columnOrder": [
            "name",
            "qty"
          ]
        }
      ]
    }
  ]
}
响应字段 ​
字段类型必返枚举出现条件含义
codeinteger是—JSON成功响应文件、任务、模板和资产接口成功码为200；提醒规则为0，均为数字。
messagestring是—JSON成功响应英文系统结果说明，通常success。
dataarray是；可为null—按任务状态、版本及资源可用性；null不等于空内容或0。本接口的数据，结构见以下字段；无返回内容时为null。
data[]object父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。该对象提供的业务扩展属性；保留原字段和类型，不视为新的接口。
data[].keysobject父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。普通字段或表格列的模板定义。
data[].keys.invoice_numberobject父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。示例模板的业务字段/列名；实际键由模板决定，值保持原JSON类型。
data[].keys.invoice_number.promptstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。字段抽取提示、显示映射名或别名列表。
data[].keys.invoice_number.mappingstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。字段抽取提示、显示映射名或别名列表。
data[].keys.invoice_number.aliasesarray父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。字段抽取提示、显示映射名或别名列表。
data[].keys.invoice_number.aliases[]string父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。字段抽取提示、显示映射名或别名列表。
data[].keys.invoice_totalobject父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。示例模板的业务字段/列名；实际键由模板决定，值保持原JSON类型。
data[].keys.invoice_total.promptstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。字段抽取提示、显示映射名或别名列表。
data[].keys.invoice_total.mappingstring | null父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。字段抽取提示、显示映射名或别名列表。
data[].keys.invoice_total.aliasesarray父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。字段抽取提示、显示映射名或别名列表。
data[].namestring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。对象或模板名称，业务内容保持原语言。
data[].idstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。当前对象的标识；样本items[].id用于删除样本，模板id用于选模板。
data[].fileIdstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。文件标识；业务任务中通常与taskId相同，样本文件则不同。
data[].enableScoringboolean父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。模板或任务评分选项；最终以任务实际设置为准。
data[].pageinteger父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。列表中page为页码；结果中为逻辑页号及页键，sourcePageKey保留原键。
data[].statusinteger父对象存在时；可选投影见条件按对象区分，见S1/S3父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。当前对象状态；任务、样本、会话与规则的枚举不同，见S1/S2/S3。
data[].sourcestring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。模板来源，例如default或organization。
data[].editableboolean父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。当前密钥身份对应的可编辑、可改状态、可使用或可管理标记。
data[].statusEditableboolean父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。当前密钥身份对应的可编辑、可改状态、可使用或可管理标记。
data[].lifecyclestring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。模板生命周期，例如published；草稿不作为正常抽取模板选择。
data[].pinnedboolean | null父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。当前用户固定状态；服务密钥上下文可为空。
data[].groupTemplateIdstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。模板分组关联标识，不等同templateId。
data[].ownerTypestring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。模板归属类型及用户/创建者标识；不能通过提交这些响应字段指定权限。
data[].ownerUserIdstring | null父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。模板归属类型及用户/创建者标识；不能通过提交这些响应字段指定权限。
data[].createdByUserIdstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。模板归属类型及用户/创建者标识；不能通过提交这些响应字段指定权限。
data[].usableboolean父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。当前密钥身份对应的可编辑、可改状态、可使用或可管理标记。
data[].manageableboolean父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。当前密钥身份对应的可编辑、可改状态、可使用或可管理标记。
data[].tableHeadersobject父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。普通字段或表格列的模板定义。
data[].tableHeaders.Itemsobject父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。示例模板的业务字段/列名；实际键由模板决定，值保持原JSON类型。
data[].tableHeaders.Items.nameobject父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。对象或模板名称，业务内容保持原语言。
data[].tableHeaders.Items.name.promptstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。字段抽取提示、显示映射名或别名列表。
data[].tableHeaders.Items.name.mappingstring | null父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。字段抽取提示、显示映射名或别名列表。
data[].tableHeaders.Items.name.aliasesarray父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。字段抽取提示、显示映射名或别名列表。
data[].tableHeaders.Items.qtyobject父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。示例模板的业务字段/列名；实际键由模板决定，值保持原JSON类型。
data[].tableHeaders.Items.qty.promptstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。字段抽取提示、显示映射名或别名列表。
data[].tableHeaders.Items.qty.mappingstring | null父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。字段抽取提示、显示映射名或别名列表。
data[].tableHeaders.Items.qty.aliasesarray父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。字段抽取提示、显示映射名或别名列表。
data[].outputConfigsobject | null父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。模板对象中的字段或表格列输出配置。独立输出配置记录通过对应管理功能维护。
data[].tableOutputConfigsobject | null父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。模板对象中的字段或表格列输出配置。独立输出配置记录通过对应管理功能维护。
data[].elementOrderarray父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。模板显示顺序：type为key/table，name对应字段/表名，columnOrder指定列顺序。
data[].elementOrder[]object父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。模板显示顺序：type为key/table，name对应字段/表名，columnOrder指定列顺序。
data[].elementOrder[].typestring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。模板显示顺序：type为key/table，name对应字段/表名，columnOrder指定列顺序。
data[].elementOrder[].namestring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。对象或模板名称，业务内容保持原语言。
data[].elementOrder[].columnOrderarray | null父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。模板显示顺序：type为key/table，name对应字段/表名，columnOrder指定列顺序。
data[].elementOrder[].columnOrder[]string父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。模板显示顺序：type为key/table，name对应字段/表名，columnOrder指定列顺序。
接口特有说明 ​
  • 前置条件：名称包含筛选search；状态active/inactive；无分页。
  • 副作用：可返回系统默认模板，usable不等于manageable；不由客户端指定owner字段越权。
  • 规则：S3
适用错误 ​

E-AUTH, E-RESOURCE, E-INTERNAL

后续调用 ​

8. 获取模板字段 ​

获取模板普通字段、表格列及显示顺序。

请求 ​
项目内容
方法GET
地址<API_BASE_URL>/api/v2/templates/{id}/fields
鉴权X-API-Key；本租户可访问/可管理资源
Content-Type无Body，无需Content-Type
请求头 ​
字段类型必填默认枚举格式/限制业务含义/依赖示例
X-API-Keystring是；可用Bearer替代无无不放在URL或Body验证Key租户与归属<API_KEY>
路径参数 ​
字段类型必填默认枚举格式/限制业务含义/依赖示例
idstring是无无—模板ID；不是样本ID。template_example
请求示例 ​

执行示例前，替换服务地址、密钥、资源ID、时间和文件。

bash
curl --request GET "<API_BASE_URL>/api/v2/templates/template_example/fields" \
  --header "X-API-Key: <API_KEY>"
成功响应 ​

HTTP 200

以下为成功响应示例。字段是否有值取决于任务状态、接口版本及资源可用性；业务字段名称由模板定义。

json
{
  "code": 200,
  "message": "success",
  "data": {
    "keys": {
      "invoice_number": {
        "prompt": "Read the invoice number",
        "mapping": "invoice_number",
        "aliases": [
          "Invoice No."
        ]
      },
      "invoice_total": {
        "prompt": "Read total amount",
        "mapping": null,
        "aliases": []
      }
    },
    "tableHeaders": {
      "Items": {
        "name": {
          "prompt": "Item name",
          "mapping": null,
          "aliases": []
        },
        "qty": {
          "prompt": "Quantity",
          "mapping": null,
          "aliases": []
        }
      }
    },
    "elementOrder": [
      {
        "type": "key",
        "name": "invoice_number",
        "columnOrder": null
      },
      {
        "type": "key",
        "name": "invoice_total",
        "columnOrder": null
      },
      {
        "type": "table",
        "name": "Items",
        "columnOrder": [
          "name",
          "qty"
        ]
      }
    ]
  }
}
响应字段 ​
字段类型必返枚举出现条件含义
codeinteger是—JSON成功响应文件、任务、模板和资产接口成功码为200；提醒规则为0，均为数字。
messagestring是—JSON成功响应英文系统结果说明，通常success。
dataobject是；可为null—按任务状态、版本及资源可用性；null不等于空内容或0。本接口的数据，结构见以下字段；无返回内容时为null。
data.keysobject父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。普通字段或表格列的模板定义。
data.keys.invoice_numberobject父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。示例模板的业务字段/列名；实际键由模板决定，值保持原JSON类型。
data.keys.invoice_number.promptstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。字段抽取提示、显示映射名或别名列表。
data.keys.invoice_number.mappingstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。字段抽取提示、显示映射名或别名列表。
data.keys.invoice_number.aliasesarray父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。字段抽取提示、显示映射名或别名列表。
data.keys.invoice_number.aliases[]string父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。字段抽取提示、显示映射名或别名列表。
data.keys.invoice_totalobject父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。示例模板的业务字段/列名；实际键由模板决定，值保持原JSON类型。
data.keys.invoice_total.promptstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。字段抽取提示、显示映射名或别名列表。
data.keys.invoice_total.mappingstring | null父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。字段抽取提示、显示映射名或别名列表。
data.keys.invoice_total.aliasesarray父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。字段抽取提示、显示映射名或别名列表。
data.tableHeadersobject父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。普通字段或表格列的模板定义。
data.tableHeaders.Itemsobject父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。示例模板的业务字段/列名；实际键由模板决定，值保持原JSON类型。
data.tableHeaders.Items.nameobject父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。对象或模板名称，业务内容保持原语言。
data.tableHeaders.Items.name.promptstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。字段抽取提示、显示映射名或别名列表。
data.tableHeaders.Items.name.mappingstring | null父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。字段抽取提示、显示映射名或别名列表。
data.tableHeaders.Items.name.aliasesarray父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。字段抽取提示、显示映射名或别名列表。
data.tableHeaders.Items.qtyobject父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。示例模板的业务字段/列名；实际键由模板决定，值保持原JSON类型。
data.tableHeaders.Items.qty.promptstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。字段抽取提示、显示映射名或别名列表。
data.tableHeaders.Items.qty.mappingstring | null父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。字段抽取提示、显示映射名或别名列表。
data.tableHeaders.Items.qty.aliasesarray父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。字段抽取提示、显示映射名或别名列表。
data.elementOrderarray父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。模板显示顺序：type为key/table，name对应字段/表名，columnOrder指定列顺序。
data.elementOrder[]object父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。模板显示顺序：type为key/table，name对应字段/表名，columnOrder指定列顺序。
data.elementOrder[].typestring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。模板显示顺序：type为key/table，name对应字段/表名，columnOrder指定列顺序。
data.elementOrder[].namestring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。对象或模板名称，业务内容保持原语言。
data.elementOrder[].columnOrderarray | null父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。模板显示顺序：type为key/table，name对应字段/表名，columnOrder指定列顺序。
data.elementOrder[].columnOrder[]string父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。模板显示顺序：type为key/table，name对应字段/表名，columnOrder指定列顺序。
接口特有说明 ​
  • 前置条件：模板须可访问。
  • 副作用：字段名用于上传模板定义和修改结果，不随意替换为显示名称。
  • 规则：S3
适用错误 ​

E-AUTH, E-RESOURCE, E-INTERNAL

后续调用 ​

9. 创建模板 ​

使用已上传初始样本创建模板。

请求 ​
项目内容
方法POST
地址<API_BASE_URL>/api/v2/templates
鉴权X-API-Key；本租户可访问/可管理资源
Content-Typeapplication/json
请求头 ​
字段类型必填默认枚举格式/限制业务含义/依赖示例
X-API-Keystring是；可用Bearer替代无无不放在URL或Body验证Key租户与归属<API_KEY>
JSON请求体 ​
字段类型必填默认枚举格式/限制业务含义/依赖示例
namestring创建必填；更新应传完整定义无无—模板名称，不可为空。Invoice Template
fileIdstring创建必填；更新由服务保留无无—创建前上传样本返回的sampleFileId；兼容file_id。sample_file_example
keysobject与tableHeaders至少一项非空无无—普通字段名到字段定义的映射。{"invoice_number": {"prompt": "Read the invoice number"}}
tableHeadersobject与keys至少一项非空无无—表名→列名→字段定义；名称由调用方模板决定。{"Items": {"qty": {"prompt": "Quantity"}}}
keys.<name>.prompt / tableHeaders.<table>.<column>.promptstring否无无—描述需要从文档中提取的字段内容。Read the invoice number
keys.<name>.mapping / tableHeaders.<table>.<column>.mappingstring否原字段名无—字段的显示或映射名称。invoice_number
keys.<name>.aliases / tableHeaders.<table>.<column>.aliasesarray<string>否[]无—同一字段的其他识别名称。["Invoice No."]
pageinteger否无无—样本的选定页，通常从1开始；保持有效页面。1
enableScoringboolean否无无—模板评分设置；上传任务可独立覆盖。兼容enable_scoring。false
elementOrderarray<object>否无无—普通字段和表格的显示顺序。[{"type": "key", "name": "invoice_number"}]
elementOrder[].typestring是无key / table—key为普通字段，table为表格。key
elementOrder[].namestring是无无—必须对应keys或tableHeaders中的名称。invoice_number
elementOrder[].columnOrderarray<string>否无无—表格列顺序，名称须存在于该表。["name", "qty"]
outputConfigs / tableOutputConfigsobject否无无—模板中的兼容输出配置数据。创建和更新模板时，独立输出配置记录保持不变。null

嵌入输出配置结构及限制。id/status/owner等返回字段不是越权或启停控制参数。

请求示例 ​

执行示例前，替换服务地址、密钥、资源ID、时间和文件。

bash
curl --request POST "<API_BASE_URL>/api/v2/templates" \
  --header "X-API-Key: <API_KEY>" \
  --header "Content-Type: application/json" \
  --data-raw '{
  "name": "Invoice Template",
  "fileId": "sample_file_example",
  "page": 1,
  "enableScoring": false,
  "keys": {
    "invoice_number": {
      "prompt": "Read the invoice number",
      "mapping": "invoice_number",
      "aliases": [
        "Invoice No."
      ]
    },
    "invoice_total": {
      "prompt": "Read the total invoice amount"
    }
  },
  "tableHeaders": {
    "Items": {
      "name": {
        "prompt": "Item name"
      },
      "qty": {
        "prompt": "Quantity"
      }
    }
  },
  "elementOrder": [
    {
      "type": "key",
      "name": "invoice_number"
    },
    {
      "type": "key",
      "name": "invoice_total"
    },
    {
      "type": "table",
      "name": "Items",
      "columnOrder": [
        "name",
        "qty"
      ]
    }
  ]
}'

纯JSON Body：

json
{
  "name": "Invoice Template",
  "fileId": "sample_file_example",
  "page": 1,
  "enableScoring": false,
  "keys": {
    "invoice_number": {
      "prompt": "Read the invoice number",
      "mapping": "invoice_number",
      "aliases": [
        "Invoice No."
      ]
    },
    "invoice_total": {
      "prompt": "Read the total invoice amount"
    }
  },
  "tableHeaders": {
    "Items": {
      "name": {
        "prompt": "Item name"
      },
      "qty": {
        "prompt": "Quantity"
      }
    }
  },
  "elementOrder": [
    {
      "type": "key",
      "name": "invoice_number"
    },
    {
      "type": "key",
      "name": "invoice_total"
    },
    {
      "type": "table",
      "name": "Items",
      "columnOrder": [
        "name",
        "qty"
      ]
    }
  ]
}
成功响应 ​

HTTP 200

以下为成功响应示例。字段是否有值取决于任务状态、接口版本及资源可用性；业务字段名称由模板定义。

json
{
  "code": 200,
  "message": "success",
  "data": "template_example"
}
响应字段 ​
字段类型必返枚举出现条件含义
codeinteger是—JSON成功响应文件、任务、模板和资产接口成功码为200；提醒规则为0，均为数字。
messagestring是—JSON成功响应英文系统结果说明，通常success。
datastring是；可为null—按任务状态、版本及资源可用性；null不等于空内容或0。本接口的数据，结构见以下字段；无返回内容时为null。
接口特有说明 ​
  • 前置条件：name、fileId，以及keys/tableHeaders至少一项非空；样本须属于当前组织。
  • 副作用：创建后data直接是模板ID字符串。创建模板本身不是一次业务文件抽取。
  • 规则：S3, S4
适用错误 ​

E-AUTH, E-RESOURCE, E-INTERNAL, E-PARAM, E-QUOTA

后续调用 ​

嵌入输出配置对象 ​

模板对象可包含以下输出配置字段。创建和更新模板时，独立输出配置记录保持不变。

字段类型默认说明
outputTypestringTextText/Number/Date/Enum
exportFieldNamestring|null原字段名导出名，不是字段提取提示
pageConsistencystringunknownunknown不检查；consistent期待相同；inconsistent期待不同；仅Visual评分
conversionobject{}数字货币/千位/精度，文本空白/替换/正则，日期outputFormat，枚举mapping；选项按类型解释
validation.requiredbooleanfalse值不可为空，不是HTTP必填规则
validation.regexstring|nullnullJava正则格式校验
validation.comparison / comparisonValuestring|nullnullgt/gte/eq/lt/lte; 比较值为文本
validation.failureStrategy / defaultValuestring|nullmark_exceptionmark_exception标记异常；default_value使用默认值

10. 更新模板 ​

保存模板完整定义。

请求 ​
项目内容
方法PUT
地址<API_BASE_URL>/api/v2/templates/
鉴权X-API-Key；本租户可访问/可管理资源
Content-Typeapplication/json
请求头 ​
字段类型必填默认枚举格式/限制业务含义/依赖示例
X-API-Keystring是；可用Bearer替代无无不放在URL或Body验证Key租户与归属<API_KEY>
路径参数 ​
字段类型必填默认枚举格式/限制业务含义/依赖示例
idstring是无无—模板ID；不是样本ID。template_example
JSON请求体 ​
字段类型必填默认枚举格式/限制业务含义/依赖示例
namestring创建必填；更新应传完整定义无无—模板名称，不可为空。Invoice Template
fileIdstring创建必填；更新由服务保留无无—创建前上传样本返回的sampleFileId；兼容file_id。sample_file_example
keysobject与tableHeaders至少一项非空无无—普通字段名到字段定义的映射。{"invoice_number": {"prompt": "Read the invoice number"}}
tableHeadersobject与keys至少一项非空无无—表名→列名→字段定义；名称由调用方模板决定。{"Items": {"qty": {"prompt": "Quantity"}}}
keys.<name>.prompt / tableHeaders.<table>.<column>.promptstring否无无—描述需要从文档中提取的字段内容。Read the invoice number
keys.<name>.mapping / tableHeaders.<table>.<column>.mappingstring否原字段名无—字段的显示或映射名称。invoice_number
keys.<name>.aliases / tableHeaders.<table>.<column>.aliasesarray<string>否[]无—同一字段的其他识别名称。["Invoice No."]
pageinteger否无无—样本的选定页，通常从1开始；保持有效页面。1
enableScoringboolean否无无—模板评分设置；上传任务可独立覆盖。兼容enable_scoring。false
elementOrderarray<object>否无无—普通字段和表格的显示顺序。[{"type": "key", "name": "invoice_number"}]
elementOrder[].typestring是无key / table—key为普通字段，table为表格。key
elementOrder[].namestring是无无—必须对应keys或tableHeaders中的名称。invoice_number
elementOrder[].columnOrderarray<string>否无无—表格列顺序，名称须存在于该表。["name", "qty"]
outputConfigs / tableOutputConfigsobject否无无—模板中的兼容输出配置数据。创建和更新模板时，独立输出配置记录保持不变。null

嵌入输出配置结构及限制。id/status/owner等返回字段不是越权或启停控制参数。

请求示例 ​

执行示例前，替换服务地址、密钥、资源ID、时间和文件。

bash
curl --request PUT "<API_BASE_URL>/api/v2/templates/template_example" \
  --header "X-API-Key: <API_KEY>" \
  --header "Content-Type: application/json" \
  --data-raw '{
  "name": "Invoice Template",
  "fileId": "sample_file_example",
  "page": 1,
  "enableScoring": false,
  "keys": {
    "invoice_number": {
      "prompt": "Read the invoice number",
      "mapping": "invoice_number",
      "aliases": [
        "Invoice No."
      ]
    },
    "invoice_total": {
      "prompt": "Read the total invoice amount"
    }
  },
  "tableHeaders": {
    "Items": {
      "name": {
        "prompt": "Item name"
      },
      "qty": {
        "prompt": "Quantity"
      }
    }
  },
  "elementOrder": [
    {
      "type": "key",
      "name": "invoice_number"
    },
    {
      "type": "key",
      "name": "invoice_total"
    },
    {
      "type": "table",
      "name": "Items",
      "columnOrder": [
        "name",
        "qty"
      ]
    }
  ]
}'

纯JSON Body：

json
{
  "name": "Invoice Template",
  "fileId": "sample_file_example",
  "page": 1,
  "enableScoring": false,
  "keys": {
    "invoice_number": {
      "prompt": "Read the invoice number",
      "mapping": "invoice_number",
      "aliases": [
        "Invoice No."
      ]
    },
    "invoice_total": {
      "prompt": "Read the total invoice amount"
    }
  },
  "tableHeaders": {
    "Items": {
      "name": {
        "prompt": "Item name"
      },
      "qty": {
        "prompt": "Quantity"
      }
    }
  },
  "elementOrder": [
    {
      "type": "key",
      "name": "invoice_number"
    },
    {
      "type": "key",
      "name": "invoice_total"
    },
    {
      "type": "table",
      "name": "Items",
      "columnOrder": [
        "name",
        "qty"
      ]
    }
  ]
}
成功响应 ​

HTTP 200

以下为成功响应示例。字段是否有值取决于任务状态、接口版本及资源可用性；业务字段名称由模板定义。

json
{
  "code": 200,
  "message": "success",
  "data": null
}
响应字段 ​
字段类型必返枚举出现条件含义
codeinteger是—JSON成功响应文件、任务、模板和资产接口成功码为200；提醒规则为0，均为数字。
messagestring是—JSON成功响应英文系统结果说明，通常success。
datanull是；可为null—按任务状态、版本及资源可用性；null不等于空内容或0。本接口的数据，结构见以下字段；无返回内容时为null。
接口特有说明 ​
  • 前置条件：可管理模板；先保留原定义再修改；路径ID为准，原fileId由服务保留。
  • 副作用：不是任意属性的PATCH；保存不改变历史结果，显式重试才读取新保存版本。
  • 规则：S3
适用错误 ​

E-AUTH, E-RESOURCE, E-INTERNAL, E-PARAM

后续调用 ​

11. 删除模板 ​

删除当前身份可管理的模板。

请求 ​
项目内容
方法DELETE
地址<API_BASE_URL>/api/v2/templates/
鉴权X-API-Key；本租户可访问/可管理资源
Content-Type无Body，无需Content-Type
请求头 ​
字段类型必填默认枚举格式/限制业务含义/依赖示例
X-API-Keystring是；可用Bearer替代无无不放在URL或Body验证Key租户与归属<API_KEY>
路径参数 ​
字段类型必填默认枚举格式/限制业务含义/依赖示例
idstring是无无—模板ID；不是样本ID。template_example
请求示例 ​

执行示例前，替换服务地址、密钥、资源ID、时间和文件。

bash
curl --request DELETE "<API_BASE_URL>/api/v2/templates/template_example" \
  --header "X-API-Key: <API_KEY>"
成功响应 ​

HTTP 200

以下为成功响应示例。字段是否有值取决于任务状态、接口版本及资源可用性；业务字段名称由模板定义。

json
{
  "code": 200,
  "message": "success",
  "data": null
}
响应字段 ​
字段类型必返枚举出现条件含义
codeinteger是—JSON成功响应文件、任务、模板和资产接口成功码为200；提醒规则为0，均为数字。
messagestring是—JSON成功响应英文系统结果说明，通常success。
datanull是；可为null—按任务状态、版本及资源可用性；null不等于空内容或0。本接口的数据，结构见以下字段；无返回内容时为null。
接口特有说明 ​
  • 前置条件：当前API Key具有目标模板的管理权限。
  • 副作用：逻辑状态变更并标记分类清理；后台清理可异步，不退还历史处理用量。
  • 规则：S3, S4, S5
适用错误 ​

E-AUTH, E-RESOURCE, E-INTERNAL, E-PARAM

后续调用 ​

12. 上传创建模板前的样本 ​

在创建模板前上传初始样本文件。

请求 ​
项目内容
方法POST
地址<API_BASE_URL>/api/v2/templates/samples
鉴权X-API-Key；本租户可访问/可管理资源
Content-Typemultipart/form-data
请求头 ​
字段类型必填默认枚举格式/限制业务含义/依赖示例
X-API-Keystring是；可用Bearer替代无无不放在URL或Body验证Key租户与归属<API_KEY>
表单参数 ​
字段类型必填默认枚举格式/限制业务含义/依赖示例
filebinary是无无单次上传一个非空文档文件。一个非空样本文件；使用File字段。@sample.pdf
请求示例 ​

执行示例前，替换服务地址、密钥、资源ID、时间和文件。

bash
curl --request POST "<API_BASE_URL>/api/v2/templates/samples" \
  --header "X-API-Key: <API_KEY>" \
  --form "[email protected]"
成功响应 ​

HTTP 200

以下为成功响应示例。字段是否有值取决于任务状态、接口版本及资源可用性；业务字段名称由模板定义。

json
{
  "code": 200,
  "message": "success",
  "data": {
    "sampleFileId": "sample_file_example",
    "fileName": "sample.pdf",
    "fileSize": 102400
  }
}
响应字段 ​
字段类型必返枚举出现条件含义
codeinteger是—JSON成功响应文件、任务、模板和资产接口成功码为200；提醒规则为0，均为数字。
messagestring是—JSON成功响应英文系统结果说明，通常success。
dataobject是；可为null—按任务状态、版本及资源可用性；null不等于空内容或0。本接口的数据，结构见以下字段；无返回内容时为null。
data.sampleFileIdstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。创建模板前上传所得的底层样本文件标识。
data.fileNamestring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。文件名；sourceFileName为原始来源名。
data.fileSizeinteger父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。文件字节数；旧样本未知时可为空，不是MB。
接口特有说明 ​
  • 前置条件：非空文件，当前Key许可和容量状态允许操作。
  • 副作用：只返回sampleFileId，不是业务任务或已有模板的多样本追加。
  • 规则：S3, S4
适用错误 ​

E-AUTH, E-RESOURCE, E-INTERNAL, E-PARAM, E-QUOTA, E-FORMAT

后续调用 ​

13. 上传/替换模板样本 ​

给已有模板追加一份样本，或替换全部关联样本。

请求 ​
项目内容
方法POST
地址<API_BASE_URL>/api/v2/templates/{templateId}/samples
鉴权X-API-Key；本租户可访问/可管理资源
Content-Typemultipart/form-data
请求头 ​
字段类型必填默认枚举格式/限制业务含义/依赖示例
X-API-Keystring是；可用Bearer替代无无不放在URL或Body验证Key租户与归属<API_KEY>
路径参数 ​
字段类型必填默认枚举格式/限制业务含义/依赖示例
templateIdstring是无无—模板ID；来自模板列表或创建返回值。template_example
表单参数 ​
字段类型必填默认枚举格式/限制业务含义/依赖示例
filebinary是无无单次上传一个非空文档文件。一个非空样本文件；使用File字段。@sample.pdf
replace_allboolean否falsetrue / false—false追加；true用新样本替换全部现有关联。false
请求示例 ​

执行示例前，替换服务地址、密钥、资源ID、时间和文件。

bash
curl --request POST "<API_BASE_URL>/api/v2/templates/template_example/samples" \
  --header "X-API-Key: <API_KEY>" \
  --form "[email protected]" \
  --form "replace_all=false"
成功响应 ​

HTTP 200

以下为成功响应示例。字段是否有值取决于任务状态、接口版本及资源可用性；业务字段名称由模板定义。

json
{
  "code": 200,
  "message": "success",
  "data": {
    "templateId": "template_example",
    "page": 1,
    "pageSize": 20,
    "total": 1,
    "count": 1,
    "limit": 5,
    "items": [
      {
        "id": "sample_example",
        "fileId": "sample_file_example",
        "fileName": "sample.pdf",
        "fileSize": 102400,
        "status": "processing",
        "profileRevision": "revision_example",
        "failureReason": null,
        "fileType": "pdf",
        "uploadedAt": "2026-10-23T08:00:00"
      }
    ],
    "profile": {
      "activeRevision": "revision_example",
      "pendingRevision": "revision_next",
      "status": "processing",
      "failureReason": null,
      "classificationPrompt": null,
      "scoringConfig": null
    },
    "classificationNeedsSave": true,
    "deletedSampleId": null
  }
}
响应字段 ​
字段类型必返枚举出现条件含义
codeinteger是—JSON成功响应文件、任务、模板和资产接口成功码为200；提醒规则为0，均为数字。
messagestring是—JSON成功响应英文系统结果说明，通常success。
dataobject是；可为null—按任务状态、版本及资源可用性；null不等于空内容或0。本接口的数据，结构见以下字段；无返回内容时为null。
data.templateIdstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。关联模板标识；自动分类完成前可能为空。
data.pageinteger父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。列表中page为页码；结果中为逻辑页号及页键，sourcePageKey保留原键。
data.pageSizeinteger父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。实际样本分页大小，来自请求page_size。
data.totalinteger父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。样本页面中为总关联样本数，不是当前页条数；资产中total为额度总量。
data.countinteger父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。样本页面中为总关联样本数，不是当前页条数；资产中total为额度总量。
data.limitinteger父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。每模板最多5份样本。
data.itemsarray父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。当前页样本条目。
data.items[]object父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。当前页样本条目。
data.items[].idstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。当前对象的标识；样本items[].id用于删除样本，模板id用于选模板。
data.items[].fileIdstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。文件标识；业务任务中通常与taskId相同，样本文件则不同。
data.items[].fileNamestring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。文件名；sourceFileName为原始来源名。
data.items[].fileSizeinteger父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。文件字节数；旧样本未知时可为空，不是MB。
data.items[].statusstring父对象存在时；可选投影见条件按对象区分，见S1/S3父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。当前对象状态；任务、样本、会话与规则的枚举不同，见S1/S2/S3。
data.items[].profileRevisionstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。当前生效、待构建或样本所属的画像版本；无对应版本时为空。
data.items[].failureReasonstring | null父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。失败信息；非失败状态通常为空。使用稳定错误码/阶段，不解析文案判状态。
data.items[].fileTypestring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。文件扩展类型或MIME内容类型，按字段名称区分。
data.items[].uploadedAtstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。Java本地日期时间字符串，无显式时区偏移；未知/尚未完成可为空。updateDate用于精确版本比较。
data.profileobject父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。当前模板分类画像的状态和版本。
data.profile.activeRevisionstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。当前生效、待构建或样本所属的画像版本；无对应版本时为空。
data.profile.pendingRevisionstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。当前生效、待构建或样本所属的画像版本；无对应版本时为空。
data.profile.statusstring父对象存在时；可选投影见条件按对象区分，见S1/S3父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。当前对象状态；任务、样本、会话与规则的枚举不同，见S1/S2/S3。
data.profile.failureReasonstring | null父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。失败信息；非失败状态通常为空。使用稳定错误码/阶段，不解析文案判状态。
data.profile.classificationPromptstring | null父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。画像的分类提示信息，未生成时可为空。
data.profile.scoringConfigobject | null父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。画像评分配置数据；结构依生成结果而定。
data.classificationNeedsSaveboolean父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。服务报告是否仍有需要保存的分类/样本改动；以实际值为准。
data.deletedSampleIdstring | null父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。已删除的样本关联ID；其他操作返回null。
接口特有说明 ​
  • 前置条件：单次一份非空文件，最多5份；replace_all=true可用一份替换已有5份。
  • 副作用：提交样本后异步更新分类画像。通过profile及classificationNeedsSave查看处理和保存状态。
  • 规则：S3, S4
适用错误 ​

E-AUTH, E-RESOURCE, E-INTERNAL, E-PARAM, E-QUOTA, E-SAMPLE, E-FORMAT

后续调用 ​

14. 获取模板样本列表 ​

分页查询模板样本及画像状态。

请求 ​
项目内容
方法GET
地址<API_BASE_URL>/api/v2/templates/{templateId}/samples
鉴权X-API-Key；本租户可访问/可管理资源
Content-Type无Body，无需Content-Type
请求头 ​
字段类型必填默认枚举格式/限制业务含义/依赖示例
X-API-Keystring是；可用Bearer替代无无不放在URL或Body验证Key租户与归属<API_KEY>
路径参数 ​
字段类型必填默认枚举格式/限制业务含义/依赖示例
templateIdstring是无无—模板ID；来自模板列表或创建返回值。template_example
查询参数 ​
字段类型必填默认枚举格式/限制业务含义/依赖示例
pageinteger否1无>=1页码，从1开始。1
page_sizeinteger否20无1–100每页条数。20
请求示例 ​

执行示例前，替换服务地址、密钥、资源ID、时间和文件。

bash
curl --request GET "<API_BASE_URL>/api/v2/templates/template_example/samples" \
  --header "X-API-Key: <API_KEY>"
成功响应 ​

HTTP 200

以下为成功响应示例。字段是否有值取决于任务状态、接口版本及资源可用性；业务字段名称由模板定义。

json
{
  "code": 200,
  "message": "success",
  "data": {
    "templateId": "template_example",
    "page": 1,
    "pageSize": 20,
    "total": 1,
    "count": 1,
    "limit": 5,
    "items": [
      {
        "id": "sample_example",
        "fileId": "sample_file_example",
        "fileName": "sample.pdf",
        "fileSize": 102400,
        "status": "active",
        "profileRevision": "revision_example",
        "failureReason": null,
        "fileType": "pdf",
        "uploadedAt": "2026-10-23T08:00:00"
      }
    ],
    "profile": {
      "activeRevision": "revision_example",
      "pendingRevision": null,
      "status": "active",
      "failureReason": null,
      "classificationPrompt": null,
      "scoringConfig": null
    },
    "classificationNeedsSave": false,
    "deletedSampleId": null
  }
}
响应字段 ​
字段类型必返枚举出现条件含义
codeinteger是—JSON成功响应文件、任务、模板和资产接口成功码为200；提醒规则为0，均为数字。
messagestring是—JSON成功响应英文系统结果说明，通常success。
dataobject是；可为null—按任务状态、版本及资源可用性；null不等于空内容或0。本接口的数据，结构见以下字段；无返回内容时为null。
data.templateIdstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。关联模板标识；自动分类完成前可能为空。
data.pageinteger父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。列表中page为页码；结果中为逻辑页号及页键，sourcePageKey保留原键。
data.pageSizeinteger父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。实际样本分页大小，来自请求page_size。
data.totalinteger父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。样本页面中为总关联样本数，不是当前页条数；资产中total为额度总量。
data.countinteger父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。样本页面中为总关联样本数，不是当前页条数；资产中total为额度总量。
data.limitinteger父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。每模板最多5份样本。
data.itemsarray父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。当前页样本条目。
data.items[]object父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。当前页样本条目。
data.items[].idstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。当前对象的标识；样本items[].id用于删除样本，模板id用于选模板。
data.items[].fileIdstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。文件标识；业务任务中通常与taskId相同，样本文件则不同。
data.items[].fileNamestring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。文件名；sourceFileName为原始来源名。
data.items[].fileSizeinteger父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。文件字节数；旧样本未知时可为空，不是MB。
data.items[].statusstring父对象存在时；可选投影见条件按对象区分，见S1/S3父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。当前对象状态；任务、样本、会话与规则的枚举不同，见S1/S2/S3。
data.items[].profileRevisionstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。当前生效、待构建或样本所属的画像版本；无对应版本时为空。
data.items[].failureReasonstring | null父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。失败信息；非失败状态通常为空。使用稳定错误码/阶段，不解析文案判状态。
data.items[].fileTypestring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。文件扩展类型或MIME内容类型，按字段名称区分。
data.items[].uploadedAtstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。Java本地日期时间字符串，无显式时区偏移；未知/尚未完成可为空。updateDate用于精确版本比较。
data.profileobject父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。当前模板分类画像的状态和版本。
data.profile.activeRevisionstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。当前生效、待构建或样本所属的画像版本；无对应版本时为空。
data.profile.pendingRevisionstring | null父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。当前生效、待构建或样本所属的画像版本；无对应版本时为空。
data.profile.statusstring父对象存在时；可选投影见条件按对象区分，见S1/S3父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。当前对象状态；任务、样本、会话与规则的枚举不同，见S1/S2/S3。
data.profile.failureReasonstring | null父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。失败信息；非失败状态通常为空。使用稳定错误码/阶段，不解析文案判状态。
data.profile.classificationPromptstring | null父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。画像的分类提示信息，未生成时可为空。
data.profile.scoringConfigobject | null父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。画像评分配置数据；结构依生成结果而定。
data.classificationNeedsSaveboolean父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。服务报告是否仍有需要保存的分类/样本改动；以实际值为准。
data.deletedSampleIdstring | null父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。已删除的样本关联ID；其他操作返回null。
接口特有说明 ​
  • 前置条件：page>=1，page_size=1–100；模板可访问。
  • 副作用：total/count为总关联数；items是当前页。删除使用items[].id，不是fileId。
  • 规则：S3
适用错误 ​

E-AUTH, E-RESOURCE, E-INTERNAL

后续调用 ​

15. 删除模板样本 ​

删除模板的一份样本关联。

请求 ​
项目内容
方法DELETE
地址<API_BASE_URL>/api/v2/templates/{templateId}/samples/
鉴权X-API-Key；本租户可访问/可管理资源
Content-Type无Body，无需Content-Type
请求头 ​
字段类型必填默认枚举格式/限制业务含义/依赖示例
X-API-Keystring是；可用Bearer替代无无不放在URL或Body验证Key租户与归属<API_KEY>
路径参数 ​
字段类型必填默认枚举格式/限制业务含义/依赖示例
templateIdstring是无无—模板ID；来自模板列表或创建返回值。template_example
sampleIdstring是无无—样本列表items[].id，不是fileId。sample_example
请求示例 ​

执行示例前，替换服务地址、密钥、资源ID、时间和文件。

bash
curl --request DELETE "<API_BASE_URL>/api/v2/templates/template_example/samples/sample_example" \
  --header "X-API-Key: <API_KEY>"
成功响应 ​

HTTP 200

以下为成功响应示例。字段是否有值取决于任务状态、接口版本及资源可用性；业务字段名称由模板定义。

json
{
  "code": 200,
  "message": "success",
  "data": {
    "templateId": "template_example",
    "page": 1,
    "pageSize": 20,
    "total": 1,
    "count": 1,
    "limit": 5,
    "items": [
      {
        "id": "remaining_sample_example",
        "fileId": "remaining_sample_file_example",
        "fileName": "remaining-sample.pdf",
        "fileSize": 102400,
        "status": "active",
        "profileRevision": "revision_example",
        "failureReason": null,
        "fileType": "pdf",
        "uploadedAt": "2026-10-23T08:00:00"
      }
    ],
    "profile": {
      "activeRevision": "revision_example",
      "pendingRevision": null,
      "status": "active",
      "failureReason": null,
      "classificationPrompt": null,
      "scoringConfig": null
    },
    "classificationNeedsSave": false,
    "deletedSampleId": "sample_example"
  }
}
响应字段 ​
字段类型必返枚举出现条件含义
codeinteger是—JSON成功响应文件、任务、模板和资产接口成功码为200；提醒规则为0，均为数字。
messagestring是—JSON成功响应英文系统结果说明，通常success。
dataobject是；可为null—按任务状态、版本及资源可用性；null不等于空内容或0。本接口的数据，结构见以下字段；无返回内容时为null。
data.templateIdstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。关联模板标识；自动分类完成前可能为空。
data.pageinteger父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。列表中page为页码；结果中为逻辑页号及页键，sourcePageKey保留原键。
data.pageSizeinteger父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。实际样本分页大小，来自请求page_size。
data.totalinteger父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。样本页面中为总关联样本数，不是当前页条数；资产中total为额度总量。
data.countinteger父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。样本页面中为总关联样本数，不是当前页条数；资产中total为额度总量。
data.limitinteger父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。每模板最多5份样本。
data.itemsarray父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。当前页样本条目。
data.items[]object父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。当前页样本条目。
data.items[].idstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。当前对象的标识；样本items[].id用于删除样本，模板id用于选模板。
data.items[].fileIdstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。文件标识；业务任务中通常与taskId相同，样本文件则不同。
data.items[].fileNamestring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。文件名；sourceFileName为原始来源名。
data.items[].fileSizeinteger父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。文件字节数；旧样本未知时可为空，不是MB。
data.items[].statusstring父对象存在时；可选投影见条件按对象区分，见S1/S3父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。当前对象状态；任务、样本、会话与规则的枚举不同，见S1/S2/S3。
data.items[].profileRevisionstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。当前生效、待构建或样本所属的画像版本；无对应版本时为空。
data.items[].failureReasonstring | null父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。失败信息；非失败状态通常为空。使用稳定错误码/阶段，不解析文案判状态。
data.items[].fileTypestring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。文件扩展类型或MIME内容类型，按字段名称区分。
data.items[].uploadedAtstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。Java本地日期时间字符串，无显式时区偏移；未知/尚未完成可为空。updateDate用于精确版本比较。
data.profileobject父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。当前模板分类画像的状态和版本。
data.profile.activeRevisionstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。当前生效、待构建或样本所属的画像版本；无对应版本时为空。
data.profile.pendingRevisionstring | null父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。当前生效、待构建或样本所属的画像版本；无对应版本时为空。
data.profile.statusstring父对象存在时；可选投影见条件按对象区分，见S1/S3父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。当前对象状态；任务、样本、会话与规则的枚举不同，见S1/S2/S3。
data.profile.failureReasonstring | null父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。失败信息；非失败状态通常为空。使用稳定错误码/阶段，不解析文案判状态。
data.profile.classificationPromptstring | null父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。画像的分类提示信息，未生成时可为空。
data.profile.scoringConfigobject | null父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。画像评分配置数据；结构依生成结果而定。
data.classificationNeedsSaveboolean父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。服务报告是否仍有需要保存的分类/样本改动；以实际值为准。
data.deletedSampleIdstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。已删除的样本关联ID；其他操作返回null。
接口特有说明 ​
  • 前置条件：至少保留一份；sampleId来自样本列表id。
  • 副作用：返回deletedSampleId和剩余数量；画像更新可能异步。
  • 规则：S3
适用错误 ​

E-AUTH, E-RESOURCE, E-INTERNAL, E-PARAM, E-SAMPLE

后续调用 ​

16. 自定义字段抽取 ​

为已有任务补充字段定义并重新抽取。

请求 ​
项目内容
方法POST
地址<API_BASE_URL>/api/v2/extract/{fileId}/fields
鉴权X-API-Key；本租户可访问/可管理资源
Content-Typeapplication/json
请求头 ​
字段类型必填默认枚举格式/限制业务含义/依赖示例
X-API-Keystring是；可用Bearer替代无无不放在URL或Body验证Key租户与归属<API_KEY>
路径参数 ​
字段类型必填默认枚举格式/限制业务含义/依赖示例
fileIdstring是无无—文件ID；此任务体系通常与taskId相同。task_example
JSON请求体 ​
字段类型必填默认枚举格式/限制业务含义/依赖示例
keysobject与tableHeaders至少一项无无—追加/覆盖此任务的普通字段定义，结构同模板keys。{"invoice_date": {"prompt": "Read invoice date"}}
tableHeadersobject与keys至少一项无无—追加表格列定义，结构同模板tableHeaders。{}
enableScoringboolean否保留原设置无—重新抽取是否评分；兼容enable_scoring。false
请求示例 ​

执行示例前，替换服务地址、密钥、资源ID、时间和文件。

bash
curl --request POST "<API_BASE_URL>/api/v2/extract/task_example/fields" \
  --header "X-API-Key: <API_KEY>" \
  --header "Content-Type: application/json" \
  --data-raw '{
  "keys": {
    "invoice_date": {
      "prompt": "Read invoice date"
    }
  },
  "enableScoring": false
}'

纯JSON Body：

json
{
  "keys": {
    "invoice_date": {
      "prompt": "Read invoice date"
    }
  },
  "enableScoring": false
}
成功响应 ​

HTTP 200

以下为成功响应示例。字段是否有值取决于任务状态、接口版本及资源可用性；业务字段名称由模板定义。

json
{
  "code": 200,
  "message": "success",
  "data": {
    "taskId": "task_example",
    "fileId": "task_example",
    "batchId": null,
    "status": "pending",
    "mode": null,
    "startPhase": null,
    "createdNewTask": null
  }
}
响应字段 ​
字段类型必返枚举出现条件含义
codeinteger是—JSON成功响应文件、任务、模板和资产接口成功码为200；提醒规则为0，均为数字。
messagestring是—JSON成功响应英文系统结果说明，通常success。
dataobject是；可为null—按任务状态、版本及资源可用性；null不等于空内容或0。本接口的数据，结构见以下字段；无返回内容时为null。
data.taskIdstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。任务标识，后续查询使用。
data.fileIdstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。文件标识；业务任务中通常与taskId相同，样本文件则不同。
data.batchIdstring | null父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。一次上传的批次标识；历史任务可能为空。
data.statusstring父对象存在时；可选投影见条件按对象区分，见S1/S3父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。当前对象状态；任务、样本、会话与规则的枚举不同，见S1/S2/S3。
data.modestring | null父对象存在时；可选投影见条件VisualExtract / LayoutExtract父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。本次处理模式：VisualExtract或LayoutExtract。
data.startPhasestring | null父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。处理阶段：parsing/classifying/extracting；无对应阶段时为空。
data.createdNewTaskboolean | null父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。是否创建新任务。任务重试返回false，并沿用原taskId。
接口特有说明 ​
  • 前置条件：keys/tableHeaders至少一项；任务不能pending/processing；LayoutExtract须有可重用解析归档。
  • 副作用：合并字段定义并清除旧抽取输出后重新排队，消耗处理资源。
  • 规则：S1, S4
适用错误 ​

E-AUTH, E-RESOURCE, E-INTERNAL, E-PARAM, E-QUOTA

后续调用 ​

17. 获取文件处理结果 ​

获取文件状态、抽取/解析结果、确认信息与评分。

请求 ​
项目内容
方法GET
地址<API_BASE_URL>/api/v2/tasks/
鉴权X-API-Key；本租户可访问/可管理资源
Content-Type无Body，无需Content-Type
请求头 ​
字段类型必填默认枚举格式/限制业务含义/依赖示例
X-API-Keystring是；可用Bearer替代无无不放在URL或Body验证Key租户与归属<API_KEY>
Accept-Versionstring否v2v2旧结构；v3精简公共结构—解析结构版本；与parser_version同时传时须一致。v3
路径参数 ​
字段类型必填默认枚举格式/限制业务含义/依赖示例
taskIdstring是无无—任务ID；来自上传返回taskIds。task_example
查询参数 ​
字段类型必填默认枚举格式/限制业务含义/依赖示例
parser_versionstring否v2v2 / v3—与Accept-Version等价的选择方式，二者冲突返回08026。v3
result_formatstring否legacylegacy旧展示；unified统一展示—仅控制抽取结果展示，不等同解析v3。legacy
json_export_idstring否已配置的默认方案无—选择管理员配置的JSON导出方案。export_example

解析结构：共享解析字段。先复制完整GET文档再编辑，不用单元素示例覆盖多页内容。

请求示例 ​

执行示例前，替换服务地址、密钥、资源ID、时间和文件。

bash
curl --request GET "<API_BASE_URL>/api/v2/tasks/task_example" \
  --header "X-API-Key: <API_KEY>" \
  --header "Accept-Version: v3"
成功响应 ​

HTTP 200

以下为成功响应示例。字段是否有值取决于任务状态、接口版本及资源可用性；业务字段名称由模板定义。

json
{
  "code": 200,
  "message": "success",
  "data": {
    "taskId": "task_example",
    "fileId": "task_example",
    "fileName": "invoice.pdf",
    "batchId": "batch_example",
    "taskType": "WORKFLOW_VISUAL_EXTRACT",
    "templateId": "template_example",
    "groupTemplateId": "group_example",
    "templateName": "Invoice Template",
    "status": "extraction_completed",
    "phase": null,
    "conversionStatus": "completed",
    "confirmStatus": "pending",
    "metadata": "{\"source\":\"api\"}",
    "error": null,
    "failureCode": null,
    "failureStage": null,
    "createdAt": "2026-10-23T08:00:00",
    "completedAt": "2026-10-23T08:00:00",
    "updateDate": "2026-10-23T08:00:00",
    "output": {
      "resultFormat": null,
      "fields": {
        "invoice_number": "INV-2026-001",
        "invoice_total": "100.00"
      },
      "tables": {
        "Items": [
          {
            "name": "Paper",
            "qty": 3
          }
        ]
      },
      "orderedElements": [
        {
          "type": "key",
          "name": "invoice_number",
          "value": "INV-2026-001"
        },
        {
          "type": "key",
          "name": "invoice_total",
          "value": "100.00"
        },
        {
          "type": "table",
          "name": "Items",
          "columns": [
            "name",
            "qty"
          ],
          "rows": [
            {
              "name": "Paper",
              "qty": 3
            }
          ]
        }
      ],
      "pages": [
        {
          "page": 1,
          "pageKey": "Page-1",
          "sourcePageKey": null,
          "tableBboxes": null,
          "fields": {
            "invoice_number": "INV-2026-001",
            "invoice_total": "100.00"
          },
          "tables": {
            "Items": [
              {
                "name": "Paper",
                "qty": 3
              }
            ]
          },
          "orderedElements": [
            {
              "type": "key",
              "name": "invoice_number",
              "value": "INV-2026-001"
            },
            {
              "type": "key",
              "name": "invoice_total",
              "value": "100.00"
            },
            {
              "type": "table",
              "name": "Items",
              "columns": [
                "name",
                "qty"
              ],
              "rows": [
                {
                  "name": "Paper",
                  "qty": 3
                }
              ]
            }
          ]
        }
      ]
    },
    "layoutOutput": "{\"api_version\":\"v3\",\"result\":{\"pages\":[{\"page_id\":1,\"page_number\":1,\"width\":1000,\"height\":1400,\"dpi\":144}],\"detail\":[{\"page_id\":1,\"element_id\":1,\"paragraph_id\":1,\"block_id\":\"block_example\",\"type\":\"text\",\"text\":\"Invoice number: INV-2026-001\",\"position\":[10,20,200,60]}]}}",
    "apiVersion": "v3",
    "fieldExceptions": "[]",
    "updatedFields": null,
    "extractionResult": {
      "resultFormat": null,
      "fields": {
        "invoice_number": "INV-2026-001",
        "invoice_total": "100.00"
      },
      "tables": {
        "Items": [
          {
            "name": "Paper",
            "qty": 3
          }
        ]
      },
      "orderedElements": [
        {
          "type": "key",
          "name": "invoice_number",
          "value": "INV-2026-001"
        },
        {
          "type": "key",
          "name": "invoice_total",
          "value": "100.00"
        },
        {
          "type": "table",
          "name": "Items",
          "columns": [
            "name",
            "qty"
          ],
          "rows": [
            {
              "name": "Paper",
              "qty": 3
            }
          ]
        }
      ],
      "pages": [
        {
          "page": 1,
          "pageKey": "Page-1",
          "sourcePageKey": null,
          "tableBboxes": null,
          "fields": {
            "invoice_number": "INV-2026-001",
            "invoice_total": "100.00"
          },
          "tables": {
            "Items": [
              {
                "name": "Paper",
                "qty": 3
              }
            ]
          },
          "orderedElements": [
            {
              "type": "key",
              "name": "invoice_number",
              "value": "INV-2026-001"
            },
            {
              "type": "key",
              "name": "invoice_total",
              "value": "100.00"
            },
            {
              "type": "table",
              "name": "Items",
              "columns": [
                "name",
                "qty"
              ],
              "rows": [
                {
                  "name": "Paper",
                  "qty": 3
                }
              ]
            }
          ]
        }
      ]
    },
    "parsingResult": {
      "api_version": "v3",
      "result": {
        "pages": [
          {
            "page_id": 1,
            "page_number": 1,
            "width": 1000,
            "height": 1400,
            "dpi": 144
          }
        ],
        "detail": [
          {
            "page_id": 1,
            "element_id": 1,
            "paragraph_id": 1,
            "block_id": "block_example",
            "type": "text",
            "text": "Invoice number: INV-2026-001",
            "position": [
              10,
              20,
              200,
              60
            ]
          }
        ]
      }
    },
    "parseResult": {
      "api_version": "v3",
      "result": {
        "pages": [
          {
            "page_id": 1,
            "page_number": 1,
            "width": 1000,
            "height": 1400,
            "dpi": 144
          }
        ],
        "detail": [
          {
            "page_id": 1,
            "element_id": 1,
            "paragraph_id": 1,
            "block_id": "block_example",
            "type": "text",
            "text": "Invoice number: INV-2026-001",
            "position": [
              10,
              20,
              200,
              60
            ]
          }
        ]
      }
    },
    "parseResultStatus": "available",
    "fieldExceptionDetails": [],
    "score": {
      "status": "complete",
      "fileScore": 72,
      "risk": "medium",
      "fields": {
        "Page-1.invoice_number": {
          "score": 72,
          "risk": "medium",
          "reasons": [
            "low_confidence"
          ]
        }
      }
    },
    "confidence": {
      "status": "complete",
      "fileScore": 72,
      "risk": "medium",
      "fields": [
        {
          "name": "Page-1.invoice_number",
          "score": 72,
          "risk": "medium",
          "deductions": [
            "low_confidence"
          ]
        }
      ]
    },
    "input": {
      "fileId": "task_example",
      "templateId": "template_example",
      "groupTemplateId": "group_example",
      "templateName": "Invoice Template",
      "mode": "VisualExtract"
    },
    "consumption": {
      "pages": 1
    },
    "originalFile": {
      "sourceFileName": "invoice.pdf",
      "fileName": "invoice.pdf",
      "contentType": "application/pdf",
      "normalizedPdf": true,
      "previewUrl": "<opaque-preview-link>",
      "downloadUrl": "<opaque-original-link>"
    },
    "artifacts": {
      "parsingZip": {
        "available": true,
        "downloadUrl": "<opaque-parsing-link>"
      },
      "extractionJson": {
        "available": true,
        "downloadUrl": "<opaque-extraction-link>"
      },
      "integratedZip": {
        "available": false,
        "downloadUrl": null
      }
    },
    "customJsonExport": null,
    "jsonExportError": null,
    "extractionSource": null,
    "parseResultUpdated": null
  }
}
响应字段 ​
字段类型必返枚举出现条件含义
codeinteger是—JSON成功响应文件、任务、模板和资产接口成功码为200；提醒规则为0，均为数字。
messagestring是—JSON成功响应英文系统结果说明，通常success。
dataobject是；可为null—按任务状态、版本及资源可用性；null不等于空内容或0。本接口的数据，结构见以下字段；无返回内容时为null。
data.taskIdstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。任务标识，后续查询使用。
data.fileIdstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。文件标识；业务任务中通常与taskId相同，样本文件则不同。
data.fileNamestring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。文件名；sourceFileName为原始来源名。
data.batchIdstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。一次上传的批次标识；历史任务可能为空。
data.taskTypestring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。既有任务类型标识，例如WORKFLOW_VISUAL_EXTRACT/WORKFLOW_LAYOUT_EXTRACT；历史类型保留。
data.templateIdstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。关联模板标识；自动分类完成前可能为空。
data.groupTemplateIdstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。模板分组关联标识，不等同templateId。
data.templateNamestring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。对象或模板名称，业务内容保持原语言。
data.statusstring父对象存在时；可选投影见条件按对象区分，见S1/S3父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。当前对象状态；任务、样本、会话与规则的枚举不同，见S1/S2/S3。
data.phasestring | null父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。处理阶段：parsing/classifying/extracting；无对应阶段时为空。
data.conversionStatusstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。文件转换状态信息；以服务返回值为准，不代替任务阶段。
data.confirmStatusstring父对象存在时；可选投影见条件pending / confirmed父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。结果确认状态：pending待确认、confirmed已确认，与处理状态独立。
data.metadatastring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。原上传的业务元数据文本；不是自动转换后的object。
data.errorstring | null父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。失败信息；非失败状态通常为空。使用稳定错误码/阶段，不解析文案判状态。
data.failureCodestring | null父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。失败信息；非失败状态通常为空。使用稳定错误码/阶段，不解析文案判状态。
data.failureStagestring | null父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。处理阶段：parsing/classifying/extracting；无对应阶段时为空。
data.createdAtstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。Java本地日期时间字符串，无显式时区偏移；未知/尚未完成可为空。updateDate用于精确版本比较。
data.completedAtstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。已完成任务的更新时间。后续结果修改会更新此时间。
data.updateDatestring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。Java本地日期时间字符串，无显式时区偏移；未知/尚未完成可为空。updateDate用于精确版本比较。
data.outputobject父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。抽取结果。output保留兼容形态；extractionResult为结构化字段、表格、排序与分页视图。
data.output.resultFormatstring | null父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。选择统一抽取视图时为unified；旧视图可不返回。
data.output.fieldsobject父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。普通字段名到业务值的映射；评分对象中则是字段路径到评分项的映射。
data.output.fields.invoice_numberstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。示例模板的业务字段/列名；实际键由模板决定，值保持原JSON类型。
data.output.fields.invoice_totalstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。示例模板的业务字段/列名；实际键由模板决定，值保持原JSON类型。
data.output.tablesobject父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。表名到行数组的映射，行内键为业务列名。
data.output.tables.Itemsarray父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。示例模板的业务字段/列名；实际键由模板决定，值保持原JSON类型。
data.output.tables.Items[]object父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。示例模板的业务字段/列名；实际键由模板决定，值保持原JSON类型。
data.output.tables.Items[].namestring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。对象或模板名称，业务内容保持原语言。
data.output.tables.Items[].qtyinteger父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。示例模板的业务字段/列名；实际键由模板决定，值保持原JSON类型。
data.output.orderedElementsarray父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。字段与表格的有序展示条目。
data.output.orderedElements[]object父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。字段与表格的有序展示条目。
data.output.orderedElements[].typestring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。模板显示顺序：type为key/table，name对应字段/表名，columnOrder指定列顺序。
data.output.orderedElements[].namestring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。对象或模板名称，业务内容保持原语言。
data.output.orderedElements[].valuestring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。此普通字段的业务值，保持原JSON类型。
data.output.orderedElements[].columnsarray父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。解析元素的图片、分类、表格或跨页关系等业务属性；按实际返回保留，不按白名单误删。
data.output.orderedElements[].columns[]string父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。解析元素的图片、分类、表格或跨页关系等业务属性；按实际返回保留，不按白名单误删。
data.output.orderedElements[].rowsarray父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。解析元素的图片、分类、表格或跨页关系等业务属性；按实际返回保留，不按白名单误删。
data.output.orderedElements[].rows[]object父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。解析元素的图片、分类、表格或跨页关系等业务属性；按实际返回保留，不按白名单误删。
data.output.orderedElements[].rows[].namestring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。对象或模板名称，业务内容保持原语言。
data.output.orderedElements[].rows[].qtyinteger父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。示例模板的业务字段/列名；实际键由模板决定，值保持原JSON类型。
data.output.pagesarray父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。在consumption下是页数；在结果下是页面数组，含分页字段/表格或解析页信息。
data.output.pages[]object父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。在consumption下是页数；在结果下是页面数组，含分页字段/表格或解析页信息。
data.output.pages[].pageinteger父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。列表中page为页码；结果中为逻辑页号及页键，sourcePageKey保留原键。
data.output.pages[].pageKeystring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。列表中page为页码；结果中为逻辑页号及页键，sourcePageKey保留原键。
data.output.pages[].sourcePageKeystring | null父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。列表中page为页码；结果中为逻辑页号及页键，sourcePageKey保留原键。
data.output.pages[].tableBboxesobject | null父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。页面尺寸、分辨率或定位坐标，保持原单位和数值。
data.output.pages[].fieldsobject父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。普通字段名到业务值的映射；评分对象中则是字段路径到评分项的映射。
data.output.pages[].fields.invoice_numberstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。示例模板的业务字段/列名；实际键由模板决定，值保持原JSON类型。
data.output.pages[].fields.invoice_totalstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。示例模板的业务字段/列名；实际键由模板决定，值保持原JSON类型。
data.output.pages[].tablesobject父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。表名到行数组的映射，行内键为业务列名。
data.output.pages[].tables.Itemsarray父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。示例模板的业务字段/列名；实际键由模板决定，值保持原JSON类型。
data.output.pages[].tables.Items[]object父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。示例模板的业务字段/列名；实际键由模板决定，值保持原JSON类型。
data.output.pages[].tables.Items[].namestring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。对象或模板名称，业务内容保持原语言。
data.output.pages[].tables.Items[].qtyinteger父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。示例模板的业务字段/列名；实际键由模板决定，值保持原JSON类型。
data.output.pages[].orderedElementsarray父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。字段与表格的有序展示条目。
data.output.pages[].orderedElements[]object父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。字段与表格的有序展示条目。
data.output.pages[].orderedElements[].typestring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。模板显示顺序：type为key/table，name对应字段/表名，columnOrder指定列顺序。
data.output.pages[].orderedElements[].namestring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。对象或模板名称，业务内容保持原语言。
data.output.pages[].orderedElements[].valuestring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。此普通字段的业务值，保持原JSON类型。
data.output.pages[].orderedElements[].columnsarray父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。解析元素的图片、分类、表格或跨页关系等业务属性；按实际返回保留，不按白名单误删。
data.output.pages[].orderedElements[].columns[]string父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。解析元素的图片、分类、表格或跨页关系等业务属性；按实际返回保留，不按白名单误删。
data.output.pages[].orderedElements[].rowsarray父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。解析元素的图片、分类、表格或跨页关系等业务属性；按实际返回保留，不按白名单误删。
data.output.pages[].orderedElements[].rows[]object父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。解析元素的图片、分类、表格或跨页关系等业务属性；按实际返回保留，不按白名单误删。
data.output.pages[].orderedElements[].rows[].namestring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。对象或模板名称，业务内容保持原语言。
data.output.pages[].orderedElements[].rows[].qtyinteger父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。示例模板的业务字段/列名；实际键由模板决定，值保持原JSON类型。
data.layoutOutputstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。兼容解析结果JSON字符串；需要再解析一次，不能当作object直接使用。
data.apiVersionstring父对象存在时；可选投影见条件v2 / v3父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。本响应采用的解析版本v2/v3，与根解析文档的api_version命名不同。
data.fieldExceptionsstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。兼容校验异常JSON字符串。
data.updatedFieldsarray | null父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。本次保存涉及的抽取字段名称列表；不是完整变更审计。
data.extractionResultobject父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。抽取结果。output保留兼容形态；extractionResult为结构化字段、表格、排序与分页视图。
data.extractionResult.resultFormatstring | null父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。选择统一抽取视图时为unified；旧视图可不返回。
data.extractionResult.fieldsobject父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。普通字段名到业务值的映射；评分对象中则是字段路径到评分项的映射。
data.extractionResult.fields.invoice_numberstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。示例模板的业务字段/列名；实际键由模板决定，值保持原JSON类型。
data.extractionResult.fields.invoice_totalstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。示例模板的业务字段/列名；实际键由模板决定，值保持原JSON类型。
data.extractionResult.tablesobject父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。表名到行数组的映射，行内键为业务列名。
data.extractionResult.tables.Itemsarray父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。示例模板的业务字段/列名；实际键由模板决定，值保持原JSON类型。
data.extractionResult.tables.Items[]object父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。示例模板的业务字段/列名；实际键由模板决定，值保持原JSON类型。
data.extractionResult.tables.Items[].namestring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。对象或模板名称，业务内容保持原语言。
data.extractionResult.tables.Items[].qtyinteger父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。示例模板的业务字段/列名；实际键由模板决定，值保持原JSON类型。
data.extractionResult.orderedElementsarray父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。字段与表格的有序展示条目。
data.extractionResult.orderedElements[]object父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。字段与表格的有序展示条目。
data.extractionResult.orderedElements[].typestring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。模板显示顺序：type为key/table，name对应字段/表名，columnOrder指定列顺序。
data.extractionResult.orderedElements[].namestring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。对象或模板名称，业务内容保持原语言。
data.extractionResult.orderedElements[].valuestring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。此普通字段的业务值，保持原JSON类型。
data.extractionResult.orderedElements[].columnsarray父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。解析元素的图片、分类、表格或跨页关系等业务属性；按实际返回保留，不按白名单误删。
data.extractionResult.orderedElements[].columns[]string父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。解析元素的图片、分类、表格或跨页关系等业务属性；按实际返回保留，不按白名单误删。
data.extractionResult.orderedElements[].rowsarray父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。解析元素的图片、分类、表格或跨页关系等业务属性；按实际返回保留，不按白名单误删。
data.extractionResult.orderedElements[].rows[]object父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。解析元素的图片、分类、表格或跨页关系等业务属性；按实际返回保留，不按白名单误删。
data.extractionResult.orderedElements[].rows[].namestring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。对象或模板名称，业务内容保持原语言。
data.extractionResult.orderedElements[].rows[].qtyinteger父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。示例模板的业务字段/列名；实际键由模板决定，值保持原JSON类型。
data.extractionResult.pagesarray父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。在consumption下是页数；在结果下是页面数组，含分页字段/表格或解析页信息。
data.extractionResult.pages[]object父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。在consumption下是页数；在结果下是页面数组，含分页字段/表格或解析页信息。
data.extractionResult.pages[].pageinteger父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。列表中page为页码；结果中为逻辑页号及页键，sourcePageKey保留原键。
data.extractionResult.pages[].pageKeystring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。列表中page为页码；结果中为逻辑页号及页键，sourcePageKey保留原键。
data.extractionResult.pages[].sourcePageKeystring | null父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。列表中page为页码；结果中为逻辑页号及页键，sourcePageKey保留原键。
data.extractionResult.pages[].tableBboxesobject | null父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。页面尺寸、分辨率或定位坐标，保持原单位和数值。
data.extractionResult.pages[].fieldsobject父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。普通字段名到业务值的映射；评分对象中则是字段路径到评分项的映射。
data.extractionResult.pages[].fields.invoice_numberstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。示例模板的业务字段/列名；实际键由模板决定，值保持原JSON类型。
data.extractionResult.pages[].fields.invoice_totalstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。示例模板的业务字段/列名；实际键由模板决定，值保持原JSON类型。
data.extractionResult.pages[].tablesobject父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。表名到行数组的映射，行内键为业务列名。
data.extractionResult.pages[].tables.Itemsarray父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。示例模板的业务字段/列名；实际键由模板决定，值保持原JSON类型。
data.extractionResult.pages[].tables.Items[]object父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。示例模板的业务字段/列名；实际键由模板决定，值保持原JSON类型。
data.extractionResult.pages[].tables.Items[].namestring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。对象或模板名称，业务内容保持原语言。
data.extractionResult.pages[].tables.Items[].qtyinteger父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。示例模板的业务字段/列名；实际键由模板决定，值保持原JSON类型。
data.extractionResult.pages[].orderedElementsarray父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。字段与表格的有序展示条目。
data.extractionResult.pages[].orderedElements[]object父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。字段与表格的有序展示条目。
data.extractionResult.pages[].orderedElements[].typestring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。模板显示顺序：type为key/table，name对应字段/表名，columnOrder指定列顺序。
data.extractionResult.pages[].orderedElements[].namestring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。对象或模板名称，业务内容保持原语言。
data.extractionResult.pages[].orderedElements[].valuestring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。此普通字段的业务值，保持原JSON类型。
data.extractionResult.pages[].orderedElements[].columnsarray父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。解析元素的图片、分类、表格或跨页关系等业务属性；按实际返回保留，不按白名单误删。
data.extractionResult.pages[].orderedElements[].columns[]string父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。解析元素的图片、分类、表格或跨页关系等业务属性；按实际返回保留，不按白名单误删。
data.extractionResult.pages[].orderedElements[].rowsarray父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。解析元素的图片、分类、表格或跨页关系等业务属性；按实际返回保留，不按白名单误删。
data.extractionResult.pages[].orderedElements[].rows[]object父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。解析元素的图片、分类、表格或跨页关系等业务属性；按实际返回保留，不按白名单误删。
data.extractionResult.pages[].orderedElements[].rows[].namestring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。对象或模板名称，业务内容保持原语言。
data.extractionResult.pages[].orderedElements[].rows[].qtyinteger父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。示例模板的业务字段/列名；实际键由模板决定，值保持原JSON类型。
data.parsingResultobject父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。同一公共解析文档的兼容对象字段；无归档/读取失败时可为空。
data.parsingResult.api_versionstring父对象存在时；可选投影见条件v2 / v3父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。解析文档版本标记；v3编辑应保留此标记。
data.parsingResult.resultobject父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。解析文档正文包装；历史无此层时文档自身为正文。
data.parsingResult.result.pagesarray父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。在consumption下是页数；在结果下是页面数组，含分页字段/表格或解析页信息。
data.parsingResult.result.pages[]object父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。在consumption下是页数；在结果下是页面数组，含分页字段/表格或解析页信息。
data.parsingResult.result.pages[].page_idinteger父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。页面/元素/模型引用标识。编辑以page_id+element_id为准，paragraph_id兼容且须一致；不重排block_id。
data.parsingResult.result.pages[].page_numberinteger父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。页面/元素/模型引用标识。编辑以page_id+element_id为准，paragraph_id兼容且须一致；不重排block_id。
data.parsingResult.result.pages[].widthinteger父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。页面尺寸、分辨率或定位坐标，保持原单位和数值。
data.parsingResult.result.pages[].heightinteger父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。页面尺寸、分辨率或定位坐标，保持原单位和数值。
data.parsingResult.result.pages[].dpiinteger父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。页面尺寸、分辨率或定位坐标，保持原单位和数值。
data.parsingResult.result.detailarray父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。该对象提供的业务扩展属性；保留原字段和类型，不视为新的接口。
data.parsingResult.result.detail[]object父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。该对象提供的业务扩展属性；保留原字段和类型，不视为新的接口。
data.parsingResult.result.detail[].page_idinteger父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。页面/元素/模型引用标识。编辑以page_id+element_id为准，paragraph_id兼容且须一致；不重排block_id。
data.parsingResult.result.detail[].element_idinteger父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。页面/元素/模型引用标识。编辑以page_id+element_id为准，paragraph_id兼容且须一致；不重排block_id。
data.parsingResult.result.detail[].paragraph_idinteger父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。页面/元素/模型引用标识。编辑以page_id+element_id为准，paragraph_id兼容且须一致；不重排block_id。
data.parsingResult.result.detail[].block_idstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。页面/元素/模型引用标识。编辑以page_id+element_id为准，paragraph_id兼容且须一致；不重排block_id。
data.parsingResult.result.detail[].typestring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。解析元素类型，例如text/table/image；保持原业务类型。
data.parsingResult.result.detail[].textstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。解析业务内容；文本以text为编辑权威，表格保留完整结构。
data.parsingResult.result.detail[].positionarray父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。页面尺寸、分辨率或定位坐标，保持原单位和数值。
data.parsingResult.result.detail[].position[]integer父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。页面尺寸、分辨率或定位坐标，保持原单位和数值。
data.parseResultobject父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。同一公共解析文档的兼容对象字段；无归档/读取失败时可为空。
data.parseResult.api_versionstring父对象存在时；可选投影见条件v2 / v3父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。解析文档版本标记；v3编辑应保留此标记。
data.parseResult.resultobject父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。解析文档正文包装；历史无此层时文档自身为正文。
data.parseResult.result.pagesarray父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。在consumption下是页数；在结果下是页面数组，含分页字段/表格或解析页信息。
data.parseResult.result.pages[]object父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。在consumption下是页数；在结果下是页面数组，含分页字段/表格或解析页信息。
data.parseResult.result.pages[].page_idinteger父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。页面/元素/模型引用标识。编辑以page_id+element_id为准，paragraph_id兼容且须一致；不重排block_id。
data.parseResult.result.pages[].page_numberinteger父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。页面/元素/模型引用标识。编辑以page_id+element_id为准，paragraph_id兼容且须一致；不重排block_id。
data.parseResult.result.pages[].widthinteger父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。页面尺寸、分辨率或定位坐标，保持原单位和数值。
data.parseResult.result.pages[].heightinteger父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。页面尺寸、分辨率或定位坐标，保持原单位和数值。
data.parseResult.result.pages[].dpiinteger父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。页面尺寸、分辨率或定位坐标，保持原单位和数值。
data.parseResult.result.detailarray父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。该对象提供的业务扩展属性；保留原字段和类型，不视为新的接口。
data.parseResult.result.detail[]object父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。该对象提供的业务扩展属性；保留原字段和类型，不视为新的接口。
data.parseResult.result.detail[].page_idinteger父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。页面/元素/模型引用标识。编辑以page_id+element_id为准，paragraph_id兼容且须一致；不重排block_id。
data.parseResult.result.detail[].element_idinteger父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。页面/元素/模型引用标识。编辑以page_id+element_id为准，paragraph_id兼容且须一致；不重排block_id。
data.parseResult.result.detail[].paragraph_idinteger父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。页面/元素/模型引用标识。编辑以page_id+element_id为准，paragraph_id兼容且须一致；不重排block_id。
data.parseResult.result.detail[].block_idstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。页面/元素/模型引用标识。编辑以page_id+element_id为准，paragraph_id兼容且须一致；不重排block_id。
data.parseResult.result.detail[].typestring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。解析元素类型，例如text/table/image；保持原业务类型。
data.parseResult.result.detail[].textstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。解析业务内容；文本以text为编辑权威，表格保留完整结构。
data.parseResult.result.detail[].positionarray父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。页面尺寸、分辨率或定位坐标，保持原单位和数值。
data.parseResult.result.detail[].position[]integer父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。页面尺寸、分辨率或定位坐标，保持原单位和数值。
data.parseResultStatusstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。available可用、not_available无归档、read_failed读取失败。
data.fieldExceptionDetailsarray父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。结构化字段异常明细；条目由具体校验结果决定。
data.scoreobject父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。兼容评分对象：状态、总分、风险和字段映射；缺失时不伪造0分。
data.score.statusstring父对象存在时；可选投影见条件pending / complete / failed / missing父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。评分状态，不是任务处理状态；missing可表示未启用评分。
data.score.fileScoreinteger父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。整体评分，当前公共视图通常为1–100；仅完成评分时有值。
data.score.riskstring父对象存在时；可选投影见条件low / medium / high父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。模型提供的风险级别low/medium/high，不由调用方从分数自行推导。
data.score.fieldsobject父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。字段路径到评分详情的对象映射；键可能包含点号，按完整键使用。
data.score.fields[<fieldPath>]object父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。示例模板的业务字段/列名；实际键由模板决定，值保持原JSON类型。
data.score.fields[<fieldPath>].scoreinteger父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。该字段归一化后的数值评分，通常1–100；不是评分对象。
data.score.fields[<fieldPath>].riskstring父对象存在时；可选投影见条件low / medium / high父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。模型提供的风险级别low/medium/high，不由调用方从分数自行推导。
data.score.fields[<fieldPath>].reasonsarray父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。该评分项的原因列表，可为空。
data.score.fields[<fieldPath>].reasons[]string父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。总分1–100、风险low/medium/high、原因或扣分说明；不要将缺失评分当0。
data.confidenceobject父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。任务中为兼容新增的评分展示对象；分类结果中是可能为空的数值置信度。
data.confidence.statusstring父对象存在时；可选投影见条件pending / complete / failed / missing父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。评分状态，不是任务处理状态；missing可表示未启用评分。
data.confidence.fileScoreinteger父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。整体评分，当前公共视图通常为1–100；仅完成评分时有值。
data.confidence.riskstring父对象存在时；可选投影见条件low / medium / high父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。模型提供的风险级别low/medium/high，不由调用方从分数自行推导。
data.confidence.fieldsarray父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。字段评分展示数组；与score.fields对象映射并存。
data.confidence.fields[]object父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。普通字段名到业务值的映射；评分对象中则是字段路径到评分项的映射。
data.confidence.fields[].namestring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。评分项的字段路径名称，例如Page-1.invoice_number。
data.confidence.fields[].scoreinteger父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。该字段归一化后的数值评分，通常1–100；不是评分对象。
data.confidence.fields[].riskstring父对象存在时；可选投影见条件low / medium / high父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。模型提供的风险级别low/medium/high，不由调用方从分数自行推导。
data.confidence.fields[].deductionsarray父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。评分展示数组中的扣分说明列表。
data.confidence.fields[].deductions[]string父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。总分1–100、风险low/medium/high、原因或扣分说明；不要将缺失评分当0。
data.inputobject父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。任务输入摘要；可用来确认实际模式和模板。
data.input.fileIdstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。文件标识；业务任务中通常与taskId相同，样本文件则不同。
data.input.templateIdstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。关联模板标识；自动分类完成前可能为空。
data.input.groupTemplateIdstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。模板分组关联标识，不等同templateId。
data.input.templateNamestring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。对象或模板名称，业务内容保持原语言。
data.input.modestring父对象存在时；可选投影见条件VisualExtract / LayoutExtract父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。本次处理模式：VisualExtract或LayoutExtract。
data.consumptionobject父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。当前任务的资源使用信息。
data.consumption.pagesinteger父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。在consumption下是页数；在结果下是页面数组，含分页字段/表格或解析页信息。
data.originalFileobject父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。原文件信息及现有链接字段。
data.originalFile.sourceFileNamestring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。文件名；sourceFileName为原始来源名。
data.originalFile.fileNamestring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。文件名；sourceFileName为原始来源名。
data.originalFile.contentTypestring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。文件扩展类型或MIME内容类型，按字段名称区分。
data.originalFile.normalizedPdfboolean父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。是否已规范化为PDF。
data.originalFile.previewUrlstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。资源访问链接。无可用资源时为空；访问时使用对应服务的认证方式。
data.originalFile.downloadUrlstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。资源访问链接。无可用资源时为空；访问时使用对应服务的认证方式。
data.artifactsobject父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。结果归档的可用性信息。
data.artifacts.parsingZipobject父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。对应解析ZIP、抽取JSON或整合ZIP的可用性对象。
data.artifacts.parsingZip.availableboolean父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。该归档是否存在并可供当前响应引用。
data.artifacts.parsingZip.downloadUrlstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。资源访问链接。无可用资源时为空；访问时使用对应服务的认证方式。
data.artifacts.extractionJsonobject父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。对应解析ZIP、抽取JSON或整合ZIP的可用性对象。
data.artifacts.extractionJson.availableboolean父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。该归档是否存在并可供当前响应引用。
data.artifacts.extractionJson.downloadUrlstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。资源访问链接。无可用资源时为空；访问时使用对应服务的认证方式。
data.artifacts.integratedZipobject父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。对应解析ZIP、抽取JSON或整合ZIP的可用性对象。
data.artifacts.integratedZip.availableboolean父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。该归档是否存在并可供当前响应引用。
data.artifacts.integratedZip.downloadUrlstring | null父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。资源访问链接。无可用资源时为空；访问时使用对应服务的认证方式。
data.customJsonExportboolean | null父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。是否已应用自定义JSON导出结构。
data.jsonExportErrorstring | null父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。导出结构应用失败的信息；正常时为空。
data.extractionSourceJSON | null父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。自定义导出需要时保留的原抽取结果；普通请求可为空。
data.parseResultUpdatedboolean | null父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。仅结果更新响应用于指示本次是否修改解析部分。
data.score.reasonstring否无服务实际提供对应诊断时评分不可用或失败的原因，例如scoring_disabled。
data.score.modelFileScoreinteger否无服务实际提供对应诊断时模型诊断分数。整体评分读取fileScore。
data.score.scoredFieldCountinteger否无服务实际提供对应诊断时模型附带的已评分字段数量；可不出现。
接口特有说明 ​
  • 前置条件：可访问的taskId；解析v3使用Accept-Version或parser_version，冲突拒绝。
  • 副作用：各结果字段随解析、抽取和评分进度返回。通过status、parseResultStatus及score.status分别读取状态。
  • 规则：S1, S6
适用错误 ​

E-AUTH, E-RESOURCE, E-INTERNAL, E-VERSION

后续调用 ​

解析文档共享字段 ​

P11和P12使用以下解析文档结构。更新时保留页面、坐标、DPI及其他公共业务属性。

字段类型必填/出现条件含义
api_versionstring可选；编辑v3数据时保留版本标记，不代替请求Header/Query选择。
resultobject有包装时保留正文容器；历史无result时以根对象为正文，勿混放两套pages/detail。
result.pagesarray<object>编辑时必需完整保留的页清单，含空白页。
result.pages[].page_idinteger是正整数、不可重复；不要用数组下标替代。
result.pages[].page_number / width / height / dpinumber / original type原文有则保留页码、尺寸和DPI等信息；保持原值与单位，不能硬编码72/144。
result.detailarray<object>正常编辑必须完整提供正文元素唯一列表；显式[]表示删除全部，不能由旧structured/content复活。
result.detail[].page_idinteger是必须引用pages中存在的页。
result.detail[].element_id / paragraph_idinteger需要有效元素标识正整数、同页唯一；两个别名同时传必须相同。
result.detail[].block_idstring / original type原文有则保留模型定位引用，不用它替代element_id。
result.detail[].typestring保留原类型例如text/table/image等，具体业务类型按返回保持。
result.detail[].text / html / markdown / contentstring or JSON按元素类型及原文文本以text为权威，包括空字符串；表格保留HTML和其他结构。
result.detail[].position / bbox / image / image_url / urlarray or JSON原文有则保留定位或图片引用；保持坐标单位及归档相对位置。
result.detail[].cells / cols / columns / rows / tableJSON表格原文有则保留结构化表格属性。修改html时保留相关行、列和单元格数据。
result.detail[].continue / next_page_id / next_para_idJSON跨页结构存在时跨页关联信息，保持引用关系。
result.detail[].confidence / score / category / label / additional propertiesJSON按原返回模型返回的其他公共属性。更新时保留其名称、类型和值。

18. 更新文件处理结果 ​

人工更新已完成且未确认任务的处理结果。

请求 ​
项目内容
方法PUT
地址<API_BASE_URL>/api/v2/tasks/
鉴权X-API-Key；本租户可访问/可管理资源
Content-Typeapplication/json
请求头 ​
字段类型必填默认枚举格式/限制业务含义/依赖示例
X-API-Keystring是；可用Bearer替代无无不放在URL或Body验证Key租户与归属<API_KEY>
Accept-Versionstring否v2v2旧结构；v3精简公共结构—解析结构版本；与parser_version同时传时须一致。v3
路径参数 ​
字段类型必填默认枚举格式/限制业务含义/依赖示例
taskIdstring是无无—任务ID；来自上传返回taskIds。task_example
查询参数 ​
字段类型必填默认枚举格式/限制业务含义/依赖示例
parser_versionstring否v2v2 / v3—与Accept-Version等价的选择方式，二者冲突返回08026。v3
result_formatstring否legacylegacy旧展示；unified统一展示—仅控制抽取结果展示，不等同解析v3。legacy
json_export_idstring否已配置的默认方案无—选择管理员配置的JSON导出方案。export_example
JSON请求体 ​
字段类型必填默认枚举格式/限制业务含义/依赖示例
fieldsobjectfields/tables/parse_result至少一项省略不修改该部分无—普通字段完整替换。键为实际业务字段名，值保持原类型。
tablesobject三者至少一项省略不修改该部分无—表名→行数组，完整替换提交的表格部分；行内键为实际列名。{"Items": [{"name": "Paper", "qty": 3}]}
parse_resultobject三者至少一项省略不修改解析无—完整公共解析文档，先复制GET结果再修改；兼容parseResult。详见共享结构。null
confirmboolean否true无—本次是否主动确认结果。false不阻止后续评分自动确认。false
expectedUpdateDatestring否不执行该版本比较无—最近GET返回的updateDate原文；不要改时区或精度。2026-10-23T08:00:00

解析结构：共享解析字段。先复制完整GET文档再编辑，不用单元素示例覆盖多页内容。

请求示例 ​

执行示例前，替换服务地址、密钥、资源ID、时间和文件。

bash
curl --request PUT "<API_BASE_URL>/api/v2/tasks/task_example" \
  --header "X-API-Key: <API_KEY>" \
  --header "Accept-Version: v3" \
  --header "Content-Type: application/json" \
  --data-raw '{
  "fields": {
    "invoice_number": "INV-2026-002",
    "invoice_total": "100.00"
  },
  "tables": {
    "Items": [
      {
        "name": "Paper",
        "qty": 3
      }
    ]
  },
  "parse_result": {
    "api_version": "v3",
    "result": {
      "pages": [
        {
          "page_id": 1,
          "width": 1000,
          "height": 1400,
          "dpi": 144,
          "page_number": 1
        }
      ],
      "detail": [
        {
          "page_id": 1,
          "element_id": 1,
          "paragraph_id": 1,
          "type": "text",
          "text": "Invoice number: INV-2026-002",
          "position": [
            10,
            20,
            200,
            60
          ],
          "block_id": "block_example"
        }
      ]
    }
  },
  "confirm": false,
  "expectedUpdateDate": "2026-10-23T08:00:00"
}'

纯JSON Body：

json
{
  "fields": {
    "invoice_number": "INV-2026-002",
    "invoice_total": "100.00"
  },
  "tables": {
    "Items": [
      {
        "name": "Paper",
        "qty": 3
      }
    ]
  },
  "parse_result": {
    "api_version": "v3",
    "result": {
      "pages": [
        {
          "page_id": 1,
          "width": 1000,
          "height": 1400,
          "dpi": 144,
          "page_number": 1
        }
      ],
      "detail": [
        {
          "page_id": 1,
          "element_id": 1,
          "paragraph_id": 1,
          "type": "text",
          "text": "Invoice number: INV-2026-002",
          "position": [
            10,
            20,
            200,
            60
          ],
          "block_id": "block_example"
        }
      ]
    }
  },
  "confirm": false,
  "expectedUpdateDate": "2026-10-23T08:00:00"
}
成功响应 ​

HTTP 200

以下为成功响应示例。字段是否有值取决于任务状态、接口版本及资源可用性；业务字段名称由模板定义。

json
{
  "code": 200,
  "message": "success",
  "data": {
    "taskId": "task_example",
    "fileId": "task_example",
    "fileName": "invoice.pdf",
    "batchId": "batch_example",
    "taskType": "WORKFLOW_VISUAL_EXTRACT",
    "templateId": "template_example",
    "groupTemplateId": "group_example",
    "templateName": "Invoice Template",
    "status": "extraction_completed",
    "phase": null,
    "conversionStatus": "completed",
    "confirmStatus": "pending",
    "metadata": "{\"source\":\"api\"}",
    "error": null,
    "failureCode": null,
    "failureStage": null,
    "createdAt": "2026-10-23T08:00:00",
    "completedAt": "2026-10-23T08:01:00",
    "updateDate": "2026-10-23T08:01:00",
    "output": {
      "resultFormat": null,
      "fields": {
        "invoice_number": "INV-2026-002",
        "invoice_total": "100.00"
      },
      "tables": {
        "Items": [
          {
            "name": "Paper",
            "qty": 3
          }
        ]
      },
      "orderedElements": [
        {
          "type": "key",
          "name": "invoice_number",
          "value": "INV-2026-002"
        },
        {
          "type": "key",
          "name": "invoice_total",
          "value": "100.00"
        },
        {
          "type": "table",
          "name": "Items",
          "columns": [
            "name",
            "qty"
          ],
          "rows": [
            {
              "name": "Paper",
              "qty": 3
            }
          ]
        }
      ],
      "pages": [
        {
          "page": 1,
          "pageKey": "Page-1",
          "sourcePageKey": null,
          "tableBboxes": null,
          "fields": {
            "invoice_number": "INV-2026-002",
            "invoice_total": "100.00"
          },
          "tables": {
            "Items": [
              {
                "name": "Paper",
                "qty": 3
              }
            ]
          },
          "orderedElements": [
            {
              "type": "key",
              "name": "invoice_number",
              "value": "INV-2026-002"
            },
            {
              "type": "key",
              "name": "invoice_total",
              "value": "100.00"
            },
            {
              "type": "table",
              "name": "Items",
              "columns": [
                "name",
                "qty"
              ],
              "rows": [
                {
                  "name": "Paper",
                  "qty": 3
                }
              ]
            }
          ]
        }
      ]
    },
    "layoutOutput": "{\"api_version\":\"v3\",\"result\":{\"pages\":[{\"page_id\":1,\"width\":1000,\"height\":1400,\"dpi\":144,\"page_number\":1}],\"detail\":[{\"page_id\":1,\"element_id\":1,\"paragraph_id\":1,\"type\":\"text\",\"text\":\"Invoice number: INV-2026-002\",\"position\":[10,20,200,60],\"block_id\":\"block_example\"}]}}",
    "apiVersion": "v3",
    "fieldExceptions": "[]",
    "updatedFields": [
      "invoice_number",
      "invoice_total",
      "Items"
    ],
    "extractionResult": {
      "resultFormat": null,
      "fields": {
        "invoice_number": "INV-2026-002",
        "invoice_total": "100.00"
      },
      "tables": {
        "Items": [
          {
            "name": "Paper",
            "qty": 3
          }
        ]
      },
      "orderedElements": [
        {
          "type": "key",
          "name": "invoice_number",
          "value": "INV-2026-002"
        },
        {
          "type": "key",
          "name": "invoice_total",
          "value": "100.00"
        },
        {
          "type": "table",
          "name": "Items",
          "columns": [
            "name",
            "qty"
          ],
          "rows": [
            {
              "name": "Paper",
              "qty": 3
            }
          ]
        }
      ],
      "pages": [
        {
          "page": 1,
          "pageKey": "Page-1",
          "sourcePageKey": null,
          "tableBboxes": null,
          "fields": {
            "invoice_number": "INV-2026-002",
            "invoice_total": "100.00"
          },
          "tables": {
            "Items": [
              {
                "name": "Paper",
                "qty": 3
              }
            ]
          },
          "orderedElements": [
            {
              "type": "key",
              "name": "invoice_number",
              "value": "INV-2026-002"
            },
            {
              "type": "key",
              "name": "invoice_total",
              "value": "100.00"
            },
            {
              "type": "table",
              "name": "Items",
              "columns": [
                "name",
                "qty"
              ],
              "rows": [
                {
                  "name": "Paper",
                  "qty": 3
                }
              ]
            }
          ]
        }
      ]
    },
    "parsingResult": {
      "api_version": "v3",
      "result": {
        "pages": [
          {
            "page_id": 1,
            "width": 1000,
            "height": 1400,
            "dpi": 144,
            "page_number": 1
          }
        ],
        "detail": [
          {
            "page_id": 1,
            "element_id": 1,
            "paragraph_id": 1,
            "type": "text",
            "text": "Invoice number: INV-2026-002",
            "position": [
              10,
              20,
              200,
              60
            ],
            "block_id": "block_example"
          }
        ]
      }
    },
    "parseResult": {
      "api_version": "v3",
      "result": {
        "pages": [
          {
            "page_id": 1,
            "width": 1000,
            "height": 1400,
            "dpi": 144,
            "page_number": 1
          }
        ],
        "detail": [
          {
            "page_id": 1,
            "element_id": 1,
            "paragraph_id": 1,
            "type": "text",
            "text": "Invoice number: INV-2026-002",
            "position": [
              10,
              20,
              200,
              60
            ],
            "block_id": "block_example"
          }
        ]
      }
    },
    "parseResultStatus": "available",
    "fieldExceptionDetails": [],
    "score": {
      "status": "complete",
      "fileScore": 72,
      "risk": "medium",
      "fields": {
        "Page-1.invoice_number": {
          "score": 72,
          "risk": "medium",
          "reasons": [
            "low_confidence"
          ]
        }
      }
    },
    "confidence": {
      "status": "complete",
      "fileScore": 72,
      "risk": "medium",
      "fields": [
        {
          "name": "Page-1.invoice_number",
          "score": 72,
          "risk": "medium",
          "deductions": [
            "low_confidence"
          ]
        }
      ]
    },
    "input": {
      "fileId": "task_example",
      "templateId": "template_example",
      "groupTemplateId": "group_example",
      "templateName": "Invoice Template",
      "mode": "VisualExtract"
    },
    "consumption": {
      "pages": 1
    },
    "originalFile": {
      "sourceFileName": "invoice.pdf",
      "fileName": "invoice.pdf",
      "contentType": "application/pdf",
      "normalizedPdf": true,
      "previewUrl": "<opaque-preview-link>",
      "downloadUrl": "<opaque-original-link>"
    },
    "artifacts": {
      "parsingZip": {
        "available": true,
        "downloadUrl": "<opaque-parsing-link>"
      },
      "extractionJson": {
        "available": true,
        "downloadUrl": "<opaque-extraction-link>"
      },
      "integratedZip": {
        "available": false,
        "downloadUrl": null
      }
    },
    "customJsonExport": null,
    "jsonExportError": null,
    "extractionSource": null,
    "parseResultUpdated": true
  }
}
响应字段 ​
字段类型必返枚举出现条件含义
codeinteger是—JSON成功响应文件、任务、模板和资产接口成功码为200；提醒规则为0，均为数字。
messagestring是—JSON成功响应英文系统结果说明，通常success。
dataobject是；可为null—按任务状态、版本及资源可用性；null不等于空内容或0。本接口的数据，结构见以下字段；无返回内容时为null。
data.taskIdstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。任务标识，后续查询使用。
data.fileIdstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。文件标识；业务任务中通常与taskId相同，样本文件则不同。
data.fileNamestring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。文件名；sourceFileName为原始来源名。
data.batchIdstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。一次上传的批次标识；历史任务可能为空。
data.taskTypestring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。既有任务类型标识，例如WORKFLOW_VISUAL_EXTRACT/WORKFLOW_LAYOUT_EXTRACT；历史类型保留。
data.templateIdstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。关联模板标识；自动分类完成前可能为空。
data.groupTemplateIdstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。模板分组关联标识，不等同templateId。
data.templateNamestring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。对象或模板名称，业务内容保持原语言。
data.statusstring父对象存在时；可选投影见条件按对象区分，见S1/S3父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。当前对象状态；任务、样本、会话与规则的枚举不同，见S1/S2/S3。
data.phasestring | null父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。处理阶段：parsing/classifying/extracting；无对应阶段时为空。
data.conversionStatusstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。文件转换状态信息；以服务返回值为准，不代替任务阶段。
data.confirmStatusstring父对象存在时；可选投影见条件pending / confirmed父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。结果确认状态：pending待确认、confirmed已确认，与处理状态独立。
data.metadatastring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。原上传的业务元数据文本；不是自动转换后的object。
data.errorstring | null父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。失败信息；非失败状态通常为空。使用稳定错误码/阶段，不解析文案判状态。
data.failureCodestring | null父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。失败信息；非失败状态通常为空。使用稳定错误码/阶段，不解析文案判状态。
data.failureStagestring | null父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。处理阶段：parsing/classifying/extracting；无对应阶段时为空。
data.createdAtstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。Java本地日期时间字符串，无显式时区偏移；未知/尚未完成可为空。updateDate用于精确版本比较。
data.completedAtstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。已完成任务的更新时间。后续结果修改会更新此时间。
data.updateDatestring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。Java本地日期时间字符串，无显式时区偏移；未知/尚未完成可为空。updateDate用于精确版本比较。
data.outputobject父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。抽取结果。output保留兼容形态；extractionResult为结构化字段、表格、排序与分页视图。
data.output.resultFormatstring | null父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。选择统一抽取视图时为unified；旧视图可不返回。
data.output.fieldsobject父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。普通字段名到业务值的映射；评分对象中则是字段路径到评分项的映射。
data.output.fields.invoice_numberstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。示例模板的业务字段/列名；实际键由模板决定，值保持原JSON类型。
data.output.fields.invoice_totalstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。示例模板的业务字段/列名；实际键由模板决定，值保持原JSON类型。
data.output.tablesobject父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。表名到行数组的映射，行内键为业务列名。
data.output.tables.Itemsarray父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。示例模板的业务字段/列名；实际键由模板决定，值保持原JSON类型。
data.output.tables.Items[]object父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。示例模板的业务字段/列名；实际键由模板决定，值保持原JSON类型。
data.output.tables.Items[].namestring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。对象或模板名称，业务内容保持原语言。
data.output.tables.Items[].qtyinteger父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。示例模板的业务字段/列名；实际键由模板决定，值保持原JSON类型。
data.output.orderedElementsarray父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。字段与表格的有序展示条目。
data.output.orderedElements[]object父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。字段与表格的有序展示条目。
data.output.orderedElements[].typestring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。模板显示顺序：type为key/table，name对应字段/表名，columnOrder指定列顺序。
data.output.orderedElements[].namestring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。对象或模板名称，业务内容保持原语言。
data.output.orderedElements[].valuestring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。此普通字段的业务值，保持原JSON类型。
data.output.orderedElements[].columnsarray父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。解析元素的图片、分类、表格或跨页关系等业务属性；按实际返回保留，不按白名单误删。
data.output.orderedElements[].columns[]string父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。解析元素的图片、分类、表格或跨页关系等业务属性；按实际返回保留，不按白名单误删。
data.output.orderedElements[].rowsarray父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。解析元素的图片、分类、表格或跨页关系等业务属性；按实际返回保留，不按白名单误删。
data.output.orderedElements[].rows[]object父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。解析元素的图片、分类、表格或跨页关系等业务属性；按实际返回保留，不按白名单误删。
data.output.orderedElements[].rows[].namestring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。对象或模板名称，业务内容保持原语言。
data.output.orderedElements[].rows[].qtyinteger父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。示例模板的业务字段/列名；实际键由模板决定，值保持原JSON类型。
data.output.pagesarray父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。在consumption下是页数；在结果下是页面数组，含分页字段/表格或解析页信息。
data.output.pages[]object父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。在consumption下是页数；在结果下是页面数组，含分页字段/表格或解析页信息。
data.output.pages[].pageinteger父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。列表中page为页码；结果中为逻辑页号及页键，sourcePageKey保留原键。
data.output.pages[].pageKeystring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。列表中page为页码；结果中为逻辑页号及页键，sourcePageKey保留原键。
data.output.pages[].sourcePageKeystring | null父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。列表中page为页码；结果中为逻辑页号及页键，sourcePageKey保留原键。
data.output.pages[].tableBboxesobject | null父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。页面尺寸、分辨率或定位坐标，保持原单位和数值。
data.output.pages[].fieldsobject父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。普通字段名到业务值的映射；评分对象中则是字段路径到评分项的映射。
data.output.pages[].fields.invoice_numberstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。示例模板的业务字段/列名；实际键由模板决定，值保持原JSON类型。
data.output.pages[].fields.invoice_totalstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。示例模板的业务字段/列名；实际键由模板决定，值保持原JSON类型。
data.output.pages[].tablesobject父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。表名到行数组的映射，行内键为业务列名。
data.output.pages[].tables.Itemsarray父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。示例模板的业务字段/列名；实际键由模板决定，值保持原JSON类型。
data.output.pages[].tables.Items[]object父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。示例模板的业务字段/列名；实际键由模板决定，值保持原JSON类型。
data.output.pages[].tables.Items[].namestring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。对象或模板名称，业务内容保持原语言。
data.output.pages[].tables.Items[].qtyinteger父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。示例模板的业务字段/列名；实际键由模板决定，值保持原JSON类型。
data.output.pages[].orderedElementsarray父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。字段与表格的有序展示条目。
data.output.pages[].orderedElements[]object父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。字段与表格的有序展示条目。
data.output.pages[].orderedElements[].typestring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。模板显示顺序：type为key/table，name对应字段/表名，columnOrder指定列顺序。
data.output.pages[].orderedElements[].namestring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。对象或模板名称，业务内容保持原语言。
data.output.pages[].orderedElements[].valuestring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。此普通字段的业务值，保持原JSON类型。
data.output.pages[].orderedElements[].columnsarray父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。解析元素的图片、分类、表格或跨页关系等业务属性；按实际返回保留，不按白名单误删。
data.output.pages[].orderedElements[].columns[]string父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。解析元素的图片、分类、表格或跨页关系等业务属性；按实际返回保留，不按白名单误删。
data.output.pages[].orderedElements[].rowsarray父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。解析元素的图片、分类、表格或跨页关系等业务属性；按实际返回保留，不按白名单误删。
data.output.pages[].orderedElements[].rows[]object父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。解析元素的图片、分类、表格或跨页关系等业务属性；按实际返回保留，不按白名单误删。
data.output.pages[].orderedElements[].rows[].namestring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。对象或模板名称，业务内容保持原语言。
data.output.pages[].orderedElements[].rows[].qtyinteger父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。示例模板的业务字段/列名；实际键由模板决定，值保持原JSON类型。
data.layoutOutputstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。兼容解析结果JSON字符串；需要再解析一次，不能当作object直接使用。
data.apiVersionstring父对象存在时；可选投影见条件v2 / v3父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。本响应采用的解析版本v2/v3，与根解析文档的api_version命名不同。
data.fieldExceptionsstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。兼容校验异常JSON字符串。
data.updatedFieldsarray父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。本次保存涉及的抽取字段名称列表；不是完整变更审计。
data.updatedFields[]string父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。本次保存涉及的抽取字段名称列表；不是完整变更审计。
data.extractionResultobject父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。抽取结果。output保留兼容形态；extractionResult为结构化字段、表格、排序与分页视图。
data.extractionResult.resultFormatstring | null父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。选择统一抽取视图时为unified；旧视图可不返回。
data.extractionResult.fieldsobject父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。普通字段名到业务值的映射；评分对象中则是字段路径到评分项的映射。
data.extractionResult.fields.invoice_numberstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。示例模板的业务字段/列名；实际键由模板决定，值保持原JSON类型。
data.extractionResult.fields.invoice_totalstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。示例模板的业务字段/列名；实际键由模板决定，值保持原JSON类型。
data.extractionResult.tablesobject父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。表名到行数组的映射，行内键为业务列名。
data.extractionResult.tables.Itemsarray父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。示例模板的业务字段/列名；实际键由模板决定，值保持原JSON类型。
data.extractionResult.tables.Items[]object父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。示例模板的业务字段/列名；实际键由模板决定，值保持原JSON类型。
data.extractionResult.tables.Items[].namestring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。对象或模板名称，业务内容保持原语言。
data.extractionResult.tables.Items[].qtyinteger父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。示例模板的业务字段/列名；实际键由模板决定，值保持原JSON类型。
data.extractionResult.orderedElementsarray父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。字段与表格的有序展示条目。
data.extractionResult.orderedElements[]object父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。字段与表格的有序展示条目。
data.extractionResult.orderedElements[].typestring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。模板显示顺序：type为key/table，name对应字段/表名，columnOrder指定列顺序。
data.extractionResult.orderedElements[].namestring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。对象或模板名称，业务内容保持原语言。
data.extractionResult.orderedElements[].valuestring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。此普通字段的业务值，保持原JSON类型。
data.extractionResult.orderedElements[].columnsarray父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。解析元素的图片、分类、表格或跨页关系等业务属性；按实际返回保留，不按白名单误删。
data.extractionResult.orderedElements[].columns[]string父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。解析元素的图片、分类、表格或跨页关系等业务属性；按实际返回保留，不按白名单误删。
data.extractionResult.orderedElements[].rowsarray父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。解析元素的图片、分类、表格或跨页关系等业务属性；按实际返回保留，不按白名单误删。
data.extractionResult.orderedElements[].rows[]object父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。解析元素的图片、分类、表格或跨页关系等业务属性；按实际返回保留，不按白名单误删。
data.extractionResult.orderedElements[].rows[].namestring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。对象或模板名称，业务内容保持原语言。
data.extractionResult.orderedElements[].rows[].qtyinteger父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。示例模板的业务字段/列名；实际键由模板决定，值保持原JSON类型。
data.extractionResult.pagesarray父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。在consumption下是页数；在结果下是页面数组，含分页字段/表格或解析页信息。
data.extractionResult.pages[]object父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。在consumption下是页数；在结果下是页面数组，含分页字段/表格或解析页信息。
data.extractionResult.pages[].pageinteger父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。列表中page为页码；结果中为逻辑页号及页键，sourcePageKey保留原键。
data.extractionResult.pages[].pageKeystring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。列表中page为页码；结果中为逻辑页号及页键，sourcePageKey保留原键。
data.extractionResult.pages[].sourcePageKeystring | null父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。列表中page为页码；结果中为逻辑页号及页键，sourcePageKey保留原键。
data.extractionResult.pages[].tableBboxesobject | null父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。页面尺寸、分辨率或定位坐标，保持原单位和数值。
data.extractionResult.pages[].fieldsobject父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。普通字段名到业务值的映射；评分对象中则是字段路径到评分项的映射。
data.extractionResult.pages[].fields.invoice_numberstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。示例模板的业务字段/列名；实际键由模板决定，值保持原JSON类型。
data.extractionResult.pages[].fields.invoice_totalstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。示例模板的业务字段/列名；实际键由模板决定，值保持原JSON类型。
data.extractionResult.pages[].tablesobject父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。表名到行数组的映射，行内键为业务列名。
data.extractionResult.pages[].tables.Itemsarray父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。示例模板的业务字段/列名；实际键由模板决定，值保持原JSON类型。
data.extractionResult.pages[].tables.Items[]object父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。示例模板的业务字段/列名；实际键由模板决定，值保持原JSON类型。
data.extractionResult.pages[].tables.Items[].namestring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。对象或模板名称，业务内容保持原语言。
data.extractionResult.pages[].tables.Items[].qtyinteger父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。示例模板的业务字段/列名；实际键由模板决定，值保持原JSON类型。
data.extractionResult.pages[].orderedElementsarray父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。字段与表格的有序展示条目。
data.extractionResult.pages[].orderedElements[]object父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。字段与表格的有序展示条目。
data.extractionResult.pages[].orderedElements[].typestring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。模板显示顺序：type为key/table，name对应字段/表名，columnOrder指定列顺序。
data.extractionResult.pages[].orderedElements[].namestring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。对象或模板名称，业务内容保持原语言。
data.extractionResult.pages[].orderedElements[].valuestring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。此普通字段的业务值，保持原JSON类型。
data.extractionResult.pages[].orderedElements[].columnsarray父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。解析元素的图片、分类、表格或跨页关系等业务属性；按实际返回保留，不按白名单误删。
data.extractionResult.pages[].orderedElements[].columns[]string父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。解析元素的图片、分类、表格或跨页关系等业务属性；按实际返回保留，不按白名单误删。
data.extractionResult.pages[].orderedElements[].rowsarray父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。解析元素的图片、分类、表格或跨页关系等业务属性；按实际返回保留，不按白名单误删。
data.extractionResult.pages[].orderedElements[].rows[]object父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。解析元素的图片、分类、表格或跨页关系等业务属性；按实际返回保留，不按白名单误删。
data.extractionResult.pages[].orderedElements[].rows[].namestring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。对象或模板名称，业务内容保持原语言。
data.extractionResult.pages[].orderedElements[].rows[].qtyinteger父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。示例模板的业务字段/列名；实际键由模板决定，值保持原JSON类型。
data.parsingResultobject父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。同一公共解析文档的兼容对象字段；无归档/读取失败时可为空。
data.parsingResult.api_versionstring父对象存在时；可选投影见条件v2 / v3父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。解析文档版本标记；v3编辑应保留此标记。
data.parsingResult.resultobject父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。解析文档正文包装；历史无此层时文档自身为正文。
data.parsingResult.result.pagesarray父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。在consumption下是页数；在结果下是页面数组，含分页字段/表格或解析页信息。
data.parsingResult.result.pages[]object父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。在consumption下是页数；在结果下是页面数组，含分页字段/表格或解析页信息。
data.parsingResult.result.pages[].page_idinteger父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。页面/元素/模型引用标识。编辑以page_id+element_id为准，paragraph_id兼容且须一致；不重排block_id。
data.parsingResult.result.pages[].page_numberinteger父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。页面/元素/模型引用标识。编辑以page_id+element_id为准，paragraph_id兼容且须一致；不重排block_id。
data.parsingResult.result.pages[].widthinteger父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。页面尺寸、分辨率或定位坐标，保持原单位和数值。
data.parsingResult.result.pages[].heightinteger父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。页面尺寸、分辨率或定位坐标，保持原单位和数值。
data.parsingResult.result.pages[].dpiinteger父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。页面尺寸、分辨率或定位坐标，保持原单位和数值。
data.parsingResult.result.detailarray父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。该对象提供的业务扩展属性；保留原字段和类型，不视为新的接口。
data.parsingResult.result.detail[]object父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。该对象提供的业务扩展属性；保留原字段和类型，不视为新的接口。
data.parsingResult.result.detail[].page_idinteger父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。页面/元素/模型引用标识。编辑以page_id+element_id为准，paragraph_id兼容且须一致；不重排block_id。
data.parsingResult.result.detail[].element_idinteger父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。页面/元素/模型引用标识。编辑以page_id+element_id为准，paragraph_id兼容且须一致；不重排block_id。
data.parsingResult.result.detail[].paragraph_idinteger父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。页面/元素/模型引用标识。编辑以page_id+element_id为准，paragraph_id兼容且须一致；不重排block_id。
data.parsingResult.result.detail[].block_idstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。页面/元素/模型引用标识。编辑以page_id+element_id为准，paragraph_id兼容且须一致；不重排block_id。
data.parsingResult.result.detail[].typestring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。解析元素类型，例如text/table/image；保持原业务类型。
data.parsingResult.result.detail[].textstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。解析业务内容；文本以text为编辑权威，表格保留完整结构。
data.parsingResult.result.detail[].positionarray父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。页面尺寸、分辨率或定位坐标，保持原单位和数值。
data.parsingResult.result.detail[].position[]integer父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。页面尺寸、分辨率或定位坐标，保持原单位和数值。
data.parseResultobject父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。同一公共解析文档的兼容对象字段；无归档/读取失败时可为空。
data.parseResult.api_versionstring父对象存在时；可选投影见条件v2 / v3父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。解析文档版本标记；v3编辑应保留此标记。
data.parseResult.resultobject父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。解析文档正文包装；历史无此层时文档自身为正文。
data.parseResult.result.pagesarray父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。在consumption下是页数；在结果下是页面数组，含分页字段/表格或解析页信息。
data.parseResult.result.pages[]object父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。在consumption下是页数；在结果下是页面数组，含分页字段/表格或解析页信息。
data.parseResult.result.pages[].page_idinteger父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。页面/元素/模型引用标识。编辑以page_id+element_id为准，paragraph_id兼容且须一致；不重排block_id。
data.parseResult.result.pages[].page_numberinteger父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。页面/元素/模型引用标识。编辑以page_id+element_id为准，paragraph_id兼容且须一致；不重排block_id。
data.parseResult.result.pages[].widthinteger父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。页面尺寸、分辨率或定位坐标，保持原单位和数值。
data.parseResult.result.pages[].heightinteger父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。页面尺寸、分辨率或定位坐标，保持原单位和数值。
data.parseResult.result.pages[].dpiinteger父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。页面尺寸、分辨率或定位坐标，保持原单位和数值。
data.parseResult.result.detailarray父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。该对象提供的业务扩展属性；保留原字段和类型，不视为新的接口。
data.parseResult.result.detail[]object父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。该对象提供的业务扩展属性；保留原字段和类型，不视为新的接口。
data.parseResult.result.detail[].page_idinteger父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。页面/元素/模型引用标识。编辑以page_id+element_id为准，paragraph_id兼容且须一致；不重排block_id。
data.parseResult.result.detail[].element_idinteger父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。页面/元素/模型引用标识。编辑以page_id+element_id为准，paragraph_id兼容且须一致；不重排block_id。
data.parseResult.result.detail[].paragraph_idinteger父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。页面/元素/模型引用标识。编辑以page_id+element_id为准，paragraph_id兼容且须一致；不重排block_id。
data.parseResult.result.detail[].block_idstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。页面/元素/模型引用标识。编辑以page_id+element_id为准，paragraph_id兼容且须一致；不重排block_id。
data.parseResult.result.detail[].typestring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。解析元素类型，例如text/table/image；保持原业务类型。
data.parseResult.result.detail[].textstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。解析业务内容；文本以text为编辑权威，表格保留完整结构。
data.parseResult.result.detail[].positionarray父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。页面尺寸、分辨率或定位坐标，保持原单位和数值。
data.parseResult.result.detail[].position[]integer父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。页面尺寸、分辨率或定位坐标，保持原单位和数值。
data.parseResultStatusstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。available可用、not_available无归档、read_failed读取失败。
data.fieldExceptionDetailsarray父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。结构化字段异常明细；条目由具体校验结果决定。
data.scoreobject父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。兼容评分对象：状态、总分、风险和字段映射；缺失时不伪造0分。
data.score.statusstring父对象存在时；可选投影见条件pending / complete / failed / missing父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。评分状态，不是任务处理状态；missing可表示未启用评分。
data.score.fileScoreinteger父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。整体评分，当前公共视图通常为1–100；仅完成评分时有值。
data.score.riskstring父对象存在时；可选投影见条件low / medium / high父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。模型提供的风险级别low/medium/high，不由调用方从分数自行推导。
data.score.fieldsobject父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。字段路径到评分详情的对象映射；键可能包含点号，按完整键使用。
data.score.fields[<fieldPath>]object父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。示例模板的业务字段/列名；实际键由模板决定，值保持原JSON类型。
data.score.fields[<fieldPath>].scoreinteger父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。该字段归一化后的数值评分，通常1–100；不是评分对象。
data.score.fields[<fieldPath>].riskstring父对象存在时；可选投影见条件low / medium / high父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。模型提供的风险级别low/medium/high，不由调用方从分数自行推导。
data.score.fields[<fieldPath>].reasonsarray父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。该评分项的原因列表，可为空。
data.score.fields[<fieldPath>].reasons[]string父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。总分1–100、风险low/medium/high、原因或扣分说明；不要将缺失评分当0。
data.confidenceobject父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。任务中为兼容新增的评分展示对象；分类结果中是可能为空的数值置信度。
data.confidence.statusstring父对象存在时；可选投影见条件pending / complete / failed / missing父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。评分状态，不是任务处理状态；missing可表示未启用评分。
data.confidence.fileScoreinteger父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。整体评分，当前公共视图通常为1–100；仅完成评分时有值。
data.confidence.riskstring父对象存在时；可选投影见条件low / medium / high父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。模型提供的风险级别low/medium/high，不由调用方从分数自行推导。
data.confidence.fieldsarray父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。字段评分展示数组；与score.fields对象映射并存。
data.confidence.fields[]object父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。普通字段名到业务值的映射；评分对象中则是字段路径到评分项的映射。
data.confidence.fields[].namestring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。评分项的字段路径名称，例如Page-1.invoice_number。
data.confidence.fields[].scoreinteger父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。该字段归一化后的数值评分，通常1–100；不是评分对象。
data.confidence.fields[].riskstring父对象存在时；可选投影见条件low / medium / high父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。模型提供的风险级别low/medium/high，不由调用方从分数自行推导。
data.confidence.fields[].deductionsarray父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。评分展示数组中的扣分说明列表。
data.confidence.fields[].deductions[]string父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。总分1–100、风险low/medium/high、原因或扣分说明；不要将缺失评分当0。
data.inputobject父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。任务输入摘要；可用来确认实际模式和模板。
data.input.fileIdstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。文件标识；业务任务中通常与taskId相同，样本文件则不同。
data.input.templateIdstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。关联模板标识；自动分类完成前可能为空。
data.input.groupTemplateIdstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。模板分组关联标识，不等同templateId。
data.input.templateNamestring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。对象或模板名称，业务内容保持原语言。
data.input.modestring父对象存在时；可选投影见条件VisualExtract / LayoutExtract父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。本次处理模式：VisualExtract或LayoutExtract。
data.consumptionobject父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。当前任务的资源使用信息。
data.consumption.pagesinteger父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。在consumption下是页数；在结果下是页面数组，含分页字段/表格或解析页信息。
data.originalFileobject父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。原文件信息及现有链接字段。
data.originalFile.sourceFileNamestring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。文件名；sourceFileName为原始来源名。
data.originalFile.fileNamestring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。文件名；sourceFileName为原始来源名。
data.originalFile.contentTypestring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。文件扩展类型或MIME内容类型，按字段名称区分。
data.originalFile.normalizedPdfboolean父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。是否已规范化为PDF。
data.originalFile.previewUrlstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。资源访问链接。无可用资源时为空；访问时使用对应服务的认证方式。
data.originalFile.downloadUrlstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。资源访问链接。无可用资源时为空；访问时使用对应服务的认证方式。
data.artifactsobject父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。结果归档的可用性信息。
data.artifacts.parsingZipobject父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。对应解析ZIP、抽取JSON或整合ZIP的可用性对象。
data.artifacts.parsingZip.availableboolean父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。该归档是否存在并可供当前响应引用。
data.artifacts.parsingZip.downloadUrlstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。资源访问链接。无可用资源时为空；访问时使用对应服务的认证方式。
data.artifacts.extractionJsonobject父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。对应解析ZIP、抽取JSON或整合ZIP的可用性对象。
data.artifacts.extractionJson.availableboolean父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。该归档是否存在并可供当前响应引用。
data.artifacts.extractionJson.downloadUrlstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。资源访问链接。无可用资源时为空；访问时使用对应服务的认证方式。
data.artifacts.integratedZipobject父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。对应解析ZIP、抽取JSON或整合ZIP的可用性对象。
data.artifacts.integratedZip.availableboolean父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。该归档是否存在并可供当前响应引用。
data.artifacts.integratedZip.downloadUrlstring | null父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。资源访问链接。无可用资源时为空；访问时使用对应服务的认证方式。
data.customJsonExportboolean | null父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。是否已应用自定义JSON导出结构。
data.jsonExportErrorstring | null父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。导出结构应用失败的信息；正常时为空。
data.extractionSourceJSON | null父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。自定义导出需要时保留的原抽取结果；普通请求可为空。
data.parseResultUpdatedboolean父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。仅结果更新响应用于指示本次是否修改解析部分。
data.score.reasonstring否无服务实际提供对应诊断时评分不可用或失败的原因，例如scoring_disabled。
data.score.modelFileScoreinteger否无服务实际提供对应诊断时模型诊断分数。整体评分读取fileScore。
data.score.scoredFieldCountinteger否无服务实际提供对应诊断时模型附带的已评分字段数量；可不出现。
接口特有说明 ​
  • 前置条件：fields/tables/parse_result至少一项；可选expectedUpdateDate必须精确匹配。
  • 副作用：各提交部分整体替换，confirm默认true；不自动重新抽取。已确认须先经管理流程撤销，再GET。
  • 规则：S1, S6
适用错误 ​

E-AUTH, E-RESOURCE, E-INTERNAL, E-PARAM, E-STATE, E-VERSION

后续调用 ​

19. 获取文件分类 ​

读取文件当前分类状态及关联模板。

请求 ​
项目内容
方法GET
地址<API_BASE_URL>/api/v2/classify/{taskId}/result
鉴权X-API-Key；本租户可访问/可管理资源
Content-Type无Body，无需Content-Type
请求头 ​
字段类型必填默认枚举格式/限制业务含义/依赖示例
X-API-Keystring是；可用Bearer替代无无不放在URL或Body验证Key租户与归属<API_KEY>
路径参数 ​
字段类型必填默认枚举格式/限制业务含义/依赖示例
taskIdstring是无无—任务ID；来自上传返回taskIds。task_example
请求示例 ​

执行示例前，替换服务地址、密钥、资源ID、时间和文件。

bash
curl --request GET "<API_BASE_URL>/api/v2/classify/task_example/result" \
  --header "X-API-Key: <API_KEY>"
成功响应 ​

HTTP 200

以下为成功响应示例。字段是否有值取决于任务状态、接口版本及资源可用性；业务字段名称由模板定义。

json
{
  "code": 200,
  "message": "success",
  "data": {
    "taskId": "task_example",
    "status": "completed",
    "templateId": "template_example",
    "templateName": "Invoice Template",
    "confidence": null,
    "metadata": "{\"source\":\"api\"}"
  }
}
响应字段 ​
字段类型必返枚举出现条件含义
codeinteger是—JSON成功响应文件、任务、模板和资产接口成功码为200；提醒规则为0，均为数字。
messagestring是—JSON成功响应英文系统结果说明，通常success。
dataobject是；可为null—按任务状态、版本及资源可用性；null不等于空内容或0。本接口的数据，结构见以下字段；无返回内容时为null。
data.taskIdstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。任务标识，后续查询使用。
data.statusstring父对象存在时；可选投影见条件按对象区分，见S1/S3父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。当前对象状态；任务、样本、会话与规则的枚举不同，见S1/S2/S3。
data.templateIdstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。关联模板标识；自动分类完成前可能为空。
data.templateNamestring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。对象或模板名称，业务内容保持原语言。
data.confidencenumber | null父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。任务中为兼容新增的评分展示对象；分类结果中是可能为空的数值置信度。
data.metadatastring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。原上传的业务元数据文本；不是自动转换后的object。
接口特有说明 ​
  • 前置条件：可访问的taskId；无分类结果时模板字段可为空。
  • 副作用：只读；confidence可能为空，不能补成0。
  • 规则：S1
适用错误 ​

E-AUTH, E-RESOURCE, E-INTERNAL

后续调用 ​

4.5 提醒规则管理 ​

20. 创建提醒规则 ​

为当前租户创建提醒规则。

请求 ​
项目内容
方法POST
地址<API_BASE_URL>/api/v2/rules
鉴权X-API-Key；本租户可访问/可管理资源
Content-Typeapplication/json
请求头 ​
字段类型必填默认枚举格式/限制业务含义/依赖示例
X-API-Keystring是；可用Bearer替代无无不放在URL或Body验证Key租户与归属<API_KEY>
JSON请求体 ​
字段类型必填默认枚举格式/限制业务含义/依赖示例
namestring创建是；更新可省略无无1–50字符，当前租户内唯一规则名称；更新省略则保留。Invoice Review Rule
template_idstring创建是；更新可省略无无—关联模板ID。template_example
frequencystring创建是；更新可省略无daily每日；hourly每小时；on_extract_complete抽取完成；on_result_confirm结果确认—触发频率或事件。on_extract_complete
conditionsarray<object>创建是且非空；更新可省略无无—触发条件列表。[{"field": "score", "operator": "lt", "value": 80}]
channelsarray<string>创建是且非空；更新可省略无in_app站内；email邮件；webhook回调—通知渠道；渠道启用不等于实际投递成功。["in_app"]
recipientsobject创建是；更新可省略无无—接收人配置，详见子字段。
title_templatestring创建是；更新可省略无无1–100字符通知标题模板，可使用{file_name}等事件变量。Review
content_templatestring创建是；更新可省略无无1–500字符通知正文，使用已提供事件字段变量。Please review {file_name}.
statusstring仅更新可选；创建默认activeactiveactive启用；inactive停用—规则启停；创建时不通过此字段覆盖初始状态。inactive
conditions[].fieldstring是无无—系统字段score/review_status/processing_status，或fields.<业务字段名>。score
conditions[].operatorstring是无无—score支持eq/ne/gt/gte/lt/lte/between/not_between；状态支持eq/ne/in/not_in。lt
conditions[].valueJSON是无无—score为1–100数字；区间为两个升序数字；状态eq/ne为字符串、in/not_in为数组。80
conditions[].logicstring否ANDAND / OR—AND同时满足，OR任一满足。AND
recipients.membersarray<string>否[]无—本租户有效用户ID，去重后最多50个；不是成员关系ID。["user_example"]
recipients.emailsarray<string>否[]无—额外邮件地址，投递时验证和去重。["[email protected]"]
recipients.field_bindingsarray<string>否[]无—从事件字段读取收件邮箱，如fields.contact_email。["fields.contact_email"]
recipients.webhook_idsarray<string>channels含webhook时必填[]无—本租户已配置、启用并订阅rule_triggered事件的回调ID。["webhook_example"]
recipients.departmentsarray否[]无—部门列表不参与接收人解析。通过members、emails、field_bindings或webhook_ids配置接收人。[]
请求示例 ​

执行示例前，替换服务地址、密钥、资源ID、时间和文件。

bash
curl --request POST "<API_BASE_URL>/api/v2/rules" \
  --header "X-API-Key: <API_KEY>" \
  --header "Content-Type: application/json" \
  --data-raw '{
  "name": "Invoice Review Rule",
  "template_id": "template_example",
  "frequency": "on_extract_complete",
  "conditions": [
    {
      "field": "score",
      "operator": "lt",
      "value": 80,
      "logic": "AND"
    }
  ],
  "channels": [
    "in_app"
  ],
  "recipients": {
    "members": [
      "user_example"
    ]
  },
  "title_template": "Review {file_name}",
  "content_template": "Please review {file_name}."
}'

纯JSON Body：

json
{
  "name": "Invoice Review Rule",
  "template_id": "template_example",
  "frequency": "on_extract_complete",
  "conditions": [
    {
      "field": "score",
      "operator": "lt",
      "value": 80,
      "logic": "AND"
    }
  ],
  "channels": [
    "in_app"
  ],
  "recipients": {
    "members": [
      "user_example"
    ]
  },
  "title_template": "Review {file_name}",
  "content_template": "Please review {file_name}."
}
成功响应 ​

HTTP 201

以下为成功响应示例。字段是否有值取决于任务状态、接口版本及资源可用性；业务字段名称由模板定义。

json
{
  "code": 0,
  "message": "success",
  "data": {
    "rule_id": "rule_example",
    "name": "Invoice Review Rule",
    "status": "active",
    "created_at": "2026-10-23T08:00:00Z"
  }
}
响应字段 ​
字段类型必返枚举出现条件含义
codeinteger是—JSON成功响应文件、任务、模板和资产接口成功码为200；提醒规则为0，均为数字。
messagestring是—JSON成功响应英文系统结果说明，通常success。
dataobject是；可为null—按任务状态、版本及资源可用性；null不等于空内容或0。本接口的数据，结构见以下字段；无返回内容时为null。
data.rule_idstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。提醒规则标识。
data.namestring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。对象或模板名称，业务内容保持原语言。
data.statusstring父对象存在时；可选投影见条件active / inactive父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。当前对象状态；任务、样本、会话与规则的枚举不同，见S1/S2/S3。
data.created_atstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。规则时间戳，UTC ISO8601，带Z。
接口特有说明 ​
  • 前置条件：提供完整规则字段及合法条件/接收人；不允许指定组织身份字段。
  • 副作用：规则创建后默认active，满足触发条件时进入通知处理流程。
  • 规则：S7
适用错误 ​

E-AUTH, E-RESOURCE, E-INTERNAL, E-PARAM, E-RULE

后续调用 ​

21. 更新提醒规则 ​

部分更新当前租户的提醒规则。

请求 ​
项目内容
方法PUT
地址<API_BASE_URL>/api/v2/rules/
鉴权X-API-Key；本租户可访问/可管理资源
Content-Typeapplication/json
请求头 ​
字段类型必填默认枚举格式/限制业务含义/依赖示例
X-API-Keystring是；可用Bearer替代无无不放在URL或Body验证Key租户与归属<API_KEY>
路径参数 ​
字段类型必填默认枚举格式/限制业务含义/依赖示例
rule_idstring是无无—规则ID，来自创建或列表的rule_id。rule_example
JSON请求体 ​
字段类型必填默认枚举格式/限制业务含义/依赖示例
namestring创建是；更新可省略无无1–50字符，当前租户内唯一规则名称；更新省略则保留。Invoice Review Rule
template_idstring创建是；更新可省略无无—关联模板ID。template_example
frequencystring创建是；更新可省略无daily每日；hourly每小时；on_extract_complete抽取完成；on_result_confirm结果确认—触发频率或事件。on_extract_complete
conditionsarray<object>创建是且非空；更新可省略无无—触发条件列表。[{"field": "score", "operator": "lt", "value": 80}]
channelsarray<string>创建是且非空；更新可省略无in_app站内；email邮件；webhook回调—通知渠道；渠道启用不等于实际投递成功。["in_app"]
recipientsobject创建是；更新可省略无无—接收人配置，详见子字段。
title_templatestring创建是；更新可省略无无1–100字符通知标题模板，可使用{file_name}等事件变量。Review
content_templatestring创建是；更新可省略无无1–500字符通知正文，使用已提供事件字段变量。Please review {file_name}.
statusstring仅更新可选；创建默认activeactiveactive启用；inactive停用—规则启停；创建时不通过此字段覆盖初始状态。inactive
conditions[].fieldstring是无无—系统字段score/review_status/processing_status，或fields.<业务字段名>。score
conditions[].operatorstring是无无—score支持eq/ne/gt/gte/lt/lte/between/not_between；状态支持eq/ne/in/not_in。lt
conditions[].valueJSON是无无—score为1–100数字；区间为两个升序数字；状态eq/ne为字符串、in/not_in为数组。80
conditions[].logicstring否ANDAND / OR—AND同时满足，OR任一满足。AND
recipients.membersarray<string>否[]无—本租户有效用户ID，去重后最多50个；不是成员关系ID。["user_example"]
recipients.emailsarray<string>否[]无—额外邮件地址，投递时验证和去重。["[email protected]"]
recipients.field_bindingsarray<string>否[]无—从事件字段读取收件邮箱，如fields.contact_email。["fields.contact_email"]
recipients.webhook_idsarray<string>channels含webhook时必填[]无—本租户已配置、启用并订阅rule_triggered事件的回调ID。["webhook_example"]
recipients.departmentsarray否[]无—部门列表不参与接收人解析。通过members、emails、field_bindings或webhook_ids配置接收人。[]
请求示例 ​

执行示例前，替换服务地址、密钥、资源ID、时间和文件。

bash
curl --request PUT "<API_BASE_URL>/api/v2/rules/rule_example" \
  --header "X-API-Key: <API_KEY>" \
  --header "Content-Type: application/json" \
  --data-raw '{
  "name": "Invoice Review Rule - Priority",
  "conditions": [
    {
      "field": "score",
      "operator": "lt",
      "value": 70,
      "logic": "AND"
    }
  ]
}'

纯JSON Body：

json
{
  "name": "Invoice Review Rule - Priority",
  "conditions": [
    {
      "field": "score",
      "operator": "lt",
      "value": 70,
      "logic": "AND"
    }
  ]
}
成功响应 ​

HTTP 200

以下为成功响应示例。字段是否有值取决于任务状态、接口版本及资源可用性；业务字段名称由模板定义。

json
{
  "code": 0,
  "message": "success",
  "data": {
    "rule_id": "rule_example",
    "name": "Invoice Review Rule - Priority",
    "template_id": "template_example",
    "status": "active",
    "channels": [
      "in_app"
    ],
    "frequency": "on_extract_complete",
    "created_at": "2026-10-23T08:00:00Z",
    "updated_at": "2026-10-23T08:00:00Z",
    "conditions": [
      {
        "field": "score",
        "operator": "lt",
        "value": 70,
        "logic": "AND"
      }
    ],
    "recipients": {
      "members": [
        "user_example"
      ],
      "departments": [],
      "emails": [],
      "field_bindings": [],
      "webhook_ids": []
    },
    "title_template": "Review {file_name}",
    "content_template": "Please review {file_name}."
  }
}
响应字段 ​
字段类型必返枚举出现条件含义
codeinteger是—JSON成功响应文件、任务、模板和资产接口成功码为200；提醒规则为0，均为数字。
messagestring是—JSON成功响应英文系统结果说明，通常success。
dataobject是；可为null—按任务状态、版本及资源可用性；null不等于空内容或0。本接口的数据，结构见以下字段；无返回内容时为null。
data.rule_idstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。提醒规则标识。
data.namestring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。对象或模板名称，业务内容保持原语言。
data.template_idstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。关联模板标识；自动分类完成前可能为空。
data.statusstring父对象存在时；可选投影见条件active / inactive父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。当前对象状态；任务、样本、会话与规则的枚举不同，见S1/S2/S3。
data.channelsarray父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。通知渠道或触发频率/事件，枚举见请求说明。
data.channels[]string父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。通知渠道或触发频率/事件，枚举见请求说明。
data.frequencystring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。通知渠道或触发频率/事件，枚举见请求说明。
data.created_atstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。规则时间戳，UTC ISO8601，带Z。
data.updated_atstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。规则时间戳，UTC ISO8601，带Z。
data.conditionsarray父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。保存后的触发条件、接收人或通知模板；列表摘要不返回完整配置。
data.conditions[]object父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。保存后的触发条件、接收人或通知模板；列表摘要不返回完整配置。
data.conditions[].fieldstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。条件检查的事件字段路径。
data.conditions[].operatorstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。条件比较运算符，允许值依字段类型而定。
data.conditions[].valueinteger父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。规则条件字段、比较符、比较值与AND/OR逻辑；value在业务结果中表示字段值。
data.conditions[].logicstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。条件组合逻辑AND或OR。
data.recipientsobject父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。保存后的触发条件、接收人或通知模板；列表摘要不返回完整配置。
data.recipients.membersarray父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。规范化接收人配置；departments目前为空数组。
data.recipients.members[]string父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。规范化接收人配置；departments目前为空数组。
data.recipients.departmentsarray父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。规范化接收人配置；departments目前为空数组。
data.recipients.emailsarray父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。规范化接收人配置；departments目前为空数组。
data.recipients.field_bindingsarray父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。规范化接收人配置；departments目前为空数组。
data.recipients.webhook_idsarray父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。规范化接收人配置；departments目前为空数组。
data.title_templatestring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。保存后的触发条件、接收人或通知模板；列表摘要不返回完整配置。
data.content_templatestring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。保存后的触发条件、接收人或通知模板；列表摘要不返回完整配置。
接口特有说明 ​
  • 前置条件：规则可访问；省略字段保留，但合并后的完整配置仍重新校验。
  • 副作用：保存修改并清除该规则的既有触发去重记录，开启新的去重周期。
  • 规则：S7
适用错误 ​

E-AUTH, E-RESOURCE, E-INTERNAL, E-PARAM, E-RULE

后续调用 ​

22. 获取提醒规则列表 ​

列出当前租户的提醒规则摘要。

请求 ​
项目内容
方法GET
地址<API_BASE_URL>/api/v2/rules
鉴权X-API-Key；本租户可访问/可管理资源
Content-Type无Body，无需Content-Type
请求头 ​
字段类型必填默认枚举格式/限制业务含义/依赖示例
X-API-Keystring是；可用Bearer替代无无不放在URL或Body验证Key租户与归属<API_KEY>
查询参数 ​
字段类型必填默认枚举格式/限制业务含义/依赖示例
statusstring否全部active / inactive—规则启停筛选；无分页参数。active
请求示例 ​

执行示例前，替换服务地址、密钥、资源ID、时间和文件。

bash
curl --request GET "<API_BASE_URL>/api/v2/rules" \
  --header "X-API-Key: <API_KEY>"
成功响应 ​

HTTP 200

以下为成功响应示例。字段是否有值取决于任务状态、接口版本及资源可用性；业务字段名称由模板定义。

json
{
  "code": 0,
  "message": "success",
  "data": [
    {
      "rule_id": "rule_example",
      "name": "Invoice Review Rule",
      "template_id": "template_example",
      "status": "active",
      "channels": [
        "in_app"
      ],
      "frequency": "on_extract_complete",
      "created_at": "2026-10-23T08:00:00Z",
      "updated_at": "2026-10-23T08:00:00Z"
    }
  ]
}
响应字段 ​
字段类型必返枚举出现条件含义
codeinteger是—JSON成功响应文件、任务、模板和资产接口成功码为200；提醒规则为0，均为数字。
messagestring是—JSON成功响应英文系统结果说明，通常success。
dataarray是；可为null—按任务状态、版本及资源可用性；null不等于空内容或0。本接口的数据，结构见以下字段；无返回内容时为null。
data[]object父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。该对象提供的业务扩展属性；保留原字段和类型，不视为新的接口。
data[].rule_idstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。提醒规则标识。
data[].namestring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。对象或模板名称，业务内容保持原语言。
data[].template_idstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。关联模板标识；自动分类完成前可能为空。
data[].statusstring父对象存在时；可选投影见条件active / inactive父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。当前对象状态；任务、样本、会话与规则的枚举不同，见S1/S2/S3。
data[].channelsarray父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。通知渠道或触发频率/事件，枚举见请求说明。
data[].channels[]string父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。通知渠道或触发频率/事件，枚举见请求说明。
data[].frequencystring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。通知渠道或触发频率/事件，枚举见请求说明。
data[].created_atstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。规则时间戳，UTC ISO8601，带Z。
data[].updated_atstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。规则时间戳，UTC ISO8601，带Z。
接口特有说明 ​
  • 前置条件：只支持可选status筛选，无分页/排序参数。
  • 副作用：只读；列表不返回conditions/recipients/标题正文等完整配置，详情用R04。
  • 规则：S7
适用错误 ​

E-AUTH, E-RESOURCE, E-INTERNAL, E-RULE

后续调用 ​

23. 获取提醒规则详情 ​

获取一条可访问提醒规则的完整配置。

请求 ​
项目内容
方法GET
地址<API_BASE_URL>/api/v2/rules/
鉴权X-API-Key；本租户可访问/可管理资源
Content-Type无Body，无需Content-Type
请求头 ​
字段类型必填默认枚举格式/限制业务含义/依赖示例
X-API-Keystring是；可用Bearer替代无无不放在URL或Body验证Key租户与归属<API_KEY>
路径参数 ​
字段类型必填默认枚举格式/限制业务含义/依赖示例
rule_idstring是无无—规则ID，来自创建或列表的rule_id。rule_example
请求示例 ​

执行示例前，替换服务地址、密钥、资源ID、时间和文件。

bash
curl --request GET "<API_BASE_URL>/api/v2/rules/rule_example" \
  --header "X-API-Key: <API_KEY>"
成功响应 ​

HTTP 200

以下为成功响应示例。字段是否有值取决于任务状态、接口版本及资源可用性；业务字段名称由模板定义。

json
{
  "code": 0,
  "message": "success",
  "data": {
    "rule_id": "rule_example",
    "name": "Invoice Review Rule",
    "template_id": "template_example",
    "status": "active",
    "channels": [
      "in_app"
    ],
    "frequency": "on_extract_complete",
    "created_at": "2026-10-23T08:00:00Z",
    "updated_at": "2026-10-23T08:00:00Z",
    "conditions": [
      {
        "field": "score",
        "operator": "lt",
        "value": 80,
        "logic": "AND"
      }
    ],
    "recipients": {
      "members": [
        "user_example"
      ],
      "departments": [],
      "emails": [],
      "field_bindings": [],
      "webhook_ids": []
    },
    "title_template": "Review {file_name}",
    "content_template": "Please review {file_name}."
  }
}
响应字段 ​
字段类型必返枚举出现条件含义
codeinteger是—JSON成功响应文件、任务、模板和资产接口成功码为200；提醒规则为0，均为数字。
messagestring是—JSON成功响应英文系统结果说明，通常success。
dataobject是；可为null—按任务状态、版本及资源可用性；null不等于空内容或0。本接口的数据，结构见以下字段；无返回内容时为null。
data.rule_idstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。提醒规则标识。
data.namestring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。对象或模板名称，业务内容保持原语言。
data.template_idstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。关联模板标识；自动分类完成前可能为空。
data.statusstring父对象存在时；可选投影见条件active / inactive父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。当前对象状态；任务、样本、会话与规则的枚举不同，见S1/S2/S3。
data.channelsarray父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。通知渠道或触发频率/事件，枚举见请求说明。
data.channels[]string父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。通知渠道或触发频率/事件，枚举见请求说明。
data.frequencystring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。通知渠道或触发频率/事件，枚举见请求说明。
data.created_atstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。规则时间戳，UTC ISO8601，带Z。
data.updated_atstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。规则时间戳，UTC ISO8601，带Z。
data.conditionsarray父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。保存后的触发条件、接收人或通知模板；列表摘要不返回完整配置。
data.conditions[]object父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。保存后的触发条件、接收人或通知模板；列表摘要不返回完整配置。
data.conditions[].fieldstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。条件检查的事件字段路径。
data.conditions[].operatorstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。条件比较运算符，允许值依字段类型而定。
data.conditions[].valueinteger父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。规则条件字段、比较符、比较值与AND/OR逻辑；value在业务结果中表示字段值。
data.conditions[].logicstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。条件组合逻辑AND或OR。
data.recipientsobject父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。保存后的触发条件、接收人或通知模板；列表摘要不返回完整配置。
data.recipients.membersarray父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。规范化接收人配置；departments目前为空数组。
data.recipients.members[]string父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。规范化接收人配置；departments目前为空数组。
data.recipients.departmentsarray父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。规范化接收人配置；departments目前为空数组。
data.recipients.emailsarray父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。规范化接收人配置；departments目前为空数组。
data.recipients.field_bindingsarray父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。规范化接收人配置；departments目前为空数组。
data.recipients.webhook_idsarray父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。规范化接收人配置；departments目前为空数组。
data.title_templatestring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。保存后的触发条件、接收人或通知模板；列表摘要不返回完整配置。
data.content_templatestring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。保存后的触发条件、接收人或通知模板；列表摘要不返回完整配置。
接口特有说明 ​
  • 前置条件：rule_id来自规则创建或列表。
  • 副作用：只读，不触发通知或重置去重记录。
  • 规则：S7
适用错误 ​

E-AUTH, E-RESOURCE, E-INTERNAL, E-RULE

后续调用 ​

24. 启停提醒规则 ​

启用或停用一条提醒规则。

请求 ​
项目内容
方法PATCH
地址<API_BASE_URL>/api/v2/rules/{rule_id}/status
鉴权X-API-Key；本租户可访问/可管理资源
Content-Typeapplication/json
请求头 ​
字段类型必填默认枚举格式/限制业务含义/依赖示例
X-API-Keystring是；可用Bearer替代无无不放在URL或Body验证Key租户与归属<API_KEY>
路径参数 ​
字段类型必填默认枚举格式/限制业务含义/依赖示例
rule_idstring是无无—规则ID，来自创建或列表的rule_id。rule_example
JSON请求体 ​
字段类型必填默认枚举格式/限制业务含义/依赖示例
statusstring是无active启用；inactive停用—规则状态不是模板的数字0/1。inactive
请求示例 ​

执行示例前，替换服务地址、密钥、资源ID、时间和文件。

bash
curl --request PATCH "<API_BASE_URL>/api/v2/rules/rule_example/status" \
  --header "X-API-Key: <API_KEY>" \
  --header "Content-Type: application/json" \
  --data-raw '{
  "status": "inactive"
}'

纯JSON Body：

json
{
  "status": "inactive"
}
成功响应 ​

HTTP 200

以下为成功响应示例。字段是否有值取决于任务状态、接口版本及资源可用性；业务字段名称由模板定义。

json
{
  "code": 0,
  "message": "success",
  "data": {
    "rule_id": "rule_example",
    "status": "inactive"
  }
}
响应字段 ​
字段类型必返枚举出现条件含义
codeinteger是—JSON成功响应文件、任务、模板和资产接口成功码为200；提醒规则为0，均为数字。
messagestring是—JSON成功响应英文系统结果说明，通常success。
dataobject是；可为null—按任务状态、版本及资源可用性；null不等于空内容或0。本接口的数据，结构见以下字段；无返回内容时为null。
data.rule_idstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。提醒规则标识。
data.statusstring父对象存在时；可选投影见条件active / inactive父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。当前对象状态；任务、样本、会话与规则的枚举不同，见S1/S2/S3。
接口特有说明 ​
  • 前置条件：规则可访问；status为active或inactive。
  • 副作用：更新规则启用状态。已发送的通知保持不变，通知投递状态独立于规则状态。
  • 规则：S7
适用错误 ​

E-AUTH, E-RESOURCE, E-INTERNAL, E-PARAM, E-RULE

后续调用 ​

25. 删除提醒规则 ​

删除当前租户的一条提醒规则。

请求 ​
项目内容
方法DELETE
地址<API_BASE_URL>/api/v2/rules/
鉴权X-API-Key；本租户可访问/可管理资源
Content-Type无Body，无需Content-Type
请求头 ​
字段类型必填默认枚举格式/限制业务含义/依赖示例
X-API-Keystring是；可用Bearer替代无无不放在URL或Body验证Key租户与归属<API_KEY>
路径参数 ​
字段类型必填默认枚举格式/限制业务含义/依赖示例
rule_idstring是无无—规则ID，来自创建或列表的rule_id。rule_example
请求示例 ​

执行示例前，替换服务地址、密钥、资源ID、时间和文件。

bash
curl --request DELETE "<API_BASE_URL>/api/v2/rules/rule_example" \
  --header "X-API-Key: <API_KEY>"
成功响应 ​

HTTP 204

成功且无响应体；不要解析JSON或读取code。

接口特有说明 ​
  • 前置条件：规则须存在且可访问。
  • 副作用：成功返回204无Body；不撤回已发送通知。再次删除已不存在规则可能404。
  • 规则：S7
适用错误 ​

E-AUTH, E-RESOURCE, E-INTERNAL, E-PARAM, E-RULE

后续调用 ​

4.6 资产管理 ​

26. 获取资产信息 ​

查询当前Key组织的资产和产品额度面板。

请求 ​
项目内容
方法GET
地址<API_BASE_URL>/api/v2/assets
鉴权X-API-Key；本租户可访问/可管理资源
Content-Type无Body，无需Content-Type
请求头 ​
字段类型必填默认枚举格式/限制业务含义/依赖示例
X-API-Keystring是；可用Bearer替代无无不放在URL或Body验证Key租户与归属<API_KEY>
请求示例 ​

执行示例前，替换服务地址、密钥、资源ID、时间和文件。

bash
curl --request GET "<API_BASE_URL>/api/v2/assets" \
  --header "X-API-Key: <API_KEY>"
成功响应 ​

HTTP 200

以下为成功响应示例。字段是否有值取决于任务状态、接口版本及资源可用性；业务字段名称由模板定义。

json
{
  "code": 200,
  "message": "success",
  "data": {
    "asset": 900,
    "assetTypeName": null,
    "overageTime": null,
    "assetTotal": 1000,
    "user": {
      "avatar": null,
      "username": "Example User",
      "email": "[email protected]"
    },
    "accountType": null,
    "accountTypeName": null,
    "expireTime": null,
    "showExpireTime": false,
    "showAssetEntry": true,
    "products": [
      {
        "productType": "EXTRACT",
        "productName": "Document extraction",
        "unit": "PAGE",
        "unitName": "pages",
        "used": 100,
        "unlimited": false,
        "usageExact": 100,
        "withholding": 0,
        "remaining": 900,
        "total": 1000,
        "progress": 10,
        "fileLimit": null,
        "singleFileSizeLimitMB": 100
      }
    ]
  }
}
响应字段 ​
字段类型必返枚举出现条件含义
codeinteger是—JSON成功响应文件、任务、模板和资产接口成功码为200；提醒规则为0，均为数字。
messagestring是—JSON成功响应英文系统结果说明，通常success。
dataobject是；可为null—按任务状态、版本及资源可用性；null不等于空内容或0。本接口的数据，结构见以下字段；无返回内容时为null。
data.assetinteger父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。兼容字段：服务返回的当前可用额度。
data.assetTypeNamestring | null父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。兼容字段：套餐或资产来源展示名。
data.overageTimestring | null父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。兼容字段：资产到期时间；可能为空。
data.assetTotalinteger父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。兼容字段：服务返回的额度总量。
data.userobject父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。当前资产面板可提供的用户摘要。
data.user.avatarstring | null父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。用户头像引用、显示名称或邮箱；无信息时可为空。
data.user.usernamestring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。用户头像引用、显示名称或邮箱；无信息时可为空。
data.user.emailstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。用户头像引用、显示名称或邮箱；无信息时可为空。
data.accountTypestring | null父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。账户分类代码。
data.accountTypeNamestring | null父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。账户分类的展示名称，不用于授权判断。
data.expireTimestring | null父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。套餐到期时间；未知或不适用时为空。
data.showExpireTimeboolean父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。兼容展示标记，不是新的权限凭据。
data.showAssetEntryboolean父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。兼容展示标记，不是新的权限凭据。
data.productsarray父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。按产品划分的资产信息。
data.products[]object父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。按产品划分的资产信息。
data.products[].productTypestring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。产品代码与展示名称，例如EXTRACT；不由客户端伪造产品归属。
data.products[].productNamestring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。产品代码与展示名称，例如EXTRACT；不由客户端伪造产品归属。
data.products[].unitstring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。额度单位代码，例如PAGE。
data.products[].unitNamestring父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。额度单位的展示名称。
data.products[].usedinteger父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。兼容的已用量字段；应与精确用量及未知历史状态一起解释。
data.products[].unlimitedboolean父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。是否无限额度；不能仅由剩余量猜测。
data.products[].usageExactinteger父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。精确已用量；历史未知时可为null，不能按0处理。
data.products[].withholdinginteger父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。当前预锁定额度，不是重复实际扣除。
data.products[].remaininginteger父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。当前可用/剩余额度；结合unlimited和服务返回值理解。
data.products[].totalinteger父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。样本页面中为总关联样本数，不是当前页条数；资产中total为额度总量。
data.products[].progressinteger父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。服务计算的额度进度展示值。
data.products[].fileLimitinteger | null父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。服务报告的文件数/单文件MB上限；实际入口还受自身校验限制。
data.products[].singleFileSizeLimitMBinteger父对象存在时；可选投影见条件—父对象/数组项存在；字段值可随状态为空。业务映射中的动态键随模板变化。服务报告的文件数/单文件MB上限；实际入口还受自身校验限制。
接口特有说明 ​
  • 前置条件：无业务请求参数，身份只来自密钥。
  • 副作用：返回当前组织的额度和使用信息。usageExact为null表示历史用量未知。
  • 规则：S4
适用错误 ​

E-AUTH, E-RESOURCE, E-INTERNAL

后续调用 ​

5. 请求参数索引 ​

所有接口均需携带第1节定义的鉴权请求头。下表按参数位置列出字段；类型、必填条件、默认值和示例见对应接口。点号表示对象层级，[]表示数组项。

接口参数位置字段
上传文件（异步处理）表单file, url, mode, template_id, metadata, user_id, user_email, enable_scoring
删除文件JSON请求体fileIds, dateRange, dateRange.start / dateRange.end, metadataConditions, deletePermanently
修改文件模板类别路径fileId
修改文件模板类别JSON请求体groupTemplateId, enableScoring
查询批次任务路径batchId
查询批次任务查询status
重试/重新处理任务路径taskId
重试/重新处理任务查询enable_scoring
取消任务路径taskId
获取模板列表查询search, status
获取模板字段路径id
创建模板JSON请求体name, fileId, keys, tableHeaders, keys.<name>.prompt / tableHeaders.<table>.<column>.prompt, keys.<name>.mapping / tableHeaders.<table>.<column>.mapping, keys.<name>.aliases / tableHeaders.<table>.<column>.aliases, page, enableScoring, elementOrder, elementOrder[].type, elementOrder[].name, elementOrder[].columnOrder, outputConfigs / tableOutputConfigs
更新模板路径id
更新模板JSON请求体name, fileId, keys, tableHeaders, keys.<name>.prompt / tableHeaders.<table>.<column>.prompt, keys.<name>.mapping / tableHeaders.<table>.<column>.mapping, keys.<name>.aliases / tableHeaders.<table>.<column>.aliases, page, enableScoring, elementOrder, elementOrder[].type, elementOrder[].name, elementOrder[].columnOrder, outputConfigs / tableOutputConfigs
删除模板路径id
上传创建模板前的样本表单file
上传/替换模板样本路径templateId
上传/替换模板样本表单file, replace_all
获取模板样本列表路径templateId
获取模板样本列表查询page, page_size
删除模板样本路径templateId, sampleId
自定义字段抽取路径fileId
自定义字段抽取JSON请求体keys, tableHeaders, enableScoring
获取文件处理结果请求头Accept-Version
获取文件处理结果路径taskId
获取文件处理结果查询parser_version, result_format, json_export_id
更新文件处理结果请求头Accept-Version
更新文件处理结果路径taskId
更新文件处理结果查询parser_version, result_format, json_export_id
更新文件处理结果JSON请求体fields, tables, parse_result, confirm, expectedUpdateDate
获取文件分类路径taskId
创建提醒规则JSON请求体name, template_id, frequency, conditions, channels, recipients, title_template, content_template, status, conditions[].field, conditions[].operator, conditions[].value, conditions[].logic, recipients.members, recipients.emails, recipients.field_bindings, recipients.webhook_ids, recipients.departments
更新提醒规则路径rule_id
更新提醒规则JSON请求体name, template_id, frequency, conditions, channels, recipients, title_template, content_template, status, conditions[].field, conditions[].operator, conditions[].value, conditions[].logic, recipients.members, recipients.emails, recipients.field_bindings, recipients.webhook_ids, recipients.departments
获取提醒规则列表查询status
获取提醒规则详情路径rule_id
启停提醒规则路径rule_id
启停提醒规则JSON请求体status
删除提醒规则路径rule_id
获取资产信息无无业务请求参数

6. 调用流程与错误处理 ​

6.1 文件处理流程 ​

  1. 通过模板列表获取模板ID；创建新模板时，先上传初始样本，再创建模板。
  2. 通过上传文件提交文件，保存返回的batchId、fileIds和taskIds。
  3. 使用批次查询查看整体进度，或通过任务结果查询单个任务；根据状态决定继续轮询或读取结果。
  4. 编辑前重新查询任务。提交结果更新时，expectedUpdateDate使用最新updateDate；仅保存时显式传confirm:false。
  5. 任务失败时读取code和error_detail.reason，按任务规则判断是否可以重试。
  6. 写入请求超时后，先查询资源状态。遇到版本冲突时，读取最新结果并合并修改后再提交。

6.2 错误响应与错误码 ​

错误响应提供业务码、具体原因及处理方式。调用方应同时读取HTTP状态、code/error_code和error_detail.reason。

文件、任务、模板或资产接口错误示例：HTTP200。

json
{
  "code": "08007",
  "message": "The current status of the task is invalid.",
  "data": null,
  "error_detail": {
    "reason": "UPDATE_VERSION_CONFLICT",
    "message": "The task has changed. expectedUpdateDate does not match the current version.",
    "suggestion": "Fetch the task again and submit its exact updateDate after reconciling changes.",
    "retryable": false,
    "request_id": "00000000-0000-4000-8000-000000000000",
    "details": {}
  }
}

规则错误示例：HTTP400。

json
{
  "code": 102,
  "error_code": "INVALID_RULE_CONFIGURATION",
  "message": "The reminder rule configuration is invalid.",
  "data": {},
  "error_detail": {
    "reason": "INVALID_RULE_CONFIGURATION",
    "message": "The reminder rule configuration is invalid.",
    "suggestion": "Check required fields, types and allowed values.",
    "retryable": false,
    "request_id": "00000000-0000-4000-8000-000000000001",
    "details": {}
  }
}

路径或方法错误使用HTTP404/405，响应包含timestamp/status/error/message/path等字段。依据Content-Type解析响应。

字段类型含义/条件
codeinteger|string业务信封中的结果码；保留前导零
messagestring英文系统结果说明
dataJSON|null错误附加数据，可为空
error_codestring提醒规则接口的错误分类
error_detail.reasonstring同一旧code下的具体原因
error_detail.message / suggestionstring英文说明和修正步骤
error_detail.retryableboolean是否暂时故障；重试写请求仍需先查询是否生效
error_detail.request_idstring错误关联标识，与X-Request-ID响应头对应
error_detail.detailsobject可含field/allowed_methods等定位信息，不回显密钥

E-AUTH ​

HTTP业务码/字段触发条件处理方式
HTTP 200 / 401 / 403401 / 403缺少/无效/不可用Key、租户或权限。error_detail.reason区分API_KEY_MISSING/INVALID/EXPIRED/INACTIVE、TENANT_UNAVAILABLE、KEY_OWNER_UNAVAILABLE、AUTH_SERVICE_UNAVAILABLE。检查请求头、密钥及服务地址。认证服务暂时不可用时，按响应中的处理步骤重试。

E-PARAM ​

HTTP业务码/字段触发条件处理方式
HTTP 200400 / "03000" / "01001"请求字段缺失、格式错误或类型不匹配。JSON读取错误可能返回01001；具体原因见error_detail.reason。按位置、类型和互斥规则改正；文件不能用路径字符串代替。

E-RESOURCE ​

HTTP业务码/字段触发条件处理方式
HTTP 200 / 404404 / "08003" / "08014" / "04003"资源不存在或当前身份不可访问。检查资源ID及其所属租户。

E-STATE ​

HTTP业务码/字段触发条件处理方式
HTTP 200"08007" / 409 / "08023"状态或版本冲突、会话/重试忙、模板禁用；08007的reason区分未完成、已确认、未确认、版本冲突、取消状态。先GET状态；按reason处理，避免无条件重复写。

E-QUOTA ​

HTTP业务码/字段触发条件处理方式
HTTP 200"08001"可用文件处理额度不足。查询可用资产或联系管理员补充处理额度。

E-VERSION ​

HTTP业务码/字段触发条件处理方式
HTTP 200"08026"解析版本非法、两个选择值冲突或v2兼容被禁用。使用一致的v3选择。

E-SAMPLE ​

HTTP业务码/字段触发条件处理方式
HTTP 200"08027" / "08028"超过5份样本或尝试删除最后一份。先调整样本或使用明确的整体替换。

E-FORMAT ​

HTTP业务码/字段触发条件处理方式
HTTP 200400 / 415文件大小超出限制，或文件格式不受支持。调整大小或格式；URL源也受相同大小上限。

E-ROUTE ​

HTTP业务码/字段触发条件处理方式
HTTP404 / HTTP405status / error地址或方法未匹配；可能不含业务code，error_detail仍可提供诊断。检查请求路径及方法；HTTP405时查看Allow响应头。

E-RULE ​

HTTP业务码/字段触发条件处理方式
HTTP400 / HTTP404 / HTTP409102 / 404 / 409规则配置/状态非法、规则不可见或唯一性冲突。error_code包括INVALID_RULE_CONFIGURATION、INVALID_RULE_STATUS、RULE_NOT_FOUND、RESOURCE_CONFLICT。按error_code及details定位，保留原字段类型。

E-INTERNAL ​

HTTP业务码/字段触发条件处理方式
HTTP 200"01001" / 100服务或依赖异常，详见具体诊断；不回传堆栈或SQL。保留request_id和时间；写请求重试前查询是否已生效。