generated/google/apis/vision_v1/classes.rb in google-api-client-0.12.0 vs generated/google/apis/vision_v1/classes.rb in google-api-client-0.13.0

- old
+ new

@@ -20,114 +20,406 @@ module Google module Apis module VisionV1 - # Relevant information for the image from the Internet. - class WebDetection + # Set of dominant colors and their corresponding scores. + class DominantColorsAnnotation include Google::Apis::Core::Hashable - # Web pages containing the matching images from the Internet. - # Corresponds to the JSON property `pagesWithMatchingImages` - # @return [Array<Google::Apis::VisionV1::WebPage>] - attr_accessor :pages_with_matching_images + # RGB color values with their score and pixel fraction. + # Corresponds to the JSON property `colors` + # @return [Array<Google::Apis::VisionV1::ColorInfo>] + attr_accessor :colors - # 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. - # Corresponds to the JSON property `partialMatchingImages` - # @return [Array<Google::Apis::VisionV1::WebImage>] - attr_accessor :partial_matching_images + def initialize(**args) + update!(**args) + end - # The visually similar image results. - # Corresponds to the JSON property `visuallySimilarImages` - # @return [Array<Google::Apis::VisionV1::WebImage>] - attr_accessor :visually_similar_images + # Update properties of this object + def update!(**args) + @colors = args[:colors] if args.key?(:colors) + end + end - # Fully matching images from the Internet. - # Can include resized copies of the query image. - # Corresponds to the JSON property `fullMatchingImages` - # @return [Array<Google::Apis::VisionV1::WebImage>] - attr_accessor :full_matching_images + # 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. + class TextAnnotation + include Google::Apis::Core::Hashable - # Deduced entities from similar images on the Internet. - # Corresponds to the JSON property `webEntities` - # @return [Array<Google::Apis::VisionV1::WebEntity>] - attr_accessor :web_entities + # List of pages detected by OCR. + # Corresponds to the JSON property `pages` + # @return [Array<Google::Apis::VisionV1::Page>] + attr_accessor :pages + # UTF-8 text detected on the pages. + # Corresponds to the JSON property `text` + # @return [String] + attr_accessor :text + def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) - @pages_with_matching_images = args[:pages_with_matching_images] if args.key?(:pages_with_matching_images) - @partial_matching_images = args[:partial_matching_images] if args.key?(:partial_matching_images) - @visually_similar_images = args[:visually_similar_images] if args.key?(:visually_similar_images) - @full_matching_images = args[:full_matching_images] if args.key?(:full_matching_images) - @web_entities = args[:web_entities] if args.key?(:web_entities) + @pages = args[:pages] if args.key?(:pages) + @text = args[:text] if args.key?(:text) end end - # Response to a batch image annotation request. - class BatchAnnotateImagesResponse + # A vertex represents a 2D point in the image. + # NOTE: the vertex coordinates are in the same scale as the original image. + class Vertex include Google::Apis::Core::Hashable - # Individual responses to image annotation requests within the batch. - # Corresponds to the JSON property `responses` - # @return [Array<Google::Apis::VisionV1::AnnotateImageResponse>] - attr_accessor :responses + # X coordinate. + # Corresponds to the JSON property `x` + # @return [Fixnum] + attr_accessor :x + # Y coordinate. + # Corresponds to the JSON property `y` + # @return [Fixnum] + attr_accessor :y + def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) - @responses = args[:responses] if args.key?(:responses) + @x = args[:x] if args.key?(:x) + @y = args[:y] if args.key?(:y) end end - # External image source (Google Cloud Storage image location). - class ImageSource + # Detected language for a structural component. + class DetectedLanguage include Google::Apis::Core::Hashable - # NOTE: For new code `image_uri` below is preferred. - # Google Cloud Storage image URI, which must be in the following form: - # `gs://bucket_name/object_name` (for details, see - # [Google Cloud Storage Request - # URIs](https://cloud.google.com/storage/docs/reference-uris)). - # NOTE: Cloud Storage object versioning is not supported. - # Corresponds to the JSON property `gcsImageUri` + # 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. + # Corresponds to the JSON property `languageCode` # @return [String] - attr_accessor :gcs_image_uri + attr_accessor :language_code - # Image URI which supports: - # 1) Google Cloud Storage image URI, which must be in the following form: - # `gs://bucket_name/object_name` (for details, see - # [Google Cloud Storage Request - # URIs](https://cloud.google.com/storage/docs/reference-uris)). - # NOTE: Cloud Storage object versioning is not supported. - # 2) Publicly accessible image HTTP/HTTPS URL. - # This is preferred over the legacy `gcs_image_uri` above. When both - # `gcs_image_uri` and `image_uri` are specified, `image_uri` takes - # precedence. - # Corresponds to the JSON property `imageUri` + # Confidence of detected language. Range [0, 1]. + # Corresponds to the JSON property `confidence` + # @return [Float] + attr_accessor :confidence + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @language_code = args[:language_code] if args.key?(:language_code) + @confidence = args[:confidence] if args.key?(:confidence) + end + end + + # Additional information detected on the structural component. + class TextProperty + include Google::Apis::Core::Hashable + + # Detected start or end of a structural component. + # Corresponds to the JSON property `detectedBreak` + # @return [Google::Apis::VisionV1::DetectedBreak] + attr_accessor :detected_break + + # A list of detected languages together with confidence. + # Corresponds to the JSON property `detectedLanguages` + # @return [Array<Google::Apis::VisionV1::DetectedLanguage>] + attr_accessor :detected_languages + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @detected_break = args[:detected_break] if args.key?(:detected_break) + @detected_languages = args[:detected_languages] if args.key?(:detected_languages) + end + end + + # A bounding polygon for the detected image annotation. + class BoundingPoly + include Google::Apis::Core::Hashable + + # The bounding polygon vertices. + # Corresponds to the JSON property `vertices` + # @return [Array<Google::Apis::VisionV1::Vertex>] + attr_accessor :vertices + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @vertices = args[:vertices] if args.key?(:vertices) + end + end + + # Entity deduced from similar images on the Internet. + class WebEntity + include Google::Apis::Core::Hashable + + # Overall relevancy score for the entity. + # Not normalized and not comparable across different image queries. + # Corresponds to the JSON property `score` + # @return [Float] + attr_accessor :score + + # Opaque entity ID. + # Corresponds to the JSON property `entityId` # @return [String] - attr_accessor :image_uri + attr_accessor :entity_id + # Canonical description of the entity, in English. + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description + def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) - @gcs_image_uri = args[:gcs_image_uri] if args.key?(:gcs_image_uri) - @image_uri = args[:image_uri] if args.key?(:image_uri) + @score = args[:score] if args.key?(:score) + @entity_id = args[:entity_id] if args.key?(:entity_id) + @description = args[:description] if args.key?(:description) end end + # Response to an image annotation request. + class AnnotateImageResponse + include Google::Apis::Core::Hashable + + # The `Status` type defines a logical error model that is suitable for different + # programming environments, including REST APIs and RPC APIs. It is used by + # [gRPC](https://github.com/grpc). The error model is designed to be: + # - Simple to use and understand for most users + # - Flexible enough to meet unexpected needs + # # Overview + # The `Status` message contains three pieces of data: error code, error message, + # and error details. The error code should be an enum value of + # google.rpc.Code, but it may accept additional error codes if needed. The + # error message should be a developer-facing English message that helps + # developers *understand* and *resolve* the error. If a localized user-facing + # error message is needed, put the localized message in the error details or + # localize it in the client. The optional error details may contain arbitrary + # information about the error. There is a predefined set of error detail types + # in the package `google.rpc` that can be used for common error conditions. + # # Language mapping + # The `Status` message is the logical representation of the error model, but it + # is not necessarily the actual wire format. When the `Status` message is + # exposed in different client libraries and different wire protocols, it can be + # mapped differently. For example, it will likely be mapped to some exceptions + # in Java, but more likely mapped to some error codes in C. + # # Other uses + # The error model and the `Status` message can be used in a variety of + # environments, either with or without APIs, to provide a + # consistent developer experience across different environments. + # Example uses of this error model include: + # - Partial errors. If a service needs to return partial errors to the client, + # it may embed the `Status` in the normal response to indicate the partial + # errors. + # - Workflow errors. A typical workflow has multiple steps. Each step may + # have a `Status` message for error reporting. + # - Batch operations. If a client uses batch request and batch response, the + # `Status` message should be used directly inside batch response, one for + # each error sub-response. + # - Asynchronous operations. If an API call embeds asynchronous operation + # results in its response, the status of those operations should be + # represented directly using the `Status` message. + # - Logging. If some API errors are stored in logs, the message `Status` could + # be used directly after any stripping needed for security/privacy reasons. + # Corresponds to the JSON property `error` + # @return [Google::Apis::VisionV1::Status] + attr_accessor :error + + # 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. + # Corresponds to the JSON property `fullTextAnnotation` + # @return [Google::Apis::VisionV1::TextAnnotation] + attr_accessor :full_text_annotation + + # If present, landmark detection has completed successfully. + # Corresponds to the JSON property `landmarkAnnotations` + # @return [Array<Google::Apis::VisionV1::EntityAnnotation>] + attr_accessor :landmark_annotations + + # If present, text (OCR) detection has completed successfully. + # Corresponds to the JSON property `textAnnotations` + # @return [Array<Google::Apis::VisionV1::EntityAnnotation>] + attr_accessor :text_annotations + + # If present, face detection has completed successfully. + # Corresponds to the JSON property `faceAnnotations` + # @return [Array<Google::Apis::VisionV1::FaceAnnotation>] + attr_accessor :face_annotations + + # Stores image properties, such as dominant colors. + # Corresponds to the JSON property `imagePropertiesAnnotation` + # @return [Google::Apis::VisionV1::ImageProperties] + attr_accessor :image_properties_annotation + + # If present, logo detection has completed successfully. + # Corresponds to the JSON property `logoAnnotations` + # @return [Array<Google::Apis::VisionV1::EntityAnnotation>] + attr_accessor :logo_annotations + + # Set of crop hints that are used to generate new crops when serving images. + # Corresponds to the JSON property `cropHintsAnnotation` + # @return [Google::Apis::VisionV1::CropHintsAnnotation] + attr_accessor :crop_hints_annotation + + # Relevant information for the image from the Internet. + # Corresponds to the JSON property `webDetection` + # @return [Google::Apis::VisionV1::WebDetection] + attr_accessor :web_detection + + # If present, label detection has completed successfully. + # Corresponds to the JSON property `labelAnnotations` + # @return [Array<Google::Apis::VisionV1::EntityAnnotation>] + attr_accessor :label_annotations + + # Set of features pertaining to the image, computed by computer vision + # methods over safe-search verticals (for example, adult, spoof, medical, + # violence). + # Corresponds to the JSON property `safeSearchAnnotation` + # @return [Google::Apis::VisionV1::SafeSearchAnnotation] + attr_accessor :safe_search_annotation + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @error = args[:error] if args.key?(:error) + @full_text_annotation = args[:full_text_annotation] if args.key?(:full_text_annotation) + @landmark_annotations = args[:landmark_annotations] if args.key?(:landmark_annotations) + @text_annotations = args[:text_annotations] if args.key?(:text_annotations) + @face_annotations = args[:face_annotations] if args.key?(:face_annotations) + @image_properties_annotation = args[:image_properties_annotation] if args.key?(:image_properties_annotation) + @logo_annotations = args[:logo_annotations] if args.key?(:logo_annotations) + @crop_hints_annotation = args[:crop_hints_annotation] if args.key?(:crop_hints_annotation) + @web_detection = args[:web_detection] if args.key?(:web_detection) + @label_annotations = args[:label_annotations] if args.key?(:label_annotations) + @safe_search_annotation = args[:safe_search_annotation] if args.key?(:safe_search_annotation) + end + end + + # Parameters for crop hints annotation request. + class CropHintsParams + include Google::Apis::Core::Hashable + + # Aspect ratios in floats, representing the ratio of the width to the height + # of the image. For example, if the desired aspect ratio is 4/3, the + # corresponding float value should be 1.33333. If not specified, the + # best possible crop is returned. The number of provided aspect ratios is + # limited to a maximum of 16; any aspect ratios provided after the 16th are + # ignored. + # Corresponds to the JSON property `aspectRatios` + # @return [Array<Float>] + attr_accessor :aspect_ratios + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @aspect_ratios = args[:aspect_ratios] if args.key?(:aspect_ratios) + end + end + + # Logical element on the page. + class Block + include Google::Apis::Core::Hashable + + # Additional information detected on the structural component. + # Corresponds to the JSON property `property` + # @return [Google::Apis::VisionV1::TextProperty] + attr_accessor :property + + # Detected block type (text, image etc) for this block. + # Corresponds to the JSON property `blockType` + # @return [String] + attr_accessor :block_type + + # A bounding polygon for the detected image annotation. + # Corresponds to the JSON property `boundingBox` + # @return [Google::Apis::VisionV1::BoundingPoly] + attr_accessor :bounding_box + + # List of paragraphs in this block (if this blocks is of type text). + # Corresponds to the JSON property `paragraphs` + # @return [Array<Google::Apis::VisionV1::Paragraph>] + attr_accessor :paragraphs + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @property = args[:property] if args.key?(:property) + @block_type = args[:block_type] if args.key?(:block_type) + @bounding_box = args[:bounding_box] if args.key?(:bounding_box) + @paragraphs = args[:paragraphs] if args.key?(:paragraphs) + end + end + + # A `Property` consists of a user-supplied name/value pair. + class Property + include Google::Apis::Core::Hashable + + # Value of the property. + # Corresponds to the JSON property `value` + # @return [String] + attr_accessor :value + + # Value of numeric properties. + # Corresponds to the JSON property `uint64Value` + # @return [Fixnum] + attr_accessor :uint64_value + + # Name of the property. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @value = args[:value] if args.key?(:value) + @uint64_value = args[:uint64_value] if args.key?(:uint64_value) + @name = args[:name] if args.key?(:name) + end + end + # Detected entity location information. class LocationInfo include Google::Apis::Core::Hashable # An object representing a latitude/longitude pair. This is expressed as a pair @@ -177,41 +469,114 @@ def update!(**args) @lat_lng = args[:lat_lng] if args.key?(:lat_lng) end end - # A `Property` consists of a user-supplied name/value pair. - class Property + # External image source (Google Cloud Storage image location). + class ImageSource include Google::Apis::Core::Hashable - # Value of the property. - # Corresponds to the JSON property `value` + # NOTE: For new code `image_uri` below is preferred. + # Google Cloud Storage image URI, which must be in the following form: + # `gs://bucket_name/object_name` (for details, see + # [Google Cloud Storage Request + # URIs](https://cloud.google.com/storage/docs/reference-uris)). + # NOTE: Cloud Storage object versioning is not supported. + # Corresponds to the JSON property `gcsImageUri` # @return [String] - attr_accessor :value + attr_accessor :gcs_image_uri - # Value of numeric properties. - # Corresponds to the JSON property `uint64Value` - # @return [Fixnum] - attr_accessor :uint64_value - - # Name of the property. - # Corresponds to the JSON property `name` + # Image URI which supports: + # 1) Google Cloud Storage image URI, which must be in the following form: + # `gs://bucket_name/object_name` (for details, see + # [Google Cloud Storage Request + # URIs](https://cloud.google.com/storage/docs/reference-uris)). + # NOTE: Cloud Storage object versioning is not supported. + # 2) Publicly accessible image HTTP/HTTPS URL. + # This is preferred over the legacy `gcs_image_uri` above. When both + # `gcs_image_uri` and `image_uri` are specified, `image_uri` takes + # precedence. + # Corresponds to the JSON property `imageUri` # @return [String] - attr_accessor :name + attr_accessor :image_uri def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) - @value = args[:value] if args.key?(:value) - @uint64_value = args[:uint64_value] if args.key?(:uint64_value) - @name = args[:name] if args.key?(:name) + @gcs_image_uri = args[:gcs_image_uri] if args.key?(:gcs_image_uri) + @image_uri = args[:image_uri] if args.key?(:image_uri) end end + # Response to a batch image annotation request. + class BatchAnnotateImagesResponse + include Google::Apis::Core::Hashable + + # Individual responses to image annotation requests within the batch. + # Corresponds to the JSON property `responses` + # @return [Array<Google::Apis::VisionV1::AnnotateImageResponse>] + attr_accessor :responses + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @responses = args[:responses] if args.key?(:responses) + end + end + + # Relevant information for the image from the Internet. + class WebDetection + include Google::Apis::Core::Hashable + + # Fully matching images from the Internet. + # Can include resized copies of the query image. + # Corresponds to the JSON property `fullMatchingImages` + # @return [Array<Google::Apis::VisionV1::WebImage>] + attr_accessor :full_matching_images + + # Deduced entities from similar images on the Internet. + # Corresponds to the JSON property `webEntities` + # @return [Array<Google::Apis::VisionV1::WebEntity>] + attr_accessor :web_entities + + # Web pages containing the matching images from the Internet. + # Corresponds to the JSON property `pagesWithMatchingImages` + # @return [Array<Google::Apis::VisionV1::WebPage>] + attr_accessor :pages_with_matching_images + + # 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. + # Corresponds to the JSON property `partialMatchingImages` + # @return [Array<Google::Apis::VisionV1::WebImage>] + attr_accessor :partial_matching_images + + # The visually similar image results. + # Corresponds to the JSON property `visuallySimilarImages` + # @return [Array<Google::Apis::VisionV1::WebImage>] + attr_accessor :visually_similar_images + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @full_matching_images = args[:full_matching_images] if args.key?(:full_matching_images) + @web_entities = args[:web_entities] if args.key?(:web_entities) + @pages_with_matching_images = args[:pages_with_matching_images] if args.key?(:pages_with_matching_images) + @partial_matching_images = args[:partial_matching_images] if args.key?(:partial_matching_images) + @visually_similar_images = args[:visually_similar_images] if args.key?(:visually_similar_images) + end + end + # A 3D position in the image, used primarily for Face detection landmarks. # A valid Position must have both x and y coordinates. # The position coordinates are in the same scale as the original image. class Position include Google::Apis::Core::Hashable @@ -272,10 +637,15 @@ # Color information consists of RGB channels, score, and the fraction of # the image that the color occupies in the image. class ColorInfo include Google::Apis::Core::Hashable + # Image-specific score for this color. Value in range [0, 1]. + # Corresponds to the JSON property `score` + # @return [Float] + attr_accessor :score + # The fraction of pixels the color occupies in the image. # Value in range [0, 1]. # Corresponds to the JSON property `pixelFraction` # @return [Float] attr_accessor :pixel_fraction @@ -381,51 +751,26 @@ # // ... # Corresponds to the JSON property `color` # @return [Google::Apis::VisionV1::Color] attr_accessor :color - # Image-specific score for this color. Value in range [0, 1]. - # Corresponds to the JSON property `score` - # @return [Float] - attr_accessor :score - def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) + @score = args[:score] if args.key?(:score) @pixel_fraction = args[:pixel_fraction] if args.key?(:pixel_fraction) @color = args[:color] if args.key?(:color) - @score = args[:score] if args.key?(:score) end end # Set of detected entity features. class EntityAnnotation include Google::Apis::Core::Hashable - # Some entities may have optional user-supplied `Property` (name/value) - # fields, such a score or string that qualifies the entity. - # Corresponds to the JSON property `properties` - # @return [Array<Google::Apis::VisionV1::Property>] - attr_accessor :properties - - # Overall score of the result. Range [0, 1]. - # Corresponds to the JSON property `score` - # @return [Float] - attr_accessor :score - - # The location information for the detected entity. Multiple - # `LocationInfo` elements can be present because one location may - # indicate the location of the scene in the image, and another location - # may indicate the location of the place where the image was taken. - # Location information is usually present for landmarks. - # Corresponds to the JSON property `locations` - # @return [Array<Google::Apis::VisionV1::LocationInfo>] - attr_accessor :locations - # Opaque entity ID. Some IDs may be available in # [Google Knowledge Graph Search API](https://developers.google.com/knowledge- # graph/). # Corresponds to the JSON property `mid` # @return [String] @@ -448,39 +793,59 @@ # A bounding polygon for the detected image annotation. # Corresponds to the JSON property `boundingPoly` # @return [Google::Apis::VisionV1::BoundingPoly] attr_accessor :bounding_poly + # Entity textual description, expressed in its `locale` language. + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description + # The relevancy of the ICA (Image Content Annotation) label to the # image. For example, the relevancy of "tower" is likely higher to an image # containing the detected "Eiffel Tower" than to an image containing a # detected distant towering building, even though the confidence that # there is a tower in each image may be the same. Range [0, 1]. # Corresponds to the JSON property `topicality` # @return [Float] attr_accessor :topicality - # Entity textual description, expressed in its `locale` language. - # Corresponds to the JSON property `description` - # @return [String] - attr_accessor :description + # Some entities may have optional user-supplied `Property` (name/value) + # fields, such a score or string that qualifies the entity. + # Corresponds to the JSON property `properties` + # @return [Array<Google::Apis::VisionV1::Property>] + attr_accessor :properties + # Overall score of the result. Range [0, 1]. + # Corresponds to the JSON property `score` + # @return [Float] + attr_accessor :score + + # The location information for the detected entity. Multiple + # `LocationInfo` elements can be present because one location may + # indicate the location of the scene in the image, and another location + # may indicate the location of the place where the image was taken. + # Location information is usually present for landmarks. + # Corresponds to the JSON property `locations` + # @return [Array<Google::Apis::VisionV1::LocationInfo>] + attr_accessor :locations + def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) - @properties = args[:properties] if args.key?(:properties) - @score = args[:score] if args.key?(:score) - @locations = args[:locations] if args.key?(:locations) @mid = args[:mid] if args.key?(:mid) @confidence = args[:confidence] if args.key?(:confidence) @locale = args[:locale] if args.key?(:locale) @bounding_poly = args[:bounding_poly] if args.key?(:bounding_poly) - @topicality = args[:topicality] if args.key?(:topicality) @description = args[:description] if args.key?(:description) + @topicality = args[:topicality] if args.key?(:topicality) + @properties = args[:properties] if args.key?(:properties) + @score = args[:score] if args.key?(:score) + @locations = args[:locations] if args.key?(:locations) end end # Single crop hint that is used to generate a new crop when serving an image. class CropHint @@ -520,30 +885,30 @@ # Therefore it is NOT guaranteed that `0 <= x < width` or # `0 <= y < height`. class Landmark include Google::Apis::Core::Hashable + # Face landmark type. + # Corresponds to the JSON property `type` + # @return [String] + attr_accessor :type + # A 3D position in the image, used primarily for Face detection landmarks. # A valid Position must have both x and y coordinates. # The position coordinates are in the same scale as the original image. # Corresponds to the JSON property `position` # @return [Google::Apis::VisionV1::Position] attr_accessor :position - # Face landmark type. - # Corresponds to the JSON property `type` - # @return [String] - attr_accessor :type - def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) - @position = args[:position] if args.key?(:position) @type = args[:type] if args.key?(:type) + @position = args[:position] if args.key?(:position) end end # Metadata for online images. class WebImage @@ -573,15 +938,10 @@ # A word representation. class Word include Google::Apis::Core::Hashable - # Additional information detected on the structural component. - # Corresponds to the JSON property `property` - # @return [Google::Apis::VisionV1::TextProperty] - attr_accessor :property - # A bounding polygon for the detected image annotation. # Corresponds to the JSON property `boundingBox` # @return [Google::Apis::VisionV1::BoundingPoly] attr_accessor :bounding_box @@ -589,50 +949,55 @@ # The order of the symbols follows the natural reading order. # Corresponds to the JSON property `symbols` # @return [Array<Google::Apis::VisionV1::Symbol>] attr_accessor :symbols + # Additional information detected on the structural component. + # Corresponds to the JSON property `property` + # @return [Google::Apis::VisionV1::TextProperty] + attr_accessor :property + def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) - @property = args[:property] if args.key?(:property) @bounding_box = args[:bounding_box] if args.key?(:bounding_box) @symbols = args[:symbols] if args.key?(:symbols) + @property = args[:property] if args.key?(:property) end end # Structural unit of text representing a number of words in certain order. class Paragraph include Google::Apis::Core::Hashable + # Additional information detected on the structural component. + # Corresponds to the JSON property `property` + # @return [Google::Apis::VisionV1::TextProperty] + attr_accessor :property + # A bounding polygon for the detected image annotation. # Corresponds to the JSON property `boundingBox` # @return [Google::Apis::VisionV1::BoundingPoly] attr_accessor :bounding_box # List of words in this paragraph. # Corresponds to the JSON property `words` # @return [Array<Google::Apis::VisionV1::Word>] attr_accessor :words - # Additional information detected on the structural component. - # Corresponds to the JSON property `property` - # @return [Google::Apis::VisionV1::TextProperty] - attr_accessor :property - def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) + @property = args[:property] if args.key?(:property) @bounding_box = args[:bounding_box] if args.key?(:bounding_box) @words = args[:words] if args.key?(:words) - @property = args[:property] if args.key?(:property) end end # Client image to perform Google Cloud Vision API tasks over. class Image @@ -664,10 +1029,36 @@ # A face annotation object contains the results of face detection. class FaceAnnotation include Google::Apis::Core::Hashable + # Pitch angle, which indicates the upwards/downwards angle that the face is + # pointing relative to the image's horizontal plane. Range [-180,180]. + # Corresponds to the JSON property `tiltAngle` + # @return [Float] + attr_accessor :tilt_angle + + # A bounding polygon for the detected image annotation. + # Corresponds to the JSON property `fdBoundingPoly` + # @return [Google::Apis::VisionV1::BoundingPoly] + attr_accessor :fd_bounding_poly + + # Surprise likelihood. + # Corresponds to the JSON property `surpriseLikelihood` + # @return [String] + attr_accessor :surprise_likelihood + + # Detected face landmarks. + # Corresponds to the JSON property `landmarks` + # @return [Array<Google::Apis::VisionV1::Landmark>] + attr_accessor :landmarks + + # Anger likelihood. + # Corresponds to the JSON property `angerLikelihood` + # @return [String] + attr_accessor :anger_likelihood + # Joy likelihood. # Corresponds to the JSON property `joyLikelihood` # @return [String] attr_accessor :joy_likelihood @@ -718,57 +1109,31 @@ # Sorrow likelihood. # Corresponds to the JSON property `sorrowLikelihood` # @return [String] attr_accessor :sorrow_likelihood - # Pitch angle, which indicates the upwards/downwards angle that the face is - # pointing relative to the image's horizontal plane. Range [-180,180]. - # Corresponds to the JSON property `tiltAngle` - # @return [Float] - attr_accessor :tilt_angle - - # A bounding polygon for the detected image annotation. - # Corresponds to the JSON property `fdBoundingPoly` - # @return [Google::Apis::VisionV1::BoundingPoly] - attr_accessor :fd_bounding_poly - - # Anger likelihood. - # Corresponds to the JSON property `angerLikelihood` - # @return [String] - attr_accessor :anger_likelihood - - # Detected face landmarks. - # Corresponds to the JSON property `landmarks` - # @return [Array<Google::Apis::VisionV1::Landmark>] - attr_accessor :landmarks - - # Surprise likelihood. - # Corresponds to the JSON property `surpriseLikelihood` - # @return [String] - attr_accessor :surprise_likelihood - def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) + @tilt_angle = args[:tilt_angle] if args.key?(:tilt_angle) + @fd_bounding_poly = args[:fd_bounding_poly] if args.key?(:fd_bounding_poly) + @surprise_likelihood = args[:surprise_likelihood] if args.key?(:surprise_likelihood) + @landmarks = args[:landmarks] if args.key?(:landmarks) + @anger_likelihood = args[:anger_likelihood] if args.key?(:anger_likelihood) @joy_likelihood = args[:joy_likelihood] if args.key?(:joy_likelihood) @landmarking_confidence = args[:landmarking_confidence] if args.key?(:landmarking_confidence) @detection_confidence = args[:detection_confidence] if args.key?(:detection_confidence) @pan_angle = args[:pan_angle] if args.key?(:pan_angle) @under_exposed_likelihood = args[:under_exposed_likelihood] if args.key?(:under_exposed_likelihood) @blurred_likelihood = args[:blurred_likelihood] if args.key?(:blurred_likelihood) @headwear_likelihood = args[:headwear_likelihood] if args.key?(:headwear_likelihood) @bounding_poly = args[:bounding_poly] if args.key?(:bounding_poly) @roll_angle = args[:roll_angle] if args.key?(:roll_angle) @sorrow_likelihood = args[:sorrow_likelihood] if args.key?(:sorrow_likelihood) - @tilt_angle = args[:tilt_angle] if args.key?(:tilt_angle) - @fd_bounding_poly = args[:fd_bounding_poly] if args.key?(:fd_bounding_poly) - @anger_likelihood = args[:anger_likelihood] if args.key?(:anger_likelihood) - @landmarks = args[:landmarks] if args.key?(:landmarks) - @surprise_likelihood = args[:surprise_likelihood] if args.key?(:surprise_likelihood) end end # Multiple image annotation requests are batched into a single service call. class BatchAnnotateImagesRequest @@ -817,20 +1182,10 @@ # Image context and/or feature-specific parameters. class ImageContext include Google::Apis::Core::Hashable - # Rectangle determined by min and max `LatLng` pairs. - # Corresponds to the JSON property `latLongRect` - # @return [Google::Apis::VisionV1::LatLongRect] - attr_accessor :lat_long_rect - - # Parameters for crop hints annotation request. - # Corresponds to the JSON property `cropHintsParams` - # @return [Google::Apis::VisionV1::CropHintsParams] - attr_accessor :crop_hints_params - # List of languages to use for TEXT_DETECTION. In most cases, an empty value # yields the best results since it enables automatic language detection. For # languages based on the Latin alphabet, setting `language_hints` is not # needed. In rare cases, when the language of the text in the image is known, # setting a hint will help get better results (although it will be a @@ -839,26 +1194,41 @@ # [supported languages](/vision/docs/languages). # Corresponds to the JSON property `languageHints` # @return [Array<String>] attr_accessor :language_hints + # Rectangle determined by min and max `LatLng` pairs. + # Corresponds to the JSON property `latLongRect` + # @return [Google::Apis::VisionV1::LatLongRect] + attr_accessor :lat_long_rect + + # Parameters for crop hints annotation request. + # Corresponds to the JSON property `cropHintsParams` + # @return [Google::Apis::VisionV1::CropHintsParams] + attr_accessor :crop_hints_params + def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) + @language_hints = args[:language_hints] if args.key?(:language_hints) @lat_long_rect = args[:lat_long_rect] if args.key?(:lat_long_rect) @crop_hints_params = args[:crop_hints_params] if args.key?(:crop_hints_params) - @language_hints = args[:language_hints] if args.key?(:language_hints) end end # Detected page from OCR. class Page include Google::Apis::Core::Hashable + # Page height in pixels. + # Corresponds to the JSON property `height` + # @return [Fixnum] + attr_accessor :height + # Page width in pixels. # Corresponds to the JSON property `width` # @return [Fixnum] attr_accessor :width @@ -870,57 +1240,52 @@ # Additional information detected on the structural component. # Corresponds to the JSON property `property` # @return [Google::Apis::VisionV1::TextProperty] attr_accessor :property - # Page height in pixels. - # Corresponds to the JSON property `height` - # @return [Fixnum] - attr_accessor :height - def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) + @height = args[:height] if args.key?(:height) @width = args[:width] if args.key?(:width) @blocks = args[:blocks] if args.key?(:blocks) @property = args[:property] if args.key?(:property) - @height = args[:height] if args.key?(:height) end end # Request for performing Google Cloud Vision API tasks over a user-provided # image, with user-requested features. class AnnotateImageRequest include Google::Apis::Core::Hashable - # Image context and/or feature-specific parameters. - # Corresponds to the JSON property `imageContext` - # @return [Google::Apis::VisionV1::ImageContext] - attr_accessor :image_context - # Client image to perform Google Cloud Vision API tasks over. # Corresponds to the JSON property `image` # @return [Google::Apis::VisionV1::Image] attr_accessor :image # Requested features. # Corresponds to the JSON property `features` # @return [Array<Google::Apis::VisionV1::Feature>] attr_accessor :features + # Image context and/or feature-specific parameters. + # Corresponds to the JSON property `imageContext` + # @return [Google::Apis::VisionV1::ImageContext] + attr_accessor :image_context + def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) - @image_context = args[:image_context] if args.key?(:image_context) @image = args[:image] if args.key?(:image) @features = args[:features] if args.key?(:features) + @image_context = args[:image_context] if args.key?(:image_context) end end # The `Status` type defines a logical error model that is suitable for different # programming environments, including REST APIs and RPC APIs. It is used by @@ -962,10 +1327,16 @@ # - Logging. If some API errors are stored in logs, the message `Status` could # be used directly after any stripping needed for security/privacy reasons. class Status include Google::Apis::Core::Hashable + # A list of messages that carry the error details. There will be a + # common set of message types for APIs to use. + # Corresponds to the JSON property `details` + # @return [Array<Hash<String,Object>>] + attr_accessor :details + # The status code, which should be an enum value of google.rpc.Code. # Corresponds to the JSON property `code` # @return [Fixnum] attr_accessor :code @@ -974,28 +1345,53 @@ # google.rpc.Status.details field, or localized by the client. # Corresponds to the JSON property `message` # @return [String] attr_accessor :message - # A list of messages that carry the error details. There will be a - # common set of message types for APIs to use. - # Corresponds to the JSON property `details` - # @return [Array<Hash<String,Object>>] - attr_accessor :details - def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) + @details = args[:details] if args.key?(:details) @code = args[:code] if args.key?(:code) @message = args[:message] if args.key?(:message) - @details = args[:details] if args.key?(:details) end end + # A single symbol representation. + class Symbol + include Google::Apis::Core::Hashable + + # The actual UTF-8 representation of the symbol. + # Corresponds to the JSON property `text` + # @return [String] + attr_accessor :text + + # Additional information detected on the structural component. + # Corresponds to the JSON property `property` + # @return [Google::Apis::VisionV1::TextProperty] + attr_accessor :property + + # A bounding polygon for the detected image annotation. + # Corresponds to the JSON property `boundingBox` + # @return [Google::Apis::VisionV1::BoundingPoly] + attr_accessor :bounding_box + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @text = args[:text] if args.key?(:text) + @property = args[:property] if args.key?(:property) + @bounding_box = args[:bounding_box] if args.key?(:bounding_box) + end + end + # Rectangle determined by min and max `LatLng` pairs. class LatLongRect include Google::Apis::Core::Hashable # An object representing a latitude/longitude pair. This is expressed as a pair @@ -1031,13 +1427,13 @@ # assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0) # assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0) # assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0) # assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0) # assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0) - # Corresponds to the JSON property `maxLatLng` + # Corresponds to the JSON property `minLatLng` # @return [Google::Apis::VisionV1::LatLng] - attr_accessor :max_lat_lng + attr_accessor :min_lat_lng # An object representing a latitude/longitude pair. This is expressed as a pair # of doubles representing degrees latitude and degrees longitude. Unless # specified otherwise, this must conform to the # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 @@ -1070,56 +1466,25 @@ # assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0) # assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0) # assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0) # assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0) # assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0) - # Corresponds to the JSON property `minLatLng` + # Corresponds to the JSON property `maxLatLng` # @return [Google::Apis::VisionV1::LatLng] - attr_accessor :min_lat_lng + attr_accessor :max_lat_lng def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) - @max_lat_lng = args[:max_lat_lng] if args.key?(:max_lat_lng) @min_lat_lng = args[:min_lat_lng] if args.key?(:min_lat_lng) + @max_lat_lng = args[:max_lat_lng] if args.key?(:max_lat_lng) end end - # A single symbol representation. - class Symbol - include Google::Apis::Core::Hashable - - # Additional information detected on the structural component. - # Corresponds to the JSON property `property` - # @return [Google::Apis::VisionV1::TextProperty] - attr_accessor :property - - # A bounding polygon for the detected image annotation. - # Corresponds to the JSON property `boundingBox` - # @return [Google::Apis::VisionV1::BoundingPoly] - attr_accessor :bounding_box - - # The actual UTF-8 representation of the symbol. - # Corresponds to the JSON property `text` - # @return [String] - attr_accessor :text - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @property = args[:property] if args.key?(:property) - @bounding_box = args[:bounding_box] if args.key?(:bounding_box) - @text = args[:text] if args.key?(:text) - end - end - # Set of crop hints that are used to generate new crops when serving images. class CropHintsAnnotation include Google::Apis::Core::Hashable # Crop hint results. @@ -1296,15 +1661,10 @@ # `; # // ... class Color include Google::Apis::Core::Hashable - # The amount of red in the color as a value in the interval [0, 1]. - # Corresponds to the JSON property `red` - # @return [Float] - attr_accessor :red - # The amount of green in the color as a value in the interval [0, 1]. # Corresponds to the JSON property `green` # @return [Float] attr_accessor :green @@ -1324,23 +1684,47 @@ # (as if the alpha value had been explicitly given with a value of 1.0). # Corresponds to the JSON property `alpha` # @return [Float] attr_accessor :alpha + # The amount of red in the color as a value in the interval [0, 1]. + # Corresponds to the JSON property `red` + # @return [Float] + attr_accessor :red + def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) - @red = args[:red] if args.key?(:red) @green = args[:green] if args.key?(:green) @blue = args[:blue] if args.key?(:blue) @alpha = args[:alpha] if args.key?(:alpha) + @red = args[:red] if args.key?(:red) end end + # Stores image properties, such as dominant colors. + class ImageProperties + include Google::Apis::Core::Hashable + + # Set of dominant colors and their corresponding scores. + # Corresponds to the JSON property `dominantColors` + # @return [Google::Apis::VisionV1::DominantColorsAnnotation] + attr_accessor :dominant_colors + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @dominant_colors = args[:dominant_colors] if args.key?(:dominant_colors) + end + end + # Users describe the type of Google Cloud Vision API tasks to perform over # images by using *Feature*s. Each Feature indicates a type of image # detection task to perform. Features encode the Cloud Vision API # vertical to operate on and the number of top-scoring results to return. class Feature @@ -1365,35 +1749,21 @@ @type = args[:type] if args.key?(:type) @max_results = args[:max_results] if args.key?(:max_results) end end - # Stores image properties, such as dominant colors. - class ImageProperties - include Google::Apis::Core::Hashable - - # Set of dominant colors and their corresponding scores. - # Corresponds to the JSON property `dominantColors` - # @return [Google::Apis::VisionV1::DominantColorsAnnotation] - attr_accessor :dominant_colors - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @dominant_colors = args[:dominant_colors] if args.key?(:dominant_colors) - end - end - # Set of features pertaining to the image, computed by computer vision # methods over safe-search verticals (for example, adult, spoof, medical, # violence). class SafeSearchAnnotation include Google::Apis::Core::Hashable + # Likelihood that this is a medical image. + # Corresponds to the JSON property `medical` + # @return [String] + attr_accessor :medical + # Violence likelihood. # Corresponds to the JSON property `violence` # @return [String] attr_accessor :violence @@ -1407,389 +1777,19 @@ # funny or offensive. # Corresponds to the JSON property `spoof` # @return [String] attr_accessor :spoof - # Likelihood that this is a medical image. - # Corresponds to the JSON property `medical` - # @return [String] - attr_accessor :medical - def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) + @medical = args[:medical] if args.key?(:medical) @violence = args[:violence] if args.key?(:violence) @adult = args[:adult] if args.key?(:adult) @spoof = args[:spoof] if args.key?(:spoof) - @medical = args[:medical] if args.key?(:medical) - end - end - - # Set of dominant colors and their corresponding scores. - class DominantColorsAnnotation - include Google::Apis::Core::Hashable - - # RGB color values with their score and pixel fraction. - # Corresponds to the JSON property `colors` - # @return [Array<Google::Apis::VisionV1::ColorInfo>] - attr_accessor :colors - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @colors = args[:colors] if args.key?(:colors) - end - end - - # 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. - class TextAnnotation - include Google::Apis::Core::Hashable - - # List of pages detected by OCR. - # Corresponds to the JSON property `pages` - # @return [Array<Google::Apis::VisionV1::Page>] - attr_accessor :pages - - # UTF-8 text detected on the pages. - # Corresponds to the JSON property `text` - # @return [String] - attr_accessor :text - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @pages = args[:pages] if args.key?(:pages) - @text = args[:text] if args.key?(:text) - end - end - - # Detected language for a structural component. - class DetectedLanguage - include Google::Apis::Core::Hashable - - # 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. - # Corresponds to the JSON property `languageCode` - # @return [String] - attr_accessor :language_code - - # Confidence of detected language. Range [0, 1]. - # Corresponds to the JSON property `confidence` - # @return [Float] - attr_accessor :confidence - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @language_code = args[:language_code] if args.key?(:language_code) - @confidence = args[:confidence] if args.key?(:confidence) - end - end - - # A vertex represents a 2D point in the image. - # NOTE: the vertex coordinates are in the same scale as the original image. - class Vertex - include Google::Apis::Core::Hashable - - # Y coordinate. - # Corresponds to the JSON property `y` - # @return [Fixnum] - attr_accessor :y - - # X coordinate. - # Corresponds to the JSON property `x` - # @return [Fixnum] - attr_accessor :x - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @y = args[:y] if args.key?(:y) - @x = args[:x] if args.key?(:x) - end - end - - # Entity deduced from similar images on the Internet. - class WebEntity - include Google::Apis::Core::Hashable - - # Canonical description of the entity, in English. - # Corresponds to the JSON property `description` - # @return [String] - attr_accessor :description - - # Overall relevancy score for the entity. - # Not normalized and not comparable across different image queries. - # Corresponds to the JSON property `score` - # @return [Float] - attr_accessor :score - - # Opaque entity ID. - # Corresponds to the JSON property `entityId` - # @return [String] - attr_accessor :entity_id - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @description = args[:description] if args.key?(:description) - @score = args[:score] if args.key?(:score) - @entity_id = args[:entity_id] if args.key?(:entity_id) - end - end - - # A bounding polygon for the detected image annotation. - class BoundingPoly - include Google::Apis::Core::Hashable - - # The bounding polygon vertices. - # Corresponds to the JSON property `vertices` - # @return [Array<Google::Apis::VisionV1::Vertex>] - attr_accessor :vertices - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @vertices = args[:vertices] if args.key?(:vertices) - end - end - - # Additional information detected on the structural component. - class TextProperty - include Google::Apis::Core::Hashable - - # A list of detected languages together with confidence. - # Corresponds to the JSON property `detectedLanguages` - # @return [Array<Google::Apis::VisionV1::DetectedLanguage>] - attr_accessor :detected_languages - - # Detected start or end of a structural component. - # Corresponds to the JSON property `detectedBreak` - # @return [Google::Apis::VisionV1::DetectedBreak] - attr_accessor :detected_break - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @detected_languages = args[:detected_languages] if args.key?(:detected_languages) - @detected_break = args[:detected_break] if args.key?(:detected_break) - end - end - - # Response to an image annotation request. - class AnnotateImageResponse - include Google::Apis::Core::Hashable - - # If present, text (OCR) detection has completed successfully. - # Corresponds to the JSON property `textAnnotations` - # @return [Array<Google::Apis::VisionV1::EntityAnnotation>] - attr_accessor :text_annotations - - # If present, face detection has completed successfully. - # Corresponds to the JSON property `faceAnnotations` - # @return [Array<Google::Apis::VisionV1::FaceAnnotation>] - attr_accessor :face_annotations - - # Stores image properties, such as dominant colors. - # Corresponds to the JSON property `imagePropertiesAnnotation` - # @return [Google::Apis::VisionV1::ImageProperties] - attr_accessor :image_properties_annotation - - # If present, logo detection has completed successfully. - # Corresponds to the JSON property `logoAnnotations` - # @return [Array<Google::Apis::VisionV1::EntityAnnotation>] - attr_accessor :logo_annotations - - # Relevant information for the image from the Internet. - # Corresponds to the JSON property `webDetection` - # @return [Google::Apis::VisionV1::WebDetection] - attr_accessor :web_detection - - # Set of crop hints that are used to generate new crops when serving images. - # Corresponds to the JSON property `cropHintsAnnotation` - # @return [Google::Apis::VisionV1::CropHintsAnnotation] - attr_accessor :crop_hints_annotation - - # Set of features pertaining to the image, computed by computer vision - # methods over safe-search verticals (for example, adult, spoof, medical, - # violence). - # Corresponds to the JSON property `safeSearchAnnotation` - # @return [Google::Apis::VisionV1::SafeSearchAnnotation] - attr_accessor :safe_search_annotation - - # If present, label detection has completed successfully. - # Corresponds to the JSON property `labelAnnotations` - # @return [Array<Google::Apis::VisionV1::EntityAnnotation>] - attr_accessor :label_annotations - - # The `Status` type defines a logical error model that is suitable for different - # programming environments, including REST APIs and RPC APIs. It is used by - # [gRPC](https://github.com/grpc). The error model is designed to be: - # - Simple to use and understand for most users - # - Flexible enough to meet unexpected needs - # # Overview - # The `Status` message contains three pieces of data: error code, error message, - # and error details. The error code should be an enum value of - # google.rpc.Code, but it may accept additional error codes if needed. The - # error message should be a developer-facing English message that helps - # developers *understand* and *resolve* the error. If a localized user-facing - # error message is needed, put the localized message in the error details or - # localize it in the client. The optional error details may contain arbitrary - # information about the error. There is a predefined set of error detail types - # in the package `google.rpc` that can be used for common error conditions. - # # Language mapping - # The `Status` message is the logical representation of the error model, but it - # is not necessarily the actual wire format. When the `Status` message is - # exposed in different client libraries and different wire protocols, it can be - # mapped differently. For example, it will likely be mapped to some exceptions - # in Java, but more likely mapped to some error codes in C. - # # Other uses - # The error model and the `Status` message can be used in a variety of - # environments, either with or without APIs, to provide a - # consistent developer experience across different environments. - # Example uses of this error model include: - # - Partial errors. If a service needs to return partial errors to the client, - # it may embed the `Status` in the normal response to indicate the partial - # errors. - # - Workflow errors. A typical workflow has multiple steps. Each step may - # have a `Status` message for error reporting. - # - Batch operations. If a client uses batch request and batch response, the - # `Status` message should be used directly inside batch response, one for - # each error sub-response. - # - Asynchronous operations. If an API call embeds asynchronous operation - # results in its response, the status of those operations should be - # represented directly using the `Status` message. - # - Logging. If some API errors are stored in logs, the message `Status` could - # be used directly after any stripping needed for security/privacy reasons. - # Corresponds to the JSON property `error` - # @return [Google::Apis::VisionV1::Status] - attr_accessor :error - - # 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. - # Corresponds to the JSON property `fullTextAnnotation` - # @return [Google::Apis::VisionV1::TextAnnotation] - attr_accessor :full_text_annotation - - # If present, landmark detection has completed successfully. - # Corresponds to the JSON property `landmarkAnnotations` - # @return [Array<Google::Apis::VisionV1::EntityAnnotation>] - attr_accessor :landmark_annotations - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @text_annotations = args[:text_annotations] if args.key?(:text_annotations) - @face_annotations = args[:face_annotations] if args.key?(:face_annotations) - @image_properties_annotation = args[:image_properties_annotation] if args.key?(:image_properties_annotation) - @logo_annotations = args[:logo_annotations] if args.key?(:logo_annotations) - @web_detection = args[:web_detection] if args.key?(:web_detection) - @crop_hints_annotation = args[:crop_hints_annotation] if args.key?(:crop_hints_annotation) - @safe_search_annotation = args[:safe_search_annotation] if args.key?(:safe_search_annotation) - @label_annotations = args[:label_annotations] if args.key?(:label_annotations) - @error = args[:error] if args.key?(:error) - @full_text_annotation = args[:full_text_annotation] if args.key?(:full_text_annotation) - @landmark_annotations = args[:landmark_annotations] if args.key?(:landmark_annotations) - end - end - - # Parameters for crop hints annotation request. - class CropHintsParams - include Google::Apis::Core::Hashable - - # Aspect ratios in floats, representing the ratio of the width to the height - # of the image. For example, if the desired aspect ratio is 4/3, the - # corresponding float value should be 1.33333. If not specified, the - # best possible crop is returned. The number of provided aspect ratios is - # limited to a maximum of 16; any aspect ratios provided after the 16th are - # ignored. - # Corresponds to the JSON property `aspectRatios` - # @return [Array<Float>] - attr_accessor :aspect_ratios - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @aspect_ratios = args[:aspect_ratios] if args.key?(:aspect_ratios) - end - end - - # Logical element on the page. - class Block - include Google::Apis::Core::Hashable - - # Additional information detected on the structural component. - # Corresponds to the JSON property `property` - # @return [Google::Apis::VisionV1::TextProperty] - attr_accessor :property - - # Detected block type (text, image etc) for this block. - # Corresponds to the JSON property `blockType` - # @return [String] - attr_accessor :block_type - - # A bounding polygon for the detected image annotation. - # Corresponds to the JSON property `boundingBox` - # @return [Google::Apis::VisionV1::BoundingPoly] - attr_accessor :bounding_box - - # List of paragraphs in this block (if this blocks is of type text). - # Corresponds to the JSON property `paragraphs` - # @return [Array<Google::Apis::VisionV1::Paragraph>] - attr_accessor :paragraphs - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @property = args[:property] if args.key?(:property) - @block_type = args[:block_type] if args.key?(:block_type) - @bounding_box = args[:bounding_box] if args.key?(:bounding_box) - @paragraphs = args[:paragraphs] if args.key?(:paragraphs) end end end end end