As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.
Analisa documentos de identidade para obter informações relevantes. Essas informações são extraídas e retornadas comoIdentityDocumentFields, que registra o campo normalizado e o valor do texto extraído.Ao contrário de outras operações Amazon Textract,AnalyzeIDnão retorna nenhum dado de geometria.
Sintaxe da solicitação
{
"DocumentPages": [
{
"Bytes": blob,
"S3Object": {
"Bucket": "string",
"Name": "string",
"Version": "string"
}
}
]
}Parâmetros de solicitação
A solicitação aceita os dados a seguir no formato JSON.
- DocumentPages
-
O documento que está sendo passado para o AnalyzeID.
Type: Matriz deDocumentobjetos
Membros da matriz: Número mínimo de 1 item. Número máximo de 2 itens.
Obrigatório: Sim
Sintaxe da resposta
{
"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"
}
}
]
}
]
}Elementos de resposta
Se a ação for bem-sucedida, o serviço reenviará uma resposta HTTP 200.
Os seguintes dados são retornados no formato JSON pelo serviço.
- AnalyzeIDModelVersion
-
A versão da API AnalyzeIdentity que está sendo usada para processar documentos.
Type: String
- DocumentMetadata
-
Informações sobre o documento de entrada.
Tipo: objeto DocumentMetadata
- IdentityDocuments
-
A lista de documentos processados pelo AnalyzeID. Inclui um número que denota seu lugar na lista e a estrutura de resposta do documento.
Type: Matriz deIdentityDocumentobjetos
Erros
- AccessDeniedException
-
Você não está autorizado a executar a ação. Use o nome de recurso da Amazon (ARN) de um usuário autorizado ou a função do IAM para executar a operação.
Código de status HTTP: 400
- BadDocumentException
-
O Amazon Textract não consegue ler o documento. Para obter mais informações sobre os limites de documentos no Amazon Textract, consulteLimites rígidos no Amazon Textract.
Código de status HTTP: 400
- DocumentTooLargeException
-
O documento não pode ser processado porque é muito grande. O tamanho máximo do documento para operações síncronas 10 MB. O tamanho máximo do documento para operações assíncronas é de 500 MB para arquivos PDF.
Código de status HTTP: 400
- InternalServerError
-
O Amazon Textract teve um problema de serviço. Tente fazer a chamada novamente.
Código de status HTTP: 500
- InvalidParameterException
-
Um parâmetro de entrada violou uma restrição. Por exemplo, em operações síncronas, um
InvalidParameterExceptionexceção ocorre quando nenhum dosS3ObjectouBytesvalores são fornecidos noDocumentParâmetro de solicitação. Valide seu parâmetro antes de chamar a operação de API novamente.Código de status HTTP: 400
- InvalidS3ObjectException
-
O Amazon Textract está indisponível para acessar o objeto do S3 especificado na solicitação. para obter mais informações,Configuração de acesso ao Amazon S3Para obter informações sobre a solução de problemas, consulteSolução de problemas do Amazon S3
Código de status HTTP: 400
- ProvisionedThroughputExceededException
-
O número de solicitações excedeu o limite da taxa de transferência. Se precisar aumentar esse limite, entre em contato com o Amazon Textract.
Código de status HTTP: 400
- ThrottlingException
-
O Amazon Textract está temporariamente indisponível para processar a solicitação. Tente fazer a chamada novamente.
Código de status HTTP: 500
- UnsupportedDocumentException
-
O formato do documento de entrada não é compatível. Os documentos para operações podem estar no formato PNG, JPEG, PDF ou TIFF.
Código de status HTTP: 400
Consulte também
Para obter mais informações sobre como usar essa API em um dos AWS SDKs específicos de linguagem, consulte o seguinte:
