跳转到主要内容
业务处理报告显示文档的处理情况,并为审计提供端到端的事务可追溯性。Warehouse 会捕获所有事务(包括已完成和进行中的),以便在商业智能工具中进行分析和可视化。数据会保留 12 个月,从而可以在指定的时间段内进行分析和审计。 会跟踪以下数据:
  • 事务 ID。
  • 技能 ID 和版本。
  • 按步骤划分的处理路径:
    • 步骤类型
    • 名称
    • 步骤开始和结束的日期和时间
    • 持续时间(秒)
  • 人工审核人员姓名和电子邮件。
  • 文档和事务的注册参数。
注意: Warehouse 不会存储在根据其设置从未执行的活动中发生的文档处理事件的信息。例如,“按文件组装”(Assemble by files)设置对应于 Vantage 的默认行为,因此在此活动中的文档处理将在工作流中被跳过。

从 v1 迁移到 v2

在 Vantage 3.0 及更高版本中,transaction-steps v1 端点已被弃用。为了保持向后兼容性,v2 端点的工作方式类似,只是端点名称发生了变化,并且查询参数被移到了请求正文中。v2 端点采用异步模型,以更好地处理大批量数据请求。发起报表请求后,可以轮询状态直到报表准备就绪。完成后即可下载结果。

有哪些更新?

在请求(/api/reporting/v2/exports/transaction-steps)中:
  • 过滤条件已从查询参数移至请求体中的 filters JSON 对象。
  • 现在必须在 filters 对象中指定 startDate
  • 新增字段:sendEmailNotification(true/false)——当报告已准备好供下载时,向提交报告请求的用户发送电子邮件通知。
在最终结果(/api/reporting/v2/exports/transaction-steps/{{requestId}}/result/{fileIndex})中下载得到的 CSV 文件中,新增了两列:
  • DocumentsCount:事务中已处理文档的数量。
  • PagesCount:事务中已处理页面的数量。
继续阅读以下内容,了解 v2 端点的工作原理。

下载数据报告

注意: 只有拥有 Tenant AdministratorProcessing Supervisor 角色的用户才能从 Warehouse 下载数据报告。更多信息,请参阅基于角色的访问控制。
您可以使用 Vantage API 从 Warehouse 以 CSV 文件形式获取数据。为此,请向以下资源发送 POST 请求: 请求正文应在 filters 对象中包含以下属性:
  • skillId。其事务需要下载的技能 ID。可选。
  • transactionId。用于筛选的事务 ID。可选。
  • startDate。要下载事务的时间段的第一天(示例格式:2022-01-07T13:03:38,时间应为 UTC)。必需。
  • endDate。要下载事务的时间段的最后一天(示例格式:2022-09-07T13:03:38,时间应为 UTC)。可选。
  • sendEmailNotification。向创建报告请求的用户发送电子邮件,通知其报告已准备好下载。可选。
{
  "filters": {
    "skillId": "d0e27b2d-bcc6-4129-bfd1-c1e37ee3efae",
    "transactionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "startDate": "2025-11-03T17:19:54.386Z",
    "endDate": "2025-11-17T20:05:26.097Z"
  },
  "sendEmailNotification": true
}
报表请求是异步执行的,因此响应会返回一个 requestId,用于检查该请求的状态。 结果:
{
  "requestId": "8f772512-099c-4050-8dd3-6c4d7af69747”
}
要检查报表状态,请在 GET 请求中传入 requestId 当报表生成完成后,status 为 “Succeeded”,totalFileCount 显示可供下载的文件数:
{
  "status": "Succeeded",
  "totalFileCount": 3,
  "filters": {
      "skillId": "d0e27b2d-bcc6-4129-bfd1-c1e37ee3efae",
      "startDate": "2025-11-03T17:19:54.386+00:00",
      "endDate": "2025-11-17T20:05:26.097+00:00"
  }
}
要下载生成的报告文件,请发送如下所示的 GET 请求,再次传入 requestId,并添加 fileIndex,即从 0 开始的文件索引值。例如,如果 "totalFileCount": 3,则可用的文件索引为 0、1 和 2。 下面是一个 CSV 响应示例:
SkillIdSkillVersionSkillNameTransactionIdStepNameStepTypeManualReviewOperatorNameManualReviewOperatorEmailStartedUtcCompletedUtcStatusDurationDocumentsCountPagesCountdocument_SourceFileNamedocument_SourceTypetransaction_App
d0e27b2d-bcc6-4129-bfd1-c1e37ee3efae1Redaction Test6d7e9eeb-86e3-4952-8e29-3f76b3fae59fInputInput11/17/2025 19:37:5211/17/2025 19:38:01FinishedSuccessfully9Invoice CA_2.pdfPublicAPIPublicAPI
d0e27b2d-bcc6-4129-bfd1-c1e37ee3efae1Redaction Test6d7e9eeb-86e3-4952-8e29-3f76b3fae59fOCROcr11/17/2025 19:38:0211/17/2025 19:38:17FinishedSuccessfully15Invoice CA_2.pdfPublicAPIPublicAPI
d0e27b2d-bcc6-4129-bfd1-c1e37ee3efae1Redaction Test6d7e9eeb-86e3-4952-8e29-3f76b3fae59fClassifyClassification11/17/2025 19:38:1711/17/2025 19:38:20FinishedSuccessfully3Invoice CA_2.pdfPublicAPIPublicAPI
d0e27b2d-bcc6-4129-bfd1-c1e37ee3efae1Redaction Test6d7e9eeb-86e3-4952-8e29-3f76b3fae59fExtractExtraction11/17/2025 19:38:2111/17/2025 19:38:44FinishedSuccessfully23Invoice CA_2.pdfPublicAPIPublicAPI
d0e27b2d-bcc6-4129-bfd1-c1e37ee3efae1Redaction Test6d7e9eeb-86e3-4952-8e29-3f76b3fae59fOutputOutput11/17/2025 19:38:4711/17/2025 19:39:01Failed13Invoice CA_2.pdfPublicAPIPublicAPI

响应结构

CSV 文件中的每一行都表示在一个事务上执行的一次操作,例如导入文档、识别或人工审核。对于 Warehouse 中的每个操作,其详细信息都存储在各个列中:
ColumnDescription
SkillId技能 ID。
SkillVersion技能版本。
SkillName技能名称。
TransactionId事务 ID。
StepName事件名称;在流程技能中,为活动名称。
StepType事件类型。可能的取值:
- Input(适用于所有技能类型)
- Ocr(适用于 OCR 技能或添加了 OCR 活动的流程技能)
- Classification(适用于分类技能或添加了 Classification 活动的流程技能)
- Extraction(适用于所有技能类型)
- Condition(适用于添加了 Condition 活动的流程技能)
- CustomActivity(适用于添加了 Custom 活动的流程技能)
- WaitingForManualReview(适用于添加了 Manual Review 活动的流程技能)。表示事务等待人工审核的时长。
- ManualReview(适用于添加了 Manual Review 活动的流程技能)。表示操作员正在核查事务的时长。
- Output(适用于所有技能类型)
ManualReviewOperatorName人工审核操作员的姓名。
ManualReviewOperatorEmail人工审核操作员的电子邮箱地址。
StartedUtc事件开始时间(UTC)。例如,5/3/2022 1:59:02 PM。
CompletedUtc事件结束时间(UTC)。
Status事件状态。可能的取值:
- Processing
- Finished Successfully
- Canceled
- Failed
Duration事件持续时间(秒)。
DocumentsCount事务中已处理文档的数量。
PagesCount事务中已处理页面的数量。
document_*, transaction_*传入进行处理的文档或事务参数。文档参数在表头中添加前缀 document_,事务参数添加前缀 transaction_,例如 document_SourceFileName。如果一个事务包含名称相同但值不同的文档参数,Warehouse 会列出该参数的所有唯一值,并用逗号分隔,例如事务中的所有文件名。
准备好的数据会在请求完成后保存 2 周。以 CSV 格式获取的数据可以在任何 BI 工具中进一步分析。

获取报表请求列表

要在指定时间段内获取创建的报表请求列表,请向以下端点发送一个 GET 请求,其中 createdFromcreatedTo 表示日期范围的起止时间,statusFilter 为以下值之一:NewQueuedProcessingSucceededFailedCancelled。这在请求 ID 遗失的情况下非常有用。 响应中包含一个报表请求数组。
{
  "requests": [
    {
      "requestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "status": "New",
      "completedUtc": "2025-11-18T22:22:00.294Z",
      "createdUtc": "2025-11-18T22:20:49.294Z",
      "totalFileCount": "2",
      "filters": {
        "skillId": "d0e27b2d-bcc6-4129-bfd1-c1e37ee3efae",
        "startDate": "2025-11-03T17:19:54.386+00:00",
        "endDate": "2025-11-17T20:05:26.097+00:00"
      }
    },
    {
      "requestId": "48293032-5717-4562-b3fc-2c963f66afa6",
      "status": "Succeeded",
      "completedUtc": "2025-12-18T22:22:00.294Z",
      "createdUtc": "2025-12-18T22:20:49.294Z",
      "totalFileCount": "4",
      "filters": {
        "skillId": "dk3ioda-bcc6-4129-bfd1-c1e37ee3efae",
        "startDate": "2025-11-03T17:19:54.386+00:00",
        "endDate": "2025-11-17T20:05:26.097+00:00"
      }
    }
  ]
}