本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。
分析身份證明文件以獲取相關信息。此信息被提取並返回為IdentityDocumentFields
,它記錄提取文本的標準化字段和值。與其他 Amazon Textract 操作不同,AnalyzeID
不會傳回任何幾何數據。
請求語法
{
"DocumentPages": [
{
"Bytes": blob
,
"S3Object": {
"Bucket": "string
",
"Name": "string
",
"Version": "string
"
}
}
]
}
請求參數
請求接受採用 JSON 格式的下列資料。
- DocumentPages
-
傳遞給分析 ID 的文檔。
類型:的陣列Document對象
陣列成員:項目數下限為 1。項目數上限為 2。
的必要項目:是
回應語法
{
"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"
}
}
]
}
]
}
回應元素
如果動作成功,則服務傳回 HTTP 200 回應。
服務會傳回下列 JSON 格式的資料。
- AnalyzeIDModelVersion
-
用於處理文檔的分析身份 API 版本。
類型:字串
- DocumentMetadata
-
有關輸入文檔的信息。
類型:DocumentMetadata 物件
- IdentityDocuments
-
分析編號處理的文件列表。包括一個數字,表示它們在列表中的位置和文檔的響應結構。
類型:的陣列IdentityDocument對象
錯誤
- AccessDeniedException
-
您未獲授權執行動作。使用已獲授權之使用者或 IAM 角色的 Amazon Resource Name (ARN) 來執行操作。
HTTP 狀態碼:400
- BadDocumentException
-
Amazon Textract 無法閲讀該文檔。有關 Amazon Textract 中文檔限制的更多信息,請參閲亞馬遜文字中的硬性限制。
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 的存取如需故障診斷資訊,請參閱 。故障診斷 Amazon S3
HTTP 狀態碼:400
- ProvisionedThroughputExceededException
-
請求數超過您的傳輸量限制。如果您希望提高此限制,請聯絡 Amazon Textract。
HTTP 狀態碼:400
- ThrottlingException
-
Amazon Textract 暫時無法處理請求。請再次嘗試呼叫。
HTTP 狀態碼:500
- UnsupportedDocumentException
-
不支持輸入檔案的格式。操作文檔可以採用 PNG、JPEG、PDF 或 TIFF 格式。
HTTP 狀態碼:400
另請參閱
如需在語言特定的 AWS 開發套件之一中使用此 API 的詳細資訊,請參閱下列說明: