Merge pull request #101 from watson-developer-cloud/visual-insights

Visual insights

Author: germanattanasio

README.md

@@ -20,6 +20,8 @@ APIs and SDKs that use cognitive computing to solve complex problems.
     * [Getting the Service Credentials](#getting-the-service-credentials)
     * [Alchemy Services](#alchemy-services)
       * [Alchemy Language](#alchemy-language)
+      * [Alchemy Vision](#alchemy-vision)
+      * [Alchemy Data News](#alchemy-data-news)
     * [IBM Watson Services](#ibm-watson-services)
       * [Authorization](#authorization)
       * [Concept Expansion](#concept-expansion)
@@ -35,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)
@@ -124,6 +127,55 @@ alchemy_language.sentiment(params, function (err, response) {
 });
 ```
 
+### Alchemy Vision
+[Alchemy Vision][alchemy_vision] uses deep learning innovations to understand a picture's content and context. It sees complex visual scenes in their entirety —without needing any textual clues— leveraging a holistic approach to understanding the multiple objects and surroundings.
+
+Example: Extract keywords from an image.
+
+```javascript
+var watson = require('watson-developer-cloud');
+var fs = require('fs');
+
+var alchemy_vision = watson.alchemy_vision({
+  api_key: '<api_key>'
+});
+
+var params = {
+  image: fs.fs.createReadStream('src/test/resources/obama.jpg')
+};
+
+alchemy_vision.getImageKeywords(params, function (err, keywords) {
+  if (err)
+    console.log('error:', err);
+  else
+    console.log(JSON.stringify(keywords, null, 2));
+});
+```
+
+### Alchemy Data News
+[Alchemy Data News][alchemy_data_news] indexes 250k to 300k English language news and blog articles every day with historical search available for the past 60 days.
+Example: Get the volume data from the last 7 days using 12hs of time slice.
+
+```javascript
+var watson = require('watson-developer-cloud');
+
+var alchemy_data_news = watson.alchemy_data_news({
+  api_key: '<api_key>'
+});
+
+var params = {
+  start: 'now-1d',
+  end: 'now'
+};
+
+alchemy_data_news.getNews(params, function (err, news) {
+  if (err)
+    console.log('error:', err);
+  else
+    console.log(JSON.stringify(news, null, 2));
+});
+```
+
 ## IBM Watson Services
 The Watson Developer Cloud offers a variety of services for building cognitive
 apps.
@@ -491,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.
@@ -590,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/
@@ -598,6 +677,9 @@ See [CONTRIBUTING](https://github.com/watson-developer-cloud/nodejs-wrapper/blob
 
 [alchemy_language]: http://www.alchemyapi.com/products/alchemylanguage
 [sentiment_analysis]: http://www.alchemyapi.com/products/alchemylanguage/sentiment-analysis
+[alchemy_vision]: http://www.alchemyapi.com/products/alchemyvision
+[alchemy_data_news]: http://www.alchemyapi.com/products/alchemydata-news
+
 [wdc]: http://www.ibm.com/smarterplanet/us/en/ibmwatson/developercloud/
 [bluemix]: https://console.ng.bluemix.net
 [npm_link]: https://www.npmjs.com/package/watson-developer-cloud

examples/alchemy_data_news.v1.js

@@ -0,0 +1,19 @@
+'use strict';
+
+var watson = require('watson-developer-cloud');
+
+var alchemy_data_news = watson.alchemy_data_news({
+  api_key: '<api_key>'
+});
+
+var params = {
+  start: 'now-1d',
+  end: 'now'
+};
+
+alchemy_data_news.getNews(params, function (err, news) {
+  if (err)
+    console.log('error:', err);
+  else
+    console.log(JSON.stringify(news, null, 2));
+});

examples/alchemy_vision.v1.js

@@ -0,0 +1,19 @@
+'use strict';
+
+var watson = require('watson-developer-cloud');
+var fs = require('fs');
+
+var alchemy_vision = watson.alchemy_vision({
+  api_key: '<api_key>'
+});
+
+var params = {
+  image: fs.fs.createReadStream('src/test/resources/obama.jpg')
+};
+
+alchemy_vision.getImageKeywords(params, function (err, keywords) {
+  if (err)
+    console.log('error:', err);
+  else
+    console.log(JSON.stringify(keywords, null, 2));
+});

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

@@ -12,9 +12,9 @@
   },
 
   "concepts": {
-    "url"  : "/url/URLGetRankedKeywords",
-    "text" : "/text/TextGetRankedKeywords",
-    "html" : "/html/HTMLGetRankedKeywords"
+    "url"  : "/url/URLGetRankedConcepts",
+    "text" : "/text/TextGetRankedConcepts",
+    "html" : "/html/HTMLGetRankedConcepts"
   },
 
   "sentiment": {
@@ -29,12 +29,6 @@
     "html" : "/html/HTMLGetTargetedSentiment"
   },
 
-  "category": {
-    "url"  : "/url/URLGetRankedConcepts",
-    "text" : "/text/TextGetRankedConcepts",
-    "html" : "/html/HTMLGetRankedConcepts"
-  },
-
   "relations": {
     "url"  : "/url/URLGetRelations",
     "text" : "/text/TextGetRelations",
@@ -52,6 +46,16 @@
     "html" : "/html/HTMLGetText"
   },
 
+  "category": {
+    "url"  : "/url/URLGetCategory",
+    "text" : "/text/TextGetCategory"
+  },
+
+  "publication_date": {
+    "url"  : "/url/URLGetPubDate",
+    "html" : "/html/HTMLGetPubDate"
+  },
+
   "text_raw": {
     "url"  : "/url/URLGetRawText",
     "html" : "/html/HTMLGetRawText"
@@ -86,7 +90,7 @@
 
   "image_link": {
     "url"  : "/url/URLGetImage",
-    "html" : "/html/HTMLGetImage"
+    "html" : "/url/HTMLGetImage"
   },
 
   "image_keywords": {

lib/alchemy_endpoints.json

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

lib/index.js

@@ -18,8 +18,6 @@
 
 var extend         = require('extend');
 var requestFactory = require('../../lib/requestwrapper');
-var endpoints      = require('../../lib/alchemy_endpoints.json');
-var helper         = require('../../lib/helper');
 
 function errorFormatter(cb) {
   return function(err, result, response) {
@@ -38,32 +36,6 @@ function errorFormatter(cb) {
   };
 }
 
-function createRequest(method) {
-  return function(_params, callback ) {
-    var params = _params || {};
-    var accepted_formats = Object.keys(endpoints[method]);
-    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[method][format],
-        method: 'POST',
-        json: true,
-        form: extend({outputMode: 'json'}, params) // change default output to json
-      },
-      defaultOptions: this._options
-    };
-    return requestFactory(parameters, errorFormatter(callback));
-  };
-}
-
 function AlchemyDataNews(options) {
   // Default URL
   var serviceDefaults = {

services/alchemy_data_news/v1.js

@@ -130,10 +130,15 @@ AlchemyLanguage.prototype.relations = createRequest('relations');
  */
 AlchemyLanguage.prototype.category = createRequest('category');
 
+/**
+ * Categorizes the text for text, a URL or HTML.
+ */
+AlchemyLanguage.prototype.publicationDate = createRequest('publication_date');
+
 /**
  * Detects the RSS/ATOM feeds for a URL or HTML.
  */
-AlchemyLanguage.prototype.feeds = createRequest('category');
+AlchemyLanguage.prototype.feeds = createRequest('feeds');
 
 /**
  * Parses the microformats for a URL or HTML.