{"id":21,"date":"2016-11-09T03:23:36","date_gmt":"2016-11-09T03:23:36","guid":{"rendered":"http:\/\/freedville.com\/blog\/?p=21"},"modified":"2019-04-12T14:14:20","modified_gmt":"2019-04-12T14:14:20","slug":"training-a-personal-chatbot-with-watson-developer-cloud-apis","status":"publish","type":"post","link":"https:\/\/freedville.com\/blog\/2016\/11\/09\/training-a-personal-chatbot-with-watson-developer-cloud-apis\/","title":{"rendered":"Training a personal chatbot with Watson Developer Cloud APIs"},"content":{"rendered":"

The Watson Developer Cloud APIs<\/a> are intended to give you building blocks for building your own applications with the cognitive capabilities of Watson.  There’s been a lot of press on combining Watson and Slack<\/a>, and I’d like to give my own views on how one should get started with the training process.<\/p>\n

What is classification?<\/strong><\/p>\n

The key technology behind the Conversation<\/a> and Natural Language Classifier<\/a> services is the use of classification.  For text classification, the core question boils down to “given a block of text, is it more likely an X<\/em> or Y<\/em>?” or “given a block of text, should I classify it as an X<\/em> or Y<\/em>? The classifier is trained by selecting examples of text that mean X<\/em> and examples that mean Y<\/em>.  After the classifier is trained, it can make classification decisions on blocks of text it has never seen before.<\/p>\n

Finding training data for the classifier behind a chat bot<\/strong><\/p>\n

That’s all well and good in the abstract.  But how do we put it to use?  I’m going to describe how to build a personal chat bot.  I use an instant messaging program at work – it would be great if a chat bot could screen my incoming messages and respond for me, at least for the easy stuff.  To do this, I need to gather a significant amount of training data and train some classifiers.<\/p>\n

Fortunately, my instant messaging application logs all chat transcripts.  700MB of chat transcripts, in fact!  I first narrowed down the transcripts by searching for all messages containing a question mark.  This yields over 66,000 questions.  Scanning the questions gives me a rough idea of what kinds of questions I am being asked, but building a chat bot still feels overwhelming.  Now what?<\/p>\n

Searching for training data:
\ngrep -R \\? SametimeTranscripts > ..\/SametimeQuestions.html
\ncat ..\/SametimeQuestions.html | cut -d '>' -f 12 | cut -d '<' -f 1 | sort | uniq > ..\/SametimeQuestions.txt<\/code><\/p>\n

First, a major thing I did, and another that I did NOT do.  The thing I did was to narrow my aim.  Instead of building an overall chat bot, I narrowed in on a lunch-assisting chat bot.  The bot’s only job is to determine if a question is about lunch (my answer will be “I’d love to go, pick me up at 11:30”) or about anything else (in which case, don’t answer for me).  The thing I did NOT do was give up on my chat transcripts and manually create questions.  This is important, because classifiers work best if they are trained on representative data.  It would take less effort to create ‘synthetic’ questions, but the classifier performance would suffer (more on this later).<\/p>\n

Focusing on a simple classification scheme (“lunch” or “other”) made it easier to find representative questions.<\/p>\n

For “lunch”, I used simple ‘grep’ commands to find the word ‘lunch’ or restaurants I commonly go to.  Examples:
\ngrep -i lunch SametimeQuestions.txt
\ngrep -i carmens SametimeQuestions.txt<\/code><\/p>\n

For “other”, I simply grabbed a random sampling of questions (Perl script reference<\/a>)
\nperl -ne 'print ((0 == $. % 100) ? $_ : \"\")' SametimeQuestions.txt<\/code><\/p>\n

For a starter set, I copied 20+ questions from both command sets into a single Excel file.  Column A for the question, Column B for classification (‘lunch’ or ‘other’).<\/p>\n

Sample training data:
\nlunch @ 1130?,lunch
\ncarmen\u2019s?,lunch
\nmoes?,lunch
\nCan I call?,other
\nDo I need to assign a change set in order to check in?,other
\nAndrew- u have extra shinguard?,other
\nlet's chat after I grab some lunch .. you have some time this afternoon?,other<\/code><\/p>\n

Full training data: Lunch vs Other NLC Training Data<\/a><\/p>\n

The command which produced the question is a strong indicator of the classification I should use, but it’s worth noting this is not 100% reliable.  For instance, one of my questions was “let’s chat after I grab some lunch .. you have some time this afternoon?” – this is clearly not a lunch invitation but rather a desire to have a meeting, so I had to pay attention while classifying it.  After saving this file as a CSV, I was ready to upload it to the Watson APIs as training data.<\/p>\n

Protip: Double-check your file contents here.  String-escape your questions (or remove the commas), so that your training file is treated as a two-column CSV.  Beware also of special characters like “smart quotes”, which will be rejected by the training API.  (Fortunately, the API will tell you the line number of any special characters it doesn’t understand.)<\/p>\n

Sending training data to an NLC classifier service<\/strong><\/p>\n

I used NLC API instead of going right to Conversation since I want to focus on the training techniques and I find NLC slightly easier to get started with.  I followed the NLC Getting Started Reference<\/a> and created a service instance at https:\/\/console.ng.bluemix.net\/catalog\/services\/natural-language-classifier\/<\/a>.  Clicking the Credentials tab gives me the user, password, and URL I need to get started.  (The NLC API Reference<\/a> is a great cookbook to use once you have these three things.)<\/p>\n

Training my first classifier:
\ncurl -u \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\":\"xxxxxxxxxxxx\" -F training_data=@AndrewChatsNLCTraining.csv -F training_metadata=\"{\\\"language\\\":\\\"en\\\",\\\"name\\\":\"ARF-Chatbot-NLC\\\"}\" https:\/\/gateway.watsonplatform.net\/natural-language-classifier\/api\/v1\/classifiers
\n{
\n\"classifier_id\" : \"xxxxxxxxxx-nlc-xxxx\",
\n\"name\" : \"ARF-Chatbot-NLC\",
\n\"language\" : \"en\",
\n\"created\" : \"2016-11-07T03:27:26.678Z\",
\n\"url\" : \"https:\/\/gateway.watsonplatform.net\/natural-language-classifier\/api\/v1\/classifiers\/xxxxxxxxxx-nlc-xxxx\",
\n\"status\" : \"Training\",
\n\"status_description\" : \"The classifier instance is in its training phase, not yet ready to accept classify requests\"
\n}<\/code><\/p>\n

Protip: Make sure your curl command doesn’t have smart-quotes either, or the command won’t be recognized! (Several times curl gave me an error that a URL was not in the command, due to smart quotes)<\/p>\n

A few minutes later, I checked the status and the classifier was ready to sort text into “lunch” or “other” categories.<\/p>\n

Testing the classifer<\/strong><\/p>\n

My first question was close to the training set:
\ncurl -G -u \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\":\"xxxxxxxxxxxx\" https:\/\/gateway.watsonplatform.net\/natural-language-classifier\/api\/v1\/classifiers\/xxxxxxxxxx-nlc-xxxx\/classify --data-urlencode \"text=lunch @ 1145?\"<\/code><\/p>\n

with high confidence results:
\n{
\n\"classifier_id\" : \"xxxxxxxxxx-nlc-xxxx\",
\n\"url\" : \"https:\/\/gateway.watsonplatform.net\/natural-language-classifier\/api\/v1\/classifiers\/xxxxxxxxxx-nlc-xxxx\",
\n\"text\" : \"lunch @ 1145?\",
\n\"top_class\" : \"lunch\",
\n\"classes\" : [ {
\n\"class_name\" : \"lunch\",
\n\"confidence\" : 0.9923420767749419
\n}, {
\n\"class_name\" : \"other\",
\n\"confidence\" : 0.007657923225058088
\n} ]
\n}<\/code><\/p>\n

The training process yielded some other interesting results:<\/p>\n\n\n\n\n\t\n\n\t\n\t\n\t\n\t\n\t\n\t
Question<\/th>Classification<\/th>Confidence<\/th>\n<\/tr>\n<\/thead>\n
sure, when do you need it by?<\/td>other<\/td>99.4%<\/td>\n<\/tr>\n
talk after lunch?<\/td>lunch<\/td>99.0%<\/td>\n<\/tr>\n
can we talk after your lunch?<\/td>lunch<\/td>79.9%<\/td>\n<\/tr>\n
o'charleys?<\/td>lunch<\/td>95.1%<\/td>\n<\/tr>\n
production?<\/td>lunch<\/td>94.9%<\/td>\n<\/tr>\n
How much wood would a woodchuck chuck if a woodchuck could chuck wood?<\/td>other<\/td>80.7%<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\n

The classifier gets some questions right with very high confidence, and some very wrong as well.  It has extracted patterns from the training data.  My training data shows that a short question, or a question that uses the word lunch, is very likely to be a lunch question.  This was good for O’Charleys (a place I have not gone for lunch), or the 11:45 question (too late for me to go to lunch!), but bad for the quick question about our production environment (who can go to lunch if production is down?)<\/p>\n

How to improve the classifier<\/strong><\/p>\n

The solution will be to use more training data.  50 is the bare minimum number of cases to train a classifier, I should really have tried to collect 100 examples for each classification.  Additionally I should check that I have accurately sampled my transcripts (do I have questions about lunch with more words? shorter questions not about lunch? non-lunch questions that contain the word lunch?)<\/p>\n

It’s worth reiterating here the need to use representative training data rather than trying to create it synthetically.  If I was creating training data manually, I would have had a bunch of questions like “Hey Andrew, do you want to eat lunch with us today?”  Not only is that far better punctuation than I see in a typical chat transcript, it would provide other distracting or misleading signals to the classifier.  In my chat transcripts, the word “eat” appears in only 3 out of 66,000 questions, and none were in invitations to lunch!<\/p>\n

Conclusion<\/strong><\/p>\n

While the use of a lunch concierge chat bot is a bit tongue in cheek, I hope this shows you how to get started with text classification.  It’s important to use training data from reality, not your imagination, and to use a representative sample of that real data.<\/p>\n

Click through to part 2<\/a> where I explore more complicated classification scenarios, including classifying against multiple dimensions.<\/p>\n","protected":false},"excerpt":{"rendered":"

The Watson Developer Cloud APIs are intended to give you building blocks for building your own applications with the cognitive capabilities of Watson.  There’s been a lot of press on combining Watson and Slack, and…<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":[],"categories":[1],"tags":[9,5,4],"_links":{"self":[{"href":"https:\/\/freedville.com\/blog\/wp-json\/wp\/v2\/posts\/21"}],"collection":[{"href":"https:\/\/freedville.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/freedville.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/freedville.com\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/freedville.com\/blog\/wp-json\/wp\/v2\/comments?post=21"}],"version-history":[{"count":10,"href":"https:\/\/freedville.com\/blog\/wp-json\/wp\/v2\/posts\/21\/revisions"}],"predecessor-version":[{"id":427,"href":"https:\/\/freedville.com\/blog\/wp-json\/wp\/v2\/posts\/21\/revisions\/427"}],"wp:attachment":[{"href":"https:\/\/freedville.com\/blog\/wp-json\/wp\/v2\/media?parent=21"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/freedville.com\/blog\/wp-json\/wp\/v2\/categories?post=21"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/freedville.com\/blog\/wp-json\/wp\/v2\/tags?post=21"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}