本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。 # GetDocumentTextDetection 获取用于检测文档中文本的 Amazon Textract 异步操作的结果。Amazon Textract 可以检测文本行和构成一行文本的单词。通过调用来开始异步文本检测[StartDocumentTextDetection](API_StartDocumentTextDetection.md)，它返回作业标识符 (`JobId`)。当文本检测操作完成后，Amazon Textract 向亚马逊 Simple Notification Service (Amazon SNS) 主题发布完成状态，该主题已在首次调用时注册`StartDocumentTextDetection`. 要获得文本检测操作的结果，请首先检查发布到 Amazon SNS 主题的状态值是否为`SUCCEEDED`. 如果是的话，打电话`GetDocumentTextDetection`，然后传递作业标识符（`JobId`) 从最初的电话到`StartDocumentTextDetection`. `GetDocumentTextDetection`返回一个数组[Block](API_Block.md)对象。每个文档页面都有关联`Block`的类型 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). ## 请求语法 ``` { "JobId": "string", "MaxResults": number, "NextToken": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [JobId](#API_GetDocumentTextDetection_RequestSyntax) ** 文本检测作业的唯一标识符。这些区域有：`JobId`从返回的`StartDocumentTextDetection`. 一个`JobId`该值仅在 7 天内有效。类型: 字符串长度约束：最小长度为 1。最大长度为 64。模式：`^[a-zA-Z0-9-_]+$` ：必需是 ** [MaxResults](#API_GetDocumentTextDetection_RequestSyntax) ** 每个分页呼叫返回的最大结果数。您可以指定的最大值是 1,000。如果指定的值大于 1,000，则返回最多 1000 个结果。默认值是 1,000。类型: 整数有效范围：最小值为 1。：必需否 ** [NextToken](#API_GetDocumentTextDetection_RequestSyntax) ** 如果之前的响应不完整（因为需要检索更多块），Amazon Textract 将在响应中返回分页令牌。您可以使用此分页令牌来检索下一组区块。类型: 字符串长度约束：最小长度为 1。长度上限为 255。模式：`.*\S.*` ：必需否 ## 响应语法 ``` { "Blocks": [ { "BlockType": "string", "ColumnIndex": number, "ColumnSpan": number, "Confidence": number, "EntityTypes": [ "string" ], "Geometry": { "BoundingBox": { "Height": number, "Left": number, "Top": number, "Width": number }, "Polygon": [ { "X": number, "Y": number } ] }, "Id": "string", "Page": number, "Relationships": [ { "Ids": [ "string" ], "Type": "string" } ], "RowIndex": number, "RowSpan": number, "SelectionStatus": "string", "Text": "string", "TextType": "string" } ], "DetectDocumentTextModelVersion": "string", "DocumentMetadata": { "Pages": number }, "JobStatus": "string", "NextToken": "string", "StatusMessage": "string", "Warnings": [ { "ErrorCode": "string", "Pages": [ number ] } ] } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回的以下数据。 ** [Blocks](#API_GetDocumentTextDetection_ResponseSyntax) ** 文本检测操作的结果。类型: 数组的数组[Block](API_Block.md)对象 ** [DetectDocumentTextModelVersion](#API_GetDocumentTextDetection_ResponseSyntax) ** 类型: 字符串 ** [DocumentMetadata](#API_GetDocumentTextDetection_ResponseSyntax) ** 有关 Amazon Textract 处理的文档的信息。`DocumentMetadata`在 Amazon Textract 视频操作的分页响应的每一页中返回。类型：[DocumentMetadata](API_DocumentMetadata.md) 对象 ** [JobStatus](#API_GetDocumentTextDetection_ResponseSyntax) ** 文本检测作业的当前状态。类型: 字符串有效值:` IN_PROGRESS | SUCCEEDED | FAILED | PARTIAL_SUCCESS` ** [NextToken](#API_GetDocumentTextDetection_ResponseSyntax) ** 如果响应被截断，Amazon Textract 将返回此令牌。您可以在后续请求中使用此令牌来检索下一组文本检测结果。类型: 字符串长度约束：最小长度为 1。长度上限为 255。模式：`.*\S.*` ** [StatusMessage](#API_GetDocumentTextDetection_ResponseSyntax) ** 如果无法完成检测作业，则返回该函数。包含发生什么错误的解释。类型: 字符串 ** [Warnings](#API_GetDocumentTextDetection_ResponseSyntax) ** 文档的文本检测操作期间发生的警告列表。类型: 数组的数组[Warning](API_Warning.md)对象 ## 错误 ** AccessDeniedException ** 您无权执行该操作。使用授权用户或 IAM 角色的 Amazon 资源名称 (ARN) 来执行操作。 HTTP 状态代码：400 ** InternalServerError ** Amazon Textract 遇到了一个服务问题。重新尝试您的调用。 HTTP 状态代码：500 ** InvalidJobIdException ** 向传递了无效的作业标识符[GetDocumentAnalysis](API_GetDocumentAnalysis.md)或者去[GetDocumentAnalysis](API_GetDocumentAnalysis.md). HTTP 状态代码：400 ** InvalidKMSKeyException ** 表示输入的 KMS 密钥没有解密权限，或者 KMS 密钥输入错误。 HTTP 状态代码：400 ** InvalidParameterException ** 有一个输入参数违反了约束。例如，在同步操作中，`InvalidParameterException`如果两者都不会发生异常`S3Object`要么`Bytes`值在`Document`请求参数。先验证您的参数，然后重新调用 API 操作。 HTTP 状态代码：400 ** InvalidS3ObjectException ** Amazon Textract 无法访问请求中指定的 S3 对象。有关更多信息，[配置对 Amazon S3 的访问权限](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html)有关故障排除信息，请参阅。[Amazon S3 故障排除](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html) HTTP 状态代码：400 ** ProvisionedThroughputExceededException ** 请求数超出了您的吞吐量限制。如要增加此限制，请联系 Amazon Textract。 HTTP 状态代码：400 ** ThrottlingException ** Amazon Textract 暂时无法处理该请求。重新尝试您的调用。 HTTP 状态代码：500 ## 另请参阅有关在特定语言的AWS软件开发工具包中使用此 API 的更多信息，请参阅以下内容： + [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/textract-2018-06-27/GetDocumentTextDetection) + [适用于 .NET 的AWS开发工具包](https://docs.aws.amazon.com/goto/DotNetSDKV3/textract-2018-06-27/GetDocumentTextDetection) + [适用于 C\$1\$1 的AWS开发工具包](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/GetDocumentTextDetection) + [适用于 Go 的AWS开发工具包](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/GetDocumentTextDetection) + [AWS适用于 Java 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)