InteractiveCanvas (Dialogflow)

Obiekt interactiveCanvas to interfejs akcji konwersacyjnej udostępniany w aplikacji internetowej.

Metody

gotowa

ready(callbacks) returns undefined

Wywoływana przez aplikację internetową Interactive Canvas po jej załadowaniu w celu zarejestrowania wywołań zwrotnych.

Parametry
callbacks InteractiveCanvasCallbacks

Obiekt zawierający wywołania zwrotne metody.

sendTextQuery

sendTextQuery(textQuery) returns Promise<state>

Wysyła zapytanie tekstowe do czynności związanej z konwersacją.

Parametry
textQuery string

Zapytanie wysłane do działania związanego z konwersacją.
state string

Jedna z tych wersji:

READY: Platforma może akceptować żądania.

BLOCKED: Wyświetlane jest zapytanie, które zostanie pominięte.

UNKNOWN: Nie udało się określić bieżącego stanu zapytania.

getHeaderHeightPx

getHeaderHeightPx() returns Promise<height>

Określa wysokość nagłówka u góry ekranu.

Parametry
height number

Wysokość w pikselach.

InteractiveCanvasCallbacks

Wywołania te umożliwiają reagowanie na informacje lub prośby z rozmowy, natomiast metody wysyłania informacji lub próśb związane z rozmową.

onUpdate

onUpdate(data) returns undefined

Wywoływane, gdy w ramach czynności związanej z rozmową zostanie wysłany HtmlResponse. Po zakończeniu wywołania funkcji od razu rozpocznie się zamiana tekstu na mowę.

Parametry
data Object

Zaktualizowane dane wysłane przez webhooka.

onTtsMark

onTtsMark(markName) returns undefined

Wywołanie zwrotne podczas odtwarzania zamiany tekstu na mowę.

Specjalne znaki, które są zawsze wywoływane:

  • START wskazuje początek zamiany tekstu na mowę.
  • END wskazuje koniec zamiany tekstu na mowę.
  • ERROR oznacza błąd podczas odtwarzania zamiany tekstu na mowę.

Znaczniki niestandardowe możesz też definiować za pomocą SSML i tagu <mark>, np. <mark name="custom"/>.

Parametry
markName string

Oznacz nazwę wywołaną podczas odtwarzania zamiany tekstu na mowę.