InteractiveCanvas (Dialogflow)

L'oggetto interactiveCanvas è l'interfaccia della tua azione di conversazione reso disponibile all'interno della tua applicazione web.

Nota: l'oggetto interactiveCanvas è collegato all'oggetto window. Se usando un framework front-end per sviluppare la tua applicazione web, devi assicurarti puoi accedere a window per configurare l'API.

Metodi

pronto

ready(callbacks) returns undefined

Richiamato dall'app web Interactive Canvas al termine del caricamento per la registrazione dei callback.

Parametri
callbacks	InteractiveCanvasCallbacks Un oggetto che contiene callback di metodi.

Nota: devi richiamare l'API ready nell'app web non appena la pagina viene caricato. 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: Esiste una query in fase di pubblicazione e la nuova query verrà eliminata. UNKNOWN: Impossibile determinare lo stato attuale della query.

Attenzione: il valore 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 ti permettono di rispondere a informazioni o richieste dall'azione conversazionale, mentre i metodi forniscono un modo per inviare informazioni o richieste all'azione conversazionale.

onUpdate

onUpdate(data) returns undefined

Richiamato quando viene inviato un HtmlResponse dall'azione di conversazione. Dopo il giorno al termine della chiamata di funzione, la sintesi vocale verrà avviata immediatamente.

Parametri
data	Object Dati aggiornati inviati dal webhook.

onTtsMark

onTtsMark(markName) returns undefined

Callback richiamato durante la riproduzione della sintesi vocale.

Segnali 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 della sintesi vocale.

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

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

• Prima dell'inizio della sintesi vocale, l'utente tocca il microfono o il Canvas interattivo il client richiama sendTextQuery. La sintesi vocale viene annullata e qualsiasi contrassegno SSML nella vengono ignorati.
• Durante la sintesi vocale, l'utente tocca il microfono o il client Interactive Canvas richiama sendTextQuery. La sintesi vocale viene interrotta e qualsiasi SSML rimanente nella sintesi vocale vengono ignorati.

Parametri
markName	string Contrassegna il nome richiamato durante la riproduzione della sintesi vocale.