Interactive Canvas API adalah library JavaScript yang Anda gunakan untuk berinteraksi
dengan Action Percakapan menggunakan objek interactiveCanvas
di aplikasi web Anda.
Untuk informasi selengkapnya tentang Canvas Interaktif, lihat dokumentasi Canvas Interaktif.
Metode
siap
ready(callbacks) returns undefined
Dipanggil oleh aplikasi web Canvas Interaktif setelah dimuat untuk mendaftarkan callback.
Parameter | |
---|---|
callbacks |
InteractiveCanvasCallbacks
Objek yang berisi callback metode. |
sendTextQuery
sendTextQuery(textQuery) returns Promise<state>
Mengirim kueri teks ke tindakan percakapan.
Parameter | |
---|---|
textQuery |
string
Kueri yang akan dikirim ke tindakan percakapan. |
state |
string
Salah satu dari berikut ini:
|
getHeaderHeightPx
getHeaderHeightPx() returns Promise<height>
Menentukan tinggi header di bagian atas tampilan.
Parameter | |
---|---|
height |
number
Tinggi dalam piksel. |
outputTts
outputTts(text, openMic) returns undefined;
Memutar teks SSML.
Parameter | |
---|---|
text |
string
String yang didukung SSML untuk diputar. |
openMic |
boolean
Apakah akan mengaktifkan mikrofon setelah TTS diputar. |
createIntentHandler
createIntentHandler(intentId, callback) returns IntentHandler
Membuat pengendali intent untuk intent kustom NLU.
Parameter | |
---|---|
intentId |
string
Nama intent seperti yang ditentukan di Action Builder. |
callback |
function(MatchedIntent)
Fungsi yang akan dieksekusi saat intent cocok. |
IntentHandler |
object
Objek pengendali intent yang dapat didaftarkan menggunakan |
IntentHandler
Objek yang mewakili pengendali intent. Dapat didaftarkan menggunakan expect()
atau prompt()
.
MatchedIntent
Objek yang berisi data untuk intent yang cocok.
Metode | |
---|---|
getIntentArg(parameterName) |
function(string)
Metode untuk mendapatkan parameter intent intent yang cocok. |
createNumberSlot
createNumberSlot(callback, hints?) returns Slot<number>
Membuat slot nomor jenis.
Parameter | |
---|---|
callback |
function(FilledSlot)
Fungsi yang akan dieksekusi ketika slot terisi. |
hints |
Hints
Kata-kata singkat yang mungkin diucapkan pengguna saat mengisi slot. |
Slot |
object
Objek slot yang dapat didaftarkan menggunakan |
createTextSlot
createTextSlot(callback, hints?) returns Slot<string>
Membuat slot string jenis.
Parameter | |
---|---|
callback |
function(FilledSlot)
Fungsi yang akan dieksekusi ketika slot terisi. |
hints |
Hints
Kata-kata singkat yang mungkin diucapkan pengguna saat mengisi slot. |
Slot |
object
Objek slot yang dapat didaftarkan menggunakan |
createConfirmationSlot
createConfirmationSlot(callback, hints?) returns Slot<boolean>
Membuat slot jenis boolean.
Parameter | |
---|---|
callback |
function(FilledSlot)
Fungsi yang akan dieksekusi ketika slot terisi. |
hints |
Hints
Kata-kata singkat yang mungkin diucapkan pengguna saat mengisi slot. |
Slot |
object
Objek slot yang dapat didaftarkan menggunakan |
createOptionsSlot
createOptionsSlot(options, callback, hints?) returns Slot<string>
Membuat slot dari daftar opsi yang ditentukan sebelumnya.
Parameter | |
---|---|
options |
array<Option>
Fungsi yang akan dieksekusi ketika slot terisi. |
callback |
function(FilledSlot)
Fungsi yang akan dieksekusi ketika slot terisi. |
hints |
Hints
Kata-kata singkat yang mungkin diucapkan pengguna saat mengisi slot. |
Slot |
object
Objek slot yang dapat didaftarkan menggunakan |
Slot
Objek yang mewakili slot yang akan diisi. Dapat didaftarkan menggunakan expect()
atau prompt()
.
FilledSlot<T>
Objek yang merepresentasikan slot yang terisi.
Parameter | |
---|---|
T |
boolean|number|string
Jenis slot. |
Opsi
Objek yang mewakili entri jenis slot.
Kolom | |
---|---|
key |
string
ID unik untuk entri jenis slot. |
synonyms |
array<string>
Daftar kata yang digunakan untuk memilih opsi slot. |
Petunjuk
Objek yang merepresentasikan petunjuk untuk slot.
Kolom | |
---|---|
associatedWords |
array<string>
Daftar kata yang digunakan untuk membantu sistem NLU memutuskan slot mana yang harus diisi. |
expect
expect(expectation) returns HandlerRegistration
Mendaftarkan ekspektasi pada klien. Dapat dipanggil di slot dan pengendali intent.
Parameter | |
---|---|
expectation |
IntentHandler|Slot
Pengendali intent atau slot yang akan didaftarkan. |
HandlerRegistration |
object
Slot atau pengendali intent yang terdaftar. |
HandlerRegistration
Objek yang mewakili pengendali intent terdaftar.
Metode | |
---|---|
deleteHandler() |
function
Membatalkan pendaftaran pengendali intent yang diharapkan. |
clearExpectations
clearExpectations() returns undefined;
Menghapus semua ekspektasi dengan menghapus semua slot dan pengendali intent yang telah terdaftar.
perintah
prompt(tts, expectation) returns Promise<Answer<T>>
Meminta pengguna dengan string TTS yang disediakan, dan mendaftarkan ekspektasi di klien. Dapat dipanggil di slot dan pengendali intent.
Parameter | |
---|---|
tts |
string
String TTS yang digunakan untuk meminta pengguna memberikan ekspektasi yang diberikan. |
expectation |
IntentHandler|Slot
Pengendali intent atau slot yang akan didaftarkan. |
Answer<T> |
object
Jawaban yang diberikan pengguna. |
Jawaban<T>
Objek yang mewakili jawaban yang diberikan pengguna atas sebuah dialog.
Kolom | |
---|---|
value |
boolean|number|string
Nilai jawaban yang diberikan pengguna. |
status |
string
Status jawaban. Salah satu dari berikut ini:
|
triggerScene
triggerScene(sceneName) returns Promise<TriggerSceneStatus>
Memicu scene.
Parameter | |
---|---|
sceneName |
string
Nama scene yang akan dipicu. |
TriggerSceneStatus |
string
Status panggilan ke triggerScene(). Salah satu dari berikut ini:
|
setUserParam
setUserParam(key, value) returns Promise<undefined>;
Menetapkan pasangan nilai kunci yang diteruskan dan dipertahankan di antara percakapan.
Parameter | |
---|---|
key |
string
Kunci parameter. |
value |
object|array|boolean|number|string
Nilai parameter. |
getUserParam
getUserParam(key) returns Promise<object|array|boolean|number|string>;
Mendapatkan nilai parameter untuk kunci yang diberikan jika ada dan status pemanggilannya.
Parameter | |
---|---|
key |
string
Kunci parameter. |
resetUserParam
resetUserParam() returns Promise<void>;
Menghapus semua parameter pengguna.
setHomeParam
setHomeParam(key, value) returns Promise<undefined>;
Menetapkan pasangan nilai kunci yang diteruskan dan dipertahankan di antara percakapan.
Parameter | |
---|---|
key |
string
Kunci parameter. |
value |
object|array|boolean|number|string
Nilai parameter. |
getHomeParam
getHomeParam(key) returns Promise<object|array|boolean|number|string>;
Mendapatkan nilai parameter untuk kunci yang diberikan jika ada dan status pemanggilannya.
Parameter | |
---|---|
key |
string
Kunci parameter. |
resetHomeParam
resetHomeParam() returns Promise<void>;
Menghapus semua parameter pengguna.
setCanvasState
setCanvasState(state) returns undefined
Memberi tahu Asisten bahwa aplikasi web Canvas telah memperbarui statusnya. Metode
setCanvasState
tidak menampilkan nilai. Payload status dapat diakses melalui
properti conv.context.canvas.state
.
Parameter | |
---|---|
state |
Object
Status terbaru aplikasi Canvas sebagai objek JSON. |
InteractiveCanvasCallbacks
Callback ini memberikan cara bagi Anda untuk merespons informasi atau permintaan dari Action Percakapan, sedangkan metode tersebut memberikan cara untuk mengirim informasi atau permintaan ke Action Percakapan Anda.
onUpdate
onUpdate(data) returns Promise|undefined
Dipanggil saat respons Canvas
dikirim dari Action Percakapan. TTS akan dimulai saat
Promise yang ditampilkan diselesaikan, atau waktu tunggu habis setelah 10 detik.
Parameter | |
---|---|
data |
Object
Data yang diperbarui yang dikirim oleh webhook. |
onTtsMark
onTtsMark(markName) returns undefined
Callback yang dipanggil selama pemutaran TTS.
Tanda khusus yang selalu dipicu:
START
menunjukkan awal TTS.END
menunjukkan akhir TTS.ERROR
menunjukkan error saat memutar TTS.
Anda juga dapat menentukan tanda kustom menggunakan SSML dan tag <mark>
, seperti
<mark name="custom"/>
.
Parameter | |
---|---|
markName |
string
Menandai nama yang dipanggil selama pemutaran TTS. |
onInputStatusChanged
onInputStatusChanged(inputStatus) returns undefined
Memberi tahu aplikasi Canvas bahwa status input Asisten telah berubah.
Parameter | |
---|---|
inputStatus |
Enum
Status pemrosesan input suara dan/atau teks pada perangkat. Dapat berupa:
|