Bot Builder Community - .NET Extensions
This repository is part of the Bot Builder Community Project and contains Bot Builder Extensions for the .NET SDK, including middleware, dialogs, helpers and more. Other repos within the Bot Builder Community Project exist for extensions for JavaScript, Python and tools - you can find our other repos under our GitHub organisation for the project.
To see a list of current extensions available for the Bot Builder .NET SDK, use the links below to jump to a section.
- C# Middleware
- C# Dialogs & Prompts
- C# Adapters - e.g. Alexa, Google and Twitter DMs
- C# Recognizers
- C# Storage
Installation
Each extension, such as middleware or recognizers, is available individually from NuGet. See each individual component description for installation details and links.
Contributing and Reporting Issues
We welcome and encourage contributions to this project, in the form of bug fixes, enhancements or new extensions. Please fork the repo and raise a PR if you have something you would like us to review for inclusion. If you want to discuss an idea first then the best way to do this right now is to raise a GitHub issue or reach out to one of us on Twitter.
Middleware
The following pieces of middleware are currently available;
| Name | Description | Sample? | NuGet |
|---|---|---|---|
| Handle Activity Type Middleware | Middleware component which allows you to respond to different types of incoming activities, e.g. send a greeting, or even filter out activities you do not care about altogether. |  |
|
| BestMatch Middleware | A middleware implementation of the popular open source BestMatchDialog for v3 of the SDK. This piece of middleware will allow you to match a message received from a bot user against a list of strings and then carry out an appropriate action. Matching does not have to be exact and you can set the threshold as to how closely the message should match with an item in the list. | Sample | |
| Azure Active Directory Authentication Middleware | This middleware will allow your bot to authenticate with Azure AD. It was created to support integration with Microsoft Graph but it will work with any application that uses the OAuth 2.0 authorization code flow. | |
|
| Sentiment Analysis Middleware | This middleware uses Cognitive Services Sentiment Analysis to identify the sentiment of each inbound message and make it available for your bot or other middleware component. | Sample | |
| Spell Check Middleware | This middleware uses Cognitive Services Check to automatically correct inbound message text | |
Dialogs and Prompts
The following dialogs are currently available;
| Name | Description | Sample | NuGet |
|---|---|---|---|
| Bot Builder v4 Location Dialog | An implemention for v4 of the Bot Build .NET SDK of the Microsoft.Bot.Builder.Location dialog project built for Bot Builder v3. An open-source location picker control for Microsoft Bot Framework powered by Azure or Bing Maps REST services. This control will allow a user to search for a location, with the ability to specify required fields and also store locations as favorites for the user. | Sample |  |
| Bot Builder ChoiceFlow | This dialog allows you to provide the user with a series of guides choice prompts in turn (defined in a JSON file or as a collection of ChoiceFlowItem objects), similar to when calling a telephone line with a series of automated options. The dialog returns the user's last choice as a result from the dialog and optionally provide the user with a simple text response depending on which choice they land on. | Sample |  |
| Bot Builder v4 FormFlow | An implemention for v4 of the Bot Build .NET SDK of the Microsoft.Bot.Builder.FormFlow dialog project built for Bot Builder v3. FormFlow automatically generates the dialogs that are necessary to manage a guided conversation, based upon guidelines you specify. | Sample | |
| Bot Builder v4 Prompts | A collection of Prompts for use with Bot Builder v4, providing the ability to prompt for and recognize currencies, age, distances and temperature. |  |
|
| Bot Builder v4 Luis Dialog | An implementation for v4 of the Bot Builder .NET SDK of the Microsoft.Bot.Builder.Dialogs.LuisDialog built for Bot Builder V3 A dialog specialized to handle intents and entities from LUIS. | Sample | |
Adapters
The following adapters can be used to expose your bot on additional channels not supported by the Azure Bot Service, such as Alexa.
| Name | Description | Sample? | NuGet |
|---|---|---|---|
| Alexa Adapter | An adapter to allow for Alexa Skills to be built using the Bot Builder SDK. Includes broad support for Alexa skills capabilities, including devices with displays (Show / Spot), Alexa Cards, access to user profile data and the ability to send Progressive Responses. | Sample |  |
| Google Adapter | An adapter to allow for Google Actions to be built using the Bot Builder SDK. Includes broad support for Alexa skills capabilities, including Cards and suggestion chips | Sample | |
| Twitter Adapter | An adapter that integrates Twitter Direct Messages with the Bot Builder. The adapter sets up the required webhooks and responds to CRC requests. The webhooks code is based on the work by Tweety with modifications to support the Premium tier of the Account Activity API. | Sample | |
Recognizers
The following recognizers are currently available;
| Name | Description | NuGet |
|---|---|---|
| Fuzzy Matching Recognizer | A recognizer that allows you to use fuzzy matching to compare strings. Useful in situations such as when a user make a spelling mistake etc. When the recognizer is used a list of matches, along with confidence scores, are returned. | |
Storage
The following Storage implementations are currently available;
| Name | Description | NuGet |
|---|---|---|
| Elasticsearch storage | Elasticsearch based storage for bots created using Microsoft Bot Builder SDK. |  |
| EntityFramework storage | EntityFramework based storage and transcript store for bots created using Microsoft Bot Builder SDK. | |