GetDocumentTextDetection

获取用于检测文档中文本的 Amazon Textract 异步操作的结果。Amazon Textract 可以检测文本行和构成一行文本的单词。

通过调用来开始异步文本检测StartDocumentTextDetection，它返回作业标识符 (JobId)。当文本检测操作完成后，Amazon Textract 向亚马逊 Simple Notification Service (Amazon SNS) 主题发布完成状态，该主题已在首次调用时注册StartDocumentTextDetection. 要获得文本检测操作的结果，请首先检查发布到 Amazon SNS 主题的状态值是否为SUCCEEDED. 如果是的话，打电话GetDocumentTextDetection，然后传递作业标识符（JobId) 从最初的电话到StartDocumentTextDetection.

GetDocumentTextDetection返回一个数组Block对象。

每个文档页面都有关联Block的类型 PAGE。每个页面Block对象是 LINE 的父Block表示页面上检测到的文本行的对象。一行Block对象是构成该行的每个单词的父项。单词的表示为BlockWORD 类型的对象。

使用 MaxResults 参数限制返回的数据块数。如果结果超过中指定的结果MaxResults，的价值NextToken在操作响应中包含用于获取下一组结果的分页令牌。要获取下一页结果，请致电GetDocumentTextDetection，然后填充NextToken具有从上一次调用返回的令牌值的请求参数GetDocumentTextDetection.

有关更多信息，请参阅。文本检测.

请求语法


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

请求参数

请求接受采用 JSON 格式的以下数据。

JobId

文本检测作业的唯一标识符。这些区域有：JobId从返回的StartDocumentTextDetection. 一个JobId该值仅在 7 天内有效。

类型: 字符串

长度约束：最小长度为 1。最大长度为 64。

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

：必需是

MaxResults

每个分页呼叫返回的最大结果数。您可以指定的最大值是 1,000。如果指定的值大于 1,000，则返回最多 1000 个结果。默认值是 1,000。

类型: 整数

有效范围：最小值为 1。

：必需否

NextToken

如果之前的响应不完整（因为需要检索更多块），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 ]
      }
   ]
}