Menggunakan APIs untuk analitik

Bagian ini menjelaskan operasi API yang Anda gunakan untuk mengambil analitik untuk bot.

catatan

Untuk menggunakan ListUtteranceMetricsdan ListUtteranceAnalyticsData, peran IAM Anda harus memiliki izin untuk melakukan ListAggregatedUtterancesoperasi, yang menyediakan akses ke analitik terkait ucapan. Lihat Melihat statistik ucapan dari percakapan Lex V2 untuk detail dan kebijakan IAM untuk diterapkan pada peran IAM.

• Operasi API berikut mengambil metrik ringkasan untuk bot:

  • ListSessionMetrics

  • ListIntentMetrics

  • ListIntentStageMetrics

  • ListUtteranceMetrics

• Operasi API berikut mengambil daftar metadata untuk sesi dan ucapan:

  • ListSessionAnalyticsData

  • ListUtteranceAnalyticsData

• ListIntentPathsOperasi mengambil metrik tentang urutan maksud yang diambil pelanggan dalam percakapan dengan bot.

Hasil penyaringan

Permintaan API Analytics mengharuskan Anda untuk menentukan startTime danendTime. API menampilkan sesi, intent, tahapan maksud, atau ucapan yang dimulai setelah startTime dan berakhir sebelum. endTime

filtersadalah bidang opsional dalam permintaan API Analytics. Ini memetakan ke daftar AnalyticsSessionFilter, AnalyticsIntentFilter, AnalyticsIntentStageFilter, atau AnalyticsUtteranceFilterobjek. Di setiap objek, gunakan bidang untuk membuat ekspresi untuk memfilter menurut. Misalnya, jika Anda menambahkan filter berikut ke daftar, bot akan mencari percakapan yang lebih dari 30 detik.

{
    "name": "Duration",
    "operator": "GT",
    "value": "30 sec",
}

Mengambil metrik untuk bot

GunakanListSessionMetrics, ListIntentMetricsListIntentStageMetrics, dan ListUtteranceMetrics operasi untuk mengambil metrik ringkasan untuk sesi, maksud, tahapan maksud, dan ucapan.

Untuk operasi ini, isi kolom wajib berikut:

• Berikan startTime dan endTime untuk menentukan rentang waktu yang ingin Anda ambil hasilnya.

• Tentukan metrik yang ingin Anda hitungmetrics, daftar AnalyticsSessionMetric,, AnalyticsIntentMetricAnalyticsIntentStageMetric, atau AnalyticsUtteranceMetricobjek. Di setiap objek, gunakan name bidang untuk menentukan metrik untuk menghitung statistic bidang untuk menentukan apakah akan menghitungSum,Average, atau Max angka, dan order bidang untuk menentukan apakah akan mengurutkan hasil dalam Ascending atau Descending urutan.

  catatan

  Kedua objek metrics dan binBy objek mengandung order bidang. Anda dapat menentukan penyortiran hanya order dalam satu dari dua objek.

Bidang yang tersisa dalam permintaan adalah opsional. Anda dapat memfilter dan mengatur hasil dengan cara berikut:

• Hasil penyaringan — Gunakan filters bidang untuk memfilter hasil. Lihat Hasil penyaringan untuk detail selengkapnya.

• Mengelompokkan hasil berdasarkan kategori - Tentukan groupBy bidang, daftar yang berisi satu AnalyticsSessionResult,, AnalyticsIntentResultAnalyticsIntentStageResult, atau AnalyticsUtteranceResultobjek. Di objek, tentukan name bidang dengan kategori yang ingin Anda kelompokkan hasilnya.

  Jika Anda menentukan groupBy bidang dalam permintaan, results objek dalam respons berisigroupByKeys, daftar AnalyticsSessionGroupByKey,, AnalyticsIntentGroupByKeyAnalyticsIntentStageGroupByKey, atau AnalyticsUtteranceGroupByKeyobjek, masing-masing dengan name yang Anda tentukan dalam permintaan dan anggota kategori itu di value bidang tersebut.

• Hasil binning berdasarkan waktu - Tentukan binBy bidang, daftar yang berisi satu AnalyticsBinBySpecificationobjek. Dalam objek, tentukan name bidang dengan ConversationStartTime untuk membungkus hasil ketika percakapan dimulai atau UtteranceTimestamp untuk membuang hasil ketika ucapan berlangsung. Tentukan interval waktu yang Anda inginkan untuk memasukkan hasil di interval lapangan, dan apakah akan mengurutkan Ascending atau Descending urutan waktu di order lapangan.

  Jika Anda menentukan binBy bidang dalam permintaan, results objek dalam respons berisibinKeys, daftar AnalyticsBinKeyobjek, masing-masing dengan name yang Anda tentukan dalam permintaan dan interval waktu yang mendefinisikan bin itu di value bidang.

  catatan

  Kedua objek metrics dan binBy objek mengandung order bidang. Anda dapat menentukan penyortiran hanya order dalam satu dari dua objek.

Gunakan bidang berikut untuk menangani tampilan respons:

• Tentukan angka antara 1 dan 1.000 di maxResults bidang untuk membatasi jumlah hasil yang akan dikembalikan dalam satu respons.

• Jika jumlah hasil lebih besar dari jumlah yang Anda tentukan di maxResults bidang, responsnya berisi anextToken. Buat permintaan lagi, tetapi gunakan nilai ini di nextToken bidang untuk mengembalikan kumpulan hasil berikutnya.

Jika Anda menggunakanListUtteranceMetrics, Anda dapat menentukan atribut untuk kembali di attributes bidang. Bidang ini memetakan ke daftar yang berisi satu AnalyticsUtteranceAttributeobjek. Tentukan LastUsedIntent di name bidang untuk mengembalikan maksud yang digunakan Amazon Lex V2 pada saat ucapan.

Sebagai tanggapan, results bidang memetakan ke daftar AnalyticsSessionResult,, AnalyticsIntentResultAnalyticsIntentStageResult, atau AnalyticsUtteranceResultobjek. Setiap objek berisi metrics bidang yang mengembalikan nilai statistik ringkasan untuk metrik yang Anda minta, selain bin atau grup apa pun yang dibuat dari metode yang Anda tentukan.

Mengambil metadata untuk sesi dan ucapan dalam bot

Gunakan ListSessionAnalyticsDatadan ListUtteranceAnalyticsDataoperasi untuk mengambil metadata tentang sesi dan ucapan individu.

Isi endTime kolom wajib startTime dan untuk menentukan rentang waktu yang ingin Anda ambil hasilnya.

Bidang yang tersisa dalam permintaan adalah opsional. Untuk memfilter dan mengurutkan hasil:

• Hasil penyaringan — Gunakan filters bidang untuk memfilter hasil. Lihat Hasil penyaringan untuk detail selengkapnya.

• Mengurutkan hasil — Urutkan hasil dengan sortBy bidang, yang berisi UtteranceDataSortByobjek SessionDataSortByatau. Tentukan nilai yang ingin Anda urutkan berdasarkan di name bidang dan apakah akan mengurutkan Ascending atau Descending mengurutkan di order bidang.

Gunakan bidang berikut untuk menangani tampilan respons:

• Tentukan angka antara 1 dan 1.000 di maxResults bidang untuk membatasi jumlah hasil yang akan dikembalikan dalam satu respons.

• Jika jumlah hasil lebih besar dari jumlah yang Anda tentukan di maxResults bidang, responsnya berisi anextToken. Buat permintaan lagi, tetapi gunakan nilai ini di nextToken bidang untuk mengembalikan kumpulan hasil berikutnya.

Sebagai tanggapan, sessions atau utterances bidang memetakan ke daftar SessionSpecificationatau UtteranceSpecificationobjek. Setiap objek berisi metadata untuk satu sesi atau ucapan.

Mengambil metadata untuk sesi dan ucapan dalam bot

Gunakan ListIntentPathsoperasi untuk mengambil metrik tentang urutan maksud yang diambil pelanggan dalam percakapan dengan bot.

Untuk operasi ini, isi kolom wajib berikut:

• Berikan startTime dan endTime untuk menentukan rentang waktu yang ingin Anda ambil hasilnya.

• Berikan intentPath untuk menentukan urutan maksud yang ingin Anda ambil metriknya. Pisahkan maksud di jalan dengan garis miring ke depan. Misalnya, isi intentPath bidang dengan /BookCar/BookHotel untuk melihat detail tentang berapa kali pengguna memanggil BookCar dan BookHotel maksud dalam urutan itu.

Gunakan filters bidang opsional untuk memfilter hasil. Untuk detail selengkapnya, lihat Hasil penyaringan.

Melihat statistik ucapan dari percakapan Lex V2

Anda dapat menggunakan statistik ucapan untuk menentukan ucapan yang dikirim pengguna ke bot Anda. Anda dapat melihat kedua ucapan yang berhasil dideteksi Amazon Lex V2 dan ucapan yang tidak. Anda dapat menggunakan informasi ini untuk membantu menyetel bot Anda.

Misalnya, jika Anda menemukan bahwa pengguna Anda mengirim ucapan bahwa Amazon Lex V2 tidak ada, Anda dapat menambahkan ucapan ke intent. Versi Draft dari intent diperbarui dengan ucapan baru dan Anda dapat mengujinya sebelum menerapkannya ke bot Anda.

Ucapan terdeteksi saat Amazon Lex V2 mengenali ucapan tersebut sebagai upaya untuk memanggil maksud yang dikonfigurasi untuk bot. Ucapan terlewatkan ketika Amazon Lex V2 tidak mengenali ucapannya dan memanggilnya. AMAZON.FallbackIntent

Statistik ucapan dapat dilihat menggunakan ListUtteranceMetrics API dan API. ListAggregatedUtterance

Statistik ucapan tidak dibuat menggunakan ListUtteranceMetrics API dalam kondisi berikut:

• Pengaturan Undang-Undang Perlindungan Privasi Online Anak disetel ke Ya saat bot dibuat dengan konsol, atau childDirected bidang disetel ke true saat bot dibuat dengan CreateBot operasi.

ListUtteranceMetricsAPI menyediakan fitur tambahan termasuk:

• Informasi lebih lanjut tersedia, seperti maksud yang dipetakan untuk ucapan yang terdeteksi.

• Lebih banyak kemampuan penyaringan (termasuk saluran dan mode).

• Rentang tanggal retensi yang lebih lama (30 hari).

• Anda dapat menggunakan API bahkan jika Anda telah memilih keluar dari penyimpanan data. Fungsionalitas konsol untuk ucapan yang terlewat dan terdeteksi akan bergantung pada ListUtteranceMetrics API.

Statistik ucapan tidak dibuat menggunakan ListAggregatedUtterance API dalam kondisi berikut:

• Pengaturan Undang-Undang Perlindungan Privasi Online Anak disetel ke Ya saat bot dibuat dengan konsol, atau childDirected bidang disetel ke true saat bot dibuat dengan CreateBot operasi.

• Anda menggunakan slot obfuscation dengan satu atau lebih slot.

• Anda memilih untuk tidak berpartisipasi dalam meningkatkan Amazon Lex.

ListAggregatedUtteranceAPI menyediakan fitur termasuk:

• Informasi yang kurang rinci tersedia (tidak ada maksud yang dipetakan untuk ucapan).

• Kemampuan penyaringan terbatas (tidak termasuk saluran dan mode).

• Rentang tanggal retensi pendek (15 hari).

Dengan menggunakan statistik ucapan, Anda dapat melihat apakah ucapan tertentu terdeteksi atau terlewatkan, di samping terakhir kali ucapan tersebut digunakan dalam interaksi bot.

Amazon Lex V2 menyimpan ucapan terus menerus saat pengguna berinteraksi dengan bot Anda. Anda dapat menanyakan statistik menggunakan konsol atau ListAggregatedUtterances operasi. Ini memiliki retensi data 15 hari dan tidak tersedia jika pengguna telah memilih keluar dari penyimpanan data. Anda dapat menghapus ucapan menggunakan DeleteUtterances operasi atau dengan memilih keluar dari penyimpanan data. Semua ucapan dihapus jika Anda menutup akun Anda. AWS Ucapan yang disimpan dienkripsi dengan kunci yang dikelola server.

Saat Anda menghapus versi bot, statistik ucapan tersedia untuk versi hingga 30 hari denganListUtteranceMetrics, dan 15 hari penggunaan. ListAggregatedUtterances Anda tidak dapat melihat statistik untuk versi yang dihapus di konsol Amazon Lex V2. Untuk melihat statistik untuk versi yang dihapus, Anda dapat menggunakan keduanya ListAggregatedUtterances dan ListUtteranceMetrics operasi.

Dengan kedua ListAggregatedUtterances dan ListUtteranceMetrics APIs, ucapan dikumpulkan oleh teks ucapan. Misalnya, semua contoh di mana pelanggan menggunakan frasa “Saya ingin memesan pizza” digabungkan ke dalam baris yang sama sebagai tanggapan. Saat Anda menggunakan RecognizeUtteranceoperasi, teks yang digunakan adalah transkrip input.

Untuk menggunakan ListAggregatedUtterances dan ListUtteranceMetrics APIs, terapkan kebijakan berikut ke peran.

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Sid": "ListAggregatedUtterancesPolicy",
            "Effect": "Allow",
            "Action": "lex:ListAggregatedUtterances",
            "Resource": "*"
        }
    ]
}