Merge pull request #336 from chughts/langfix

Language updates for Tone Analyzer and Discovery

Author: chughts

README.md

@@ -7,6 +7,12 @@ Node-RED Watson Nodes for IBM Bluemix
 
 <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.5.15
+- Allow language code to be specified on create collection in Discovery Node.
+- Implement delete collection, delete environment in Discovery Node.
+- Allow multiple interface versions for Tone Analyzer Node.
+- Enable Content, en or fr, in Tone Analyzer Node.
+
 ### New in version 0.5.14
 - Bump to latest version of watson-developer-cloud node.js sdk
 - Allow empty input into converse for Conversation Node

package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-red-node-watson",
-  "version": "0.5.14",
+  "version": "0.5.15",
   "description": "A collection of Node-RED nodes for IBM Watson services",
   "dependencies": {
     "alchemy-api": "^1.3.0",
@@ -11,7 +11,7 @@
     "temp": "^0.8.3",
     "qs": "6.x",
 	  "image-type": "^2.0.2",
-    "watson-developer-cloud": "^2.39.2",
+    "watson-developer-cloud": "^2.40.0",
     "kuromoji": "^0.1.1",
     "is-docx": "^0.0.3",
     "stream-to-array" : "^2.3.0"

services/discovery/discovery-utils.js

@@ -86,7 +86,7 @@ DiscoveryUtils.prototype = {
     params = me.buildParamsForQuery(msg, config, params);
 
     ['environment_id', 'collection_id', 'configuration_id',
-      'collection_name',
+      'collection_name', 'language_code',
       'passages', 'description', 'size'
     ].forEach(function(f) {
       params = me.buildParamsFor(msg, config, params, f);

services/discovery/v1-query-builder.js

@@ -43,7 +43,7 @@ module.exports = function(RED) {
       username: sUsername ? sUsername : req.query.un,
       password: sPassword ? sPassword : req.query.pwd,
       url: req.query.endpoint ? req.query.endpoint : sEndpoint,
-      version_date: '2017-08-01',
+      version_date: '2017-09-01',
       headers: {
         'User-Agent': pkg.name + '-' + pkg.version
       }
@@ -67,7 +67,7 @@ module.exports = function(RED) {
       username: sUsername ? sUsername : req.query.un,
       password: sPassword ? sPassword : req.query.pwd,
       url: req.query.endpoint ? req.query.endpoint : sEndpoint,
-      version_date: '2017-08-01',
+      version_date: '2017-09-01',
       headers: {
         'User-Agent': pkg.name + '-' + pkg.version
       }
@@ -91,8 +91,8 @@ module.exports = function(RED) {
     var discovery = new DiscoveryV1({
       username: sUsername ? sUsername : req.query.un,
       password: sPassword ? sPassword : req.query.pwd,
-      url: req.query.endpoint ? req.query.endpoint : sEndpoint,      
-      version_date: '2017-08-01',
+      url: req.query.endpoint ? req.query.endpoint : sEndpoint,
+      version_date: '2017-09-01',
       headers: {
         'User-Agent': pkg.name + '-' + pkg.version
       }

services/discovery/v1.html

@@ -50,9 +50,11 @@
             <option value="createEnvrionment">Create new environment</option>
             <option value="listEnvrionments">List existing environments</option>
             <option value="getEnvironmentDetails">Retrieve environment details</option>
+            <option value="deleteEnvironment">Delete environment</option>
             <option value="createCollection">Create new collection</option>
             <option value="listCollections">List existing collections</option>
             <option value="getCollectionDetails">Retrieve collection details</option>
+            <option value="deleteCollection">Delete collection</option>
             <option value="createConfiguration">Create new configuration</option>
             <option value="listConfigurations">List existing configurations</option>
             <option value="getConfigurationDetails">Retrieve configuration details</option>
@@ -83,6 +85,21 @@
         <label for="node-input-configuration_id"><i class="fa fa-tag"></i> Configuration ID</label>
         <input type="text" id="node-input-configuration_id" placeholder="">
     </div>
+
+    <div class="form-row">
+        <label for="node-input-language_code"><i class="fa fa-language"></i> Language: </label>
+        <select type="text" id="node-input-language_code" style="display: inline-block; width: 70%;">
+            <option value="en">English</option>
+            <option value="de">German</option>
+            <option value="es">Spanish</option>
+            <option value="ar">Arabic</option>
+            <option value="fr">French</option>
+            <option value="it">Italian</option>
+            <option value="ja">Japanese</option>
+            <option value="pt-br">Brazilian Portuguese</option>
+        </select>
+    </div>
+
     <div class="form-row">
         <label for="node-input-count"><i class="fa fa-tag"></i> Number of documents</label>
         <input type="text" id="node-input-count" placeholder="">
@@ -180,6 +197,25 @@
                 <li><code>msg.environment_details</code> : Details of the requested environment.</li>
               </ul>
         </li>
+        <li>
+            <p><b>Create New Collection</b><p>
+            <p>For this method the node needs an Environment ID, Collection Name,
+            Description, Configuration ID and Language Code as input.
+            </p>
+            <p>The fields can be overridden by specifying
+              in <code>msg.discoveryparams.environment_id</code>
+              , <code>msg.discoveryparams.collection_name</code>
+              , <code>msg.discoveryparams.description</code>
+              , <code>msg.discoveryparams.configuration_id</code>
+              and <code>msg.discoveryparams.language_code</code>
+            </p>
+
+            <p>Node output : </p>
+              <ul>
+                <li><code>msg.collection</code> : Information about the
+                newly created collection.</li>
+              </ul>
+        </li>
         <br/>
         <li>
             <p><b>List Existing Collections</b><p>
@@ -295,6 +331,7 @@
       $('#node-input-collection_id').parent().hide();
       $('#node-input-configurationname').parent().hide();
       $('#node-input-configuration_id').parent().hide();
+      $('#node-input-language_code').parent().hide();
       $('#node-input-count').parent().hide();
       $('#node-input-passages').parent().hide();
       $('#node-input-nlp_query').parent().hide();
@@ -327,15 +364,18 @@
         case 'createCollection':
           fields.push('#node-input-environment_id'
                           + ', #node-input-configuration_id'
+                          + ', #node-input-language_code'
                           + ', #node-input-collection_name'
                           + ', #node-input-description');
           break;
         case 'createConfiguration':
         case 'getEnvironmentDetails':
         case 'listCollections':
+        case 'deleteEnvironment':
           fields.push('#node-input-environment_id');
           break;
         case 'getCollectionDetails':
+        case 'deleteCollection':
           fields.push('#node-input-environment_id'
                           + ', #node-input-collection_id');
           break;
@@ -407,6 +447,7 @@
                 collection_id: {value: ''},
                 configurationname: {value: ''},
                 configuration_id: {value: ''},
+                language_code: {value: 'en'},
                 collection_name: {value: ''},
                 count: {value: '1'},
                 passages: {value: 'false'},

services/discovery/v1.js

@@ -118,7 +118,6 @@ module.exports = function (RED) {
       //  //delete params[f];
       //});
 
-      //console.log('about to create collection with params : ', params);
       discovery.createCollection(params, function (err, response) {
         if (err) {
           reject(err);
@@ -131,6 +130,33 @@ module.exports = function (RED) {
     return p;
   }
 
+  function executeDeleteCollection(node, discovery, params, msg) {
+    var p = new Promise(function resolver(resolve, reject){
+      discovery.deleteCollection(params, function (err, response) {
+        if (err) {
+          reject(err);
+        } else {
+          msg.collection = response.collection ? response.collection : response;
+          resolve();
+        }
+      });
+    });
+    return p;
+  }
+
+  function executeDeleteEnvironment(node, discovery, params, msg) {
+    var p = new Promise(function resolver(resolve, reject){
+      discovery.deleteEnvironment(params, function (err, response) {
+        if (err) {
+          reject(err);
+        } else {
+          msg.environment = response.environment ? response.environment : response;
+          resolve();
+        }
+      });
+    });
+    return p;
+  }
 
   function executeListCollections(node, discovery, params, msg) {
     var p = new Promise(function resolver(resolve, reject){
@@ -225,7 +251,7 @@ module.exports = function (RED) {
       serviceSettings = {
         username: username,
         password: password,
-        version_date: '2017-08-01',
+        version_date: '2017-09-01',
         headers: {
           'User-Agent': pkg.name + '-' + pkg.version
         }
@@ -256,6 +282,9 @@ module.exports = function (RED) {
     case 'getCollectionDetails':
       p = executeGetCollectionDetails(node, discovery, params, msg);
       break;
+    case 'deleteCollection':
+      p = executeDeleteCollection(node, discovery, params, msg);
+      break;
     case 'createConfiguration':
       p = executeCreateConfiguration(node, discovery, params, msg);
       break;
@@ -265,6 +294,9 @@ module.exports = function (RED) {
     case 'getConfigurationDetails':
       p = executeGetConfigurationDetails(node, discovery, params, msg);
       break;
+    case 'deleteEnvironment':
+      p = executeDeleteEnvironment(node, discovery, params, msg);
+      break;
     case 'query':
       p = executeQuery(node, discovery, params, msg);
       break;

services/tone_analyzer/v3.html

@@ -51,6 +51,14 @@
         </select>
     </div>
 
+    <div class="form-row">
+        <label for="node-input-interface-version"><i class="fa fa-history"></i> version_date: </label>
+        <select type="text" id="node-input-interface-version" style="display: inline-block; width: 70%;">
+            <option value="2016-05-19">Multiple Tones</option>
+            <option value="2017-09-21">Dominant Tone</option>
+        </select>
+    </div>
+
     <div class="form-row">
         <label for="node-input-tones"><i class="fa fa-comments-o"></i> Tones</label>
         <select type="text" id="node-input-tones" style="display: inline-block; width: 70%;" >
@@ -75,6 +83,14 @@
         </select>
     </div>
 
+    <div class="form-row">
+        <label for="node-input-inputlang"><i class="fa fa-language"></i> Input Text Language</label>
+        <select type="text" id="node-input-inputlang" style="display: inline-block; width: 70%;" >
+            <option value="en">English</option>
+            <option value="fr">French</option>
+        </select>
+    </div>
+
 </script>
 
 <script type="text/x-red" data-help-name="watson-tone-analyzer-v3">
@@ -115,6 +131,7 @@
     fields.push('#node-input-tones');
     fields.push('#node-input-sentences');
     fields.push('#node-input-contentType');
+    fields.push('#node-input-inputlang');
     ToneV3.hideSelectedFields(fields);
   };
 
@@ -126,18 +143,37 @@
         fields.push('#node-input-tones');
         fields.push('#node-input-sentences');
         fields.push('#node-input-contentType');
+        fields.push('#node-input-inputlang');        
         break;
     }
     ToneV3.showSelectedFields(fields);
   }
 
+  ToneV3.processSelectedVersion = function(method, version) {
+    if ('generalTone' == method)
+    {
+      fields = [];
+      fields.push('#node-input-tones');
+      if  ('2016-05-19' == version) {
+        ToneV3.showSelectedFields(fields);
+      } else {
+        ToneV3.hideSelectedFields(fields);
+      }
+    }
+  }
 
   ToneV3.UIListeners = function () {
     $('#node-input-tone-method').change(function(val){
       var method = $('#node-input-tone-method').val();
       ToneV3.processSelectedMethod(method);
     });
 
+    $('#node-input-interface-version').change(function(val){
+      var version = $('#node-input-interface-version').val();
+      var method = $('#node-input-tone-method').val();
+      ToneV3.processSelectedVersion(method, version);
+    });
+
     $('#node-input-default-endpoint').change(function () {
       var checked = $('#node-input-default-endpoint').prop('checked')
       if (checked) {
@@ -176,6 +212,9 @@
                 sentences: {value: "true"},
                 contentType: {value: "false"},
                 "tone-method": {value:"generalTone"},
+                "interface-version": {value:"generalTone"},
+                name: {value: ""},
+                inputlang: {value: "en"},
                 'default-endpoint' :{value: true},
                 'service-endpoint' :{value: 'https://gateway.watsonplatform.net/tone-analyzer/api'}
             },

services/tone_analyzer/v3.js

@@ -94,7 +94,7 @@ module.exports = function (RED) {
     var serviceSettings = {
       'username': settings.username,
       'password': settings.password,
-      version_date: '2016-05-19',
+      version_date: '2017-09-21',
       headers: {
         'User-Agent': pkg.name + '-' + pkg.version
       }
@@ -109,6 +109,10 @@ module.exports = function (RED) {
       serviceSettings.url = endpoint;
     }
 
+    if (config['interface-version']) {
+      serviceSettings.version_date = config['interface-version'];
+    }
+
     const tone_analyzer = new ToneAnalyzerV3(serviceSettings);
 
     var p = new Promise(function resolver(resolve, reject){
@@ -120,6 +124,7 @@ module.exports = function (RED) {
         m = 'tone_chat';
         break;
       }
+
       tone_analyzer[m](options, function (err, response) {
         if (err) {
           reject(err);
@@ -138,6 +143,7 @@ module.exports = function (RED) {
     checkConfiguration(msg, node)
       .then(function(settings) {
         var options = toneutils.parseOptions(msg, config);
+        options = toneutils.parseLanguage(msg, config, options);
         node.status({fill:'blue', shape:'dot', text:'requesting'});
         return invokeService(config, options, settings);
       })

utilities/tone-utils.js

@@ -86,6 +86,23 @@ ToneUtils.prototype = {
       break;
     }
 
+    return options;
+  },
+
+  // function to splice in language options into header
+  parseLanguage: function(msg, config, options) {
+    var inputlang = config.inputlang ? config.inputlang : 'en';
+    //outputlang = config.outputlang ? config.outputlang : 'en';
+
+    // The SDK is currently ignoring this, but this is how it should be done.
+    // If you need it, then Personality Insights as full set of accept-language
+    //options.headers = {
+    //  'content-language': inputlang,
+    //  'accept-language': outputlang
+    //}
+
+    // This is how it is currently working.
+    options.language = inputlang;
     return options;
   }