Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.
# Localisation d'entités PII avec des tâches asynchrones (API)
Exécutez un traitement par lots asynchrone pour localiser les informations personnelles dans un ensemble de documents. Pour exécuter la tâche, téléchargez vos documents sur Amazon S3 et soumettez une [StartPiiEntitiesDetectionJob](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_StartPiiEntitiesDetectionJob.html)demande.
**Topics**
+ [Avant de commencer](#detect-pii-before)
+ [Paramètres d’entrée](#async-pii-api-inputs)
+ [Méthodes Async Job](#async-pii-api-lifecycle)
+ [Format du fichier de sortie](#async-pii-api-outputs)
+ [Analyse asynchrone à l'aide du AWS Command Line Interface](#async-pii-api-cli)
## Avant de commencer
Avant de commencer, assurez-vous que vous disposez des éléments suivants :
+ **Compartiments d'entrée et de sortie** : identifiez les compartiments Amazon S3 que vous souhaitez utiliser pour les fichiers d'entrée et de sortie. Les buckets doivent se trouver dans la même région que l'API que vous appelez.
+ **Rôle de service IAM** : vous devez disposer d'un rôle de service IAM autorisé à accéder à vos compartiments d'entrée et de sortie. Pour de plus amples informations, veuillez consulter [Role-based autorisations requises pour les opérations asynchrones](security_iam_id-based-policy-examples.md#auth-role-permissions).
## Paramètres d’entrée
Dans votre demande, incluez les paramètres obligatoires suivants :
+ `InputDataConfig`— Fournissez une [InputDataConfig](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_InputDataConfig.html)définition pour votre demande, qui inclut les propriétés d'entrée de la tâche. Pour le `S3Uri` paramètre, spécifiez l'emplacement Amazon S3 de vos documents d'entrée.
+ `OutputDataConfig`— Fournissez une [OutputDataConfig](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_OutputDataConfig.html)définition pour votre demande, qui inclut les propriétés de sortie de la tâche. Pour le `S3Uri` paramètre, spécifiez l'emplacement Amazon S3 où Amazon Comprehend écrit les résultats de son analyse.
+ `DataAccessRoleArn`— Fournissez le nom de ressource Amazon (ARN) d'un Gestion des identités et des accès AWS rôle. Ce rôle doit accorder à Amazon Comprehend un accès en lecture à vos données d'entrée et un accès en écriture à votre emplacement de sortie dans Amazon S3. Pour de plus amples informations, veuillez consulter [Role-based autorisations requises pour les opérations asynchrones](security_iam_id-based-policy-examples.md#auth-role-permissions).
+ `Mode`— Définissez ce paramètre sur`ONLY_OFFSETS`. Avec ce paramètre, la sortie fournit les décalages de caractères qui localisent chaque entité PII dans le texte d'entrée. Le résultat inclut également les scores de confiance et les types d'entités PII.
+ `LanguageCode`— Définissez ce paramètre sur `en` ou`es`. Amazon Comprehend prend en charge la détection des informations personnelles dans des textes en anglais ou en espagnol.
## Méthodes Async Job
`StartPiiEntitiesDetectionJob`Renvoie un identifiant de tâche, afin que vous puissiez suivre la progression de la tâche et récupérer le statut de la tâche une fois celle-ci terminée.
Pour suivre la progression d'une tâche d'analyse, fournissez l'ID de tâche à l'[DescribePiiEntitiesDetectionJob](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_DescribePiiEntitiesDetectionJob.html)opération. Le formulaire de réponse `DescribePiiEntitiesDetectionJob` contient le `JobStatus` champ indiquant le statut actuel de la tâche. Un emploi réussi passe par les états suivants :
SOUMIS -> IN\_PROGRESS -> TERMINÉ.
Une fois qu'une tâche d'analyse `JobStatus` est terminée (TERMINÉE, ÉCHOUÉE ou ARRÊTÉE), utilisez-la `DescribePiiEntitiesDetectionJob` pour obtenir l'emplacement des résultats. Si le statut de la tâche est le suivant`COMPLETED`, la réponse inclut un `OutputDataConfig` champ contenant l'emplacement du fichier de sortie sur Amazon S3.
Pour plus de détails sur les étapes à suivre pour l'analyse asynchrone d'Amazon Comprehend, consultez. [Traitement par lots asynchrone](concepts-processing-modes.md#how-async)
## Format du fichier de sortie
Le fichier de sortie utilise le nom du fichier d'entrée, avec .out ajouté à la fin. Il contient les résultats de l'analyse.
Voici un exemple de fichier de sortie issu d'une tâche d'analyse qui a détecté des entités PII dans des documents. Le format de l'entrée est d'un document par ligne.
```
{
"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
}
```
Voici un exemple de sortie d'une analyse où le format de l'entrée est d'un document par fichier.
```
{
"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"
}
```
## Analyse asynchrone à l'aide du AWS Command Line Interface
L'exemple suivant utilise l'`StartPiiEntitiesDetectionJob`opération avec le AWS CLI.
L'exemple est mis en forme pour Unix, Linux et macOS. Pour Windows, remplacez le caractère de continuation Unix, à savoir la barre oblique inversée (\\), à la fin de chaque ligne par un accent circonflexe (^).
```
aws comprehend start-pii-entities-detection-job \
--region {{region}} \
--job-name {{job name}} \
--cli-input-json file://{{path to JSON input file}}
```
Pour le `cli-input-json` paramètre, vous fournissez le chemin d'accès à un fichier JSON contenant les données de demande, comme illustré dans l'exemple suivant.
```
{
"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"
}
```
Si la demande de démarrage de la tâche de détection des événements est réussie, vous recevrez une réponse similaire à la suivante :
```
{
"JobId": "5d2fbe6e...e2c"
"JobArn": "arn:aws:comprehend:us-west-2:123456789012:pii-entities-detection-job/5d2fbe6e...e2c"
"JobStatus": "SUBMITTED",
}
```
Vous pouvez utiliser cette [DescribeEventsDetectionJob](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_DescribeEventsDetectionJob.html)opération pour obtenir le statut d'une tâche existante. Si la demande de démarrage de la tâche de détection des événements est réussie, vous recevrez une réponse similaire à la suivante :
```
aws comprehend describe-pii-entities-detection-job \
--region {{region}} \
--job-id {{job ID}}
```
Lorsque le travail est terminé avec succès, vous recevez une réponse similaire à la suivante :
```
{
"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)
}
}
```