Orchestrator entities sample (#6340)

* Orchestrator reorganization

1. Moved ModelTuning from botbuilder-samples repo
2. Delete OrchestratorDispatch Composer sample (moved to botbuilder-samples repo)

* Update FAQ.md

* Orchestrator with entities sample

Author: tsuwandy

Orchestrator/Samples/dotnet/nlp-with-entities/.gitignore

@@ -0,0 +1,9 @@
+# Assets generated by luis:build, luis:cross-train
+**/model
+**/[Gg]enerated
+**/*.blu
+*.json
+**/*.targets
+**/*.props
+**/*.cache
+*.dgspec.json

Orchestrator/Samples/dotnet/nlp-with-entities/AdapterWithErrorHandler.cs

@@ -0,0 +1,48 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+using System;
+using Microsoft.Bot.Builder;
+using Microsoft.Bot.Builder.Integration.AspNet.Core;
+using Microsoft.Bot.Builder.TraceExtensions;
+using Microsoft.Extensions.Configuration;
+using Microsoft.Extensions.Logging;
+
+namespace Microsoft.BotBuilderSamples
+{
+    public class AdapterWithErrorHandler : BotFrameworkHttpAdapter
+    {
+        public AdapterWithErrorHandler(IConfiguration configuration, ILogger<BotFrameworkHttpAdapter> logger, ConversationState conversationState = null)
+            : base(configuration, logger)
+        {
+            OnTurnError = async (turnContext, exception) =>
+            {
+                // Log any leaked exception from the application.
+                logger.LogError(exception, $"[OnTurnError] unhandled error : {exception.Message}");
+
+                // Send a message to the user
+                await turnContext.SendActivityAsync("The bot encountered an error or bug.");
+                await turnContext.SendActivityAsync("To run this sample make sure you have the LUIS and QnA models deployed.");
+                await turnContext.SendActivityAsync("To continue to run this bot, please fix the bot source code.");
+
+                if (conversationState != null)
+                {
+                    try
+                    {
+                        // Delete the conversationState for the current conversation to prevent the
+                        // bot from getting stuck in a error-loop caused by being in a bad state.
+                        // ConversationState should be thought of as similar to "cookie-state" in a Web pages.
+                        await conversationState.DeleteAsync(turnContext);
+                    }
+                    catch (Exception e)
+                    {
+                        logger.LogError(e, $"Exception caught on attempting to Delete ConversationState : {e.Message}");
+                    }
+                }
+
+                // Send a trace activity, which will be displayed in the Bot Framework Emulator
+                await turnContext.TraceActivityAsync("OnTurnError Trace", exception.Message, "https://www.botframework.com/schemas/error", "TurnError");
+            };
+        }
+    }
+}

Orchestrator/Samples/dotnet/nlp-with-entities/BotServices.cs

@@ -0,0 +1,61 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+using Microsoft.Bot.Builder.AI.Luis;
+using Microsoft.Bot.Builder.AI.Orchestrator;
+using Microsoft.Bot.Builder.AI.QnA;
+using Microsoft.Extensions.Configuration;
+
+namespace Microsoft.BotBuilderSamples
+{
+    public class BotServices : IBotServices
+    {
+        public BotServices(IConfiguration configuration, OrchestratorRecognizer dispatcher)
+        {
+            // Read the setting for cognitive services (LUIS, QnA) from the appsettings.json
+            // If includeApiResults is set to true, the full response from the LUIS api (LuisResult)
+            // will be made available in the properties collection of the RecognizerResult
+            LuisHomeAutomationRecognizer = CreateLuisRecognizer(configuration, "LuisHomeAutomationAppId");
+            LuisWeatherRecognizer = CreateLuisRecognizer(configuration, "LuisWeatherAppId");
+
+            Dispatch = dispatcher;
+
+            SampleQnA = new QnAMaker(new QnAMakerEndpoint
+            {
+                KnowledgeBaseId = configuration["QnAKnowledgebaseId"],
+                EndpointKey = configuration["QnAEndpointKey"],
+                Host = configuration["QnAEndpointHostName"]
+            });
+        }
+
+        public OrchestratorRecognizer Dispatch { get; private set; }
+        
+        public QnAMaker SampleQnA { get; private set; }
+        
+        public LuisRecognizer LuisHomeAutomationRecognizer { get; private set; }
+
+        public LuisRecognizer LuisWeatherRecognizer { get; private set; }
+
+        private LuisRecognizer CreateLuisRecognizer(IConfiguration configuration, string appIdKey)
+        {
+            var luisApplication = new LuisApplication(
+                configuration[appIdKey],
+                configuration["LuisAPIKey"],
+                configuration["LuisAPIHostName"]);
+
+            // Set the recognizer options depending on which endpoint version you want to use.
+            // More details can be found in https://docs.microsoft.com/en-gb/azure/cognitive-services/luis/luis-migration-api-v3
+            var recognizerOptions = new LuisRecognizerOptionsV2(luisApplication)
+            {
+                IncludeAPIResults = true,
+                PredictionOptions = new LuisPredictionOptions()
+                {
+                    IncludeAllIntents = true,
+                    IncludeInstanceData = true
+                }
+            };
+
+            return new LuisRecognizer(recognizerOptions);
+        }
+    }
+}

Orchestrator/Samples/dotnet/nlp-with-entities/Bots/DispatchBot.cs

@@ -0,0 +1,125 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+using System.Collections.Generic;
+using System.Linq;
+using System.Threading;
+using System.Threading.Tasks;
+using Microsoft.Azure.CognitiveServices.Language.LUIS.Runtime.Models;
+using Microsoft.Bot.Builder;
+using Microsoft.Bot.Builder.Dialogs;
+using Microsoft.Bot.Schema;
+using Microsoft.Extensions.Logging;
+
+namespace Microsoft.BotBuilderSamples
+{
+    public class DispatchBot : ActivityHandler
+    {
+        private ILogger<DispatchBot> _logger;
+        private IBotServices _botServices;
+
+        public DispatchBot(IBotServices botServices, ILogger<DispatchBot> logger)
+        {
+            _logger = logger;
+            _botServices = botServices;
+        }
+
+        protected override async Task OnMessageActivityAsync(ITurnContext<IMessageActivity> turnContext, CancellationToken cancellationToken)
+        {
+            var dc = new DialogContext(new DialogSet(), turnContext, new DialogState());
+            // Top intent tell us which cognitive service to use.
+            var allScores = await _botServices.Dispatch.RecognizeAsync(dc, (Activity)turnContext.Activity, cancellationToken);
+            var topIntent = allScores.Intents.First().Key;
+
+            // Detected entities which could be used to help with intent dispatching, for example, when top intent score is too low or
+            // when there are multiple top intents with close scores.
+            var entities = allScores.Entities.Children().Where(t => t.Path != "$instance");
+            
+            // Next, we call the dispatcher with the top intent.
+            await DispatchToTopIntentAsync(turnContext, topIntent, cancellationToken);
+        }
+
+        protected override async Task OnMembersAddedAsync(IList<ChannelAccount> membersAdded, ITurnContext<IConversationUpdateActivity> turnContext, CancellationToken cancellationToken)
+        {
+            const string WelcomeText = "Type a greeting, or a question about the weather to get started.";
+
+            foreach (var member in membersAdded)
+            {
+                if (member.Id != turnContext.Activity.Recipient.Id)
+                {
+                    await turnContext.SendActivityAsync(MessageFactory.Text($"Welcome to Dispatch bot {member.Name}. {WelcomeText}"), cancellationToken);
+                }
+            }
+        }
+
+        private async Task DispatchToTopIntentAsync(ITurnContext<IMessageActivity> turnContext, string intent, CancellationToken cancellationToken)
+        {
+            switch (intent)
+            {
+                case "HomeAutomation":
+                    await ProcessHomeAutomationAsync(turnContext, cancellationToken);
+                    break;
+                case "Weather":
+                    await ProcessWeatherAsync(turnContext, cancellationToken);
+                    break;
+                case "QnAMaker":
+                    await ProcessSampleQnAAsync(turnContext, cancellationToken);
+                    break;
+                default:
+                    _logger.LogInformation($"Dispatch unrecognized intent: {intent}.");
+                    await turnContext.SendActivityAsync(MessageFactory.Text($"Dispatch unrecognized intent: {intent}."), cancellationToken);
+                    break;
+            }
+        }
+
+        private async Task ProcessHomeAutomationAsync(ITurnContext<IMessageActivity> turnContext, CancellationToken cancellationToken)
+        {
+            _logger.LogInformation("ProcessHomeAutomationAsync");
+
+            // Retrieve LUIS result for HomeAutomation.
+            var recognizerResult = await _botServices.LuisHomeAutomationRecognizer.RecognizeAsync(turnContext, cancellationToken);
+            var result = recognizerResult.Properties["luisResult"] as LuisResult;
+
+            var topIntent = result.TopScoringIntent.Intent; 
+            
+            await turnContext.SendActivityAsync(MessageFactory.Text($"HomeAutomation top intent {topIntent}."), cancellationToken);
+            await turnContext.SendActivityAsync(MessageFactory.Text($"HomeAutomation intents detected:\n\n{string.Join("\n\n", result.Intents.Select(i => i.Intent))}"), cancellationToken);
+            if (result.Entities.Count > 0)
+            {
+                await turnContext.SendActivityAsync(MessageFactory.Text($"HomeAutomation entities were found in the message:\n\n{string.Join("\n\n", result.Entities.Select(i => i.Entity))}"), cancellationToken);
+            }
+        }
+
+        private async Task ProcessWeatherAsync(ITurnContext<IMessageActivity> turnContext, CancellationToken cancellationToken)
+        {
+            _logger.LogInformation("ProcessWeatherAsync");
+
+            // Retrieve LUIS result for Weather.
+            var recognizerResult = await _botServices.LuisWeatherRecognizer.RecognizeAsync(turnContext, cancellationToken);
+            var result = recognizerResult.Properties["luisResult"] as LuisResult;
+            var topIntent = result.TopScoringIntent.Intent;
+
+            await turnContext.SendActivityAsync(MessageFactory.Text($"ProcessWeather top intent {topIntent}."), cancellationToken);
+            await turnContext.SendActivityAsync(MessageFactory.Text($"ProcessWeather Intents detected::\n\n{string.Join("\n\n", result.Intents.Select(i => i.Intent))}"), cancellationToken);
+            if (result.Entities.Count > 0)
+            {
+                await turnContext.SendActivityAsync(MessageFactory.Text($"ProcessWeather entities were found in the message:\n\n{string.Join("\n\n", result.Entities.Select(i => i.Entity))}"), cancellationToken);
+            }
+        }
+
+        private async Task ProcessSampleQnAAsync(ITurnContext<IMessageActivity> turnContext, CancellationToken cancellationToken)
+        {
+            _logger.LogInformation("ProcessSampleQnAAsync");
+
+            var results = await _botServices.SampleQnA.GetAnswersAsync(turnContext);
+            if (results.Any())
+            {
+                await turnContext.SendActivityAsync(MessageFactory.Text(results.First().Answer), cancellationToken);
+            }
+            else
+            {
+                await turnContext.SendActivityAsync(MessageFactory.Text("Sorry, could not find an answer in the Q and A system."), cancellationToken);
+            }
+        }
+    }
+}

Orchestrator/Samples/dotnet/nlp-with-entities/CognitiveModels/HomeAutomation.lu

@@ -0,0 +1,106 @@
+
+> LUIS application information
+> !# @app.name = Home Automation
+> !# @app.desc = Home Automation LUIS application - Bot Builder Samples
+> !# @app.versionId = 0.1
+> !# @app.culture = en-us
+> !# @app.luis_schema_version = 4.0.0
+> !# @app.tokenizerVersion = 1.0.0
+
+
+> # Intent definitions
+
+## ControlDevice
+- {@Room=breezeway} on please
+- change {@deviceProperty=temperature} to seventy two degrees
+- {@Device=coffee bar} on please
+- decrease {@deviceProperty=temperature} for me please
+- dim {@Room=kitchen} {@Device=lights} to 25 .
+- {@Device=fish pond} off please
+- {@Device=fish pond} on please
+- {@Device=illuminate} please
+- {@Room=living room} {@Device=lamp} on please
+- {@Room=living room} {@Device=lamps} off please
+- lock the {@Device=doors} for me please
+- lower your {@deviceProperty=volume}
+- make {@Device=camera 1} off please
+- make some {@Device=coffee}
+- play {@Device=dvd}
+- set {@Device=lights} out in {@Room=bedroom}
+- set {@Device=lights} to {@deviceProperty=bright}
+- set {@Device=lights} to {@deviceProperty=concentrate}
+- shut down my work {@Device=computer}
+- snap switch {@Device=fan} fifty percent
+- start {@Room=master bedroom} {@Device=light}.
+- {@Room=theater} on please
+- turn {@Device=dimmer} off
+- turn off {@Device=ac} please
+- turn off {@Room=foyer} {@Device=lights}
+- turn off {@Room=living room} {@Device=light}
+- turn off {@Device=staircase}
+- turn off venice {@Device=lamp}
+- turn on {@Room=bathroom} {@Device=heater}
+- turn on {@Device=external speaker}
+- turn on {@Room=kitchen} {@Device=faucet}
+- turn on {@Device=light} in {@Room=bedroom}
+- turn on my {@Room=bedroom} {@Device=lights}.
+- turn on the {@Room=furnace room} {@Device=lights}
+- turn on the internet in my {@Room=bedroom} please
+- turn on {@Device=thermostat} please
+- turn the {@Device=fan} to high
+- turn {@Device=thermostat} on 70.
+- {@Device_PatternAny} off [please]
+- {@Device_PatternAny} in {Room_PatternAny} on [please]
+- turn on {@Device_PatternAny} in {Room_PatternAny}
+- turn off {@Device_PatternAny} in {Room_PatternAny}
+- {@Device_PatternAny} in {Room_PatternAny} off [please]
+- {@Device_PatternAny} on [please]
+- turn on {@Device_PatternAny}
+
+
+## None
+
+
+> # Entity definitions
+
+@ ml Device
+
+@ ml deviceProperty
+
+@ ml Room
+
+
+> # PREBUILT Entity definitions
+
+@ prebuilt number
+
+
+> # Phrase list definitions
+
+
+> # List entities
+
+@ list Operation = 
+	- off :
+		- turn off
+		- switch off
+		- lock
+		- out
+		- shut down
+		- stop
+	- on :
+		- turn on
+		- switch on
+		- unlock
+		- un lock
+		- boot up
+		- start
+
+
+> # RegEx entities
+
+
+> # Pattern.Any entities
+
+@ patternany Device_PatternAny
+@ patternany Room_PatternAny

Orchestrator/Samples/dotnet/nlp-with-entities/CognitiveModels/QnAMaker.qna

@@ -0,0 +1,21 @@
+# ? hi
+```
+hello
+```
+
+# ? greetings
+- good morning
+- good evening
+```
+Hello!
+```
+
+# ? What are you?
+- What?
+- What do you do?
+- Who are you?
+- What is your name?
+- What should I call you?
+```
+I am the LUIS-QnAMaker Dispatch bot! This sample demonstrates using several LUIS applications and QnA Maker knowledge base using Orchestrator.
+```