本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

# 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`键：Key`Block`对象和一个 VALUE`Block`对象。例如，*名称：安娜·席尔瓦*包含密钥和值。*名称：*是关键。*安娜·席尔瓦*是值。
+ 表格和表格单元格数据。一张桌子`Block`对象包含有关检测到的表的信息。一个单元格`Block`对象将为表中的每个单元格返回。
+ 文本的行和单词。一行`Block`对象包含一个或多个 WORD`Block`对象。返回文档中检测到的所有行和单词（包括与`FeatureTypes`)。

可以在表单数据和表格中检测到选择元素，例如复选框和选项按钮（单选按钮）。一个选择 \$1 元素`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>
要执行的分析类型的列表。将 TABLES 添加到列表以返回有关在输入文档中检测到的表的信息。添加 FORMS 以返回检测到的表单数据。要执行这两种类型的分析，请将 TABLES 和 FORMS 添加到`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 资源名称 (ARN) 来执行操作。  
HTTP 状态代码：400

 ** BadDocumentException **   
Amazon Textract 无法阅读文档。有关 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 V2 的开发工具包](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 存储桶的 AWS 区域必须与您用于 Amazon Textract 操作的 AWS 区域匹配。  
如果您使用 AWS CLI 调用 Amazon Textract 操作，则不支持使用字节属性传递图像字节。您必须先将文档上传到 Amazon S3 存储桶，然后使用 S3Oject 属性调用操作。  
要使 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 资源名称 (ARN) 来执行操作。  
HTTP 状态代码：400

 ** BadDocumentException **   
Amazon Textract 无法阅读文档。有关 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_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 V2 的开发工具包](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>
文档正在传递给 AnalyZeID。  
类型: 数组数组[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>
用于处理文档的 AnalyzeIdentity 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>
AnalyzeID 处理的文档清单。包括一个数字，表示它们在列表中的位置以及文档的响应结构。  
类型: 数组数组[IdentityDocument](API_IdentityDocument.md)对象

## 错误
<a name="API_AnalyzeID_Errors"></a>

 ** AccessDeniedException **   
您无权执行该操作。使用授权用户或 IAM 角色的 Amazon 资源名称 (ARN) 来执行操作。  
HTTP 状态代码：400

 ** BadDocumentException **   
Amazon Textract 无法阅读文档。有关 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 V2 的开发工具包](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`的类型 PAGE。每页`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 资源名称 (ARN) 来执行操作。  
HTTP 状态代码：400

 ** BadDocumentException **   
Amazon Textract 无法阅读文档。有关 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 V2 的开发工具包](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`: Key`Block`对象和一个 VALUE`Block`对象。例如，*名称：安娜·席尔瓦*包含密钥和值。*名称：*是关键。*安娜·席尔瓦*是值。
+ 表格和表格单元格数据。一张桌子`Block`对象包含有关检测到的表的信息。一个单元格`Block`对象将为表中的每个单元格返回。
+ 文本的行和单词。一行`Block`对象包含一个或多个 WORD`Block`对象。返回文档中检测到的所有行和单词（包括与`StartDocumentAnalysis` `FeatureTypes`输入参数)。

可以在表单数据和表格中检测到选择元素，例如复选框和选项按钮（单选按钮）。一个选择 \$1 元素`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，则返回最多 1000 个结果。默认值是 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 资源名称 (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 V2 的开发工具包](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`的类型 PAGE。每个页面`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，则返回最多 1000 个结果。默认值是 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 资源名称 (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 V2 的开发工具包](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 资源名称 (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 V2 的开发工具包](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 将完成状态发布到您在中指定的 Amazon Simple Notification Service (Amazon SNS) 主题。`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>
要执行的分析类型的列表。将 TABLES 添加到列表以返回有关输入文档中检测到的表的信息。添加 FORMS 以返回检测到的表单数据。要执行这两种类型的分析，请将 TABLES 和 FORMS 添加到`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 资源名称 (ARN) 来执行操作。  
HTTP 状态代码：400

 ** BadDocumentException **   
Amazon Textract 无法阅读文档。有关 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 V2 的开发工具包](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 将在内部保存结果，以便通过 getDocumentTextTectIncect 操作访问。  
类型：[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 资源名称 (ARN) 来执行操作。  
HTTP 状态代码：400

 ** BadDocumentException **   
Amazon Textract 无法阅读文档。有关 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_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 V2 的开发工具包](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 将完成状态发布到您提供给`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 资源名称 (ARN) 来执行操作。  
HTTP 状态代码：400

 ** BadDocumentException **   
Amazon Textract 无法阅读文档。有关 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_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 V2 的开发工具包](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>

用于包含 AnalyzeID 操作检测到的信息。

## 目录
<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 V2 的开发工具包](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>
已识别的文本项目的类型。在文本检测操作中，返回以下类型：  
+  *页*-包含 LINE 列表`Block`在文档页面上检测到的对象。
+  *单词*-在文档页面上检测到的单词。单词 是一个或多个 ISO 基本拉丁字母字符，不用空格分隔。
+  *线*-在文档页面上检测到的制表符分隔的连续单词的字符串。
在文本分析操作中，返回以下类型：  
+  *页*-包含孩子列表`Block`在文档页面上检测到的对象。
+  *KEY\$1VALUE\$1SET*-存储 KEY 和 VALUE`Block`在文档页面上检测到的链接文本的对象。使用`EntityType`字段来确定 KEY\$1VALUE\$1SET 对象是否为 KEY`Block`对象或 VALUE`Block`对象。
+  *单词*-在文档页面上检测到的单词。单词 是一个或多个 ISO 基本拉丁字母字符，不用空格分隔。
+  *线*-在文档页面上检测到的制表符分隔的连续单词的字符串。
+  *桌子*-在文档页面上检测到的表格。表格是基于网格的信息，包含两行或多列，单元格跨度为一行和一列。
+  *细胞*-检测到的桌子里的一个细胞。单元格是包含单元格中文本的块的父项。
+  *选择\$1元素*-在文档页面上检测到的选择元素，例如选项按钮（单选按钮）或复选框。使用的值`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 V2 的开发工具包](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 V2 的开发工具包](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 对象。

您可以使用`Bytes`财产。例如，您应使用`Bytes`属性来传递从本地文件系统加载的文档。通过使用`Bytes`属性必须采用 base64 编码。如果您使用 AWS 开发工具包调用 Amazon Textract API 操作，则代码可能不需要对文档文件字节进行编码。

您可以使用存储在 S3 存储桶中的图像传递给 Amazon Textract API 操作。`S3Object`财产。存储在 S3 存储桶中的文档不需要 base64 编码。

包含 S3 对象的 S3 存储桶的 AWS 区域必须与您用于 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。最大长度为 10485760。  
必填项：否

 ** 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 V2 的开发工具包](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 V2 的开发工具包](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 V2 的开发工具包](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 V2 的开发工具包](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 V2 的开发工具包](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 V2 的开发工具包](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 V2 的开发工具包](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 V2 的开发工具包](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>

显示循环中的人类评估结果。如果没有 HumanLoopARN，则输入内容不会触发人工审查。

## 目录
<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 的 Amazon 资源名称 (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 V2 的开发工具包](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 资源名称 (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 V2 的开发工具包](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 V2 的开发工具包](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>

列出了在分析 ID 操作中处理的每个文档的结构。

## 目录
<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 V2 的开发工具包](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>
用于包含 AnalyzeID 操作检测到的信息。  
类型：[AnalyzeIDDetections](API_AnalyzeIDDetections.md) 对象  
必填项: 否

 ** ValueDetection **   <a name="Textract-Type-IdentityDocumentField-ValueDetection"></a>
用于包含 AnalyzeID 操作检测到的信息。  
类型：[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 V2 的开发工具包](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>
ExpenseFields 用于显示表格上检测到的行中的信息。  
类型: 数组[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 V2 的开发工具包](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>

一组包含 lineItem 的表格，其中每个表都由表格标识`LineItemGroupIndex`.

## 目录
<a name="API_LineItemGroup_Contents"></a>

 ** LineItemGroupIndex **   <a name="Textract-Type-LineItemGroup-LineItemGroupIndex"></a>
用于标识文档中特定表的数字。遇到的第一张表格的 lineItemGroupIndex 将为 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 V2 的开发工具包](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。  
类型: 字符串  
有效值:` 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 V2 的开发工具包](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 Textract 向其发布异步文档操作的完成状态的 Amazon Simple Notification Service (Amazon SNS) 主题，例如[StartDocumentTextDetection](API_StartDocumentTextDetection.md).

## 目录
<a name="API_NotificationChannel_Contents"></a>

 ** RoleArn **   <a name="Textract-Type-NotificationChannel-RoleArn"></a>
向 Amazon Textract 授予 Amazon SNS 主题发布权限的 Amazon 资源名称 (ARN)。  
类型: 字符串  
长度约束：最小长度为 20。长度上限为 2048。  
模式：`arn:([a-z\d-]+):iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+`  
必填项：是

 ** SNSTopicArn **   <a name="Textract-Type-NotificationChannel-SNSTopicArn"></a>
Amazon 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 V2 的开发工具包](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>
将保存输出的对象键的前缀。如果未启用，前缀将为 “textract\$1output”。  
类型: 字符串  
长度约束：最小长度为 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 V2 的开发工具包](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>
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 V2 的开发工具包](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。孩子类型的关系是一个 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 V2 的开发工具包](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 V2 的开发工具包](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 V2 的开发工具包](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)