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 pekerjaan, unggah dokumen Anda ke Amazon S3, dan kirimkan [StartPiiEntitiesDetectionJob](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_StartPiiEntitiesDetectionJob.html)permintaan.
**Topics**
+ [Sebelum Anda mulai](#detect-pii-before)
+ [Parameter input](#async-pii-api-inputs)
+ [Metode Async Job](#async-pii-api-lifecycle)
+ [Format file keluaran](#async-pii-api-outputs)
+ [Analisis asinkron menggunakan AWS Command Line Interface](#async-pii-api-cli)
## Sebelum Anda mulai
Sebelum Anda mulai, 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 yang diperlukan untuk operasi asinkron](security_iam_id-based-policy-examples.md#auth-role-permissions).
## Parameter input
Dalam permintaan Anda, sertakan parameter yang diperlukan berikut:
+ `InputDataConfig`— Berikan [InputDataConfig](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_InputDataConfig.html)definisi untuk permintaan Anda, yang mencakup properti input untuk pekerjaan itu. Untuk `S3Uri` parameter, tentukan lokasi Amazon S3 dari dokumen input Anda.
+ `OutputDataConfig`— Berikan [OutputDataConfig](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_OutputDataConfig.html)definisi untuk permintaan Anda, yang mencakup properti output untuk pekerjaan tersebut. Untuk `S3Uri` parameter, tentukan lokasi Amazon S3 tempat Amazon Comprehend menulis hasil analisisnya.
+ `DataAccessRoleArn`— Berikan Nama Sumber Daya Amazon (ARN) dari suatu AWS Identity and Access Management peran. Peran ini harus memberikan Amazon Comprehend akses baca ke data input Anda dan akses tulis ke lokasi keluaran Anda di Amazon S3. Untuk informasi selengkapnya, lihat [Role-based izin yang diperlukan untuk operasi asinkron](security_iam_id-based-policy-examples.md#auth-role-permissions).
+ `Mode`— Tetapkan parameter ini ke`ONLY_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`— Tetapkan parameter ini ke `en` atau`es`. Amazon Comprehend mendukung deteksi PII dalam teks bahasa Inggris atau Spanyol.
## Metode Async Job
`StartPiiEntitiesDetectionJob`Mengembalikan ID pekerjaan, sehingga Anda dapat memantau kemajuan pekerjaan dan mengambil status pekerjaan ketika selesai.
Untuk memantau kemajuan pekerjaan analisis, berikan ID pekerjaan untuk [DescribePiiEntitiesDetectionJob](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_DescribePiiEntitiesDetectionJob.html)operasi. Tanggapan dari `DescribePiiEntitiesDetectionJob` berisi `JobStatus` bidang dengan status pekerjaan saat ini. Transisi pekerjaan yang sukses melalui negara-negara berikut:
DIKIRIMKAN -> IN\_PROGRESS -> SELESAI.
Setelah pekerjaan analisis selesai (`JobStatus`SELESAI, GAGAL, atau BERHENTI), gunakan `DescribePiiEntitiesDetectionJob` untuk mendapatkan lokasi hasil. Jika status pekerjaan`COMPLETED`, 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 Comprehend, lihat. [Pemrosesan batch asinkron](concepts-processing-modes.md#how-async)
## 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.
Contoh diformat untuk Unix, Linux, dan macOS. Untuk Windows, ganti karakter kelanjutan backslash (\\) Unix di akhir setiap baris dengan tanda sisipan (^).
```
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 menyediakan path ke file JSON yang berisi data permintaan, seperti yang ditunjukkan pada 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 mirip dengan yang 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](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_DescribeEventsDetectionJob.html)operasi untuk mendapatkan status pekerjaan yang ada. Jika permintaan untuk memulai pekerjaan deteksi peristiwa berhasil, Anda akan menerima respons yang mirip dengan yang berikut ini:
```
aws comprehend describe-pii-entities-detection-job \
--region {{region}} \
--job-id {{job ID}}
```
Ketika pekerjaan selesai dengan sukses, Anda menerima tanggapan yang mirip dengan yang berikut:
```
{
"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)
}
}
```