botpress / v12

Botpress OSS – v12

Botpress — The building blocks for building chatbots

IMPORTANT: With the launch of Botpress Cloud, the documentation for Botpress v12 can now be found here.

What is Botpress?

Botpress is the standard developer stack to build, run, and improve conversational AI applications. Powered by natural language understanding, a messaging API, and a fully featured studio, Botpress allows developers and conversation designers around the globe to build remarkable chatbots without compromise.

The fastest & easiest way to get started with Botpress is by signing up for free to Botpress Cloud. Alternatively, continue reading for more information about Botpress v12.

Out of the box, Botpress v12 includes:

• Administration panel to orchestrate and monitor your chatbots
• Conversation Studio to design a conversation, manage content, code custom integration
• Easy integration with messaging channels (Messenger, WhatsApp, Slack, Teams, Webchat, Telegram, SMS & more)
• Natural Language Understanding
• Complete list of features and specs here

Getting Started

There are a few ways to get started with Botpress v12:

• Download the latest binary for your OS here and follow the installation docs.

• Use the official Docker image and follow the hosting docs

• Run from sources, follow build docs

• Deploy it in the cloud using these shortlinks:

  ---

     

Documentation

• Main Documentation
• SDK Reference
• Code Examples
• Video Tutorials

Community

• Discord - Get community support and find answers to your questions
• Issues - Report bugs and file feature requests
• Blog - How to's, case studies, and announcements
• Contributing - Start contributing to Botpress
• Partners - List of agencies who can help you with Botpress

License

Botpress is dual-licensed under AGPLv3 and the Botpress Proprietary License.

By default, any bot created with Botpress is licensed under AGPLv3, but you may change to the Botpress License from within your bot's web interface in a few clicks.

For more information about how the dual-license works and why it works that way, please see the FAQS.

v12's Issues

Facebook Messenger location

This piece of code produce the intended effect of creating a location button:

bp.hear({ text: /location/i, type: 'message' }, (event, next) => {
    payload = {
      quick_replies: [
        {
          title: 'location',
          content_type: 'location'
        }
      ],
      typing: true
    }

    bp.messenger.sendText(event.user.id, 'Where do you live?', payload)
})

But then when the user selects its location, the response from FB produces the following error:

error: Unhandled Rejection in Promise:  Promise {
  _bitField: 18087936,
  _fulfillmentHandler0:
   TypeError: Expected event to contain (type: string), (platform: string), (text: string), (raw: any)
       at Object.dispatch (/Users/pdionne/Dev/dialog/dialog-examples/node/botpress-example/node_modules/botpress/src/middlewares.js:37:13)
       at Object.sendIncoming (/Users/pdionne/Dev/dialog/dialog-examples/node/botpress-example/node_modules/botpress/src/middlewares.js:157:8)
       at /Users/pdionne/Dev/dialog/dialog-examples/node/botpress-example/node_modules/botpress-messenger/bin/webpack:/src/incoming.js:56:24
       at Array.forEach (native)
       at /Users/pdionne/Dev/dialog/dialog-examples/node/botpress-example/node_modules/botpress-messenger/bin/webpack:/src/incoming.js:55:29
       at tryCatcher (/Users/pdionne/Dev/dialog/dialog-examples/node/botpress-example/node_modules/bluebird/js/release/util.js:16:23)
       at Promise._settlePromiseFromHandler (/Users/pdionne/Dev/dialog/dialog-examples/node/botpress-example/node_modules/bluebird/js/release/promise.js:510:31)
       at Promise._settlePromise (/Users/pdionne/Dev/dialog/dialog-examples/node/botpress-example/node_modules/bluebird/js/release/promise.js:567:18)
       at Promise._settlePromiseCtx (/Users/pdionne/Dev/dialog/dialog-examples/node/botpress-example/node_modules/bluebird/js/release/promise.js:604:10)
       at Async._drainQueue (/Users/pdionne/Dev/dialog/dialog-examples/node/botpress-example/node_modules/bluebird/js/release/async.js:143:12)
       at Async._drainQueues (/Users/pdionne/Dev/dialog/dialog-examples/node/botpress-example/node_modules/bluebird/js/release/async.js:148:10)
       at Immediate.Async.drainQueues [as _onImmediate] (/Users/pdionne/Dev/dialog/dialog-examples/node/botpress-example/node_modules/bluebird/js/release/async.js:17:14)
       at tryOnImmediate (timers.js:543:15)
       at processImmediate [as _immediateCallback] (timers.js:523:5),
  _rejectionHandler0: undefined,
  _promise0: undefined,
  _receiver0: undefined } Reason: TypeError: Expected event to contain (type: string), (platform: string), (text: string), (raw: any)
    at Object.dispatch (/Users/pdionne/Dev/dialog/dialog-examples/node/botpress-example/node_modules/botpress/src/middlewares.js:37:13)
    at Object.sendIncoming (/Users/pdionne/Dev/dialog/dialog-examples/node/botpress-example/node_modules/botpress/src/middlewares.js:157:8)
    at /Users/pdionne/Dev/dialog/dialog-examples/node/botpress-example/node_modules/botpress-messenger/bin/webpack:/src/incoming.js:56:24
    at Array.forEach (native)
    at /Users/pdionne/Dev/dialog/dialog-examples/node/botpress-example/node_modules/botpress-messenger/bin/webpack:/src/incoming.js:55:29
    at tryCatcher (/Users/pdionne/Dev/dialog/dialog-examples/node/botpress-example/node_modules/bluebird/js/release/util.js:16:23)
    at Promise._settlePromiseFromHandler (/Users/pdionne/Dev/dialog/dialog-examples/node/botpress-example/node_modules/bluebird/js/release/promise.js:510:31)
    at Promise._settlePromise (/Users/pdionne/Dev/dialog/dialog-examples/node/botpress-example/node_modules/bluebird/js/release/promise.js:567:18)
    at Promise._settlePromiseCtx (/Users/pdionne/Dev/dialog/dialog-examples/node/botpress-example/node_modules/bluebird/js/release/promise.js:604:10)
    at Async._drainQueue (/Users/pdionne/Dev/dialog/dialog-examples/node/botpress-example/node_modules/bluebird/js/release/async.js:143:12)
    at Async._drainQueues (/Users/pdionne/Dev/dialog/dialog-examples/node/botpress-example/node_modules/bluebird/js/release/async.js:148:10)
    at Immediate.Async.drainQueues [as _onImmediate] (/Users/pdionne/Dev/dialog/dialog-examples/node/botpress-example/node_modules/bluebird/js/release/async.js:17:14)
    at tryOnImmediate (timers.js:543:15)
    at processImmediate [as _immediateCallback] (timers.js:523:5)
14:23:49 - error: TypeError: Expected event to contain (type: string), (platform: string), (text: string), (raw: any)
    at Object.dispatch (/Users/pdionne/Dev/dialog/dialog-examples/node/botpress-example/node_modules/botpress/src/middlewares.js:37:13)
    at Object.sendIncoming (/Users/pdionne/Dev/dialog/dialog-examples/node/botpress-example/node_modules/botpress/src/middlewares.js:157:8)
    at /Users/pdionne/Dev/dialog/dialog-examples/node/botpress-example/node_modules/botpress-messenger/bin/webpack:/src/incoming.js:56:24
    at Array.forEach (native)
    at /Users/pdionne/Dev/dialog/dialog-examples/node/botpress-example/node_modules/botpress-messenger/bin/webpack:/src/incoming.js:55:29
    at tryCatcher (/Users/pdionne/Dev/dialog/dialog-examples/node/botpress-example/node_modules/bluebird/js/release/util.js:16:23)
    at Promise._settlePromiseFromHandler (/Users/pdionne/Dev/dialog/dialog-examples/node/botpress-example/node_modules/bluebird/js/release/promise.js:510:31)
    at Promise._settlePromise (/Users/pdionne/Dev/dialog/dialog-examples/node/botpress-example/node_modules/bluebird/js/release/promise.js:567:18)
    at Promise._settlePromiseCtx (/Users/pdionne/Dev/dialog/dialog-examples/node/botpress-example/node_modules/bluebird/js/release/promise.js:604:10)
    at Async._drainQueue (/Users/pdionne/Dev/dialog/dialog-examples/node/botpress-example/node_modules/bluebird/js/release/async.js:143:12)
    at Async._drainQueues (/Users/pdionne/Dev/dialog/dialog-examples/node/botpress-example/node_modules/bluebird/js/release/async.js:148:10)
    at Immediate.Async.drainQueues [as _onImmediate] (/Users/pdionne/Dev/dialog/dialog-examples/node/botpress-example/node_modules/bluebird/js/release/async.js:17:14)
    at tryOnImmediate (timers.js:543:15)
    at processImmediate [as _immediateCallback] (timers.js:523:5)

[create modules] Exclude react from the bundle by default

In the default webpack.js file, exclude React (and ReactDOM) from the bundle. The reason is because if we don't there's two different versions of React running concurrently, causing issues with ReactDOM

Throw when calling getRouter with an invalid router name

Routers must start with botpress- otherwise they aren't working. This is by design.

We should:

1. Also add bp- as a valid router prefix
2. Throw when calling getRouter with an invalid name
3. Add this restriction in the getRouter documentaton

Error When I Click ngrok

I get this error when I click the ngrok checkbox (windows)

12:09:24 - error: (fatal) An unhandled exception occured in your bot Error: spawn ./ngrok.exe ENOENT at exports._errnoException (util.js:1026:11) at Process.ChildProcess._handle.onexit (internal/child_process.js:193:32) at onErrorNT (internal/child_process.js:359:16) at _combinedTickCallback (internal/process/next_tick.js:74:11) at process._tickCallback (internal/process/next_tick.js:98:9) 12:09:24 - error: Error: spawn ./ngrok.exe ENOENT at exports._errnoException (util.js:1026:11) at Process.ChildProcess._handle.onexit (internal/child_process.js:193:32) at onErrorNT (internal/child_process.js:359:16) at _combinedTickCallback (internal/process/next_tick.js:74:11) at process._tickCallback (internal/process/next_tick.js:98:9)

why bluebird over native promise?

I think bluebird can be replaced with native promise of ES6.

Prefix logger messages by the calling module name

Separate official / community / local modules in `/manage`

Show module tags in `/manage`

Add current botpress version on bot start

Make it possible for modules to have a custom icon

Integrate with Botkit

Botpress lacks conversation management, we should have an easy Botkit support built-in

License?

The site says, it is dual licensed. But, here at github, only AGPL is mentioned, which is useless for commercial use of most kinds and completely unlike WordPress for that matter. What's the other license under the dual license that is advertised on the official website?

Thanks!

Standardize react-bootstrap styling in the global theme

On module load error (in the UI), fix the broken link

The "click here" leads nowhere

Testing new CLA

Add a global UI alert (toast) feature that modules can easily use

modules should be able to use something like:

this.props.bp.alert('info', 'Config saved successfully')

Check if there's a newer version of botpress available

Testing CLA

Show local modules in `/manage`

Watch code and run

Hey!
I'm having a lot of fun while playing with botpress. really cool idea and implementation.

I offer a feature, but there is a chance i can do it and just need to RTFM.

Instead of run bp start each time i change my code, the process will watch my code and restart/update himself.

tnx

Add default README in created bots

Show if project has outdated modules + update button

Modules sorting in `/manage`

Implement simple users Key-Value store

Allow to easily store and retrieve user data

Error on windows

Once I bp init i get this error

name: (kk) (node:6784) UnhandledPromiseRejectionWarning: Unhandled promise rejection (rejection id: 1): Error: Error while obtaining machine id: Error: Command failed: REG QUERY HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Cryptography /v MachineGuid
ERROR: The system was unable to find the specified registry key or value.

Add a changelog file to the repo

Document on how to use transpiled code with botpress

This shouldn't be a problem for many but it would be convenient to document on how to use transpiled code with a botpress application, allowing use of things like import/export or async/await in the node.js part of the codebase.

I'd be happy to document this in a separate .md on the Advanced Topics, for example. Let me know if this kind of thing is desirable and, if so, I'll submit a quick PR with a babel example.

minify web.bundle.js

The actual web.bundle.js file is 3.3MB, which is huge. A simple JS minification of the web.bundle.js code could reduce to 1.1MB ... which is significantly better.

Just adding the following plugin to webpack.js :

new webpack.optimize.UglifyJsPlugin({ compress: { warnings: false } })

Would you want a PR for this?

Make modules style.scss load the bot's theme.scss

use yarn \o/

yarn is much faster than npm

Search modules per tag (`/manage`)

Make it possible to overwrite the default theme colors

Add menu item modules extension point

Install & Uninstall local modules (`/manage`)

Add modules_config to gitignore by default

Onboard users on their first visit (`/#guided-tour`)

After a module is initialized, run "npm install" automatically and instruct them to run "npm run watch" to compile the module

On bot start, display loaded modules and their version

Display bot's current time and allow Time zone override

In node, setting the TZ environment variable will override the Timezone. We should:

1. Add the current timezone in the menu
2. Allow to change the current TZ by setting environment variable and restarting the bot
3. We should have a Settings panel

Make it possible for bots to replace the botpress logo by their own logo

botpress + rasa NLU

Very excited about botpress. I'd love to see an integration with rasa NLU as well!

Add topbar modules extension point

Add module pre-publish script with instructions & CLA form

Testing CLA

Add default README in created modules

Add a bot deployment guide for AWS / Azure / etc

Make it possible to create interfaceless modules

Add a module creation guide

Explain how to create a simple module from scratch

Botpress changes cwd, causing issues with node-config

When Botpress is used with node-config, the config path is set to WARNING: No configurations found in configuration directory: <...>/node_modules/botpress/config. This causes node-config not to find its own configuration files.

For others having this issue: easy to work around by overriding process.env.NODE_CONFIG_DIR using something like

var path = require('path')
process.env.NODE_CONFIG_DIR = path.resolve(process.cwd()+'/../../config')

Since, for this case there is an easy (albeit hacky) workaround I believe this should be considered as low priority.

However, there may be other modules relying on process.cwd() which will then likely experience similar breaking issues. A proper fix then might be to avoid having process.cwd changed to the botpress dir inside node_modules.

Make it possible to hide the community heroes section in the botfile