本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。 # 動作 支援以下動作： + [AnalyzeDocument](API_AnalyzeDocument.md) + [AnalyzeExpense](API_AnalyzeExpense.md) + [AnalyzeID](API_AnalyzeID.md) + [DetectDocumentText](API_DetectDocumentText.md) + [GetDocumentAnalysis](API_GetDocumentAnalysis.md) + [GetDocumentTextDetection](API_GetDocumentTextDetection.md) + [GetExpenseAnalysis](API_GetExpenseAnalysis.md) + [StartDocumentAnalysis](API_StartDocumentAnalysis.md) + [StartDocumentTextDetection](API_StartDocumentTextDetection.md) + [StartExpenseAnalysis](API_StartExpenseAnalysis.md) # AnalyzeDocument 分析輸入檔案，分析已偵測項目之間的關係。 返回的信息類型如下： + 資料表單（金鑰值對）。有關資訊會以兩種方式傳回[Block](API_Block.md)對象, 每個類型`KEY_VALUE_SET`：金鑰`Block`對象和一個值`Block`物件。例如：*名稱: 安娜·席爾瓦·卡羅萊納州*包含一個鍵和值。*名稱:*是關鍵。*安娜·席爾瓦·卡羅萊納州*均為值。 + 表格和表格單元格數據。資料表`Block`對象包含有關檢測到的表的信息。儲存格`Block`對象返回表中的每個單元格。 + 文本的行和單詞。行`Block`物件包含一個或多個 WORD`Block`物件。返回文檔中檢測到的所有行和單詞（包括與`FeatureTypes`。 選擇元素（如複選框和選項按鈕（單選按鈕）可以在表單數據和表格中檢測。選擇元素`Block`對象包含有關選擇元素的信息，包括選擇狀態。 您可以選擇要執行的分析類型，方法是指定`FeatureTypes`列表。 輸出返回在`Block`物件。 `AnalyzeDocument`均為同步操作。要異步分析文檔，請使用[StartDocumentAnalysis](API_StartDocumentAnalysis.md)。 如需詳細資訊，請參閱「」[文件文字分析](https://docs.aws.amazon.com/textract/latest/dg/how-it-works-analyzing.html)。 ## 請求語法 ``` { "Document": { "Bytes": blob, "S3Object": { "Bucket": "string", "Name": "string", "Version": "string" } }, "FeatureTypes": [ "string" ], "HumanLoopConfig": { "DataAttributes": { "ContentClassifiers": [ "string" ] }, "FlowDefinitionArn": "string", "HumanLoopName": "string" } } ``` ## 請求參數 請求接受採用 JSON 格式的下列資料。 ** [Document](#API_AnalyzeDocument_RequestSyntax) ** 輸入文檔為 base64 編碼的字節或 Amazon S3 對象。如果您使用 AWS CLI 調用 Amazon Textract 操作，則無法傳遞圖像字節。文檔必須是 JPEG、PNG、PDF 或 TIFF 格式的圖像。 如果您使用 AWS 開發工具包調用 Amazon Textract，則可能不需要對使用`Bytes`欄位。 類型：[Document](API_Document.md) 物件 ：必要 是 ** [FeatureTypes](#API_AnalyzeDocument_RequestSyntax) ** 要執行的分析類型的列表。將 TABLE 添加到列表以返回有關輸入文檔中檢測到的表的信息。添加表單以返回檢測到的表單數據。要執行這兩種類型的分析，請將表和表格添加到`FeatureTypes`。文檔中檢測到的所有行和單詞都包含在響應中（包括與`FeatureTypes`。 類型：字串陣列 有效值：` TABLES | FORMS` ：必要 是 ** [HumanLoopConfig](#API_AnalyzeDocument_RequestSyntax) ** 設置用於分析文檔的循環工作流的配置。 類型：[HumanLoopConfig](API_HumanLoopConfig.md) 物件 ：必要 否 ## 回應語法 ``` { "AnalyzeDocumentModelVersion": "string", "Blocks": [ { "BlockType": "string", "ColumnIndex": number, "ColumnSpan": number, "Confidence": number, "EntityTypes": [ "string" ], "Geometry": { "BoundingBox": { "Height": number, "Left": number, "Top": number, "Width": number }, "Polygon": [ { "X": number, "Y": number } ] }, "Id": "string", "Page": number, "Relationships": [ { "Ids": [ "string" ], "Type": "string" } ], "RowIndex": number, "RowSpan": number, "SelectionStatus": "string", "Text": "string", "TextType": "string" } ], "DocumentMetadata": { "Pages": number }, "HumanLoopActivationOutput": { "HumanLoopActivationConditionsEvaluationResults": "string", "HumanLoopActivationReasons": [ "string" ], "HumanLoopArn": "string" } } ``` ## 回應元素 如果動作成功，則服務傳回 HTTP 200 回應。 服務會傳回下列 JSON 格式的資料。 ** [AnalyzeDocumentModelVersion](#API_AnalyzeDocument_ResponseSyntax) ** 用於分析文件的模型版本。 類型：字串 ** [Blocks](#API_AnalyzeDocument_ResponseSyntax) ** 檢測和分析的項目`AnalyzeDocument`。 類型：的陣列[Block](API_Block.md)對象 ** [DocumentMetadata](#API_AnalyzeDocument_ResponseSyntax) ** 有關已分析文檔的元數據。一個例子是頁數。 類型：[DocumentMetadata](API_DocumentMetadata.md) 物件 ** [HumanLoopActivationOutput](#API_AnalyzeDocument_ResponseSyntax) ** 顯示循環評估中人類的結果。 類型：[HumanLoopActivationOutput](API_HumanLoopActivationOutput.md) 物件 ## 錯誤 ** AccessDeniedException ** 您未獲授權執行動作。使用已獲授權之使用者或 IAM 角色的 Amazon Resource Name (ARN) 來執行操作。 HTTP 狀態碼：400 ** BadDocumentException ** Amazon Textract 無法閲讀該文檔。有關 Amazon Textract 中文檔限制的更多信息，請參閲[亞馬遜文字中的硬性限制](limits.md)。 HTTP 狀態碼：400 ** DocumentTooLargeException ** 無法處理該文檔，因為它太大。用於同步操作的上限文件大小，10 MB。對於 PDF 文件，異步操作的最大文檔大小為 500 MB。 HTTP 狀態碼：400 ** HumanLoopQuotaExceededException ** 指示您已超過可用循環工作流中活動人工的上限數量 HTTP 狀態碼：400 ** InternalServerError ** Amazon Textract 發生服務問題。請再次嘗試呼叫。 HTTP 狀態碼：500 ** InvalidParameterException ** 輸入參數違反限制。例如，在同步操作中，`InvalidParameterException`異常發生時，`S3Object`或者`Bytes`值提供在`Document`請求參數。請驗證您的參數，然後再次呼叫 API 操作。 HTTP 狀態碼：400 ** InvalidS3ObjectException ** Amazon Textract 無法存取請求中指定的 S3 物件。有關詳細信息，請[配置對 Amazon S3 的存取](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html)如需故障診斷資訊，請參閱 。[故障診斷 Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html) HTTP 狀態碼：400 ** ProvisionedThroughputExceededException ** 請求數超過您的傳輸量限制。如果您希望提高此限制，請聯絡 Amazon Textract。 HTTP 狀態碼：400 ** ThrottlingException ** Amazon Textract 暫時無法處理請求。請再次嘗試呼叫。 HTTP 狀態碼：500 ** UnsupportedDocumentException ** 不支持輸入檔案的格式。操作文檔可以採用 PNG、JPEG、PDF 或 TIFF 格式。 HTTP 狀態碼：400 ## 另請參閱 如需在語言特定的 AWS 開發套件之一中使用此 API 的詳細資訊，請參閱下列說明： + [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/textract-2018-06-27/AnalyzeDocument) + [適用於 .NET 的 AWS 開發套件](https://docs.aws.amazon.com/goto/DotNetSDKV3/textract-2018-06-27/AnalyzeDocument) + [適用於 C\$1\$1 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/AnalyzeDocument) + [適用於 Go 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/AnalyzeDocument) + [AWS適用於 Java 的開發套件第 2 版](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/AnalyzeDocument) + [適用於 JavaScript 的 AWS 開發套件](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/textract-2018-06-27/AnalyzeDocument) + [適用於 PHP V3 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/AnalyzeDocument) + [適用於 Python 的 AWS 開發套件](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/AnalyzeDocument) + [適用於 Ruby V3 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/AnalyzeDocument) # AnalyzeExpense `AnalyzeExpense`同步分析輸入文檔之間的財務相關關係。 信息返回為`ExpenseDocuments`並分開如下。 + `LineItemGroups`-包含`LineItems`存儲有關文本行的信息，例如購買的物料及其收據上的價格。 + `SummaryFields`-包含收據的所有其他信息，例如題頭信息或供應商名稱。 ## 請求語法 ``` { "Document": { "Bytes": blob, "S3Object": { "Bucket": "string", "Name": "string", "Version": "string" } } } ``` ## 請求參數 請求接受採用 JSON 格式的下列資料。 ** [Document](#API_AnalyzeExpense_RequestSyntax) ** 輸入文檔，作為字節或 S3 對象。 您可以使用`Bytes`屬性。例如，您需要使用`Bytes`屬性傳遞從本地文件系統加載的文檔。通過使用`Bytes`屬性必須經過 base64 編碼。如果您使用 AWS 開發工具包調用 Amazon Textract API 操作，則您的代碼可能無需對文檔文件字節進行編碼。 您可以使用 S3 儲存貯體中的影像來傳遞至 Amazon Textract API 操作，方法是使用`S3Object`屬性。存放在 S3 儲存貯體中的檔案，不需要 base64 編碼。 含有 S3 物件的 S3 儲存貯體區域必須符合您用於 Amazon Textract 操作的 AWS 區域。 如果您使用 AWS CLI 呼叫 Amazon Textract 操作，則不支援使用 Bytes 屬性來傳遞影像位元組。您必須先將文件上傳至 Amazon S3 儲存貯體，再使用 S3Object 屬性呼叫操作。 若要 Amazon Textract 處理 S3 物件，用户必須具有 S3 物件的存取許可。 類型：[Document](API_Document.md) 物件 ：必要 是 ## 回應語法 ``` { "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" } } ] } ] } ``` ## 回應元素 如果動作成功，則服務傳回 HTTP 200 回應。 服務會傳回下列 JSON 格式的資料。 ** [DocumentMetadata](#API_AnalyzeExpense_ResponseSyntax) ** 有關輸入文檔的信息。 類型：[DocumentMetadata](API_DocumentMetadata.md) 物件 ** [ExpenseDocuments](#API_AnalyzeExpense_ResponseSyntax) ** Amazon Textract 檢測到的費用。 類型：的陣列[ExpenseDocument](API_ExpenseDocument.md)對象 ## 錯誤 ** AccessDeniedException ** 您未獲授權執行動作。使用已獲授權之使用者或 IAM 角色的 Amazon Resource Name (ARN) 來執行操作。 HTTP 狀態碼：HTTP 狀態碼：400 ** BadDocumentException ** Amazon Textract 無法閲讀該文檔。有關 Amazon Textract 中文檔限制的更多信息，請參閲[亞馬遜文字中的硬性限制](limits.md)。 HTTP 狀態碼：HTTP 狀態碼：400 ** DocumentTooLargeException ** 無法處理該文檔，因為它太大。同步操作的最大檔案大小為 10 MB。對於 PDF 文件，異步操作的最大文檔大小為 500 MB。 HTTP 狀態碼：HTTP 狀態碼：400 ** InternalServerError ** Amazon Textract 發生服務問題。請再次嘗試呼叫。 HTTP 狀態碼：HTTP 狀態碼：500 ** InvalidParameterException ** 輸入參數違反限制。例如，在同步操作中，`InvalidParameterException`異常發生時，`S3Object`或者`Bytes`值提供在`Document`請求參數。請驗證您的參數，然後再次呼叫 API 操作。 HTTP 狀態碼：HTTP 狀態碼：400 ** InvalidS3ObjectException ** Amazon Textract 無法存取請求中指定的 S3 物件。有關詳細信息，請[設定對 Amazon S3 的存取](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html)如需故障診斷資訊，請參閱 。[故障診斷 Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html) HTTP 狀態碼：HTTP 狀態碼：400 ** ProvisionedThroughputExceededException ** 請求數超過您的傳輸量限制。如果您希望提高此限制，請聯絡 Amazon Textract。 HTTP 狀態碼：HTTP 狀態碼：400 ** ThrottlingException ** Amazon Textract 暫時無法處理請求。請再次嘗試呼叫。 HTTP 狀態碼：HTTP 狀態碼：500 ** UnsupportedDocumentException ** 不支援輸入檔案的格式。操作文檔可以採用 PNG、JPEG、PDF 或 TIFF 格式。 HTTP 狀態碼：HTTP 狀態碼：400 ## 另請參閱 如需在語言特定的 AWS 開發套件之一中使用此 API 的詳細資訊，請參閱下列說明： + [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/textract-2018-06-27/AnalyzeExpense) + [適用於 .NET 的 AWS 開發套件](https://docs.aws.amazon.com/goto/DotNetSDKV3/textract-2018-06-27/AnalyzeExpense) + [適用於 C\$1\$1 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/AnalyzeExpense) + [適用於 Go 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/AnalyzeExpense) + [AWS適用於 Java 的開發套件第 2 版](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/AnalyzeExpense) + [適用於 JavaScript 的 AWS 開發套件](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/textract-2018-06-27/AnalyzeExpense) + [適用於 PHP V3 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/AnalyzeExpense) + [適用於 Python 的 AWS 開發套件](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/AnalyzeExpense) + [適用於 Ruby V3 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/AnalyzeExpense) # AnalyzeID 分析身份證明文件以獲取相關信息。此信息被提取並返回為`IdentityDocumentFields`，它記錄提取文本的標準化字段和值。與其他 Amazon Textract 操作不同，`AnalyzeID`不會傳回任何幾何數據。 ## 請求語法 ``` { "DocumentPages": [ { "Bytes": blob, "S3Object": { "Bucket": "string", "Name": "string", "Version": "string" } } ] } ``` ## 請求參數 請求接受採用 JSON 格式的下列資料。 ** [DocumentPages](#API_AnalyzeID_RequestSyntax) ** 傳遞給分析 ID 的文檔。 類型：的陣列[Document](API_Document.md)對象 陣列成員：項目數下限為 1。項目數上限為 2。 的必要項目：是 ## 回應語法 ``` { "AnalyzeIDModelVersion": "string", "DocumentMetadata": { "Pages": number }, "IdentityDocuments": [ { "DocumentIndex": number, "IdentityDocumentFields": [ { "Type": { "Confidence": number, "NormalizedValue": { "Value": "string", "ValueType": "string" }, "Text": "string" }, "ValueDetection": { "Confidence": number, "NormalizedValue": { "Value": "string", "ValueType": "string" }, "Text": "string" } } ] } ] } ``` ## 回應元素 如果動作成功，則服務傳回 HTTP 200 回應。 服務會傳回下列 JSON 格式的資料。 ** [AnalyzeIDModelVersion](#API_AnalyzeID_ResponseSyntax) ** 用於處理文檔的分析身份 API 版本。 類型：字串 ** [DocumentMetadata](#API_AnalyzeID_ResponseSyntax) ** 有關輸入文檔的信息。 類型：[DocumentMetadata](API_DocumentMetadata.md) 物件 ** [IdentityDocuments](#API_AnalyzeID_ResponseSyntax) ** 分析編號處理的文件列表。包括一個數字，表示它們在列表中的位置和文檔的響應結構。 類型：的陣列[IdentityDocument](API_IdentityDocument.md)對象 ## 錯誤 ** AccessDeniedException ** 您未獲授權執行動作。使用已獲授權之使用者或 IAM 角色的 Amazon Resource Name (ARN) 來執行操作。 HTTP 狀態碼：400 ** BadDocumentException ** Amazon Textract 無法閲讀該文檔。有關 Amazon Textract 中文檔限制的更多信息，請參閲[亞馬遜文字中的硬性限制](limits.md)。 HTTP 狀態碼：400 ** DocumentTooLargeException ** 無法處理該文檔，因為它太大。同步操作的最大文件大小為 10 MB。對於 PDF 文件，異步操作的最大文檔大小為 500 MB。 HTTP 狀態碼：400 ** InternalServerError ** Amazon Textract 發生服務問題。請再次嘗試呼叫。 HTTP 狀態碼：500 ** InvalidParameterException ** 輸入參數違反限制。例如，在同步操作中，`InvalidParameterException`異常發生時，`S3Object`或者`Bytes`值提供在`Document`請求參數。請驗證您的參數，然後再次呼叫 API 操作。 HTTP 狀態碼：400 ** InvalidS3ObjectException ** Amazon Textract 無法存取請求中指定的 S3 物件。有關詳細信息，請[設定對 Amazon S3 的存取](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html)如需故障診斷資訊，請參閱 。[故障診斷 Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html) HTTP 狀態碼：400 ** ProvisionedThroughputExceededException ** 請求數超過您的傳輸量限制。如果您希望提高此限制，請聯絡 Amazon Textract。 HTTP 狀態碼：400 ** ThrottlingException ** Amazon Textract 暫時無法處理請求。請再次嘗試呼叫。 HTTP 狀態碼：500 ** UnsupportedDocumentException ** 不支持輸入檔案的格式。操作文檔可以採用 PNG、JPEG、PDF 或 TIFF 格式。 HTTP 狀態碼：400 ## 另請參閱 如需在語言特定的 AWS 開發套件之一中使用此 API 的詳細資訊，請參閱下列說明： + [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/textract-2018-06-27/AnalyzeID) + [適用於 .NET 的 AWS 開發套件](https://docs.aws.amazon.com/goto/DotNetSDKV3/textract-2018-06-27/AnalyzeID) + [適用於 C\$1\$1 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/AnalyzeID) + [適用於 Go 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/AnalyzeID) + [AWS適用於 Java 的開發套件第 2 版](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/AnalyzeID) + [適用於 JavaScript 的 AWS 開發套件](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/textract-2018-06-27/AnalyzeID) + [適用於 PHP V3 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/AnalyzeID) + [適用於 Python 的 AWS 開發套件](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/AnalyzeID) + [適用於 Ruby V3 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/AnalyzeID) # DetectDocumentText 檢測輸入文檔中的文本。Amazon Textract 可以檢測文本行和構成一行文本的單詞。輸入文檔必須是 JPEG、PNG、PDF 或 TIFF 格式的圖像。`DetectDocumentText`返回一個數組中檢測到的文本[Block](API_Block.md)物件。 每個文檔頁面都有一個關聯的`Block`類型為頁面。每頁`Block`LINE 的父物件`Block`對象，表示頁面上檢測到的文本行。一條線`Block`對象是構成該行的每個單詞的父項。單詞表示為`Block`類型為 WORD 的對象。 `DetectDocumentText`是同步操作。要異步分析文檔，請使用[StartDocumentTextDetection](API_StartDocumentTextDetection.md)。 如需詳細資訊，請參閱「」[文字偵測](https://docs.aws.amazon.com/textract/latest/dg/how-it-works-detecting.html)。 ## 請求語法 ``` { "Document": { "Bytes": blob, "S3Object": { "Bucket": "string", "Name": "string", "Version": "string" } } } ``` ## 請求參數 請求接受採用 JSON 格式的下列資料。 ** [Document](#API_DetectDocumentText_RequestSyntax) ** 輸入文檔為 base64 編碼的字節或 Amazon S3 對象。如果您使用 AWS CLI 調用 Amazon Textract 操作，則無法傳遞圖像字節。文檔必須是 JPEG 或 PNG 格式的圖像。 如果您使用 AWS 開發工具包調用 Amazon Textract，則可能不需要對使用`Bytes`欄位。 類型：[Document](API_Document.md) 物件 ：必要 是 ## 回應語法 ``` { "Blocks": [ { "BlockType": "string", "ColumnIndex": number, "ColumnSpan": number, "Confidence": number, "EntityTypes": [ "string" ], "Geometry": { "BoundingBox": { "Height": number, "Left": number, "Top": number, "Width": number }, "Polygon": [ { "X": number, "Y": number } ] }, "Id": "string", "Page": number, "Relationships": [ { "Ids": [ "string" ], "Type": "string" } ], "RowIndex": number, "RowSpan": number, "SelectionStatus": "string", "Text": "string", "TextType": "string" } ], "DetectDocumentTextModelVersion": "string", "DocumentMetadata": { "Pages": number } } ``` ## 回應元素 如果動作成功，則服務傳回 HTTP 200 回應。 服務會傳回下列 JSON 格式的資料。 ** [Blocks](#API_DetectDocumentText_ResponseSyntax) ** 陣列`Block`對象，其中包含在文檔中檢測到的文本。 類型：的陣列[Block](API_Block.md)對象 ** [DetectDocumentTextModelVersion](#API_DetectDocumentText_ResponseSyntax) ** 類型：字串 ** [DocumentMetadata](#API_DetectDocumentText_ResponseSyntax) ** 有關文檔的元數據。它包含在文檔中檢測到的頁數。 類型：[DocumentMetadata](API_DocumentMetadata.md) 物件 ## 錯誤 ** AccessDeniedException ** 您未獲授權執行動作。使用已獲授權之使用者或 IAM 角色的 Amazon Resource Name (ARN) 來執行操作。 HTTP 狀態碼：：400 ** BadDocumentException ** Amazon Textract 無法閲讀該文檔。有關 Amazon Textract 中文檔限制的更多信息，請參閲[亞馬遜文字中的硬性限制](limits.md)。 HTTP 狀態碼：：400 ** DocumentTooLargeException ** 無法處理該文檔，因為它太大。同步操作的文件大小上限為 10 MB。對於 PDF 文件，異步操作的最大文檔大小為 500 MB。 HTTP 狀態碼：：400 ** InternalServerError ** Amazon Textract 發生服務問題。請再次嘗試呼叫。 HTTP 狀態碼：：500 ** InvalidParameterException ** 輸入參數違反限制。例如，在同步操作中，`InvalidParameterException`異常發生時，`S3Object`或者`Bytes`值提供在`Document`請求參數。請驗證您的參數，然後再次呼叫 API 操作。 HTTP 狀態碼：：400 ** InvalidS3ObjectException ** Amazon Textract 無法存取請求中指定的 S3 物件。有關詳細信息，請[配置對 Amazon S3 的存取](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html)如需故障診斷資訊，請參閱 。[故障診斷 Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html) HTTP 狀態碼：：400 ** ProvisionedThroughputExceededException ** 請求數超過您的傳輸量限制。如果您希望提高此限制，請聯絡 Amazon Textract。 HTTP 狀態碼：：400 ** ThrottlingException ** Amazon Textract 暫時無法處理請求。請再次嘗試呼叫。 HTTP 狀態碼：：500 ** UnsupportedDocumentException ** 不支持輸入文件的格式。操作文檔可以採用 PNG、JPEG、PDF 或 TIFF 格式。 HTTP 狀態碼：：400 ## 另請參閱 如需在語言特定的 AWS 開發套件之一中使用此 API 的詳細資訊，請參閱下列說明： + [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/textract-2018-06-27/DetectDocumentText) + [適用於 .NET 的 AWS 開發套件](https://docs.aws.amazon.com/goto/DotNetSDKV3/textract-2018-06-27/DetectDocumentText) + [適用於 C\$1\$1 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/DetectDocumentText) + [適用於 Go 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/DetectDocumentText) + [AWS適用於 Java 的開發套件第 2 版](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/DetectDocumentText) + [適用於 JavaScript 的 AWS 開發套件](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/textract-2018-06-27/DetectDocumentText) + [適用於 PHP V3 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/DetectDocumentText) + [適用於 Python 的 AWS 開發套件](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/DetectDocumentText) + [適用於 Ruby V3 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/DetectDocumentText) # GetDocumentAnalysis 獲取分析文檔中文本的 Amazon Textract 異步操作的結果。 您可以通過調用[StartDocumentAnalysis](API_StartDocumentAnalysis.md)，它返回一個作業標識符（`JobId`。當文本分析操作完成後，Amazon Textract 會向亞馬遜 Simple Notification Service (Amazon SNS) 主題發佈完成狀態，該主題在首次調用`StartDocumentAnalysis`。要獲取文本檢測操作的結果，請首先檢查發佈到 Amazon SNS 主題的狀態值是否為`SUCCEEDED`。如果是這樣，請調用`GetDocumentAnalysis`，並傳遞作業標識符（`JobId`）從初始調用到`StartDocumentAnalysis`。 `GetDocumentAnalysis`傳回[Block](API_Block.md)物件。傳回下列類型的資訊： + 資料表單（金鑰值對）。相關資訊會以兩種形式傳回[Block](API_Block.md)對象, 每個類型`KEY_VALUE_SET`：一個金鑰`Block`對象和一個值`Block`物件。例如：*名稱: 安娜·席爾瓦·卡羅萊納州*包含一個鍵和值。*名稱:*是關鍵。*安娜·席爾瓦·卡羅萊納州*是值。 + 表格和表格單元格數據。資料表`Block`對象包含有關檢測到的表的信息。儲存格`Block`對象返回表中的每個單元格。 + 文本的行和單詞。一條線`Block`物件包含一個或多個 WORD`Block`物件。返回文檔中檢測到的所有行和單詞（包括與`StartDocumentAnalysis` `FeatureTypes`輸入參數）。 選擇元素（如複選框和選項按鈕（單選按鈕）可以在表單數據和表格中檢測。選擇元素`Block`對象包含有關選擇元素的信息，包括選擇狀態。 使用`MaxResults`參數來限制傳回的區塊數量。如果結果多於`MaxResults`，值`NextToken`在操作響應中包含一個用於取得下一組結果的字符。若要取得下一頁的結果，請調用`GetDocumentAnalysis`，然後填入`NextToken`請求參數與上一次調用返回的令牌值`GetDocumentAnalysis`。 如需詳細資訊，請參閱「」[文件文字分析](https://docs.aws.amazon.com/textract/latest/dg/how-it-works-analyzing.html)。 ## 請求語法 ``` { "JobId": "string", "MaxResults": number, "NextToken": "string" } ``` ## 請求參數 請求接受採用 JSON 格式的下列資料。 ** [JobId](#API_GetDocumentAnalysis_RequestSyntax) ** 文字檢測任務的唯一識別符。所以此`JobId`從`StartDocumentAnalysis`。一個`JobId`值僅在 7 天內有效。 類型：字串 長度約束：長度下限為 1。長度上限為 64。 模式：`^[a-zA-Z0-9-_]+$` 必要：是 ** [MaxResults](#API_GetDocumentAnalysis_RequestSyntax) ** 每次分頁呼叫可回傳結果的數量上限。您可以指定的最大值為 1,000。如果您指定的值大於 1,000，最多只能傳回 1,000 個結果。預設值為 1,000。 類型：整數 有效範圍：最小值為 1。 必要：否 ** [NextToken](#API_GetDocumentAnalysis_RequestSyntax) ** 如果之前的響應不完整（因為有更多要檢索的塊），Amazon Textract 會在響應中返回一個分頁令牌。您可以使用此分頁符來檢索下一組區塊。 類型：字串 長度約束：長度下限為 1。長度上限為 255。 模式：`.*\S.*` 必要：否 ## 回應語法 ``` { "AnalyzeDocumentModelVersion": "string", "Blocks": [ { "BlockType": "string", "ColumnIndex": number, "ColumnSpan": number, "Confidence": number, "EntityTypes": [ "string" ], "Geometry": { "BoundingBox": { "Height": number, "Left": number, "Top": number, "Width": number }, "Polygon": [ { "X": number, "Y": number } ] }, "Id": "string", "Page": number, "Relationships": [ { "Ids": [ "string" ], "Type": "string" } ], "RowIndex": number, "RowSpan": number, "SelectionStatus": "string", "Text": "string", "TextType": "string" } ], "DocumentMetadata": { "Pages": number }, "JobStatus": "string", "NextToken": "string", "StatusMessage": "string", "Warnings": [ { "ErrorCode": "string", "Pages": [ number ] } ] } ``` ## 回應元素 如果動作成功，則服務傳回 HTTP 200 回應。 服務會傳回下列 JSON 格式的資料。 ** [AnalyzeDocumentModelVersion](#API_GetDocumentAnalysis_ResponseSyntax) ** 類型：字串 ** [Blocks](#API_GetDocumentAnalysis_ResponseSyntax) ** 文本分析操作的結果。 類型：陣列[Block](API_Block.md)對象 ** [DocumentMetadata](#API_GetDocumentAnalysis_ResponseSyntax) ** 有關 Amazon Textract 處理的文檔的信息。`DocumentMetadata`會在 Amazon Textract 視頻操作的分頁響應的每一頁中返回。 類型：[DocumentMetadata](API_DocumentMetadata.md) 物件 ** [JobStatus](#API_GetDocumentAnalysis_ResponseSyntax) ** 文字檢測任務的目前狀態。 類型：字串 有效值：` IN_PROGRESS | SUCCEEDED | FAILED | PARTIAL_SUCCESS` ** [NextToken](#API_GetDocumentAnalysis_ResponseSyntax) ** 如果響應被截斷，Amazon Textract 將返回此令牌。您可以在後續請求中使用此符記來檢索下一組文字檢測結果。 類型：字串 長度約束：長度下限為 1。長度上限為 255。 模式：`.*\S.*` ** [StatusMessage](#API_GetDocumentAnalysis_ResponseSyntax) ** 如果無法完成檢測任務，則會傳回。包含有關發生什麼錯誤的説明。 類型：字串 ** [Warnings](#API_GetDocumentAnalysis_ResponseSyntax) ** 文檔分析操作期間發生的警告列表。 類型：陣列[Warning](API_Warning.md)對象 ## 錯誤 ** AccessDeniedException ** 您未獲授權執行動作。使用已獲授權之使用者或 IAM 角色的 Amazon Resource Name (ARN) 來執行操作。 HTTP 狀態碼：400 ** InternalServerError ** Amazon Textract 發生服務問題。請再次嘗試呼叫。 HTTP 狀態碼：500 ** InvalidJobIdException ** 將無效的作業標識符傳遞給[GetDocumentAnalysis](#API_GetDocumentAnalysis)或[GetDocumentAnalysis](#API_GetDocumentAnalysis)。 HTTP 狀態碼：400 ** InvalidKMSKeyException ** 表示您沒有使用輸入的 KMS 密鑰進行解密權限，或者 KMS 密鑰輸入錯誤。 HTTP 狀態碼：400 ** InvalidParameterException ** 輸入參數違反限制。例如，在同步操作中，`InvalidParameterException`異常發生時，`S3Object`或者`Bytes`值提供在`Document`請求參數。請驗證您的參數，然後再次呼叫 API 操作。 HTTP 狀態碼：400 ** InvalidS3ObjectException ** Amazon Textract 無法存取請求中指定的 S3 物件。有關詳細信息，請[設定對 Amazon S3 的存取](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html)如需故障診斷資訊，請參閱 。[故障診斷 Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html) HTTP 狀態碼：400 ** ProvisionedThroughputExceededException ** 請求數超過您的傳輸量限制。如果您希望提高此限制，請聯絡 Amazon Textract。 HTTP 狀態碼：400 ** ThrottlingException ** Amazon Textract 暫時無法處理請求。請再次嘗試呼叫。 HTTP 狀態碼：500 ## 另請參閱 如需在語言特定的 AWS 開發套件之一中使用此 API 的詳細資訊，請參閱下列說明： + [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/textract-2018-06-27/GetDocumentAnalysis) + [適用於 .NET 的 AWS 開發套件](https://docs.aws.amazon.com/goto/DotNetSDKV3/textract-2018-06-27/GetDocumentAnalysis) + [適用於 C\$1\$1 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/GetDocumentAnalysis) + [適用於 Go 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/GetDocumentAnalysis) + [AWS適用於 Java 的開發套件第 2 版](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/GetDocumentAnalysis) + [適用於 JavaScript 的 AWS 開發套件](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/textract-2018-06-27/GetDocumentAnalysis) + [適用於 PHP V3 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/GetDocumentAnalysis) + [適用於 Python 的 AWS 開發套件](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/GetDocumentAnalysis) + [適用於 Ruby V3 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/GetDocumentAnalysis) # GetDocumentTextDetection 獲取用於檢測文檔中文本的 Amazon Textract 異步操作的結果。Amazon Textract 可以檢測文本行和構成一行文本的單詞。 您可以通過調用[StartDocumentTextDetection](API_StartDocumentTextDetection.md)，它返回一個作業標識符（`JobId`。當文本檢測操作完成後，Amazon Textract 會向亞馬遜 Simple Notification Service (Amazon SNS) 主題發佈完成狀態，該主題在初始調用`StartDocumentTextDetection`。要獲取文本檢測操作的結果，請首先檢查發佈到 Amazon SNS 主題的狀態值是否為`SUCCEEDED`。如果是這樣，請調用`GetDocumentTextDetection`，並傳遞作業標識符（`JobId`）從初始調用到`StartDocumentTextDetection`。 `GetDocumentTextDetection`傳回一個[Block](API_Block.md)物件。 每個文檔頁面都有一個關聯的`Block`類型為頁面。每頁`Block`物件是 LINE 的父項`Block`對象，表示頁面上檢測到的文本行。一條線`Block`對象是構成該行的每個單詞的父項。單詞表示為`Block`類型為 WORD 的對象。 使用 MaxResults 參數來限制傳回的塊數量。如果結果多於`MaxResults`，值`NextToken`在操作響應中包含一個用於取得下一組結果的分頁符記。若要取得下一頁的結果，請調用`GetDocumentTextDetection`，然後填入`NextToken`請求參數與上一次調用返回的令牌值`GetDocumentTextDetection`。 如需詳細資訊，請參閱「」[文件文字偵測](https://docs.aws.amazon.com/textract/latest/dg/how-it-works-detecting.html)。 ## 請求語法 ``` { "JobId": "string", "MaxResults": number, "NextToken": "string" } ``` ## 請求參數 請求接受採用 JSON 格式的下列資料。 ** [JobId](#API_GetDocumentTextDetection_RequestSyntax) ** 文字偵測任務的唯一識別符。所以此`JobId`從傳回`StartDocumentTextDetection`。一個`JobId`值僅在 7 天內有效。 類型：字串 長度限制：長度下限為 1。長度上限為 64。 模式：`^[a-zA-Z0-9-_]+$` ：必要 是 ** [MaxResults](#API_GetDocumentTextDetection_RequestSyntax) ** 每筆分頁呼叫傳回結果的數量上限。您可以指定的最大值為 1,000。如果您指定的值大於 1,000，最多只能傳回 1,000 個結果。預設值為 1,000。 類型：整數 有效範圍：最小值為 1。 ：必要 否 ** [NextToken](#API_GetDocumentTextDetection_RequestSyntax) ** 如果之前的響應不完整（因為有更多要檢索的塊），Amazon Textract 會在響應中返回一個分頁令牌。您可以使用此分頁符記來取回下一組塊。 類型：字串 長度限制：長度下限為 1。長度上限為 255。 模式：`.*\S.*` ：必要 否 ## 回應語法 ``` { "Blocks": [ { "BlockType": "string", "ColumnIndex": number, "ColumnSpan": number, "Confidence": number, "EntityTypes": [ "string" ], "Geometry": { "BoundingBox": { "Height": number, "Left": number, "Top": number, "Width": number }, "Polygon": [ { "X": number, "Y": number } ] }, "Id": "string", "Page": number, "Relationships": [ { "Ids": [ "string" ], "Type": "string" } ], "RowIndex": number, "RowSpan": number, "SelectionStatus": "string", "Text": "string", "TextType": "string" } ], "DetectDocumentTextModelVersion": "string", "DocumentMetadata": { "Pages": number }, "JobStatus": "string", "NextToken": "string", "StatusMessage": "string", "Warnings": [ { "ErrorCode": "string", "Pages": [ number ] } ] } ``` ## 回應元素 如果動作成功，則服務傳回 HTTP 200 回應。 服務會傳回下列 JSON 格式的資料。 ** [Blocks](#API_GetDocumentTextDetection_ResponseSyntax) ** 文本檢測操作的結果。 類型：的陣列[Block](API_Block.md)對象 ** [DetectDocumentTextModelVersion](#API_GetDocumentTextDetection_ResponseSyntax) ** 類型：字串 ** [DocumentMetadata](#API_GetDocumentTextDetection_ResponseSyntax) ** 有關 Amazon Textract 處理的文檔的信息。`DocumentMetadata`會在 Amazon Textract 視頻操作的分頁響應的每一頁中返回。 類型：[DocumentMetadata](API_DocumentMetadata.md) 物件 ** [JobStatus](#API_GetDocumentTextDetection_ResponseSyntax) ** 文字偵測任務的目前狀態。 類型：字串 有效值：` IN_PROGRESS | SUCCEEDED | FAILED | PARTIAL_SUCCESS` ** [NextToken](#API_GetDocumentTextDetection_ResponseSyntax) ** 如果響應被截斷，Amazon Textract 將返回此令牌。您可以在後續請求中使用此符記來檢索下一組文字偵測結果。 類型：字串 長度限制：長度下限為 1。長度上限為 255。 模式：`.*\S.*` ** [StatusMessage](#API_GetDocumentTextDetection_ResponseSyntax) ** 如果無法完成檢測任務，則返回。包含有關發生什麼錯誤的説明。 類型：字串 ** [Warnings](#API_GetDocumentTextDetection_ResponseSyntax) ** 文檔的文本檢測操作過程中發生的警告列表。 類型：的陣列[Warning](API_Warning.md)對象 ## 錯誤 ** AccessDeniedException ** 您未獲授權執行動作。使用已獲授權之使用者或 IAM 角色的 Amazon Resource Name (ARN) 來執行操作。 HTTP 狀態碼：400 ** InternalServerError ** Amazon Textract 發生服務問題。請再次嘗試呼叫。 HTTP 狀態碼：500 ** InvalidJobIdException ** 將無效的作業標識符傳遞給[GetDocumentAnalysis](API_GetDocumentAnalysis.md)或[GetDocumentAnalysis](API_GetDocumentAnalysis.md)。 HTTP 狀態碼：400 ** InvalidKMSKeyException ** 表示您沒有使用輸入的 KMS 密鑰進行解密權限，或者 KMS 密鑰輸入錯誤。 HTTP 狀態碼：400 ** InvalidParameterException ** 輸入參數違反限制。例如，在同步操作中，`InvalidParameterException`異常發生時，`S3Object`或者`Bytes`值提供在`Document`請求參數。請驗證您的參數，然後再次呼叫 API 操作。 HTTP 狀態碼：400 ** InvalidS3ObjectException ** Amazon Textract 無法存取請求中指定的 S3 物件。有關更多信息，請[設定 Amazon S3 的存取](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html)如需故障診斷資訊，請參閱 。[故障診斷 Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html) HTTP 狀態碼：400 ** ProvisionedThroughputExceededException ** 請求數超過您的傳輸量限制。如果您希望提高此限制，請聯絡 Amazon Textract。 HTTP 狀態碼：400 ** ThrottlingException ** Amazon Textract 暫時無法處理請求。請再次嘗試呼叫。 HTTP 狀態碼：500 ## 另請參閱 如需在語言特定的 AWS 開發套件之一中使用此 API 的詳細資訊，請參閱下列說明： + [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/textract-2018-06-27/GetDocumentTextDetection) + [適用於 .NET 的 AWS 開發套件](https://docs.aws.amazon.com/goto/DotNetSDKV3/textract-2018-06-27/GetDocumentTextDetection) + [適用於 C\$1\$1 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/GetDocumentTextDetection) + [適用於 Go 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/GetDocumentTextDetection) + [AWS適用於 Java 的開發套件第 2 版](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/GetDocumentTextDetection) + [適用於 JavaScript 的 AWS 開發套件](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/textract-2018-06-27/GetDocumentTextDetection) + [適用於 PHP V3 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/GetDocumentTextDetection) + [適用於 Python 的 AWS 開發套件](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/GetDocumentTextDetection) + [適用於 Ruby V3 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/GetDocumentTextDetection) # GetExpenseAnalysis 獲取分析發票和收據的 Amazon Textract 異步操作的結果。Amazon Textract 從輸入的發票和收據中查找聯繫信息、購買的商品和供應商名稱。 啟動異步發票/收據分析，方法是調用[StartExpenseAnalysis](API_StartExpenseAnalysis.md)，它返回一個作業標識符（`JobId`。在完成發票/收據分析後，Amazon Textract 會將完成狀態發佈到 Amazon Simple Notification Service (Amazon SNS) 主題。此主題必須在初始調用`StartExpenseAnalysis`。若要取得發票/收據分析操作結果，首先請確認 Amazon SNS 主題的狀態值為`SUCCEEDED`。如果是這樣，請調用`GetExpenseAnalysis`，並傳遞作業標識符（`JobId`）從初始調用到`StartExpenseAnalysis`。 使用 MaxResults 參數來限制傳回的塊數量。如果結果多於`MaxResults`，值`NextToken`在操作響應中包含用於取得下一組結果的字符。若要取得下一頁的結果，請調用`GetExpenseAnalysis`，然後填入`NextToken`請求參數與上一次調用返回的令牌值`GetExpenseAnalysis`。 如需詳細資訊，請參閱「」[分析發票和收款](https://docs.aws.amazon.com/textract/latest/dg/invoices-receipts.html)。 ## 請求語法 ``` { "JobId": "string", "MaxResults": number, "NextToken": "string" } ``` ## 請求參數 請求接受採用 JSON 格式的下列資料。 ** [JobId](#API_GetExpenseAnalysis_RequestSyntax) ** 文本檢測任務的唯一識別碼。所以此`JobId`從傳回`StartExpenseAnalysis`。一個`JobId`值只能保留 7 天。 類型：字串 限制：長度下限為 1。長度上限為 64。 模式：`^[a-zA-Z0-9-_]+$` ：必要 是 ** [MaxResults](#API_GetExpenseAnalysis_RequestSyntax) ** 每次分頁呼叫可回傳結果的數量上限。您可以指定的最大值為 20。如果您指定的值大於 20，最多只能傳回 20 個結果。預設值為 20。 類型：整數 有效範圍：最小值為 1。 ：必要 否 ** [NextToken](#API_GetExpenseAnalysis_RequestSyntax) ** 如果之前的響應不完整（因為有更多要檢索的塊），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](#API_GetExpenseAnalysis_ResponseSyntax) ** 分析費用的當前模型版本。 類型：字串 ** [DocumentMetadata](#API_GetExpenseAnalysis_ResponseSyntax) ** 有關 Amazon Textract 處理的文檔的信息。`DocumentMetadata`會在 Amazon Textract 操作的分頁響應的每一頁中返回。 類型：[DocumentMetadata](API_DocumentMetadata.md) 物件 ** [ExpenseDocuments](#API_GetExpenseAnalysis_ResponseSyntax) ** Amazon Textract 檢測到的費用。 類型：的陣列[ExpenseDocument](API_ExpenseDocument.md)對象 ** [JobStatus](#API_GetExpenseAnalysis_ResponseSyntax) ** 文本檢測任務的目前狀態。 類型：字串 有效值：` IN_PROGRESS | SUCCEEDED | FAILED | PARTIAL_SUCCESS` ** [NextToken](#API_GetExpenseAnalysis_ResponseSyntax) ** 如果響應被截斷，Amazon Textract 將返回此令牌。您可以在後續請求中使用此符記來檢索下一組文本檢測結果。 類型：字串 限制：長度下限為 1。長度上限為 255。 模式：`.*\S.*` ** [StatusMessage](#API_GetExpenseAnalysis_ResponseSyntax) ** 如果無法完成檢測任務，則返回。包含有關發生什麼錯誤的説明。 類型：字串 ** [Warnings](#API_GetExpenseAnalysis_ResponseSyntax) ** 文檔的文本檢測操作過程中發生的警告列表。 類型：的陣列[Warning](API_Warning.md)對象 ## 錯誤 ** AccessDeniedException ** 您未獲授權執行動作。使用已獲授權之使用者或 IAM 角色的 Amazon Resource Name (ARN) 來執行操作。 HTTP 狀態碼：400 ** InternalServerError ** Amazon Textract 發生服務問題。請再次嘗試呼叫。 HTTP 狀態碼：500 ** InvalidJobIdException ** 將無效的作業標識符傳遞給[GetDocumentAnalysis](API_GetDocumentAnalysis.md)或[GetDocumentAnalysis](API_GetDocumentAnalysis.md)。 HTTP 狀態碼：400 ** InvalidKMSKeyException ** 表示您沒有使用輸入的 KMS 密鑰進行解密權限，或者 KMS 密鑰輸入錯誤。 HTTP 狀態碼：400 ** InvalidParameterException ** 輸入參數違反限制。例如，在同步操作中，`InvalidParameterException`異常發生時，`S3Object`或者`Bytes`值提供在`Document`請求參數。請驗證您的參數，然後再次呼叫 API 操作。 HTTP 狀態碼：400 ** InvalidS3ObjectException ** Amazon Textract 無法存取請求中指定的 S3 物件。有關詳細信息，請[設定對 Amazon S3 的存取](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html)如需故障診斷資訊，請參閱 。[故障診斷 Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html) HTTP 狀態碼：400 ** ProvisionedThroughputExceededException ** 請求數超過您的傳輸量限制。如果您想要提高此限制，請聯絡 Amazon Textract。 HTTP 狀態碼：400 ** ThrottlingException ** Amazon Textract 暫時無法處理請求。請再次嘗試呼叫。 HTTP 狀態碼：500 ## 另請參閱 如需在語言特定的 AWS 開發套件之一中使用此 API 的詳細資訊，請參閱下列說明： + [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/textract-2018-06-27/GetExpenseAnalysis) + [適用於 .NET 的 AWS 開發套件](https://docs.aws.amazon.com/goto/DotNetSDKV3/textract-2018-06-27/GetExpenseAnalysis) + [適用於 C\$1\$1 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/GetExpenseAnalysis) + [適用於 Go 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/GetExpenseAnalysis) + [AWS適用於 Java 的開發套件第 2 版](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/GetExpenseAnalysis) + [適用於 JavaScript 的 AWS 開發套件](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/textract-2018-06-27/GetExpenseAnalysis) + [適用於 PHP V3 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/GetExpenseAnalysis) + [適用於 Python 的 AWS 開發套件](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/GetExpenseAnalysis) + [適用於 Ruby V3 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/GetExpenseAnalysis) # StartDocumentAnalysis 開始對輸入檔的異步分析，以瞭解檢測到的項目之間的關係，例如鍵值組、表格和選擇元素。 `StartDocumentAnalysis`可以分析 JPEG、PNG、TIFF 和 PDF 格式的文檔中的文本。這些文件存放在 Amazon S3 儲存貯體中。使用[DocumentLocation](API_DocumentLocation.md)指定文件的儲存貯體與影片檔名稱。 `StartDocumentAnalysis`返回一個作業標識符 (`JobId`），您可以用來獲取操作的結果。文字分析完成後，Amazon Textract 會將完成狀態態碼發佈至您在`NotificationChannel`。要獲取文本分析操作的結果，請首先檢查發佈到 Amazon SNS 主題的狀態值是否為`SUCCEEDED`。如果是這樣，請調用[GetDocumentAnalysis](API_GetDocumentAnalysis.md)，並傳遞作業標識符（`JobId`）從初始調用到`StartDocumentAnalysis`。 如需詳細資訊，請參閱「」[文件文字分析](https://docs.aws.amazon.com/textract/latest/dg/how-it-works-analyzing.html)。 ## 請求語法 ``` { "ClientRequestToken": "string", "DocumentLocation": { "S3Object": { "Bucket": "string", "Name": "string", "Version": "string" } }, "FeatureTypes": [ "string" ], "JobTag": "string", "KMSKeyId": "string", "NotificationChannel": { "RoleArn": "string", "SNSTopicArn": "string" }, "OutputConfig": { "S3Bucket": "string", "S3Prefix": "string" } } ``` ## 請求參數 請求接受採用 JSON 格式的下列資料。 ** [ClientRequestToken](#API_StartDocumentAnalysis_RequestSyntax) ** 用於標識啟動請求的冪等令牌。如果您將相同的令牌與多個`StartDocumentAnalysis`請求，相同`JobId`將傳回。使用`ClientRequestToken`以防止同一作業意外多次啟動。如需詳細資訊，請參閱「」[調用 Amazon Textract 異步操作](https://docs.aws.amazon.com/textract/latest/dg/api-async.html)。 類型：字串 長度限制：長度下限為 1。長度上限為 64。 模式：`^[a-zA-Z0-9-_]+$` ：必要 否 ** [DocumentLocation](#API_StartDocumentAnalysis_RequestSyntax) ** 要處理的文檔的位置。 類型：[DocumentLocation](API_DocumentLocation.md) 物件 ：必要 是 ** [FeatureTypes](#API_StartDocumentAnalysis_RequestSyntax) ** 要執行的分析類型的列表。將 TABLE 添加到列表以返回有關輸入文檔中檢測到的表的信息。添加表單以返回檢測到的表單數據。要執行這兩種類型的分析，請將表和表格添加到`FeatureTypes`。文檔中檢測到的所有行和單詞都包含在響應中（包括與`FeatureTypes`。 類型：字串陣列 有效值：` TABLES | FORMS` ：必要 是 ** [JobTag](#API_StartDocumentAnalysis_RequestSyntax) ** 您指定的標識符，該編碼包含在發佈到 Amazon SNS 主題的完成通知中。例如，您可以使用`JobTag`標識完成通知對應的單據類型（例如納税表或收據）。 類型：字串 長度限制：長度下限為 1。長度上限為 64。 模式：`[a-zA-Z0-9_.\-:]+` ：必要 否 ** [KMSKeyId](#API_StartDocumentAnalysis_RequestSyntax) ** 用來加密推斷結果的 KMS 金鑰。這可以是密鑰 ID 或密鑰別名格式。提供 KMS 密鑰後，KMS 密鑰將用於客户存儲桶中的對象的服務器端加密。如果未啟用此參數，則結果將使用 SSE-S3 加密服務器端。 類型：字串 長度限制：長度下限為 1。長度上限為 2048。 模式：`^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$` ：必要 否 ** [NotificationChannel](#API_StartDocumentAnalysis_RequestSyntax) ** 您希望亞馬 Amazon Textract 將操作的完成狀態發佈到的 Amazon SNS 主題 ARN。 類型：[NotificationChannel](API_NotificationChannel.md) 物件 ：必要 否 ** [OutputConfig](#API_StartDocumentAnalysis_RequestSyntax) ** 設置輸出是否轉到客户定義的時段。默認情況下，Amazon Textract 系統會在內部保存結果，以供 GetDocumentAnalysis 操作訪問。 類型：[OutputConfig](API_OutputConfig.md) 物件 ：必要 否 ## 回應語法 ``` { "JobId": "string" } ``` ## 回應元素 如果動作成功，則服務傳回 HTTP 200 回應。 服務會傳回下列 JSON 格式的資料。 ** [JobId](#API_StartDocumentAnalysis_ResponseSyntax) ** 文件文字偵測任務的識別碼。使用`JobId`在後續調用中標識作業`GetDocumentAnalysis`。一個`JobId`值僅在 7 天內有效。 類型：字串 長度限制：長度下限為 1。長度上限為 64。 模式：`^[a-zA-Z0-9-_]+$` ## 錯誤 ** AccessDeniedException ** 您未獲授權執行動作。使用已獲授權之使用者或 IAM 角色的 Amazon Resource Name (ARN) 來執行操作。 HTTP 狀態碼：400 ** BadDocumentException ** Amazon Textract 無法閲讀該文檔。有關 Amazon Textract 中文檔限制的更多信息，請參閲[亞馬遜文字中的硬性限制](limits.md)。 HTTP 狀態碼：400 ** DocumentTooLargeException ** 無法處理該文檔，因為它太大。同步操作的最大文件大小為 10 MB。對於 PDF 文件，異步操作的最大文檔大小為 500 MB。 HTTP 狀態碼：400 ** IdempotentParameterMismatchException ** 一個`ClientRequestToken`輸入參數重複用於一個操作，但至少有一個其他輸入參數不同於先前對操作的呼叫。 HTTP 狀態碼：400 ** InternalServerError ** Amazon Textract 發生服務問題。請再次嘗試呼叫。 HTTP 狀態碼：500 ** InvalidKMSKeyException ** 表示您沒有使用輸入的 KMS 密鑰進行解密權限，或者 KMS 密鑰輸入錯誤。 HTTP 狀態碼：400 ** InvalidParameterException ** 輸入參數違反限制。例如，在同步操作中，`InvalidParameterException`異常發生時，`S3Object`或者`Bytes`值提供在`Document`請求參數。請驗證您的參數，然後再次呼叫 API 操作。 HTTP 狀態碼：400 ** InvalidS3ObjectException ** Amazon Textract 無法存取請求中指定的 S3 物件。有關詳細信息，請[設定對 Amazon S3 的存取](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html)如需故障診斷資訊，請參閱 。[故障診斷 Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html) HTTP 狀態碼：400 ** LimitExceededException ** 超出 Amazon Textract 服務限制。例如，如果您同時啟動太多的異步作業，則調用以啟動操作 (`StartDocumentTextDetection`）將引發 LimitExceededException 制 (HTTP 狀態碼：400)，直到數量同時執行任務的數量低於 Amazon Textract 服務限制。 HTTP 狀態碼：400 ** ProvisionedThroughputExceededException ** 請求數超過您的傳輸量限制。如果您希望提高此限制，請聯絡 Amazon Textract。 HTTP 狀態碼：400 ** ThrottlingException ** Amazon Textract 暫時無法處理請求。請再次嘗試呼叫。 HTTP 狀態碼：500 ** UnsupportedDocumentException ** 不支持輸入檔的格式。操作文檔可以採用 PNG、JPEG、PDF 或 TIFF 格式。 HTTP 狀態碼：400 ## 另請參閱 如需在語言特定的 AWS 開發套件之一中使用此 API 的詳細資訊，請參閱下列說明： + [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/textract-2018-06-27/StartDocumentAnalysis) + [適用於 .NET 的 AWS 開發套件](https://docs.aws.amazon.com/goto/DotNetSDKV3/textract-2018-06-27/StartDocumentAnalysis) + [適用於 C\$1\$1 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/StartDocumentAnalysis) + [適用於 Go 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/StartDocumentAnalysis) + [AWS適用於 Java 的開發套件第 2 版](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/StartDocumentAnalysis) + [適用於 JavaScript 的 AWS 開發套件](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/textract-2018-06-27/StartDocumentAnalysis) + [適用於 PHP V3 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/StartDocumentAnalysis) + [適用於 Python 的 AWS 開發套件](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/StartDocumentAnalysis) + [適用於 Ruby V3 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/StartDocumentAnalysis) # StartDocumentTextDetection 開始非同步偵測文件中的文字。Amazon Textract 可以檢測文本行和構成一行文本的單詞。 `StartDocumentTextDetection`可以分析 JPEG、PNG、TIFF 和 PDF 格式的文檔中的文本。這些文件存放在 Amazon S3 儲存貯體中。使用[DocumentLocation](API_DocumentLocation.md)指定文件的儲存貯體與影片檔名稱。 `StartTextDetection`返回一個作業標識符 (`JobId`），用於獲取操作結果。文字偵測完成後，Amazon Textract 會將完成狀態發佈至 Amazon Simple Notification Service (Amazon SNS) 主題的完成狀態，而此主題會傳送至您在`NotificationChannel`。要獲取文本檢測操作的結果，請首先檢查發佈到 Amazon SNS 主題的狀態值是`SUCCEEDED`。如果是這樣，請調用[GetDocumentTextDetection](API_GetDocumentTextDetection.md)，並傳遞作業標識符（`JobId`）從初始調用到`StartDocumentTextDetection`。 如需詳細資訊，請參閱「」[文件文字偵測](https://docs.aws.amazon.com/textract/latest/dg/how-it-works-detecting.html)。 ## 請求語法 ``` { "ClientRequestToken": "string", "DocumentLocation": { "S3Object": { "Bucket": "string", "Name": "string", "Version": "string" } }, "JobTag": "string", "KMSKeyId": "string", "NotificationChannel": { "RoleArn": "string", "SNSTopicArn": "string" }, "OutputConfig": { "S3Bucket": "string", "S3Prefix": "string" } } ``` ## 請求參數 請求接受採用 JSON 格式的下列資料。 ** [ClientRequestToken](#API_StartDocumentTextDetection_RequestSyntax) ** 用於標識啟動請求的冪等令牌。如果您將相同的令牌與多個`StartDocumentTextDetection`請求，相同`JobId`傳回。使用`ClientRequestToken`以防止同一作業意外多次啟動。如需詳細資訊，請參閱「」[調用 Amazon Textract 異步操作](https://docs.aws.amazon.com/textract/latest/dg/api-async.html)。 類型：字串 長度限制：長度下限為 1。長度上限為 64。 模式：`^[a-zA-Z0-9-_]+$` ：必要 否 ** [DocumentLocation](#API_StartDocumentTextDetection_RequestSyntax) ** 要處理的文檔的位置。 類型：[DocumentLocation](API_DocumentLocation.md) 物件 ：必要 是 ** [JobTag](#API_StartDocumentTextDetection_RequestSyntax) ** 您指定的標識符，該編碼包含在發佈到 Amazon SNS 主題的完成通知中。例如，您可以使用`JobTag`標識完成通知對應的單據類型（例如納税表或收據）。 類型：字串 長度限制：長度下限為 1。長度上限為 64。 模式：`[a-zA-Z0-9_.\-:]+` ：必要 否 ** [KMSKeyId](#API_StartDocumentTextDetection_RequestSyntax) ** 用於加密推斷結果的 KMS 金鑰。此格式可以是密鑰 ID 或密鑰別名格式。提供 KMS 密鑰後，KMS 密鑰將用於客户存儲桶中的對象的服務器端加密。如果未啟用此參數，則結果將使用 SSE-S3 加密服務器端。 類型：字串 長度限制：長度下限為 1。長度上限為 2048。 模式：`^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$` ：必要 否 ** [NotificationChannel](#API_StartDocumentTextDetection_RequestSyntax) ** 您希望亞馬 Amazon Textract 將操作的完成狀態發佈到的 Amazon SNS 主題 ARN。 類型：[NotificationChannel](API_NotificationChannel.md) 物件 ：必要 否 ** [OutputConfig](#API_StartDocumentTextDetection_RequestSyntax) ** 設置輸出是否轉到客户定義的存儲段。默認情況下，Amazon Textract 將在內部保存結果，以便通過獲取 GetDocumentTextDetection 操作進行訪問。 類型：[OutputConfig](API_OutputConfig.md) 物件 ：必要 否 ## 回應語法 ``` { "JobId": "string" } ``` ## 回應元素 如果動作成功，則服務傳回 HTTP 200 回應。 服務會傳回下列 JSON 格式的資料。 ** [JobId](#API_StartDocumentTextDetection_ResponseSyntax) ** 文檔的文本檢測作業的標識符。使用`JobId`在後續調用中標識作業`GetDocumentTextDetection`。一個`JobId`值僅在 7 天內有效。 類型：字串 長度限制：長度下限為 1。長度上限為 64。 模式：`^[a-zA-Z0-9-_]+$` ## 錯誤 ** AccessDeniedException ** 您未獲授權執行動作。使用已獲授權之使用者或 IAM 角色的 Amazon Resource Name (ARN) 來執行操作。 HTTP 狀態碼：400 ** BadDocumentException ** Amazon Textract 無法閲讀該文檔。有關 Amazon Textract 中文檔限制的更多信息，請參閲[亞馬遜文字中的硬性限制](limits.md)。 HTTP 狀態碼：400 ** DocumentTooLargeException ** 無法處理該文檔，因為它太大。同步操作的最大文件大小為 10 MB。對於 PDF 文件，異步操作的最大文檔大小為 500 MB。 HTTP 狀態碼：400 ** IdempotentParameterMismatchException ** 一個`ClientRequestToken`輸入參數與操作一起重複用，但至少有一個其他輸入參數不同於先前對操作的呼叫。 HTTP 狀態碼：400 ** InternalServerError ** Amazon Textract 發生服務問題。請再次嘗試呼叫。 HTTP 狀態碼：500 ** InvalidKMSKeyException ** 表示您沒有使用輸入的 KMS 密鑰進行解密權限，或者 KMS 密鑰輸入錯誤。 HTTP 狀態碼：400 ** InvalidParameterException ** 輸入參數違反限制。例如，在同步操作中，`InvalidParameterException`異常發生時，`S3Object`或者`Bytes`值提供在`Document`請求參數。請驗證您的參數，然後再次呼叫 API 操作。 HTTP 狀態碼：400 ** InvalidS3ObjectException ** Amazon Textract 無法存取請求中指定的 S3 物件。有關詳細信息，請[設定對 Amazon S3 的存取](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html)如需故障診斷資訊，請參閱 。[故障診斷 Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html) HTTP 狀態碼：400 ** LimitExceededException ** 超出 Amazon Textract 服務限制。例如，如果您同時啟動太多的異步作業，則調用以啟動操作 (`StartDocumentTextDetection`）引發限制拒絕例外狀況 (HTTP 狀態碼：400)，直到數量同時執行任務的數量低於 Amazon Textract 服務限制。 HTTP 狀態碼：400 ** ProvisionedThroughputExceededException ** 請求數超過您的傳輸量限制。如果您希望提高此限制，請聯絡 Amazon Textract。 HTTP 狀態碼：400 ** ThrottlingException ** Amazon Textract 暫時無法處理請求。請再次嘗試呼叫。 HTTP 狀態碼：500 ** UnsupportedDocumentException ** 不支持輸入檔案的格式。操作文檔可以採用 PNG、JPEG、PDF 或 TIFF 格式。 HTTP 狀態碼：400 ## 另請參閱 如需在語言特定的 AWS 開發套件之一中使用此 API 的詳細資訊，請參閱下列說明： + [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/textract-2018-06-27/StartDocumentTextDetection) + [適用於 .NET 的 AWS 開發套件](https://docs.aws.amazon.com/goto/DotNetSDKV3/textract-2018-06-27/StartDocumentTextDetection) + [適用於 C\$1\$1 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/StartDocumentTextDetection) + [適用於 Go 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/StartDocumentTextDetection) + [AWS適用於 Java 的開發套件第 2 版](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/StartDocumentTextDetection) + [適用於 JavaScript 的 AWS 開發套件](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/textract-2018-06-27/StartDocumentTextDetection) + [適用於 PHP V3 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/StartDocumentTextDetection) + [適用於 Python 的 AWS 開發套件](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/StartDocumentTextDetection) + [適用於 Ruby V3 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/StartDocumentTextDetection) # StartExpenseAnalysis 開始對聯繫信息、購買物料和供應商名稱等數據的發票或收據進行異步分析。 `StartExpenseAnalysis`可以分析 JPEG、PNG 和 PDF 格式的文檔中的文本。文件必要儲存在 Amazon S3 儲存貯體中。使用[DocumentLocation](API_DocumentLocation.md)參數指定您的 S3 儲存貯體名稱以及該儲存貯體中檔案的名稱。 `StartExpenseAnalysis`返回一個作業標識符 (`JobId`），您將提供給`GetExpenseAnalysis`檢索操作的結果。完成對輸入發票/收據的分析後，Amazon Textract 會向您提供的亞馬遜 Simple Notification Service (Amazon SNS) 主題發佈完成狀態。`NotificationChannel`。要獲得發票和收據分析操作的結果，請確保發佈到 Amazon SNS 主題的狀態值為`SUCCEEDED`。如果是這樣，請調用[GetExpenseAnalysis](API_GetExpenseAnalysis.md)，並傳遞作業標識符（`JobId`），您通過調用`StartExpenseAnalysis`。 如需詳細資訊，請參閱「」[分析發票和收款](https://docs.aws.amazon.com/textract/latest/dg/invoice-receipts.html)。 ## 請求語法 ``` { "ClientRequestToken": "string", "DocumentLocation": { "S3Object": { "Bucket": "string", "Name": "string", "Version": "string" } }, "JobTag": "string", "KMSKeyId": "string", "NotificationChannel": { "RoleArn": "string", "SNSTopicArn": "string" }, "OutputConfig": { "S3Bucket": "string", "S3Prefix": "string" } } ``` ## 請求參數 請求接受採用 JSON 格式的下列資料。 ** [ClientRequestToken](#API_StartExpenseAnalysis_RequestSyntax) ** 用於標識啟動請求的冪等令牌。如果您將相同的令牌與多個`StartDocumentTextDetection`請求，相同`JobId`傳回。使用`ClientRequestToken`以防止同一作業意外多次啟動。如需詳細資訊，請參閱「」[調用 Amazon Textract 異步操作](https://docs.aws.amazon.com/textract/latest/dg/api-async.html) 類型：字串 長度限制：長度下限為 1。長度上限為 64。 模式：`^[a-zA-Z0-9-_]+$` ：必要 否 ** [DocumentLocation](#API_StartExpenseAnalysis_RequestSyntax) ** 要處理的文檔的位置。 類型：[DocumentLocation](API_DocumentLocation.md) 物件 ：必要 是 ** [JobTag](#API_StartExpenseAnalysis_RequestSyntax) ** 您指定的標識符，該編碼包含在發佈到 Amazon SNS 主題的完成通知中。例如，您可以使用`JobTag`標識完成通知對應的單據類型（例如納税表或收據）。 類型：字串 長度限制：長度下限為 1。長度上限為 64。 模式：`[a-zA-Z0-9_.\-:]+` ：必要 否 ** [KMSKeyId](#API_StartExpenseAnalysis_RequestSyntax) ** 用來加密推理結果的 KMS 金鑰。此格式可以是密鑰 ID 或密鑰別名格式。提供 KMS 密鑰後，KMS 密鑰將用於客户存儲桶中的對象的服務器端加密。如果未啟用此參數，則結果將使用 SSE-S3 加密服務器端。 類型：字串 長度限制：長度下限為 1。長度上限為 2048。 模式：`^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$` ：必要 否 ** [NotificationChannel](#API_StartExpenseAnalysis_RequestSyntax) ** 您希望亞馬 Amazon Textract 將操作的完成狀態發佈到的 Amazon SNS 主題 ARN。 類型：[NotificationChannel](API_NotificationChannel.md) 物件 ：必要 否 ** [OutputConfig](#API_StartExpenseAnalysis_RequestSyntax) ** 設置輸出是否轉到客户定義的存儲段。默認情況下，Amazon Textract 會在內部保存結果，以便`GetExpenseAnalysis`operation. 類型：[OutputConfig](API_OutputConfig.md) 物件 ：必要 否 ## 回應語法 ``` { "JobId": "string" } ``` ## 回應元素 如果動作成功，則服務傳回 HTTP 200 回應。 服務會傳回下列 JSON 格式的資料。 ** [JobId](#API_StartExpenseAnalysis_ResponseSyntax) ** 文本檢測任務的唯一識別符。所以此`JobId`從傳回`StartExpenseAnalysis`。一個`JobId`值僅在 7 天內有效。 類型：字串 長度限制：長度下限為 1。長度上限為 64。 模式：`^[a-zA-Z0-9-_]+$` ## 錯誤 ** AccessDeniedException ** 您未獲授權執行動作。使用已獲授權之使用者或 IAM 角色的 Amazon Resource Name (ARN) 來執行操作。 HTTP 狀態碼：400 ** BadDocumentException ** Amazon Textract 無法閲讀該文檔。有關 Amazon Textract 中文檔限制的更多信息，請參閲[亞馬遜文字中的硬性限制](limits.md)。 HTTP 狀態碼：400 ** DocumentTooLargeException ** 無法處理該文檔，因為它太大。同步操作的最大檔案大小為 10 MB。對於 PDF 文件，異步操作的最大文檔大小為 500 MB。 HTTP 狀態碼：400 ** IdempotentParameterMismatchException ** 一個`ClientRequestToken`輸入參數重複用於一個操作，但至少有一個其他輸入參數不同於先前對操作的呼叫。 HTTP 狀態碼：400 ** InternalServerError ** Amazon Textract 發生服務問題。請再次嘗試呼叫。 HTTP 狀態碼：500 ** InvalidKMSKeyException ** 表示您沒有使用輸入的 KMS 密鑰進行解密權限，或者 KMS 密鑰輸入錯誤。 HTTP 狀態碼：400 ** InvalidParameterException ** 輸入參數違反限制。例如，在同步操作中，`InvalidParameterException`異常發生時，`S3Object`或者`Bytes`值提供在`Document`請求參數。請驗證您的參數，然後再次呼叫 API 操作。 HTTP 狀態碼：400 ** InvalidS3ObjectException ** Amazon Textract 無法存取請求中指定的 S3 物件。有關詳細信息，請[設定對 Amazon S3 的存取](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html)如需故障診斷資訊，請參閱 。[故障診斷 Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html) HTTP 狀態碼：400 ** LimitExceededException ** 超出 Amazon Textract 服務限制。例如，如果您同時啟動太多的異步作業，則調用以啟動操作 (`StartDocumentTextDetection`）引發限制拒絕例外狀況 (HTTP 狀態碼：400)，直到數量同時執行任務的數量低於 Amazon Textract 服務限制。 HTTP 狀態碼：400 ** ProvisionedThroughputExceededException ** 請求數超過您的傳輸量限制。如果您希望提高此限制，請聯絡 Amazon Textract。 HTTP 狀態碼：400 ** ThrottlingException ** Amazon Textract 暫時無法處理請求。請再次嘗試呼叫。 HTTP 狀態碼：500 ** UnsupportedDocumentException ** 輸入檔案的格式不受支持。操作文檔可以採用 PNG、JPEG、PDF 或 TIFF 格式。 HTTP 狀態碼：400 ## 另請參閱 如需在語言特定的 AWS 開發套件之一中使用此 API 的詳細資訊，請參閱下列說明： + [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/textract-2018-06-27/StartExpenseAnalysis) + [適用於 .NET 的 AWS 開發套件](https://docs.aws.amazon.com/goto/DotNetSDKV3/textract-2018-06-27/StartExpenseAnalysis) + [適用於 C\$1\$1 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/StartExpenseAnalysis) + [適用於 Go 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/StartExpenseAnalysis) + [AWS適用於 Java 的開發套件第 2 版](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/StartExpenseAnalysis) + [適用於 JavaScript 的 AWS 開發套件](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/textract-2018-06-27/StartExpenseAnalysis) + [適用於 PHP V3 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/StartExpenseAnalysis) + [適用於 Python 的 AWS 開發套件](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/StartExpenseAnalysis) + [適用於 Ruby V3 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/StartExpenseAnalysis)