Como usar o recurso de metadados no 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!

Etapa 1: Crie um novo widget de site

1. Navegue até Integrações e clique no botão Criar integração de widget.
2. Preencha o nome e a descrição opcional.
3. Conecte-se a um bot existente ou selecione um Backstory, Model, Dataset e Skillset.
4. Salve a integração clicando no botão Create (Criar ).

Etapa 2: Incorporar o widget em seu site

1. Clique no botão Instalar.
2. Copy the widget snippet (code).
3. Cole o snippet em seu site.

Etapa 3: inicializar o widget do ChatBotKit com metadados

Depois de instalar o widget em seu site, você pode inicializá-lo com metadados que podem ser usados para marcar suas conversas. Isso pode ser feito de forma programática usando o comando chatbotkitWidget.instance objeto.

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

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

No exemplo acima, userId e e-mail são as propriedades de metadados. Você pode substituí-las por quaisquer detalhes relevantes que queira associar à conversa.

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:

Incorporação por meio do Widget SDK

Com esse método, passamos um objeto codificado em JSON diretamente para o atributo de metadados do Widget SDK. As informações serão coletadas automaticamente e usadas para inicializar o widget.

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

Incorporação por meio do elemento Widget

Com esse método, passamos um objeto codificado em JSON diretamente para o atributo meta do elemento HTML Widget. Observe que incluímos o SDK, mas inicializamos o widget manualmente usando HTML.

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

Etapa 4: Use os metadados

Você pode usar os metadados para várias finalidades, como recuperar conversas específicas, personalizar as interações do usuário e rastrear o comportamento do usuário. Isso pode ser feito de forma programática usando restrições de filtro ao recuperar conversas. O exemplo a seguir demonstra como fazer isso com o SDK do 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.