Start here · Concepts

Edit this page on GitHub

Concepts

La biblioteca se basa en tres componentes clave para su correcto funcionamiento: el Flujo, encargado de construir el contexto de la conversación y ofrecer una interfaz amigable al desarrollador; el Proveedor, que actúa como conector permitiendo cambiar fácilmente entre proveedores de WhatsApp sin riesgo de afectar a otras partes del bot; y la Base de datos, que en consonancia con esta filosofía de conector, facilita cambiar la capa de persistencia de datos sin necesidad de reescribir el flujo de trabajo.

Diagram

Flow

Se refiere a crear secuencias estructuradas de interacciones, como en la creación de flujos de conversación. Dos métodos clave son addKeyword y addAnswer, que permiten asociar palabras clave con respuestas específicas, proporcionando opciones para personalizar el flujo de la conversación.

import { addKeyword } from '@builderbot/bot'

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

Algunos ejemplos de cómo usar la Palabra clave add en la que puede colocar la keyword o una lista de keywords que se usarán para iniciar un flujo conversacional

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

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

Para una rápida comprensión de la operación, hemos preparado un ejemplo básico de cómo implementar


Provider

Es una pieza clave utilizada para entregar el mensaje al proveedor elegido. En el caso de que esté creando un bot para whatsapp, debe usar un adaptador como Meta, Twilio, Baileys, etc. o incluso si desea conectarse a 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

Just as providers can be easily exchanged between adapters, we can do the same with the database. Now the important thing to understand is how it works. The main purpose of the database inside the bot is to provide the bot with a record of the different events that have occurred between different conversations.

Está listo para implementar adaptadores de Mongo, MySQL, Postgres, entre otros.

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.