InteractiveCanvas (Dialogflow)

Das Objekt interactiveCanvas ist die Schnittstelle zu Ihrer Konversationsaktion, die in Ihrer Webanwendung zur Verfügung gestellt wird.

Methoden

bereit

ready(callbacks) returns undefined

Wird von der Interactive Canvas-Webanwendung nach dem Laden aufgerufen, um Callbacks zu registrieren.

Parameter
callbacks InteractiveCanvasCallbacks

Ein Objekt, das Methoden-Callbacks enthält.

sendTextQuery

sendTextQuery(textQuery) returns Promise<state>

Sendet eine Textabfrage an die Konversationsaktion.

Parameter
textQuery string

Die Abfrage, die an die Konversationsaktion gesendet werden soll.
state string

Eines der folgenden Betriebssysteme:

READY: Anfragen können von der Plattform angenommen werden.

BLOCKED: Eine Abfrage wird ausgeführt und die neue Abfrage wird gelöscht.

UNKNOWN: Der aktuelle Abfragestatus konnte nicht ermittelt werden.

getHeaderHeightPx

getHeaderHeightPx() returns Promise<height>

Bestimmt die Höhe der Kopfzeile oben in einer Anzeige.

Parameter
height number

Die Höhe in Pixeln.

InteractiveCanvasCallbacks

Diese Callbacks bieten Ihnen die Möglichkeit, auf Informationen oder Anfragen aus Ihrer Unterhaltungsaktion zu antworten, während die Methoden eine Möglichkeit bieten, Informationen oder Anfragen an die Unterhaltungsaktion zu senden.

onUpdate

onUpdate(data) returns undefined

Wird aufgerufen, wenn ein HtmlResponse von der Unterhaltungsaktion gesendet wird. Nach dem Ende des Funktionsaufrufs beginnt die Sprachausgabe sofort.

Parameter
data Object

Aktualisierte Daten, die vom Webhook gesendet werden.

onTtsMark

onTtsMark(markName) returns undefined

Ein Rückruf, der während der Sprachausgabe ausgelöst wird.

Spezielle Markierungen, die immer ausgelöst werden:

  • START gibt den Beginn der TTS an.
  • END gibt das Ende der TTS an.
  • ERROR weist auf einen Fehler bei der Wiedergabe der Sprachausgabe hin.

Sie können auch benutzerdefinierte Markierungen mit SSML und dem Tag <mark> definieren, z. B. mit <mark name="custom"/>.

Parameter
markName string

Namen markieren, der während der Text-in-Sprache-Wiedergabe aufgerufen wird.