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 auf deinem Storefront durchführen kann.

Name & Beschreibung #

Gehe zu Chat > Tools und klicke auf + Add another tool, um den Tool-Editor zu öffnen. Gib dem Tool einen klaren Namen und beschreibe, wann Chat es verwenden soll.

Die Beschreibung dient als Anweisung für die KI. Sei spezifisch in Bezug auf die 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 verwenden und zu vermeiden, dass es für nicht verwandte Fragen aufgerufen wird.

Mit Ask erstellen #

Wenn du das Tool nicht selbst einrichten möchtest, bitte Ask Clerk.io, einen Webhook oder ein JavaScript-Tool vorzuschlagen. Beschreibe, was Chat tun soll, und überprüfe dann den vorgeschlagenen Namen, die Beschreibung, die Parameter und die Konfiguration, bevor du es verwendest.

Webhooks #

Wähle in Type Webhook aus. Webhook-Tools rufen deine HTTP-API auf. Verwende sie, wenn ein Dienst die Daten liefern oder die Aktion ausführen kann, die Chat benötigt, und zwar über einen Endpoint.

Parameter #

Definiere 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 fehlenden Wert.

Für jeden Parameter definiere:

• Name — Der Variablenname, der vom Endpoint oder der JavaScript-Funktion verwendet wird.
• Typ — Die Art des Werts, den Chat sammeln soll, z. B. Text oder ganze Zahl.
• Beschreibung — Was der Wert darstellt und wonach Chat den Besucher fragen soll.

Markiere einen Parameter als Required, wenn das Tool ohne ihn nicht arbeiten kann.

Endpoint #

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

Methode: Wähle GET, POST, PUT oder DELETE, je nachdem, was deine API erfordert.

URL: Gib die vollständige Endpoint-URL ein. Query-Parameter können statisch sein oder Werte verwenden, die aus dem Gespräch gesammelt wurden, mit {{parameter_name}}. Zum Beispiel:

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

Request body: Für POST- und PUT-Anfragen gib den Body im Format ein, das deine API erwartet. Du kannst hier ebenfalls Parameter verwenden.

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

Timeout: Wähle, wie lange Chat auf eine Antwort warten soll, bevor die Anfrage abgebrochen wird. Die verfügbaren Optionen reichen von 3 Sekunden bis zu 10 Minuten.

Speichern und Testen #

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

Nutze den Bereich Test unten im Editor. Gib Werte für die Parameter ein und klicke auf Test request, um die Verbindung zu überprüfen.

JavaScript #

Wähle in Type JavaScript aus. JavaScript-Tools laufen im Browser des Shoppers und können Chat mit Funktionen verbinden, die bereits auf deinem Storefront existieren, z. B.:

• Produkt zum Warenkorb hinzufügen
• Aktuellen Warenkorb auslesen
• Rabattcode anwenden
• Checkout öffnen
• Größenberater öffnen
• Ein Produkt zu einer Wunschliste speichern
• Store Locator oder Click-and-Collect-Flow öffnen

Dies sind benutzerdefinierte Aktionen, keine integrierten Operationen. Du musst jedes Tool mit der passenden Funktionalität in deinem Storefront verbinden.

Parameter #

Definiere 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 fehlenden Wert.

Für jeden Parameter definiere:

• Name — Der Variablenname, der von der JavaScript-Funktion verwendet wird.
• Typ — Die Art des Werts, den Chat sammeln soll, z. B. Text oder ganze Zahl.
• Beschreibung — Was der Wert darstellt und wonach Chat den Besucher fragen soll.

Markiere einen Parameter als Required, wenn das Tool ohne ihn nicht arbeiten kann. Lese die gesammelten Werte im args-Objekt deiner Funktion aus.

Code #

Schreibe eine asynchrone Funktion, die das Storefront ausführt, wenn Chat das Tool aufruft. Der Editor stellt der Funktion die gesammelten Argumente und den Storefront-Kontext zur Verfügung.

Nutze das args-Objekt, um die in Parameters definierten Werte auszulesen. Rufe dann den Storefront-Code auf, der die Aktion ausführt, z. B. einen Artikel zum Warenkorb hinzufügen oder den Checkout öffnen. Gib ein klares Ergebnis zurück, damit Chat dem Besucher sagen kann, was passiert ist.

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

Speichern und Testen #

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

Teste JavaScript-Tools auf einem Test- oder Vorschau-Storefront, bevor du sie für Besucher verfügbar machst. Überprüfe sowohl die Storefront-Aktion als auch die Nachricht, die Chat nach Abschluss der Aktion ausgibt.