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 von PII-Entitäten mit asynchronen Aufträgen (API)
Führen Sie einen asynchronen Batch-Job aus, um PII in einer Sammlung von Dokumenten zu finden. Um den Job auszuführen, laden Sie Ihre Dokumente auf Amazon S3 hoch und senden Sie eine Anfrage. StartPiiEntitiesDetectionJob
Themen
Bevor Sie beginnen
Bevor Sie beginnen, stellen Sie sicher, dass Sie:
-
Eingabe- und Ausgabe-Buckets — Identifizieren Sie die Amazon S3-Buckets, die Sie für Eingabe- und Ausgabedateien verwenden möchten. Die Buckets müssen sich in derselben Region wie die API befinden, die Sie aufrufen.
-
IAM-Servicerolle — Sie benötigen eine IAM-Servicerolle mit der Berechtigung, auf Ihre Eingabe- und Ausgabe-Buckets zuzugreifen. Weitere Informationen finden Sie unter Role-based Berechtigungen, die für asynchrone Operationen erforderlich sind.
Eingabeparameter
Geben Sie in Ihrer Anfrage die folgenden erforderlichen Parameter an:
-
InputDataConfig— Geben Sie eine InputDataConfig Definition für Ihre Anfrage an, die die Eingabeeigenschaften für den Job enthält. Geben Sie für denS3UriParameter den Amazon S3-Speicherort Ihrer Eingabedokumente an. -
OutputDataConfig— Geben Sie eine OutputDataConfig Definition für Ihre Anfrage an, die die Ausgabeeigenschaften für den Job enthält. Geben Sie für denS3UriParameter den Amazon S3-Speicherort an, an dem Amazon Comprehend die Ergebnisse seiner Analyse schreibt. -
DataAccessRoleArn— Geben Sie den Amazon-Ressourcennamen (ARN) einer Rolle an AWS Identity and Access Management . Diese Rolle muss Amazon Comprehend Lesezugriff auf Ihre Eingabedaten und Schreibzugriff auf Ihren Ausgabeort in Amazon S3 gewähren. Weitere Informationen finden Sie unter Role-based Berechtigungen, die für asynchrone Operationen erforderlich sind. -
Mode— Stellen Sie diesen Parameter auf ein.ONLY_OFFSETSBei dieser Einstellung liefert die Ausgabe die Zeichen-Offsets, mit denen jede PII-Entität im Eingabetext lokalisiert wird. Die Ausgabe umfasst auch Konfidenzwerte und PII-Entitätstypen. -
LanguageCode— Stellen Sie diesen Parameter aufenoderesein. Amazon Comprehend unterstützt die Erkennung personenbezogener Daten in englischem oder spanischem Text.
Async-Job-Methoden
Der StartPiiEntitiesDetectionJob gibt eine Job-ID zurück, sodass Sie den Fortschritt des Auftrags ü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 DescribePiiEntitiesDetectionJob Vorgang an. Das DescribePiiEntitiesDetectionJob Antwortformular enthält das JobStatus Feld mit dem aktuellen Status des Jobs. Ein erfolgreicher Jobübergang durchläuft die folgenden Zustände:
EINGEREICHT -> IN_PROGRESS -> ABGESCHLOSSEN.
Wenn ein Analysejob abgeschlossen JobStatus ist (ABGESCHLOSSEN, FEHLGESCHLAGEN oder GESTOPPT), verwenden Sie diesen Befehl, DescribePiiEntitiesDetectionJob um den Speicherort der Ergebnisse abzurufen. Wenn der Auftragsstatus lautetCOMPLETED, enthält die Antwort ein OutputDataConfig Feld, das ein Feld mit dem Amazon S3-Speicherort der Ausgabedatei enthält.
Weitere Informationen zu den Schritten, die für die asynchrone Amazon Comprehend-Analyse zu befolgen sind, finden Sie unter. Asynchrone Stapelverarbeitung
Ausgabedateiformat
Die Ausgabedatei verwendet den Namen der Eingabedatei, wobei am Ende die Erweiterung.out angehängt wird. Sie enthält die Ergebnisse der Analyse.
Im Folgenden finden Sie ein Beispiel für eine Ausgabedatei eines Analyseauftrags, 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 }
Das Folgende ist 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 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 \ --regionregion\ --job-namejob 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 DescribeEventsDetectionJob Vorgang verwenden, um den Status eines vorhandenen Auftrags abzurufen. Wenn die Anforderung, den Job zur Erkennung von Ereignissen zu starten, erfolgreich war, erhalten Sie eine Antwort, die der folgenden ähnelt:
aws comprehend describe-pii-entities-detection-job \ --regionregion\ --job-idjob ID
Wenn der Auftrag 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) } }