GetExpenseAnalysis - Amazon Textract

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

GetExpenseAnalysis

獲取分析發票和收據的 Amazon Textract 異步操作的結果。Amazon Textract 從輸入的發票和收據中查找聯繫信息、購買的商品和供應商名稱。

啟動異步發票/收據分析,方法是調用StartExpenseAnalysis,它返回一個作業標識符(JobId。在完成發票/收據分析後,Amazon Textract 會將完成狀態發佈到 Amazon Simple Notification Service (Amazon SNS) 主題。此主題必須在初始調用StartExpenseAnalysis。若要取得發票/收據分析操作結果,首先請確認 Amazon SNS 主題的狀態值為SUCCEEDED。如果是這樣,請調用GetExpenseAnalysis,並傳遞作業標識符(JobId)從初始調用到StartExpenseAnalysis

使用 MaxResults 參數來限制傳回的塊數量。如果結果多於MaxResults,值NextToken在操作響應中包含用於取得下一組結果的字符。若要取得下一頁的結果,請調用GetExpenseAnalysis,然後填入NextToken請求參數與上一次調用返回的令牌值GetExpenseAnalysis

如需詳細資訊,請參閱「」分析發票和收款

請求語法

{ "JobId": "string", "MaxResults": number, "NextToken": "string" }

請求參數

請求接受採用 JSON 格式的下列資料。

JobId

文本檢測任務的唯一識別碼。所以此JobId從傳回StartExpenseAnalysis。一個JobId值只能保留 7 天。

類型:字串

限制:長度下限為 1。長度上限為 64。

模式:^[a-zA-Z0-9-_]+$

:必要 是

MaxResults

每次分頁呼叫可回傳結果的數量上限。您可以指定的最大值為 20。如果您指定的值大於 20,最多只能傳回 20 個結果。預設值為 20。

類型:整數

有效範圍:最小值為 1。

:必要 否

NextToken

如果之前的響應不完整(因為有更多要檢索的塊),Amazon Textract 會在響應中返回一個分頁令牌。您可以使用此分頁符記來檢索下一組塊。

類型:字串

限制:長度下限為 1。長度上限為 255。

模式:.*\S.*

:必要 否

回應語法

{ "AnalyzeExpenseModelVersion": "string", "DocumentMetadata": { "Pages": number }, "ExpenseDocuments": [ { "ExpenseIndex": number, "LineItemGroups": [ { "LineItemGroupIndex": number, "LineItems": [ { "LineItemExpenseFields": [ { "LabelDetection": { "Confidence": number, "Geometry": { "BoundingBox": { "Height": number, "Left": number, "Top": number, "Width": number }, "Polygon": [ { "X": number, "Y": number } ] }, "Text": "string" }, "PageNumber": number, "Type": { "Confidence": number, "Text": "string" }, "ValueDetection": { "Confidence": number, "Geometry": { "BoundingBox": { "Height": number, "Left": number, "Top": number, "Width": number }, "Polygon": [ { "X": number, "Y": number } ] }, "Text": "string" } } ] } ] } ], "SummaryFields": [ { "LabelDetection": { "Confidence": number, "Geometry": { "BoundingBox": { "Height": number, "Left": number, "Top": number, "Width": number }, "Polygon": [ { "X": number, "Y": number } ] }, "Text": "string" }, "PageNumber": number, "Type": { "Confidence": number, "Text": "string" }, "ValueDetection": { "Confidence": number, "Geometry": { "BoundingBox": { "Height": number, "Left": number, "Top": number, "Width": number }, "Polygon": [ { "X": number, "Y": number } ] }, "Text": "string" } } ] } ], "JobStatus": "string", "NextToken": "string", "StatusMessage": "string", "Warnings": [ { "ErrorCode": "string", "Pages": [ number ] } ] }

回應元素

如果動作成功,則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

AnalyzeExpenseModelVersion

分析費用的當前模型版本。

類型:字串

DocumentMetadata

有關 Amazon Textract 處理的文檔的信息。DocumentMetadata會在 Amazon Textract 操作的分頁響應的每一頁中返回。

類型:DocumentMetadata 物件

ExpenseDocuments

Amazon Textract 檢測到的費用。

類型:的陣列ExpenseDocument對象

JobStatus

文本檢測任務的目前狀態。

類型:字串

有效值: IN_PROGRESS | SUCCEEDED | FAILED | PARTIAL_SUCCESS

NextToken

如果響應被截斷,Amazon Textract 將返回此令牌。您可以在後續請求中使用此符記來檢索下一組文本檢測結果。

類型:字串

限制:長度下限為 1。長度上限為 255。

模式:.*\S.*

StatusMessage

如果無法完成檢測任務,則返回。包含有關發生什麼錯誤的説明。

類型:字串

Warnings

文檔的文本檢測操作過程中發生的警告列表。

類型:的陣列Warning對象

錯誤

AccessDeniedException

您未獲授權執行動作。使用已獲授權之使用者或 IAM 角色的 Amazon Resource Name (ARN) 來執行操作。

HTTP 狀態碼:400

InternalServerError

Amazon Textract 發生服務問題。請再次嘗試呼叫。

HTTP 狀態碼:500

InvalidJobIdException

將無效的作業標識符傳遞給GetDocumentAnalysisGetDocumentAnalysis

HTTP 狀態碼:400

InvalidKMSKeyException

表示您沒有使用輸入的 KMS 密鑰進行解密權限,或者 KMS 密鑰輸入錯誤。

HTTP 狀態碼:400

InvalidParameterException

輸入參數違反限制。例如,在同步操作中,InvalidParameterException異常發生時,S3Object或者Bytes值提供在Document請求參數。請驗證您的參數,然後再次呼叫 API 操作。

HTTP 狀態碼:400

InvalidS3ObjectException

Amazon Textract 無法存取請求中指定的 S3 物件。有關詳細信息,請設定對 Amazon S3 的存取如需故障診斷資訊,請參閱 。故障診斷 Amazon S3

HTTP 狀態碼:400

ProvisionedThroughputExceededException

請求數超過您的傳輸量限制。如果您想要提高此限制,請聯絡 Amazon Textract。

HTTP 狀態碼:400

ThrottlingException

Amazon Textract 暫時無法處理請求。請再次嘗試呼叫。

HTTP 狀態碼:500

另請參閱

如需在語言特定的 AWS 開發套件之一中使用此 API 的詳細資訊,請參閱下列說明: