Praktik terbaik untuk menggunakan endpoint ConversationalAnalytics API di API Looker

Endpoint API ConversationalAnalytics Looker memungkinkan Anda membangun pengalaman Analisis Percakapan kustom dalam aplikasi tersemat. API ini mencerminkan endpoint yang mendukung fitur Analisis Percakapan Looker dan menyediakan fungsi yang sama dalam Looker API. API ini mencakup operasi buat, perbarui, baca, dan hapus (CRUD) untuk agen, percakapan, dan pesan, serta API chat untuk berinteraksi dengan agen percakapan. Untuk memastikan proses pengembangan yang lancar dan performa yang optimal, penting untuk memahami batasan tertentu dan mengikuti praktik terbaik yang direkomendasikan saat menggunakan API ini.

Alur kerja umum

Alur kerja umum untuk percakapan bolak-balik melibatkan penggunaan agen, percakapan, pesan, dan API chat secara bersamaan.

  1. Buat agen: Jika Anda belum memilikinya, buat agen menggunakan POST /agents. Agen dikonfigurasi untuk menggunakan model dan Eksplorasi Looker tertentu.
  2. Buat percakapan: Mulai percakapan baru yang terkait dengan agen menggunakan POST /conversations. Tindakan ini akan menampilkan ID percakapan.
  3. Mengirim pesan: Untuk setiap giliran dalam percakapan, panggil POST /conversational_analytics/chat dengan conversation_id dan pesan pengguna. Endpoint ini menampilkan satu atau beberapa pesan sistem dari agen.
  4. Mempertahankan pesan: Endpoint /conversational_analytics/chat tidak mempertahankan pesan pengguna atau pesan sistem yang ditampilkan. Untuk mempertahankan histori percakapan untuk giliran berikutnya, Anda harus mempertahankan pesan pengguna dan pesan sistem dengan memanggil POST /conversations/:conversation_id/messages setelah memanggil chat API.

Rekomendasi

Ikuti rekomendasi berikut untuk mendapatkan hasil terbaik:

  • Mempertahankan semua pesan: Setelah setiap panggilan ke /conversational_analytics/chat, pastikan untuk memanggil POST /conversations/:conversation_id/messages guna menyimpan pesan pengguna dari giliran tersebut dan semua pesan sistem yang ditampilkan oleh chat API. Hal ini penting untuk percakapan multi-giliran.
  • Menangani Streaming: Jika memungkinkan, gunakan kemampuan streaming chat API untuk memberikan masukan kepada pengguna saat agen sedang memproses. Pesan yang diterima selama streaming dapat digunakan untuk menunjukkan bahwa agen sedang "berpikir".

Batasan dan pertimbangan

Saat menggunakan endpoint API ConversationalAnalytics, pertimbangkan batasan berikut:

  • Persistensi Pesan: Anda bertanggung jawab untuk mempertahankan pesan menggunakan endpoint POST /conversations/:conversation_id/messages. Jika pesan tidak dipertahankan setelah setiap panggilan ke /conversational_analytics/chat, histori percakapan tidak akan dipertahankan, dan agen tidak akan memiliki konteks untuk pertanyaan lanjutan dalam percakapan multi-turn.
  • Dukungan Streaming: Chat API adalah API streaming, yang memungkinkan Anda menerima pesan saat pesan tersebut dibuat oleh agen, sehingga dapat meningkatkan pengalaman pengguna untuk kueri yang berjalan lama. Namun, tidak semua bahasa Looker SDK mendukung streaming. Jika Anda menggunakan SDK yang tidak mendukung streaming, API akan menampilkan respons lengkap secara serentak setelah semua pesan dibuat. Jika streaming sangat penting dan tidak didukung oleh bahasa SDK Anda, Anda mungkin perlu melakukan panggilan HTTP secara langsung untuk menggunakan streaming.