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：一個金鑰Block對象和一個值Block物件。例如：名稱: 安娜·席爾瓦·卡羅萊納州包含一個鍵和值。名稱:是關鍵。安娜·席爾瓦·卡羅萊納州是值。
表格和表格單元格數據。資料表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，最多只能傳回 1,000 個結果。預設值為 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 ]
      }
   ]
}