Start here · Concepts

Edit this page on GitHub

Concepts

A biblioteca baseia-se em três componentes fundamentais para o seu correcto funcionamento: o fluxo, encarregado de construir o contexto da conversa e de oferecer uma interface amigável ao programador; o fornecedor, que actua como um conector que permite alternar facilmente entre os fornecedores do WhatsApp sem o risco de afectar outras partes do bot; e a base de dados, que em consonância com esta filosofia do conector, facilita a alteração da camada de persistência de dados sem a necessidade de reescrever o fluxo de trabalho.

Diagram

Flow

Refere-se à criação de sequências estruturadas de interações, como na construção de fluxos de conversação. Dois métodos principais são addKeyword e addAnswer, que permitem que palavras-chave sejam associadas a respostas específicas, fornecendo opções para personalizar o fluxo da conversa.

import { addKeyword } from '@builderbot/bot'

addKeyword(['hello','hi']).addAnswer('Ey! welcome')

Alguns exemplos de como usar a palavra-chave add na qual você pode colocar a __keyword__ou uma lista de keywords que será usada para iniciar um fluxo de conversação

// Example with single keyword
addKeyword('hello').addAnswer('Ey! welcome')

// Example with multi keywords
addKeyword(['hello','hi']).addAnswer('Ey! welcome')

Para uma rápida compreensão da operação, preparamos um exemplo básico de como implementar


Provider

É uma peça-chave usada para entregar a mensagem ao fornecedor escolhido. No caso de você estar construindo um bot para o whatsapp, você deve usar um adaptador como Meta, Twilio, Baileys, etc ou mesmo se quiser se conectar ao Telegram.

import { addKeyword, MemoryDB, createProvider, createFlow } from '@builderbot/bot'
import { BaileysProvider } from '@builderbot/provider-baileys'

// ...stuff code...

const main = async () => {
    
    await createBot({
        database: new MemoryDB(),
        provider: createProvider(BaileysProvider),
        flow: createFlow([flowDemo])
    })
}

main()

Database

Assim como os fornecedores podem ser facilmente trocados entre adaptadores, podemos fazer o mesmo com a base de dados. Agora, o importante a entender é como funciona. O principal objetivo do banco de dados dentro da inicialização é fornecer ao bot um registro dos diferentes eventos que ocorreram entre diferentes conversas.

Está pronto para implementar adaptadores de Mongo, MySQL, Postgres, entre outros.

import { addKeyword, MemoryDB, createProvider, createFlow } from '@builderbot/bot'
import { BaileysProvider } from '@builderbot/provider-baileys'

// ...stuff code...

const main = async () => {
    
    await createBot({
        database: new MemoryDB(),
        provider: createProvider(BaileysProvider),
        flow: createFlow([flowDemo])
    })
}

main()

Guides

My first chatbot

Learn how build your first chatbot in few minutes

Read more

Concepts

Understand the essential concepts for building bots

Read more

Add Functions

The key to learning how to write flows is add-functions.

Read more

Plugins

Unlimitate and start implementing the community plugins.

Read more

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.