Skip to content

Latest commit

 

History

History
 
 

11.qnamaker

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
deploymentTemplates
deploymentTemplates
 
 
src
src
 
 
LICENSE
LICENSE
 
 
README.md
README.md
 
 
pom.xml
pom.xml
 
 

README.md

QnA Maker

Bot Framework v4 QnA Maker bot sample

This bot has been created using Bot Framework, it shows how to create a bot that uses the QnA Maker Cognitive AI service.

The QnA Maker Service enables you to build, train and publish a simple question and answer bot based on FAQ URLs, structured documents or editorial content in minutes. In this sample, we demonstrate how to use the QnA Maker service to answer questions based on a FAQ text file used as input.

This sample is a Spring Boot app and uses the Azure CLI and azure-webapp Maven plugin to deploy to Azure.

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.
  • Java 1.8+
  • Install Maven
  • An account on Azure if you want to deploy to Azure.

Create a QnAMaker Application to enable QnA Knowledge Bases

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

Once the Knowledge Base was created and published, refer to this section for the instructions on how to obtain the QnAMaker parameters to be used in the application settings.

To try this sample

  • From the root of this project folder:
    • Build the sample using mvn package
    • Run it by using java -jar .\target\bot-qna-sample.jar

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

Interacting with the bot

QnA Maker enables you to power a question and answer service from your semi-structured content.

One of the basic requirements in writing your own bot is to seed it with questions and answers. In many cases, the questions and answers already exist in content like FAQ URLs/documents, product manuals, etc. With QnA Maker, users can query your application in a natural, conversational manner. QnA Maker uses machine learning to extract relevant question-answer pairs from your content. It also uses powerful matching and ranking algorithms to provide the best possible match between the user query and the questions.

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