/TelcoChatBot

This application demonstrates how the Watson Conversation service can be used to build a simple on-board telco chat application

Primary LanguageJavaScript

Build a Telco Conversation Dashboard application using IBM Cloud & Watson Services

Overview

This application demonstrates how the Watson Conversation service can be used to build a simple on-board telco chat application.

  • We will learn and understand how to integrate the Conversation, Discovery and Cloudant services.

Following services are used from IBM Cloud:

  1. Watson Conversation Service
  2. Cloudant NoSQLDB Database Service
  3. Watson Discovery Service

See the app demo

For more information about Conversation, see the detailed documentation.

How the app works

The app interface is designed and trained for chatting with the telco customers. Your questions and commands are run against a small set of sample data trained with intents like these:

view profile
view account
edit email

These intents help the system to understand variations of questions and commands that you might submit.

Example commands that can be executed by the Conversation service are:

view profile
edit emailId
What are the available plans for Vodafone
What are the available plans for Idea
view my account
view my bill

Technical Architecture - Telco Chatbot

                                                                                 
  • The user writes a query about a service to the chatbot
  • The orchestrator accepts query, saves the user context & starts a REST call with the Cognitive APIs.
  • Depending on the nature of the query (long /Short tail), the answer is provided by either Watson Conversation API or Watson Discovery Services

Pre-requisities

Ensure that you have a IBM Cloud account

Deploy the app and explore the conversation flow

  1. Select "Deploy to IBM Cloud" icon below.

            Deploy to Bluemix

  1. This action deploys 1 application and 2 services. You can view this on your IBM Cloud Dashboard.

  2. Log in with your existing IBM Cloud account or Sign up

  3. Name your app and select your REGION, ORGANIZATION and SPACE. Then select DEPLOY.

  1. The deploy performs two actions:

    • deploys the app run time
    • creates a Conversation and Cloudant service instances
    • connects to the already created Discovery service

  2. To see the status of your app, you can click "Delivery Pipeline".

  1. The deployment can take some time.

  2. Deployment of the app might FAIL. The reason for the failure is that we have to configure the cloudant database.

To configure the cloudant database please follow the below steps:

Cloudant

  1. Click on "cloudant-db" from the IBM Cloud Dashboard. In the landing page, click on Launch button.

  2. Click on Databases from left hand navigation. Click on "Create Database" from top right corner.

  3. Give a name to the database, like telco-users

  4. To load demo / sample data to the database, two versions of data are available under resources folder: telco-users-<number>.json and telco-users-cloudant.txt

  5. Install couchimport tool to upload data to cloudant using the following commnands:

MAC / Linux:

Open the Terminal and run the following snippet:

sudo npm install -g couchimport

To get the URL, click on the App in Bluemix dashboard --> Runtime --> Environment Variable --> Under Cloudant service, check for the URL

export COUCH_URL="https://username:password@xxx-bluemix.cloudant.com"

export COUCH_DATABASE="telco-users"

cat telco-users-cloudant.txt | couchimport --db telco-users

Windows:

Open Command Prompt and run:

npm install -g couchimport (Refer https://nodejs.org/download/release/npm/ for npm installers)

To get the URL, click on the App in IBM Cloud dashboard --> Runtime --> Environment Variable --> Under Cloudant service, check for the URL

set COUCH_URL="https://username:password@xxx-bluemix.cloudant.com"

set COUCH_DATABASE="telco-users"

type telco-users-cloudant.txt | couchimport --db telco-users

Note:

  1. Install node.js for your OS from https://nodejs.org/

  2. To see if Node is installed, type the below on your command line

node -v

To see if Node Package Manager - npm is installed, type the below on your command line

npm -v

  1. Make sure that the telco-users-cloudant.txt file is under the same folder from where the Terminal/Command prompt commands are issued

Importing a workspace

To use the app you're creating, you need to add a workspace to your Conversation service. A workspace is a container for all the artifacts that define the behavior of your service (ie: intents, entities and chat flows).

For more information on workspaces, see the full Conversation service documentation.

  1. Navigate to the IBM Cloud dashboard, select the Conversation service that you created

  2. Go to the Manage menu item and select Launch Tool. This opens a new tab in your browser, where you are prompted to login if you have not done so before. Use your IBM Cloud credentials.

  3. Download the exported file that contains the Workspace contents by clicking exported JSON file

    • navigate to the resources folder to find telcobot-conversation-workspace-handson.json file
    • click on the "Raw" link which will open a browser
    • Select "Save As" and save the file as a json

  4. Select the import icon: . Browse to (or drag and drop) the JSON file. Choose to import Everything(Intents, Entities, and Dialog). Then select Import to finish importing the workspace.

  5. Refresh your browser. A new workspace tile is created in the tool. Select the menu button within the workspace tile, then select View details:

            Workpsace Details

In the Details UI, copy the 36 character UNID ID field. This is the WORKSPACE_ID. Retain this for the following step where we will create an environment variable. This varibale will be the handle for the application to refer to the Conversation Service that we created.

            

Load the Discovery documents

Launch the Watson Discovery tool. Create a new data collection and give the data collection a unique name.

             collection

Save the environment_id and collection_id for next step.

Under Add data to this collection use Drag and drop your documents here or browse from computer to seed the content with the four documents in resources/Discovery folder

Configure the WCS and Watson Discovery Service

  1. Click on the deployed app from IBM Cloud Dashboard

  2. Go to Runtime -> Environment variables section

  3. Under "User defined" section at the botton, click on Add button

  4. Under Name, enter WORKSPACE_ID (with out quotes) and under Value, copy the workspace id from importing workspace step

  5. Click on Add button again and, enter DISCOVERY_USERNAME and under Value, copy the Disocvery service username

  6. Click on Add button again and, enter DISCOVERY_PASSWORD and under Value, copy the Disocvery service password

  7. Click on Add button again and, enter DISCOVERY_ENVIRONMENT_ID and under Value, copy the environment id from previous step

  8. Click on Add button again and, enter DISCOVERY_COLLECTION_ID and under Value, copy the environment id from previous step

  9. Click on Save button. The app will automatically restart.

Running the app

  1. Launch the application from IBM Cloud dashboard

  2. Enter an username, say, ajay to login and see the chat bot working

Troubleshooting in IBM Cloud

In the Classic Experience:

  • Log in to IBM Cloud, you'll be taken to the dashboard
  • Navigate to the the application you previously created
  • Select Logs

            

  • If you want, filter the LOG TYPE by "APP"

            

License

This sample code is licensed under Apache 2.0. Full license text is available in LICENSE.

Open Source @ IBM

Find more open source projects on the IBM Github Page.