shyampurk/multiLingualFAQBot

Multi Lingual FAQ Bot

MultiLingual FAQBot

MultiLingualFAQBot Using IBM's Retrieve and Rank API , Language Translation API

This repository contains the source code of a demo app that acts as a vertical search engine for a product manual. Cannon EOS550D camera user manual has been used as an example here. By parsing the camera manual through the Watson Retrieve and Rank API, this app provides a search interface to the users so that they can jump to the sections of the manual that contain the search words or phrases.It also provides Language translation from english to german , french and arabic.

Demo Setup Overview

This README file contains the instructions for setting up the services for hosting the demo app. The demo app is a standalone web page whose code is available here

The following services are required to be setup for deploying the backend for this app

Watson Document Conversion

Watson Retrieve and Rank

Watson Language Translator

PubNub Blocks (Refer this README file )

You will need to clone this repository and must have a valid IBM and PubNub account. Both services offer free tier accounts for demo purposes. Once the services are setup, you can launch the app by opening the main index file in browser.

Document Conversion Service - Setting up

Step 1 :

Login to the Bluemix account with the valid credentials, and goto Catalog.

Step 2 :

Select the Document Conversion Service under the Watson Services.

Step 3 :

Give the service name and scroll down the page,select the Free plan (you can see more about pricing options in that page) and click on the "create" button.

Step 4 :

Once you create the service, it will redirect you to the homepage of the service. There, click on the "Service Credentials" to get the apikey to access the Document Conversion api. Make a note of this API key.

Retrieve and Rank Service - Setting up

Step 1 :

Login to the Bluemix account with the valid credentials, and goto Catalog.

Step 2 :

Select the Retrieve and Rank Service under the Watson Services.

Step 3 :

Give the service name and scroll down the page,select the Free plan (you can see more about pricing options in that page) and click on the "create" button.

Step 4 :

Once you create the service, it will redirect you to the homepage of the service. There, click on the "Service Credentials" to get the apikey to access the Retrieve and Rank API. Make a note of this API key.

Language Translator Service - Setting up

Step 1 :

Login to the Bluemix account with the valid credentials, and goto Catalog.

Step 2 :

Select the Language Translator Service under the Watson Services.

Step 3 :

Give the service name and scroll down the page,select the Free plan (you can see more about pricing options in that page) and click on the "create" button.

Step 4 :

Once you create the service, it will redirect you to the homepage of the service. There, click on the "Service Credentials" to get the apikey to access the Language Translator api. Make a note of this API key.

Training the Retrieve and Rank API with Camera User Manual

Step 1 :

Open Watson's Retrieve and Rank Service page . Now we will create a solr cluster & collection and then upload the document and questions.

Step 2 :

Select the Conversation Service you have created earlier steps

Step 3 :

Select the Retrieve and Rank Service you have created earlier steps

Step 4 : Cluster Creation

Select the Create cluster button from the left side panel

Step 5 :

Provide proper cluster name and specify the size of cluster

Step 6 : Collection Creation

Select Create Collection button to setup a collection for our documents

Step 7 :

Set a collection name and select language type and click create

Step 8 :

These are our cluster key and collection name

Step 9 : Upload The Product Manual Document

Upload this camera manual to the collection

Step 10 : Upload Sample Query Question

Upload this set of sample questions set1 or set2 to the Retrieve and Rank Service