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

# API 參考
<a name="API_Reference"></a>

 本節提供 Amazon Textract API 操作的文件。

**Topics**
+ [

# 動作
](API_Operations.md)
+ [

# 資料類型
](API_Types.md)

# 動作
<a name="API_Operations"></a>

支援以下動作：
+  [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
<a name="API_AnalyzeDocument"></a>

分析輸入檔案，分析已偵測項目之間的關係。

返回的信息類型如下：
+ 資料表單（金鑰值對）。有關資訊會以兩種方式傳回[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)。

## 請求語法
<a name="API_AnalyzeDocument_RequestSyntax"></a>

```
{
   "Document": { 
      "Bytes": blob,
      "S3Object": { 
         "Bucket": "string",
         "Name": "string",
         "Version": "string"
      }
   },
   "FeatureTypes": [ "string" ],
   "HumanLoopConfig": { 
      "DataAttributes": { 
         "ContentClassifiers": [ "string" ]
      },
      "FlowDefinitionArn": "string",
      "HumanLoopName": "string"
   }
}
```

## 請求參數
<a name="API_AnalyzeDocument_RequestParameters"></a>

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

 ** [Document](#API_AnalyzeDocument_RequestSyntax) **   <a name="Textract-AnalyzeDocument-request-Document"></a>
輸入文檔為 base64 編碼的字節或 Amazon S3 對象。如果您使用 AWS CLI 調用 Amazon Textract 操作，則無法傳遞圖像字節。文檔必須是 JPEG、PNG、PDF 或 TIFF 格式的圖像。  
如果您使用 AWS 開發工具包調用 Amazon Textract，則可能不需要對使用`Bytes`欄位。  
類型：[Document](API_Document.md) 物件  
：必要 是

 ** [FeatureTypes](#API_AnalyzeDocument_RequestSyntax) **   <a name="Textract-AnalyzeDocument-request-FeatureTypes"></a>
要執行的分析類型的列表。將 TABLE 添加到列表以返回有關輸入文檔中檢測到的表的信息。添加表單以返回檢測到的表單數據。要執行這兩種類型的分析，請將表和表格添加到`FeatureTypes`。文檔中檢測到的所有行和單詞都包含在響應中（包括與`FeatureTypes`。  
類型：字串陣列  
有效值：` TABLES | FORMS`  
：必要 是

 ** [HumanLoopConfig](#API_AnalyzeDocument_RequestSyntax) **   <a name="Textract-AnalyzeDocument-request-HumanLoopConfig"></a>
設置用於分析文檔的循環工作流的配置。  
類型：[HumanLoopConfig](API_HumanLoopConfig.md) 物件  
：必要 否

## 回應語法
<a name="API_AnalyzeDocument_ResponseSyntax"></a>

```
{
   "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"
   }
}
```

## 回應元素
<a name="API_AnalyzeDocument_ResponseElements"></a>

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

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

 ** [AnalyzeDocumentModelVersion](#API_AnalyzeDocument_ResponseSyntax) **   <a name="Textract-AnalyzeDocument-response-AnalyzeDocumentModelVersion"></a>
用於分析文件的模型版本。  
類型：字串

 ** [Blocks](#API_AnalyzeDocument_ResponseSyntax) **   <a name="Textract-AnalyzeDocument-response-Blocks"></a>
檢測和分析的項目`AnalyzeDocument`。  
類型：的陣列[Block](API_Block.md)對象

 ** [DocumentMetadata](#API_AnalyzeDocument_ResponseSyntax) **   <a name="Textract-AnalyzeDocument-response-DocumentMetadata"></a>
有關已分析文檔的元數據。一個例子是頁數。  
類型：[DocumentMetadata](API_DocumentMetadata.md) 物件

 ** [HumanLoopActivationOutput](#API_AnalyzeDocument_ResponseSyntax) **   <a name="Textract-AnalyzeDocument-response-HumanLoopActivationOutput"></a>
顯示循環評估中人類的結果。  
類型：[HumanLoopActivationOutput](API_HumanLoopActivationOutput.md) 物件

## 錯誤
<a name="API_AnalyzeDocument_Errors"></a>

 ** 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

## 另請參閱
<a name="API_AnalyzeDocument_SeeAlso"></a>

如需在語言特定的 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
<a name="API_AnalyzeExpense"></a>

 `AnalyzeExpense`同步分析輸入文檔之間的財務相關關係。

信息返回為`ExpenseDocuments`並分開如下。
+  `LineItemGroups`-包含`LineItems`存儲有關文本行的信息，例如購買的物料及其收據上的價格。
+  `SummaryFields`-包含收據的所有其他信息，例如題頭信息或供應商名稱。

## 請求語法
<a name="API_AnalyzeExpense_RequestSyntax"></a>

```
{
   "Document": { 
      "Bytes": blob,
      "S3Object": { 
         "Bucket": "string",
         "Name": "string",
         "Version": "string"
      }
   }
}
```

## 請求參數
<a name="API_AnalyzeExpense_RequestParameters"></a>

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

 ** [Document](#API_AnalyzeExpense_RequestSyntax) **   <a name="Textract-AnalyzeExpense-request-Document"></a>
輸入文檔，作為字節或 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) 物件  
：必要 是

## 回應語法
<a name="API_AnalyzeExpense_ResponseSyntax"></a>

```
{
   "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"
               }
            }
         ]
      }
   ]
}
```

## 回應元素
<a name="API_AnalyzeExpense_ResponseElements"></a>

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

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

 ** [DocumentMetadata](#API_AnalyzeExpense_ResponseSyntax) **   <a name="Textract-AnalyzeExpense-response-DocumentMetadata"></a>
有關輸入文檔的信息。  
類型：[DocumentMetadata](API_DocumentMetadata.md) 物件

 ** [ExpenseDocuments](#API_AnalyzeExpense_ResponseSyntax) **   <a name="Textract-AnalyzeExpense-response-ExpenseDocuments"></a>
Amazon Textract 檢測到的費用。  
類型：的陣列[ExpenseDocument](API_ExpenseDocument.md)對象

## 錯誤
<a name="API_AnalyzeExpense_Errors"></a>

 ** 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

## 另請參閱
<a name="API_AnalyzeExpense_SeeAlso"></a>

如需在語言特定的 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
<a name="API_AnalyzeID"></a>

分析身份證明文件以獲取相關信息。此信息被提取並返回為`IdentityDocumentFields`，它記錄提取文本的標準化字段和值。與其他 Amazon Textract 操作不同，`AnalyzeID`不會傳回任何幾何數據。

## 請求語法
<a name="API_AnalyzeID_RequestSyntax"></a>

```
{
   "DocumentPages": [ 
      { 
         "Bytes": blob,
         "S3Object": { 
            "Bucket": "string",
            "Name": "string",
            "Version": "string"
         }
      }
   ]
}
```

## 請求參數
<a name="API_AnalyzeID_RequestParameters"></a>

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

 ** [DocumentPages](#API_AnalyzeID_RequestSyntax) **   <a name="Textract-AnalyzeID-request-DocumentPages"></a>
傳遞給分析 ID 的文檔。  
類型：的陣列[Document](API_Document.md)對象  
陣列成員：項目數下限為 1。項目數上限為 2。  
的必要項目：是

## 回應語法
<a name="API_AnalyzeID_ResponseSyntax"></a>

```
{
   "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"
               }
            }
         ]
      }
   ]
}
```

## 回應元素
<a name="API_AnalyzeID_ResponseElements"></a>

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

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

 ** [AnalyzeIDModelVersion](#API_AnalyzeID_ResponseSyntax) **   <a name="Textract-AnalyzeID-response-AnalyzeIDModelVersion"></a>
用於處理文檔的分析身份 API 版本。  
類型：字串

 ** [DocumentMetadata](#API_AnalyzeID_ResponseSyntax) **   <a name="Textract-AnalyzeID-response-DocumentMetadata"></a>
有關輸入文檔的信息。  
類型：[DocumentMetadata](API_DocumentMetadata.md) 物件

 ** [IdentityDocuments](#API_AnalyzeID_ResponseSyntax) **   <a name="Textract-AnalyzeID-response-IdentityDocuments"></a>
分析編號處理的文件列表。包括一個數字，表示它們在列表中的位置和文檔的響應結構。  
類型：的陣列[IdentityDocument](API_IdentityDocument.md)對象

## 錯誤
<a name="API_AnalyzeID_Errors"></a>

 ** 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

## 另請參閱
<a name="API_AnalyzeID_SeeAlso"></a>

如需在語言特定的 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
<a name="API_DetectDocumentText"></a>

檢測輸入文檔中的文本。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)。

## 請求語法
<a name="API_DetectDocumentText_RequestSyntax"></a>

```
{
   "Document": { 
      "Bytes": blob,
      "S3Object": { 
         "Bucket": "string",
         "Name": "string",
         "Version": "string"
      }
   }
}
```

## 請求參數
<a name="API_DetectDocumentText_RequestParameters"></a>

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

 ** [Document](#API_DetectDocumentText_RequestSyntax) **   <a name="Textract-DetectDocumentText-request-Document"></a>
輸入文檔為 base64 編碼的字節或 Amazon S3 對象。如果您使用 AWS CLI 調用 Amazon Textract 操作，則無法傳遞圖像字節。文檔必須是 JPEG 或 PNG 格式的圖像。  
如果您使用 AWS 開發工具包調用 Amazon Textract，則可能不需要對使用`Bytes`欄位。  
類型：[Document](API_Document.md) 物件  
：必要 是

## 回應語法
<a name="API_DetectDocumentText_ResponseSyntax"></a>

```
{
   "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
   }
}
```

## 回應元素
<a name="API_DetectDocumentText_ResponseElements"></a>

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

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

 ** [Blocks](#API_DetectDocumentText_ResponseSyntax) **   <a name="Textract-DetectDocumentText-response-Blocks"></a>
陣列`Block`對象，其中包含在文檔中檢測到的文本。  
類型：的陣列[Block](API_Block.md)對象

 ** [DetectDocumentTextModelVersion](#API_DetectDocumentText_ResponseSyntax) **   <a name="Textract-DetectDocumentText-response-DetectDocumentTextModelVersion"></a>
  
類型：字串

 ** [DocumentMetadata](#API_DetectDocumentText_ResponseSyntax) **   <a name="Textract-DetectDocumentText-response-DocumentMetadata"></a>
有關文檔的元數據。它包含在文檔中檢測到的頁數。  
類型：[DocumentMetadata](API_DocumentMetadata.md) 物件

## 錯誤
<a name="API_DetectDocumentText_Errors"></a>

 ** 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

## 另請參閱
<a name="API_DetectDocumentText_SeeAlso"></a>

如需在語言特定的 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
<a name="API_GetDocumentAnalysis"></a>

獲取分析文檔中文本的 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)。

## 請求語法
<a name="API_GetDocumentAnalysis_RequestSyntax"></a>

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

## 請求參數
<a name="API_GetDocumentAnalysis_RequestParameters"></a>

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

 ** [JobId](#API_GetDocumentAnalysis_RequestSyntax) **   <a name="Textract-GetDocumentAnalysis-request-JobId"></a>
文字檢測任務的唯一識別符。所以此`JobId`從`StartDocumentAnalysis`。一個`JobId`值僅在 7 天內有效。  
類型：字串  
長度約束：長度下限為 1。長度上限為 64。  
模式：`^[a-zA-Z0-9-_]+$`  
必要：是

 ** [MaxResults](#API_GetDocumentAnalysis_RequestSyntax) **   <a name="Textract-GetDocumentAnalysis-request-MaxResults"></a>
每次分頁呼叫可回傳結果的數量上限。您可以指定的最大值為 1,000。如果您指定的值大於 1,000，最多只能傳回 1,000 個結果。預設值為 1,000。  
類型：整數  
有效範圍：最小值為 1。  
必要：否

 ** [NextToken](#API_GetDocumentAnalysis_RequestSyntax) **   <a name="Textract-GetDocumentAnalysis-request-NextToken"></a>
如果之前的響應不完整（因為有更多要檢索的塊），Amazon Textract 會在響應中返回一個分頁令牌。您可以使用此分頁符來檢索下一組區塊。  
類型：字串  
長度約束：長度下限為 1。長度上限為 255。  
模式：`.*\S.*`  
必要：否

## 回應語法
<a name="API_GetDocumentAnalysis_ResponseSyntax"></a>

```
{
   "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 ]
      }
   ]
}
```

## 回應元素
<a name="API_GetDocumentAnalysis_ResponseElements"></a>

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

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

 ** [AnalyzeDocumentModelVersion](#API_GetDocumentAnalysis_ResponseSyntax) **   <a name="Textract-GetDocumentAnalysis-response-AnalyzeDocumentModelVersion"></a>
  
類型：字串

 ** [Blocks](#API_GetDocumentAnalysis_ResponseSyntax) **   <a name="Textract-GetDocumentAnalysis-response-Blocks"></a>
文本分析操作的結果。  
類型：陣列[Block](API_Block.md)對象

 ** [DocumentMetadata](#API_GetDocumentAnalysis_ResponseSyntax) **   <a name="Textract-GetDocumentAnalysis-response-DocumentMetadata"></a>
有關 Amazon Textract 處理的文檔的信息。`DocumentMetadata`會在 Amazon Textract 視頻操作的分頁響應的每一頁中返回。  
類型：[DocumentMetadata](API_DocumentMetadata.md) 物件

 ** [JobStatus](#API_GetDocumentAnalysis_ResponseSyntax) **   <a name="Textract-GetDocumentAnalysis-response-JobStatus"></a>
文字檢測任務的目前狀態。  
類型：字串  
有效值：` IN_PROGRESS | SUCCEEDED | FAILED | PARTIAL_SUCCESS`

 ** [NextToken](#API_GetDocumentAnalysis_ResponseSyntax) **   <a name="Textract-GetDocumentAnalysis-response-NextToken"></a>
如果響應被截斷，Amazon Textract 將返回此令牌。您可以在後續請求中使用此符記來檢索下一組文字檢測結果。  
類型：字串  
長度約束：長度下限為 1。長度上限為 255。  
模式：`.*\S.*`

 ** [StatusMessage](#API_GetDocumentAnalysis_ResponseSyntax) **   <a name="Textract-GetDocumentAnalysis-response-StatusMessage"></a>
如果無法完成檢測任務，則會傳回。包含有關發生什麼錯誤的説明。  
類型：字串

 ** [Warnings](#API_GetDocumentAnalysis_ResponseSyntax) **   <a name="Textract-GetDocumentAnalysis-response-Warnings"></a>
文檔分析操作期間發生的警告列表。  
類型：陣列[Warning](API_Warning.md)對象

## 錯誤
<a name="API_GetDocumentAnalysis_Errors"></a>

 ** 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

## 另請參閱
<a name="API_GetDocumentAnalysis_SeeAlso"></a>

如需在語言特定的 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
<a name="API_GetDocumentTextDetection"></a>

獲取用於檢測文檔中文本的 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)。

## 請求語法
<a name="API_GetDocumentTextDetection_RequestSyntax"></a>

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

## 請求參數
<a name="API_GetDocumentTextDetection_RequestParameters"></a>

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

 ** [JobId](#API_GetDocumentTextDetection_RequestSyntax) **   <a name="Textract-GetDocumentTextDetection-request-JobId"></a>
文字偵測任務的唯一識別符。所以此`JobId`從傳回`StartDocumentTextDetection`。一個`JobId`值僅在 7 天內有效。  
類型：字串  
長度限制：長度下限為 1。長度上限為 64。  
模式：`^[a-zA-Z0-9-_]+$`  
：必要 是

 ** [MaxResults](#API_GetDocumentTextDetection_RequestSyntax) **   <a name="Textract-GetDocumentTextDetection-request-MaxResults"></a>
每筆分頁呼叫傳回結果的數量上限。您可以指定的最大值為 1,000。如果您指定的值大於 1,000，最多只能傳回 1,000 個結果。預設值為 1,000。  
類型：整數  
有效範圍：最小值為 1。  
：必要 否

 ** [NextToken](#API_GetDocumentTextDetection_RequestSyntax) **   <a name="Textract-GetDocumentTextDetection-request-NextToken"></a>
如果之前的響應不完整（因為有更多要檢索的塊），Amazon Textract 會在響應中返回一個分頁令牌。您可以使用此分頁符記來取回下一組塊。  
類型：字串  
長度限制：長度下限為 1。長度上限為 255。  
模式：`.*\S.*`  
：必要 否

## 回應語法
<a name="API_GetDocumentTextDetection_ResponseSyntax"></a>

```
{
   "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 ]
      }
   ]
}
```

## 回應元素
<a name="API_GetDocumentTextDetection_ResponseElements"></a>

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

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

 ** [Blocks](#API_GetDocumentTextDetection_ResponseSyntax) **   <a name="Textract-GetDocumentTextDetection-response-Blocks"></a>
文本檢測操作的結果。  
類型：的陣列[Block](API_Block.md)對象

 ** [DetectDocumentTextModelVersion](#API_GetDocumentTextDetection_ResponseSyntax) **   <a name="Textract-GetDocumentTextDetection-response-DetectDocumentTextModelVersion"></a>
  
類型：字串

 ** [DocumentMetadata](#API_GetDocumentTextDetection_ResponseSyntax) **   <a name="Textract-GetDocumentTextDetection-response-DocumentMetadata"></a>
有關 Amazon Textract 處理的文檔的信息。`DocumentMetadata`會在 Amazon Textract 視頻操作的分頁響應的每一頁中返回。  
類型：[DocumentMetadata](API_DocumentMetadata.md) 物件

 ** [JobStatus](#API_GetDocumentTextDetection_ResponseSyntax) **   <a name="Textract-GetDocumentTextDetection-response-JobStatus"></a>
文字偵測任務的目前狀態。  
類型：字串  
有效值：` IN_PROGRESS | SUCCEEDED | FAILED | PARTIAL_SUCCESS`

 ** [NextToken](#API_GetDocumentTextDetection_ResponseSyntax) **   <a name="Textract-GetDocumentTextDetection-response-NextToken"></a>
如果響應被截斷，Amazon Textract 將返回此令牌。您可以在後續請求中使用此符記來檢索下一組文字偵測結果。  
類型：字串  
長度限制：長度下限為 1。長度上限為 255。  
模式：`.*\S.*`

 ** [StatusMessage](#API_GetDocumentTextDetection_ResponseSyntax) **   <a name="Textract-GetDocumentTextDetection-response-StatusMessage"></a>
如果無法完成檢測任務，則返回。包含有關發生什麼錯誤的説明。  
類型：字串

 ** [Warnings](#API_GetDocumentTextDetection_ResponseSyntax) **   <a name="Textract-GetDocumentTextDetection-response-Warnings"></a>
文檔的文本檢測操作過程中發生的警告列表。  
類型：的陣列[Warning](API_Warning.md)對象

## 錯誤
<a name="API_GetDocumentTextDetection_Errors"></a>

 ** 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

## 另請參閱
<a name="API_GetDocumentTextDetection_SeeAlso"></a>

如需在語言特定的 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
<a name="API_GetExpenseAnalysis"></a>

獲取分析發票和收據的 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)。

## 請求語法
<a name="API_GetExpenseAnalysis_RequestSyntax"></a>

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

## 請求參數
<a name="API_GetExpenseAnalysis_RequestParameters"></a>

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

 ** [JobId](#API_GetExpenseAnalysis_RequestSyntax) **   <a name="Textract-GetExpenseAnalysis-request-JobId"></a>
文本檢測任務的唯一識別碼。所以此`JobId`從傳回`StartExpenseAnalysis`。一個`JobId`值只能保留 7 天。  
類型：字串  
限制：長度下限為 1。長度上限為 64。  
模式：`^[a-zA-Z0-9-_]+$`  
：必要 是

 ** [MaxResults](#API_GetExpenseAnalysis_RequestSyntax) **   <a name="Textract-GetExpenseAnalysis-request-MaxResults"></a>
每次分頁呼叫可回傳結果的數量上限。您可以指定的最大值為 20。如果您指定的值大於 20，最多只能傳回 20 個結果。預設值為 20。  
類型：整數  
有效範圍：最小值為 1。  
：必要 否

 ** [NextToken](#API_GetExpenseAnalysis_RequestSyntax) **   <a name="Textract-GetExpenseAnalysis-request-NextToken"></a>
如果之前的響應不完整（因為有更多要檢索的塊），Amazon Textract 會在響應中返回一個分頁令牌。您可以使用此分頁符記來檢索下一組塊。  
類型：字串  
限制：長度下限為 1。長度上限為 255。  
模式：`.*\S.*`  
：必要 否

## 回應語法
<a name="API_GetExpenseAnalysis_ResponseSyntax"></a>

```
{
   "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 ]
      }
   ]
}
```

## 回應元素
<a name="API_GetExpenseAnalysis_ResponseElements"></a>

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

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

 ** [AnalyzeExpenseModelVersion](#API_GetExpenseAnalysis_ResponseSyntax) **   <a name="Textract-GetExpenseAnalysis-response-AnalyzeExpenseModelVersion"></a>
分析費用的當前模型版本。  
類型：字串

 ** [DocumentMetadata](#API_GetExpenseAnalysis_ResponseSyntax) **   <a name="Textract-GetExpenseAnalysis-response-DocumentMetadata"></a>
有關 Amazon Textract 處理的文檔的信息。`DocumentMetadata`會在 Amazon Textract 操作的分頁響應的每一頁中返回。  
類型：[DocumentMetadata](API_DocumentMetadata.md) 物件

 ** [ExpenseDocuments](#API_GetExpenseAnalysis_ResponseSyntax) **   <a name="Textract-GetExpenseAnalysis-response-ExpenseDocuments"></a>
Amazon Textract 檢測到的費用。  
類型：的陣列[ExpenseDocument](API_ExpenseDocument.md)對象

 ** [JobStatus](#API_GetExpenseAnalysis_ResponseSyntax) **   <a name="Textract-GetExpenseAnalysis-response-JobStatus"></a>
文本檢測任務的目前狀態。  
類型：字串  
有效值：` IN_PROGRESS | SUCCEEDED | FAILED | PARTIAL_SUCCESS`

 ** [NextToken](#API_GetExpenseAnalysis_ResponseSyntax) **   <a name="Textract-GetExpenseAnalysis-response-NextToken"></a>
如果響應被截斷，Amazon Textract 將返回此令牌。您可以在後續請求中使用此符記來檢索下一組文本檢測結果。  
類型：字串  
限制：長度下限為 1。長度上限為 255。  
模式：`.*\S.*`

 ** [StatusMessage](#API_GetExpenseAnalysis_ResponseSyntax) **   <a name="Textract-GetExpenseAnalysis-response-StatusMessage"></a>
如果無法完成檢測任務，則返回。包含有關發生什麼錯誤的説明。  
類型：字串

 ** [Warnings](#API_GetExpenseAnalysis_ResponseSyntax) **   <a name="Textract-GetExpenseAnalysis-response-Warnings"></a>
文檔的文本檢測操作過程中發生的警告列表。  
類型：的陣列[Warning](API_Warning.md)對象

## 錯誤
<a name="API_GetExpenseAnalysis_Errors"></a>

 ** 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

## 另請參閱
<a name="API_GetExpenseAnalysis_SeeAlso"></a>

如需在語言特定的 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
<a name="API_StartDocumentAnalysis"></a>

開始對輸入檔的異步分析，以瞭解檢測到的項目之間的關係，例如鍵值組、表格和選擇元素。

 `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)。

## 請求語法
<a name="API_StartDocumentAnalysis_RequestSyntax"></a>

```
{
   "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"
   }
}
```

## 請求參數
<a name="API_StartDocumentAnalysis_RequestParameters"></a>

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

 ** [ClientRequestToken](#API_StartDocumentAnalysis_RequestSyntax) **   <a name="Textract-StartDocumentAnalysis-request-ClientRequestToken"></a>
用於標識啟動請求的冪等令牌。如果您將相同的令牌與多個`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) **   <a name="Textract-StartDocumentAnalysis-request-DocumentLocation"></a>
要處理的文檔的位置。  
類型：[DocumentLocation](API_DocumentLocation.md) 物件  
：必要 是

 ** [FeatureTypes](#API_StartDocumentAnalysis_RequestSyntax) **   <a name="Textract-StartDocumentAnalysis-request-FeatureTypes"></a>
要執行的分析類型的列表。將 TABLE 添加到列表以返回有關輸入文檔中檢測到的表的信息。添加表單以返回檢測到的表單數據。要執行這兩種類型的分析，請將表和表格添加到`FeatureTypes`。文檔中檢測到的所有行和單詞都包含在響應中（包括與`FeatureTypes`。  
類型：字串陣列  
有效值：` TABLES | FORMS`  
：必要 是

 ** [JobTag](#API_StartDocumentAnalysis_RequestSyntax) **   <a name="Textract-StartDocumentAnalysis-request-JobTag"></a>
您指定的標識符，該編碼包含在發佈到 Amazon SNS 主題的完成通知中。例如，您可以使用`JobTag`標識完成通知對應的單據類型（例如納税表或收據）。  
類型：字串  
長度限制：長度下限為 1。長度上限為 64。  
模式：`[a-zA-Z0-9_.\-:]+`  
：必要 否

 ** [KMSKeyId](#API_StartDocumentAnalysis_RequestSyntax) **   <a name="Textract-StartDocumentAnalysis-request-KMSKeyId"></a>
用來加密推斷結果的 KMS 金鑰。這可以是密鑰 ID 或密鑰別名格式。提供 KMS 密鑰後，KMS 密鑰將用於客户存儲桶中的對象的服務器端加密。如果未啟用此參數，則結果將使用 SSE-S3 加密服務器端。  
類型：字串  
長度限制：長度下限為 1。長度上限為 2048。  
模式：`^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$`  
：必要 否

 ** [NotificationChannel](#API_StartDocumentAnalysis_RequestSyntax) **   <a name="Textract-StartDocumentAnalysis-request-NotificationChannel"></a>
您希望亞馬 Amazon Textract 將操作的完成狀態發佈到的 Amazon SNS 主題 ARN。  
類型：[NotificationChannel](API_NotificationChannel.md) 物件  
：必要 否

 ** [OutputConfig](#API_StartDocumentAnalysis_RequestSyntax) **   <a name="Textract-StartDocumentAnalysis-request-OutputConfig"></a>
設置輸出是否轉到客户定義的時段。默認情況下，Amazon Textract 系統會在內部保存結果，以供 GetDocumentAnalysis 操作訪問。  
類型：[OutputConfig](API_OutputConfig.md) 物件  
：必要 否

## 回應語法
<a name="API_StartDocumentAnalysis_ResponseSyntax"></a>

```
{
   "JobId": "string"
}
```

## 回應元素
<a name="API_StartDocumentAnalysis_ResponseElements"></a>

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

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

 ** [JobId](#API_StartDocumentAnalysis_ResponseSyntax) **   <a name="Textract-StartDocumentAnalysis-response-JobId"></a>
文件文字偵測任務的識別碼。使用`JobId`在後續調用中標識作業`GetDocumentAnalysis`。一個`JobId`值僅在 7 天內有效。  
類型：字串  
長度限制：長度下限為 1。長度上限為 64。  
模式：`^[a-zA-Z0-9-_]+$`

## 錯誤
<a name="API_StartDocumentAnalysis_Errors"></a>

 ** 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

## 另請參閱
<a name="API_StartDocumentAnalysis_SeeAlso"></a>

如需在語言特定的 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
<a name="API_StartDocumentTextDetection"></a>

開始非同步偵測文件中的文字。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)。

## 請求語法
<a name="API_StartDocumentTextDetection_RequestSyntax"></a>

```
{
   "ClientRequestToken": "string",
   "DocumentLocation": { 
      "S3Object": { 
         "Bucket": "string",
         "Name": "string",
         "Version": "string"
      }
   },
   "JobTag": "string",
   "KMSKeyId": "string",
   "NotificationChannel": { 
      "RoleArn": "string",
      "SNSTopicArn": "string"
   },
   "OutputConfig": { 
      "S3Bucket": "string",
      "S3Prefix": "string"
   }
}
```

## 請求參數
<a name="API_StartDocumentTextDetection_RequestParameters"></a>

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

 ** [ClientRequestToken](#API_StartDocumentTextDetection_RequestSyntax) **   <a name="Textract-StartDocumentTextDetection-request-ClientRequestToken"></a>
用於標識啟動請求的冪等令牌。如果您將相同的令牌與多個`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) **   <a name="Textract-StartDocumentTextDetection-request-DocumentLocation"></a>
要處理的文檔的位置。  
類型：[DocumentLocation](API_DocumentLocation.md) 物件  
：必要 是

 ** [JobTag](#API_StartDocumentTextDetection_RequestSyntax) **   <a name="Textract-StartDocumentTextDetection-request-JobTag"></a>
您指定的標識符，該編碼包含在發佈到 Amazon SNS 主題的完成通知中。例如，您可以使用`JobTag`標識完成通知對應的單據類型（例如納税表或收據）。  
類型：字串  
長度限制：長度下限為 1。長度上限為 64。  
模式：`[a-zA-Z0-9_.\-:]+`  
：必要 否

 ** [KMSKeyId](#API_StartDocumentTextDetection_RequestSyntax) **   <a name="Textract-StartDocumentTextDetection-request-KMSKeyId"></a>
用於加密推斷結果的 KMS 金鑰。此格式可以是密鑰 ID 或密鑰別名格式。提供 KMS 密鑰後，KMS 密鑰將用於客户存儲桶中的對象的服務器端加密。如果未啟用此參數，則結果將使用 SSE-S3 加密服務器端。  
類型：字串  
長度限制：長度下限為 1。長度上限為 2048。  
模式：`^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$`  
：必要 否

 ** [NotificationChannel](#API_StartDocumentTextDetection_RequestSyntax) **   <a name="Textract-StartDocumentTextDetection-request-NotificationChannel"></a>
您希望亞馬 Amazon Textract 將操作的完成狀態發佈到的 Amazon SNS 主題 ARN。  
類型：[NotificationChannel](API_NotificationChannel.md) 物件  
：必要 否

 ** [OutputConfig](#API_StartDocumentTextDetection_RequestSyntax) **   <a name="Textract-StartDocumentTextDetection-request-OutputConfig"></a>
設置輸出是否轉到客户定義的存儲段。默認情況下，Amazon Textract 將在內部保存結果，以便通過獲取 GetDocumentTextDetection 操作進行訪問。  
類型：[OutputConfig](API_OutputConfig.md) 物件  
：必要 否

## 回應語法
<a name="API_StartDocumentTextDetection_ResponseSyntax"></a>

```
{
   "JobId": "string"
}
```

## 回應元素
<a name="API_StartDocumentTextDetection_ResponseElements"></a>

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

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

 ** [JobId](#API_StartDocumentTextDetection_ResponseSyntax) **   <a name="Textract-StartDocumentTextDetection-response-JobId"></a>
文檔的文本檢測作業的標識符。使用`JobId`在後續調用中標識作業`GetDocumentTextDetection`。一個`JobId`值僅在 7 天內有效。  
類型：字串  
長度限制：長度下限為 1。長度上限為 64。  
模式：`^[a-zA-Z0-9-_]+$`

## 錯誤
<a name="API_StartDocumentTextDetection_Errors"></a>

 ** 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

## 另請參閱
<a name="API_StartDocumentTextDetection_SeeAlso"></a>

如需在語言特定的 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
<a name="API_StartExpenseAnalysis"></a>

開始對聯繫信息、購買物料和供應商名稱等數據的發票或收據進行異步分析。

 `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)。

## 請求語法
<a name="API_StartExpenseAnalysis_RequestSyntax"></a>

```
{
   "ClientRequestToken": "string",
   "DocumentLocation": { 
      "S3Object": { 
         "Bucket": "string",
         "Name": "string",
         "Version": "string"
      }
   },
   "JobTag": "string",
   "KMSKeyId": "string",
   "NotificationChannel": { 
      "RoleArn": "string",
      "SNSTopicArn": "string"
   },
   "OutputConfig": { 
      "S3Bucket": "string",
      "S3Prefix": "string"
   }
}
```

## 請求參數
<a name="API_StartExpenseAnalysis_RequestParameters"></a>

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

 ** [ClientRequestToken](#API_StartExpenseAnalysis_RequestSyntax) **   <a name="Textract-StartExpenseAnalysis-request-ClientRequestToken"></a>
用於標識啟動請求的冪等令牌。如果您將相同的令牌與多個`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) **   <a name="Textract-StartExpenseAnalysis-request-DocumentLocation"></a>
要處理的文檔的位置。  
類型：[DocumentLocation](API_DocumentLocation.md) 物件  
：必要 是

 ** [JobTag](#API_StartExpenseAnalysis_RequestSyntax) **   <a name="Textract-StartExpenseAnalysis-request-JobTag"></a>
您指定的標識符，該編碼包含在發佈到 Amazon SNS 主題的完成通知中。例如，您可以使用`JobTag`標識完成通知對應的單據類型（例如納税表或收據）。  
類型：字串  
長度限制：長度下限為 1。長度上限為 64。  
模式：`[a-zA-Z0-9_.\-:]+`  
：必要 否

 ** [KMSKeyId](#API_StartExpenseAnalysis_RequestSyntax) **   <a name="Textract-StartExpenseAnalysis-request-KMSKeyId"></a>
用來加密推理結果的 KMS 金鑰。此格式可以是密鑰 ID 或密鑰別名格式。提供 KMS 密鑰後，KMS 密鑰將用於客户存儲桶中的對象的服務器端加密。如果未啟用此參數，則結果將使用 SSE-S3 加密服務器端。  
類型：字串  
長度限制：長度下限為 1。長度上限為 2048。  
模式：`^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$`  
：必要 否

 ** [NotificationChannel](#API_StartExpenseAnalysis_RequestSyntax) **   <a name="Textract-StartExpenseAnalysis-request-NotificationChannel"></a>
您希望亞馬 Amazon Textract 將操作的完成狀態發佈到的 Amazon SNS 主題 ARN。  
類型：[NotificationChannel](API_NotificationChannel.md) 物件  
：必要 否

 ** [OutputConfig](#API_StartExpenseAnalysis_RequestSyntax) **   <a name="Textract-StartExpenseAnalysis-request-OutputConfig"></a>
設置輸出是否轉到客户定義的存儲段。默認情況下，Amazon Textract 會在內部保存結果，以便`GetExpenseAnalysis`operation.  
類型：[OutputConfig](API_OutputConfig.md) 物件  
：必要 否

## 回應語法
<a name="API_StartExpenseAnalysis_ResponseSyntax"></a>

```
{
   "JobId": "string"
}
```

## 回應元素
<a name="API_StartExpenseAnalysis_ResponseElements"></a>

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

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

 ** [JobId](#API_StartExpenseAnalysis_ResponseSyntax) **   <a name="Textract-StartExpenseAnalysis-response-JobId"></a>
文本檢測任務的唯一識別符。所以此`JobId`從傳回`StartExpenseAnalysis`。一個`JobId`值僅在 7 天內有效。  
類型：字串  
長度限制：長度下限為 1。長度上限為 64。  
模式：`^[a-zA-Z0-9-_]+$`

## 錯誤
<a name="API_StartExpenseAnalysis_Errors"></a>

 ** 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

## 另請參閱
<a name="API_StartExpenseAnalysis_SeeAlso"></a>

如需在語言特定的 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) 

# 資料類型
<a name="API_Types"></a>

目前支援下列資料類型：
+  [AnalyzeIDDetections](API_AnalyzeIDDetections.md) 
+  [Block](API_Block.md) 
+  [BoundingBox](API_BoundingBox.md) 
+  [Document](API_Document.md) 
+  [DocumentLocation](API_DocumentLocation.md) 
+  [DocumentMetadata](API_DocumentMetadata.md) 
+  [ExpenseDetection](API_ExpenseDetection.md) 
+  [ExpenseDocument](API_ExpenseDocument.md) 
+  [ExpenseField](API_ExpenseField.md) 
+  [ExpenseType](API_ExpenseType.md) 
+  [Geometry](API_Geometry.md) 
+  [HumanLoopActivationOutput](API_HumanLoopActivationOutput.md) 
+  [HumanLoopConfig](API_HumanLoopConfig.md) 
+  [HumanLoopDataAttributes](API_HumanLoopDataAttributes.md) 
+  [IdentityDocument](API_IdentityDocument.md) 
+  [IdentityDocumentField](API_IdentityDocumentField.md) 
+  [LineItemFields](API_LineItemFields.md) 
+  [LineItemGroup](API_LineItemGroup.md) 
+  [NormalizedValue](API_NormalizedValue.md) 
+  [NotificationChannel](API_NotificationChannel.md) 
+  [OutputConfig](API_OutputConfig.md) 
+  [Point](API_Point.md) 
+  [Relationship](API_Relationship.md) 
+  [S3Object](API_S3Object.md) 
+  [Warning](API_Warning.md) 

# AnalyzeIDDetections
<a name="API_AnalyzeIDDetections"></a>

用於包含分析 Id 操作檢測到的信息。

## 內容
<a name="API_AnalyzeIDDetections_Contents"></a>

 ** Confidence **   <a name="Textract-Type-AnalyzeIDDetections-Confidence"></a>
偵測到的文字置信度。  
類型：Float  
有效範圍：最小值為 0。最大值為 100。  
：必要 否

 ** NormalizedValue **   <a name="Textract-Type-AnalyzeIDDetections-NormalizedValue"></a>
僅返回日期，返回檢測到的值的類型和以更具機器可讀性的方式寫入的日期。  
類型：[NormalizedValue](API_NormalizedValue.md) 物件  
：必要 否

 ** Text **   <a name="Textract-Type-AnalyzeIDDetections-Text"></a>
標準化字段或與其關聯的值的文本。  
類型：字串  
：必要 是

## 另請參閱
<a name="API_AnalyzeIDDetections_SeeAlso"></a>

如需在語言特定的 AWS 開發套件之一中使用此 API 的詳細資訊，請參閱下列說明：
+  [適用於 C\$1\$1 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/AnalyzeIDDetections) 
+  [適用於 Go 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/AnalyzeIDDetections) 
+  [AWS適用於 Java 的開發套件第 2 版](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/AnalyzeIDDetections) 
+  [適用於 Ruby V3 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/AnalyzeIDDetections) 

# Block
<a name="API_Block"></a>

一個`Block`表示在文檔中識別的一組相互接近的像素內的項目。返回的信息在`Block`物件取決於操作類型。在文檔的文本檢測中（例如[DetectDocumentText](API_DetectDocumentText.md)），您可以獲得有關檢測到的單詞和文本行的信息。在文本分析中（例如[AnalyzeDocument](API_AnalyzeDocument.md)），您還可以獲取有關文檔中檢測到的字段、表格和選擇元素的信息。

陣列`Block`對象由同步操作和異步操作返回。在同步操作中，例如[DetectDocumentText](API_DetectDocumentText.md)，陣列`Block`對象是整個結果集。在異步操作中，例如[GetDocumentAnalysis](API_GetDocumentAnalysis.md)時，數組將通過一個或多個響應返回。

如需詳細資訊，請參閱「」[Amazon Textract 運作方式](https://docs.aws.amazon.com/textract/latest/dg/how-it-works.html)。

## 內容
<a name="API_Block_Contents"></a>

 ** BlockType **   <a name="Textract-Type-Block-BlockType"></a>
已識別的文本項的類型。在文本檢測操作中，返回以下類型：  
+  *頁面*-包含線的清單`Block`在文檔頁面上檢測到的對象。
+  *字*-在文檔頁面上檢測到的單詞。單字是一或多個 ISO 基本拉丁指令碼字元，不以空格分隔。
+  *線*-在文檔頁面上檢測到的製表符分隔的連續單詞的字符串。
在文本分析操作中，返回以下類型：  
+  *頁面*-包含子項目`Block`在文檔頁面上檢測到的對象。
+  *鍵值集*-存儲密鑰和值`Block`對象，用於在文檔頁面上檢測到的鏈接文本。使用`EntityType`字段來確定鍵值集對象是否為密鑰`Block`對象或值`Block`物件。
+  *字*-在文檔頁面上檢測到的單詞。單字是一或多個 ISO 基本拉丁指令碼字元，不以空格分隔。
+  *線*-在文檔頁面上檢測到的製表符分隔的連續單詞的字符串。
+  *表*-在文檔頁面上檢測到的表。表是具有兩個或多個行或列的基於網格的信息，單元格跨度包含一行和一列。
+  *細胞*-檢測到的表中的單元格。單元格是包含單元格中文本的塊的父項。
+  *選擇元素*-選擇元素，例如選項按鈕（單選按鈕）或在文檔頁面上檢測到的複選框。使用`SelectionStatus`，以判斷選取元素的狀態。
類型：字串  
有效值：` KEY_VALUE_SET | PAGE | LINE | WORD | TABLE | CELL | SELECTION_ELEMENT`  
：必要 否

 ** ColumnIndex **   <a name="Textract-Type-Block-ColumnIndex"></a>
在其中顯示表單元格的列。第一列位置為 1。`ColumnIndex`不返回`DetectDocumentText`和`GetDocumentTextDetection`。  
類型：整數  
有效範圍：最小值為 0。  
：必要 否

 ** ColumnSpan **   <a name="Textract-Type-Block-ColumnSpan"></a>
表單元格跨越的列數。目前，此值始終為 1，即使跨越的列數大於 1。`ColumnSpan`不返回`DetectDocumentText`和`GetDocumentTextDetection`。  
類型：整數  
有效範圍：最小值為 0。  
：必要 否

 ** Confidence **   <a name="Textract-Type-Block-Confidence"></a>
Amazon Textract 在識別文本的準確性以及識別文本周圍幾何點的準確性方面的置信度得分。  
類型：Float  
有效範圍：最小值為 0。最大值為 100。  
：必要 否

 ** EntityTypes **   <a name="Textract-Type-Block-EntityTypes"></a>
實體類型。可能返回以下內容：  
+  *鍵*-文檔上某個字段的標識符。
+  *值*-字段文本。
 `EntityTypes`不返回`DetectDocumentText`和`GetDocumentTextDetection`。  
類型：字串陣列  
有效值：` KEY | VALUE`  
：必要 否

 ** Geometry **   <a name="Textract-Type-Block-Geometry"></a>
已識別文字在圖像上的位置。它包括一個圍繞文本的軸對齊粗邊界框，以及一個細粒度的多邊形，以獲得更精確的空間信息。  
類型：[Geometry](API_Geometry.md) 物件  
：必要 否

 ** Id **   <a name="Textract-Type-Block-Id"></a>
識別文本的標識符。標識符僅對於單個操作是唯一的。  
類型：字串  
模式：`.*\S.*`  
：必要 否

 ** Page **   <a name="Textract-Type-Block-Page"></a>
檢測到塊的頁面。`Page`由異步操作返回。僅為 PDF 或 TIFF 格式的多頁文檔返回大於 1 的頁面值。掃描的圖像 (JPEG/PNG)，即使它包含多個文檔頁面，也被視為單頁文檔。的值為`Page`一律為 1。同步操作不返回`Page`因為每個輸入文檔都被視為單頁文檔。  
類型：整數  
有效範圍：最小值為 0。  
：必要 否

 ** Relationships **   <a name="Textract-Type-Block-Relationships"></a>
當前塊子塊的列表。例如，LINE 對象具有作為文本行一部分的每個 WORD 塊的子塊。列表中沒有不存在的關係對象，例如當前塊沒有子塊時。列表大小可以如下：  
+ 0-塊沒有子塊。
+ 1-該塊具有子塊。
類型：陣列[Relationship](API_Relationship.md)對象  
：必要 否

 ** RowIndex **   <a name="Textract-Type-Block-RowIndex"></a>
表單元格所在的行。第一行位置為 1。`RowIndex`不返回`DetectDocumentText`和`GetDocumentTextDetection`。  
類型：整數  
有效範圍：最小值為 0。  
：必要 否

 ** RowSpan **   <a name="Textract-Type-Block-RowSpan"></a>
表單元格跨越的行數。目前，此值始終為 1，即使跨越的行數大於 1。`RowSpan`不返回`DetectDocumentText`和`GetDocumentTextDetection`。  
類型：整數  
有效範圍：最小值為 0。  
：必要 否

 ** SelectionStatus **   <a name="Textract-Type-Block-SelectionStatus"></a>
選擇元素的選擇狀態，例如選項按鈕或複選框。  
類型：字串  
有效值：` SELECTED | NOT_SELECTED`  
：必要 否

 ** Text **   <a name="Textract-Type-Block-Text"></a>
Amazon Textract 識別的單詞或文本行。  
類型：字串  
：必要 否

 ** TextType **   <a name="Textract-Type-Block-TextType"></a>
Amazon Textract 檢測到的文本類型。可以檢查是否有手寫文字和打印文本。  
類型：字串  
有效值：` HANDWRITING | PRINTED`  
：必要 否

## 另請參閱
<a name="API_Block_SeeAlso"></a>

如需在語言特定的 AWS 開發套件之一中使用此 API 的詳細資訊，請參閱下列說明：
+  [適用於 C\$1\$1 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/Block) 
+  [適用於 Go 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/Block) 
+  [AWS適用於 Java 的開發套件第 2 版](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/Block) 
+  [適用於 Ruby V3 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/Block) 

# BoundingBox
<a name="API_BoundingBox"></a>

文檔頁面上檢測到的頁面、文本、鍵值對、表格、表格單元格或選擇元素周圍的邊界框。所以此`left`（x 座標）和`top`（y 軸）是代表上方和左邊方的座標。請注意，影像的左上角是原點 (0,0)。

所以此`top`和`left`返回的值是整個文檔頁面大小的比率。例如，如果輸入影像為 700 x 200 像素，而週框方塊的左上方座標為 350 x 50 像素，則 API 會傳回 `left` 值 0.5 (350/700) 和 `top` 值 0.25 (50/200)。

所以此`width`和`height`值以整體文檔頁面維度的比例表示，以整體文檔頁面維度的比例表示。例如，如果文檔頁面大小為 700 x 200 像素，邊界框寬度為 70 像素，則返回的寬度為 0.1。

## 內容
<a name="API_BoundingBox_Contents"></a>

 ** Height **   <a name="Textract-Type-BoundingBox-Height"></a>
高度方塊的高度，以整體文檔頁面高度的比例表示。  
類型：Float  
：必要 否

 ** Left **   <a name="Textract-Type-BoundingBox-Left"></a>
左邊方塊的左邊座標，以整體文檔頁面寬度的比例表示。  
類型：Float  
：必要 否

 ** Top **   <a name="Textract-Type-BoundingBox-Top"></a>
上方方座標，以整體文檔頁面高度的比例表示。  
類型：Float  
：必要 否

 ** Width **   <a name="Textract-Type-BoundingBox-Width"></a>
寬度方塊的寬度，以整體文檔頁面寬度的比例表示。  
類型：Float  
：必要 否

## 另請參閱
<a name="API_BoundingBox_SeeAlso"></a>

如需在語言特定的 AWS 開發套件之一中使用此 API 的詳細資訊，請參閱下列說明：
+  [適用於 C\$1\$1 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/BoundingBox) 
+  [適用於 Go 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/BoundingBox) 
+  [AWS適用於 Java 的開發套件第 2 版](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/BoundingBox) 
+  [適用於 Ruby V3 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/BoundingBox) 

# Document
<a name="API_Document"></a>

輸入文檔，以字節形式或 S3 對象形式。

您可以將影像位元組傳遞至 Amazon Textract 章 API 操作，使用`Bytes`屬性。例如，您需要使用`Bytes`屬性傳遞從本地文件系統加載的文檔。圖像字節通過使用`Bytes`屬性必須經過 base64 編碼。如果您使用 AWS 開發工具包調用 Amazon Textract API 操作，則您的代碼可能無需對文檔文件字節進行編碼。

您可以將 S3 儲存貯體中的影像傳遞至 Amazon Textract API 操作，使用`S3Object`屬性。存放在 S3 儲存貯體中的文檔，不需要 base64 編碼。

含有 S3 物件的 S3 儲存貯體區域必須符合您用於 Amazon Textract 操作的 AWS 區域。

如果您使用 AWS CLI 呼叫 Amazon Textract 操作，則不支援使用位元組來傳遞。您必須先將文檔上傳至 Amazon S3 儲存貯體，再使用 S3Object 屬性呼叫操作。

若要使用 Amazon Textract 處理 S3 物件，用户必須具有 S3 物件的存取許可。

## 內容
<a name="API_Document_Contents"></a>

 ** Bytes **   <a name="Textract-Type-Document-Bytes"></a>
一個由 base64 編碼的文檔字節組成的 Blob。字節 Blob 中提供的文檔的最大大小為 5 MB。文檔字節必須採用 PNG 或 JPEG 格式。  
如果您使用 AWS 開發工具包調用 Amazon Textract，則可能無需使用`Bytes`欄位。  
類型：Base64 編碼二進位數據物件  
長度限制：長度下限為 1。長度上限為 104857。  
必要 否

 ** S3Object **   <a name="Textract-Type-Document-S3Object"></a>
將 S3 對象標識為文檔源。存儲在 S3 存儲桶中的文檔的最大大小為 5 MB。  
類型：[S3Object](API_S3Object.md) 物件  
必要 否

## 另請參閱
<a name="API_Document_SeeAlso"></a>

如需在語言特定的 AWS 開發套件之一中使用此 API 的詳細資訊，請參閱下列說明：
+  [適用於 C\$1\$1 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/Document) 
+  [適用於 Go 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/Document) 
+  [AWS適用於 Java 的開發套件第 2 版](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/Document) 
+  [適用於 Ruby V3 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/Document) 

# DocumentLocation
<a name="API_DocumentLocation"></a>

內含待處理檔案的 Amazon S3 儲存儲體。它被異步操作（如[StartDocumentTextDetection](API_StartDocumentTextDetection.md)。

輸入文檔可以是 JPEG 或 PNG 格式的圖像文件。它也可以是 PDF 格式的文件。

## 內容
<a name="API_DocumentLocation_Contents"></a>

 ** S3Object **   <a name="Textract-Type-DocumentLocation-S3Object"></a>
內含輸入檔案的 Amazon S3 儲存儲體。  
類型：[S3Object](API_S3Object.md) 物件  
：必要 否

## 另請參閱
<a name="API_DocumentLocation_SeeAlso"></a>

如需在語言特定的 AWS 開發套件之一中使用此 API 的詳細資訊，請參閱下列說明：
+  [適用於 C\$1\$1 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/DocumentLocation) 
+  [適用於 Go 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/DocumentLocation) 
+  [AWS適用於 Java 的開發套件第 2 版](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/DocumentLocation) 
+  [適用於 Ruby V3 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/DocumentLocation) 

# DocumentMetadata
<a name="API_DocumentMetadata"></a>

有關輸入文檔的信息。

## 內容
<a name="API_DocumentMetadata_Contents"></a>

 ** Pages **   <a name="Textract-Type-DocumentMetadata-Pages"></a>
在文檔中檢測到的頁數。  
類型：整數  
有效範圍：最小值為 0。  
必要：否

## 另請參閱
<a name="API_DocumentMetadata_SeeAlso"></a>

如需在語言特定的 AWS 開發套件之一中使用此 API 的詳細資訊，請參閱下列說明：
+  [適用於 C\$1\$1 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/DocumentMetadata) 
+  [適用於 Go 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/DocumentMetadata) 
+  [AWS適用於 Java 的開發套件第 2 版](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/DocumentMetadata) 
+  [適用於 Ruby V3 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/DocumentMetadata) 

# ExpenseDetection
<a name="API_ExpenseDetection"></a>

用於存儲 Amazon Textract 檢測到的值或標籤相關信息的對象。

## 內容
<a name="API_ExpenseDetection_Contents"></a>

 ** Confidence **   <a name="Textract-Type-ExpenseDetection-Confidence"></a>
檢測的可信度，以百分比表示  
類型：Float  
有效範圍：最小值為 0。最大值為 100。  
：必要 否

 ** Geometry **   <a name="Textract-Type-ExpenseDetection-Geometry"></a>
有關以下項目在文件頁面上的位置的信息：檢測到的頁面、文字、鍵值組、表格單元格和選擇元素。  
類型：[Geometry](API_Geometry.md) 物件  
：必要 否

 ** Text **   <a name="Textract-Type-ExpenseDetection-Text"></a>
Amazon Textract 識別的單詞或文本行  
類型：字串  
：必要 否

## 另請參閱
<a name="API_ExpenseDetection_SeeAlso"></a>

如需在語言特定的 AWS 開發套件之一中使用此 API 的詳細資訊，請參閱下列說明：
+  [適用於 C\$1\$1 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/ExpenseDetection) 
+  [適用於 Go 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/ExpenseDetection) 
+  [AWS適用於 Java 的開發套件第 2 版](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/ExpenseDetection) 
+  [適用於 Ruby V3 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/ExpenseDetection) 

# ExpenseDocument
<a name="API_ExpenseDocument"></a>

保存分析費用返回的所有信息的結構

## 內容
<a name="API_ExpenseDocument_Contents"></a>

 ** ExpenseIndex **   <a name="Textract-Type-ExpenseDocument-ExpenseIndex"></a>
表示信息來自單據中的發票或收據。第一個文檔為 1，第二個文檔為 2，以此類推。  
類型：整數  
有效範圍：最小值為 0。  
：必要 否

 ** LineItemGroups **   <a name="Textract-Type-ExpenseDocument-LineItemGroups"></a>
在文檔的每個表格上檢測到的信息，分別為`LineItems`。  
類型：的陣列[LineItemGroup](API_LineItemGroup.md)對象  
：必要 否

 ** SummaryFields **   <a name="Textract-Type-ExpenseDocument-SummaryFields"></a>
Amazon Textract 在表格之外找到的任何信息。  
類型：的陣列[ExpenseField](API_ExpenseField.md)對象  
：必要 否

## 另請參閱
<a name="API_ExpenseDocument_SeeAlso"></a>

如需在語言特定的 AWS 開發套件之一中使用此 API 的詳細資訊，請參閱下列說明：
+  [適用於 C\$1\$1 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/ExpenseDocument) 
+  [適用於 Go 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/ExpenseDocument) 
+  [AWS適用於 Java 的開發套件第 2 版](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/ExpenseDocument) 
+  [適用於 Ruby V3 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/ExpenseDocument) 

# ExpenseField
<a name="API_ExpenseField"></a>

對檢測到的信息進行細分，分別為災難類型、標籤檢測和價值檢測

## 內容
<a name="API_ExpenseField_Contents"></a>

 ** LabelDetection **   <a name="Textract-Type-ExpenseField-LabelDetection"></a>
檢測到的元素的明確聲明的標籤。  
類型：[ExpenseDetection](API_ExpenseDetection.md) 物件  
：必要 否

 ** PageNumber **   <a name="Textract-Type-ExpenseField-PageNumber"></a>
檢測到值的頁碼。  
類型：整數  
有效範圍：最小值為 0。  
：必要 否

 ** Type **   <a name="Textract-Type-ExpenseField-Type"></a>
檢測到的元素的隱含標籤。與顯式元素的標籤檢測一起顯示。  
類型：[ExpenseType](API_ExpenseType.md) 物件  
：必要 否

 ** ValueDetection **   <a name="Textract-Type-ExpenseField-ValueDetection"></a>
檢測到的元素的值。存在於顯式和隱式元素中。  
類型：[ExpenseDetection](API_ExpenseDetection.md) 物件  
：必要 否

## 另請參閱
<a name="API_ExpenseField_SeeAlso"></a>

如需在語言特定的 AWS 開發套件之一中使用此 API 的詳細資訊，請參閱下列說明：
+  [適用於 C\$1\$1 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/ExpenseField) 
+  [適用於 Go 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/ExpenseField) 
+  [AWS適用於 Java 的開發套件第 2 版](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/ExpenseField) 
+  [適用於 Ruby V3 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/ExpenseField) 

# ExpenseType
<a name="API_ExpenseType"></a>

用於存儲 Amazon Textract 檢測到的類型相關信息的對象。

## 內容
<a name="API_ExpenseType_Contents"></a>

 ** Confidence **   <a name="Textract-Type-ExpenseType-Confidence"></a>
準確度的置信度，以百分比表示。  
類型：Float  
有效範圍：最小值為 0。最大值為 100。  
使用必要項目 否

 ** Text **   <a name="Textract-Type-ExpenseType-Text"></a>
Amazon Textract 檢測到的單詞或文本行。  
類型：字串  
使用必要項目 否

## 另請參閱
<a name="API_ExpenseType_SeeAlso"></a>

如需在語言特定的 AWS 開發套件之一中使用此 API 的詳細資訊，請參閱下列說明：
+  [適用於 C\$1\$1 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/ExpenseType) 
+  [適用於 Go 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/ExpenseType) 
+  [AWS適用於 Java 的開發套件第 2 版](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/ExpenseType) 
+  [適用於 Ruby V3 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/ExpenseType) 

# Geometry
<a name="API_Geometry"></a>

以下項目在文件頁中的位置的信息：檢測到的頁面、文字、鍵值組、表格單元格和選擇元素。

## 內容
<a name="API_Geometry_Contents"></a>

 ** BoundingBox **   <a name="Textract-Type-Geometry-BoundingBox"></a>
在文檔頁面上已識別項目位置的軸對齊粗糙表示。  
類型：[BoundingBox](API_BoundingBox.md) 物件  
的必要項目 否

 ** Polygon **   <a name="Textract-Type-Geometry-Polygon"></a>
在邊界框內，已識別項目周圍的細粒度多邊形。  
類型：的陣列[Point](API_Point.md)對象  
的必要項目 否

## 另請參閱
<a name="API_Geometry_SeeAlso"></a>

如需在語言特定的 AWS 開發套件之一中使用此 API 的詳細資訊，請參閱下列說明：
+  [適用於 C\$1\$1 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/Geometry) 
+  [適用於 Go 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/Geometry) 
+  [AWS適用於 Java 的開發套件第 2 版](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/Geometry) 
+  [適用於 Ruby V3 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/Geometry) 

# HumanLoopActivationOutput
<a name="API_HumanLoopActivationOutput"></a>

顯示循環評估中人類的結果。如果沒有人工解析，則輸入不會觸發人工審查。

## 內容
<a name="API_HumanLoopActivationOutput_Contents"></a>

 ** HumanLoopActivationConditionsEvaluationResults **   <a name="Textract-Type-HumanLoopActivationOutput-HumanLoopActivationConditionsEvaluationResults"></a>
顯示狀態評估的結果，包括激活人工審查的條件。  
類型：字串  
長度限制：長度上限為 10240。  
必要項目：否

 ** HumanLoopActivationReasons **   <a name="Textract-Type-HumanLoopActivationOutput-HumanLoopActivationReasons"></a>
顯示是否需要以及為什麼需要人工審查。  
類型：字串陣列  
陣列成員：項目數下限為 1。  
必要項目：否

 ** HumanLoopArn **   <a name="Textract-Type-HumanLoopActivationOutput-HumanLoopArn"></a>
創建的 HumanLoop Source Name (ARN)。  
類型：字串  
長度限制：長度上限為 256。  
必要項目：否

## 另請參閱
<a name="API_HumanLoopActivationOutput_SeeAlso"></a>

如需在語言特定的 AWS 開發套件之一中使用此 API 的詳細資訊，請參閱下列說明：
+  [適用於 C\$1\$1 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/HumanLoopActivationOutput) 
+  [適用於 Go 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/HumanLoopActivationOutput) 
+  [AWS適用於 Java 的開發套件第 2 版](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/HumanLoopActivationOutput) 
+  [適用於 Ruby V3 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/HumanLoopActivationOutput) 

# HumanLoopConfig
<a name="API_HumanLoopConfig"></a>

設置文檔在滿足其中一個條件時將發送到的人工審閲工作流程。您還可以在查看之前設置圖像的某些屬性。

## 內容
<a name="API_HumanLoopConfig_Contents"></a>

 ** DataAttributes **   <a name="Textract-Type-HumanLoopConfig-DataAttributes"></a>
設置輸入資料屬性。  
類型：[HumanLoopDataAttributes](API_HumanLoopDataAttributes.md) 物件  
：必要 否

 ** FlowDefinitionArn **   <a name="Textract-Type-HumanLoopConfig-FlowDefinitionArn"></a>
流程定義的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 256。  
：必要 是

 ** HumanLoopName **   <a name="Textract-Type-HumanLoopConfig-HumanLoopName"></a>
用於此圖像的人工作流程名稱。區域中的這一點應保持獨特。  
類型：字串  
長度限制：長度下限為 1。長度上限為 63。  
模式：`^[a-z0-9](-*[a-z0-9])*`  
：必要 是

## 另請參閱
<a name="API_HumanLoopConfig_SeeAlso"></a>

如需在語言特定的 AWS 開發套件之一中使用此 API 的詳細資訊，請參閱下列說明：
+  [適用於 C\$1\$1 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/HumanLoopConfig) 
+  [適用於 Go 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/HumanLoopConfig) 
+  [AWS適用於 Java 的開發套件第 2 版](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/HumanLoopConfig) 
+  [適用於 Ruby V3 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/HumanLoopConfig) 

# HumanLoopDataAttributes
<a name="API_HumanLoopDataAttributes"></a>

允許您設置圖像的屬性。目前，您可以聲明圖片不含個人身份信息和成人內容。

## 內容
<a name="API_HumanLoopDataAttributes_Contents"></a>

 ** ContentClassifiers **   <a name="Textract-Type-HumanLoopDataAttributes-ContentClassifiers"></a>
設置輸入圖像是不含個人識別資訊或成人內容。  
類型：字串陣列  
陣列成員：項目數上限為 256。  
有效值：` FreeOfPersonallyIdentifiableInformation | FreeOfAdultContent`  
：必要 否

## 另請參閱
<a name="API_HumanLoopDataAttributes_SeeAlso"></a>

如需在語言特定的 AWS 開發套件之一中使用此 API 的詳細資訊，請參閱下列說明：
+  [適用於 C\$1\$1 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/HumanLoopDataAttributes) 
+  [適用於 Go 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/HumanLoopDataAttributes) 
+  [AWS適用於 Java 的開發套件第 2 版](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/HumanLoopDataAttributes) 
+  [適用於 Ruby V3 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/HumanLoopDataAttributes) 

# IdentityDocument
<a name="API_IdentityDocument"></a>

列出在 AnalyzeID 操作中處理的每個文檔的結構。

## 內容
<a name="API_IdentityDocument_Contents"></a>

 ** DocumentIndex **   <a name="Textract-Type-IdentityDocument-DocumentIndex"></a>
表示文檔在標識文檔列表中的位置。第一個文檔標記為 1，第二個 2，依此類推。  
類型：整數  
有效範圍：最小值為 0。  
必要 否

 ** IdentityDocumentFields **   <a name="Textract-Type-IdentityDocument-IdentityDocumentFields"></a>
用於記錄從身份證件中提取的信息的結構。包含已提取文本的標準化字段和值。  
類型：陣列[IdentityDocumentField](API_IdentityDocumentField.md)對象  
必要 否

## 另請參閱
<a name="API_IdentityDocument_SeeAlso"></a>

如需在語言特定的 AWS 開發套件之一中使用此 API 的詳細資訊，請參閱下列說明：
+  [適用於 C\$1\$1 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/IdentityDocument) 
+  [適用於 Go 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/IdentityDocument) 
+  [AWS適用於 Java 的開發套件第 2 版](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/IdentityDocument) 
+  [適用於 Ruby V3 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/IdentityDocument) 

# IdentityDocumentField
<a name="API_IdentityDocumentField"></a>

包含已提取信息的規範化類型和與其關聯的文本的結構。它們分別提取為類型和值。

## 內容
<a name="API_IdentityDocumentField_Contents"></a>

 ** Type **   <a name="Textract-Type-IdentityDocumentField-Type"></a>
用於包含分析 Id 操作檢測到的信息。  
類型：[AnalyzeIDDetections](API_AnalyzeIDDetections.md) 物件  
：必要 否

 ** ValueDetection **   <a name="Textract-Type-IdentityDocumentField-ValueDetection"></a>
用於包含分析 Id 操作檢測到的信息。  
類型：[AnalyzeIDDetections](API_AnalyzeIDDetections.md) 物件  
：必要 否

## 另請參閱
<a name="API_IdentityDocumentField_SeeAlso"></a>

如需在語言特定的 AWS 開發套件之一中使用此 API 的詳細資訊，請參閱下列說明：
+  [適用於 C\$1\$1 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/IdentityDocumentField) 
+  [適用於 Go 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/IdentityDocumentField) 
+  [AWS適用於 Java 的開發套件第 2 版](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/IdentityDocumentField) 
+  [適用於 Ruby V3 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/IdentityDocumentField) 

# LineItemFields
<a name="API_LineItemFields"></a>

保存有關文檔表中不同行的信息的結構。

## 內容
<a name="API_LineItemFields_Contents"></a>

 ** LineItemExpenseFields **   <a name="Textract-Type-LineItemFields-LineItemExpenseFields"></a>
用於顯示表中檢測到的行信息的字段。  
類型：陣列[ExpenseField](API_ExpenseField.md)對象  
：必要 否

## 另請參閱
<a name="API_LineItemFields_SeeAlso"></a>

如需在語言特定的 AWS 開發套件之一中使用此 API 的詳細資訊，請參閱下列說明：
+  [適用於 C\$1\$1 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/LineItemFields) 
+  [適用於 Go 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/LineItemFields) 
+  [AWS適用於 Java 的開發套件第 2 版](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/LineItemFields) 
+  [適用於 Ruby V3 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/LineItemFields) 

# LineItemGroup
<a name="API_LineItemGroup"></a>

包含 LineItems 的表的分組，每個表都由表的`LineItemGroupIndex`。

## 內容
<a name="API_LineItemGroup_Contents"></a>

 ** LineItemGroupIndex **   <a name="Textract-Type-LineItemGroup-LineItemGroupIndex"></a>
用於標識文檔中特定表的編號。遇到的第一個表格將有一個行項目組索引為 1，第二個 2，依此類推。  
類型：整數  
有效範圍：最小值為 0。  
：必要 否

 ** LineItems **   <a name="Textract-Type-LineItemGroup-LineItems"></a>
表格的特定行上的信息細分。  
類型：陣列為[LineItemFields](API_LineItemFields.md)對象  
：必要 否

## 另請參閱
<a name="API_LineItemGroup_SeeAlso"></a>

如需在語言特定的 AWS 開發套件之一中使用此 API 的詳細資訊，請參閱下列說明：
+  [適用於 C\$1\$1 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/LineItemGroup) 
+  [適用於 Go 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/LineItemGroup) 
+  [AWS適用於 Java 的開發套件第 2 版](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/LineItemGroup) 
+  [適用於 Ruby V3 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/LineItemGroup) 

# NormalizedValue
<a name="API_NormalizedValue"></a>

包含與文檔中日期相關的信息，包括值的類型和值。

## 內容
<a name="API_NormalizedValue_Contents"></a>

 ** Value **   <a name="Textract-Type-NormalizedValue-Value"></a>
日期的值，寫為年月-日：分鐘：秒。  
類型：字串  
必要 否

 ** ValueType **   <a name="Textract-Type-NormalizedValue-ValueType"></a>
檢測到的值的標準化類型。在這種情況下，日期。  
類型：字串  
有效值：` DATE`  
必要 否

## 另請參閱
<a name="API_NormalizedValue_SeeAlso"></a>

如需在語言特定的 AWS 開發套件之一中使用此 API 的詳細資訊，請參閱下列說明：
+  [適用於 C\$1\$1 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/NormalizedValue) 
+  [適用於 Go 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/NormalizedValue) 
+  [AWS適用於 Java 的開發套件第 2 版](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/NormalizedValue) 
+  [適用於 Ruby V3 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/NormalizedValue) 

# NotificationChannel
<a name="API_NotificationChannel"></a>

Amazon Simple Notification Service (Amazon SNS) 主題，Amazon Textract 將異步文檔操作的完成狀態發佈至此主題，例如[StartDocumentTextDetection](API_StartDocumentTextDetection.md)。

## 內容
<a name="API_NotificationChannel_Contents"></a>

 ** RoleArn **   <a name="Textract-Type-NotificationChannel-RoleArn"></a>
IAM 角色的 Amazon Resource Name (ARN)，該角色授予 Amazon Textract 發佈 Amazon SNS 主題的許可。  
類型：字串  
長度限制：長度下限為 20。長度上限為 2048。  
模式：`arn:([a-z\d-]+):iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+`  
：必要 是

 ** SNSTopicArn **   <a name="Textract-Type-NotificationChannel-SNSTopicArn"></a>
亞馬遜 Textract 將完成狀態發佈到的 Amazon SNS 主題。  
類型：字串  
長度限制：長度下限為 20。長度上限為 1024。  
模式：`(^arn:([a-z\d-]+):sns:[a-zA-Z\d-]{1,20}:\w{12}:.+$)`  
：必要 是

## 另請參閱
<a name="API_NotificationChannel_SeeAlso"></a>

如需在語言特定的 AWS 開發套件之一中使用此 API 的詳細資訊，請參閱下列說明：
+  [適用於 C\$1\$1 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/NotificationChannel) 
+  [適用於 Go 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/NotificationChannel) 
+  [AWS適用於 Java 的開發套件第 2 版](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/NotificationChannel) 
+  [適用於 Ruby V3 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/NotificationChannel) 

# OutputConfig
<a name="API_OutputConfig"></a>

設置輸出是否轉到用户創建的存儲桶。用於設置存儲桶的名稱和輸出文件上的前綴。

 `OutputConfig`是一個可選參數，可讓您調整輸出的放置位置。默認情況下，Amazon Textract 將在內部存儲結果，並且只能通過獲取 API 操作訪問。啟用 OutputConfig 後，您可以設置將輸出發送到的存儲桶的名稱以及您可以下載結果的結果的文件前綴。此外，您也可以設置`KMSKeyID`參數添加到客户主金鑰 (CMK)，以加密您的輸出。如果沒有此參數設置，Amazon Textract 將使用適用於 Amazon S3 的 AWS 託管 CMK 對服務器端進行加密。

Amazon Textract 處理文檔時，必須對買家內容進行解密。如果您的帳户根據 AI 服務退出政策選擇退出，則在服務處理客户內容後，所有未加密的客户內容都會立即永久刪除。Amazon Textract 不會保留輸出的副本。如需如何選擇退出的資訊，請參[管理 AI 服務選擇退出政策。](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_ai-opt-out.html)

如需資料隱私權的詳細資訊，請參[資料私權常見問答](https://aws.amazon.com/compliance/data-privacy-faq/)。

## 內容
<a name="API_OutputConfig_Contents"></a>

 ** S3Bucket **   <a name="Textract-Type-OutputConfig-S3Bucket"></a>
輸出要轉到的存儲桶的名稱。  
類型：字串  
長度限制：長度下限為 3。長度上限為 255。  
模式：`[0-9A-Za-z\.\-_]*`  
：必要 是

 ** S3Prefix **   <a name="Textract-Type-OutputConfig-S3Prefix"></a>
物件金鑰的字首，而該物件金鑰是保存輸出的起源。如果未啟用，則前綴將為「文本輸出」。  
類型：字串  
長度限制：長度下限為 1。長度上限為 1024。  
模式：`.*\S.*`  
：必要 否

## 另請參閱
<a name="API_OutputConfig_SeeAlso"></a>

如需在語言特定的 AWS 開發套件之一中使用此 API 的詳細資訊，請參閱下列說明：
+  [適用於 C\$1\$1 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/OutputConfig) 
+  [適用於 Go 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/OutputConfig) 
+  [AWS適用於 Java 的開發套件第 2 版](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/OutputConfig) 
+  [適用於 Ruby V3 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/OutputConfig) 

# Point
<a name="API_Point"></a>

文檔頁面上點的 X 和 Y 座標。返回的 X 和 Y 值是整個文檔頁面大小的比率。例如，如果輸入文檔為 700 x 200，且操作返回 X=0.5 且 Y=0.25，則該點位於文檔頁面上 (350,50) 像素座標處。

陣列`Point`物件,`Polygon`的一部分，返回為[Geometry](API_Geometry.md)對象，該對象在[Block](API_Block.md)物件。一個`Polygon`對象表示檢測到的文本、鍵值對、表格、表格單元格或選擇元素周圍的細粒度多邊形。

## 內容
<a name="API_Point_Contents"></a>

 ** X **   <a name="Textract-Type-Point-X"></a>
上某個點的 X 座標值`Polygon`。  
類型：Float  
：必要 否

 ** Y **   <a name="Textract-Type-Point-Y"></a>
上某個點的 Y 座標值`Polygon`。  
類型：Float  
：必要 否

## 另請參閱
<a name="API_Point_SeeAlso"></a>

如需在語言特定的 AWS 開發套件之一中使用此 API 的詳細資訊，請參閱下列說明：
+  [適用於 C\$1\$1 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/Point) 
+  [適用於 Go 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/Point) 
+  [AWS適用於 Java 的開發套件第 2 版](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/Point) 
+  [適用於 Ruby V3 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/Point) 

# Relationship
<a name="API_Relationship"></a>

有關塊如何相互關聯的信息。一個`Block`對象包含 0 或更多`Relation`列表中的對象，`Relationships`。如需詳細資訊，請參閱 [Block](API_Block.md)。

所以此`Type`元素提供了所有塊的關係類型`IDs`陣列。

## 內容
<a name="API_Relationship_Contents"></a>

 ** Ids **   <a name="Textract-Type-Relationship-Ids"></a>
相關塊的 ID 數組。您可以從`Type`元素。  
類型：字串陣列  
模式：`.*\S.*`  
：必要 否

 ** Type **   <a name="Textract-Type-Relationship-Type"></a>
ID 數組中的塊與當前塊的關係類型。兩者間的關係可用`VALUE`或者`CHILD`。VALUE 類型的關係是一個列表，其中包含與鍵值對的 KEY 相關聯的 VALUE 塊的 ID。類型 CIDD 的關係是一個 ID 的列表，用於標識行單元格塊（表中的單元格塊），在選擇元素的情況下標識 WORD 塊。  
類型：字串  
有效值：` VALUE | CHILD | COMPLEX_FEATURES`  
：必要 否

## 另請參閱
<a name="API_Relationship_SeeAlso"></a>

如需在語言特定的 AWS 開發套件之一中使用此 API 的詳細資訊，請參閱下列說明：
+  [適用於 C\$1\$1 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/Relationship) 
+  [適用於 Go 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/Relationship) 
+  [AWS適用於 Java 的開發套件第 2 版](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/Relationship) 
+  [適用於 Ruby V3 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/Relationship) 

# S3Object
<a name="API_S3Object"></a>

標識文檔的 S3 存儲桶名稱和文件名。

包含文檔的 S3 存儲桶的 AWS 區域必須與您用於 Amazon Textract 操作的區域匹配。

為了使 Amazon Textract 能夠處理 S3 存儲桶中的文件，用户必須具有訪問 S3 存儲桶和文件的權限。

## 內容
<a name="API_S3Object_Contents"></a>

 ** Bucket **   <a name="Textract-Type-S3Object-Bucket"></a>
S3 儲存貯體的名稱。請注意，\$1 字符在文件名中無效。  
類型：字串  
長度限制：長度下限為 3。長度上限為 255。  
模式：`[0-9A-Za-z\.\-_]*`  
必要 否

 ** Name **   <a name="Textract-Type-S3Object-Name"></a>
輸入文檔的文件名。同步操作可以使用 JPEG 或 PNG 格式的圖像文件。異步操作還支持 PDF 和 TIFF 格式文件。  
類型：字串  
長度限制：長度下限為 1。長度上限為 1024。  
模式：`.*\S.*`  
必要 否

 ** Version **   <a name="Textract-Type-S3Object-Version"></a>
如果儲存儲體已啟用版本控制，您可以指定物件版本。  
類型：字串  
長度限制：長度下限為 1。長度上限為 1024。  
模式：`.*\S.*`  
必要 否

## 另請參閱
<a name="API_S3Object_SeeAlso"></a>

如需在語言特定的 AWS 開發套件之一中使用此 API 的詳細資訊，請參閱下列說明：
+  [適用於 C\$1\$1 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/S3Object) 
+  [適用於 Go 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/S3Object) 
+  [AWS適用於 Java 的開發套件第 2 版](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/S3Object) 
+  [適用於 Ruby V3 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/S3Object) 

# Warning
<a name="API_Warning"></a>

有關異步文本分析過程中發生的問題的警告 ([StartDocumentAnalysis](API_StartDocumentAnalysis.md)）或異步文檔文本檢測（[StartDocumentTextDetection](API_StartDocumentTextDetection.md)。

## 內容
<a name="API_Warning_Contents"></a>

 ** ErrorCode **   <a name="Textract-Type-Warning-ErrorCode"></a>
警告的錯誤碼。  
類型：字串  
：必要 否

 ** Pages **   <a name="Textract-Type-Warning-Pages"></a>
警告應用到的頁面的列表。  
類型：整數數  
有效範圍：最小值為 0。  
：必要 否

## 另請參閱
<a name="API_Warning_SeeAlso"></a>

如需在語言特定的 AWS 開發套件之一中使用此 API 的詳細資訊，請參閱下列說明：
+  [適用於 C\$1\$1 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/Warning) 
+  [適用於 Go 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/Warning) 
+  [AWS適用於 Java 的開發套件第 2 版](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/Warning) 
+  [適用於 Ruby V3 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/Warning)