StartCallAnalyticsJob - Transcribe
Sintaksis PermintaanParameter PermintaanSintaksis ResponsElemen ResponsKesalahanLihat Juga

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

StartCallAnalyticsJob

Mentranskripsikan audio dari panggilan layanan pelanggan dan menerapkan Parameter Permintaan tambahan yang Anda pilih untuk disertakan dalam permintaan Anda.

Selain banyak fitur transkripsi standar, Call Analytics memberi Anda karakteristik panggilan, ringkasan panggilan, sentimen speaker, dan redaksi opsional transkrip teks dan file audio Anda. Anda juga dapat menerapkan kategori khusus untuk menandai kondisi yang ditentukan. Untuk mempelajari lebih lanjut tentang fitur dan wawasan ini, lihat Menganalisis audio call center dengan Call Analytics.

Jika Anda ingin menerapkan kategori ke pekerjaan Call Analytics, Anda harus membuatnya sebelum mengirimkan permintaan pekerjaan Anda. Kategori tidak dapat diterapkan secara surut pada suatu pekerjaan. Untuk membuat kategori baru, gunakanCreateCallAnalyticsCategory operasi. Untuk mempelajari lebih lanjut tentang kategori Analytics Panggilan, lihat Membuat kategori untuk transkripsi pasca-panggilan dan Membuat kategori untuk transkripsi real-time.

Untuk membuatStartCallAnalyticsJob permintaan, Anda harus terlebih dahulu mengunggah file media Anda ke bucket Amazon S3; Anda kemudian dapat menentukan lokasi Amazon S3 file menggunakanMedia parameter.

Anda harus menyertakan parameter berikut dalamStartCallAnalyticsJob permintaan Anda:

  • region: DiWilayah AWS mana Anda membuat permintaan Anda. Untuk daftar yangWilayah AWS didukung dengan Amazon Transcribe, lihat titik akhir dan kuota Amazon Transcribe.

  • CallAnalyticsJobName: Nama kustom yang Anda buat untuk pekerjaan transkripsi Anda yang unik dalam diri AndaAkun AWS.

  • DataAccessRoleArn: Amazon S3 yang berisi file masukan Anda.

  • Media(MediaFileUriatauRedactedMediaFileUri): Lokasi Amazon S3 file media Anda.

catatan

Dengan Call Analytics, Anda dapat menyunting audio yang terdapat dalam file media Anda dengan menyertakanRedactedMediaFileUriMediaFileUri, sebagai gantinya, untuk menentukan lokasi audio input Anda. Jika Anda memilih untuk menyunting audio, Anda dapat menemukan media yang telah diedit di lokasi yang ditentukan diRedactedMediaFileUri bidang respons Anda.

Sintaksis Permintaan

{
   "CallAnalyticsJobName": "string",
   "ChannelDefinitions": [ 
      { 
         "ChannelId": number,
         "ParticipantRole": "string"
      }
   ],
   "DataAccessRoleArn": "string",
   "Media": { 
      "MediaFileUri": "string",
      "RedactedMediaFileUri": "string"
   },
   "OutputEncryptionKMSKeyId": "string",
   "OutputLocation": "string",
   "Settings": { 
      "ContentRedaction": { 
         "PiiEntityTypes": [ "string" ],
         "RedactionOutput": "string",
         "RedactionType": "string"
      },
      "LanguageIdSettings": { 
         "string" : { 
            "LanguageModelName": "string",
            "VocabularyFilterName": "string",
            "VocabularyName": "string"
         }
      },
      "LanguageModelName": "string",
      "LanguageOptions": [ "string" ],
      "VocabularyFilterMethod": "string",
      "VocabularyFilterName": "string",
      "VocabularyName": "string"
   }
}

Parameter Permintaan

Untuk informasi tentang parameter yang umum untuk semua tindakan, lihat Parameter Umum.

Permintaan menerima data berikut dalam format JSON.

CallAnalyticsJobName

Nama unik, yang dipilih oleh Anda, untuk pekerjaan Call Analytics Anda.

Nama ini peka huruf besar, tidak dapat berisi spasi, dan harus unik dalam sebuahAkun AWS. Jika Anda mencoba membuat pekerjaan baru dengan nama yang sama dengan pekerjaan yang ada, Anda mendapatkanConflictException kesalahan.

Jenis: String

Panjang Batasan: Panjang minimum 1. Panjang maksimum 200.

Pola: ^[0-9a-zA-Z._-]+

Diperlukan: Ya

ChannelDefinitions

Memungkinkan untuk menentukan speaker mana yang ada di saluran mana. Misalnya, jika agen Anda adalah peserta pertama yang berbicara, Anda akan mengaturChannelId ke0 (untuk menunjukkan saluran pertama) danAGENT (ParticipantRoleuntuk menunjukkan bahwa itu adalah agen yang berbicara).

Tipe: Array objek ChannelDefinition

Anggota Array: Jumlah tetap 2 item.

Wajib: Tidak

DataAccessRoleArn

Amazon S3 yang berisi file masukan Anda. Jika peran yang Anda tentukan tidak memiliki izin yang sesuai untuk mengakses lokasi Amazon S3 yang ditentukan, permintaan Anda gagal.

ARN peran IAM memiliki formatarn:partition:iam::account:role/role-name-with-path. Misalnya: arn:aws:iam::111122223333:role/Admin.

Untuk informasi selengkapnya, lihat IAM ARN.

Jenis: String

Batasan Panjang: Panjang minimum 20. Panjang maksimum 2048.

Pola: ^arn:(aws|aws-cn|aws-us-gov|aws-iso-{0,1}[a-z]{0,1}):iam::[0-9]{0,63}:role/[A-Za-z0-9:_/+=,@.-]{0,1024}$

Wajib: Tidak

Media

Menjelaskan lokasi Amazon S3 dari file media yang ingin Anda gunakan dalam permintaan Call Analytics Anda.

Tipe: Objek Media

Wajib: Ya

OutputEncryptionKMSKeyId

Kunci KMS yang ingin Anda gunakan untuk mengenkripsi output Call Analytics.

Jika menggunakan kunci yang terletak di saat iniAkun AWS, Anda dapat menentukan kunci KMS Anda dengan salah satu dari empat cara:

  1. Gunakan ID kunci KMS itu sendiri. Sebagai contoh, 1234abcd-12ab-34cd-56ef-1234567890ab.

  2. Gunakan alias untuk ID kunci KMS. Sebagai contoh, alias/ExampleAlias.

  3. Gunakan Amazon Resource Name (ARN) untuk ID kunci KMS. Sebagai contoh, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.

  4. Gunakan ARN untuk alias kunci KMS. Sebagai contoh, arn:aws:kms:region:account-ID:alias/ExampleAlias.

Jika menggunakan kunci yang terletak di berbedaAkun AWS dari saat iniAkun AWS, Anda dapat menentukan kunci KMS Anda dalam salah satu dari dua cara:

  1. Gunakan ARN untuk ID kunci KMS. Sebagai contoh, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.

  2. Gunakan ARN untuk alias kunci KMS. Sebagai contoh, arn:aws:kms:region:account-ID:alias/ExampleAlias.

Jika Anda tidak menentukan kunci enkripsi, output Anda akan dienkripsi dengan kunci Amazon S3 (SSE-S3).

Jika Anda menentukan kunci KMS untuk mengenkripsi output Anda, Anda juga harus menentukan lokasi keluaran menggunakanOutputLocation parameter.

Perhatikan bahwa peran yang membuatStartCallAnalyticsJob permintaan harus memiliki izin untuk menggunakan kunci KMS yang ditentukan.

Jenis: String

Batasan Panjang: Panjang minimum 1. Panjang maksimum 2048.

Pola: ^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$

Wajib: Tidak

OutputLocation

Lokasi Amazon S3 di mana Anda ingin keluaran transkripsi Call Analytics tersimpan. Anda dapat menggunakan salah satu format berikut untuk menentukan lokasi keluaran:

  1. s3://DOC-EXAMPLE-BUCKET

  2. s3://DOC-EXAMPLE-BUCKET/my-output-folder/

  3. s3://DOC-EXAMPLE-BUCKET/my-output-folder/my-call-analytics-job.json

Kecuali Anda menentukan nama file (opsi 3), nama file keluaran Anda memiliki nilai default yang cocok dengan nama yang Anda tentukan untuk pekerjaan transkripsi Anda menggunakanCallAnalyticsJobName parameter.

Anda dapat menentukan kunci KMS untuk mengenkripsi output Anda menggunakanOutputEncryptionKMSKeyId parameter. Jika Anda tidak menentukan kunci KMS, Amazon Transcribe menggunakan kunci Amazon S3 untuk enkripsi sisi server.

Jika Anda tidak menentukanOutputLocation, transkrip Anda ditempatkan di bucket Amazon S3 yang dikelola layanan dan Anda diberikan URI untuk mengakses transkrip Anda.

Jenis: String

Batasan Panjang: Panjang minimum 1. Panjang maksimum 2000.

Pola: (s3://|http(s*)://).+

Wajib: Tidak

Settings

Tentukan pengaturan opsional tambahan dalamStartCallAnalyticsJob permintaan Anda, termasuk redaksi konten; memungkinkan Anda menerapkan model bahasa kustom, filter kosakata, dan kosakata khusus ke pekerjaan Analytics Panggilan Anda.

Tipe: Objek CallAnalyticsJobSettings

Wajib: Tidak

Sintaksis Respons

{
   "CallAnalyticsJob": { 
      "CallAnalyticsJobName": "string",
      "CallAnalyticsJobStatus": "string",
      "ChannelDefinitions": [ 
         { 
            "ChannelId": number,
            "ParticipantRole": "string"
         }
      ],
      "CompletionTime": number,
      "CreationTime": number,
      "DataAccessRoleArn": "string",
      "FailureReason": "string",
      "IdentifiedLanguageScore": number,
      "LanguageCode": "string",
      "Media": { 
         "MediaFileUri": "string",
         "RedactedMediaFileUri": "string"
      },
      "MediaFormat": "string",
      "MediaSampleRateHertz": number,
      "Settings": { 
         "ContentRedaction": { 
            "PiiEntityTypes": [ "string" ],
            "RedactionOutput": "string",
            "RedactionType": "string"
         },
         "LanguageIdSettings": { 
            "string" : { 
               "LanguageModelName": "string",
               "VocabularyFilterName": "string",
               "VocabularyName": "string"
            }
         },
         "LanguageModelName": "string",
         "LanguageOptions": [ "string" ],
         "VocabularyFilterMethod": "string",
         "VocabularyFilterName": "string",
         "VocabularyName": "string"
      },
      "StartTime": number,
      "Transcript": { 
         "RedactedTranscriptFileUri": "string",
         "TranscriptFileUri": "string"
      }
   }
}

Elemen Respons

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Layanan mengembalikan data berikut dalam format JSON.

CallAnalyticsJob

Memberikan informasi rinci tentang pekerjaan Analytics Panggilan saat ini, termasuk status pekerjaan dan, jika berlaku, alasan kegagalan.

Tipe: Objek CallAnalyticsJob

Kesalahan

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat Kesalahan Umum.

BadRequestException

Permintaan Anda tidak lulus satu atau beberapa tes validasi. Hal ini dapat terjadi ketika entitas yang Anda coba hapus tidak ada atau jika itu dalam keadaan non-terminal (sepertiIN PROGRESS). Lihat kolom pesan pengecualian untuk informasi selengkapnya.

Kode Status HTTP: 400

ConflictException

Sumber daya sudah ada dengan nama ini. Nama sumber daya harus unik dalamAkun AWS.

Kode Status HTTP: 400

InternalFailureException

Ada kesalahan internal. Periksa pesan kesalahan, perbaiki masalah, dan coba lagi permintaan Anda.

Kode Status HTTP: 500

LimitExceededException

Anda telah mengirim terlalu banyak permintaan atau file input Anda terlalu panjang. Tunggu sebelum mencoba ulang permintaan Anda, atau gunakan file yang lebih kecil dan coba lagi permintaan Anda.

Kode Status HTTP: 400

Lihat Juga

Untuk informasi selengkapnya tentang penggunaan API ini di salah satuAWS SDK khusus bahasa, lihat berikut ini: