GetDocumentAnalysis

获取分析文档中文本的 Amazon Textract 异步操作的结果。

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

GetDocumentAnalysis返回一个数组Block对象。返回以下类型的信息：

表单数据（键值对）。两个相关信息返回Block对象，每种类型KEY_VALUE_SET: KeyBlock对象和一个 VALUEBlock对象。例如，名称：安娜·席尔瓦包含密钥和值。名称：是关键。安娜·席尔瓦是值。
表格和表格单元格数据。一张桌子Block对象包含有关检测到的表的信息。一个单元格Block对象将为表中的每个单元格返回。
文本的行和单词。一行Block对象包含一个或多个 WORDBlock对象。返回文档中检测到的所有行和单词（包括与StartDocumentAnalysis FeatureTypes输入参数)。

可以在表单数据和表格中检测到选择元素，例如复选框和选项按钮（单选按钮）。一个选择 _ 元素Block对象包含有关选择元素的信息，包括选择状态。

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

有关更多信息，请参阅。文档文本分析.

请求语法


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

请求参数

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

JobId

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

类型: 字符串

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

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

：必需是

MaxResults

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

类型: 整数

有效范围：最小值为 1。

：必需否

NextToken

如果之前的响应不完整（因为需要检索更多块），Amazon Textract 将在响应中返回分页令牌。您可以使用此分页令牌来检索下一组块块。

类型: 字符串

长度约束：最小长度为 1。长度上限为 255。

模式：.*\S.*

：必需否

响应语法


{
   "AnalyzeDocumentModelVersion": "string",
   "Blocks": [ 
      { 
         "BlockType": "string",
         "ColumnIndex": number,
         "ColumnSpan": number,
         "Confidence": number,
         "EntityTypes": [ "string" ],
         "Geometry": { 
            "BoundingBox": { 
               "Height": number,
               "Left": number,
               "Top": number,
               "Width": number
            },
            "Polygon": [ 
               { 
                  "X": number,
                  "Y": number
               }
            ]
         },
         "Id": "string",
         "Page": number,
         "Relationships": [ 
            { 
               "Ids": [ "string" ],
               "Type": "string"
            }
         ],
         "RowIndex": number,
         "RowSpan": number,
         "SelectionStatus": "string",
         "Text": "string",
         "TextType": "string"
      }
   ],
   "DocumentMetadata": { 
      "Pages": number
   },
   "JobStatus": "string",
   "NextToken": "string",
   "StatusMessage": "string",
   "Warnings": [ 
      { 
         "ErrorCode": "string",
         "Pages": [ number ]
      }
   ]
}