跳轉到主要內容
所有處於進行中或已完成狀態的處理作業清單可以用來:
  • 追蹤目前處於手動審核階段的進行中處理作業。
  • 取得進行中處理作業的手動審核連結。
  • 下載已完成處理作業的結果檔案。
您可以使用 Vantage API 取得包含識別碼的處理作業清單。您可以使用 技能監控 套用更進階的篩選條件。

作用中處理作業清單

若要取得作用中處理作業的清單,請對 transactions/active 資源送出 GET 要求。 在要求本文中,指定下列參數:
ParameterDescription
StageType處理作業所在的階段。
可能的值為:
- ManuaReview
- CustomActivity
- Automatic(所有不需要使用者參與的階段,例如擷取欄位)
StageName特定動作的名稱(僅適用於 ManualReview 階段)。
SkillIdskill 識別碼。
如果未指定值,則會將所有可用的 skill 納入考量。
SkillVersionskill 版本。
如果未指定值,則會將所有可用 skill 的所有版本納入考量。
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
範例要求: 對包含指定 skill 識別碼的要求,其回應將包含類似下列的 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
}
您也可以為目前處理中的處理作業取得 Manual Review 用戶端連結。為此,請在請求 URI 中使用處理作業識別碼,向 transactions/<transaction_id> 資源送出 GET 要求。 請求範例: 回應將包含類似以下的內容: manualReviewLink 鍵會包含 Manual Review 用戶端的網頁介面連結以及 Vantage 存取權杖(若需要手動審核)。此連結與權杖可用於檢閱並更正特定處理作業的分類與欄位擷取結果。提供的連結有效期間為 168 小時,到期後,應使用相同方法建立並取得新的連結(有效期同為 168 小時)。如需詳細資訊,請參閱 Integrating manual review
透過此連結授權的使用者將無法檢視或修改任何其他文件或處理作業。

已完成處理作業清單

若要取得已完成處理作業的清單,請對 transactions/completed 資源發出 GET 要求。 在要求主體中,指定下列參數:
ParameterDescription
TransactionStatus處理作業的狀態。
可能的值為:
- Processed
- Canceled
- Failed
SkillIdskill 識別碼。
若未指定值,將會納入所有可用的 skill。
SkillVersionskill 版本。
若未指定值,將會納入所有可用 skill 的所有版本。
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": [
    {
      "status": "已成功完成",
      "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": "已成功完成",
      "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": "已成功完成",
      "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": "已成功完成",
      "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": "已成功完成",
      "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
}