14.nlp-with-dispatch

NLP with Dispatch

Bot Framework v4 NLP with Dispatch bot sample

This bot has been created using Bot Framework, it shows how to create a bot that relies on multiple LUIS.ai and QnAMaker.ai models for natural language processing (NLP).

Use the Dispatch model in cases when:

• Your bot consists of multiple language modules (LUIS + QnA) and you need assistance in routing user's utterances to these modules in order to integrate the different modules into your bot.
• Evaluate quality of intents classification of a single LUIS model.
• Create a text classification model from text files.

Prerequisites

This samples requires prerequisites in order to run.

Overview

This bot uses QnA Maker Service, an AI based cognitive service, to implement simple Question and Answer conversational patterns.

Create a QnAMaker Application to enable QnA Knowledge Bases

QnA knowledge base setup and application configuration steps can be found here.

Running the sample

• Clone the repository

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

• Bring up a terminal, navigate to botbuilder-samples\samples\python\14.nlp-with-dispatch folder
• Activate your desired virtual environment
• In the terminal, type pip install -r requirements.txt
• Update QNA_KNOWLEDGEBASE_ID, QNA_ENDPOINT_KEY, and QNA_ENDPOINT_HOST in config.py
• Update LUIS_APP_ID, LUIS_API_KEY, and LUIS_API_HOST_NAME in config.py
• Run your bot with python app.py

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

• Launch Bot Framework Emulator
• File -> Open Bot
• Paste this URL in the emulator window - http://localhost:3978/api/messages

Dispatch

Once you are comfortable with the concepts presented in this sample, you may want to configure Dispatch using a CLI tool. Dispatch CLI is a CLI tool that enables you to create a dispatch NLP model across the different LUIS applications and/ or QnA Maker Knowledge Bases you have for your bot.

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
• QnA Maker Documentation
• Activity processing
• QnA Maker CLI
• Channels and Bot Connector Service
• Azure Portal
• LUIS documentation
• Using LUIS for Language Understanding