View a markdown version of this page

Individuazione delle entità PII con processi asincroni (API) - Amazon Comprehend
Prima di iniziareParametri di inputMetodi Async JobFormato del file di outputAnalisi asincrona utilizzando il AWS Command Line Interface

Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

Individuazione delle entità PII con processi asincroni (API)

Esegui un processo batch asincrono per individuare le PII in una raccolta di documenti. Per eseguire il processo, carica i tuoi documenti su Amazon S3 e invia una richiesta. StartPiiEntitiesDetectionJob

Prima di iniziare

Prima di iniziare, assicurati di avere:

  • Bucket di input e output: identifica i bucket Amazon S3 da utilizzare per i file di input e di output. I bucket devono trovarsi nella stessa regione dell'API che stai chiamando.

  • Ruolo del servizio IAM: è necessario disporre di un ruolo di servizio IAM con autorizzazione per accedere ai bucket di input e output. Per ulteriori informazioni, consulta Role-based autorizzazioni necessarie per le operazioni asincrone.

Parametri di input

Nella richiesta, includi i seguenti parametri obbligatori:

  • InputDataConfig— Fornisci una InputDataConfig definizione per la tua richiesta, che includa le proprietà di input per il lavoro. Per il S3Uri parametro, specifica la posizione Amazon S3 dei documenti di input.

  • OutputDataConfig— Fornisci una OutputDataConfig definizione per la tua richiesta, che includa le proprietà di output per il lavoro. Per il S3Uri parametro, specifica la posizione Amazon S3 in cui Amazon Comprehend scrive i risultati della sua analisi.

  • DataAccessRoleArn— Fornisci l'Amazon Resource Name (ARN) di un ruolo. AWS Identity and Access Management Questo ruolo deve concedere ad Amazon Comprehend l'accesso in lettura ai dati di input e l'accesso in scrittura alla posizione di output in Amazon S3. Per ulteriori informazioni, consulta Role-based autorizzazioni necessarie per le operazioni asincrone.

  • Mode— Imposta questo parametro su. ONLY_OFFSETS Con questa impostazione, l'output fornisce gli offset di caratteri che localizzano ciascuna entità PII nel testo di input. L'output include anche i punteggi di confidenza e i tipi di entità PII.

  • LanguageCode— Impostare questo parametro su en oes. Amazon Comprehend supporta il rilevamento delle informazioni personali in testo inglese o spagnolo.

Metodi Async Job

StartPiiEntitiesDetectionJobRestituisce un ID del lavoro, in modo da poter monitorare l'avanzamento del lavoro e recuperare lo stato del lavoro una volta completato.

Per monitorare lo stato di avanzamento di un processo di analisi, fornisci l'ID del lavoro all'DescribePiiEntitiesDetectionJoboperazione. Il modulo di risposta DescribePiiEntitiesDetectionJob contiene il JobStatus campo con lo stato corrente del processo. Un lavoro riuscito passa attraverso i seguenti stati:

INVIATO -> IN_PROGRESS -> COMPLETATO.

Al termine di un processo di analisi (JobStatusCOMPLETATO, FALLITO o INTERROTTO), utilizzalo DescribePiiEntitiesDetectionJob per ottenere la posizione dei risultati. Se lo stato del processo èCOMPLETED, la risposta include un OutputDataConfig campo che contiene un campo con la posizione Amazon S3 del file di output.

Per ulteriori dettagli sui passaggi da seguire per l'analisi asincrona di Amazon Comprehend, consulta. Elaborazione asincrona in batch

Formato del file di output

Il file di output utilizza il nome del file di input, con .out aggiunto alla fine. Contiene i risultati dell'analisi.

Di seguito è riportato un esempio di file di output di un processo di analisi che ha rilevato entità PII nei documenti. Il formato dell'input è un documento per riga. 

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

Di seguito è riportato un esempio di output di un'analisi in cui il formato di input è un documento per file.

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

Analisi asincrona utilizzando il AWS Command Line Interface

L'esempio seguente utilizza l'StartPiiEntitiesDetectionJoboperazione con. AWS CLI

L'esempio è formattato per Unix, Linux e macOS. Per Windows, sostituisci il carattere di continuazione UNIX barra rovesciata (\) al termine di ogni riga con un accento circonflesso (^).

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

Per il cli-input-json parametro, fornisci il percorso di un file JSON che contiene i dati della richiesta, come mostrato nell'esempio seguente.

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

Se la richiesta di avvio del processo di rilevamento degli eventi è andata a buon fine, riceverai una risposta simile alla seguente:

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

È possibile utilizzare l'DescribeEventsDetectionJoboperazione per ottenere lo stato di un processo esistente. Se la richiesta di avvio del processo di rilevamento degli eventi è andata a buon fine, riceverai una risposta simile alla seguente:

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

Quando il processo viene completato con successo, riceverai una risposta simile alla seguente:

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