Basics · Functions
Edit this page on GitHubFeatures
Estas são as funções mais importantes que você deve aprender ao criar fluxos ou interações dinâmicas com o bot
Add keyword
addKeyword é o ponto de partida de um fluxo de conversa, só precisa passar um array of keywords,
quando alguém escreve essas palavras-chave no chatbot, a função aciona a caixa de diálogo predefinida que você configurou.
No exemplo a seguir é estabelecido um fluxo de conversação que recebeu as palavras-chave 'hello ' e'hi',
em seguida, o chatbot enviará uma mensagem usando addAnswer com o texto 'oi, bem-vindo à minha loja incrível, como posso ajudá-lo?'
e 'a Loja oferece: sapatos, camisas, calças e chapéus'.
import { addKeyword } from '@builderbot/bot';
const mainFlow = addKeyword(['hello', 'hi'])
.addAnswer(['Hi, welcome to my amazing shop', 'how can I help you?'])
.addAnswer(['The shop has: ', 'shoes, shirts, pants, and hats'])O fluxo de conversação pode ser limitado a uma keyword específica, por exemplo, a palavra 'compra' para acionar a próxima caixa de diálogo
import { addKeyword } from '@builderbot/bot';
const mainFlow = addKeyword('buy')
.addAnswer(['Great! ', 'What do you want to buy?'])Regex
O chatbot suporta validação de regex, no exemplo a seguir um objeto é passado como o segundo parâmetro para a função addKeyword, o objeto tem uma propriedade regex definida como true e a propriedade keywords é um padrão regex.
import { addKeyword } from '@builderbot/bot';
const REGEX_GMAIL_EMAIL = /(\w+)@gmail\.com/g;
const mainFlow = addKeyword(REGEX_GMAIL_EMAIL,
{ regex: true })
.addAnswer(`Thanks for the gmail address`)Sensitive
O chatbot detecta uma palavra-chave específica em qualquer parte de uma mensagem, mas sensitive propriedade como true o chatbot acionará a caixa de diálogo se o usuário anotar exatamente o mesmo keyword.
import { addKeyword } from '@builderbot/bot';
const mainFlow = addKeyword('buy', { sensitive: true })
.addAnswer(['Great! ', 'What do you want to buy?'])Add answer
addAnswer é usado para enviar uma mensagem ao usuário, pode ser um texto simples ou um arquivo anexado.
No exemplo a seguir é estabelecido um fluxo de conversa que recebeu a palavra-chave 'hello',
em seguida, o chatbot enviará uma mensagem usando addAnswer com o texto ' oi, bem-vindo à minha loja incrível, como posso ajudá-lo?'
import { addKeyword, addAnswer } from '@builderbot/bot';
const mainFlow = addKeyword('hello')
.addAnswer('Hi, welcome to my amazing shop, how can I help you?')Existem diferentes configurações para o envio de mensagens, algumas funções como envio de arquivos, imagens, vídeo, atrasos, quebras de linha: line breaks, consecutive, delay , callback
Consecutive Messages
O chatbot pode enviar várias mensagens apenas adicionando a função addAnswer uma após a outra. No exemplo a seguir, o chatbot enviará (3) mensagens:
Hi, Welcome to my amazing shop, how can I help you? nessa ordem.
import { addKeyword, addAnswer } from '@builderbot/bot';
const mainFlow = addKeyword('hello')
.addAnswer('Hi')
.addAnswer('Welcome to my amazing shop')
.addAnswer('how can I help you?')Message with line breaks
Sempre que precisar enviar uma mensagem com quebras de linha, você pode usar uma matriz de string, como pode ver no exemplo a seguir.
import { addKeyword, addAnswer } from '@builderbot/bot';
const mainFlow = addKeyword('hello')
.addAnswer([
'Hi', 'Welcome to my amazing shop',
'how can I help you?'
])Message with delay
O chatbot pode enviar uma mensagem com um delay, basta adicionar a função addAnswer com a propriedade delay definida para a quantidade de milissegundos que deseja aguardar antes de enviar a mensagem.
import { addKeyword, addAnswer } from '@builderbot/bot';
const mainFlow = addKeyword('hello')
.addAnswer('This message will after 2 seconds',
{ delay: 2000 }
)Message with callback
Ao usar funções de retorno de chamada em um addAnswers, a operação prioriza o envio da mensagem e, em seguida, a execução da função.
import { addKeyword, addAnswer } from '@builderbot/bot';
const mainFlow = addKeyword('hello')
.addAnswer('Hi!, Do you know 4+4?', null, async (_, {flowDynamic}) => {
const sum = 4 + 4
await flowDynamic(`Total: ${sum}`)
})
.addAction(async (_, {flowDynamic}) => {
await flowDynamic(`Other message`)
})Add Action
addAction é usado para definir ações específicas como uma resposta quando uma mensagem do whatsapp foi recebida,
esta função permite acionar fluxos de conversação com base na entrada do Usuário e definir como o chatbot deve agir.
No exemplo a seguir, você pode ver como pode acionar uma função quando o usuário envia uma mensagem com a palavra-chave 'buy'.
import { addKeyword, addAction } from '@builderbot/bot';
const mainFlow = addKeyword('buy')
.addAnswer('Great! What do you want to buy?')
.addAction(async (_, { flowDynamic }): void => {
return console.log('The user wants to buy something');
})Você pode usar a função addAction com capture como você pode ver no exemplo abaixo
import { addKeyword, addAction } from '@builderbot/bot';
const mainFlow = addKeyword(['Hello', 'Hi'])
.addAction(async (_, { flowDynamic }): void => {
return flowDynamic('Hi! how can I help you?');
})
.addAction({ capture: true }, async (ctx, { flowDynamic, state }): void => {
await state.udpate({ name: ctx.body})
return console.flowDynamic(`The user said: ${ctx.body}`);
})Resources
Modularize
Learn how to modularise flows so that you can have a more maintainable bot.
Send Message
How to send a message via HTTP to start conversations, you can send multimedia as well.
Dockerizer
A good practice is to dockerise your bots to make them more maintainable and effective.
Events
Learning about events will make us more fluent when creating chatbots.