generated/google/apis/vision_v1/classes.rb in google-api-client-0.9.20 vs generated/google/apis/vision_v1/classes.rb in google-api-client-0.9.21
- old
+ new
@@ -24,14 +24,15 @@
# External image source (Google Cloud Storage image location).
class ImageSource
include Google::Apis::Core::Hashable
- # Google Cloud Storage image URI. It must be in the following form:
- # `gs://bucket_name/object_name`. For more
- # details, please see: https://cloud.google.com/storage/docs/reference-uris.
- # NOTE: Cloud Storage object versioning is not supported!
+ # 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 :gcs_image_uri
def initialize(**args)
@@ -78,43 +79,41 @@
# Response to an image annotation request.
class AnnotateImageResponse
include Google::Apis::Core::Hashable
- # If present, label detection completed successfully.
+ # If present, label detection has completed successfully.
# Corresponds to the JSON property `labelAnnotations`
# @return [Array<Google::Apis::VisionV1::EntityAnnotation>]
attr_accessor :label_annotations
- # If present, landmark detection completed successfully.
+ # If present, landmark detection has completed successfully.
# Corresponds to the JSON property `landmarkAnnotations`
# @return [Array<Google::Apis::VisionV1::EntityAnnotation>]
attr_accessor :landmark_annotations
- # Set of features pertaining to the image, computed by various computer vision
- # methods over safe-search verticals (for example, adult, spoof, medical,
- # violence).
+ # If present, safe-search annotation has completed successfully.
# Corresponds to the JSON property `safeSearchAnnotation`
# @return [Google::Apis::VisionV1::SafeSearchAnnotation]
attr_accessor :safe_search_annotation
- # Stores image properties (e.g. dominant colors).
+ # 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, text (OCR) detection completed successfully.
+ # 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, logo detection completed successfully.
+ # If present, logo detection has completed successfully.
# Corresponds to the JSON property `logoAnnotations`
# @return [Array<Google::Apis::VisionV1::EntityAnnotation>]
attr_accessor :logo_annotations
- # If present, face detection completed successfully.
+ # If present, face detection has completed successfully.
# Corresponds to the JSON property `faceAnnotations`
# @return [Array<Google::Apis::VisionV1::FaceAnnotation>]
attr_accessor :face_annotations
# The `Status` type defines a logical error model that is suitable for different
@@ -175,11 +174,11 @@
@face_annotations = args[:face_annotations] if args.key?(:face_annotations)
@error = args[:error] if args.key?(:error)
end
end
- # Rectangle determined by min and max LatLng pairs.
+ # 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
# of doubles representing degrees latitude and degrees longitude. Unless
@@ -214,10 +213,12 @@
# 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)
+ # The code in logs/storage/validator/logs_validator_traits.cc treats this type
+ # as if it were annotated as ST_LOCATION.
# Corresponds to the JSON property `maxLatLng`
# @return [Google::Apis::VisionV1::LatLng]
attr_accessor :max_lat_lng
# An object representing a latitude/longitude pair. This is expressed as a pair
@@ -253,10 +254,12 @@
# 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)
+ # The code in logs/storage/validator/logs_validator_traits.cc treats this type
+ # as if it were annotated as ST_LOCATION.
# Corresponds to the JSON property `minLatLng`
# @return [Google::Apis::VisionV1::LatLng]
attr_accessor :min_lat_lng
def initialize(**args)
@@ -344,13 +347,12 @@
# A face annotation object contains the results of face detection.
class FaceAnnotation
include Google::Apis::Core::Hashable
- # Pitch angle. Indicates the upwards/downwards angle that the face is
- # pointing
- # relative to the image's horizontal plane. Range [-180,180].
+ # 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
# Under-exposed likelihood.
@@ -391,12 +393,12 @@
# Headwear likelihood.
# Corresponds to the JSON property `headwearLikelihood`
# @return [String]
attr_accessor :headwear_likelihood
- # Yaw angle. Indicates the leftward/rightward angle that the face is
- # pointing, relative to the vertical plane perpendicular to the image. Range
+ # Yaw angle, which indicates the leftward/rightward angle that the face is
+ # pointing relative to the vertical plane perpendicular to the image. Range
# [-180,180].
# Corresponds to the JSON property `panAngle`
# @return [Float]
attr_accessor :pan_angle
@@ -413,14 +415,13 @@
# Blurred likelihood.
# Corresponds to the JSON property `blurredLikelihood`
# @return [String]
attr_accessor :blurred_likelihood
- # Roll angle. Indicates the amount of clockwise/anti-clockwise rotation of
- # the
- # face relative to the image vertical, about the axis perpendicular to the
- # face. Range [-180,180].
+ # Roll angle, which indicates the amount of clockwise/anti-clockwise rotation
+ # of the face relative to the image vertical about the axis perpendicular to
+ # the face. Range [-180,180].
# Corresponds to the JSON property `rollAngle`
# @return [Float]
attr_accessor :roll_angle
# Sorrow likelihood.
@@ -476,16 +477,16 @@
@y = args[:y] if args.key?(:y)
@x = args[:x] if args.key?(:x)
end
end
- # Color information consists of RGB channels, score and fraction of
- # image the color occupies in the image.
+ # 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
- # Stores the fraction of pixels the color occupies in the image.
+ # 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
@@ -628,12 +629,13 @@
end
end
# A face-specific landmark (for example, a face feature).
# Landmark positions may fall outside the bounds of the image
- # when the face is near one or more edges of the image.
- # Therefore it is NOT guaranteed that 0 <= x < width or 0 <= y < height.
+ # if the face is near one or more edges of the image.
+ # Therefore it is NOT guaranteed that `0 <= x < width` or
+ # `0 <= y < height`.
class Landmark
include Google::Apis::Core::Hashable
# A 3D position in the image, used primarily for Face detection landmarks.
# A valid Position must have both x and y coordinates.
@@ -660,11 +662,11 @@
# Image context and/or feature-specific parameters.
class ImageContext
include Google::Apis::Core::Hashable
- # Rectangle determined by min and max LatLng pairs.
+ # Rectangle determined by min and max `LatLng` pairs.
# Corresponds to the JSON property `latLongRect`
# @return [Google::Apis::VisionV1::LatLongRect]
attr_accessor :lat_long_rect
# List of languages to use for TEXT_DETECTION. In most cases, an empty value
@@ -672,12 +674,11 @@
# 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
# significant hindrance if the hint is wrong). Text detection returns an
# error if one or more of the specified languages is not one of the
- # [supported
- # languages](/translate/v2/translate-reference#supported_languages).
+ # [supported languages](/vision/docs/languages).
# Corresponds to the JSON property `languageHints`
# @return [Array<String>]
attr_accessor :language_hints
def initialize(**args)
@@ -712,39 +713,39 @@
# Set of detected entity features.
class EntityAnnotation
include Google::Apis::Core::Hashable
- # Opaque entity ID. Some IDs might be available in Knowledge Graph(KG).
- # For more details on KG please see:
- # https://developers.google.com/knowledge-graph/
+ # 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]
attr_accessor :mid
- # Entity textual description, expressed in its <code>locale</code> language.
+ # 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' to an image containing
- # 'Eiffel Tower' is likely higher than an image containing a distant towering
- # building, though the confidence that there is a tower may be the same.
- # Range [0, 1].
+ # 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
# The language code for the locale in which the entity textual
- # <code>description</code> (next field) is expressed.
+ # `description` is expressed.
# Corresponds to the JSON property `locale`
# @return [String]
attr_accessor :locale
- # Some entities can have additional optional <code>Property</code> fields.
- # For example a different kind of score or string that qualifies the entity.
+ # 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].
@@ -756,21 +757,22 @@
# Corresponds to the JSON property `boundingPoly`
# @return [Google::Apis::VisionV1::BoundingPoly]
attr_accessor :bounding_poly
# The location information for the detected entity. Multiple
- # <code>LocationInfo</code> elements can be present since one location may
- # indicate the location of the scene in the query image, and another the
- # location of the place where the query image was taken. Location information
- # is usually present for landmarks.
+ # `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
# The accuracy of the entity detection in an image.
- # For example, for an image containing 'Eiffel Tower,' this field represents
- # the confidence that there is a tower in the query image. Range [0, 1].
+ # For example, for an image in which the "Eiffel Tower" entity is detected,
+ # this field represents the confidence that there is a tower in the query
+ # image. Range [0, 1].
# Corresponds to the JSON property `confidence`
# @return [Float]
attr_accessor :confidence
def initialize(**args)
@@ -789,11 +791,11 @@
@locations = args[:locations] if args.key?(:locations)
@confidence = args[:confidence] if args.key?(:confidence)
end
end
- # Arbitrary name/value pair.
+ # 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`
@@ -996,10 +998,12 @@
# 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)
+ # The code in logs/storage/validator/logs_validator_traits.cc treats this type
+ # as if it were annotated as ST_LOCATION.
# Corresponds to the JSON property `latLng`
# @return [Google::Apis::VisionV1::LatLng]
attr_accessor :lat_lng
def initialize(**args)
@@ -1010,22 +1014,20 @@
def update!(**args)
@lat_lng = args[:lat_lng] if args.key?(:lat_lng)
end
end
- # Set of features pertaining to the image, computed by various computer vision
- # methods over safe-search verticals (for example, adult, spoof, medical,
- # violence).
+ #
class SafeSearchAnnotation
include Google::Apis::Core::Hashable
- # Likelihood this is a medical image.
+ # Likelihood that this is a medical image.
# Corresponds to the JSON property `medical`
# @return [String]
attr_accessor :medical
- # Spoof likelihood. The likelihood that an obvious modification
+ # Spoof likelihood. The likelihood that an modification
# was made to the image's canonical version to make it appear
# funny or offensive.
# Corresponds to the JSON property `spoof`
# @return [String]
attr_accessor :spoof
@@ -1033,11 +1035,11 @@
# Violence likelihood.
# Corresponds to the JSON property `violence`
# @return [String]
attr_accessor :violence
- # Represents the adult contents likelihood for the image.
+ # Represents the adult content likelihood for the image.
# Corresponds to the JSON property `adult`
# @return [String]
attr_accessor :adult
def initialize(**args)
@@ -1082,11 +1084,11 @@
# Set of dominant colors and their corresponding scores.
class DominantColorsAnnotation
include Google::Apis::Core::Hashable
- # RGB color values, with their score and pixel fraction.
+ # 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)
@@ -1097,13 +1099,13 @@
def update!(**args)
@colors = args[:colors] if args.key?(:colors)
end
end
- # The <em>Feature</em> indicates what type of image detection task to perform.
# Users describe the type of Google Cloud Vision API tasks to perform over
- # images by using <em>Feature</em>s. Features encode the Cloud Vision API
+ # 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
include Google::Apis::Core::Hashable
# The feature type.
@@ -1144,11 +1146,11 @@
def update!(**args)
@responses = args[:responses] if args.key?(:responses)
end
end
- # Stores image properties (e.g. dominant colors).
+ # 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`
@@ -1198,9 +1200,11 @@
# 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)
+ # The code in logs/storage/validator/logs_validator_traits.cc treats this type
+ # as if it were annotated as ST_LOCATION.
class LatLng
include Google::Apis::Core::Hashable
# The latitude in degrees. It must be in the range [-90.0, +90.0].
# Corresponds to the JSON property `latitude`