google-cloud-vision 0.22.1 → 0.23.0

data/lib/google/cloud/vision/v1/doc/google/cloud/vision/v1/text_annotation.rb

@@ -0,0 +1,231 @@
+# Copyright 2016 Google Inc. 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.
+
+module Google
+  module Cloud
+    module Vision
+      module V1
+        # TextAnnotation contains a structured representation of OCR extracted text.
+        # The hierarchy of an OCR extracted text structure is like this:
+        #     TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol
+        # Each structural component, starting from Page, may further have their own
+        # properties. Properties describe detected languages, breaks etc.. Please
+        # refer to the Google::Cloud::Vision::V1::TextAnnotation::TextProperty message
+        # definition below for more detail.
+        # @!attribute [rw] pages
+        #   @return [Array<Google::Cloud::Vision::V1::Page>]
+        #     List of pages detected by OCR.
+        # @!attribute [rw] text
+        #   @return [String]
+        #     UTF-8 text detected on the pages.
+        class TextAnnotation
+          # Detected language for a structural component.
+          # @!attribute [rw] language_code
+          #   @return [String]
+          #     The BCP-47 language code, such as "en-US" or "sr-Latn". For more
+          #     information, see
+          #     http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
+          # @!attribute [rw] confidence
+          #   @return [Float]
+          #     Confidence of detected language. Range [0, 1].
+          class DetectedLanguage; end
+
+          # Detected start or end of a structural component.
+          # @!attribute [rw] type
+          #   @return [Google::Cloud::Vision::V1::TextAnnotation::DetectedBreak::BreakType]
+          # @!attribute [rw] is_prefix
+          #   @return [true, false]
+          #     True if break prepends the element.
+          class DetectedBreak
+            # Enum to denote the type of break found. New line, space etc.
+            module BreakType
+              # Unknown break label type.
+              UNKNOWN = 0
+
+              # Regular space.
+              SPACE = 1
+
+              # Sure space (very wide).
+              SURE_SPACE = 2
+
+              # Line-wrapping break.
+              EOL_SURE_SPACE = 3
+
+              # End-line hyphen that is not present in text; does
+              HYPHEN = 4
+
+              # not co-occur with SPACE, LEADER_SPACE, or
+              # LINE_BREAK.
+              # Line break that ends a paragraph.
+              LINE_BREAK = 5
+            end
+          end
+
+          # Additional information detected on the structural component.
+          # @!attribute [rw] detected_languages
+          #   @return [Array<Google::Cloud::Vision::V1::TextAnnotation::DetectedLanguage>]
+          #     A list of detected languages together with confidence.
+          # @!attribute [rw] detected_break
+          #   @return [Google::Cloud::Vision::V1::TextAnnotation::DetectedBreak]
+          #     Detected start or end of a text segment.
+          class TextProperty; end
+        end
+
+        # Detected page from OCR.
+        # @!attribute [rw] property
+        #   @return [Google::Cloud::Vision::V1::TextAnnotation::TextProperty]
+        #     Additional information detected on the page.
+        # @!attribute [rw] width
+        #   @return [Integer]
+        #     Page width in pixels.
+        # @!attribute [rw] height
+        #   @return [Integer]
+        #     Page height in pixels.
+        # @!attribute [rw] blocks
+        #   @return [Array<Google::Cloud::Vision::V1::Block>]
+        #     List of blocks of text, images etc on this page.
+        class Page; end
+
+        # Logical element on the page.
+        # @!attribute [rw] property
+        #   @return [Google::Cloud::Vision::V1::TextAnnotation::TextProperty]
+        #     Additional information detected for the block.
+        # @!attribute [rw] bounding_box
+        #   @return [Google::Cloud::Vision::V1::BoundingPoly]
+        #     The bounding box for the block.
+        #     The vertices are in the order of top-left, top-right, bottom-right,
+        #     bottom-left. When a rotation of the bounding box is detected the rotation
+        #     is represented as around the top-left corner as defined when the text is
+        #     read in the 'natural' orientation.
+        #     For example:
+        #       * when the text is horizontal it might look like:
+        #          0----1
+        #          |    |
+        #          3----2
+        #       * when it's rotated 180 degrees around the top-left corner it becomes:
+        #          2----3
+        #          |    |
+        #          1----0
+        #       and the vertice order will still be (0, 1, 2, 3).
+        # @!attribute [rw] paragraphs
+        #   @return [Array<Google::Cloud::Vision::V1::Paragraph>]
+        #     List of paragraphs in this block (if this blocks is of type text).
+        # @!attribute [rw] block_type
+        #   @return [Google::Cloud::Vision::V1::Block::BlockType]
+        #     Detected block type (text, image etc) for this block.
+        class Block
+          # Type of a block (text, image etc) as identified by OCR.
+          module BlockType
+            # Unknown block type.
+            UNKNOWN = 0
+
+            # Regular text block.
+            TEXT = 1
+
+            # Table block.
+            TABLE = 2
+
+            # Image block.
+            PICTURE = 3
+
+            # Horizontal/vertical line box.
+            RULER = 4
+
+            # Barcode block.
+            BARCODE = 5
+          end
+        end
+
+        # Structural unit of text representing a number of words in certain order.
+        # @!attribute [rw] property
+        #   @return [Google::Cloud::Vision::V1::TextAnnotation::TextProperty]
+        #     Additional information detected for the paragraph.
+        # @!attribute [rw] bounding_box
+        #   @return [Google::Cloud::Vision::V1::BoundingPoly]
+        #     The bounding box for the paragraph.
+        #     The vertices are in the order of top-left, top-right, bottom-right,
+        #     bottom-left. When a rotation of the bounding box is detected the rotation
+        #     is represented as around the top-left corner as defined when the text is
+        #     read in the 'natural' orientation.
+        #     For example:
+        #       * when the text is horizontal it might look like:
+        #          0----1
+        #          |    |
+        #          3----2
+        #       * when it's rotated 180 degrees around the top-left corner it becomes:
+        #          2----3
+        #          |    |
+        #          1----0
+        #       and the vertice order will still be (0, 1, 2, 3).
+        # @!attribute [rw] words
+        #   @return [Array<Google::Cloud::Vision::V1::Word>]
+        #     List of words in this paragraph.
+        class Paragraph; end
+
+        # A word representation.
+        # @!attribute [rw] property
+        #   @return [Google::Cloud::Vision::V1::TextAnnotation::TextProperty]
+        #     Additional information detected for the word.
+        # @!attribute [rw] bounding_box
+        #   @return [Google::Cloud::Vision::V1::BoundingPoly]
+        #     The bounding box for the word.
+        #     The vertices are in the order of top-left, top-right, bottom-right,
+        #     bottom-left. When a rotation of the bounding box is detected the rotation
+        #     is represented as around the top-left corner as defined when the text is
+        #     read in the 'natural' orientation.
+        #     For example:
+        #       * when the text is horizontal it might look like:
+        #          0----1
+        #          |    |
+        #          3----2
+        #       * when it's rotated 180 degrees around the top-left corner it becomes:
+        #          2----3
+        #          |    |
+        #          1----0
+        #       and the vertice order will still be (0, 1, 2, 3).
+        # @!attribute [rw] symbols
+        #   @return [Array<Google::Cloud::Vision::V1::Symbol>]
+        #     List of symbols in the word.
+        #     The order of the symbols follows the natural reading order.
+        class Word; end
+
+        # A single symbol representation.
+        # @!attribute [rw] property
+        #   @return [Google::Cloud::Vision::V1::TextAnnotation::TextProperty]
+        #     Additional information detected for the symbol.
+        # @!attribute [rw] bounding_box
+        #   @return [Google::Cloud::Vision::V1::BoundingPoly]
+        #     The bounding box for the symbol.
+        #     The vertices are in the order of top-left, top-right, bottom-right,
+        #     bottom-left. When a rotation of the bounding box is detected the rotation
+        #     is represented as around the top-left corner as defined when the text is
+        #     read in the 'natural' orientation.
+        #     For example:
+        #       * when the text is horizontal it might look like:
+        #          0----1
+        #          |    |
+        #          3----2
+        #       * when it's rotated 180 degrees around the top-left corner it becomes:
+        #          2----3
+        #          |    |
+        #          1----0
+        #       and the vertice order will still be (0, 1, 2, 3).
+        # @!attribute [rw] text
+        #   @return [String]
+        #     The actual UTF-8 representation of the symbol.
+        class Symbol; end
+      end
+    end
+  end
+end

data/lib/google/cloud/vision/v1/doc/google/cloud/vision/v1/web_detection.rb

@@ -0,0 +1,73 @@
+# Copyright 2016 Google Inc. 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.
+
+module Google
+  module Cloud
+    module Vision
+      module V1
+        # Relevant information for the image from the Internet.
+        # @!attribute [rw] web_entities
+        #   @return [Array<Google::Cloud::Vision::V1::WebDetection::WebEntity>]
+        #     Deduced entities from similar images on the Internet.
+        # @!attribute [rw] full_matching_images
+        #   @return [Array<Google::Cloud::Vision::V1::WebDetection::WebImage>]
+        #     Fully matching images from the Internet.
+        #     They're definite neardups and most often a copy of the query image with
+        #     merely a size change.
+        # @!attribute [rw] partial_matching_images
+        #   @return [Array<Google::Cloud::Vision::V1::WebDetection::WebImage>]
+        #     Partial matching images from the Internet.
+        #     Those images are similar enough to share some key-point features. For
+        #     example an original image will likely have partial matching for its crops.
+        # @!attribute [rw] pages_with_matching_images
+        #   @return [Array<Google::Cloud::Vision::V1::WebDetection::WebPage>]
+        #     Web pages containing the matching images from the Internet.
+        class WebDetection
+          # Entity deduced from similar images on the Internet.
+          # @!attribute [rw] entity_id
+          #   @return [String]
+          #     Opaque entity ID.
+          # @!attribute [rw] score
+          #   @return [Float]
+          #     Overall relevancy score for the entity.
+          #     Not normalized and not comparable across different image queries.
+          # @!attribute [rw] description
+          #   @return [String]
+          #     Canonical description of the entity, in English.
+          class WebEntity; end
+
+          # Metadata for online images.
+          # @!attribute [rw] url
+          #   @return [String]
+          #     The result image URL.
+          # @!attribute [rw] score
+          #   @return [Float]
+          #     Overall relevancy score for the image.
+          #     Not normalized and not comparable across different image queries.
+          class WebImage; end
+
+          # Metadata for web pages.
+          # @!attribute [rw] url
+          #   @return [String]
+          #     The result web page URL.
+          # @!attribute [rw] score
+          #   @return [Float]
+          #     Overall relevancy score for the web page.
+          #     Not normalized and not comparable across different image queries.
+          class WebPage; end
+        end
+      end
+    end
+  end
+end

data/lib/google/cloud/vision/v1/image_annotator_client.rb

@@ -32,9 +32,9 @@ module Google
   module Cloud
     module Vision
       module V1
-        # Service that performs Google Cloud Vision API detection tasks, such as face,
-        # landmark, logo, label, and text detection, over client images, and returns
-        # detected entities from the images.
+        # Service that performs Google Cloud Vision API detection tasks over client
+        # images, such as face, landmark, logo, label, and text detection. The
+        # ImageAnnotator service returns detected entities from the images.
         #
         # @!attribute [r] image_annotator_stub
         #   @return [Google::Cloud::Vision::V1::ImageAnnotator::Stub]
@@ -95,7 +95,7 @@ module Google
 
             google_api_client = "gl-ruby/#{RUBY_VERSION}"
             google_api_client << " #{lib_name}/#{lib_version}" if lib_name
-            google_api_client << " gapic/ gax/#{Google::Gax::VERSION}"
+            google_api_client << " gapic/0.6.8 gax/#{Google::Gax::VERSION}"
             google_api_client << " grpc/#{GRPC::VERSION}"
             google_api_client.freeze
 

data/lib/google/cloud/vision/v1/image_annotator_pb.rb

@@ -5,6 +5,8 @@ require 'google/protobuf'
 
 require 'google/api/annotations_pb'
 require 'google/cloud/vision/v1/geometry_pb'
+require 'google/cloud/vision/v1/text_annotation_pb'
+require 'google/cloud/vision/v1/web_detection_pb'
 require 'google/rpc/status_pb'
 require 'google/type/color_pb'
 require 'google/type/latlng_pb'
@@ -20,11 +22,15 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     value :LOGO_DETECTION, 3
     value :LABEL_DETECTION, 4
     value :TEXT_DETECTION, 5
+    value :DOCUMENT_TEXT_DETECTION, 11
     value :SAFE_SEARCH_DETECTION, 6
     value :IMAGE_PROPERTIES, 7
+    value :CROP_HINTS, 9
+    value :WEB_DETECTION, 10
   end
   add_message "google.cloud.vision.v1.ImageSource" do
     optional :gcs_image_uri, :string, 1
+    optional :image_uri, :string, 2
   end
   add_message "google.cloud.vision.v1.Image" do
     optional :content, :bytes, 1
@@ -127,9 +133,21 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
   add_message "google.cloud.vision.v1.ImageProperties" do
     optional :dominant_colors, :message, 1, "google.cloud.vision.v1.DominantColorsAnnotation"
   end
+  add_message "google.cloud.vision.v1.CropHint" do
+    optional :bounding_poly, :message, 1, "google.cloud.vision.v1.BoundingPoly"
+    optional :confidence, :float, 2
+    optional :importance_fraction, :float, 3
+  end
+  add_message "google.cloud.vision.v1.CropHintsAnnotation" do
+    repeated :crop_hints, :message, 1, "google.cloud.vision.v1.CropHint"
+  end
+  add_message "google.cloud.vision.v1.CropHintsParams" do
+    repeated :aspect_ratios, :float, 1
+  end
   add_message "google.cloud.vision.v1.ImageContext" do
     optional :lat_long_rect, :message, 1, "google.cloud.vision.v1.LatLongRect"
     repeated :language_hints, :string, 2
+    optional :crop_hints_params, :message, 4, "google.cloud.vision.v1.CropHintsParams"
   end
   add_message "google.cloud.vision.v1.AnnotateImageRequest" do
     optional :image, :message, 1, "google.cloud.vision.v1.Image"
@@ -142,8 +160,11 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     repeated :logo_annotations, :message, 3, "google.cloud.vision.v1.EntityAnnotation"
     repeated :label_annotations, :message, 4, "google.cloud.vision.v1.EntityAnnotation"
     repeated :text_annotations, :message, 5, "google.cloud.vision.v1.EntityAnnotation"
+    optional :full_text_annotation, :message, 12, "google.cloud.vision.v1.TextAnnotation"
     optional :safe_search_annotation, :message, 6, "google.cloud.vision.v1.SafeSearchAnnotation"
     optional :image_properties_annotation, :message, 8, "google.cloud.vision.v1.ImageProperties"
+    optional :crop_hints_annotation, :message, 11, "google.cloud.vision.v1.CropHintsAnnotation"
+    optional :web_detection, :message, 13, "google.cloud.vision.v1.WebDetection"
     optional :error, :message, 9, "google.rpc.Status"
   end
   add_message "google.cloud.vision.v1.BatchAnnotateImagesRequest" do
@@ -181,6 +202,9 @@ module Google
         ColorInfo = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.vision.v1.ColorInfo").msgclass
         DominantColorsAnnotation = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.vision.v1.DominantColorsAnnotation").msgclass
         ImageProperties = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.vision.v1.ImageProperties").msgclass
+        CropHint = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.vision.v1.CropHint").msgclass
+        CropHintsAnnotation = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.vision.v1.CropHintsAnnotation").msgclass
+        CropHintsParams = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.vision.v1.CropHintsParams").msgclass
         ImageContext = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.vision.v1.ImageContext").msgclass
         AnnotateImageRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.vision.v1.AnnotateImageRequest").msgclass
         AnnotateImageResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.vision.v1.AnnotateImageResponse").msgclass

data/lib/google/cloud/vision/v1/image_annotator_services_pb.rb

@@ -24,9 +24,9 @@ module Google
     module Vision
       module V1
         module ImageAnnotator
-          # Service that performs Google Cloud Vision API detection tasks, such as face,
-          # landmark, logo, label, and text detection, over client images, and returns
-          # detected entities from the images.
+          # Service that performs Google Cloud Vision API detection tasks over client
+          # images, such as face, landmark, logo, label, and text detection. The
+          # ImageAnnotator service returns detected entities from the images.
           class Service
 
             include GRPC::GenericService

data/lib/google/cloud/vision/v1/text_annotation_pb.rb

@@ -0,0 +1,88 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: google/cloud/vision/v1/text_annotation.proto
+
+require 'google/protobuf'
+
+require 'google/api/annotations_pb'
+require 'google/cloud/vision/v1/geometry_pb'
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_message "google.cloud.vision.v1.TextAnnotation" do
+    repeated :pages, :message, 1, "google.cloud.vision.v1.Page"
+    optional :text, :string, 2
+  end
+  add_message "google.cloud.vision.v1.TextAnnotation.DetectedLanguage" do
+    optional :language_code, :string, 1
+    optional :confidence, :float, 2
+  end
+  add_message "google.cloud.vision.v1.TextAnnotation.DetectedBreak" do
+    optional :type, :enum, 1, "google.cloud.vision.v1.TextAnnotation.DetectedBreak.BreakType"
+    optional :is_prefix, :bool, 2
+  end
+  add_enum "google.cloud.vision.v1.TextAnnotation.DetectedBreak.BreakType" do
+    value :UNKNOWN, 0
+    value :SPACE, 1
+    value :SURE_SPACE, 2
+    value :EOL_SURE_SPACE, 3
+    value :HYPHEN, 4
+    value :LINE_BREAK, 5
+  end
+  add_message "google.cloud.vision.v1.TextAnnotation.TextProperty" do
+    repeated :detected_languages, :message, 1, "google.cloud.vision.v1.TextAnnotation.DetectedLanguage"
+    optional :detected_break, :message, 2, "google.cloud.vision.v1.TextAnnotation.DetectedBreak"
+  end
+  add_message "google.cloud.vision.v1.Page" do
+    optional :property, :message, 1, "google.cloud.vision.v1.TextAnnotation.TextProperty"
+    optional :width, :int32, 2
+    optional :height, :int32, 3
+    repeated :blocks, :message, 4, "google.cloud.vision.v1.Block"
+  end
+  add_message "google.cloud.vision.v1.Block" do
+    optional :property, :message, 1, "google.cloud.vision.v1.TextAnnotation.TextProperty"
+    optional :bounding_box, :message, 2, "google.cloud.vision.v1.BoundingPoly"
+    repeated :paragraphs, :message, 3, "google.cloud.vision.v1.Paragraph"
+    optional :block_type, :enum, 4, "google.cloud.vision.v1.Block.BlockType"
+  end
+  add_enum "google.cloud.vision.v1.Block.BlockType" do
+    value :UNKNOWN, 0
+    value :TEXT, 1
+    value :TABLE, 2
+    value :PICTURE, 3
+    value :RULER, 4
+    value :BARCODE, 5
+  end
+  add_message "google.cloud.vision.v1.Paragraph" do
+    optional :property, :message, 1, "google.cloud.vision.v1.TextAnnotation.TextProperty"
+    optional :bounding_box, :message, 2, "google.cloud.vision.v1.BoundingPoly"
+    repeated :words, :message, 3, "google.cloud.vision.v1.Word"
+  end
+  add_message "google.cloud.vision.v1.Word" do
+    optional :property, :message, 1, "google.cloud.vision.v1.TextAnnotation.TextProperty"
+    optional :bounding_box, :message, 2, "google.cloud.vision.v1.BoundingPoly"
+    repeated :symbols, :message, 3, "google.cloud.vision.v1.Symbol"
+  end
+  add_message "google.cloud.vision.v1.Symbol" do
+    optional :property, :message, 1, "google.cloud.vision.v1.TextAnnotation.TextProperty"
+    optional :bounding_box, :message, 2, "google.cloud.vision.v1.BoundingPoly"
+    optional :text, :string, 3
+  end
+end
+
+module Google
+  module Cloud
+    module Vision
+      module V1
+        TextAnnotation = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.vision.v1.TextAnnotation").msgclass
+        TextAnnotation::DetectedLanguage = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.vision.v1.TextAnnotation.DetectedLanguage").msgclass
+        TextAnnotation::DetectedBreak = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.vision.v1.TextAnnotation.DetectedBreak").msgclass
+        TextAnnotation::DetectedBreak::BreakType = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.vision.v1.TextAnnotation.DetectedBreak.BreakType").enummodule
+        TextAnnotation::TextProperty = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.vision.v1.TextAnnotation.TextProperty").msgclass
+        Page = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.vision.v1.Page").msgclass
+        Block = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.vision.v1.Block").msgclass
+        Block::BlockType = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.vision.v1.Block.BlockType").enummodule
+        Paragraph = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.vision.v1.Paragraph").msgclass
+        Word = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.vision.v1.Word").msgclass
+        Symbol = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.vision.v1.Symbol").msgclass
+      end
+    end
+  end
+end