// maintains state.<p></p>
<p>var prompt = require('prompt-sync')();<br>
var ConversationV1 = require('watson-developer-cloud/conversation/v1');</p>
<p>// Set up Conversation service.<br>
var conversation = new ConversationV1({<br>
username: 'USERNAME', // replace with username from service key<br>
password: 'PASSWORD', // replace with password from service key<br>
path: { workspace_id: 'WORKSPACE_ID' }, // replace with workspace ID<br>
version_date: '2016-07-11'<br>
});</p>
<p>// Start conversation with empty message.<br>
conversation.message({}, processResponse);</p>
<p>// Process the conversation response.<br>
function processResponse(err, response) {<br>
if (err) {<br>
console.error(err); // something went wrong<br>
return;<br>
}</p>
<p> // If an intent was detected, log it out to the console.<br>
if (response.intents.length > 0) {<br>
console.log('Detected intent: #' + response.intents[0].intent);<br>
}</p>
<p> // Display the output from dialog, if any.<br>
if (response.output.text.length != 0) {<br>
console.log(response.output.text[0]);<br>
}</p>
<p> // Prompt for the next round of input.<br>
var newMessageFromUser = prompt('>> ');<br>
// Send back the context to maintain state.<br>
conversation.message({<br>
input: { text: newMessageFromUser },<br>
context : response.context,<br>
}, processResponse)<br>
}</p>
This post introduces the Importance of Context to maintain the state of a Conversation while building a bot more specifically a chatbot.
A conversation (or chat) is a chain of statements exchanged between two or more individuals. Mostly, conversations happen on a particular topic or in a situation. Whatever the topic or situation is, Context is very important to maintain the state of a conversation.
In the world of cognitive computing, computers are conversing with humans as ChatBots or in short Bots. As Alan Turing famously quoted
So, even computers need the so called Context to keep the conversation flowing and to deceive us as humans.
Why am I so contextual today? Looks like chatting with a Bot for a week took a toll on me or reading the below line from the Watson Conversation documentation had its impact,
Technically,
A context includes a unique identifier for each conversation with a user, as well as a counter that is incremented with each turn of the conversation. If we don’t preserve the context, each round of input appeared to be the start of a new conversation. We can fix that by saving the context and sending it back to the Conversation service each time.
Code to achieve Context persistence
In Javascript,
// maintains state.<p></p>
<p>var prompt = require('prompt-sync')();<br>
var ConversationV1 = require('watson-developer-cloud/conversation/v1');</p>
<p>// Set up Conversation service.<br>
var conversation = new ConversationV1({<br>
username: 'USERNAME', // replace with username from service key<br>
password: 'PASSWORD', // replace with password from service key<br>
path: { workspace_id: 'WORKSPACE_ID' }, // replace with workspace ID<br>
version_date: '2016-07-11'<br>
});</p>
<p>// Start conversation with empty message.<br>
conversation.message({}, processResponse);</p>
<p>// Process the conversation response.<br>
function processResponse(err, response) {<br>
if (err) {<br>
console.error(err); // something went wrong<br>
return;<br>
}</p>
<p> // If an intent was detected, log it out to the console.<br>
if (response.intents.length > 0) {<br>
console.log('Detected intent: #' + response.intents[0].intent);<br>
}</p>
<p> // Display the output from dialog, if any.<br>
if (response.output.text.length != 0) {<br>
console.log(response.output.text[0]);<br>
}</p>
<p> // Prompt for the next round of input.<br>
var newMessageFromUser = prompt('>> ');<br>
// Send back the context to maintain state.<br>
conversation.message({<br>
input: { text: newMessageFromUser },<br>
context : response.context,<br>
}, processResponse)<br>
}</p>
In Android, using Watson Developer Cloud Java SDK
private Map<String,Object> context = new HashMap<>();<p></p>
<p> ConversationService service = new ConversationService(ConversationService.VERSION_DATE_2016_09_20);<br>
service.setUsernameAndPassword("Your Watson service UserName", "Your watson service PassWord");<br>
MessageRequest newMessage = new MessageRequest.Builder().inputText(inputmessage).context(context).build();<br>
MessageResponse response = service.message("Your Workspace Id", newMessage).execute();</p>
<p> //Passing Context of last conversation<br>
if(response.getContext() !=null)<br>
{<br>
context.clear();<br>
context = response.getContext();</p>
<p> }</p>
Check the complete Android code (link resides outside ibm.com) – ChatBot Repo (link resides outside ibm.com) on Github
In Swift 3.0, using swift watson sdk
import Conversation<p></p>
<p>let username = "your-username-here"<br>
let password = "your-password-here"<br>
let version = "YYYY-MM-DD" // use today's date for the most recent version<br>
let conversation = Conversation(username: username, password: password, version: version)</p>
<p>let workspaceID = "your-workspace-id-here"<br>
let failure = { (error: RestError) in print(error) }<br>
var context: Context? // save context to continue conversation<br>
conversation.message(workspaceID, failure: failure) { response in<br>
print(response.output.text)<br>
context = response.context<br>
}</p>
In addition to maintaining our place in the conversation, the context can also be used to store any other data you want to pass back and forth between your application and the Conversation service. This can include persistent data you want to maintain throughout the conversation (such as a customer’s name or account number), or any other data you want to track (such as the current status of option settings).
Additionally,