Added Multiturn QnA Maker accelerator

Author: Russ Williams

.gitattributes

@@ -0,0 +1,63 @@
+###############################################################################
+# Set default behavior to automatically normalize line endings.
+###############################################################################
+* text=auto
+
+###############################################################################
+# Set default behavior for command prompt diff.
+#
+# This is need for earlier builds of msysgit that does not have it on by
+# default for csharp files.
+# Note: This is only used by command line
+###############################################################################
+#*.cs     diff=csharp
+
+###############################################################################
+# Set the merge driver for project and solution files
+#
+# Merging from the command prompt will add diff markers to the files if there
+# are conflicts (Merging from VS is not affected by the settings below, in VS
+# the diff markers are never inserted). Diff markers may cause the following 
+# file extensions to fail to load in VS. An alternative would be to treat
+# these files as binary and thus will always conflict and require user
+# intervention with every merge. To do so, just uncomment the entries below
+###############################################################################
+#*.sln       merge=binary
+#*.csproj    merge=binary
+#*.vbproj    merge=binary
+#*.vcxproj   merge=binary
+#*.vcproj    merge=binary
+#*.dbproj    merge=binary
+#*.fsproj    merge=binary
+#*.lsproj    merge=binary
+#*.wixproj   merge=binary
+#*.modelproj merge=binary
+#*.sqlproj   merge=binary
+#*.wwaproj   merge=binary
+
+###############################################################################
+# behavior for image files
+#
+# image files are treated as binary by default.
+###############################################################################
+#*.jpg   binary
+#*.png   binary
+#*.gif   binary
+
+###############################################################################
+# diff behavior for common document formats
+# 
+# Convert binary document formats to text before diffing them. This feature
+# is only available from the command line. Turn it on by uncommenting the 
+# entries below.
+###############################################################################
+#*.doc   diff=astextplain
+#*.DOC   diff=astextplain
+#*.docx  diff=astextplain
+#*.DOCX  diff=astextplain
+#*.dot   diff=astextplain
+#*.DOT   diff=astextplain
+#*.pdf   diff=astextplain
+#*.PDF   diff=astextplain
+#*.rtf   diff=astextplain
+#*.RTF   diff=astextplain

.gitignore

@@ -0,0 +1,340 @@
+## Ignore Visual Studio temporary files, build results, and
+## files generated by popular Visual Studio add-ons.
+##
+## Get latest from https://github.com/github/gitignore/blob/master/VisualStudio.gitignore
+
+# User-specific files
+*.rsuser
+*.suo
+*.user
+*.userosscache
+*.sln.docstates
+
+# User-specific files (MonoDevelop/Xamarin Studio)
+*.userprefs
+
+# Build results
+[Dd]ebug/
+[Dd]ebugPublic/
+[Rr]elease/
+[Rr]eleases/
+x64/
+x86/
+[Aa][Rr][Mm]/
+[Aa][Rr][Mm]64/
+bld/
+[Bb]in/
+[Oo]bj/
+[Ll]og/
+
+# Visual Studio 2015/2017 cache/options directory
+.vs/
+# Uncomment if you have tasks that create the project's static files in wwwroot
+#wwwroot/
+
+# Visual Studio 2017 auto generated files
+Generated\ Files/
+
+# MSTest test Results
+[Tt]est[Rr]esult*/
+[Bb]uild[Ll]og.*
+
+# NUNIT
+*.VisualState.xml
+TestResult.xml
+
+# Build Results of an ATL Project
+[Dd]ebugPS/
+[Rr]eleasePS/
+dlldata.c
+
+# Benchmark Results
+BenchmarkDotNet.Artifacts/
+
+# .NET Core
+project.lock.json
+project.fragment.lock.json
+artifacts/
+
+# StyleCop
+StyleCopReport.xml
+
+# Files built by Visual Studio
+*_i.c
+*_p.c
+*_h.h
+*.ilk
+*.meta
+*.obj
+*.iobj
+*.pch
+*.pdb
+*.ipdb
+*.pgc
+*.pgd
+*.rsp
+*.sbr
+*.tlb
+*.tli
+*.tlh
+*.tmp
+*.tmp_proj
+*_wpftmp.csproj
+*.log
+*.vspscc
+*.vssscc
+.builds
+*.pidb
+*.svclog
+*.scc
+
+# Chutzpah Test files
+_Chutzpah*
+
+# Visual C++ cache files
+ipch/
+*.aps
+*.ncb
+*.opendb
+*.opensdf
+*.sdf
+*.cachefile
+*.VC.db
+*.VC.VC.opendb
+
+# Visual Studio profiler
+*.psess
+*.vsp
+*.vspx
+*.sap
+
+# Visual Studio Trace Files
+*.e2e
+
+# TFS 2012 Local Workspace
+$tf/
+
+# Guidance Automation Toolkit
+*.gpState
+
+# ReSharper is a .NET coding add-in
+_ReSharper*/
+*.[Rr]e[Ss]harper
+*.DotSettings.user
+
+# JustCode is a .NET coding add-in
+.JustCode
+
+# TeamCity is a build add-in
+_TeamCity*
+
+# DotCover is a Code Coverage Tool
+*.dotCover
+
+# AxoCover is a Code Coverage Tool
+.axoCover/*
+!.axoCover/settings.json
+
+# Visual Studio code coverage results
+*.coverage
+*.coveragexml
+
+# NCrunch
+_NCrunch_*
+.*crunch*.local.xml
+nCrunchTemp_*
+
+# MightyMoose
+*.mm.*
+AutoTest.Net/
+
+# Web workbench (sass)
+.sass-cache/
+
+# Installshield output folder
+[Ee]xpress/
+
+# DocProject is a documentation generator add-in
+DocProject/buildhelp/
+DocProject/Help/*.HxT
+DocProject/Help/*.HxC
+DocProject/Help/*.hhc
+DocProject/Help/*.hhk
+DocProject/Help/*.hhp
+DocProject/Help/Html2
+DocProject/Help/html
+
+# Click-Once directory
+publish/
+
+# Publish Web Output
+*.[Pp]ublish.xml
+*.azurePubxml
+# Note: Comment the next line if you want to checkin your web deploy settings,
+# but database connection strings (with potential passwords) will be unencrypted
+*.pubxml
+*.publishproj
+
+# Microsoft Azure Web App publish settings. Comment the next line if you want to
+# checkin your Azure Web App publish settings, but sensitive information contained
+# in these scripts will be unencrypted
+PublishScripts/
+
+# NuGet Packages
+*.nupkg
+# The packages folder can be ignored because of Package Restore
+**/[Pp]ackages/*
+# except build/, which is used as an MSBuild target.
+!**/[Pp]ackages/build/
+# Uncomment if necessary however generally it will be regenerated when needed
+#!**/[Pp]ackages/repositories.config
+# NuGet v3's project.json files produces more ignorable files
+*.nuget.props
+*.nuget.targets
+
+# Microsoft Azure Build Output
+csx/
+*.build.csdef
+
+# Microsoft Azure Emulator
+ecf/
+rcf/
+
+# Windows Store app package directories and files
+AppPackages/
+BundleArtifacts/
+Package.StoreAssociation.xml
+_pkginfo.txt
+*.appx
+
+# Visual Studio cache files
+# files ending in .cache can be ignored
+*.[Cc]ache
+# but keep track of directories ending in .cache
+!?*.[Cc]ache/
+
+# Others
+ClientBin/
+~$*
+*~
+*.dbmdl
+*.dbproj.schemaview
+*.jfm
+*.pfx
+*.publishsettings
+orleans.codegen.cs
+
+# Including strong name files can present a security risk
+# (https://github.com/github/gitignore/pull/2483#issue-259490424)
+#*.snk
+
+# Since there are multiple workflows, uncomment next line to ignore bower_components
+# (https://github.com/github/gitignore/pull/1529#issuecomment-104372622)
+#bower_components/
+
+# RIA/Silverlight projects
+Generated_Code/
+
+# Backup & report files from converting an old project file
+# to a newer Visual Studio version. Backup files are not needed,
+# because we have git ;-)
+_UpgradeReport_Files/
+Backup*/
+UpgradeLog*.XML
+UpgradeLog*.htm
+ServiceFabricBackup/
+*.rptproj.bak
+
+# SQL Server files
+*.mdf
+*.ldf
+*.ndf
+
+# Business Intelligence projects
+*.rdl.data
+*.bim.layout
+*.bim_*.settings
+*.rptproj.rsuser
+*- Backup*.rdl
+
+# Microsoft Fakes
+FakesAssemblies/
+
+# GhostDoc plugin setting file
+*.GhostDoc.xml
+
+# Node.js Tools for Visual Studio
+.ntvs_analysis.dat
+node_modules/
+
+# Visual Studio 6 build log
+*.plg
+
+# Visual Studio 6 workspace options file
+*.opt
+
+# Visual Studio 6 auto-generated workspace file (contains which files were open etc.)
+*.vbw
+
+# Visual Studio LightSwitch build output
+**/*.HTMLClient/GeneratedArtifacts
+**/*.DesktopClient/GeneratedArtifacts
+**/*.DesktopClient/ModelManifest.xml
+**/*.Server/GeneratedArtifacts
+**/*.Server/ModelManifest.xml
+_Pvt_Extensions
+
+# Paket dependency manager
+.paket/paket.exe
+paket-files/
+
+# FAKE - F# Make
+.fake/
+
+# JetBrains Rider
+.idea/
+*.sln.iml
+
+# CodeRush personal settings
+.cr/personal
+
+# Python Tools for Visual Studio (PTVS)
+__pycache__/
+*.pyc
+
+# Cake - Uncomment if you are using it
+# tools/**
+# !tools/packages.config
+
+# Tabs Studio
+*.tss
+
+# Telerik's JustMock configuration file
+*.jmconfig
+
+# BizTalk build output
+*.btp.cs
+*.btm.cs
+*.odx.cs
+*.xsd.cs
+
+# OpenCover UI analysis results
+OpenCover/
+
+# Azure Stream Analytics local run output
+ASALocalRun/
+
+# MSBuild Binary and Structured Log
+*.binlog
+
+# NVidia Nsight GPU debugger configuration file
+*.nvuser
+
+# MFractors (Xamarin productivity tool) working folder
+.mfractor/
+
+# Local History for Visual Studio
+.localhistory/
+
+# BeatPulse healthcheck temp database
+healthchecksdb

.vs/BotFrameworkAccelerators/v16/.suo

@@ -5,6 +5,6 @@
     "\\SecuredWebChatControl\\Controllers",
     "\\SecuredWebChatControl\\wwwroot"
   ],
-  "SelectedNode": "\\SecuredWebChatControl\\README.md",
+  "SelectedNode": "\\README.md",
   "PreviewInSolutionExplorer": false
 }

.vs/VSWorkspaceState.json

@@ -0,0 +1,50 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+using System.Collections.Generic;
+using System.Linq;
+using Microsoft.Bot.Schema;
+using QnA.MultiturnQnAMaker;
+
+namespace QnAPrompting.Helpers
+{
+    public class CardHelper
+    {
+        /// <summary>
+        /// Get Hero card
+        /// </summary>
+        /// <param name="cardTitle">Title of the card</param>
+        /// <param name="prompts">List of suggested prompts</param>
+        /// <returns>Message activity</returns>
+        public static Activity GetHeroCard(string cardTitle, QnAPrompts[] prompts)
+        {
+            var chatActivity = Activity.CreateMessageActivity();
+            var buttons = new List<CardAction>();
+
+            var sortedPrompts = prompts.OrderBy(r => r.DisplayOrder);
+            foreach (var prompt in sortedPrompts)
+            {
+                buttons.Add(
+                    new CardAction()
+                    {
+                        Value = prompt.DisplayText,
+                        Type =  ActionTypes.ImBack,
+                        Title = prompt.DisplayText,
+                    });
+            }
+
+            var plCard = new HeroCard()
+            {
+                Title = cardTitle,
+                Subtitle = string.Empty,
+                Buttons = buttons
+            };
+
+            var attachment = plCard.ToAttachment();
+
+            chatActivity.Attachments.Add(attachment);
+
+            return (Activity)chatActivity;
+        }
+    }
+}

.vs/slnx.sqlite

@@ -0,0 +1,10 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+namespace QnA.MultiturnQnAMaker
+{
+    public class MultiturnQnAContext
+    {
+        public MultiturnQnAPrompts[] Prompts { get; set; }
+    }
+}

MultiturnQnAMaker/Changes to Startup.cs.pdf

@@ -0,0 +1,12 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+namespace QnA.MultiturnQnAMaker
+{
+    public class MultiturnQnAMetadata
+    {
+        public string Name { get; set; }
+
+        public string Value { get; set; }
+    }
+}

MultiturnQnAMaker/Dialogs/Changes to MainDialog.cs.pdf

@@ -0,0 +1,14 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+namespace QnA.MultiturnQnAMaker
+{
+    public class MultiturnQnAPrompts
+    {
+        public int DisplayOrder { get; set; }
+
+        public int QnaId { get; set; }
+
+        public string DisplayText { get; set; }
+    }
+}

MultiturnQnAMaker/Helpers/CardHelper.cs

@@ -0,0 +1,22 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+namespace QnA.MultiturnQnAMaker
+{
+    public class MultiturnQnAResult
+    {
+        public string[] Questions { get; set; }
+
+        public string Answer { get; set; }
+
+        public double Score { get; set; }
+
+        public int Id { get; set; }
+
+        public string Source { get; set; }
+
+        public MultiturnQnAMetadata[] Metadata { get; }
+
+        public MultiturnQnAContext Context { get; set; }
+    }
+}

MultiturnQnAMaker/Models/MultiturnQnAContext.cs

@@ -0,0 +1,10 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+namespace QnA.MultiturnQnAMaker
+{
+    public class MultiturnQnAResultList
+    {
+        public MultiturnQnAResult[] Answers { get; set; }
+    }
+}

MultiturnQnAMaker/Models/MultiturnQnAMetadata.cs

@@ -0,0 +1,17 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Threading.Tasks;
+
+namespace QnA.MultiturnQnAMaker
+{
+    /// <summary>
+    /// This is passed as the context in the body of the call to generateanswer API in the QnA service
+    /// </summary>
+    public class MultiturnQnAState
+    {
+        public int PreviousQnaId { get; set; }
+
+        public string PreviousUserQuery { get; set; }
+    }
+}

MultiturnQnAMaker/Models/MultiturnQnAPrompts.cs

@@ -0,0 +1,22 @@
+# Multiturn QnA Maker
+This accelerator shows how to add the ability to show the new follow-on prompts you can now add to
+QnA Maker knowledgebases.
+
+You can find an overview of this new multiturn QnA capability
+[here](https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/how-to/multiturn-conversation) 
+along with how to add follow-on prompts in the portal (see **Add new QnA pair as follow-up prompt** section
+for quick way to manually add 1 or 2 to get started)
+
+## To Use
+1. Create, build and deploy a Virtual Assistant bot as described [here](https://github.com/microsoft/botframework-solutions/blob/master/docs/tutorials/csharp/virtualassistant.md)
+2. Copy the **Helpers** folder to root project folder of your assistant (i.e. where the .csproj file is)
+3. Copy the files from the **Models** folder into the **Models** folder of your assistant
+4. Copy **Services\MultiturnQnAMaker.cs** to the **Services** folder of your assistant
+5. Edit your assistant's **Dialogs\MainDialog.cs** as outlined in **Dialogs\Changes to MainDialog.cs.pdf**
+6. Edit your assistant's **Services\BotServices.cs** as outlined in **Services\Changes to BotServices.cs.pdf**
+7. Edit your assistant's **Startup.cs** as outlined in **Changes to Startup.cs.pdf**
+8. Browse to [https://www.qnamaker.ai/](https://www.qnamaker.ai/) and find the **faq** for the assistant
+you deployed in step 1 and add a few QnAs with follow-on prompts as descrived [here](https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/how-to/multiturn-conversation) 
+(see **Add new QnA pair as follow-up prompt** section specifically)
+9. Sync the new QnA changes with your assistant as described [here](https://github.com/microsoft/botframework-solutions/blob/master/docs/tutorials/csharp/customizeassistant.md#update-your-local-lu-files-for-luis-and-qnamaker)
+10. Run the bot and test it with the bot emulator by typing in the multiturn QnA questions you added

MultiturnQnAMaker/Models/MultiturnQnAResult.cs

@@ -0,0 +1,90 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+using System.Collections;
+using System.Collections.Generic;
+using System.Net.Http;
+using System.Threading;
+using System.Threading.Tasks;
+using Microsoft.Bot.Builder;
+using Microsoft.Bot.Builder.AI.QnA;
+using Microsoft.Bot.Builder.Dialogs;
+using Microsoft.Bot.Schema;
+using Microsoft.Extensions.Configuration;
+using Newtonsoft.Json;
+using QnAPrompting.Helpers;
+
+namespace QnA.MultiturnQnAMaker
+{
+    public class MultiturnQnAMaker : QnAMaker
+    {
+        public const string FunctionStateName = "functionState";
+        private readonly HttpClient _httpClient;
+        private readonly QnAMakerEndpoint _endpoint;
+        private readonly QnAMakerOptions _options;
+
+        public MultiturnQnAMaker(QnAMakerEndpoint endpoint, HttpClient httpClient, IBotTelemetryClient telemetryClient, bool logPersonalInformation = false) : base(endpoint, null, httpClient, telemetryClient, logPersonalInformation)
+        {
+            _httpClient = httpClient;
+            _endpoint = endpoint;
+            _options = new QnAMakerOptions { Top = 3 };
+        }
+
+        public async Task<(MultiturnQnAState newState, IEnumerable<Activity> output)> GetAnswersAsync(MultiturnQnAState oldState, ITurnContext turnContext, QnAMakerOptions options, Dictionary<string, string> telemetryProperties, Dictionary<string, double> telemetryMetrics = null)
+        {
+            Activity outputActivity = null;
+            MultiturnQnAState newState = null;
+
+            var query = turnContext.Activity.Text;
+            var qnaResult = await QueryQnAServiceAsync(query, oldState);
+            var qnaAnswer = qnaResult[0].Answer;
+            var prompts = qnaResult[0].Context?.Prompts;
+
+            if (prompts == null || prompts.Length < 1)
+            {
+                outputActivity = MessageFactory.Text(qnaAnswer);
+            }
+            else
+            {
+                // Set bot state only if prompts are found in QnA result
+                newState = new MultiturnQnAState
+                {
+                    PreviousQnaId = qnaResult[0].Id,
+                    PreviousUserQuery = query
+                };
+
+                outputActivity = CardHelper.GetHeroCard(qnaAnswer, prompts);
+            }
+
+            return (newState, new Activity[] { outputActivity });
+        }
+
+        public async Task<MultiturnQnAResult[]> QueryQnAServiceAsync(string query, MultiturnQnAState oldState)
+        {
+            var requestUrl = $"{_endpoint.Host}/knowledgebases/{_endpoint.KnowledgeBaseId}/generateanswer";
+            var request = new HttpRequestMessage(HttpMethod.Post, requestUrl);
+            var jsonRequest = JsonConvert.SerializeObject(
+                new
+                {
+                    question = query,
+                    top = _options.Top,
+                    context = oldState,
+                    strictFilters = _options.StrictFilters,
+                    metadataBoost = _options.MetadataBoost,
+                    scoreThreshold = _options.ScoreThreshold,
+                }, Formatting.None);
+
+            request.Headers.Add("Authorization", $"EndpointKey {_endpoint.EndpointKey}");
+            request.Content = new StringContent(jsonRequest, System.Text.Encoding.UTF8, "application/json");
+
+            var response = await _httpClient.SendAsync(request);
+            response.EnsureSuccessStatusCode();
+
+            var contentString = await response.Content.ReadAsStringAsync();
+
+            var result = JsonConvert.DeserializeObject<MultiturnQnAResultList>(contentString);
+
+            return result.Answers;
+        }
+    }
+}