vision: support ImageContext in detect requests (#1342)

okofish · stephenplusplus · commit 7ff0a5bc4a4f · 2016-05-26T16:51:43.000-04:00
* vision: support ImageContext in detect requests ImageContext allows the user to provide "hints" about the content of the image to the Vision API. See https://cloud.google.com/vision/reference/rest/v1/images/annotate#ImageContext. * Added name to authors/contributors * Removed trailing whitespace * vision: Alphabetizing imageContext docs and handler locations, simplifying imageContext docs * vision: Adding test for imageContext * vision: Fixing doc formatting for imageContext
diff --git a/AUTHORS b/AUTHORS
@@ -9,3 +9,4 @@
 Google Inc.
 Anand Suresh
 Brett Bergmann
+Jesse Friedman
diff --git a/CONTRIBUTORS b/CONTRIBUTORS
@@ -17,6 +17,7 @@ Brett Bergmann <me@brettbergmann.com>
 Burcu Dogan <jbd@google.com>
 Hector Rovira <hrovira@gmail.com>
 Ido Shamun <idoesh1@gmail.com>
+Jesse Friedman <jesse@jesse.ws>
 Johan Euphrosine <proppy@google.com>
 Marco Ziccardi <marco.ziccard@gmail.com>
 Patrick Costello <pcostell@google.com>
diff --git a/lib/vision/index.js b/lib/vision/index.js
@@ -187,6 +187,9 @@ Vision.prototype.annotate = function(requests, callback) {
  *     image path, a remote image URL, or a gcloud File object.
  * @param {string[]|object=} options - An array of types or a configuration
  *     object.
+ * @param {object=} options.imageContext - See an
+ *     [`ImageContext`](https://cloud.google.com/vision/reference/rest/v1/images/annotate#ImageContext)
+ *     resource.
  * @param {number} options.maxResults - The maximum number of results, per type,
  *     to return in the response.
  * @param {string[]} options.types - An array of feature types to detect from
@@ -312,6 +315,10 @@ Vision.prototype.detect = function(images, options, callback) {
           }
         };
 
+        if (is.object(options.imageContext)) {
+          cfg.imageContext = options.imageContext;
+        }
+
         if (is.number(options.maxResults)) {
           cfg.features.maxResults = options.maxResults;
         }
diff --git a/test/vision/index.js b/test/vision/index.js
@@ -311,6 +311,40 @@ describe('Vision', function() {
       async.each(shortNames, checkConfig, done);
     });
 
+    it('should allow setting imageContext', function(done) {
+      var imageContext = {
+        latLongRect: {
+          minLatLng: {
+            latitude: 37.420901,
+            longitude: -122.081293
+          },
+          maxLatLng: {
+            latitude: 37.423228,
+            longitude: -122.086347
+          }
+        }
+      };
+
+      vision.annotate = function(config) {
+        assert.deepEqual(config, [
+          {
+            image: IMAGES[0],
+            features: {
+              type: 'LABEL_DETECTION'
+            },
+            imageContext: imageContext
+          }
+        ]);
+
+        done();
+      };
+
+      vision.detect(IMAGE, {
+        types: ['label'],
+        imageContext: imageContext
+      }, assert.ifError);
+    });
+
     it('should allow setting maxResults', function(done) {
       var maxResults = 10;
 

-Original file line number
+Diff line change
 Burcu Dogan <[email protected]>
 Hector Rovira <[email protected]>
 Ido Shamun <[email protected]>
 +Jesse Friedman <[email protected]>
 Johan Euphrosine <[email protected]>
 Marco Ziccardi <[email protected]>
 Patrick Costello <[email protected]>