Web-Chat-Entwicklung-Übersicht
Wenn Sie mit JavaScript-Code vertraut sind, können Sie den Web-Chat mithilfe der Web-Chat-API anpassen und erweitern. Sie können auch WebView verwenden, um den Web-Chat in Ihre mobile App einzubetten.
Ausführliche Referenzinformationen zur Web-Chat-API finden Sie in der Entwicklerdokumentationzum Web-Chat.
Um das Web-Chat-Widget Ihrer Website oder einem WebView in Ihrer mobilen App hinzuzufügen, müssen Sie lediglich ein generiertes Scriptelement in Ihre HTML-Quelle einbetten (weitere Informationen zum Einbettungsscript finden Sie unter Einbetten des Web-Chats auf Ihrer Seite). Innerhalb dieses Einbettungsscripts können Sie die Web-Chat-API verwenden, um den Web-Chat anzupassen oder zu erweitern.
Die Web-Chat-API besteht aus mehreren Komponenten:
- Konfigurationsobjekt: Das Einbettungsscript definiert ein Konfigurationsobjekt mit dem Namen
watsonAssistantChatOptions, das Konfigurationsobjekte für das Web-Chat-Widget angibt. Durch Bearbeiten des Konfigurationsobjekts können Sie die Darstellung und das Verhalten des Web-Chats vor der Wiedergabe anpassen. Weitere Informationen zu den verfügbaren Konfigurationsoptionen finden Sie unter Configuration options object in der Web-API-Referenz. - Instanzmethoden: Die Instanzmethoden für Web-Chats bieten eine maschinennahe Steuerung des Web-Chat-Widgets. Sie können die Instanzmethoden verwenden, um angepasstes Verhalten zu implementieren, z. B. das Ändern der Art und Weise, wie das Web-Chat-Widget geöffnet wird, das Ein- und Ausblenden von Inhalten und das Festlegen von Identitätsinformationen. Weitere Informationen zu den verfügbaren Instanzdefinitionsmethoden finden Sie unter Liste der Methoden und Eigenschaften in der Web-Chat-API-Referenz.
- Ereignisse: Das Web-Chat-Ereignissystem ermöglicht es Ihrer Website, auf Web-Chat-Ereignisse zu reagieren (z. B. Öffnen oder Schließen des Web-Chat-Fensters, Senden oder Empfangen von Nachrichten). Durch Abonnieren von Ereignissen können Sie angepasstes Verhalten implementieren oder sogar Nachrichteninhalte abfangen und ändern. Weitere Informationen zum Ereignissystem finden Sie unter Ereignisse in der Web-Chat-API-Referenz.
Wenn Sie die Web-Chat-API verwenden möchten, um Ihre Web-Chat-Implementierung anzupassen, müssen Sie nicht völlig neu beginnen. Es sind Lernprogramme verfügbar, die Beispiele allgemeiner Web-Chat-Anpassungen zeigen. Weitere Informationen finden Sie unter Lernprogramme zur Web-Chat-Entwicklung.
Entwicklungstasks
Sie können die Web-Chat-API verwenden, um den Web-Chat wie folgt anzupassen und zu erweitern:
- Web-Chat-Stil und Inhalt
- Web-Chat-Fenster öffnen, schließen und wiedergeben
- Dialog anpassen
- Daten verwalten
- Sicherheit und Verwaltung
Weitere Beispiele für Web-Chat-Integrationen finden Sie hier.
Web-Chat-Stil und Inhalt
- Darstellung des Web-Chats anpassen
-
Wenn Sie den Stil und die Darstellung des Web-Chats über die Optionen hinaus anpassen wollen, die auf der Registerkarte Stil in den Web-Chat-Einstellungen verfügbar sind, können Sie dazu ein anderes Carbon Design-Motiv auswählen.
Die unterstützten Motive sind Farbmotive, die von IBM Carbon Designdefiniert werden. Verwenden Sie zum Festlegen des Carbon-Motivs die Konfigurationsoption
carbonTheme.Sie können auch einzelne Variablen innerhalb des Motivs festlegen, um bestimmte Benutzerschnittstellenelemente anzupassen. Der im Chatfenster angezeigte Text verwendet beispielsweise die Schriftarten
IBMPlexSans, Arial, Helvetica, sans-serif. Wenn Sie eine andere Schriftart verwenden wollen, können Sie sie mit der InstanzmethodeupdateCSSVariables()angeben. - Hauptanzeige anpassen
-
Die Hauptanzeige begrüßt den Kunden und zeigt optional eine Liste vorgeschlagener Gesprächsstarter an. Sie können den Stil und den Inhalt der Hauptanzeige anpassen:
-
Um der Hauptanzeige Elemente hinzuzufügen, können Sie mithilfe der Motivvariablen
writeableElements.homeScreenAfterStartersElementangepassten HTML-Code definieren:instance.writeableElements.homeScreenAfterStartersElement.innerHTML = '<div class="MyCustomClass">This is my custom element</div>';
Beispiel: Ein Arbeitsbeispiel, das zeigt, wie angepasste Elemente zur Hauptanzeige hinzugefügt werden, finden Sie unter Angepasste Elemente in der Hauptanzeige für watsonx Assistant-Web-Chat. -
Verwenden Sie zum Ändern der Darstellung der Hauptanzeige CSS-Helper-Klassen.
-
- Zeichenfolgen anpassen
-
Sie können die Zeichenfolgen anpassen, die die verschiedenen Bezeichnungen und fest codierten Ausdrücke definieren, die vom Web-Chat angezeigt werden. Verwenden Sie zum Anpassen von Zeichenfolgen die
updateLanguagePack()-Instanzmethode, um Zeichenfolgen im aktuellen Sprachenpaket zu ersetzen. Weitere Informationen finden Sie unter Sprachen. - Unterstützung globaler Zielgruppen
-
Die vom Web-Chat angezeigten Zeichenfolgen sind standardmäßig in Englisch. Wenn Sie zu einer anderen Sprache wechseln möchten, verwenden Sie die Instanzmethode
updateLanguagePack(), um das aktuelle Sprachenpaket durch eines der verfügbaren übersetzten Sprachenpakete zu ersetzen. Weitere Informationen finden Sie unter Globale Zielgruppen im Web-Chat unterstützen.
Web-Chat-Fenster öffnen, schließen und wiedergeben
- Standardstartprogramm ersetzen
-
Zur besseren Integration in Ihre Website können Sie das Symbol des integrierten Startprogramms durch einen anderen Mechanismus zum Öffnen des Web-Chats ersetzen. Um das Standardstartprogramm auszublenden, setzen Sie die Konfigurationsoption
showLauncherauffalse. Um den Web-Chat basierend auf einer anderen Interaktion zu öffnen, verwenden Sie dieopenWindow-Instanzmethode.
Lernprogramm: Ein Lernprogramm, das Ihnen zeigt, wie ein angepasstes Startprogramm implementiert wird, finden Sie unter Angepasstes Startprogramm verwenden. - Web-Chat immer offen halten
-
Wenn Sie möchten, dass der Web-Chat immer auf Ihrer Seite geöffnet bleibt, verwenden Sie die
openChatByDefault-Konfiguration, um die Seite bei geöffnetem Chatfenster wiederzugeben, und die OptionhideCloseButton, um zu verhindern, dass Kunden sie schließen. - Größe oder Position des Web-Chats ändern
-
Ihr Website-Design erfordert möglicherweise, dass Sie ändern, wo und wie das Web-Chat-Fenster auf Ihrer Website wiedergegeben wird. Sie können beispielsweise festlegen, dass er an einer anderen Position auf der Seite angezeigt wird, in einer anderen Größe oder in einem anderen Element auf der Seite verschachtelt wird.
Zum Ändern der Größe des Web-Chat-Fensters können Sie die Instanzmethode updateCSSVariables() verwenden, um den CSS-Stil zu ändern.
Wenn Sie die Position des Web-Chat-Fensters ändern müssen oder die Größe über die im CSS zulässigen Grenzwerte hinaus ändern müssen, können Sie ein angepasstes DOM-Element verwenden, das das Web-Chat-Fenster enthält. Verwenden Sie hierzu die Konfigurationsoption
element.
Lernprogramm: Ein Lernprogramm, das zeigt, wie der Web-Chat in einem angepassten Element wiedergegeben wird, finden Sie unter Lernprogramm: Größe und Position des Web-Chats anpassen. - Web-Chat zu Ihrer mobilen Anwendung hinzufügen
-
Sie können WebView mit einer JavaScript-Bridge verwenden, um den Web-Chat zu Ihrer mobilen Anwendung hinzuzufügen. Weitere Informationen finden Sie unter Web-Chat zu Ihrer mobilen Anwendung hinzufügen.
Dialog anpassen
- Nachrichten abfangen und ändern
-
Wenn Sie Ereignisse subskribieren, kann Ihr Code Nachrichten abfangen, die zwischen dem Kunden und dem Assistenten gesendet und empfangen werden, und sogar deren Inhalt ändern.
Abonnieren Sie das Ereignis
pre:receive, wenn Sie die Nachricht eines Kunden abfangen möchten, bevor sie an den Assistenten gesendet wird. Sie können beispielsweise personenbezogene Daten aus dem Nachrichtentext entfernen oder den Nachrichtennutzdaten Kontextvariablen hinzufügen.Abonnieren Sie das Ereignis
pre:send, wenn Sie eine eingehende Antwort vom Assistenten abfangen möchten, bevor sie dem Kunden angezeigt wird. Sie können beispielsweise Formatierungen, Links oder andere Elemente hinzufügen, die für den Web-Chat spezifisch sind.
Lernprogramm: Lernprogramm zur Verwendung des Ereignisses pre:receivezum Abfangen und Ändern eingehender Nachrichten finden Sie unter Lernprogramm: Angepasste Optionsfelder im Web-Chat implementieren. - Angepasste Antworttypen wiedergeben
-
Wenn Ihr Assistent spezialisierte Antworten mit einem angepassten Antworttyp (
user_defined) sendet, können Sie eine angepasste Ansicht implementieren, um diese Antworten im Web-Chat-Fenster anzuzeigen. Subskribieren Sie dazu das EreigniscustomResponse, das jedes Mal ausgelöst wird, wenn eineuser_defined-Antwort empfangen wird. In Ihrer Ereignishandlermethode können Sie dann den Inhalt der Antwort lesen und die Ausgabe mit Ihren eigenen Elementen wiedergeben.
Lernprogramm: Ein Lernprogramm, das zeigt, wie ein angepasster Antworttyp als Ersatz für die Standardantwort für Optionen wiedergegeben wird, finden
Sie unter Lernprogramm: Angepasste Optionsschaltflächen im Web-Chat implementieren. - Contact-Center-Integration implementieren
-
Sie können eines der Web-Chat-Starter-Kits für die Integration in eine Contact-Center-Plattform (Service-Desk) verwenden, die nicht als integrierte watsonx Assistant-Integrationen verfügbar ist. Referenzimplementierungen mit vollem Funktionsumfang sind für verschiedene Contact-Center-Plattformen verfügbar. Darüber hinaus können Sie mit einem Starter-Kit eine angepasste Integration mit der Plattform Ihrer Wahl entwickeln.
Weitere Informationen finden Sie unter Contact-Center-Support hinzufügen.
Daten verwalten
- Benutzeridentitätsinformationen verwalten
-
Der Web-Chat ordnet jeder Nachricht, die er an den Assistenten sendet, eine Benutzer-ID zu. Diese Benutzer-ID wird für benutzerbasierte Abrechnung und andere Zwecke verwendet. Sie können entweder zulassen, dass der Web-Chat eine anonyme ID für jeden Benutzer generiert, oder Sie können die Benutzer-ID selbst steuern.
Je nachdem, ob Sie die Sicherheit für den Web-Chat aktiviert haben, können Sie die Instanzmethode
updateUserIDoder die MethodeupdateIdentityTokenverwenden, um Benutzeridentitätsinformationen anzugeben.Weitere Informationen zur Angabe und Verwendung von Benutzeridentitätsinformationen finden Sie unter Benutzeridentitätsinformationen im Web-Chat verwalten.
Sicherheit und Verwaltung
- Web-Chat sichern
-
Um den Web-Chat zu schützen, können Sie JSON Web Token (JWT) verwenden, um Benutzer zu authentifizieren und private Daten zu verschlüsseln. Weitere Informationen finden Sie unter Web-Chat sichern.
- Web-Chat-Version steuern
-
Der Web-Chat-Code, der von IBM Cloud gehostet wird, wird regelmäßig mit Verbesserungen und neuen Funktionen aktualisiert. Das Einbettungsscript verwendet standardmäßig automatisch die neueste Version des Web-Chats. Um unerwartete Änderungen zu vermeiden, die sich auf Ihre Website auswirken können, können Sie steuern, welche Version des Web-Chats von Ihrer Website verwendet wird, sodass Sie jede neue Version testen können, bevor Sie in der Produktion implementieren, um unerwartete Änderungen zu vermeiden, wenn eine neue Version freigegeben wird.
Weitere Informationen zur Web-Chat-Versionssteuerung finden Sie unter Web-Chat-Version steuern.