Add analyze mode to VR 4 node

Author: chughts

services/visual_recognition/v4-collection-utils.html

@@ -37,6 +37,8 @@
     <div class="form-row">
         <label for="node-input-image-feature"><i class="fa fa-book"></i> Mode: </label>
         <select type="text" id="node-input-image-feature" style="display: inline-block; width: 70%;">
+            <option value="analyze">Analyze Images</option>
+            <option disabled>______________</option>
             <option value="createCollection">Create a collection</option>
             <option value="listCollections">List collections</option>
             <option value="getCollection">Get collection details</option>
@@ -49,6 +51,10 @@
             <option value="getImageDetails">Get details of image in collection</option>
             <option value="deleteImage">Delete image from collection</option>
             <option value="getJpegImage">Get JPEG image from collection</option>
+            <option disabled>______________</option>
+            <option value="train">Train a collection</option>
+            <option value="addImageTrainingData">Add training data to image</option>
+            <option value="getTrainingUsage">Get training usage</option>
         </select>
     </div>
 </script>
@@ -115,6 +121,11 @@
     your needs.</p>
     <p>The following features are available :</p>
     <ul>
+      <li>Analysis
+        <ul>
+          <li><b>Analyze Images</b></li>
+        </ul>
+      </li>
       <li>Collections
         <ul>
           <li><b>Create a collection</b></li>
@@ -134,10 +145,30 @@
           <li><b>Get JPEG image from collection</b></li>
         </ul>
       </li>
+      <li>Training
+        <ul>
+          <li><b>Train a collection</b></li>
+          <li><b>Add training data to an image</b></li>
+          <li><b>Get training usage</b></li>
+        </ul>
+      </li>
     </ul>
 
     <p>All Results will made available at <code>msg.payload</code></p>
 
+    <p><b>Analyze Images</b></p>
+    <p>this feature should be provided in input : </p>
+    <ul>
+        <li><code>msg.payload</code> : Either a zip of image files or an array of URLs of image files (Required)</li>
+        <li><code>msg.params["collectionId"]</code> : The identifier of the collection (Required)</li>
+        <li><code>msg.params["threshold"]</code> : Minimum score for matches (Optional)</li>        
+    </ul>
+    <p>More information on this
+      <a href="https://cloud.ibm.com/apidocs/visual-recognition/visual-recognition-v4?code=node#add-images">
+        API documentation</a>.</p>
+
+
+
     <p><b>Create a collection</b></p>
     <p>this feature should be provided in input : </p>
     <ul>
@@ -234,8 +265,30 @@
         <li><code>msg.params["size"]</code> : Set to either 'full' or 'thumbnail' (Optional)</li>
     </ul>
     <p>More information on this
-      <a href="https://cloud.ibm.com/apidocs/visual-recognition/visual-recognition-v4?code=node#delete-an-image">
+      <a href="https://cloud.ibm.com/apidocs/visual-recognition/visual-recognition-v4?code=node#get-a-jpeg-file-of-an-image">
+        API documentation</a>.</p>
+
+    <p><b>Train a collection</b></p>
+    <p>this feature should be provided in input : </p>
+    <ul>
+        <li><code>msg.params["collectionId"]</code> : The identifier of the collection (Required)</li>
+    </ul>
+    <p>More information on this
+      <a href="https://cloud.ibm.com/apidocs/visual-recognition/visual-recognition-v4?code=node#train-a-collection">
         API documentation</a>.</p>
 
+    <p><b>Add training data to an image</b></p>
+    <p>this feature should be provided in input : </p>
+    <ul>
+        <li><code>msg.params["collectionId"]</code> : The identifier of the collection (Required)</li>
+        <li><code>msg.params["imageId"]</code> : The identifier of the image (Required)</li>
+        <li><code>msg.params["objects"]</code> : An array of training data (Required)</li>
+    </ul>
+    <p>More information on this
+      <a href="https://cloud.ibm.com/apidocs/visual-recognition/visual-recognition-v4?code=node#add-training-data-to-an-image">
+        API documentation</a>.</p>
+
+    <p><b>Get training usage</b></p>
+    <p>No input parameters are required : </p>
 
 </script>

services/visual_recognition/v4-collection-utils.js

@@ -20,6 +20,7 @@ module.exports = function(RED) {
     { IamAuthenticator } = require('ibm-watson/auth'),
     FEATURE = 'image-feature',
     REQUIRED_PARAMS = {
+      'analyze': ['collectionIds'],
       'createCollection': ['name', 'description'],
       'getCollection': ['collectionId'],
       'updateCollection': ['collectionId'],
@@ -28,7 +29,9 @@ module.exports = function(RED) {
       'listImages': ['collectionId'],
       'getImageDetails': ['collectionId', 'imageId'],
       'deleteImage': ['collectionId', 'imageId'],
-      'getJpegImage': ['collectionId', 'imageId']
+      'getJpegImage': ['collectionId', 'imageId'],
+      'train': ['collectionId'],
+      'addImageTrainingData' : ['collectionId', 'imageId', 'objects']
     };
 
   var pkg = require('../../package.json'),
@@ -114,7 +117,7 @@ module.exports = function(RED) {
             reject(err);
           })
       }
-    });    
+    });
   }
 
   function extractIDs(body) {
@@ -268,6 +271,7 @@ module.exports = function(RED) {
 
     switch (feature) {
 
+      case 'analyze':
       case 'createCollection':
       case 'getCollection':
       case 'updateCollection':
@@ -277,6 +281,8 @@ module.exports = function(RED) {
       case 'getImageDetails':
       case 'deleteImage':
       case 'getJpegImage':
+      case 'train':
+      case 'addImageTrainingData':
         theMissing = paramCheckFor(REQUIRED_PARAMS[feature], msg);
         if (theMissing.length === 0) {
           return Promise.resolve();
@@ -286,6 +292,7 @@ module.exports = function(RED) {
 
       case 'listCollections':
       case 'deleteAllCollections':
+      case 'getTrainingUsage':
         if (! msg.params) {
           msg.params = {};
         }
@@ -296,6 +303,13 @@ module.exports = function(RED) {
     }
   }
 
+  function augmentParams(node, msg) {
+    if ('analyze' === node.config[FEATURE]) {
+      msg.params.features = ['objects'];
+    }
+    return Promise.resolve();
+  }
+
   function bufferCheck(data) {
     return data instanceof Buffer;
   }
@@ -335,9 +349,19 @@ module.exports = function(RED) {
     });
   }
 
+  function imagesExpected(feature) {
+    switch(feature) {
+      case 'addImages':
+      case 'analyze':
+        return true;
+      default:
+        return false;
+    }
+  }
+
   function processPayload(node, msg) {
     return new Promise(function resolver(resolve, reject) {
-      if ('addImages' !== node.config[FEATURE]) {
+      if (!imagesExpected(node.config[FEATURE])) {
         resolve();
       } else if (Array.isArray(msg.payload)) {
         // Payload can be either an array of urls for images
@@ -374,8 +398,12 @@ module.exports = function(RED) {
       case 'getImageDetails':
       case 'deleteImage':
       case 'getJpegImage':
+      case 'train':
+      case 'addImageTrainingData':
+      case 'getTrainingUsage':
         return Promise.resolve();
       case 'addImages':
+      case 'analyze':
         if (!msg.payload) {
           return Promise.reject('Missing property: msg.payload');
         }
@@ -408,6 +436,9 @@ module.exports = function(RED) {
         .then(() => {
           return verifyParams(node, msg);
         })
+        .then(() => {
+          return augmentParams(node, msg);
+        })
         .then(() => {
           return processPayload(node, msg);
         })