README.md

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.

Samples list

Samples are designed to illustrate scenarios you'll need to implement to build great bots! To use the samples, clone this GitHub repository using Git.

    git clone https://github.com/Microsoft/BotBuilder-Samples.git
    cd BotBuilder-Samples

Sample Name	Description	.NET CORE	JavaScript	.NET Web API	JS (es6)	TypeScript	Python
1.console-echo	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.	View	View			View	View
1.browser-echo	Demonstrates how to host a bot in the browser using Web Chat and a custom Web Chat Adapter.				View
2.echo-bot	Demonstrates how to receive and send messages.	View	View			View	View
3.welcome-user	Introduces activity types and provides a welcome message on conversation update activity.	View	View			View	View
5.multi-turn-prompt	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.	View	View			View	View
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.	View	View			View	View
7.using-adaptive-cards	Demonstrates how the multi-turn dialog can use a card to get user input for name and age.	View	View				View
8.suggested-actions	Demonstrates how to enable your bot to present buttons that the user can tap to provide input.	View	View				View
11.qnamaker	Demonstrates how to use QnA Maker to have simple single-turn conversations	View	View				View
13.core-bot	Core bot shows how to use cards, dialog, and Langugage Understanding (LUIS).	View	View	View		View	View
13.core-bot.tests	Unit test project Core bot shows how to use use Bot Framework testing framework.	View
14.nlp-with-dispatch	Demonstrates how to dispatch across LUIS and QnA Maker.	View	View				View
15.handling-attachments	Demonstrates how to listen for/handle user provided attachments.	View	View				View
16.proactive-messages	Demonstrates how to send proactive messages to users.	View	View			View	View
17.multilingual-bot	Using translate middleware to support a multi-lingual bot. Demonstrates custom middleware.	View	View				View
18.bot-authentication	Bot that demonstrates how to integrate OAuth providers.	View	View				View
19.custom-dialogs	Demonstrates complex conversation flow using the Dialogs library.	View	View				View
21.corebot-app-insights	Demonstrates how to add telemetry logging to your bot, storing telemetry within Application Insights.	View	View
23.facebook-events	Integrate and consume Facebook specific payloads, such as post-backs, quick replies and opt-in events.	View	View				View
24.bot-auth-msgraph	Demonstrates bot authentication capabilities of Azure Bot Service. Demonstrates utilizing the Microsoft Graph API to retrieve data about the user.	View	View				View
40.timex-resolution	Demonstrates various ways to parse and manipulate the TIMEX expressions you get from LUIS and the DateTimeRecognizer used by the DateTimePrompt.	View	View				View
42.scaleout	Demonstrates how you can build your own state solution from the ground up that supports scaled out deployment with ETag based optimistic locking.	View					View
43.complex-dialog	Demonstrates different ways for composing dialogs.	View	View				View
44.prompt-for-user-input	Demonstrates how to implement your own basic prompts to ask the user for information.	View	View				View
45.state-management	Demonstrates how to use state management and storage objects to manage and persist state.	View	View				View
46.teams-auth	Demonstrates how to use authentication for a bot running in Microsoft Teams.	View	View				View
47.inspection	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.	View	View				View
48.qnamaker-active-learning-bot	Demonstrates how to integrate Active Learning in a QnA Maker bot.	View	View
49.qnamaker-all-features	Demonstrates how to integrate Multiturn and Active learning in a QnA Maker bot.	View	View
50.teams-messaging-extensions-search	A Messaging Extension that accepts search requests and returns results.	View	View				View
51.teams-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.	View	View				View
52.teams-messaging-extensions-search-auth-config	A Messaging Extension that has a configuration page, accepts search requests and returns results after the user has signed in.	View	View
53.teams-messaging-extensions-action-preview	Demonstrates how to create a Preview and Edit flow for a Messaging Extension.	View	View				View
54.teams-task-module	Demonstrates how to retrieve a Task Module, and values from cards in the Task Module, for a Messaging Extension.	View	View				View
55.teams-link-unfurling	A Messaging Extension that performs link unfurling.	View	View				View
56.teams-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.	View	View				View
57.teams-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.	View	View				View
70.styling-webchat	This sample shows how to create a web page with custom Web Chat component.				View
80.skills-simple-bot-to-bot	This sample shows how to connect a skill to a skill consumer.	View	View				View

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.