跳轉到主要內容使用單一 API 呼叫 (用於建立處理作業、上傳檔案以及啟動處理作業) 來處理文件的典型作業流程包括以下步驟:
- 取得所有可用技能的清單。
- 建立並啟動處理作業。
- 監視處理作業狀態。
- 下載來源檔案與結果檔案。
傳送到伺服器的每個請求都必須包含驗證資訊。若需更多資訊,請參閱 Authentication。
如果您只有一個小於 30 MB 的檔案,且不需要編輯該檔案的影像,請使用此作業流程。
若要取得所有可用技能的清單,請對 skills 資源送出 GET 要求:
執行下列指令:
如此一來,您就會取得已新增至應用程式執行個體之所有技能的相關資訊。
若要建立並啟動一個處理作業,請向 transactions/launch 資源傳送一個 POST 請求:
在 URL 中指定 skillId 查詢參數 (由前一次 API 呼叫傳回) 。在請求內文中,傳送要處理的檔案以及選擇性的中繼資料。您也可以在請求內文中傳遞選擇性的 registrationParameters 和 skillParameters。
以下是範例請求內文:
執行下列命令:
執行後,您將收到一個回應,其中包含已建立處理作業的 id。
若要監控處理作業狀態,請向 transactions 資源送出 GET 要求:
執行下列指令:
您會收到包含處理作業狀態的回應。處理作業可能處於下列任一狀態:
New。已建立處理作業,但尚未排入佇列進行處理。
Queued。處理作業已排入佇列準備處理。
InProgress。處理作業正在處理中。
Processed。處理作業已成功處理。
ProcessedWithWarnings。處理作業已處理完成,但發生警告。
NotProcessed。由於錯誤,處理作業未處理。
Deleted。處理作業已由使用者刪除,或依據保留原則自動刪除。
如果處理作業狀態為 Processed 或 ProcessedWithWarnings,請繼續前往步驟 4。
若要下載原始檔案與結果檔案,請對 transactions/files/download 資源發出 GET 要求,並在其中指定檔案 ID,此 ID 是在上一個要求的回應中取得的:
執行下列指令: