Click here to find out what's new with Bot Framework

Bot Framework SDK

The Bot Framework SDK v4, part of the Bot Framework, provides the most comprehensive experience for building conversation applications. With the Bot Framework SDK, developers can easily model and build sophisticated conversation using their favorite programming languages. With the Bot Framework SDK, you can build bots that converse free-form or your bot can also have more guided interactions where it provides the user choices or possible actions. The conversation can use simple text or more complex rich cards that contain text, images, and action buttons. You can add natural language interactions and questions and answers, which let your users interact with your bots in a natural way.

Checkout the Bot Framework ecosystem section to learn more about other tooling and services related to the Bot Framework SDK.

Quicklinks

| C# Repo | JS Repo | Python Repo | Java Repo | BF CLI |

Overview

The Bot Framework SDK v4 is an open source SDK that enable developers to model and build sophisticated conversation using their favorite programming language.

	C#	JS	Python	Java
Stable Release	4.8	4.8	4.9	4.6.0 (preview4)
Docs	docs	docs	docs
Samples	.NET Core, WebAPI	Node.js , TypeScript, es6	Python

Bot Framework SDK v4 preview features

• Adaptive Dialog | docs | C# samples :: Adaptive Dialogs enable developers to build conversations that can be dynamically changed as the conversation progresses. Traditionally developers have mapped out the entire flow of a conversation up front, which limits the flexibility of the conversation. Adaptive dialogs allow them to be more flexible, to respond to changes in context and insert new steps or entire sub-dialogs into the conversation as it progresses. Additionally as with other SDK V4 concepts, we have defined adaptive dialogs such that they can be defined via declarative that are interpreted at runtime; which allows us to have tooling on top of this and integrate with services.

• Language Generation | docs | C# samples :: Learning from our customers experiences and bringing together capabilities first implemented by Cortana and Cognition teams, we are introducing Language Generation; which allows the developer to extract the embedded strings from their code and resource files and manage them through a Language Generation runtime and file format. Language Generation enable customers to define multiple variations on a phrase, execute simple expressions based on context, refer to conversational memory, and over time will enable us to bring additional capabilities all leading to a more natural conversational experience.

• Common Expression Language | api :: Both Adaptive dialogs and Language Generation rely on and use a common expression language to power bot conversations.

Channels and Adapters

There are two ways to connect your bot to a client experience:

• Azure Bot Service Channel - Language and SDK independent support via Azure Bot Service
• Bot Framework SDK Adapter - A per language Adapter component written by community

Client	Azure Channel	C# Adapter	JS Adapter
Microsoft Teams	Azure
Skype	Azure
Exchange	Azure
Direct Line	Azure
Web Chat	Azure		Botkit
Cortana	Azure
Facebook	Azure	SDK	Botkit
Slack	Azure	SDK	Botkit
Kik	Azure
Telegram	Azure
Line	Azure
GroupMe	Azure
Twilio (SMS)	Azure	SDK	Botkit
Alexa		Community	Community
Google Home		Community	Community
Google Hangouts		Community	Botkit
WebEx		SDK	Botkit
Console			Community

Community Extensions

Adapters and plugins from the open source community are available to extend your bot application.

	C#	JavaScript	Python	Java
botbuilder-community	C#	JavaScript	Python	Java
Botkit		JavaScript

Questions and Help

If you have questions about Bot Framework SDK or using Azure Bot Service, we encourage you to reach out to the community and Azure Bot Service dev team for help.

• For questions which fit the Stack Overflow format ("how does this work?"), we monitor the both Azure Bot Service and Bot Framework tags (search both)
• You can also tweet/follow @msbotframework

Join the conversation on Gitter.

See all the support options here.

Issues and feature requests

We track functional issues and features asks for and Bot Builder and Azure Bot Service in a variety of locations. If you have found an issue or have a feature request, please submit an issue to the below repositories.

Item	Description	Link
SDK v4 .NET	core bot runtime for .NET, connectors, middleware, dialogs, prompts, LUIS and QnA	File an issue
SDK v4 JavaScript	core bot runtime for Typescript/Javascript, connectors, middleware, dialogs, prompts, LUIS and QnA	File an issue
SDK v4 Python	core bot runtime for Python, connectors, middleware, dialogs, prompts, LUIS and QnA	File an issue
SDK v4 Java	core bot runtime for Java, connectors, middleware, dialogs, prompts, LUIS and QnA	File an issue

Prior releases

• Bot Builder v3 SDK has been migrated to the Bot Framework SDK V3 repository.
• Botkit SDK is a popular SDK which joined the Microsoft Bot Framework family and is built on top of the Bot Framework SDK V4.

Bot Framework ecosystem

• Bot Framework Composer
• Bot Framework Solutions
• Botkit
• Azure Bot Service
• Bot Framework Emulator
• Bot Framework Web Chat
• Bot Framework Tools
• Language Understanding
• QnA Maker
• Dispatch
• Speech Services
• Adaptive cards
• Analytics

Bot Framework Composer

Bot Framework Composer (Preview) is an integrated development tool for developers and multi-disciplinary teams to build bots and conversational experiences with the Microsoft Bot Framework. Within this tool, you'll find everything you need to build a sophisticated conversational experience.

Botkit

Botkit is a developer tool and SDK for building chat bots, apps and custom integrations for major messaging platforms. Botkit bots hear() triggers, ask() questions and say() replies. Developers can use this syntax to build dialogs - now cross compatible with the latest version of Bot Framework SDK.

In addition, Botkit brings with it 6 platform adapters allowing Javascript bot applications to communicate directly with messaging platforms: Slack, Webex Teams, Google Hangouts, Facebook Messenger, Twilio, and Web chat.

Botkit is part of Microsoft Bot Framework and is released under the MIT Open Source license

Bot Framework Solutions (Preview)

The Bot Framework Solutions repository provides a set of templates, solution accelerators and skills to help build sophisticated conversational experiences.

• Virtual Assistant. Customers and partners have a significant need to deliver a conversational assistant tailored to their brand, personalized to their users, and made available across a broad range of canvases and devices.
  
  This brings together all of the supporting components and greatly simplifies the creation of a new bot project including: basic conversational intents, Dispatch integration, QnA Maker, Application Insights and an automated deployment.

• Skills. A library of re-usable conversational skill building-blocks enabling you to add functionality to a Bot. We currently provide: Calendar, Email, Task, Point of Interest, Automotive, Weather and News skills. Skills include LUIS models, Dialogs, and integration code delivered in source code form to customize and extend as required.

• Analytics. Gain key insights into your bot’s health and behavior with the Bot Framework Analytics solutions, which includes: sample Application Insights queries, and Power BI dashboards to understand the full breadth of your bot’s conversations with users.

Azure Bot Service

Azure Bot Service enables you to host intelligent, enterprise-grade bots with complete ownership and control of your data. Developers can register and connect their bots to users on Skype, Microsoft Teams, Cortana, Web Chat, and more. [Docs]

• Direct Line JS Client: If you want to use the Direct Line channel in Azure Bot Service and are not using the WebChat client, the Direct Line JS client can be used in your custom application. [Readme]

• Direct Line Speech Channel: We are bringing together the Bot Framework and Microsoft's Speech Services to provide a channel that enables streamed speech and text bi-directionally from the client to the bot application. To sign up, add the 'Direct Line Speech' channel to your Azure Bot Service.

• Better isolation for your Bot - Direct Line App Service Extension : The Direct Line App Service Extension can be deployed as part of a VNET, allowing IT administrators to have more control over conversation traffic and improved latency in conversations due to reduction in the number of hops. Get started with Direct Line App Service Extension here. A VNET lets you create your own private space in Azure and is crucial to your cloud network as it offers isolation, segmentation, and other key benefits.

Bot Framework Emulator

The Bot Framework Emulator is a cross-platform desktop application that allows bot developers to test and debug bots built using the Bot Framework SDK. You can use the Bot Framework Emulator to test bots running locally on your machine or to connect to bots running remotely. [Download latest | Docs]

Bot Framework Web Chat

The Bot Framework Web Chat is a highly customizable web-based client chat control for Azure Bot Service that provides the ability for users to interact with your bot directly in a web page. [Stable release | Docs | Samples]

Bot Framework CLI Tools

The Bot Framework CLI Tools is an open source collection of cross-platform command line tools designed to support building robust end-to-end development workflows. The new Bot Framework CLI tool replaces legacy standalone tools used to manage bots and related services. We've ported most of the tools and are in the process of porting the rest of them. BF CLI aggregates the collection of cross-platform tools into one cohesive and consistent interface.

Related Services

Language Understanding

A machine learning-based service to build natural language experiences. Quickly create enterprise-ready, custom models that continuously improve. Language Understanding Service(LUIS) allows your application to understand what a person wants in their own words. [Docs | Add language understanding to your bot]

QnA Maker

QnA Maker is a cloud-based API service that creates a conversational, question-and-answer layer over your data. With QnA Maker, you can build, train and publish a simple question and answer bot based on FAQ URLs, structured documents, product manuals or editorial content in minutes. [Docs | Add qnamaker to your bot]

Dispatch

Dispatch tool lets you build language models that allow you to dispatch between disparate components (such as QnA, LUIS and custom code). [Readme]

Speech Services

Speech Services convert audio to text, perform speech translation and text-to-speech with the unified Speech services. With the speech services, you can integrate speech into your bot, create custom wake words, and author in multiple languages. [Docs]

Adaptive Cards

Adaptive Cards are an open standard for developers to exchange card content in a common and consistent way, and are used by Bot Framework developers to create great cross-channel conversatational experiences.

• Open framework, native performance - A simple open card format enables an ecosystem of shared tooling, seamless integration between apps, and native cross-platform performance on any device.
• Speech enabled from day one - We live in an exciting era where users can talk to their devices. Adaptive Cards embrace this new world and were designed from the ground up to support these new experiences.

Contributing

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.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Reporting Security Issues

Security issues and bugs should be reported privately, via email, to the Microsoft Security Response Center (MSRC) at secure@microsoft.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.