View a markdown version of this page

Rédaction d'entités PII avec des tâches asynchrones (API) - Amazon Comprehend
Avant de commencerParamètres d’entréeFormat du fichier de sortieRédaction des PII à l'aide du AWS Command Line Interface

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.

Rédaction d'entités PII avec des tâches asynchrones (API)

Pour supprimer les entités PII de votre texte, vous devez lancer un traitement par lots asynchrone. Pour exécuter le travail, chargez vos documents sur Amazon S3 et envoyez une StartPiiEntitiesDetectionJob demande.

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.

Paramètres d’entrée

Dans votre demande, incluez les paramètres obligatoires suivants :

  • InputDataConfig— Fournissez une InputDataConfig 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 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.

  • Mode— Réglez ce paramètre surONLY_REDACTION. Avec ce paramètre, Amazon Comprehend écrit une copie de vos documents d'entrée dans l'emplacement de sortie d'Amazon S3. Dans cette copie, chaque entité PII est supprimée.

  • RedactionConfig— Fournissez une RedactionConfig définition de votre demande, qui inclut les paramètres de configuration pour la rédaction. Spécifiez les types de PII à supprimer et indiquez si chaque entité PII est remplacée par le nom de son type ou par un caractère de votre choix :

    • Spécifiez les types d'entités PII à supprimer dans le PiiEntityTypes tableau. Pour supprimer tous les types d'entités, définissez la valeur du tableau sur["ALL"].

    • Pour remplacer chaque entité PII par son type, définissez le MaskMode paramètre sur. REPLACE_WITH_PII_ENTITY_TYPE Par exemple, avec ce paramètre, l'entité PII « Jane Doe » est remplacée par « [NAME] ».

    • Pour remplacer les caractères de chaque entité PII par un caractère de votre choix, définissez le MaskMode paramètre surMASK, puis définissez le MaskCharacter paramètre sur le caractère de remplacement. Indiquez un seul caractère. Les caractères valides sont ! , #, $, %, &, * et @. Par exemple, avec ce paramètre, l'entité PII « Jane Doe » peut être remplacée par « **** *** »

  • LanguageCode— Réglez ce paramètre sur en oues. Amazon Comprehend prend en charge la détection des informations d'identification personnelle sous forme de texte en anglais ou en espagnol.

Format du fichier de sortie

L'exemple suivant montre les fichiers d'entrée et de sortie d'une tâche d'analyse qui rédige des informations personnelles. Le format de saisie est d'un document par ligne. 

{
Managing Your Accounts Primary Branch Canton John Doe Phone Number 443-573-4800 123 Main StreetBaltimore, MD 21224
Online Banking HowardBank.com  Telephone 1-877-527-2703 Bank 3301 Boston Street, Baltimore, MD 21224

La tâche d'analyse visant à rédiger ce fichier d'entrée produit le fichier de sortie suivant.

{
Managing Your Accounts Primary Branch ****** ******** Phone Number ************ **********************************
Online Banking **************  Telephone ************** Bank ***************************************     
 }

Rédaction des PII à l'aide du AWS Command Line Interface

L'exemple suivant utilise l'StartPiiEntitiesDetectionJobopé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 indiquez le chemin d'accès à un fichier JSON contenant les données de la 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_REDACTION"
    "RedactionConfig": {
        "MaskCharacter": "*",
        "MaskMode": "MASK",
        "PiiEntityTypes": ["ALL"]
    }
}

Si la demande de démarrage de la tâche de détection des événements a abouti, vous recevrez une réponse similaire à la suivante :

{
  "JobId": "7c4fbe6e...e5b"
  "JobArn":  "arn:aws:comprehend:us-west-2:123456789012:pii-entities-detection-job/7c4fbe6e...e5b" 
  "JobStatus": "SUBMITTED",   
}

Vous pouvez utiliser cette DescribeEventsDetectionJob opération pour obtenir le statut d'une tâche existante. 

aws comprehend describe-pii-entities-detection-job \
    --region region \
    --job-id job ID

Lorsque la tâche est terminée avec succès, vous recevez une réponse similaire à la suivante :

{
  "PiiEntitiesDetectionJobProperties": {
     "JobId": "7c4fbe6e...e5b"
     "JobArn":  "arn:aws:comprehend:us-west-2:123456789012:pii-entities-detection-job/7c4fbe6e...e5b" 
     "JobName": "piiCLIredtest1",
     "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)
  }
}