Merge branch 'visual-insights' into dev

Author: germanattanasio

README.md

@@ -37,6 +37,7 @@ APIs and SDKs that use cognitive computing to solve complex problems.
       * [Speech to Text](#speech-to-text)
       * [Text to Speech](#text-to-speech)
       * [Tradeoff Analytics](#tradeoff-analytics)
+      * [Visual Insights](#visual-insights)
       * [Visual Recognition](#visual-recognition)
     * [Running in Bluemix](#running-in-bluemix)
     * [Debug](#debug)
@@ -542,6 +543,31 @@ tradeoff_analytics.dilemmas(params, function(err, res) {
 });
 ```
 
+### Visual Insights
+Use the [Visual Insights][visual_insights] to get insight into the themes present in a collection of images based on their visual appearance/content.
+
+```js
+var watson = require('watson-developer-cloud');
+var fs = require('fs');
+
+var visual_insights = watson.visual_insights({
+  username: '<username>',
+  password: '<password>',
+  version: 'v1'
+});
+
+var params = {
+  images_file: fs.createReadStream('./resources/images.zip')
+};
+
+visual_insights.summary(params, function(err, res) {
+  if (err)
+    console.log(err);
+  else
+    console.log(JSON.stringify(res, null, 2));
+});
+```
+
 ### Visual Recognition
 Use the [Visual Recognition][visual_recognition] service to recognize the
 following picture.
@@ -641,6 +667,8 @@ See [CONTRIBUTING](https://github.com/watson-developer-cloud/nodejs-wrapper/blob
 [concept_expansion]: http://www.ibm.com/smarterplanet/us/en/ibmwatson/developercloud/doc/glimpseapi/
 [relationship_extraction]: http://www.ibm.com/smarterplanet/us/en/ibmwatson/developercloud/doc/sireapi/
 [visual_recognition]: http://www.ibm.com/smarterplanet/us/en/ibmwatson/developercloud/doc/visual-recognition/
+[visual_insights]: http://www.ibm.com/smarterplanet/us/en/ibmwatson/developercloud/doc/visual-insights/
+
 [text_to_speech]: http://www.ibm.com/smarterplanet/us/en/ibmwatson/developercloud/doc/text-to-speech/
 [speech_to_text]: http://www.ibm.com/smarterplanet/us/en/ibmwatson/developercloud/doc/speech-to-text/
 [concept_insights]: http://www.ibm.com/smarterplanet/us/en/ibmwatson/developercloud/doc/concept-insights/

examples/resources/images.zip

@@ -0,0 +1,21 @@
+'use strict';
+
+var watson = require('watson-developer-cloud');
+var fs = require('fs');
+
+var visual_insights = watson.visual_insights({
+  username: 'INSERT YOUR USERNAME FOR THE SERVICE HERE',
+  password: 'INSERT YOUR PASSWORD FOR THE SERVICE HERE',
+  version: 'v1'
+});
+
+var params = {
+  images_file: fs.createReadStream('./resources/images.zip')
+};
+
+visual_insights.summary(params, function(err, res) {
+  if (err)
+    console.log(err);
+  else
+    console.log(JSON.stringify(res, null, 2));
+});

examples/visual_insights.v1.js

@@ -115,7 +115,7 @@ var watson = {};
   'dialog',
   'retrieve_and_rank',
   'document_conversion',
-
+  'visual_insights',
   // deprecated
   'search',
   'language_identification',

lib/index.js

@@ -21,7 +21,6 @@ var requestFactory = require('../../lib/requestwrapper');
 var endpoints      = require('../../lib/alchemy_endpoints.json');
 var helper         = require('../../lib/helper');
 var isStream       = require('isstream');
-var pick           = require('object.pick');
 var omit           = require('object.omit');
 var fs             = require('fs');
 
@@ -54,18 +53,33 @@ function createRequest(method) {
         ' needs to be specified'));
       return;
     }
+    // always return json
+    params.outputMode = 'json';
 
     var parameters = {
       options: {
         url: endpoints[method][format],
-        method: 'POST',
-        json: true,
-        qs: extend({outputMode: 'json'}, params) // change default output to json
+        method: 'POST'
       },
       defaultOptions: this._options
     };
 
-    return requestFactory(parameters, errorFormatter(callback));
+    if (!params.image || !isStream(params.image)) {
+      // url or base64 images are considered 'not-raw'
+      params.imagePostMode = 'not-raw';
+      // send the parameters as form url-encoded
+      parameters.options.form = params;
+      return requestFactory(parameters, errorFormatter(callback));
+    } else {
+      params.imagePostMode = 'raw';
+      // send the parameters as query parameters
+      parameters.options.qs = omit(params,['image']);
+      // add the content-length to the headers
+      parameters.options.headers = {
+        'Content-Length': fs.statSync(params.image.path).size
+      };
+      return params.image.pipe(requestFactory(parameters, errorFormatter(callback)));
+    }
   };
 }
 
@@ -81,86 +95,16 @@ function AlchemyVision(options) {
 /**
  * Extracts images from a URL or html
  */
-AlchemyVision.prototype.getImageLinks = function(_params, callback ) {
-  var params = _params || {};
-  var accepted_formats = Object.keys(endpoints['image_link']);
-  var format = helper.getFormat(params, accepted_formats);
-
-  if (format === null) {
-    callback(new Error('Missing required parameters: ' + accepted_formats.join(', ') + ' needs to be specified'));
-    return;
-  }
-
-  var parameters = {
-    options: {
-      url: endpoints['image_link'][format],
-      method: 'POST',
-      json: true,
-      qs: extend({}, params,{outputMode: 'json'}) // change default output to json
-    },
-    defaultOptions: this._options
-  };
-
-  return requestFactory(parameters, errorFormatter(callback));
-};
+AlchemyVision.prototype.getImageLinks = createRequest('image_link');
 
 /**
  * Tags image with keywords
  */
-AlchemyVision.prototype.getImageKeywords = function(_params, callback) {
-  var params = extend({}, _params);
-  var accepted_formats = Object.keys(endpoints['image_keywords']);
-  var format = helper.getFormat(params, accepted_formats);
-
-  if (format === null) {
-    callback(new Error('Missing required parameters: ' + accepted_formats.join(', ') + ' needs to be specified'));
-    return;
-  }
-
-  var parameters = {
-    options: {
-      url: endpoints['image_keywords'][format],
-      method: 'POST',
-      json: true,
-      qs: {outputMode: 'json'} // change default output to json
-    },
-    defaultOptions: this._options
-  };
-
-  if (typeof(params.image) !== 'undefined') {
-
-    // check if image is stream or string
-    if ((typeof(params.image) !== 'string') && !isStream(params.image)) {
-      callback(new Error('Invalid arguments: image needs to be a stream or base64'));
-      return;
-    }
-
-    if (isStream(params.image)) {
-      params.imagePostMode = 'raw';
-      // handle raw images
-      parameters.options.body = params.image;
-
-    } else {
-      params.imagePostMode = 'not-raw';
-      parameters.options.formData = params;
-    }
-  } else {
-    parameters.options.formData = params;
-  }
-
-  return requestFactory(parameters, errorFormatter(callback));
-};
+AlchemyVision.prototype.getImageKeywords = createRequest('image_keywords');
 
 /**
  * Face detection and Recognition
  */
-AlchemyVision.prototype.recognizeFaces = function(_params, callback) {
-  var params = _params || {};
-
-  if (params.image && typeof(params.image) !== 'string')
-    params.imagePostMode = 'raw';
-
-  return createRequest('image_recognition').call(this, params, callback);
-};
+AlchemyVision.prototype.recognizeFaces = createRequest('image_recognition');
 
 module.exports = AlchemyVision;

services/alchemy_vision/v1.js

@@ -0,0 +1,79 @@
+/**
+ * Copyright 2014 IBM Corp. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+'use strict';
+
+var extend         = require('extend');
+var requestFactory = require('../../lib/requestwrapper');
+var isStream       = require('isstream');
+
+function VisualInsights(options) {
+  // Default URL
+  var serviceDefaults = {
+    url: 'https://gateway.watsonplatform.net/visual-insights-experimental/api'
+  };
+
+  // Replace default options with user provided
+  this._options = extend(serviceDefaults, options);
+}
+
+/**
+ * Returns a list of the classifiers that are used in the summary call
+ */
+VisualInsights.prototype.classifiers = function(params, callback) {
+  var parameters = {
+    options: {
+      method: 'GET',
+      url: '/v1/classifiers',
+      qs: params,
+      json: true
+    },
+    defaultOptions: this._options
+  };
+  return requestFactory(parameters, callback);
+};
+
+/**
+ * Classifies @param images_file using all available classifiers.
+ *
+ * @param  {ReadStream} images_file The zip of images to analyze.
+ */
+VisualInsights.prototype.summary = function(params, callback) {
+  params = params || {};
+
+  if (!params.images_file) {
+    callback(new Error('Missing required parameters: images_file'));
+    return;
+  }
+
+  if (!isStream(params.images_file)) {
+    callback(new Error('images_file is not a standard Node.js Stream'));
+    return;
+  }
+
+  var parameters = {
+    options: {
+      method: 'POST',
+      url: '/v1/summary',
+      formData: params,
+      json: true
+    },
+    defaultOptions: this._options
+  };
+  return requestFactory(parameters, callback);
+};
+
+module.exports = VisualInsights;