View a markdown version of this page

Menemukan entitas PII dengan pekerjaan asinkron (API) - Amazon Comprehend
Sebelum Anda mulaiParameter inputMetode pekerjaan asinkronFormat file keluaranAnalisis asinkron menggunakan AWS Command Line Interface

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

Menemukan entitas PII dengan pekerjaan asinkron (API)

Jalankan pekerjaan batch asinkron untuk menemukan PII dalam kumpulan dokumen. Untuk menjalankan tugas, unggah dokumen Anda ke Amazon S3, dan kirimkan StartPiiEntitiesDetectionJob permintaan.

Sebelum Anda mulai

Sebelum memulai, pastikan Anda memiliki:

  • Bucket input dan output —Identifikasi bucket Amazon S3 yang ingin Anda gunakan untuk file input dan file output. Bucket harus berada di Wilayah yang sama dengan API yang Anda panggil.

  • Peran layanan IAM —Anda harus memiliki peran layanan IAM dengan izin untuk mengakses bucket input dan output Anda. Untuk informasi selengkapnya, lihat Role-based izin diperlukan untuk operasi asinkron.

Parameter input

Dalam permintaan Anda, sertakan parameter yang diperlukan berikut:

  • InputDataConfig— Berikan InputDataConfig definisi untuk permintaan Anda, yang mencakup properti input untuk pekerjaan. Untuk S3Uri parameter, tentukan lokasi Amazon S3 dari dokumen input Anda.

  • OutputDataConfig- Berikan OutputDataConfig definisi untuk permintaan Anda, yang mencakup properti keluaran untuk pekerjaan. Untuk S3Uri parameter, tentukan lokasi Amazon S3 tempat Amazon Compredeh menulis hasil analisisnya.

  • DataAccessRoleArn— Berikan Nama Sumber Daya Amazon (ARN) dari suatu AWS Identity and Access Management peran. Peran ini harus memberi Amazon Compredeham akses baca ke data input dan akses tulis ke lokasi keluaran Anda di Amazon S3. Untuk informasi selengkapnya, lihat Role-based izin diperlukan untuk operasi asinkron.

  • Mode— Atur parameter ini keONLY_OFFSETS. Dengan pengaturan ini, output menyediakan offset karakter yang menemukan setiap entitas PII dalam teks input. Outputnya juga mencakup skor kepercayaan dan jenis entitas PII.

  • LanguageCode— Atur parameter ini ke en ataues. Amazon Comprecept mendukung deteksi PII dalam teks bahasa Inggris atau Spanyol.

Metode pekerjaan asinkron

Mengem StartPiiEntitiesDetectionJob balikan ID pekerjaan, sehingga Anda dapat memantau kemajuan pekerjaan dan mengambil status pekerjaan saat selesai.

Untuk memantau kemajuan pekerjaan analisis, berikan ID pekerjaan ke DescribePiiEntitiesDetectionJob operasi. Respons dari DescribePiiEntitiesDetectionJob berisi JobStatus bidang dengan status pekerjaan saat ini. Transisi pekerjaan yang sukses melalui status berikut:

DIKIRIMKAN -> IN_PROGRESS -> SELESAI.

Setelah pekerjaan analisis JobStatus selesai (SELESAI, GAGAL, atau DIHENTIKAN), gunakan DescribePiiEntitiesDetectionJob untuk mendapatkan lokasi hasil. Jika status pekerjaan adalahCOMPLETED, respons menyertakan OutputDataConfig bidang yang berisi bidang dengan lokasi Amazon S3 dari file keluaran.

Untuk detail tambahan tentang langkah-langkah yang harus diikuti untuk analisis asinkron Amazon Comprecept, lihatPemrosesan batch asinkron.

Format file keluaran

File output menggunakan nama file input, dengan.out ditambahkan di akhir. Ini berisi hasil analisis.

Berikut ini adalah contoh file output dari pekerjaan analisis yang mendeteksi entitas PII dalam dokumen. Format input adalah satu dokumen per baris. 

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

Berikut ini adalah contoh output dari analisis di mana format input adalah satu dokumen 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"
}

Analisis asinkron menggunakan AWS Command Line Interface

Contoh berikut menggunakan StartPiiEntitiesDetectionJob operasi dengan AWS CLI.

Contohnya diformat untuk Unix, Linux, dan macOS. Untuk Windows, ganti karakter kelanjutan Unix garis miring (\) di akhir setiap baris dengan tanda centang (^).

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

Untuk cli-input-json parameter Anda memberikan path ke file JSON yang berisi data permintaan, seperti yang ditunjukkan dalam contoh berikut.

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

Jika permintaan untuk memulai pekerjaan deteksi peristiwa berhasil, Anda akan menerima respons yang serupa dengan berikut ini:

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

Anda dapat menggunakan DescribeEventsDetectionJob operasi untuk mendapatkan status pekerjaan yang ada. Jika permintaan untuk memulai pekerjaan deteksi peristiwa berhasil, Anda akan menerima respons yang serupa dengan berikut ini:

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

Ketika pekerjaan selesai dengan sukses, Anda menerima tanggapan yang serupa dengan berikut ini:

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