Skip to content

21.luis-with-appinsights

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History
 
 

21.luis-with-appinsights

README.md

This sample shows how to integrate LUIS to a bot with ASP.Net Core 2.

To try this sample

  • Clone the samples repository
git clone https://github.com/Microsoft/botbuilder-samples.git
  1. Install the Bot CLI Tools
npm install -g chatdown msbot ludown luis-apis qnamaker botdispatch luisgen
  1. Setup Azure Powershell (If you have never done so before)
    • To login, run:
Connect-AzureRmAccount
- To select your Azure subscription, run:

Select-AzureRmSubscription -Subscription "subscription-name"

  1. Collect your Luis Authoring Key from the the LUIS portal by selecting your name in the top right corner. Save this key for the next step.

  2. Run the following command from the project directory:

msbot clone services --name "<NAME>" --luisAuthoringKey "<YOUR AUTHORING KEY>" --folder "DeploymentScripts/MsbotClone" --location "westus" --verbose --appId <YOUR APP ID> --appSecret <YOUR APP SECRET PASSWORD>

NOTE: You can obtain your appId and appSecret at the Microsoft's Application Registration Portal

NOTE: By default your Luis Applications will be deployed to your free starter endpoint. An Azure LUIS service will be deployed along with your bot but you must manually add and publish to it from the luis.ai portal and update your key in the .bot file.

  1. Note the generated secret generated by msbot.
  • The secret key is used later for appsettings.json.
The secret used to decrypt <NAME>.bot is:
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX=
NOTE: This secret is not recoverable and you should store this secret in a secure place according to best security practices.
Your project may be configured to rely on this secret and you should update it as appropriate.
  1. Inspect Bot configuration file.
  • The msbot clone command above generates a bot configuration file.
  • The name of the bot configuration file is .bot, where is the name of your bot used in the msbot clone step.
  • The configuration file can be loaded by the Microsoft Bot Framework Emulator.
  1. Update in `botbuilder-samples\samples\csharp_dotnetcore\21.luis-with-appsinsights\Startup.cs'.
        public void ConfigureServices(IServiceCollection services)
        {
            ...

            var botConfig = BotConfiguration.Load(botFilePath ??  @".\luis-with-appinsights.bot"..);
            ...
  1. Update "YOUR_LUIS_SERVICE_NAME" in `botbuilder-samples\samples\csharp_dotnetcore\21.luis-with-appsinsights\LuisBot.cs'.
    public class LuisBot : IBot
   {
      ...
       public static readonly string LuisKey = "YOUR_LUIS_SERVICE_NAME";
  1. Right click on the generated bot configuration file, click "Properties".
  • Ensure "Copy to Output Directory" is set to "Copy always".
  1. Update your appsettings.json with your .bot file path and .bot file secret.
  • Update the botFilePath with the name of your generated bot configuration file.
  • Update the botFileSecret with the secret that the msbot tool generated from step 5 above.
{
    "botFilePath": "<YOUR BOT CONFIG>.bot",
    "botFileSecret": "<YOUR BOT SECRET>"
}

Prerequisites

Set up LUIS

(Optional) Install LUDown

  • (Optional) Install the LUDown here to help describe language understanding components for your bot.

Install Application Insights

  • Follow instructions here to set up your Application Insights service.
  • Note: The Application Insights will automatically update the appsettings.json file.

Running Locally

Visual Studio

  • Navigate to the samples folder (botbuilder-samples\samples\csharp_dotnetcore\21.luis-with-appsinsights) and open LuisBotAppInsights.csproj in Visual Studio
  • Run the project (press F5 key).

.NET Core CLI

  • Install the .NET Core CLI tools.
  • Using the command line, navigate to botbuilder-samples\samples\csharp_dotnetcore\21.luis-with-appsinsights folder.
  • Type 'dotnet run'.

Testing the bot using Bot Framework Emulator

Microsoft Bot Framework Emulator is a desktop application that allows bot developers to test and debug their bots on localhost or running remotely through a tunnel.

  • Install the Bot Framework Emulator from here.

Connect to bot using Bot Framework Emulator V4

  • Launch the Bot Framework Emulator
  • File -> Open bot and navigate to botbuilder-samples\samples\csharp_dotnetcore\21.luis-with-appsinsights folder.
  • Select luis-with-appinsights.bot file.

Deploy this bot to Azure

You can use the MSBot Bot Builder CLI tool to clone and configure any services this sample depends on.

To install all Bot Builder tools -

Ensure you have Node.js version 8.5 or higher

npm i -g msbot chatdown ludown qnamaker luis-apis botdispatch luisgen

To clone this bot, run

msbot clone services -f DeploymentScripts/MsbotClone -n <BOT-NAME> -l <Azure-location, ie westus> --subscriptionId <Azure-subscription-id>

Further reading