Parameter playbook

Playbook dapat menerima dan memancarkan informasi konteks menggunakan parameter yang ditentukan secara eksplisit. Parameter digunakan untuk menyimpan informasi tentang percakapan seperti pilihan pengguna, hasil tindakan, dan sebagainya. Anda dapat meneruskan nilai parameter ini antara playbook dan alur.

Deklarasi parameter

Anda dapat menentukan parameter input (baca) dan parameter output (tulis).

Parameter memiliki nama, deskripsi, dan salah satu jenis berikut:

• String
• Nomor
• Boolean
• Jenis parameter khusus alat

Anda juga dapat menentukan apakah parameter adalah daftar.

Parameter input (baca)

Untuk setiap playbook, Anda dapat menentukan parameter input, yang juga disebut parameter baca, yang memungkinkan playbook menggunakan nilai yang diteruskan dari alur dan playbook lainnya. Misalnya, playbook dapat menerima nama pilihan pengguna sebagai parameter dan menggunakannya untuk mengucapkan terima kasih kepada pengguna secara pribadi, atau dapat menerima ID pesanan sebagai parameter dan menggunakannya untuk mengambil detail pesanan menggunakan alat.

Parameter input ditentukan per playbook, dan playbook tidak memiliki visibilitas jenis parameter konsol Dialogflow CX lainnya secara default. Saat alur bertransisi ke playbook, parameter halaman dan sesi akan dipropagasi ke playbook jika playbook target memiliki parameter input dengan nama yang sama. Untuk mengomunikasikan informasi dari alur ke playbook selama transisi, tentukan parameter input playbook dengan nama yang sama dengan parameter sesi atau halaman yang ada sebelum transisi.

Catatan: Playbook default tidak menerima parameter input. Playbook default berfungsi sebagai titik entri untuk percakapan pengguna, sehingga tidak dapat menerima parameter input.

Buat contoh untuk mengontrol pengaruh nilai parameter input terhadap tindakan. Misalnya, jika parameter input harus memengaruhi cara agen merujuk ke pengguna, buat contoh yang menentukan nilai untuk parameter, lalu gunakan nilai yang sama dalam tindakan ucapan dalam contoh. Lihat bagian meneruskan parameter untuk mengetahui detailnya.

Parameter output (tulis, tampilkan)

Untuk setiap playbook, Anda dapat menentukan parameter output, yang juga disebut parameter tulis dan parameter tampilkan, yang memungkinkan playbook memancarkan informasi untuk digunakan oleh alur atau playbook lainnya. Misalnya, playbook dapat mengumpulkan nomor pesanan dari pengguna dan memancarkannya melalui parameter output, atau playbook dapat menggunakan alat untuk memesan tiket pesawat dan memancarkan nomor konfirmasi melalui parameter output.

Buat contoh untuk mengontrol cara playbook menentukan nilai untuk setiap parameter output. Misalnya, jika parameter output yang mewakili nomor konfirmasi harus mendapatkan nilainya dari output penggunaan alat, buat contoh yang output penggunaan alatnya cocok dengan nilai parameter output playbook.

Meneruskan parameter

Catatan: Playbook tugas tidak dapat memanggil playbook rutin, sehingga skenario penerusan parameter tersebut tidak dijelaskan di bawah.

Playbook, tidak seperti alur, tidak mendukung penyisipan nilai parameter dengan sintaksis tertentu. Sebagai gantinya, playbook mengandalkan petunjuk dan contoh perintah beberapa kali untuk menentukan cara nilai parameter harus digunakan dan cara nilai harus ditentukan saat menentukan nilai parameter.

Playbook rutin ke alur

Untuk meneruskan parameter dari playbook rutin ke alur:

• Tentukan parameter tulis untuk playbook rutin. Parameter ini akan menjadi parameter sesi.
• Alur dapat menggunakan parameter sesi.
• Sertakan penggunaan parameter dalam petunjuk dan contoh.

Alur ke playbook rutin

Untuk meneruskan parameter dari alur ke playbook rutin:

• Alur menulis parameter sesi.
• Tentukan parameter baca untuk playbook rutin dengan nama yang sama.
• Sertakan penggunaan parameter dalam petunjuk dan contoh.

Playbook tugas ke alur

Untuk meneruskan parameter dari playbook tugas ke alur:

• Di setelan alur, tentukan parameter input dengan nama yang sama.
• Sertakan penggunaan parameter dalam petunjuk dan contoh.

Alur ke playbook tugas

Untuk meneruskan parameter dari alur ke playbook tugas induk:

• Di setelan alur, tentukan parameter tampilkan.
• Sertakan penggunaan parameter dalam petunjuk dan contoh.

Untuk meneruskan parameter dari alur ke playbook tugas turunan:

• Tentukan parameter input tugas yang memiliki nama yang sama dengan parameter sesi dalam alur.
• Sertakan penggunaan parameter dalam petunjuk dan contoh.

Playbook rutin ke playbook tugas

Untuk meneruskan parameter dari playbook rutin ke playbook tugas:

• Tentukan parameter input untuk playbook tugas dengan nama yang sama.
• Sertakan penggunaan parameter dalam petunjuk dan contoh.

Contoh yang melibatkan alat

Pertimbangkan agen yang dirancang untuk penjualan tiket acara dengan playbook tugas berikut:

1. Playbook bernama Ticket ordering yang melakukan pemesanan menggunakan alat bernama Ticket sales API.
   1. Playbook ini menerima parameter input dengan jenis number dan nama event_id.
   2. Alat Ticket sales API mengharapkan permintaan yang menyertakan event_id.
2. Playbook bernama Event selection yang membantu pengguna memilih acara, lalu mengarahkannya ke Ticket ordering dengan parameter event_id untuk membeli tiket.

Dalam contoh ini, untuk memastikan event_id diteruskan dengan andal dari Event selection ke Ticket ordering dan dari Ticket ordering ke Ticket sales API, beberapa contoh diperlukan.

Playbook Ticket ordering harus menyertakan beberapa contoh yang:

• Memiliki parameter input event_id yang ditentukan dengan beberapa nilai realistis, yang berbeda di setiap contoh.
• Menyertakan tindakan penggunaan alat dengan isi permintaan yang menyertakan nilai event_id realistis yang sama seperti yang ditentukan dalam parameter input.

Playbook Event selection harus menyertakan beberapa contoh yang:

• Menyertakan ucapan pengguna saat pengguna memilih acara dengan beberapa event_id realistis, yang berbeda di setiap contoh.
• Menyertakan pemanggilan playbook Ticket ordering yang menetapkan parameter event_id ke event_id realistis yang sama seperti yang ditentukan oleh pilihan pengguna.

Selain menambahkan contoh, coba tambahkan petunjuk khusus ke petunjuk, sasaran, atau detail alat yang menjelaskan cara parameter harus digunakan. Misalnya, playbook Ticket ordering menyertakan petunjuk berikut:

- Use parameter event_id to send a buy_tickets request with ${TOOL: Ticket sales API}

Dengan contoh dan petunjuk yang dijelaskan, playbook Event selection akan menentukan event_id dengan benar berdasarkan pilihan pengguna, dan meneruskannya sebagai parameter input bernama event_id ke Ticket ordering playbook. Kemudian, Ticket ordering meneruskan event_id yang sama di isi permintaan ke Ticket sales API. Playbook bergantung pada contoh dengan nilai parameter yang berbeda untuk membantu menyimpulkan cara parameter harus digunakan.