Merge pull request #143 from watson-developer-cloud/master

Rebasing

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.6.9
+- Implemented classify collection on Natural Language Classifier node. The collection can be
+in the form of multiple sentences, an array of strings, or an array of objects.
+
 ### New in version 0.6.8
 - Move all Discovery calls to latest API version - 2017-11-07
 - Updated calls to deprecated discovery methods addJsonDocument and getCollections
@@ -61,7 +65,7 @@ out for sample flows and templates showing how to use this feature.
 - Text Recognition option removed from Visual Recognition Node
 - Move Retrieve and Rank nodes to deprecated list
 - Removed Document Conversion, Alchemy, Concept Insights, Dialog, Tradeoff Analytics and Similarity Search Nodes
-- Nodes deprecated in 0.5.x will be removed in 0.5.x releases
+- Nodes deprecated in 0.5.x will be removed in 0.6.x releases
 
 
 ### Watson Nodes for Node-RED

package.json

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

services/natural_language_classifier/v1.html

@@ -81,6 +81,17 @@
     <p>Set the classifier id in the node configuration window.</p>
     <p>The classifier can be overriden by setting msg.nlcparams.classifier_id</p>
     <p>The text to classify should be passed in on <code>msg.payload</code>.</p>
+
+    <p> If <code>msg.payload</code> contains multiple sentences then the sentences will
+    be split and the set will be classified as a collection. If there are no sentence
+    terminators then it will not be recognised as a sentence.
+    </p>
+    <p> If <code>msg.payload</code> contains an array of strings, then each string will be
+    treated as a separate sentence and the set treated as a collection. </p>
+    <p>If <code>msg.payload</code> contains an array of objects, then there is a
+    search for the <code>text</code> key in each object. Each text object will be
+    treated as part of the collection.</p>
+
     <p>The returned classification and confidence values will be returned on <code>msg.payload</code>.</p>
     <p></p>
     <p><b>Training Mode</b>.</p>

services/natural_language_classifier/v1.js

@@ -79,6 +79,33 @@ module.exports = function(RED) {
       }
     };
 
+
+    node.payloadCollectionCheck = function(msg, config, payloadData) {
+      if ('classify' === config.mode) {
+        if ('string' === typeof msg.payload) {
+          let collection = msg.payload.match( /\(?[^\.\?\!]+[\.!\?$]\)?/g );
+          if (collection && collection.length > 1) {
+            payloadData.collection = [];
+            collection.forEach((s) => {
+              let textObject = { text : s };
+              payloadData.collection.push(textObject);
+            });
+          }
+        } else if (Array.isArray(msg.payload)){
+          payloadData.collection = [];
+          msg.payload.forEach((p) => {
+            if ('string' === typeof p) {
+              let textObject = { text : p };
+              payloadData.collection.push(textObject);
+            } else if ('object' === typeof p) {
+              payloadData.collection.push(p);
+            }
+          });
+        }
+      }
+      return Promise.resolve();
+    };
+
     // Standard temp file open
     node.openTemp = function() {
       var p = new Promise(function resolver(resolve, reject) {
@@ -118,13 +145,18 @@ module.exports = function(RED) {
       }
     };
 
-    node.buildParams = function(msg, config, info) {
+    node.buildParams = function(msg, config, info, payloadData) {
       var params = {},
         message = '';
 
       switch (config.mode) {
       case 'classify':
-        params.text = msg.payload;
+        if (payloadData && payloadData.collection) {
+          params.collection = payloadData.collection;
+        } else {
+          params.text = msg.payload;
+        }
+
         params.classifier_id = config.classifier;
         if (msg.nlcparams && msg.nlcparams.classifier_id) {
           params.classifier_id = msg.nlcparams.classifier_id;
@@ -170,14 +202,31 @@ module.exports = function(RED) {
 
         natural_language_classifier = new NaturalLanguageClassifierV1(serviceSettings);
 
-        natural_language_classifier[config.mode](params, function(err, response) {
+        let mode = config.mode;
+        if (params.collection) {
+          mode = 'classifyCollection';
+        }
+
+        natural_language_classifier[mode](params, function(err, response) {
           if (err) {
             reject(err);
           } else {
-            msg.payload = (config.mode === 'classify') ? {
-              classes: response.classes,
-              top_class: response.top_class
-            } : response;
+            console.log(response);
+            switch (mode) {
+            case 'classify':
+              msg.payload = {
+                classes: response.classes,
+                top_class: response.top_class
+              };
+              break;
+            case 'classifyCollection':
+              msg.payload = {
+                collection: response.collection
+              };
+              break;
+            default:
+              msg.payload = response;
+            }
             resolve();
           }
         });
@@ -189,15 +238,19 @@ module.exports = function(RED) {
 
     this.on('input', function(msg) {
       //var params = {}
+      let payloadData = {};
       node.verifyCredentials(msg)
         .then(function() {
           return node.payloadCheck(msg);
         })
+        .then(function() {
+          return node.payloadCollectionCheck(msg, config, payloadData);
+        })
         .then(function() {
           return node.checkForCreate(msg, config);
         })
         .then(function(info) {
-          return node.buildParams(msg, config, info);
+          return node.buildParams(msg, config, info, payloadData);
         })
         .then(function(params) {
           node.status({