Allow Version override for Assistant Node

Author: chughts

README.md

@@ -7,6 +7,10 @@ Node-RED Watson Nodes for IBM Cloud
 
 <a href="https://cla-assistant.io/watson-developer-cloud/node-red-node-watson"><img src="https://cla-assistant.io/readme/badge/watson-developer-cloud/node-red-node-watson" alt="CLA assistant" /></a>
 
+### New in version 0.7.2
+- Allow version date for Assistant to be specified in `msg.params.version`
+to allow optional usage of beta version.
+
 ### New in version 0.7.1
 - Fix to how IAM Key for bound Visual Recognition is retrieved
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-red-node-watson",
-  "version": "0.7.1",
+  "version": "0.7.2",
   "description": "A collection of Node-RED nodes for IBM Watson services",
   "dependencies": {
     "async": "^1.5.2",

services/conversation/v1-workspace-manager.js

@@ -27,7 +27,8 @@ module.exports = function (RED) {
     service = serviceutils.getServiceCreds(SERVICE_IDENTIFIER),
     username = '', password = '', sUsername = '', sPassword = '',
     apikey = '', sApikey = '',
-    endpoint = '', sEndpoint = '';
+    endpoint = '', sEndpoint = '',
+    version = '2018-02-16';
 
   if (!service) {
     service = serviceutils.getServiceCreds(OLD_SERVICE_IDENTIFIER);
@@ -504,10 +505,11 @@ module.exports = function (RED) {
   }
 
   function executeMethod(node, method, params, msg) {
-    var conv = null,
+    let conv = null,
+      version = '2018-02-16',
       serviceSettings = {
-        version_date: '2018-02-16',
-        version: '2018-02-16',
+        version_date: version,
+        version: version,
         headers: {
           'User-Agent': pkg.name + '-' + pkg.version
         }
@@ -524,6 +526,8 @@ module.exports = function (RED) {
       serviceSettings.url = endpoint;
     }
 
+
+
     conv = new AssistantV1(serviceSettings);
 
     node.status({fill:'blue', shape:'dot', text:'executing'});
@@ -1100,6 +1104,9 @@ module.exports = function (RED) {
         if (msg.params.apikey) {
           apikey = msg.params.apikey;
         }
+        if (msg.params.version) {
+          version = msg.params.version;
+        }
       }
       endpoint = sEndpoint;
       if ((!config['cwm-default-endpoint']) && config['cwm-service-endpoint']) {

services/conversation/v1.html

@@ -86,37 +86,38 @@
 
 
 <script type="text/x-red" data-help-name="watson-conversation-v1">
-	<p>With the IBM Watson™ Conversation service you can create cognitive agents – virtual agents that combine machine learning, natural language understanding, and integrated dialog scripting tools to provide outstanding customer engagements.</p>
+	<p>With the IBM Watson™ Assistant service you can create cognitive agents – virtual agents that combine machine learning, natural language understanding, and integrated dialog scripting tools to provide outstanding customer engagements.</p>
 
     <p><b>Usage</b></p>
     <p>This node should be provided in input : </p>
     <ul>
-    <li><code>msg.payload</code> : the message of the conversation to analyse. Format: String </li>
-    <li><code>msg.user</code> (optional): unique identifier of the user. This will be used to maintain the context of the conversation for each user when using with multiple users. Format: String </li>
+    <li><code>msg.payload</code> : the message of the Assistant to analyse. Format: String </li>
+    <li><code>msg.user</code> (optional): unique identifier of the user. This will be used to maintain the context of the Assistant for each user when using with multiple users. Format: String </li>
     <li><code>msg.params.workspace_id</code> : unique identifier of the workspace to be used. Could be also configured in the node. Format: String </li>
     <li><code>msg.params.timeout</code> (optional): The timeout period (in millisecond) for Watson request. Leave empty or set to 0 to disable. </li>
-    <li><code>msg.params.context</code> (optional): A context object that includes state information for the conversation. When you send multiple requests for the same conversation, include the context object from the response. (<a href="http://www.ibm.com/watson/developercloud/conversation/api/v1/#send_input" target="_blank">documentation</a>). This will overwrite any context saved in the node. Format: JSON </li>
+    <li><code>msg.params.context</code> (optional): A context object that includes state information for the Assistant. When you send multiple requests for the same Assistant, include the context object from the response. (<a href="http://www.ibm.com/watson/developercloud/assistant/api/v1/#send_input" target="_blank">documentation</a>). This will overwrite any context saved in the node. Format: JSON </li>
     <li><code>msg.params.alternate_intents</code> (optional) : whether to return more than one intent. Default is false. Set to true to return all matching intents. For example, return all intents when the confidence is not high to allow users to choose their intent.</li>
     <li><code>msg.params.output</code> (optional) : see API documentation </li>
     <li><code>msg.params.entities</code> (optional) : see API documentation </li>
     <li><code>msg.params.output</code> (optional) : see API documentation </li>
     <li><code>msg.additional_context</code> (optional) : additional properties that will be added to the context object. Format: Object </li>
     <br/>
-    <li><code>msg.params.username</code> : If provided will be used as the username credential for the Conversation service.</li>
-    <li><code>msg.params.password</code> : If provided will be used as the password credential for the Conversation service.</li>
-    <li><code>msg.params.apikey</code> : If provided will be used as the api key credential for the Conversation service.</li>
-    <li><code>msg.params.endpoint</code> : If provided will be used as the url for the Conversation service.</li>
+    <li><code>msg.params.username</code> : If provided will be used as the username credential for the Assistant service.</li>
+    <li><code>msg.params.password</code> : If provided will be used as the password credential for the Assistant service.</li>
+    <li><code>msg.params.apikey</code> : If provided will be used as the api key credential for the Assistant service.</li>
+    <li><code>msg.params.endpoint</code> : If provided will be used as the url for the Assistant service.</li>
+    <li><code>msg.params.version</code> : If provided will be used as the API version date for the Assistant service.</li>
     <li><code>msg.params.optout_learning</code> : Set to true to opt out of request logging. Check the <a href="https://console.bluemix.net/docs/services/watson/getting-started-logging.html#controlling-request-logging-for-watson-services" target="_blank">documentation</a> for details.</li>
     </ul>
-    <p>See <a href="http://www.ibm.com/watson/developercloud/conversation/api/v1/#send_input" target="_blank">Conversation API documentation</a> for details.</p>
-    <p>All Results will made available at <code>msg.payload</code> in JSON format. Check the  <a href="http://www.ibm.com/watson/developercloud/conversation/api/v1/#send_input" target="_blank">documentation</a> for details.</p>
+    <p>See <a href="http://www.ibm.com/watson/developercloud/assistant/api/v1/#send_input" target="_blank">Assistant API documentation</a> for details.</p>
+    <p>All Results will made available at <code>msg.payload</code> in JSON format. Check the  <a href="http://www.ibm.com/watson/developercloud/assistant/api/v1/#send_input" target="_blank">documentation</a> for details.</p>
 
-    <p><b>Important</b> : before using this node, a workspace must be created and configured using the Watson Conversation Tool available in IBM Cloud, in the Watson Conversation instance detail page.</p>
+    <p><b>Important</b> : before using this node, a workspace must be created and configured using the Watson Assistant Tool available in IBM Cloud, in the Watson Assistant instance detail page.</p>
     <p><b>Documentation</b>
     <ul>
-    <li><a href="https://console.bluemix.net/docs/services/conversation/index.html" target="_blank">Watson Conversation API documentation</a></li>
-    <li><a href="https://watson-api-explorer.mybluemix.net/apis/conversation-v1" target="_blank">Watson API Explorer</a></li>
-    <li><a href="https://console.bluemix.net/docs/services/conversation/getting-started.html" target="_blank">Getting started tutorial</a>
+    <li><a href="https://console.bluemix.net/docs/services/assistant/index.html" target="_blank">Watson Assistant API documentation</a></li>
+    <li><a href="https://watson-api-explorer.mybluemix.net/apis/assistant-v1" target="_blank">Watson API Explorer</a></li>
+    <li><a href="https://console.bluemix.net/docs/services/assistant/getting-started.html" target="_blank">Getting started tutorial</a>
     <li><a href="https://github.com/watson-developer-cloud/node-red-bluemix-starter" target="_blank">Sample Flow in the Watson Node-RED Starter</a>
     </ul>
 </script>

services/conversation/v1.js

@@ -136,91 +136,101 @@ module.exports = function(RED) {
     return true;
   }
 
+  function verifyCredentials(msg, k, u, p) {
+    if ( !(k) && (!(u) || !(p)) ) {
+      if ( (!msg.params) ||
+            (!(msg.params.apikey) &&
+               (!(msg.params.username) || !(msg.params.password))) ) {
+        return false;
+      }
+    }
+    return true;
+  }
+
 
   function verifyServiceCredentials(node, msg, config) {
     // If it is present the newly provided user entered key
     // takes precedence over the existing one.
     // If msg.params contain credentials then these will Overridde
     // the bound or configured credentials.
     const serviceSettings = {
-      version_date: '2018-02-16',
-      version: '2018-02-16',
       headers: {
         'User-Agent': pkg.name + '-' + pkg.version
       }
     };
 
-    var userName = sUsername || node.credentials.username,
+    let userName = sUsername || node.credentials.username,
       passWord = sPassword || node.credentials.password,
       apiKey = sApikey || node.credentials.apikey,
       endpoint = '',
-      optoutLearning = false;
+      optoutLearning = false,
+      version = '2018-02-16';
 
-    if ( !(apiKey) && (!(userName) || !(passWord)) ) {
-      if ( (!msg.params) ||
-            (!(msg.params.apikey) &&
-               (!(msg.params.username) || !(msg.params.password))) ) {
-        node.status({
-          fill: 'red',
-          shape: 'ring',
-          text: 'missing credentials'
-        });
-        node.error('Missing Watson Conversation API service credentials', msg);
-        return false;
+    if (verifyCredentials(msg, apiKey, userName, passWord)) {
+      if (msg.params) {
+        if (msg.params.username) {
+          userName = msg.params.username;
+        }
+        if (msg.params.password) {
+          passWord = msg.params.password;
+        }
+        if (msg.params.apikey) {
+          apiKey = msg.params.apikey;
+        }
+        if (msg.params.version) {
+          version = msg.params.version;
+        }
       }
-    }
 
-    if (msg.params) {
-      if (msg.params.username) {
-        userName = msg.params.username;
+      if (apiKey) {
+        serviceSettings.iam_apikey = apiKey;
+      } else {
+        serviceSettings.username = userName;
+        serviceSettings.password = passWord;
       }
-      if (msg.params.password) {
-        passWord = msg.params.password;
+
+      serviceSettings.version = version;
+      serviceSettings.version_date = version;
+
+      if (service) {
+        endpoint = service.url;
       }
-      if (msg.params.apikey) {
-        apiKey = msg.params.apikey;
+      if (!config['default-endpoint'] && config['service-endpoint']) {
+        endpoint = config['service-endpoint'];
+      }
+      if (msg.params && msg.params.endpoint) {
+        endpoint = msg.params.endpoint;
       }
-    }
-
-    serviceSettings.username = userName;
-    serviceSettings.password = passWord;
-    serviceSettings.iam_apikey = apiKey;
 
-    if (service) {
-      endpoint = service.url;
-    }
-    if (!config['default-endpoint'] && config['service-endpoint']) {
-      endpoint = config['service-endpoint'];
-    }
-    if (msg.params && msg.params.endpoint) {
-      endpoint = msg.params.endpoint;
-    }
+      if (endpoint) {
+        serviceSettings.url = endpoint;
+      }
 
-    if (endpoint) {
-      serviceSettings.url = endpoint;
-    }
+      if ((msg.params && msg.params['optout_learning'])){
+        optoutLearning = true;
+      } else if (config['optout-learning']){
+        optoutLearning = true;
+      }
 
-    if ((msg.params && msg.params['optout_learning'])){
-      optoutLearning = true;
-    } else if (config['optout-learning']){
-      optoutLearning = true;
-    }
+      if (optoutLearning){
+        serviceSettings.headers = serviceSettings.headers || {};
+        serviceSettings.headers['X-Watson-Learning-Opt-Out'] = '1';
+      }
 
-    if (optoutLearning){
-      serviceSettings.headers = serviceSettings.headers || {};
-      serviceSettings.headers['X-Watson-Learning-Opt-Out'] = '1';
-    }
+      if (config['timeout'] && config['timeout'] !== '0' && isFinite(config['timeout'])){
+        serviceSettings.timeout = parseInt(config['timeout']);
+      }
 
-    if (config['timeout'] && config['timeout'] !== '0' && isFinite(config['timeout'])){
-      serviceSettings.timeout = parseInt(config['timeout']);
-    }
+      if (msg.params && msg.params.timeout !== '0' && isFinite(msg.params.timeout)){
+        serviceSettings.timeout = parseInt(msg.params.timeout);
+      }
 
-    if (msg.params && msg.params.timeout !== '0' && isFinite(msg.params.timeout)){
-      serviceSettings.timeout = parseInt(msg.params.timeout);
+      node.service = new AssistantV1(serviceSettings);
+      return true;
+    } else {
+      node.error('Missing Watson Assistant API service credentials');
+      return false;
     }
-
-    node.service = new AssistantV1(serviceSettings);
-    return true;
   }
 
   function processResponse(err, body, node, msg, config) {