Comment utiliser les méta-données dans le ChatBotKit Widget ?

Welcome to our comprehensive guide on how to utilize the meta-data feature in the ChatBotKit AI Widget. This feature allows you to tag and track your conversations effectively, leading to improved user interactions and behavior analysis. Below, we will walk you through the process from creating a new website widget, to embedding it into your website, initializing the widget with meta-data, using and updating the meta-data. Let's get started!

Étape 1 : Créer un nouveau widget pour le site web

1. Naviguez vers Intégrations et cliquez sur le bouton Créer une intégration de widget.
2. Remplissez le nom et la description facultative.
3. Connectez-vous à un bot existant ou sélectionnez une histoire, un modèle, un ensemble de données et un ensemble de compétences.
4. Enregistrez l'intégration en cliquant sur le bouton Créer.

Étape 2 : Intégrer le widget dans votre site web

1. Cliquez sur le bouton Installer.
2. Copy the widget snippet (code).
3. Collez l'extrait sur votre site web.

Étape 3 : Initialiser le widget ChatBotKit avec des métadonnées

Une fois le widget installé sur votre site web, vous pouvez l'initialiser avec des métadonnées qui peuvent être utilisées pour étiqueter vos conversations. Cette opération peut être réalisée de manière programmatique à l'aide de la fonction chatbotkitWidget.instance objet.

Here's an example of initializing the widget with metadata:

chatbotkitWidget.instance.meta = {
  userId: "1234",
  email: "user@example.com",
  // other relevant details
}

Dans l'exemple ci-dessus, ID utilisateur et courriel sont les propriétés des métadonnées. Vous pouvez les remplacer par tout détail pertinent que vous souhaitez associer à la conversation.

Alternatively you can pass the meta-data right inside the properties when embedding the widget SDK. Here are two additional methods you can use for that:

Intégration via le SDK Widget

Avec cette méthode, nous transmettons un objet encodé JSON directement dans l'attribut de métadonnées du Widget SDK. L'information sera récupérée automatiquement et utilisée pour initialiser le widget.

<script src="https://static.chatbotkit.com/integrations/widget/v2.js" data-widget="{WIDGET_ID}" data-meta="{&quot;userId&quot;: &quot;123&quot;}"></script>

Intégration via l'élément Widget

Avec cette méthode, nous passons un objet encodé JSON directement dans l'attribut meta de l'élément HTML Widget. Notez que nous incluons le SDK mais que nous initialisons le widget manuellement en utilisant le HTML.

<script src="https://static.chatbotkit.com/integrations/widget/v2.js"></script>
<chatbotkit-widget widget="{WIDGET_ID}" meta="{&quot;userId&quot;: &quot;123&quot;}"/>

Étape 4 : Utiliser les métadonnées

Vous pouvez utiliser les métadonnées à diverses fins, notamment pour récupérer des conversations spécifiques, personnaliser les interactions avec les utilisateurs et suivre leur comportement. Cela peut se faire de manière programmatique en utilisant des contraintes de filtrage lors de la récupération des conversations. L'exemple suivant montre comment procéder avec le SDK Note.

import ChatBotKit from '@chatbotkit/sdk'

const cbk = new ChatBotKit({ secret: process.env.CHATBOTKIT_API_SECRET })

for await (const conversation of cbk.conversation.list({ meta: { userId: '123' } })) {
  // do something with the conversation
}

By following these steps, you can effectively use ChatBotKit's metadata feature to enhance your chatbot's functionality and have better way to retrieve conversations associated with your users.