BotBuilder-Samples
Welcome to the Bot Framework samples repository. Here you will find task-focused samples in C#, JavaScript/TypeScript, and Python to help you get started with the Bot Framework SDK!
Top Related Projects
The open-source hub to build & deploy GPT/LLM Agents ⚡️
Botkit is an open source developer tool for building chat bots, apps and custom integrations for major messaging platforms.
VS Code in the browser
Create agents that monitor and act on your behalf. Your agents are standing by!
Quick Overview
BotBuilder-Samples is a GitHub repository maintained by Microsoft that provides a collection of sample projects and resources for building conversational bots using the Bot Framework SDK. It includes examples in multiple programming languages, demonstrating various bot capabilities and integration with different channels and services.
Pros
- Comprehensive collection of samples covering a wide range of bot scenarios and features
- Supports multiple programming languages (C#, JavaScript, Python, Java)
- Regularly updated with new samples and improvements
- Includes examples for integration with popular services like LUIS, QnA Maker, and Azure Cognitive Services
Cons
- Some samples may become outdated as the Bot Framework SDK evolves
- Documentation within individual samples can be inconsistent in quality and depth
- May require additional setup and configuration for certain samples (e.g., Azure resources)
- Learning curve can be steep for beginners due to the complexity of some advanced samples
Code Examples
Here are a few short code examples from the repository:
- Creating a simple echo bot in C#:
[Route("api/messages")]
[ApiController]
public class BotController : ControllerBase
{
private readonly IBotFrameworkHttpAdapter _adapter;
private readonly IBot _bot;
public BotController(IBotFrameworkHttpAdapter adapter, IBot bot)
{
_adapter = adapter;
_bot = bot;
}
[HttpPost, HttpGet]
public async Task PostAsync()
{
await _adapter.ProcessAsync(Request, Response, _bot);
}
}
- Handling user input in JavaScript:
class EchoBot extends ActivityHandler {
constructor() {
super();
this.onMessage(async (context, next) => {
const replyText = `Echo: ${ context.activity.text }`;
await context.sendActivity(MessageFactory.text(replyText, replyText));
await next();
});
}
}
- Integrating LUIS for natural language understanding in Python:
class LuisBot(ActivityHandler):
def __init__(self, config: DefaultConfig):
self.luis_app_id = config.LUIS_APP_ID
self.luis_api_key = config.LUIS_API_KEY
self.luis_api_host_name = config.LUIS_API_HOST_NAME
async def on_message_activity(self, turn_context: TurnContext):
luis_result = await LuisHelper.execute_luis_query(
self.luis_app_id, self.luis_api_key, self.luis_api_host_name, turn_context
)
await turn_context.send_activity(f"Top intent: {luis_result.top_intent().intent}")
Getting Started
To get started with BotBuilder-Samples:
- Clone the repository:
git clone https://github.com/microsoft/BotBuilder-Samples.git
- Navigate to the desired sample directory
- Follow the README instructions for the specific sample
- Install dependencies (e.g.,
npm install
for JavaScript,pip install -r requirements.txt
for Python) - Run the sample locally (e.g.,
dotnet run
for C#,node index.js
for JavaScript) - Test the bot using the Bot Framework Emulator or deploy it to Azure for channel integration
Competitor Comparisons
The open-source hub to build & deploy GPT/LLM Agents ⚡️
Pros of Botpress
- Open-source, self-hosted platform with a visual flow builder
- Supports multiple languages and NLU integrations
- Active community and extensive documentation
Cons of Botpress
- Steeper learning curve for developers new to the platform
- Limited built-in integrations compared to BotBuilder-Samples
Code Comparison
Botpress (JavaScript):
bp.hear(/hello/i, (event, next) => {
bp.messaging.sendText(event.channel, 'Hello, human!')
})
BotBuilder-Samples (JavaScript):
bot.onMessage(async (context, next) => {
if (context.activity.text.toLowerCase() === 'hello') {
await context.sendActivity('Hello, human!');
}
await next();
});
Both examples show how to respond to a "hello" message, but Botpress uses a more concise syntax with its bp.hear
method, while BotBuilder-Samples uses the more verbose bot.onMessage
approach.
BotBuilder-Samples offers a wider range of language samples and integration examples, making it easier for developers to get started with various platforms. However, Botpress provides a more comprehensive, all-in-one solution for building and managing chatbots, including a visual flow builder and built-in NLU capabilities.
Botkit is an open source developer tool for building chat bots, apps and custom integrations for major messaging platforms.
Pros of Botkit
- More platform-agnostic, supporting a wider range of messaging platforms
- Simpler and more intuitive API for beginners
- Active community with extensive plugin ecosystem
Cons of Botkit
- Less integrated with Azure and Microsoft services
- Fewer enterprise-level features and scalability options
- Limited support for advanced natural language processing
Code Comparison
Botkit example:
controller.hears(['hello'], 'direct_message', function(bot, message) {
bot.reply(message, 'Hello yourself!');
});
BotBuilder-Samples example:
class EchoBot extends ActivityHandler {
constructor() {
super();
this.onMessage(async (context, next) => {
await context.sendActivity(`You said "${context.activity.text}"`);
await next();
});
}
}
Key Differences
- Botkit uses a more event-driven approach, while BotBuilder-Samples follows a more object-oriented pattern
- BotBuilder-Samples provides deeper integration with Microsoft's Bot Framework
- Botkit offers a more straightforward setup for simple bots, while BotBuilder-Samples provides more flexibility for complex scenarios
Use Cases
- Botkit: Ideal for small to medium-sized projects, multi-platform bots, and rapid prototyping
- BotBuilder-Samples: Better suited for enterprise-level applications, Azure integration, and advanced AI capabilities
VS Code in the browser
Pros of code-server
- Enables full VS Code experience in a browser, allowing remote development
- Supports a wide range of programming languages and extensions
- Can be self-hosted for enhanced security and customization
Cons of code-server
- Requires more setup and maintenance compared to BotBuilder-Samples
- May have higher resource requirements for hosting
- Limited to VS Code functionality, while BotBuilder-Samples offers bot-specific tools
Code Comparison
BotBuilder-Samples (JavaScript):
const { ActivityHandler, MessageFactory } = require('botbuilder');
class EchoBot extends ActivityHandler {
constructor() {
super();
this.onMessage(async (context, next) => {
await context.sendActivity(MessageFactory.text(`Echo: ${context.activity.text}`));
await next();
});
}
}
code-server (Server Configuration):
module.exports = {
bind: '0.0.0.0',
auth: 'password',
password: 'your-password',
cert: false,
port: 8080,
'proxy-domain': 'your-domain.com'
};
While BotBuilder-Samples focuses on bot development with specific examples, code-server provides a broader development environment that can be used for various projects, including bot development. The choice between the two depends on the specific needs of the developer and the project requirements.
Create agents that monitor and act on your behalf. Your agents are standing by!
Pros of Huginn
- More versatile and can be used for a wider range of automation tasks beyond just chatbots
- Offers a user-friendly web interface for creating and managing agents
- Has a large community-driven library of pre-built agents for various tasks
Cons of Huginn
- Steeper learning curve for non-technical users
- Less focused on chatbot development specifically
- May require more setup and configuration compared to BotBuilder-Samples
Code Comparison
Huginn (Ruby):
class Agents::WeatherAgent < Agent
def check
LatchKey.new(options['api_key']).get do |forecast|
create_event :payload => forecast
end
end
end
BotBuilder-Samples (JavaScript):
const { ActivityHandler, MessageFactory } = require('botbuilder');
class EchoBot extends ActivityHandler {
constructor() {
super();
this.onMessage(async (context, next) => {
await context.sendActivity(MessageFactory.text(`Echo: ${context.activity.text}`));
await next();
});
}
}
The code snippets demonstrate the different focus areas of each project. Huginn's example shows an agent for fetching weather data, while BotBuilder-Samples' code illustrates a simple echo bot implementation.
Convert designs to code with AI
Introducing Visual Copilot: A new AI model to turn Figma designs to high quality code using your components.
Try Visual CopilotREADME
Click here to find out what's new with Bot Framework
Overview
This branch contains samples for the released version of the Microsoft Bot Framework V4 SDK for .NET, JS and Python. If you need samples for the Bot Framework V3 SDK, go here.
Getting the samples
To use the samples, clone this GitHub repository using Git.
git clone https://github.com/Microsoft/BotBuilder-Samples.git
cd BotBuilder-Samples
Sample lists
Samples are designed to illustrate functionality you'll need to implement to build great bots!
- !Bot Framework Samples
Bot essentials
Sample Name | Description | .NET | JavaScript | Python | Java | |
---|---|---|---|---|---|---|
2 | Echo bot | Demonstrates how to receive and send messages. | .NET Core | JavaScript, TypeScript | Python | Java |
3 | Welcome user | Introduces activity types and provides a welcome message on conversation update activity. | .NET Core | JavaScript, TypeScript | Python | Java |
5 | Multi turn prompts | Demonstrates how to use waterfall dialog, prompts, and component dialog to create a simple interaction that asks the user for name, age, and prints back that information. | .NET Core | JavaScript, TypeScript | Python | Java |
6 | Using cards | Introduces all card types including thumbnail, audio, media etc. Builds on Welcoming user + multi-prompt bot by presenting a card with buttons in welcome message that route to appropriate dialog. | .NET Core | JavaScript, TypeScript | Python | Java |
7 | Adaptive cards | Demonstrates how the multi-turn dialog can use a card to get user input for name and age. | .NET Core | JavaScript | Python | Java |
8 | Suggested actions | Demonstrates how to enable your bot to present buttons that the user can tap to provide input. | .NET Core | JavaScript | Python | Java |
13 | Core bot | Core bot shows how to use cards, dialog, and Language Understanding (LUIS). | .NET Core, .NET Web | JavaScript, TypeScript | Python | Java |
15 | Handling attachments | Demonstrates how to listen for/handle user provided attachments. | .NET Core | JavaScript | Python | Java |
40 | TIMEX resolution | Demonstrates various ways to parse and manipulate the TIMEX expressions you get from LUIS and the DateTimeRecognizer used by the DateTimePrompt. | .NET Core | JavaScript | Python | Java |
43 | Complex dialogs | Demonstrates different ways for composing dialogs. | .NET Core | JavaScript | Python | Java |
45 | State management | Demonstrates how to use state management and storage objects to manage and persist state. | .NET Core | JavaScript | Python | Java |
Advanced bots
Sample Name | Description | .NET | JavaScript | Python | Java | |
---|---|---|---|---|---|---|
1 | Console echo bot | Introduces the concept of adapter and demonstrates a simple echo bot on console adapter and how to send a reply and access the incoming message. | .NET Core | JavaScript, TypeScript | Python | |
1 | Browser echo bot | Demonstrates how to host a bot in the browser using Web Chat and a custom Web Chat Adapter. | ECMAScript 6 | |||
16 | Proactive messages | Demonstrates how to send proactive messages to users. | .NET Core | JavaScript, TypeScript | Python | Java |
17 | Multilingual bot | Using translate middleware to support a multi-lingual bot. Demonstrates custom middleware. | .NET Core | JavaScript | Python | Java |
19 | Custom dialogs | Demonstrates complex conversation flow using the Dialogs library. | .NET Core | JavaScript | Python | Java |
21 | Application Insights | Demonstrates how to add telemetry logging to your bot, storing telemetry within Application Insights. | .NET Core | JavaScript | Java | |
23 | Facebook events | Integrate and consume Facebook specific payloads, such as post-backs, quick replies and opt-in events. | .NET Core | JavaScript | Python | Java |
42 | Scale out | Demonstrates how you can build your own state solution from the ground up that supports scaled out deployment with ETag based optimistic locking. | .NET Core | Python | Java | |
44 | Basic custom prompts | Demonstrates how to implement your own basic prompts to ask the user for information. | .NET Core | JavaScript | Python | Java |
47 | Inspection middleware | Demonstrates how to use middleware to allow the Bot Framework Emulator to debug traffic into and out of the bot in addition to looking at the current state of the bot. | [.NET Core][cs#47] | JavaScript | Python | Java |
70 | Styling webchat | This sample shows how to create a web page with custom Web Chat component. | ECMAScript 6 |
Authentication samples
Sample Name | Description | .NET | JavaScript | Python | Java | |
---|---|---|---|---|---|---|
18 | OAuth authentication | Bot that demonstrates how to integrate OAuth providers. | .NET Core | JavaScript | Python | Java |
24 | MSGraph authentication | Demonstrates bot authentication capabilities of Azure Bot Service. Demonstrates utilizing the Microsoft Graph API to retrieve data about the user. | .NET Core | JavaScript | Python | Java |
46 | Teams authentication | Demonstrates how to use authentication for a bot running in Microsoft Teams. | .NET Core | JavaScript | Python | Java |
84 | Certificate authentication | Demonstrates how to use Certificates to authenticate the bot | .NET Core | JavaScript | ||
85 | Subject name/issuer authentication | Demonstrates how to use the subject name/issuer authentication in a bot | .NET Core | JavaScript |
Custom question answering samples
Sample Name | Description | .NET | JavaScript | Python | Java | |
---|---|---|---|---|---|---|
12 | Custom question answering (simple) | Demonstrates how to use Custom question answering to have simple single-turn conversations | .NET Core | JavaScript | ||
48 | Custom question answering (advanced) | Demonstrates how to integrate Multiturn and Active learning in a Custom question answering bot | .NET Core | JavaScript |
Teams samples
Sample Name | Description | .NET | JavaScript | Python | Java | |
---|---|---|---|---|---|---|
25 | Message Reactions | Demonstrates how to create a simple bot that responds to Message Reactions | .NET Core | JavaScript | Java | |
46 | Authentication | Demonstrates how to use authentication for a bot running in Microsoft Teams. | .NET Core | JavaScript | Python | Java |
50 | Messaging extensions - search | A Messaging Extension that accepts search requests and returns results. | .NET Core | JavaScript | Python | Java |
51 | Messaging extensions - action | A Messaging Extension that accepts parameters and returns a card. Also, how to receive a forwarded message as a parameter in a Messaging Extension. | .NET Core | JavaScript | Python | Java |
52 | Messaging extensions - auth and config | A Messaging Extension that has a configuration page, accepts search requests and returns results after the user has signed in. | .NET Core | JavaScript | ||
53 | Messaging extensions - action preview | Demonstrates how to create a Preview and Edit flow for a Messaging Extension. | .NET Core | JavaScript | Python | Java |
54 | Task module | Demonstrates how to retrieve a Task Module, and values from cards in the Task Module, for a Messaging Extension. | .NET Core | JavaScript | Python | Java |
55 | Link unfurling | A Messaging Extension that performs link unfurling. | .NET Core) | JavaScript | Python | Java |
56 | File upload | Demonstrates how to obtain file consent, and upload files to Teams from a bot. Also, how to receive a file sent to a bot. | .NET Core | JavaScript | Python | Java |
57 | Conversation bot | Demonstrates various features of bots on Teams: message all members in a Team or Channel, @mention a user from a bot, update previously sent messages, etc. | .NET Core | JavaScript | Python | Java |
58 | Start new thread in a channel | Demonstrates creating a new thread in a channel. | .NET Core | JavaScript | Python | Java |
Skills samples
Sample Name | Description | .NET | JavaScript | Python | Java | |
---|---|---|---|---|---|---|
80 | Skills - simple bot to bot | This sample shows how to connect a skill to a skill consumer. | .NET Core | JavaScript | Python | Java |
81 | Skills - skill dialog | This sample shows how to connect a skill to a skill dialog consumer. | .NET Core | JavaScript | Python | Java |
82 | Skills - SSO with CloudAdapter | This sample shows how use SSO with skills and CloudAdapter. | .NET Core | JavaScript | NA | NA |
Experimental / preview samples
A collection of experimental samples exist, intended to provide samples for features currently in preview or as a way to solicit feedback on a given design, approach, or technology being considered by the Bot Framework Team.
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.
Top Related Projects
The open-source hub to build & deploy GPT/LLM Agents ⚡️
Botkit is an open source developer tool for building chat bots, apps and custom integrations for major messaging platforms.
VS Code in the browser
Create agents that monitor and act on your behalf. Your agents are standing by!
Convert designs to code with AI
Introducing Visual Copilot: A new AI model to turn Figma designs to high quality code using your components.
Try Visual Copilot