Werkzeuge

Tools erweitern, was Chat während eines Gesprächs tun kann. Ein Webhook kann Live-Daten von einem externen Dienst abrufen, während ein JavaScript-Tool Code im Browser des Shoppers ausführen und eine Aktion in Ihrem Storefront durchführen kann.

Name & Beschreibung #

Gehen Sie zu Chat > Tools und klicken Sie auf + Add another tool, um den Tool-Editor zu öffnen. Geben Sie dem Tool einen klaren Namen und beschreiben Sie, wann Chat es verwenden soll.

Die Beschreibung dient als Anweisung für die KI. Seien Sie spezifisch bezüglich der Situation, die das Tool auslösen soll. Zum Beispiel:

“Wenn ein Kunde nach einer Bestellung fragt, verwende die in product_data verfügbaren Bestelldaten, um Informationen zu seiner Bestellung bereitzustellen.”

Eine klare Beschreibung hilft Chat, das Tool korrekt zu nutzen und zu vermeiden, dass es für nicht zusammenhängende Fragen aufgerufen wird.

Mit Ask erstellen #

Falls Sie das Tool nicht selbst einrichten möchten, bitten Sie Ask Clerk.io, einen Vorschlag für ein Webhook- oder JavaScript-Tool zu machen. Beschreiben Sie, was Chat tun soll, überprüfen und bestätigen Sie dann den vorgeschlagenen Namen, die Beschreibung, die Parameter und die Konfiguration, bevor Sie es verwenden.

Webhooks #

Wählen Sie in Type Webhook aus. Webhook-Tools rufen Ihre HTTP-API auf. Verwenden Sie sie, wenn ein Dienst die Daten bereitstellen oder die Aktion ausführen kann, die Chat über einen Endpunkt benötigt.

Parameter #

Definieren Sie die Werte, die Chat benötigt, bevor das Tool ausgeführt werden kann. Chat sammelt diese Werte aus dem Gespräch und fragt den Besucher nach jedem erforderlichen, noch fehlenden Wert.

Definieren Sie für jeden Parameter:

• Name — Der Variablenname, der vom Endpunkt oder der JavaScript-Funktion verwendet wird.
• Type — Die Art von Wert, den Chat erfassen soll, wie Text oder Ganzzahl.
• Description — Was der Wert darstellt und wofür Chat den Besucher fragen soll.

Markieren Sie einen Parameter als Required, wenn das Tool ohne ihn nicht funktionieren kann.

Endpoint #

Konfigurieren Sie die HTTP-Anfrage, die Chat sendet, wenn ein Webhook-Tool ausgeführt wird.

Method: Wählen Sie GET, POST, PUT oder DELETE, je nachdem, was Ihre API erfordert.

URL: Geben Sie die vollständige Endpunkt-URL ein. Abfrageparameter können statisch sein oder mit Werten aus dem Gespräch mit {{parameter_name}} befüllt werden. Zum Beispiel:

https://api.example.com/orders?email={{email}}&id={{order_number}}

Request body: Für POST- und PUT-Anfragen geben Sie den Body im von Ihrer API erwarteten Format ein. Auch hier können Sie Parameter verwenden.

Custom headers: Fügen Sie alle Header hinzu, die Ihre API benötigt, z.B. Authentifizierungs-Tokens oder Content-Type-Overrides.

Timeout: Legen Sie fest, wie lange Chat auf eine Antwort warten soll, bevor aufgegeben wird. Die verfügbaren Optionen reichen von 3 Sekunden bis zu 10 Minuten.

Speichern und Testen #

Wenn das Tool bereit ist, klicken Sie auf Save oder Save & Close.

Nutzen Sie den Bereich Test unten im Editor. Geben Sie Werte für die Parameter ein und klicken Sie auf Test request, um die Verbindung zu prüfen.

JavaScript #

Wählen Sie in Type JavaScript aus. JavaScript-Tools laufen im Browser des Shoppers und können Chat mit Funktionen verbinden, die bereits in Ihrem Storefront existieren, wie zum Beispiel:

• ein Produkt in den Warenkorb legen
• den aktuellen Warenkorb auslesen
• einen Rabattcode anwenden
• den Checkout öffnen
• eine Größentabelle öffnen
• ein Produkt zur Wunschliste speichern
• einen Filialfinder oder Click-and-Collect-Prozess öffnen

Dies sind benutzerdefinierte Aktionen, keine eingebauten Vorgänge. Sie müssen jedes Tool mit der entsprechenden Funktionalität in Ihrem Storefront verbinden.

Parameter #

Definieren Sie die Werte, die Chat benötigt, bevor das Tool ausgeführt werden kann. Chat sammelt diese Werte aus dem Gespräch und fragt den Besucher nach jedem erforderlichen, noch fehlenden Wert.

Definieren Sie für jeden Parameter:

• Name — Der Variablenname, der von der JavaScript-Funktion verwendet wird.
• Type — Die Art von Wert, den Chat erfassen soll, wie Text oder Ganzzahl.
• Description — Was der Wert darstellt und wofür Chat den Besucher fragen soll.

Markieren Sie einen Parameter als Required, wenn das Tool ohne ihn nicht funktionieren kann. Lesen Sie die gesammelten Werte im args-Objekt Ihrer Funktion aus.

Code #

Schreiben Sie eine asynchrone Funktion, die im Storefront ausgeführt wird, wenn Chat das Tool aufruft. Der Editor stellt der Funktion die gesammelten Argumente und den Storefront-Kontext bereit.

Nutzen Sie das args-Objekt, um die in Parameters definierten Werte auszulesen. Rufen Sie dann den Storefront-Code auf, der die Aktion ausführt, wie z.B. das Hinzufügen eines Artikels zum Warenkorb oder das Öffnen des Checkouts. Geben Sie ein klares Ergebnis zurück, damit Chat dem Besucher mitteilen kann, was passiert ist.

Der genaue JavaScript-Code hängt von Ihrem Storefront ab. Stellen Sie sicher, dass die Funktion fehlende, ungültige oder nicht verfügbare Werte sicher behandelt.

Speichern und Testen #

Wenn das Tool bereit ist, klicken Sie auf Save oder Save & Close.

Testen Sie JavaScript-Tools auf einem Test- oder Vorschau-Storefront, bevor Sie sie Besuchern zur Verfügung stellen. Überprüfen Sie sowohl die Storefront-Aktion als auch die Nachricht, die Chat nach Abschluss der Aktion anzeigt.