Bot Framework Solutions Documentation

Contents

Overview

High-level overview into the Virtual Assistant, Skills and Analytics.

Name Description
Virtual Assistant (Preview). A conversational assistant tailored to your brand, personalized for your users, and available across a broad range of clients and devices. This template greatly simplifies the creation of a new bot project by providing basic conversational intents, Dispatch, LUIS, and QnA Maker integration, and automated ARM deployment.
Skills (Preview). A collection of re-usable conversational skills enabling you to add functionality to a Virtual Assistant. We currently provide: Calendar, Email, To Do, Point of Interest, Automotive, Weather and News skills. Skills include LUIS models and source code to customize 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.

Tutorials

Step-by-step tutorials to get your started using the Virtual Assistant and Skills.

C#

Create a Virtual Assistant (C#)

Get up and running with the solution accelerator.

Customize a Virtual Assistant (C#)

Personalize your experience for your brand and customers.

Create a skill (C#)

Build a custom skill for your scenario.

Customize a skill (C#)

Customize your skill for your brand and users.

TypeScript

Create a Virtual Assistant (TypeScript)

Get up and running with the solution accelerator.

Customize a Virtual Assistant (TypeScript)

Personalize your experience for your brand and customers.

Create a skill (TypeScript)

Build a custom skill for your scenario.

Customize a skill (TypeScript)

Customize your skill for your brand and users.

More tutorials

Connect pre-built skills

Deploy and connect to a selection of provided skill projects.

Enable Speech

Enable the Microsoft Speech Channel for your assistant.

Enable Microsoft Teams

Enable the Microsoft Teams Channel for your assistant.

How To

How-to guides for achieving more complex scenarios.

Category Title Description
Virtual Assistant How to create a Release Pipeline Guidance on how to create and configure a Release Pipeline for your Virtual Assistant
Virtual Assistant Manual Deployment How to manually deploy and configuring your Virtual Assistant
Virtual Assistant Test the Virtual Assistant How to test your assistant end-to-end.
Virtual Assistant Send proactive messages Adding proactive experiences to your Assistant
Virtual Assistant Convert from Enterprise Template to Virtual Assistant Template Guidance on how to move from an Enterprise Template based Bot to the new Template
Virtual Assistant Collect Feedback Describes how to implement the FeedbackMiddleware to collect user feedback.
Virtual Assistant Link Accounts to a Virtual Assistant Enable users to link third party accounts (e.g. Office 365) to your Assistant.
Virtual Assistant Migrate from Virtual Assistant Solution to Template Guidance on how to move from the original Virtual Assistant solution to the new Template
Skills Add skills to a Virtual Assistant Steps for adding a skill to an assistant
Skills Enable skills on an existing v4 bot How to add Skills to an existing v4 bot (not Virtual Assistant template)
Skills Manually configure OAuth for Productivity Skills How to configure authentication manually for skills.
Skills Convert an existing v4 bot to a skill Steps required to take an existing Bot and make it available as a skill.
Samples Set up Enterprise Notifications for a Virtual Assistant Steps for configuring the Enterprise Notifications sample
Samples Use the Virtual Assistant Client (Android) Steps for using the Virtual Assistant Client on Android

Reference

Reference documentation providing more details on concepts across the Virtual Assistant, Skills and Analytics

Category Title Description
Virtual Assistant Architecture Detailed documentation covering what the template provides and how it works
Virtual Assistant Managing cognitive models across environments Guidance on how to manage cognitive models across environments in a team
Virtual Assistant Understanding the Template An outline of what the Virtual Assistant template provides
Virtual Assistant Deployment Scripts Reference for deployment tools provided in the Virtual Assistant Template.
Virtual Assistant Responses Details on how responses work in the Virtual Assistant template.
Virtual Assistant Events Event activities enable contextual information to be shared between a user and assistant, without being visible to the user.
Virtual Assistant Localization Understanding the Virtual Assistant’s approach to localizing conversations
Virtual Assistant Virtual Assistant and Skills Pattern How the Virtual Assistant and Skills can enable a parent-child pattern throughout your organization.
Skills Architecture Under the covers of the skill implementation.
Skills BotSkills CLI Tool Details on usage and commands.
Skills Best Practices Best practices for developing your Bot Framework Skill.
Skills Skill Manifest Overview of the skill manifest and its role with skill registration and invocation.
Skills Skill Authentication Details on skill authentication approach and flow.
Skills Skill Token Flow Details on how skills authenticate users.
Skills Responses Details on how responses work in skill projects.
Skills Automotive Skill Skill for enabling car automation scenarios.
Skills Calendar Skill Add calendar capabilities to your Assistant. Powered by Microsoft Graph and Google.
Skills Phone Skill The Phone Skill provides the capability to start phone calls to a Virtual Assistant.
Skills Email Skill Add email capabilities to your Assistant. Powered by Microsoft Graph and Google.
Skills To Do Skill Add task management capabilities to your Assistant. Powered by Microsoft Graph.
Skills Point Of Interest Skill Find points of interest and directions. Powered by Azure Maps and FourSquare.
Skills Experimental Skills News, Search, Reservation, Weather, Music, Events, and Hospitality.
Skills Transcripts Bot Framework emulator transcripts for pre-built skills.
Analytics Application Insights Detailed information on how Application Insights is used to collect information and powers our analytics capabilities.
Analytics Power BI Detailed information on how the provided Power BI template provides insights into your assistant usage.
Samples Virtual Assistant Client (Android) comprehensive feature set Detailed information on the features of the Virtual Assistant Client on Android
Samples Hospitality Assistant Virtual Assistant sample made for a hospitality scenario.

Need Help?

For questions please start with Stack Overflow where we’re happy to help.

If you are running into an issue, please refer to our Known Issues documentation where we’ve compiled some common problems and solutions first. If your problem is not listed, please use our GitHub to raise issues or feature requests.

License

Copyright (c) Microsoft Corporation. All rights reserved.