InteractiveCanvas (Dialogflow)

L'oggetto interactiveCanvas è l'interfaccia dell'azione conversazionale resa disponibile all'interno della tua app web.

Nota: l'oggetto interactiveCanvas è collegato all'oggetto window. Se utilizzi un framework front-end per sviluppare la tua app web, devi assicurarti di avere accesso a window per configurare l'API.

Metodi

pronta

ready(callbacks) returns undefined

Richiamato dall'app web Interactive Canvas dopo il caricamento per registrare le richiamate.

Parametri
callbacks	InteractiveCanvasCallbacks Un oggetto che contiene i callback di metodo.

Nota: devi richiamare l'API ready nell'app web non appena la pagina viene caricata. In caso contrario, l'Azione verrà chiusa.

sendTextQuery

sendTextQuery(textQuery) returns Promise<state>

Invia una query di testo all'azione conversazionale.

Parametri
textQuery	string La query da inviare all'azione conversazionale.
state	string Il valore sarà uno dei seguenti: READY: Le richieste possono essere accettate dalla piattaforma. BLOCKED: È presente una query in corso e la nuova query verrà eliminata. UNKNOWN: Impossibile determinare lo stato attuale della query.

Attenzione: textQuery deve contenere al massimo 640 caratteri.

getHeaderHeightPx

getHeaderHeightPx() returns Promise<height>

Determina l'altezza dell'intestazione nella parte superiore di una visualizzazione.

Parametri
height	number L'altezza in pixel.

InteractiveCanvasCallbacks

Questi callback forniscono un modo per rispondere a informazioni o richieste della tua azione conversazionale, mentre i metodi forniscono un modo per inviare informazioni o richieste alla tua azione conversazionale.

onUpdate

onUpdate(data) returns undefined

Richiamato quando viene inviata un'HtmlResponse dall'azione conversazionale. Dopo la fine della chiamata di funzione, la sintesi vocale inizia immediatamente.

Parametri
data	Object Dati aggiornati inviati dal webhook.

onTtsMark

onTtsMark(markName) returns undefined

Callback richiamato durante la riproduzione di sintesi vocale.

Segni speciali che vengono sempre attivati:

• START indica l'inizio della sintesi vocale.
• END indica la fine della sintesi vocale.
• ERROR indica un errore durante la riproduzione del TTS.

Puoi anche definire marchi personalizzati utilizzando SSML e il tag <mark>, come <mark name="custom"/>.

Nota: i marchi SSML non vengono richiamati quando si verifica quanto segue:

• Prima dell'inizio della sintesi vocale, l'utente tocca il microfono o il client Interactive Canvas richiama sendTextQuery. La sintesi vocale viene annullata e gli eventuali marchi SSML nel TTS vengono ignorati.
• Durante la sintesi vocale, l'utente tocca il microfono o il client Interactive Canvas richiama sendTextQuery. La sintesi vocale viene interrotta ed eventuali contrassegni SSML rimanenti nel TTS vengono ignorati.

Parametri
markName	string Contrassegna il nome richiamato durante la riproduzione TTS.