InteractiveCanvas (Dialogflow)

Obiekt interactiveCanvas jest interfejsem działania konwersacyjnego udostępnianej w aplikacji internetowej.

Metody

gotowe

ready(callbacks) returns undefined

Wywoływana przez aplikację internetową Interactive Canvas po 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 działania konwersacyjnego.

Parametry
textQuery string

Zapytanie, które ma zostać wysłane do działania konwersacyjnego.

state string

Jedna z tych wartości:

READY: Prośby mogą być akceptowane przez platformę.

BLOCKED: jest w trakcie wyświetlania zapytanie, w związku z czym nowe zostanie usunięte.

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

getHeaderHeightPx

getHeaderHeightPx() returns Promise<height>

Określa wysokość nagłówka na górze wyświetlacza.

Parametry
height number

Wysokość w pikselach.

InteractiveCanvasCallbacks

Dzięki tym wywołaniem możesz odpowiadać na informacje lub prośby od działań konwersacyjnych, a metody umożliwiają wysyłanie informacji lub żądań związanych z działaniem konwersacyjnym.

onUpdate

onUpdate(data) returns undefined

Wywoływana, gdy z czynności konwersacyjnej zostanie wysłane żądanie HtmlResponse. Po na koniec wywołania funkcji, zamiana tekstu na mowę rozpocznie się natychmiast.

Parametry
data Object

Zaktualizowane dane wysłane przez webhooka.

onTtsMark

onTtsMark(markName) returns undefined

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

Znaki specjalne, które są zawsze aktywowane:

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

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

Parametry
markName string

Oznacz nazwę wywoływaną podczas odtwarzania TTS.