BotBuilder-Samples/samples/javascript_nodejs/21.corebot-app-insights

CoreBot with Application Insights

Bot Framework v4 core bot sample.

This bot has been created using Bot Framework, it shows how to:

• Use LUIS to implement core AI capabilities
• Implement a multi-turn conversation using Dialogs
• Handle user interruptions for such things as Help or Cancel
• Prompt for and validate requests for information from the user
• Use Application Insights to monitor your bot

Prerequisites

This sample requires prerequisites in order to run.

Overview

This bot uses LUIS, an AI based cognitive service, to implement language understanding and Application Insights, an extensible Application Performance Management (APM) service for web developers on multiple platforms.

• Node.js version 18 or higher

  # determine node version
  node --version
  

Create a LUIS Application to enable language understanding

The LUIS model for this example can be found under CognitiveModels/FlightBooking.json and the LUIS language model setup, training, and application configuration steps can be found here.

Once you created the LUIS model, update .env with your LuisAppId, LuisAPIKey, LuisAPIHostName and AppInsights's InstrumentationKey (more info on instrumentation key here).

  "LuisAppId": "Your LUIS App Id",
  "LuisAPIKey": "Your LUIS Subscription key here",
  "LuisAPIHostName": "Your LUIS App region here (i.e: westus.api.cognitive.microsoft.com)"
  "InstrumentationKey": "Your AppInsights instrumentation key here"

Add Application Insights service to enable the bot monitoring

Application Insights resource creation steps can be found here.

To try this sample

• Clone the repository

  git clone https://github.com/microsoft/botbuilder-samples.git
  

• In a terminal, navigate to samples/javascript_nodejs/21.corebot-app-insights

  cd samples/javascript_nodejs/21.corebot-app-insights
  

• Install modules

  npm install
  

• Setup LUIS

  The prerequisites outlined above contain the steps necessary to provision a language understanding model on www.luis.ai. Refer to Create a LUIS Application to enable language understanding above for directions to setup and configure LUIS.

• Run the sample

  npm start
  

Testing the bot using Bot Framework Emulator

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 latest Bot Framework Emulator from here

Connect to the bot using Bot Framework Emulator

• Launch Bot Framework Emulator
• File -> Open Bot
• Enter a Bot URL of http://localhost:3978/api/messages

Deploy the bot to Azure

To learn more about deploying a bot to Azure, see Deploy your bot to Azure for a complete list of deployment instructions.

Further reading

• Bot Framework Documentation
• Bot Basics
• Dialogs
• Gathering Input Using Prompts
• Activity processing
• Azure Bot Service Introduction
• Azure Bot Service Documentation
• Azure CLI
• Azure Portal
• Language Understanding using LUIS
• Application Insights
• Channels and Bot Connector Service
• Restify
• dotenv