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á. # StartDocumentAnalysis Inicia a análise assíncrona de um documento de entrada para pesquisar relacionamentos entre itens detectados, como pares de chave-valor, tabelas e elementos de seleção. `StartDocumentAnalysis`pode analisar texto em documentos que estão nos formatos JPEG, PNG, TIFF e PDF. Os documentos são armazenados em um bucket do Amazon S3. Usar o[DocumentLocation](API_DocumentLocation.md)Para especificar o nome do bucket do e o nome do arquivo do documento. `StartDocumentAnalysis`retorna um identificador de trabalho (`JobId`) que você usa para obter os resultados da operação. Quando a análise de texto for concluída, o Amazon Textract publica um status de conclusão no tópico do Amazon Simple Notification Service (Amazon SNS) especificado no`NotificationChannel`. Para obter os resultados da operação de análise de texto, primeiro verifique se o valor de status publicado no tópico do Amazon SNS é`SUCCEEDED`. Em caso afirmativo, ligue[GetDocumentAnalysis](API_GetDocumentAnalysis.md)e passar o identificador de trabalho (`JobId`) da chamada inicial para`StartDocumentAnalysis`. Para obter mais informações, consulte[Análise de texto de documentos](https://docs.aws.amazon.com/textract/latest/dg/how-it-works-analyzing.html). ## Sintaxe da solicitação ``` { "ClientRequestToken": "string", "DocumentLocation": { "S3Object": { "Bucket": "string", "Name": "string", "Version": "string" } }, "FeatureTypes": [ "string" ], "JobTag": "string", "KMSKeyId": "string", "NotificationChannel": { "RoleArn": "string", "SNSTopicArn": "string" }, "OutputConfig": { "S3Bucket": "string", "S3Prefix": "string" } } ``` ## Parâmetros de solicitação A solicitação aceita os dados a seguir no formato JSON. ** [ClientRequestToken](#API_StartDocumentAnalysis_RequestSyntax) ** O token idempotente que você usa para identificar a solicitação inicial. Se você usar o mesmo token com vários`StartDocumentAnalysis`solicitações, o mesmo`JobId`O retornado. Usar o`ClientRequestToken`para evitar que o mesmo trabalho seja iniciado acidentalmente mais de uma vez. Para obter mais informações, consulte[Chamando operações assíncronas do Amazon Textract](https://docs.aws.amazon.com/textract/latest/dg/api-async.html). Type: String Restrições de comprimento: Tamanho mínimo de 1. Tamanho máximo de 64. Padrão: `^[a-zA-Z0-9-_]+$` Obrigatório: Não ** [DocumentLocation](#API_StartDocumentAnalysis_RequestSyntax) ** A localização do documento a ser processado. Tipo: objeto [DocumentLocation](API_DocumentLocation.md) Obrigatório: Sim ** [FeatureTypes](#API_StartDocumentAnalysis_RequestSyntax) ** Uma lista dos tipos de análise a serem executadas. Adicione TABLES à lista para retornar informações sobre as tabelas detectadas no documento de entrada. Adicione FORMS para retornar dados de formulário detectados. Para executar os dois tipos de análise, adicione TABLES e FORMS ao`FeatureTypes`. Todas as linhas e palavras detectadas no documento estão incluídas na resposta (incluindo texto que não está relacionado ao valor de`FeatureTypes`). Type: Matriz de strings Valores válidos:` TABLES | FORMS` Obrigatório: Sim ** [JobTag](#API_StartDocumentAnalysis_RequestSyntax) ** Um identificador que você especifica que está incluído na notificação de conclusão publicada no tópico do Amazon SNS. Por exemplo, você pode usar`JobTag`para identificar o tipo de documento ao qual a notificação de conclusão corresponde (como um formulário fiscal ou um recibo). Type: String Restrições de comprimento: Tamanho mínimo de 1. Tamanho máximo de 64. Padrão: `[a-zA-Z0-9_.\-:]+` Obrigatório: Não ** [KMSKeyId](#API_StartDocumentAnalysis_RequestSyntax) ** A chave do KMS usada para criptografar os resultados de inferência. Isso pode estar no formato Key ID ou Key Alias. Quando uma chave KMS é fornecida, a chave KMS será usada para criptografia do lado do servidor dos objetos no bucket do cliente. Quando esse parâmetro não estiver habilitado, o resultado será criptografado no lado do servidor, usando o SSE-S3. Type: String Restrições de comprimento: Tamanho mínimo de 1. Tamanho máximo de 2048. Padrão: `^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$` Obrigatório: Não ** [NotificationChannel](#API_StartDocumentAnalysis_RequestSyntax) ** O tópico ARN do Amazon SNS no qual você deseja que o Amazon Textract publique o status de conclusão da operação. Tipo: objeto [NotificationChannel](API_NotificationChannel.md) Obrigatório: Não ** [OutputConfig](#API_StartDocumentAnalysis_RequestSyntax) ** Define se a saída irá para um intervalo definido pelo cliente. Por padrão, o Amazon Textract salvará os resultados internamente para serem acessados pela operação GetDocumentAnalysis. Tipo: objeto [OutputConfig](API_OutputConfig.md) Obrigatório: Não ## Sintaxe da resposta ``` { "JobId": "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. ** [JobId](#API_StartDocumentAnalysis_ResponseSyntax) ** O identificador do trabalho de detecção de texto do documento. Usar o`JobId`para identificar o trabalho em uma chamada subsequente para`GetDocumentAnalysis`. UMA`JobId`O valor só é válido por 7 dias. Type: String Restrições de comprimento: Tamanho mínimo de 1. Tamanho máximo de 64. Padrão: `^[a-zA-Z0-9-_]+$` ## 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, consulte[Limites rígidos no Amazon Textract](limits.md). 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 ** IdempotentParameterMismatchException ** UMA`ClientRequestToken`O parâmetro de entrada foi reutilizado com uma operação, mas pelo menos um dos outros parâmetros de entrada é diferente da chamada anterior para a operação. 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 ** InvalidKMSKeyException ** Indica que você não tem permissões de descriptografia com a chave KMS inserida ou a chave KMS foi inserida incorretamente. Código de status HTTP: 400 ** InvalidParameterException ** Um parâmetro de entrada violou uma restrição. Por exemplo, em operações síncronas, um`InvalidParameterException`exceção ocorre quando nenhum dos`S3Object`ou`Bytes`valores são fornecidos na`Document`Parâ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 não pode acessar o objeto do S3 especificado na solicitação. para obter mais informações,[Configuração de acesso ao Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html)Para obter informações sobre a solução de problemas, consulte[Solução de problemas do Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html) Código de status HTTP: 400 ** LimitExceededException ** Um limite do serviço do Amazon Textract foi excedido. Por exemplo, se você iniciar muitos trabalhos assíncronos simultaneamente, chamadas para iniciar operações (`StartDocumentTextDetection`, por exemplo) gera uma exceção LimitExceededException (código de status HTTP: 400) até que o número de trabalhos simultâneos fique abaixo do limite de serviço do Amazon Textract. 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 é suportado. 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: + [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/textract-2018-06-27/StartDocumentAnalysis) + [AWS SDK for .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/textract-2018-06-27/StartDocumentAnalysis) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/StartDocumentAnalysis) + [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/StartDocumentAnalysis) + [AWSSDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/StartDocumentAnalysis) + [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/textract-2018-06-27/StartDocumentAnalysis) + [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/StartDocumentAnalysis) + [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/StartDocumentAnalysis) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/StartDocumentAnalysis)