Compreendendo os tipos de dados para variáveis
Antes de mergulharmos nos aspectos práticos do uso das variáveis, vamos nos familiarizar com os diferentes tipos de dados disponíveis no Botpress.
- Corda: Strings são usadas para armazenar o texto que pode consistir em letras, números ou caracteres especiais. Eles são comumente usados para armazenar nomes de usuários ou mensagens geradas por IA.
- Boleano: Booleanos só podem conter dois valores – verdadeiro ou falso. Eles são ideais para armazenar informações binárias, como se um usuário é um cliente recorrente ou se deseja perguntar outra coisa.
- Número: Como o nome sugere, as variáveis numéricas são usadas para armazenar valores numéricos que podem ser inteiros ou números com casas decimais. Eles são úteis para armazenar números de telefone, códigos de área e outros dados numéricos.
- Data: As variáveis de data usam o formato de data/hora ISO 8601. Representa uma única data ou uma data e hora.
- Objeto: Uma variável de objeto é uma coleção de pares de valores-chave semelhantes aos dicionários ou mapas. Eles são valiosos para armazenar estruturas de dados complexas, como perfis de usuário ou resultados de uma chamada de API.
- Variedade: Os arrays são usados para armazenar coleções de variáveis semelhantes. Eles podem conter strings ou objetos, tornando-os versáteis para vários casos de uso, como armazenar mensagens anteriores de um usuário ou fornecer opções para o usuário escolher.
- Enum: Esta é uma variável com um conjunto limitado de opções predefinidas. Eles são adequados para cenários como armazenar os dias da semana ou os itens disponíveis em um cardápio alimentar.
- Padrão: As variáveis de padrão utilizam Expressões Regulares (Regex) para armazenar os padrões especiais que podem ser usados para combinar palavras ou números específicos. Eles são úteis para armazenar números de contas ou números de voos.
Compreendendo os escopos das variáveis
Vários tipos de variáveis estão incluídos no Botpress e variam dependendo de onde podem ser acessíveis no fluxo do seu chatbot. Vamos explorar os diferentes escopos de variáveis, começando do mais limitado ao mais amplo:
Variáveis de fluxo de trabalho
Essas variáveis são definidas e usadas em um único fluxo de trabalho ou no mesmo fluxo de trabalho. Eles são excelentes para fluxos de uso único, como armazenamento de resultados de tarefas de IA, respostas de usuários a perguntas ou organização de dados de chamadas de API.
Estas etapas podem ser seguidas para criar uma variável de fluxo de trabalho:
Passo 1. Selecione o fluxo de trabalho apropriado no menu “Explorador”.
Passo 2. Clicar duas vezes em uma área vazia no editor de fluxo de trabalho abre o painel Inspetor.
Etapa 3. Especifique o nome da variável, escolha o tipo de dados da variável e clique no botão “Adicionar” para criar a variável.
Você pode adicionar um valor padrão (inicial) à sua variável na seção “Configurações adicionais”.
Variáveis de fluxo de trabalho de entrada e saída
Para trocar informações, os fluxos de trabalho podem ter variáveis de entrada e saída. As entradas são usadas para receber informações de fontes externas ou outros fluxos de trabalho, enquanto as saídas fornecem informações para fontes externas ou outros fluxos de trabalho. Isso permite comunicação e troca de dados mais flexíveis dentro do bot.
Estas etapas podem ser seguidas para marcar uma variável de entrada:
Passo 1. Crie a variável dentro do fluxo de trabalho.
Passo 2. Selecione a variável clicando no nó de entrada do fluxo de trabalho no painel Inspetor.
Estas etapas podem ser seguidas para marcar uma variável de saída:
Passo 1. Crie a variável dentro do fluxo de trabalho.
Passo 2. Selecione a variável clicando no nó de saída do fluxo de trabalho no painel Inspetor.
Variáveis de sessão
Todos os fluxos podem acessar essas variáveis, mas apenas para uma única conversa. Eles são ideais para armazenar os dados usados durante uma conversa, como histórico de bate-papo, itens coletados em um carrinho de compras virtual ou dados temporários de chamadas de API.
Para criar uma variável de sessão, você pode escrever o seguinte código:
session.variablename = 'Olá, pessoal!' ;Para usar sua variável em um cartão de texto, precisamos fechá-la entre chaves, por exemplo, {{sessão.nomedavariável}} .
Variáveis de usuário
As variáveis do usuário seguem um usuário entre conversas, o que permite que os dados persistam em múltiplas interações com o chatbot. Eles são perfeitos para armazenar informações que permanecem relevantes para o usuário ao longo do tempo, como detalhes pessoais, tags de conversas anteriores ou preferências de idioma.
Para criar uma variável de usuário:
Passo 1. Abra as “Configurações do Chatbot” no ícone do Botpress localizado no canto superior esquerdo.
Passo 2. Selecione “Variáveis” nas guias.
Etapa 3. Defina a variável de usuário nomeando-a e especificando o tipo de dados.
@user.variablename ou {{user.variablename}} podem ser usados para se referir à variável “Usuário” em um cartão de texto.
Variáveis de bot
Todos os usuários do chatbot têm acesso a essas variáveis em todas as conversas. Eles são frequentemente usados para armazenar informações e configurações do desenvolvedor, como armazenar endpoints para chamadas de API, o número da versão do bot ou seu nome.
Siga estas etapas para criar uma variável Bot:
Passo 1. Selecione “Configurações do Chatbot” clicando no ícone Botpress no canto superior esquerdo.
Passo 2. Selecione “Variáveis” nas guias.
Etapa 3. Especifique o nome e o tipo de dados da variável do bot.
Assim como as variáveis de usuário, @bot.variablename ou bot.variablename podem ser usados para se referir a variáveis de bot nos cartões.
Variáveis de configuração
Eles são um tipo especial de variável de bot segura. Você pode gerenciá-los no Cloud Dashboard e não há necessidade de abrir o bot. As variáveis de configuração são ideais para armazenar informações confidenciais, como tokens de API, endereços IP privados ou credenciais de banco de dados.
Para criar uma variável de configuração:
Passo 1. Abra as “Configurações do Chatbot” no ícone do Botpress localizado no canto superior esquerdo.
Passo 2. Clique na aba “Variáveis”.
Etapa 3. Adicione uma variável de configuração e forneça seu nome e valor.
Para acessar as variáveis de configuração no código, você pode usar “env.key” onde “key” representa o nome da variável de configuração a ser recuperada.
Usando variáveis no código
As chaves “{{ }}” ou o símbolo @ não são necessários ao usar variáveis no código. A sintaxe de acesso às variáveis no código segue o padrão “variabletype.variablename”. Por exemplo:
Código:
- fluxo de trabalho.phoneNumber
- sessão.userAcctId
- usuário.primeiroNome
- bot.endpoint
- env.apiKey
As variáveis podem ser atribuídas com valores ou atualizadas no código. Mas é crucial garantir que o valor atribuído corresponda ao tipo de dados da variável para evitar erros.
Conclusão
As variáveis são os blocos de construção das interações dinâmicas e personalizadas no Botpress. Ao usar os vários tipos de dados e compreender os escopos das variáveis, os desenvolvedores podem criar chatbots com recursos poderosos. Se você precisa armazenar as informações do usuário, conectar-se com APIs ou passar os dados entre fluxos de trabalho e variáveis no Botpress, forneça a flexibilidade e o controle necessários.