Die Interactive Canvas API ist eine JavaScript-Bibliothek, die Sie für die Kommunikation mit Ihrer Konversationsaktion über das Objekt interactiveCanvas
in Ihrer Webanwendung verwenden.
Weitere Informationen finden Sie in der Dokumentation zu Interactive Canvas.
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:
|
getHeaderHeightPx
getHeaderHeightPx() returns Promise<height>
Bestimmt die Höhe der Kopfzeile oben in einer Anzeige.
Parameter | |
---|---|
height |
number
Die Höhe in Pixeln. |
outputTts
outputTts(text, openMic) returns undefined;
Gibt SSML-Text wieder.
Parameter | |
---|---|
text |
string
Der von SSML unterstützte String, der wiedergegeben werden soll. |
openMic |
boolean
Gibt an, ob das Mikrofon nach der Sprachausgabe aktiviert werden soll. |
createIntentHandler
createIntentHandler(intentId, callback) returns IntentHandler
Erstellt einen Intent-Handler für einen benutzerdefinierten NLU-Intent.
Parameter | |
---|---|
intentId |
string
Intent-Name wie in Actions Builder definiert. |
callback |
function(MatchedIntent)
Funktion, die ausgeführt werden soll, wenn der Intent zugeordnet wird. |
IntentHandler |
object
Intent-Handler-Objekt, das mit |
IntentHandler
Ein Objekt, das einen Intent-Handler darstellt. Kann mit expect()
oder prompt()
registriert werden.
MatchedIntent
Ein Objekt, das die Daten für einen zugeordneten Intent enthält.
Methoden | |
---|---|
getIntentArg(parameterName) |
function(string)
Methode zum Abrufen des Intent-Parameters eines zugeordneten Intents. |
createNumberSlot
createNumberSlot(callback, hints?) returns Slot<number>
Erstellt einen Slot des Typs number.
Parameter | |
---|---|
callback |
function(FilledSlot)
Funktion, die ausgeführt werden soll, wenn die Anzeigenfläche gefüllt ist. |
hints |
Hints
Kurze Wörter, die ein Nutzer beim Füllen einer Anzeigenfläche sagen könnte. |
Slot |
object
Slotobjekt, das mit |
createTextSlot
createTextSlot(callback, hints?) returns Slot<string>
Erstellt einen Slot vom Typ String.
Parameter | |
---|---|
callback |
function(FilledSlot)
Funktion, die ausgeführt werden soll, wenn die Anzeigenfläche gefüllt ist. |
hints |
Hints
Kurze Wörter, die ein Nutzer beim Füllen einer Anzeigenfläche sagen könnte. |
Slot |
object
Slotobjekt, das mit |
createConfirmationSlot
createConfirmationSlot(callback, hints?) returns Slot<boolean>
Erstellt eine Anzeigenfläche vom Typ boolescher Wert.
Parameter | |
---|---|
callback |
function(FilledSlot)
Funktion, die ausgeführt werden soll, wenn die Anzeigenfläche gefüllt ist. |
hints |
Hints
Kurze Wörter, die ein Nutzer beim Füllen einer Anzeigenfläche sagen könnte. |
Slot |
object
Slotobjekt, das mit |
createOptionsSlot
createOptionsSlot(options, callback, hints?) returns Slot<string>
Erstellt eine Anzeigenfläche aus einer vordefinierten Liste von Optionen.
Parameter | |
---|---|
options |
array<Option>
Funktion, die ausgeführt werden soll, wenn die Anzeigenfläche gefüllt ist. |
callback |
function(FilledSlot)
Funktion, die ausgeführt werden soll, wenn die Anzeigenfläche gefüllt ist. |
hints |
Hints
Kurze Wörter, die ein Nutzer beim Füllen einer Anzeigenfläche sagen könnte. |
Slot |
object
Slotobjekt, das mit |
Slot
Ein Objekt, das eine zu füllende Anzeigenfläche darstellt. Kann mit expect()
oder prompt()
registriert werden.
FilledSlot<T>
Ein Objekt, das eine gefüllte Anzeigenfläche darstellt.
Parameter | |
---|---|
T |
boolean|number|string
Der Typ der Anzeigenfläche. |
Option
Ein Objekt, das einen Slottyp darstellt.
Felder | |
---|---|
key |
string
Die eindeutige Kennung für den Slottyp-Eintrag. |
synonyms |
array<string>
Eine Liste von Wörtern, mit denen die Slot-Option ausgewählt wird. |
Hinweise
Ein Objekt, das Hinweise für einen Slot darstellt.
Felder | |
---|---|
associatedWords |
array<string>
Eine Liste von Wörtern, die dem NLU-System bei der Entscheidung helfen, welche Anzeigenfläche gefüllt werden soll. |
expect
expect(expectation) returns HandlerRegistration
Registriert die Erwartung auf dem Client. Kann für Intent-Handler und Slots aufgerufen werden.
Parameter | |
---|---|
expectation |
IntentHandler|Slot
Der zu registrierende Intent-Handler oder Slot. |
HandlerRegistration |
object
Der registrierte Intent-Handler oder Slot. |
HandlerRegistration
Ein Objekt, das einen registrierten Intent-Handler darstellt.
Methoden | |
---|---|
deleteHandler() |
function
Hebt die Registrierung des erwarteten Intent-Handlers auf. |
clearExpectations
clearExpectations() returns undefined;
Alle Erwartungen werden entfernt, indem alle zuvor registrierten Intent-Handler und Slots gelöscht werden.
Prompt
prompt(tts, expectation) returns Promise<Answer<T>>
Fordert den Nutzer mit dem bereitgestellten TTS-String auf und registriert die Erwartung auf dem Client. Kann für Intent-Handler und Slots aufgerufen werden.
Parameter | |
---|---|
tts |
string
Der TTS-String, mit dem der Nutzer zur Eingabe der Erwartungen aufgefordert wird. |
expectation |
IntentHandler|Slot
Der zu registrierende Intent-Handler oder Slot. |
Answer<T> |
object
Die vom Nutzer angegebene Antwort auf die Aufforderung. |
Antwort<T>
Ein Objekt, das eine vom Nutzer bereitgestellte Antwort auf eine Aufforderung darstellt.
Felder | |
---|---|
value |
boolean|number|string
Der Wert der vom Nutzer bereitgestellten Antwort. |
status |
string
Der Antwortstatus. Eines der folgenden Betriebssysteme:
|
triggerScene
triggerScene(sceneName) returns Promise<TriggerSceneStatus>
Löst eine Szene aus.
Parameter | |
---|---|
sceneName |
string
Der Name der Szene, die ausgelöst werden soll. |
TriggerSceneStatus |
string
Der Status des Aufrufs von „triggerScene()“. Eines der folgenden Betriebssysteme:
|
setUserParam
setUserParam(key, value) returns Promise<undefined>;
Legt das Schlüssel/Wert-Paar fest, das zwischen Konversationen übergeben und beibehalten wird.
Parameter | |
---|---|
key |
string
Der Parameterschlüssel. |
value |
object|array|boolean|number|string
Der Parameterwert. |
getUserParam
getUserParam(key) returns Promise<object|array|boolean|number|string>;
Ruft den Parameterwert für den angegebenen Schlüssel, sofern vorhanden, und den Status des Aufrufs ab.
Parameter | |
---|---|
key |
string
Der Parameterschlüssel. |
resetUserParam
resetUserParam() returns Promise<void>;
Löscht alle Nutzerparameter.
setHomeParam
setHomeParam(key, value) returns Promise<undefined>;
Legt das Schlüssel/Wert-Paar fest, das zwischen Konversationen übergeben und beibehalten wird.
Parameter | |
---|---|
key |
string
Der Parameterschlüssel. |
value |
object|array|boolean|number|string
Der Parameterwert. |
getHomeParam
getHomeParam(key) returns Promise<object|array|boolean|number|string>;
Ruft den Parameterwert für den angegebenen Schlüssel, sofern vorhanden, und den Status des Aufrufs ab.
Parameter | |
---|---|
key |
string
Der Parameterschlüssel. |
resetHomeParam
resetHomeParam() returns Promise<void>;
Löscht alle Nutzerparameter.
setCanvasState
setCanvasState(state) returns undefined
Informiert Assistant darüber, dass der Status der Canvas-Web-App aktualisiert wurde. Die Methode setCanvasState
gibt keinen Wert zurück. Auf die Statusnutzlast kann über das Attribut conv.context.canvas.state
zugegriffen werden.
Parameter | |
---|---|
state |
Object
Der aktualisierte Status der Canvas-App als JSON-Objekt. |
InteractiveCanvasCallbacks
Diese Callbacks bieten Ihnen die Möglichkeit, auf Informationen oder Anfragen von Ihrer Konversationsaktion zu antworten, während die Methoden die Möglichkeit bieten, Informationen oder Anfragen an die Konversationsaktion zu senden.
onUpdate
onUpdate(data) returns Promise|undefined
Wird aufgerufen, wenn eine Canvas
-Antwort von der Konversationsaktion gesendet wird. TTS wird gestartet, wenn das zurückgegebene Promise behoben wurde, oder die Zeitüberschreitung nach 10 Sekunden.
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. <mark name="custom"/>
.
Parameter | |
---|---|
markName |
string
Namen markieren, der während der Text-in-Sprache-Wiedergabe aufgerufen wird. |
onInputStatusChanged
onInputStatusChanged(inputStatus) returns undefined
Informiert die Canvas App darüber, dass sich der Assistant-Eingabestatus geändert hat.
Parameter | |
---|---|
inputStatus |
Enum
Status der Verarbeitung von Sprach- und/oder Texteingabe auf dem Gerät. Mögliche Werte sind:
|