Dialogflow Messenger bietet Funktionen die Sie aufrufen können, um ihr Verhalten zu beeinflussen.
renderCustomText
Diese Funktion rendert eine einfache Textnachricht, als ob sie vom Agent als einfache Textantwort kam. oder vom Endnutzer eingegeben wurde.
Argumente:
string
: SMSboolean
: „true“ für eine Nachricht vom Kundenservicemitarbeiter, „false“ für eine Nachricht des Endnutzers
Zurück:
void
Beispiel:
const dfMessenger = document.querySelector('df-messenger');
dfMessenger.renderCustomText('Custom text', true);
renderCustomCard
Diese Funktion rendert eine benutzerdefinierte Karte, so als ob sie aus der Dialogflow-Auftragsausführung stammt.
Argumente:
payload
: eine Liste benutzerdefinierter Nutzlastantworten, die im Auftragsausführung.
Zurück:
void
Beispiel:
const dfMessenger = document.querySelector('df-messenger');
const payload = [
{
"type": "info",
"title": "Info item title",
"subtitle": "Info item subtitle",
"image": {
"rawUrl": "https://example.com/images/logo.png"
},
"anchor": {
"href": "https://example.com",
"target": "_blank"
}
}
];
dfMessenger.renderCustomCard(payload);
sendQuery
Diese Funktion sendet eine Abfrage an die Dialogflow API und wartet auf die Antwort. Dadurch wird eine Endnutzereingabe der normalerweise im Dialogfeld des Kundenservicemitarbeiters angezeigt wird. Die Antwort wird wie jede Endnutzeranfrage behandelt.
Argumente:
string
: Textabfrage
Zurück:
Promise<void>
: Rückgabewert für den asynchronen Vorgang
Beispiel:
const dfMessenger = document.querySelector('df-messenger');
dfMessenger.sendQuery('Describe shipping costs.');
sendRequest
Diese Funktion sendet eine Anfrage an die Dialogflow API und wartet auf die Antwort.
Argumente:
string
: Anfragetyp, unterstütztquery
(siehe auchsendQuery
oben) undevent
(siehe benutzerdefiniertes Ereignis)any
: Nutzlast, die dem Anfragetyp entspricht, der derzeit ein String für beide unterstützten Anfragetypen ist
Zurück:
Promise<void>
: Rückgabewert für den asynchronen Vorgang
Beispiel:
const dfMessenger = document.querySelector('df-messenger');
dfMessenger.sendRequest('query', 'Describe shipping costs.');
setQueryParameters
Diese Funktion legt Standardwerte für das Feld queryParams der detectIntent
-Anfrage der Dialogflow API fest.
Die jeweiligen Standardwerte in den Abfrageparametern können durch andere Dialogflow Messenger-Methoden ersetzt werden.
Argumente:
object
: JSON-Daten. Das Schema der Abfrageparameter finden Sie unter QueryParameters.
Zurück:
void
Beispiel:
const dfMessenger = document.querySelector('df-messenger');
const queryParameters = {
parameters: {
timeZone: "America/New_York"
}
};
dfMessenger.setQueryParameters(queryParameters);
setContext
Diese Funktion sendet generative Personalisierung Informationen über den Endnutzer an Dialogflow. Diese Informationen bleiben für den Rest der Sitzung erhalten.
Argumente:
object
: JSON-Daten, siehe Dokumentation zu generativer Personalisierung
Zurück:
void
Beispiel:
const dfMessenger = document.querySelector('df-messenger');
const metadata = {
"subscription plan": "Business Premium Plus",
"devices owned": [
{
model: "Google Pixel 7",
},
{
model: "Google Pixel Tablet",
},
],
};
dfMessenger.setContext(metadata);
clearStorage
Diese Funktion löscht den dauerhaften Speicher des Agent-Dialogfelds. Außerdem werden die Daten den aktuellen Status des Agent-Dialogfelds.
Argumente:
- keine
Zurück:
void
Beispiel:
const dfMessenger = document.querySelector('df-messenger');
dfMessenger.clearStorage();
clearAuthentication
Diese Funktion löscht die Authentifizierung des Agent-Dialogfelds.
Argumente:
- keine
Zurück:
void
Beispiel:
const dfMessenger = document.querySelector('df-messenger');
dfMessenger.clearAuthentication();
startNewSession
Diese Funktion startet eine neue Sitzung im Agent-Dialogfeld. Es kann entweder oder setzen Sie den aktuellen Nachrichtenverlauf zurück. Die Nutzenden werden nicht gelöscht. Authentifizierung.
Argumente:
Name | Typ | Beschreibung |
---|---|---|
args |
object? |
Optionales Argument zum Konfigurieren der neuen Sitzungserstellung. |
args.retainHistory |
boolean? |
Optionales Flag zum Beibehalten des Verlaufs. Ist sie auf „true“ gesetzt, wird der Verlauf beibehalten. Andernfalls wird er gelöscht. |
Zurück:
void
Beispiel:
const dfMessenger = document.querySelector('df-messenger');
dfMessenger.startNewSession({ retainHistory: true });
openChat
Dadurch wird der Chat geöffnet. Rufen Sie sie im df-messenger-chat-bubble
-Element auf.
um den Chat zu öffnen. Tut nichts, wenn der Chat bereits geöffnet ist.
Argumente:
- keine
Zurück:
void
Beispiel:
const dfMessengerBubble = document.querySelector('df-messenger-chat-bubble');
dfMessengerBubble.openChat();
closeChat
Diese Funktion schließt den Chat. Rufen Sie sie im df-messenger-chat-bubble
-Element auf.
um den Chat zu schließen. Tut nichts, wenn der Chat bereits geschlossen ist.
Argumente:
- keine
Zurück:
void
Beispiel:
const dfMessengerBubble = document.querySelector('df-messenger-chat-bubble');
dfMessengerBubble.closeChat();
openMinChat
Diese Funktion öffnet das Chatfenster in einer minimierten Version. Rufen Sie es im
df-messenger-chat-bubble
-Element, um den minimierten Chat zu öffnen. Tut nichts, wenn
der Chat ist bereits minimiert.
Argumente:
Name | Typ | Beschreibung |
---|---|---|
args | Objekt? | Optionales Argument zum Konfigurieren des minimierten Chats |
args.anchor | String? | Optionales anchor zum Konfigurieren, wo der minimierte Chat geöffnet wird. Es entspricht der Logik für das Attribut anchor im Infofeldelement. Die Standardeinstellung ist left-top . |
args.showActorImages | boolean? | Optionales Flag zum Anzeigen von Schauspielerbildern (falls für das Element df-messenger-chat-bubble angegeben). Die Standardeinstellung ist "false". |
Beispiel:
const dfMessengerChatBubble = document.querySelector('df-messenger-chat-bubble');
dfMessengerChatBubble.openMinChat({
anchor: 'top-left'
});
closeMinChat
Schließt den minimierten Chat. Rufen Sie sie im df-messenger-chat-bubble
-Element auf,
und schließen Sie den minimierten Chat. Tut nichts, wenn der Chat bereits geschlossen ist.
Beispiel:
const dfMessengerChatBubble = document.querySelector('df-messenger-chat-bubble');
dfMessengerChatBubble.closeMinChat();