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á.
# Localizar entidades de PII com tarefas assíncronas (API)
Execute uma tarefa em lotes assíncronos para localizar PII em uma coleção de documentos. Para executar o trabalho, faça o upload de seus documentos para o Amazon S3 e envie uma [StartPiiEntitiesDetectionJob](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_StartPiiEntitiesDetectionJob.html)solicitação.
**Topics**
+ [Antes de começar](#detect-pii-before)
+ [Parâmetros de entrada](#async-pii-api-inputs)
+ [Métodos de tarefas assíncronos](#async-pii-api-lifecycle)
+ [Formato do arquivo de saída](#async-pii-api-outputs)
+ [Análise assíncrona usando o AWS Command Line Interface](#async-pii-api-cli)
## Antes de começar
Antes de começar, garanta que você tenha:
+ **Buckets de entrada e saída**: identifique os buckets do Amazon S3 que você deseja usar para entrada e saída. O buckets devem estar na mesma região que o API que você está chamando.
+ **Perfil de serviço do IAM**: você deve ter um perfil de serviço do IAM com permissão para acessar seus buckets de entrada e saída. Para obter mais informações, consulte [Role-based permissões necessárias para operações assíncronas](security_iam_id-based-policy-examples.md#auth-role-permissions).
## Parâmetros de entrada
Em sua solicitação, inclua os seguintes parâmetros necessários:
+ `InputDataConfig`— forneça uma [InputDataConfig](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_InputDataConfig.html)definição para sua solicitação, que inclua as propriedades de entrada para o trabalho. Para o parâmetro `S3Uri`, especifique a localização dos documentos de entrada no Amazon S3.
+ `OutputDataConfig`— forneça uma [OutputDataConfig](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_OutputDataConfig.html)definição para sua solicitação, que inclua as propriedades de saída do trabalho. Para o parâmetro `S3Uri`, especifique a localização do Amazon S3 em que o Amazon Comprehend grava os resultados de sua análise.
+ `DataAccessRoleArn`— Forneça o Amazon Resource Name (ARN) de uma AWS Identity and Access Management função. Esse perfil deve conceder ao Amazon Comprehend acesso de leitura aos seus dados de entrada e acesso de gravação ao seu local de saída no Amazon S3. Para obter mais informações, consulte [Role-based permissões necessárias para operações assíncronas](security_iam_id-based-policy-examples.md#auth-role-permissions).
+ `Mode`: defina este parâmetro como `ONLY_OFFSETS`. Com essa configuração, a saída fornece os offsets de caracteres que localizam cada entidade de PII no texto de entrada. O resultado também inclui pontuações de confiança e tipos de entidades de PII.
+ `LanguageCode`— Defina esse parâmetro como `en` ou`es`. O Amazon Comprehend oferece suporte à detecção de PII em texto em inglês ou espanhol.
## Métodos de tarefas assíncronos
O `StartPiiEntitiesDetectionJob` retorna um ID da tarefa para que você possa monitorar seu andamento e recuperar seu status quando ele for concluído.
Para monitorar o progresso de um trabalho de análise, forneça o ID do trabalho para a [DescribePiiEntitiesDetectionJob](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_DescribePiiEntitiesDetectionJob.html)operação. A resposta de `DescribePiiEntitiesDetectionJob` contém o campo `JobStatus` com o status atual da tarefa. Uma tarefa bem-sucedida passa pelos seguintes estados:
SUBMITTED -> IN\_PROGRESS -> COMPLETED.
Depois que uma tarefa de análise for concluída (`JobStatus` para COMPLETED, FAILED, ou STOPPED), use `DescribePiiEntitiesDetectionJob` para obter a localização dos resultados. Se o status da tarefa for `COMPLETED`, a resposta incluirá um campo `OutputDataConfig` contendo um outro campo com a localização do arquivo de saída no Amazon S3.
Para obter detalhes adicionais sobre as etapas a serem seguidas para a análise assíncrona do Amazon Comprehend, consulte [Processamento em lote assíncrono](concepts-processing-modes.md#how-async).
## Formato do arquivo de saída
O arquivo de saída usa o nome do arquivo de entrada, com .out anexo no final. Ele contém os resultados da análise.
Veja a seguir um exemplo de arquivo de saída de uma tarefa de análise que detectou entidades de PII em documentos. O formato da entrada é um documento por linha.
```
{
"Entities": [
{
"Type": "NAME",
"BeginOffset": 40,
"EndOffset": 69,
"Score": 0.999995
},
{
"Type": "ADDRESS",
"BeginOffset": 247,
"EndOffset": 253,
"Score": 0.998828
},
{
"Type": "BANK_ACCOUNT_NUMBER",
"BeginOffset": 406,
"EndOffset": 411,
"Score": 0.693283
}
],
"File": "doc.txt",
"Line": 0
},
{
"Entities": [
{
"Type": "SSN",
"BeginOffset": 1114,
"EndOffset": 1124,
"Score": 0.999999
},
{
"Type": "EMAIL",
"BeginOffset": 3742,
"EndOffset": 3775,
"Score": 0.999993
},
{
"Type": "PIN",
"BeginOffset": 4098,
"EndOffset": 4102,
"Score": 0.999995
}
],
"File": "doc.txt",
"Line": 1
}
```
Veja a seguir um exemplo de saída de uma análise em que o formato da entrada é um documento por arquivo.
```
{
"Entities": [
{
"Type": "NAME",
"BeginOffset": 40,
"EndOffset": 69,
"Score": 0.999995
},
{
"Type": "ADDRESS",
"BeginOffset": 247,
"EndOffset": 253,
"Score": 0.998828
},
{
"Type": "BANK_ROUTING",
"BeginOffset": 279,
"EndOffset": 289,
"Score": 0.999999
}
],
"File": "doc.txt"
}
```
## Análise assíncrona usando o AWS Command Line Interface
O exemplo a seguir usa a operação `StartPiiEntitiesDetectionJob` com o AWS CLI.
O exemplo é formatado para Unix, Linux e macOS. Para Windows, substitua o caractere de continuação Unix de barra invertida (\\) no final de cada linha por um circunflexo (^).
```
aws comprehend start-pii-entities-detection-job \
--region {{region}} \
--job-name {{job name}} \
--cli-input-json file://{{path to JSON input file}}
```
Para o parâmetro `cli-input-json`, você fornece um caminho para um arquivo JSON que contém os dados da solicitação, conforme exibido no exemplo a seguir.
```
{
"InputDataConfig": {
"S3Uri": "s3://{{input bucket}}/{{input path}}",
"InputFormat": "ONE_DOC_PER_LINE"
},
"OutputDataConfig": {
"S3Uri": "s3://{{output bucket}}/{{output path}}"
},
"DataAccessRoleArn": "arn:aws:iam::{{account ID}}:role/{{data access role}}"
"LanguageCode": "en",
"Mode": "ONLY_OFFSETS"
}
```
Você receberá uma resposta parecida com a seguinte se a solicitação para iniciar a tarefa de detecção de eventos for bem-sucedida:
```
{
"JobId": "5d2fbe6e...e2c"
"JobArn": "arn:aws:comprehend:us-west-2:123456789012:pii-entities-detection-job/5d2fbe6e...e2c"
"JobStatus": "SUBMITTED",
}
```
Você pode usar a [DescribeEventsDetectionJob](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_DescribeEventsDetectionJob.html)operação para obter o status de um trabalho existente. Você receberá uma resposta parecida com a seguinte se a solicitação para iniciar a tarefa de detecção de eventos for bem-sucedida:
```
aws comprehend describe-pii-entities-detection-job \
--region {{region}} \
--job-id {{job ID}}
```
Quando a tarefa for concluída com êxito, você receberá uma resposta semelhante a seguinte:
```
{
"PiiEntitiesDetectionJobProperties": {
"JobId": "5d2fbe6e...e2c"
"JobArn": "arn:aws:comprehend:us-west-2:123456789012:pii-entities-detection-job/5d2fbe6e...e2c"
"JobName": "piiCLItest3",
"JobStatus": "COMPLETED",
"SubmitTime": "2022-05-05T14:54:06.169000-07:00",
"EndTime": "2022-05-05T15:00:17.007000-07:00",
"InputDataConfig": {
(identical to the input data that you provided with the request)
}
}
```