Bot Framework Tools
The Bot Framework tools are a collection of cross-platform command line tools designed to cover end-to-end bot development workflow. This repo is part the Microsoft Bot Framework - a comprehensive framework for building enterprise-grade conversational AI experiences.
|Chatdown||Prototype mock conversations in markdown and convert the markdown to transcripts you can load and view in the new V4 Bot Framework Emulator|
|MSBot||Create and manage connected services in your bot configuration file|
|LUDown||Build LUIS language understanding models using markdown files|
|LUIS||Create and manage your LUIS.ai applications|
|QnAMaker||Create and manage QnAMaker.ai Knowledge Bases.|
|Dispatch||Build language models allowing you to dispatch between disparate components (such as QnA, LUIS and custom code)|
|LUISGen||Auto generate backing C#/Typescript classes for your LUIS intents and entities.|
Install CLI tools:
npm install -g chatdown msbot ludown luis-apis qnamaker botdispatch luisgen
- Please see here for an overview of the end-to-end bot development workflow.
- Please see here for an overview of using Bot Builder tools throughout various phases of bot development.
Bot Builder tools are designed to work with
Before writing code, review the bot design guidelines for best practices and identify the needs for your bot: will a basic bot be enough or whether it should have more sophisticated capabilities, such as speech, language understanding, QnA, or the ability to extract knowledge from different sources and provide intelligent answers. This is also the phase where you might want to create mockup of conversations between the user and the bot for the specific scenarios your bot will support. Chatdown is the tool built for this purpose. You can author .chat files that mockup the conversations and then use chatdown CLI to convert them into rich transcripts.
As you build your bot, you may also need to integrate AI services like LUIS.ai for language understanding, QnAMaker.ai for your bot to respond to simple questions in a Q&A format, and more. You can bootstrap language understanding for your bot using LUDown.
As your bot grows in sophistication, Dispatch CLI can help create and evaluate LUIS models used to dispatch intent across multiple bot modules such as LUIS models, QnA knowledge bases and others (added to dispatch as a file type).
Throughout the Build phase, you can use MSBot CLI to create and keep your bot configuration file updated with all relevant service references.
To test and refine your bot, you can use the new V4 Bot Framework Emulator. The Bot Framework Emulator is a cross-platform Electron application that enables you to test and debug your bots on local machine or in the cloud. The new emulator includes features like faster load times, an improved dynamic layout model, support for multiple bot configurations, simple bot components management, and the ability to inspect responses from connected services such as LUIS and QnA. The Bot Framework Emulator also deepens links to different parts used by the bot. The Bot Framework Emulator new functionality enables you to debug bots based on transcript logs and to view previous chat in presentation mode. The Bot Framework Emulator is available as open source on Github.
Building the tools
Run the following commands to build all tools.
npm install npm run build
Run the following command to verify your installation.
npm run test
This repository uses lerna to manage the packages included. This allows you to execute scripts for all packages or only for some packages. For instance,
lerna run test will run all tests in each package, but
lerna run test --scope chatdown will run the tests of chatdown.
To use lerna, install it as a global package with
npm install lerna --global.
Nightly builds are generated using the latest code. Therefore, they may not be stable, and most likely lack up to date documentation. These builds are better suited for more experienced users, although everyone is welcome to use them and provide feedback.
You can get the latest nightly build of MSBot from the BotBuilder MyGet feed. To install the nightly -
npm config set registry https://botbuilder.myget.org/F/botbuilder-tools-daily/npm/
Install using npm:
npm i -g chatdown msbot ludown luis-apis qnamaker botdispatch luisgen
To reset registry:
npm config set registry https://registry.npmjs.org/
This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.
When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.
Reporting Security Issues
Security issues and bugs should be reported privately, via email, to the Microsoft Security Response Center (MSRC) at email@example.com. You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Further information, including the MSRC PGP key, can be found in the Security TechCenter.
Copyright (c) Microsoft Corporation. All rights reserved.