Suchen nach PII-Entitäten mit asynchronen Jobs (API) - Amazon Comprehend

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

Suchen nach PII-Entitäten mit asynchronen Jobs (API)

Führen Sie einen asynchronen Batch-Job aus, um personenbezogene Daten in einer Sammlung von Dokumenten zu finden. 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_OFFSETS Mit dieser Einstellung stellt die Ausgabe die Zeichen-Offsets bereit, mit denen jede PII-Entität im Eingabetext lokalisiert wird. Die Ausgabe umfasst auch Konfidenzwerte und PII-Entitätstypen.

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

Async-Job-Methoden

Die StartPiiEntitiesDetectionJob gibt eine Job-ID zurück, sodass Sie den Fortschritt des Jobs überwachen und den Auftragsstatus abrufen können, wenn er abgeschlossen ist.

Um den Fortschritt eines Analyseauftrags zu überwachen, geben Sie die Job-ID für den DescribePiiEntitiesDetectionJobVorgang an. Die Antwort von DescribePiiEntitiesDetectionJob enthält das JobStatus Feld mit dem aktuellen Status des Jobs. Ein erfolgreicher Job durchläuft die folgenden Zustände:

EINGEREICHT -> IN_PROGRESS -> ABGESCHLOSSEN.

Verwenden DescribePiiEntitiesDetectionJob Sie diese Option, um den Speicherort der JobStatus Ergebnisse abzurufen, wenn ein Analysejob abgeschlossen, FEHLGESCHLAGEN oder GESTOPPT ist. Wenn der Auftragsstatus lautetCOMPLETED, enthält die Antwort ein OutputDataConfig Feld, das ein Feld mit dem Amazon S3 S3-Speicherort der Ausgabedatei enthält.

Weitere Informationen zu den Schritten für die asynchrone Amazon Comprehend Comprehend-Analyse finden Sie unter. Asynchrone Batchverarbeitung

Format der Ausgabedatei

Die Ausgabedatei verwendet den Namen der Eingabedatei, wobei am Ende „.out“ angehängt wird. Sie enthält die Ergebnisse der Analyse.

Im Folgenden finden Sie ein Beispiel für eine Ausgabedatei aus einem Analysejob, bei dem PII-Entitäten in Dokumenten erkannt wurden. Das Format der Eingabe ist ein Dokument pro Zeile.

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

Im Folgenden finden Sie ein Beispiel für die Ausgabe einer Analyse, bei der das Eingabeformat ein Dokument pro Datei ist.

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

Asynchrone Analyse mit 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_OFFSETS" }

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

{ "JobId": "5d2fbe6e...e2c" "JobArn": "arn:aws:comprehend:us-west-2:123456789012:pii-entities-detection-job/5d2fbe6e...e2c" "JobStatus": "SUBMITTED", }

Sie können den DescribeEventsDetectionJobVorgang verwenden, um den Status eines vorhandenen Auftrags abzurufen. Wenn die Anfrage zum Starten des Auftrags zur Erkennung von Ereignissen erfolgreich war, erhalten Sie eine Antwort, die der folgenden ähnelt:

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