Redigieren von PII-Entitäten mit asynchronen Jobs (API)

Um die PII-Entitäten in Ihrem Text zu redigieren, starten Sie einen asynchronen Batch-Job. Um den Job auszuführen, laden Sie Ihre Dokumente auf Amazon S3 hoch und reichen Sie eine StartPiiEntitiesDetectionJobAnfrage ein.

Bevor Sie beginnen

Bevor Sie beginnen, stellen Sie sicher, dass Sie über Folgendes verfügen:

• Eingabe- und Ausgabe-Buckets — Identifizieren Sie die Amazon S3 S3-Buckets, die Sie für Eingabedateien und Ausgabedateien verwenden möchten. Die Buckets müssen sich in derselben Region befinden wie die API, die Sie aufrufen.

• IAM-Servicerolle — Sie benötigen eine IAM-Dienstrolle mit der Berechtigung, auf Ihre Eingabe- und Ausgabe-Buckets zuzugreifen. Weitere Informationen finden Sie unter Rollenbasierte Berechtigungen, die für asynchrone Operationen erforderlich sind.

Eingabeparameter

Geben Sie in Ihrer Anfrage die folgenden erforderlichen Parameter an:

• InputDataConfig— Geben Sie eine InputDataConfigDefinition für Ihre Anfrage an, die die Eingabeeigenschaften für den Job enthält. Geben Sie für den S3Uri Parameter den Amazon S3 S3-Speicherort Ihrer Eingabedokumente an.

• OutputDataConfig— Geben Sie eine OutputDataConfigDefinition für Ihre Anfrage an, die die Ausgabeeigenschaften für den Job enthält. Geben Sie für den S3Uri Parameter den Amazon S3 S3-Speicherort an, an den Amazon Comprehend die Ergebnisse seiner Analyse schreibt.

• DataAccessRoleArn— Geben Sie den Amazon-Ressourcennamen (ARN) einer AWS Identity and Access Management Rolle an. Diese Rolle muss Amazon Comprehend Lesezugriff auf Ihre Eingabedaten und Schreibzugriff auf Ihren Ausgabespeicherort in Amazon S3 gewähren. Weitere Informationen finden Sie unter Rollenbasierte Berechtigungen, die für asynchrone Operationen erforderlich sind.

• Mode— Stellen Sie diesen Parameter auf ein. ONLY_REDACTION Mit dieser Einstellung schreibt Amazon Comprehend eine Kopie Ihrer Eingabedokumente an den Ausgabespeicherort in Amazon S3. In dieser Kopie ist jede PII-Entität redigiert.

• RedactionConfig— Geben Sie eine RedactionConfigDefinition für Ihre Anfrage an, die die Konfigurationsparameter für die Schwärzung enthält. Geben Sie die Arten von personenbezogenen Daten an, die geschwärzt werden sollen, und geben Sie an, ob jede PII-Entität durch den Namen ihres Typs oder ein Zeichen Ihrer Wahl ersetzt wird:

  • Geben Sie die PII-Entitätstypen an, die im Array geschwärzt werden sollen. PiiEntityTypes Um alle Entitätstypen zu schwärzen, setzen Sie den Array-Wert auf. ["ALL"]

  • Um jede PII-Entität durch ihren Typ zu ersetzen, setzen Sie den MaskMode Parameter auf. REPLACE_WITH_PII_ENTITY_TYPE Mit dieser Einstellung wird beispielsweise die PII-Entität „Jane Doe“ durch „[NAME]“ ersetzt.

  • Um die Zeichen in jeder PII-Entität durch ein Zeichen Ihrer Wahl zu ersetzen, setzen Sie den MaskMode Parameter auf MASK und setzen Sie den MaskCharacter Parameter auf das Ersatzzeichen. Geben Sie nur ein einziges Zeichen an. Gültige Zeichen sind! , #, $,%, &, * und @. Mit dieser Einstellung kann beispielsweise die PII-Entität „Jane Doe“ durch „**** ***“ ersetzt werden

• LanguageCode— Setzen Sie diesen Parameter auf en oderes. Amazon Comprehend unterstützt die Erkennung personenbezogener Daten in englischem oder spanischem Text.

Format der Ausgabedatei

Das folgende Beispiel zeigt die Eingabe- und Ausgabedateien eines Analysejobs, bei dem personenbezogene Daten geschwärzt werden. Das Format der Eingabe ist ein Dokument pro Zeile.

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

Der Analyseauftrag zum Schwärzen dieser Eingabedatei erzeugt die folgende Ausgabedatei.

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

PII-Schwärzung mit dem AWS Command Line Interface

Das folgende Beispiel verwendet die StartPiiEntitiesDetectionJob Operation mit dem. AWS CLI

Das Beispiel ist für Unix, Linux und macOS formatiert. Ersetzen Sie unter Windows den umgekehrten Schrägstrich (\), das Unix-Fortsetzungszeichen, am Ende jeder Zeile durch ein Caret-Zeichen oder Zirkumflex (^).

aws comprehend start-pii-entities-detection-job \
    --region region \
    --job-name job name \
    --cli-input-json file://path to JSON input file
    

Für den cli-input-json Parameter geben Sie den Pfad zu einer JSON-Datei an, die die Anforderungsdaten enthält, wie im folgenden Beispiel gezeigt.

{
    "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"]
    }
}

Wenn die Anfrage zum Starten des Auftrags zur Erkennung von Ereignissen erfolgreich war, erhalten Sie eine Antwort, die der folgenden ähnelt:

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

Sie können den DescribeEventsDetectionJobVorgang verwenden, um den Status eines vorhandenen Auftrags abzurufen.

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

Wenn der Job erfolgreich abgeschlossen wurde, erhalten Sie eine Antwort, die der folgenden ähnelt:

{
  "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)
  }
}