Code Monkey home page Code Monkey logo

formflowbotbuilder's Introduction

unofficial Google Analytics for GitHub

Synopsis

FormFlow for Microsoft BotBuilder Node.js SDK. C# BotBuilder SDK has a cool feature called FormFlow. This feature allows you to generate a Dialog tree for your chatbot in order to get some responses back from the user.

Code Example

You start by specifying a JSON file that will contain the question/answer series for your chatbot. Pay special attention to the ordering, as this is the exact order that the questions will be asked by the bot.

[
    {
        "id": "firstname",
        "prompt": "please enter a name",
        "response": "Your name is %s",
        "errorPrompt": "please enter a string of > 0 characters",
        "type": "text"
    },
    {
        "id": "language",
        "prompt": "please select a language",
        "response": "Your favorite programming language is %s",
        "errorPrompt": "please select one of the choices",
        "type": "choice",
        "choices": "JavaScript|TypeScript|CoffeeScript"
    },
    {
        "id": "email",
        "prompt": "please enter an email",
        "response": "Your email is %s",
        "errorPrompt": "please enter a valid email",
        "type": "email"
    },
    {
        "id": "url",
        "prompt": "please enter a website (starting with http:// or https://)",
        "response": "Your url is %s",
        "errorPrompt": "please enter a valid website",
        "type": "url"
    }
]

You need to specify

  • id: that is the name of the field you want to get filled by the user
  • prompt: the question to be asked to the user
  • response: the response the bot will give to the user
  • errorPrompt: the error to be described at the user
  • type: this can be 'text','email','number','url','time','choice'
  • choices: this only work for the 'choice' type, you specify the choices separated by a pipe

Motivation

The absense of a FormFlow library for the Node.js BotBuilder SDK.

Installation

Create a new bot and get the libraries using npm

npm init
npm install --save botbuilder
npm install --save formflowbotbuilder

Create a new sampledata.json file and insert the necessary steps using the format we described above. Create a file called app.js

const builder = require('botbuilder');
const formflowbotbuilder = require('formflowbotbuilder');

const connector = new builder.ConsoleConnector().listen();
const bot = new builder.UniversalBot(connector);

//just a name for the dialog
const myDialogName = 'getFields';

formflowbotbuilder.executeFormFlow('./sampledata.json', bot, myDialogName, function (err, responses) {
  if (err) {
    console.log(err);
  } else {
    bot.dialog('/', [function (session) {
      session.beginDialog(myDialogName);
    },
      function (session, results) {
            // responses from the user are in results variable as well as in the responses callback argument
        session.send('results: ' + JSON.stringify(responses));
      }]);
  }
});

License

MIT

More info

Check out the blog post here

formflowbotbuilder's People

Contributors

dgkanatsios avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.