google-cloud-vision 0.22.1 → 0.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6ae41f26fa335cd0ec9a055716542f405caed2e9
-  data.tar.gz: 355a0a40b3cb78ff3153c5fee062f9698f354242
+  metadata.gz: 5bdbd68499f14f96adeff2ab43a46eb094c2cbc1
+  data.tar.gz: 3ac3f507e6960ba31dff0c6723320e49fab0ac6c
 SHA512:
-  metadata.gz: 704c57d9fc2b0035f53217d4a81339ad311d5e4733e12d6dee9bc1a0626cebe88d07f2fcda36362234c364d02a28dc080dfe734640b0899b3b00211d458e8107
-  data.tar.gz: 3e1fdbb422795c61079e55fc0df11b288806fa80ec311d3a6ee67cb5520afd8a528ce91602bf2deb3e4bbcd5f939153700c5590c6337795e094e1256bb6c1513
+  metadata.gz: 98d7660ad9d58a22e402df61af630b8014c1c59c27754383c1d40536e9b6c014bedabbef579e29f08c261ac3ad6b18855c6bf1505585fb244637a7469aa63b4f
+  data.tar.gz: 2e53399f5efdd0f1712cf6877f7617c97951bade9f4c2fbfa519fb31b4f5759f31cddf2d10c957b84b0d5e13a0a83c93c30acc5171e80aac5eb18020c86b2a5e

data/lib/google/cloud/vision.rb

@@ -62,6 +62,16 @@ module Google
     # image = vision.image "path/to/landmark.jpg"
     # ```
     #
+    # Or any publicly-accessible image HTTP/HTTPS URL:
+    #
+    # ```ruby
+    # require "google/cloud/vision"
+    #
+    # vision = Google::Cloud::Vision.new
+    #
+    # image = vision.image "https://www.example.com/images/landmark.jpg"
+    # ```
+    #
     # Or, you can initialize the image with a Google Cloud Storage URI:
     #
     # ```ruby
@@ -98,7 +108,8 @@ module Google
     # ```
     #
     # To run multiple features on an image in a single request, pass the image
-    # (or a string file path or Storage URI) to {Vision::Project#annotate}:
+    # (or a string file path, publicly-accessible image HTTP/HTTPS URL, or
+    # Storage URI) to {Vision::Project#annotate}:
     #
     # ```ruby
     # require "google/cloud/vision"
@@ -159,7 +170,7 @@ module Google
     # annotations[0].faces.count #=> 1
     # annotations[0].labels.count #=> 4
     # annotations[1].landmarks.count #=> 1
-    # annotations[2].text.words.count #=> 28
+    # annotations[2].text.pages.count #=> 1
     # ```
     #
     # The maximum number of results returned when performing face, landmark,
@@ -430,14 +441,130 @@ module Google
         #   # labels = vision.image("path/to/labels.jpg").labels 5
         #
         attr_accessor :default_max_labels
+
+        ##
+        # The default max results to return for crop hints detection requests.
+        # This is used on {Project#annotate} as well as {Image#crop_hints}.
+        #
+        # The default value is 100.
+        #
+        # @example Using the default setting on {Project#annotate}:
+        #   require "google/cloud/vision"
+        #
+        #   vision = Google::Cloud::Vision.new
+        #
+        #   Google::Cloud::Vision.default_max_crop_hints #=> 100
+        #
+        #   img = "path/to/landmarks.jpg"
+        #   annotation = vision.annotate img, crop_hints: true
+        #   # This is the same as calling
+        #   # annotation = vision.annotate img, crop_hints: 100
+        #
+        # @example Updating the default setting on {Project#annotate}:
+        #   require "google/cloud/vision"
+        #
+        #   vision = Google::Cloud::Vision.new
+        #
+        #   # Set a new default
+        #   Google::Cloud::Vision.default_max_crop_hints = 5
+        #
+        #   img = "path/to/landmarks.jpg"
+        #   annotation = vision.annotate img, crop_hints: true
+        #   # This is the same as calling
+        #   # annotation = vision.annotate img, crop_hints: 5
+        #
+        #
+        # @example Using the default setting on {Image#crop_hints}:
+        #   require "google/cloud/vision"
+        #
+        #   vision = Google::Cloud::Vision.new
+        #
+        #   Google::Cloud::Vision.default_max_crop_hints #=> 100
+        #
+        #   crop_hints = vision.image("path/to/landmarks.jpg").crop_hints
+        #   # This is the same as calling
+        #   # crop_hints = vision.image("path/to/landmarks.jpg").crop_hints 100
+        #
+        # @example Updating the default setting on {Image#crop_hints}:
+        #   require "google/cloud/vision"
+        #
+        #   vision = Google::Cloud::Vision.new
+        #
+        #   # Set a new default
+        #   Google::Cloud::Vision.default_max_crop_hints = 5
+        #
+        #   crop_hints = vision.image("path/to/landmarks.jpg").crop_hints
+        #   # This is the same as calling
+        #   # crop_hints = vision.image("path/to/landmarks.jpg").crop_hints 5
+        #
+        attr_accessor :default_max_crop_hints
+
+        ##
+        # The default max results to return for web detection requests.
+        # This is used on {Project#annotate} as well as {Image#web}.
+        #
+        # The default value is 100.
+        #
+        # @example Using the default setting on {Project#annotate}:
+        #   require "google/cloud/vision"
+        #
+        #   vision = Google::Cloud::Vision.new
+        #
+        #   Google::Cloud::Vision.default_max_web #=> 100
+        #
+        #   img = "path/to/landmarks.jpg"
+        #   annotation = vision.annotate img, web: true
+        #   # This is the same as calling
+        #   # annotation = vision.annotate img, web: 100
+        #
+        # @example Updating the default setting on {Project#annotate}:
+        #   require "google/cloud/vision"
+        #
+        #   vision = Google::Cloud::Vision.new
+        #
+        #   # Set a new default
+        #   Google::Cloud::Vision.default_max_web = 5
+        #
+        #   img = "path/to/landmarks.jpg"
+        #   annotation = vision.annotate img, web: true
+        #   # This is the same as calling
+        #   # annotation = vision.annotate img, web: 5
+        #
+        #
+        # @example Using the default setting on {Image#web}:
+        #   require "google/cloud/vision"
+        #
+        #   vision = Google::Cloud::Vision.new
+        #
+        #   Google::Cloud::Vision.default_max_web #=> 100
+        #
+        #   web = vision.image("path/to/landmarks.jpg").web
+        #   # This is the same as calling
+        #   # web = vision.image("path/to/landmarks.jpg").web 100
+        #
+        # @example Updating the default setting on {Image#web}:
+        #   require "google/cloud/vision"
+        #
+        #   vision = Google::Cloud::Vision.new
+        #
+        #   # Set a new default
+        #   Google::Cloud::Vision.default_max_web = 5
+        #
+        #   web = vision.image("path/to/landmarks.jpg").web
+        #   # This is the same as calling
+        #   # web = vision.image("path/to/landmarks.jpg").web 5
+        #
+        attr_accessor :default_max_web
       end
 
       # Set the default values.
       # Update the comments documentation when these change.
-      self.default_max_faces     = 100
-      self.default_max_landmarks = 100
-      self.default_max_logos     = 100
-      self.default_max_labels    = 100
+      self.default_max_faces      = 100
+      self.default_max_landmarks  = 100
+      self.default_max_logos      = 100
+      self.default_max_labels     = 100
+      self.default_max_crop_hints = 100
+      self.default_max_web        = 100
 
       ##
       # Creates a new object for connecting to the Vision service.

data/lib/google/cloud/vision/annotate.rb

@@ -103,12 +103,19 @@ module Google
         #   detection feature. The maximum number of results is configured in
         #   {Google::Cloud::Vision.default_max_labels}, or may be provided here.
         #   Optional.
-        # @param [Boolean] text Whether to perform the text (OCR) feature.
+        # @param [Boolean] text Whether to perform the text detection feature
+        #   (OCR for shorter documents with sparse text). Optional.
+        # @param [Boolean] document Whether to perform the document text
+        #   detection feature (OCR for longer documents with dense text).
         #   Optional.
         # @param [Boolean] safe_search Whether to perform the safe search
         #   feature. Optional.
         # @param [Boolean] properties Whether to perform the image properties
         #   feature (currently, the image's dominant colors.) Optional.
+        # @param [Boolean, Integer] crop_hints Whether to perform the crop hints
+        #   feature. Optional.
+        # @param [Boolean, Integer] web Whether to perform the web annotation
+        #   feature. Optional.
         #
         # @return [Annotation, Array<Annotation>] The results for all image
         #   detections, returned as a single {Annotation} instance for one
@@ -133,13 +140,14 @@ module Google
         #   annotations[0].faces.count #=> 1
         #   annotations[0].labels.count #=> 4
         #   annotations[1].landmarks.count #=> 1
-        #   annotations[2].text.words.count #=> 28
+        #   annotations[2].text.pages.count #=> 1
         #
         def annotate *images, faces: false, landmarks: false, logos: false,
-                     labels: false, text: false, safe_search: false,
-                     properties: false
-          add_requests(images, faces, landmarks, logos, labels, text,
-                       safe_search, properties)
+                     labels: false, text: false, document: false,
+                     safe_search: false, properties: false, crop_hints: false,
+                     web: false
+          add_requests(images, faces, landmarks, logos, labels, text, document,
+                       safe_search, properties, crop_hints, web)
         end
 
         protected
@@ -150,9 +158,10 @@ module Google
         end
 
         def add_requests images, faces, landmarks, logos, labels, text,
-                         safe_search, properties
+                         document, safe_search, properties, crop_hints, web
           features = annotate_features(faces, landmarks, logos, labels, text,
-                                       safe_search, properties)
+                                       document, safe_search, properties,
+                                       crop_hints, web)
 
           Array(images).flatten.each do |img|
             i = image(img)
@@ -164,20 +173,34 @@ module Google
           end
         end
 
-        def annotate_features faces, landmarks, logos, labels, text,
-                              safe_search, properties
+        def annotate_features faces, landmarks, logos, labels, text, document,
+                              safe_search, properties, crop_hints, web
           return default_features if default_features?(
-            faces, landmarks, logos, labels, text, safe_search, properties)
+            faces, landmarks, logos, labels, text, document, safe_search,
+            properties, crop_hints, web)
 
-          faces, landmarks, logos, labels = validate_max_values(
-            faces, landmarks, logos, labels)
+          faces, landmarks, logos, labels, crop_hints, web = validate_max_args(
+            faces, landmarks, logos, labels, crop_hints, web)
+
+          f = value_features faces, landmarks, logos, labels, crop_hints, web
+          f + boolean_features(text, document, safe_search, properties)
+        end
 
+        def value_features faces, landmarks, logos, labels, crop_hints, web
           f = []
           f << feature(:FACE_DETECTION, faces) unless faces.zero?
           f << feature(:LANDMARK_DETECTION, landmarks) unless landmarks.zero?
           f << feature(:LOGO_DETECTION, logos) unless logos.zero?
           f << feature(:LABEL_DETECTION, labels) unless labels.zero?
+          f << feature(:CROP_HINTS, crop_hints) unless crop_hints.zero?
+          f << feature(:WEB_DETECTION, web) unless web.zero?
+          f
+        end
+
+        def boolean_features text, document, safe_search, properties
+          f = []
           f << feature(:TEXT_DETECTION, 1) if text
+          f << feature(:DOCUMENT_TEXT_DETECTION, 1) if document
           f << feature(:SAFE_SEARCH_DETECTION, 1) if safe_search
           f << feature(:IMAGE_PROPERTIES, 1) if properties
           f
@@ -188,11 +211,12 @@ module Google
             type: type, max_results: max_results)
         end
 
-        def default_features? faces, landmarks, logos, labels, text,
-                              safe_search, properties
+        def default_features? faces, landmarks, logos, labels, text, document,
+                              safe_search, properties, crop_hints, web
           faces == false && landmarks == false && logos == false &&
-            labels == false && text == false && safe_search == false &&
-            properties == false
+            labels == false && text == false && document == false &&
+            safe_search == false && properties == false &&
+            crop_hints == false && web == false
         end
 
         def default_features
@@ -204,21 +228,28 @@ module Google
             feature(:LABEL_DETECTION,
                     Google::Cloud::Vision.default_max_labels),
             feature(:TEXT_DETECTION, 1),
+            feature(:DOCUMENT_TEXT_DETECTION, 1),
             feature(:SAFE_SEARCH_DETECTION, 1),
-            feature(:IMAGE_PROPERTIES, 1)
+            feature(:IMAGE_PROPERTIES, 1),
+            feature(:CROP_HINTS, Google::Cloud::Vision.default_max_crop_hints),
+            feature(:WEB_DETECTION, Google::Cloud::Vision.default_max_web)
           ]
         end
 
-        def validate_max_values faces, landmarks, logos, labels
-          faces     = validate_max_value(
+        def validate_max_args faces, landmarks, logos, labels, crop_hints, web
+          faces      = validate_max_value(
             faces, Google::Cloud::Vision.default_max_faces)
-          landmarks = validate_max_value(
+          landmarks  = validate_max_value(
             landmarks, Google::Cloud::Vision.default_max_landmarks)
-          logos     = validate_max_value(
+          logos      = validate_max_value(
             logos, Google::Cloud::Vision.default_max_logos)
-          labels    = validate_max_value(
+          labels     = validate_max_value(
             labels, Google::Cloud::Vision.default_max_labels)
-          [faces, landmarks, logos, labels]
+          crop_hints = validate_max_value(
+            crop_hints, Google::Cloud::Vision.default_max_crop_hints)
+          web        = validate_max_value(
+            web, Google::Cloud::Vision.default_max_web)
+          [faces, landmarks, logos, labels, crop_hints, web]
         end
 
         def validate_max_value value, default_value

data/lib/google/cloud/vision/annotation.rb

@@ -18,6 +18,8 @@ require "google/cloud/vision/annotation/entity"
 require "google/cloud/vision/annotation/text"
 require "google/cloud/vision/annotation/safe_search"
 require "google/cloud/vision/annotation/properties"
+require "google/cloud/vision/annotation/crop_hint"
+require "google/cloud/vision/annotation/web"
 
 module Google
   module Cloud
@@ -105,7 +107,7 @@ module Google
         #   annotation.face? #=> true
         #
         def face?
-          faces.count > 0
+          faces.any?
         end
 
         ##
@@ -163,7 +165,7 @@ module Google
         #   annotation.landmark? #=> true
         #
         def landmark?
-          landmarks.count > 0
+          landmarks.any?
         end
 
         ##
@@ -221,7 +223,7 @@ module Google
         #   annotation.logo? #=> true
         #
         def logo?
-          logos.count > 0
+          logos.any?
         end
 
         ##
@@ -279,7 +281,7 @@ module Google
         #   annotation.label? #=> true
         #
         def label?
-          labels.count > 0
+          labels.any?
         end
 
         ##
@@ -297,7 +299,8 @@ module Google
         #   text = annotation.text
         #
         def text
-          @text ||= Text.from_grpc(@grpc.text_annotations)
+          @text ||= \
+            Text.from_grpc(@grpc.text_annotations, @grpc.full_text_annotation)
         end
 
         ##
@@ -321,7 +324,7 @@ module Google
         ##
         # The results of safe_search detection.
         #
-        # @return [SafeSearch]
+        # @return [SafeSearch, nil]
         #
         # @example
         #   require "google/cloud/vision"
@@ -359,7 +362,7 @@ module Google
         ##
         # The results of properties detection.
         #
-        # @return [Properties]
+        # @return [Properties, nil]
         #
         # @example
         #   require "google/cloud/vision"
@@ -394,6 +397,83 @@ module Google
           !properties.nil?
         end
 
+        ##
+        # The results of crop hints detection.
+        #
+        # @return [Array<CropHint>]
+        #
+        # @example
+        #   require "google/cloud/vision"
+        #
+        #   vision = Google::Cloud::Vision.new
+        #   image = vision.image "path/to/face.jpg"
+        #
+        #   annotation = vision.annotate image, crop_hints: true
+        #   crop_hints = annotation.crop_hints
+        #
+        def crop_hints
+          return [] unless @grpc.crop_hints_annotation
+          grpc_crop_hints = @grpc.crop_hints_annotation.crop_hints
+          @crop_hints ||= Array(grpc_crop_hints).map do |ch|
+            CropHint.from_grpc ch
+          end
+        end
+
+        ##
+        # Whether there is a result for crop hints detection.
+        #
+        # @return [Boolean]
+        #
+        # @example
+        #   require "google/cloud/vision"
+        #
+        #   vision = Google::Cloud::Vision.new
+        #   image = vision.image "path/to/face.jpg"
+        #
+        #   annotation = vision.annotate image, crop_hints: true
+        #   annotation.crop_hints? #=> true
+        #
+        def crop_hints?
+          crop_hints.any?
+        end
+
+        ##
+        # The results of web detection.
+        #
+        # @return [Web]
+        #
+        # @example
+        #   require "google/cloud/vision"
+        #
+        #   vision = Google::Cloud::Vision.new
+        #   image = vision.image "path/to/face.jpg"
+        #
+        #   annotation = vision.annotate image, web: true
+        #   web = annotation.web
+        #
+        def web
+          return nil unless @grpc.web_detection
+          @web ||= Web.from_grpc(@grpc.web_detection)
+        end
+
+        ##
+        # Whether there is a result for web detection.
+        #
+        # @return [Boolean]
+        #
+        # @example
+        #   require "google/cloud/vision"
+        #
+        #   vision = Google::Cloud::Vision.new
+        #   image = vision.image "path/to/face.jpg"
+        #
+        #   annotation = vision.annotate image, web: true
+        #   annotation.web? #=> true
+        #
+        def web?
+          !web.nil?
+        end
+
         ##
         # Deeply converts object to a hash. All keys will be symbolized.
         #
@@ -402,16 +482,18 @@ module Google
         def to_h
           { faces: faces.map(&:to_h), landmarks: landmarks.map(&:to_h),
             logos: logos.map(&:to_h), labels: labels.map(&:to_h),
-            text: text.map(&:to_h), safe_search: safe_search.to_h,
-            properties: properties.to_h }
+            text: text.to_h, safe_search: safe_search.to_h,
+            properties: properties.to_h, crop_hints: crop_hints.map(&:to_h),
+            web: web.to_h }
         end
 
         # @private
         def to_s
           tmplt = "(faces: %i, landmarks: %i, logos: %i, labels: %i," \
-                  " text: %s, safe_search: %s, properties: %s)"
+                  " text: %s, safe_search: %s, properties: %s," \
+                  " crop_hints: %s, web: %s)"
           format tmplt, faces.count, landmarks.count, logos.count, labels.count,
-                 text?, safe_search?, properties?
+                 text?, safe_search?, properties?, crop_hints?, web?
         end
 
         # @private