跳转到主要内容
所有活动或已完成事务的列表可以用于:
  • 跟踪当前处于人工审核阶段的活动事务。
  • 获取活动事务的人工审核链接。
  • 下载已完成事务的结果文件。
您可以使用 Vantage API 获取包含其标识符的事务列表。您可以使用技能监控来应用更高级的筛选条件。

活跃事务列表

要获取活跃事务列表,请向 transactions/active 资源发送 GET 请求。 在请求正文中指定以下参数:
ParameterDescription
StageType事务所处的阶段。
可能的取值为:
- ManuaReview
- CustomActivity
- Automatic(用户无需参与的所有阶段,例如字段提取)
StageName具体操作名称(仅适用于 ManualReview 阶段)。
SkillId技能标识符。
如果未指定该值,则会考虑所有可用技能。
SkillVersion技能版本。
如果未指定该值,则会考虑所有可用技能的所有版本。
StartDate最早事务的创建时间(必须使用 UTC 格式)。
EndDate最晚事务的创建时间(必须使用 UTC 格式)。
如果未指定该值,则使用当前 UTC 时间。
TransactionParameters由键值 string 对组成的事务参数列表。这些参数提供额外的用户信息(例如客户名称)。
参数必须按以下格式提供:TransactionParameters={“key”: “string_1”,”value”:”string”}&TransactionParameters={“key”: “string_2”,”value”:”string”}
DocumentParameters由键值 string 对组成的文档参数列表。这些参数提供额外的文档信息(例如文件名)。
参数必须按以下格式提供:DocumentParameters={“key”: “string_1”,”value”:”string”}&DocumentParameters={“key”: “string_2”,”value”:”string”}
Offset分页偏移量。
该参数的默认值为 0
Limit分页上限。该参数为必填项。
该参数的默认值为 0
示例请求: 对于包含指定技能标识符的请求,其响应中将返回类似于以下内容的 JSON 文件:
{
  "items": [
    {
      "stage": "ManualReview",
      "stageName": "Review",
      "seqId": 13758,
      "transactionId": "56a50415-fe1d-4493-81ba-97ff07e3ffce",
      "createTimeUtc": "2023-09-11T13:53:30.633Z",
      "transactionParameters": [
        {
          "isReadOnly": true,
          "key": "string",
          "value": "string"
        },
        {
          "isReadOnly": true,
          "key": "App",
          "value": "PublicAPI"
        }
      ],
      "fileParameters": [
        {
          "isReadOnly": true,
          "key": "string",
          "value": "string"
        },
        {
          "isReadOnly": true,
          "key": "Index",
          "value": "0"
        },
        {
          "isReadOnly": true,
          "key": "SourceFileName",
          "value": "BillofLading_1.pdf"
        },
        {
          "isReadOnly": true,
          "key": "SourceType",
          "value": "PublicAPI"
        }
      ],
      "skillId": "workspace.default.processing",
      "skillVersion": 18,
      "documentCount": 1
    }
  ],
  "totalItemCount": 7
}
对指定阶段和操作的请求,其响应将包含一个 JSON 文件,其中包含所有活动事务,类似如下所示:
{
  "items": [
    {
      "stage": "ManualReview",
      "stageName": "Review2",
      "seqId": 13852,
      "transactionId": "e646754e-d854-4b21-af91-58cb63ead7a6",
      "createTimeUtc": "2023-09-11T14:04:37.97Z",
      "transactionParameters": [
        {
          "isReadOnly": true,
          "key": "string",
          "value": "string"
        },
        {
          "isReadOnly": true,
          "key": "App",
          "value": "PublicAPI"
        }
      ],
      "fileParameters": [
        {
          "isReadOnly": true,
          "key": "string",
          "value": "string"
        },
        {
          "isReadOnly": true,
          "key": "Index",
          "value": "0"
        },
        {
          "isReadOnly": true,
          "key": "SourceFileName",
          "value": "BillofLading_1.pdf"
        },
        {
          "isReadOnly": true,
          "key": "SourceType",
          "value": "PublicAPI"
        }
      ],
      "documentCount": 1
    }
  ],
  "totalItemCount": 2
}
您还可以为当前正在处理的事务获取人工审核客户端的链接。为此,请向 transactions/<transaction_id> 资源发送 GET 请求,并在请求 URI 中提供事务标识符。 请求示例: 响应将包含类似如下的内容: manualReviewLink 键将包含指向人工审核客户端 Web 界面的链接以及 Vantage 访问令牌(如果需要人工审核)。可以使用此链接和令牌来查看并更正特定事务的分类和字段提取结果。所提供的链接在 168 小时内有效,之后应使用相同的方法创建并获取一个新的链接,再延长 168 小时的有效期。有关更多信息,请参阅集成人工审核
通过此链接授权的用户将无法查看或修改任何其他文档或事务。

已完成事务列表

要获取已完成事务的列表,请向 transactions/completed 资源发送一个 GET 请求。 在请求正文中指定以下参数:
ParameterDescription
TransactionStatus事务的状态。
可能的取值为:
- Processed
- Canceled
- Failed
SkillId技能标识符。
如果未指定该值,将会考虑所有可用的技能。
SkillVersion技能版本。
如果未指定该值,将会考虑所有可用技能的所有版本。
StartDate最早事务的创建时间(必须使用 UTC 格式指定)。
EndDate最晚事务的创建时间(必须使用 UTC 格式指定)。
如果未指定该值,则使用当前 UTC 时间。
TransactionParameters由键值对(key 和 value 均为 string)组成的事务参数列表。这些参数提供额外的用户信息(例如,客户名称)。
参数必须按以下格式提供:TransactionParameters={“key”: “string_1”,”value”:”string”}&TransactionParameters={“key”: “string_2”,”value”:”string”}
DocumentParameters由键值对(key 和 value 均为 string)组成的文档参数列表。这些参数提供额外的文档信息(例如,文件名)。
参数必须按以下格式提供:DocumentParameters={“key”: “string_1”,”value”:”string”}&DocumentParameters={“key”: “string_2”,”value”:”string”}
Offset分页偏移量。
该参数的默认值为 0
Limit分页返回数量上限。此参数为必填项。
该参数的默认值为 0
响应将包含一个 JSON 文件,其中包含所有已完成的事务以及类似如下的已处理页面数量信息:
{
  "items": [
    {
      "status": "FinishedSuccessfully",
      "pageCount": 1,
      "seqId": 13705,
      "transactionId": "fc9920fe-f788-47f8-9972-b767493faed9",
      "createTimeUtc": "2023-09-11T13:47:50.273Z",
      "transactionParameters": [
        {
          "isReadOnly": true,
          "key": "string",
          "value": "string"
        },
        {
          "isReadOnly": true,
          "key": "App",
          "value": "PublicAPI"
        }
      ],
      "fileParameters": [
        {
          "isReadOnly": true,
          "key": "string",
          "value": "string"
        },
        {
          "isReadOnly": true,
          "key": "Index",
          "value": "0"
        },
        {
          "isReadOnly": true,
          "key": "SourceFileName",
          "value": "BillofLading_1.pdf"
        },
        {
          "isReadOnly": true,
          "key": "SourceType",
          "value": "PublicAPI"
        }
      ],
      "documentCount": 1
    },
    {
      "status": "FinishedSuccessfully",
      "pageCount": 2,
      "seqId": 29842,
      "transactionId": "c0dd3e08-f295-4c6c-b919-31eaa67817cc",
      "createTimeUtc": "2023-09-12T19:28:01.27Z",
      "transactionParameters": [
        {
          "isReadOnly": true,
          "key": "App",
          "value": "VantageUI"
        }
      ],
      "fileParameters": [
        {
          "isReadOnly": true,
          "key": "SourceFileName",
          "value": "Invoice _ 1213123123 _2__signed_signed _1__signed _1_.pdf"
        },
        {
          "isReadOnly": true,
          "key": "SourceType",
          "value": "VantageUI"
        }
      ],
      "documentCount": 1
    },
    {
      "status": "FinishedSuccessfully",
      "pageCount": 2,
      "seqId": 36254,
      "transactionId": "8391871e-abf5-41bc-8a66-1059418a3843",
      "createTimeUtc": "2023-09-13T08:53:41.9Z",
      "transactionParameters": [
        {
          "isReadOnly": true,
          "key": "App",
          "value": "VantageUI"
        }
      ],
      "fileParameters": [
        {
          "isReadOnly": true,
          "key": "SourceFileName",
          "value": "Invoice _ 1213123123 _2__signed_signed _1__signed _1_.pdf"
        },
        {
          "isReadOnly": true,
          "key": "SourceType",
          "value": "VantageUI"
        }
      ],
      "documentCount": 1
    },
    {
      "status": "FinishedSuccessfully",
      "pageCount": 2,
      "seqId": 36632,
      "transactionId": "7f7cd557-a03e-42e3-a454-e7981e8e9fc0",
      "createTimeUtc": "2023-09-13T09:35:27.48Z",
      "transactionParameters": [
        {
          "isReadOnly": true,
          "key": "App",
          "value": "VantageUI"
        }
      ],
      "fileParameters": [
        {
          "isReadOnly": true,
          "key": "SourceFileName",
          "value": "Invoice _ 1213123123 _2__signed_signed _1__signed.pdf"
        },
        {
          "isReadOnly": true,
          "key": "SourceType",
          "value": "VantageUI"
        }
      ],
      "documentCount": 1
    },
    {
      "status": "FinishedSuccessfully",
      "pageCount": 2,
      "seqId": 36663,
      "transactionId": "c9b3cd4d-d90f-48be-adc2-99985ece4e11",
      "createTimeUtc": "2023-09-13T09:38:29.573Z",
      "transactionParameters": [
        {
          "isReadOnly": true,
          "key": "App",
          "value": "VantageUI"
        }
      ],
      "fileParameters": [
        {
          "isReadOnly": true,
          "key": "SourceFileName",
          "value": "Invoice _ 1213123123 _2__signed_signed _1__signed.pdf"
        },
        {
          "isReadOnly": true,
          "key": "SourceType",
          "value": "VantageUI"
        }
      ],
      "documentCount": 1
    }
  ],
  "totalItemCount": 5
}