View a markdown version of this page

Menggunakan API untuk analitik - Amazon Lex

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

Menggunakan API untuk analitik

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

catatan

Untuk menggunakan ListUtteranceMetrics dan ListUtteranceAnalyticsData, peran IAM Anda harus memiliki izin untuk melakukan ListAggregatedUtterances operasi, 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.

Memfilter hasil

Permintaan API Analytics mengharuskan Anda untuk menentukan startTime danendTime. API mengembalikan sesi, maksud, 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 AnalyticsUtteranceFilter objek. Di setiap objek, gunakan bidang untuk membuat ekspresi untuk difilter. Misalnya, jika Anda menambahkan filter berikut ke daftar, bot mencari percakapan yang lebih lama 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, tahap an maksud, dan ucap an.

Untuk operasi ini, isi kolom wajib berikut:

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

  • Tentukan metrik yang ingin Anda metrics hitung, daftar AnalyticsSessionMetric, AnalyticsIntentMetric, AnalyticsIntentStageMetric, atau AnalyticsUtteranceMetric objek. 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 binBy objek metrics dan berisi order bidang. Anda dapat menentukan penyortiran hanya order di salah satu dari dua objek.

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

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

  • Pengelompokan hasil berdasarkan kategori — Tentukan groupBy bidang, daftar yang berisi satu AnalyticsSessionResult AnalyticsIntentResult, AnalyticsIntentStageResult,, atau AnalyticsUtteranceResult objek. 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,, AnalyticsIntentGroupByKey AnalyticsIntentStageGroupByKey, atau AnalyticsUtteranceGroupByKey objek, masing-masing dengan name yang Anda tentukan dalam permintaan dan anggota kategori tersebut di value bidang.

  • Hasil binning berdasarkan waktu — Tentukan binBy bidang, daftar yang berisi AnalyticsBinBySpecification objek tunggal. Di objek, tentukan name bidang ConversationStartTime untuk menyimpan hasil berdasarkan kapan percakapan dimulai atau UtteranceTimestamp untuk menyimpan hasil berdasarkan saat ucapan berlangsung. Tentukan interval waktu di mana Anda ingin menyimpan hasil di interval bidang, dan apakah akan mengurutkan Ascending atau Descending urutan waktu di order bidang.

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

    catatan

    Kedua binBy objek metrics dan berisi order bidang. Anda dapat menentukan penyortiran hanya order di salah 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, respons berisi anextToken. Buat permintaan lagi, tetapi gunakan nilai ini di nextToken bidang untuk mengembalikan batch hasil berikutnya.

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

Dalam respon, results bidang dipetakan ke daftar AnalyticsSessionResult, AnalyticsIntentResult, AnalyticsIntentStageResult, atau AnalyticsUtteranceResult objek. Setiap objek berisi metrics bidang yang mengembalikan nilai statistik ringkasan untuk metrik yang Anda minta, selain setiap tempat sampah atau grup yang dibuat dari metode yang Anda tentukan.

Mengambil metadata untuk sesi dan ucapan di bot

Gunakan ListUtteranceAnalyticsData operasi ListSessionAnalyticsData dan untuk mengambil metadata tentang sesi dan ucapan individual.

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

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

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

  • Menyor tir hasil — Urutkan hasil dengan sortBy bidang, yang berisi UtteranceDataSortBy objek SessionDataSortBy atau. Tentukan nilai yang ingin Anda urutkan 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, respons berisi anextToken. Buat permintaan lagi, tetapi gunakan nilai ini di nextToken bidang untuk mengembalikan batch hasil berikutnya.

Dalam tanggapan, utterances bidang sessions atau memetakan ke daftar SessionSpecification atau UtteranceSpecification objek. Setiap objek berisi metadata untuk satu sesi atau ucapan.

Mengambil data analitik jalur maksud

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

Untuk operasi ini, isi kolom wajib berikut:

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

  • Berikan intentPath a untuk menentukan urutan maksud yang ingin Anda ambil metrik. Pisahkan maksud di jalur 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 Memfilter hasil.

Melihat statistik ucapan dari percakapan Lex V2

Anda dapat menggunakan statistik ucapan untuk menentukan ucapan yang dikirim pengguna Anda ke bot Anda. Anda dapat melihat 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 hilang, Anda dapat menambahkan ucapan tersebut ke maksud. Versi Draf maksud diperbarui dengan ucapan baru dan Anda dapat mengujinya sebelum menerapkannya ke bot Anda.

Ucapan terdeteksi ketika Amazon Lex V2 mengenali ucapan sebagai upaya untuk memanggil maksud yang dikonfigurasi untuk bot. Ucapan terlewatkan ketika Amazon Lex V2 tidak mengenali ucapan dan memintanya sebagai gantinya. AMAZON.FallbackIntent

Statistik ucapan dapat dilihat menggunakan ListUtteranceMetrics API dan API. ListAggregatedUtterance

Statistik ucapan tidak dihasilkan menggunakan ListUtteranceMetrics API dalam kondisi berikut:

  • Pengaturan Undang-Undang Perlindungan Priv asi 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 dihasilkan menggunakan ListAggregatedUtterance API dalam kondisi berikut:

  • Pengaturan Undang-Undang Perlindungan Priv asi 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, bersamaan dengan terakhir kali ucapan itu 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 akan dihapus jika Anda menutup akun AWS Anda. Ucapan yang disimpan dienkripsi dengan kunci yang dikelola server.

Saat Anda menghapus versi bot, statistik ucapan tersedia untuk versi tersebut hingga 30 hari denganListUtteranceMetrics, dan 15 hari menggunakan. 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 API ListAggregatedUtterances dan ListUtteranceMetrics API, ucapan digabungkan oleh teks ucapan. Misalnya, semua contoh di mana pelanggan menggunakan frasa “Saya ingin memesan pizza” digabungkan ke dalam baris yang sama dalam tanggapan. Saat Anda menggunakan RecognizeUtterance operasi, teks yang digunakan adalah transkrip input.

Untuk menggunakan ListUtteranceMetrics API ListAggregatedUtterances and, terapkan kebijakan berikut ke peran.

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