google-cloud-vision 0.38.0 → 1.1.1

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

@@ -1,254 +0,0 @@
-# Copyright 2020 Google LLC
-#
-# 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
-#
-#     https://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 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]
-          #     Detected break type.
-          # @!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 not co-occur with
-              # `SPACE`, `LEADER_SPACE`, or `LINE_BREAK`.
-              HYPHEN = 4
-
-              # 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. For PDFs the unit is points. For images (including
-        #     TIFFs) the unit is pixels.
-        # @!attribute [rw] height
-        #   @return [Integer]
-        #     Page height. For PDFs the unit is points. For images (including
-        #     TIFFs) the unit is pixels.
-        # @!attribute [rw] blocks
-        #   @return [Array<Google::Cloud::Vision::V1::Block>]
-        #     List of blocks of text, images etc on this page.
-        # @!attribute [rw] confidence
-        #   @return [Float]
-        #     Confidence of the OCR results on the page. Range [0, 1].
-        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 vertex 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.
-        # @!attribute [rw] confidence
-        #   @return [Float]
-        #     Confidence of the OCR results on the block. Range [0, 1].
-        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 vertex order will still be (0, 1, 2, 3).
-        # @!attribute [rw] words
-        #   @return [Array<Google::Cloud::Vision::V1::Word>]
-        #     List of all words in this paragraph.
-        # @!attribute [rw] confidence
-        #   @return [Float]
-        #     Confidence of the OCR results for the paragraph. Range [0, 1].
-        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 vertex 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.
-        # @!attribute [rw] confidence
-        #   @return [Float]
-        #     Confidence of the OCR results for the word. Range [0, 1].
-        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 vertex order will still be (0, 1, 2, 3).
-        # @!attribute [rw] text
-        #   @return [String]
-        #     The actual UTF-8 representation of the symbol.
-        # @!attribute [rw] confidence
-        #   @return [Float]
-        #     Confidence of the OCR results for the symbol. Range [0, 1].
-        class Symbol; end
-      end
-    end
-  end
-end

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

@@ -1,102 +0,0 @@
-# Copyright 2020 Google LLC
-#
-# 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
-#
-#     https://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.
-        #     Can include resized copies of the query image.
-        # @!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.
-        # @!attribute [rw] visually_similar_images
-        #   @return [Array<Google::Cloud::Vision::V1::WebDetection::WebImage>]
-        #     The visually similar image results.
-        # @!attribute [rw] best_guess_labels
-        #   @return [Array<Google::Cloud::Vision::V1::WebDetection::WebLabel>]
-        #     The service's best guess as to the topic of the request image.
-        #     Inferred from similar images on the open web.
-        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]
-          #     (Deprecated) Overall relevancy score for the image.
-          class WebImage; end
-
-          # Metadata for web pages.
-          # @!attribute [rw] url
-          #   @return [String]
-          #     The result web page URL.
-          # @!attribute [rw] score
-          #   @return [Float]
-          #     (Deprecated) Overall relevancy score for the web page.
-          # @!attribute [rw] page_title
-          #   @return [String]
-          #     Title for the web page, may contain HTML markups.
-          # @!attribute [rw] full_matching_images
-          #   @return [Array<Google::Cloud::Vision::V1::WebDetection::WebImage>]
-          #     Fully matching images on the page.
-          #     Can include resized copies of the query image.
-          # @!attribute [rw] partial_matching_images
-          #   @return [Array<Google::Cloud::Vision::V1::WebDetection::WebImage>]
-          #     Partial matching images on the page.
-          #     Those images are similar enough to share some key-point features. For
-          #     example an original image will likely have partial matching for its
-          #     crops.
-          class WebPage; end
-
-          # Label to provide extra metadata for the web detection.
-          # @!attribute [rw] label
-          #   @return [String]
-          #     Label for extra metadata.
-          # @!attribute [rw] language_code
-          #   @return [String]
-          #     The BCP-47 language code for `label`, such as "en-US" or "sr-Latn".
-          #     For more information, see
-          #     http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
-          class WebLabel; end
-        end
-      end
-    end
-  end
-end

data/lib/google/cloud/vision/v1/doc/google/longrunning/operations.rb

@@ -1,51 +0,0 @@
-# Copyright 2020 Google LLC
-#
-# 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
-#
-#     https://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 Longrunning
-    # This resource represents a long-running operation that is the result of a
-    # network API call.
-    # @!attribute [rw] name
-    #   @return [String]
-    #     The server-assigned name, which is only unique within the same service that
-    #     originally returns it. If you use the default HTTP mapping, the
-    #     `name` should be a resource name ending with `operations/{unique_id}`.
-    # @!attribute [rw] metadata
-    #   @return [Google::Protobuf::Any]
-    #     Service-specific metadata associated with the operation.  It typically
-    #     contains progress information and common metadata such as create time.
-    #     Some services might not provide such metadata.  Any method that returns a
-    #     long-running operation should document the metadata type, if any.
-    # @!attribute [rw] done
-    #   @return [true, false]
-    #     If the value is `false`, it means the operation is still in progress.
-    #     If `true`, the operation is completed, and either `error` or `response` is
-    #     available.
-    # @!attribute [rw] error
-    #   @return [Google::Rpc::Status]
-    #     The error result of the operation in case of failure or cancellation.
-    # @!attribute [rw] response
-    #   @return [Google::Protobuf::Any]
-    #     The normal response of the operation in case of success.  If the original
-    #     method returns no data on success, such as `Delete`, the response is
-    #     `google.protobuf.Empty`.  If the original method is standard
-    #     `Get`/`Create`/`Update`, the response should be the resource.  For other
-    #     methods, the response should have the type `XxxResponse`, where `Xxx`
-    #     is the original method name.  For example, if the original method name
-    #     is `TakeSnapshot()`, the inferred response type is
-    #     `TakeSnapshotResponse`.
-    class Operation; end
-  end
-end

data/lib/google/cloud/vision/v1/doc/google/protobuf/any.rb

@@ -1,131 +0,0 @@
-# Copyright 2020 Google LLC
-#
-# 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
-#
-#     https://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 Protobuf
-    # `Any` contains an arbitrary serialized protocol buffer message along with a
-    # URL that describes the type of the serialized message.
-    #
-    # Protobuf library provides support to pack/unpack Any values in the form
-    # of utility functions or additional generated methods of the Any type.
-    #
-    # Example 1: Pack and unpack a message in C++.
-    #
-    #     Foo foo = ...;
-    #     Any any;
-    #     any.PackFrom(foo);
-    #     ...
-    #     if (any.UnpackTo(&foo)) {
-    #       ...
-    #     }
-    #
-    # Example 2: Pack and unpack a message in Java.
-    #
-    #     Foo foo = ...;
-    #     Any any = Any.pack(foo);
-    #     ...
-    #     if (any.is(Foo.class)) {
-    #       foo = any.unpack(Foo.class);
-    #     }
-    #
-    #  Example 3: Pack and unpack a message in Python.
-    #
-    #     foo = Foo(...)
-    #     any = Any()
-    #     any.Pack(foo)
-    #     ...
-    #     if any.Is(Foo.DESCRIPTOR):
-    #       any.Unpack(foo)
-    #       ...
-    #
-    #  Example 4: Pack and unpack a message in Go
-    #
-    #      foo := &pb.Foo{...}
-    #      any, err := ptypes.MarshalAny(foo)
-    #      ...
-    #      foo := &pb.Foo{}
-    #      if err := ptypes.UnmarshalAny(any, foo); err != nil {
-    #        ...
-    #      }
-    #
-    # The pack methods provided by protobuf library will by default use
-    # 'type.googleapis.com/full.type.name' as the type URL and the unpack
-    # methods only use the fully qualified type name after the last '/'
-    # in the type URL, for example "foo.bar.com/x/y.z" will yield type
-    # name "y.z".
-    #
-    #
-    # = JSON
-    #
-    # The JSON representation of an `Any` value uses the regular
-    # representation of the deserialized, embedded message, with an
-    # additional field `@type` which contains the type URL. Example:
-    #
-    #     package google.profile;
-    #     message Person {
-    #       string first_name = 1;
-    #       string last_name = 2;
-    #     }
-    #
-    #     {
-    #       "@type": "type.googleapis.com/google.profile.Person",
-    #       "firstName": <string>,
-    #       "lastName": <string>
-    #     }
-    #
-    # If the embedded message type is well-known and has a custom JSON
-    # representation, that representation will be embedded adding a field
-    # `value` which holds the custom JSON in addition to the `@type`
-    # field. Example (for message {Google::Protobuf::Duration}):
-    #
-    #     {
-    #       "@type": "type.googleapis.com/google.protobuf.Duration",
-    #       "value": "1.212s"
-    #     }
-    # @!attribute [rw] type_url
-    #   @return [String]
-    #     A URL/resource name that uniquely identifies the type of the serialized
-    #     protocol buffer message. This string must contain at least
-    #     one "/" character. The last segment of the URL's path must represent
-    #     the fully qualified name of the type (as in
-    #     `path/google.protobuf.Duration`). The name should be in a canonical form
-    #     (e.g., leading "." is not accepted).
-    #
-    #     In practice, teams usually precompile into the binary all types that they
-    #     expect it to use in the context of Any. However, for URLs which use the
-    #     scheme `http`, `https`, or no scheme, one can optionally set up a type
-    #     server that maps type URLs to message definitions as follows:
-    #
-    #     * If no scheme is provided, `https` is assumed.
-    #     * An HTTP GET on the URL must yield a {Google::Protobuf::Type}
-    #       value in binary format, or produce an error.
-    #     * Applications are allowed to cache lookup results based on the
-    #       URL, or have them precompiled into a binary to avoid any
-    #       lookup. Therefore, binary compatibility needs to be preserved
-    #       on changes to types. (Use versioned type names to manage
-    #       breaking changes.)
-    #
-    #     Note: this functionality is not currently available in the official
-    #     protobuf release, and it is not used for type URLs beginning with
-    #     type.googleapis.com.
-    #
-    #     Schemes other than `http`, `https` (or the empty scheme) might be
-    #     used with implementation specific semantics.
-    # @!attribute [rw] value
-    #   @return [String]
-    #     Must be a valid serialized protocol buffer of the above specified type.
-    class Any; end
-  end
-end