google-api-ruby-client/generated/google/apis/vision_v1/classes.rb

1268 lines
52 KiB
Ruby
Raw Normal View History

2016-02-25 23:16:53 +00:00
# Copyright 2015 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
require 'date'
require 'google/apis/core/base_service'
require 'google/apis/core/json_representation'
require 'google/apis/core/hashable'
require 'google/apis/errors'
module Google
module Apis
module VisionV1
# 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` which 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 purpose.
# - 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.
class Status
2016-02-25 23:16:53 +00:00
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
2016-02-25 23:16:53 +00:00
# The status code, which should be an enum value of google.rpc.Code.
# Corresponds to the JSON property `code`
# @return [Fixnum]
attr_accessor :code
2016-02-25 23:16:53 +00:00
# A developer-facing error message, which should be in English. Any
# user-facing error message should be localized and sent in the
# google.rpc.Status.details field, or localized by the client.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
2016-02-25 23:16:53 +00:00
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)
2016-02-25 23:16:53 +00:00
end
end
2017-01-13 23:04:35 +00:00
# Rectangle determined by min and max `LatLng` pairs.
2016-02-25 23:16:53 +00:00
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
# specified otherwise, this must conform to the
# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84
# standard</a>. Values must be within normalized ranges.
# Example of normalization code in Python:
# def NormalizeLongitude(longitude):
# """Wraps decimal degrees longitude to [-180.0, 180.0]."""
# q, r = divmod(longitude, 360.0)
# if r > 180.0 or (r == 180.0 and q <= -1.0):
# return r - 360.0
# return r
# def NormalizeLatLng(latitude, longitude):
# """Wraps decimal degrees latitude and longitude to
2016-05-25 16:16:15 +00:00
# [-90.0, 90.0] and [-180.0, 180.0], respectively."""
2016-02-25 23:16:53 +00:00
# r = latitude % 360.0
# if r <= 90.0:
# return r, NormalizeLongitude(longitude)
# elif r >= 270.0:
# return r - 360, NormalizeLongitude(longitude)
# else:
# return 180 - r, NormalizeLongitude(longitude + 180.0)
# assert 180.0 == NormalizeLongitude(180.0)
# assert -180.0 == NormalizeLongitude(-180.0)
# assert -179.0 == NormalizeLongitude(181.0)
# assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0)
# assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0)
# assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0)
# assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0)
# assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0)
# 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)
2017-01-13 23:04:35 +00:00
# The code in logs/storage/validator/logs_validator_traits.cc treats this type
# as if it were annotated as ST_LOCATION.
2016-02-25 23:16:53 +00:00
# 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
# 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
# standard</a>. Values must be within normalized ranges.
# Example of normalization code in Python:
# def NormalizeLongitude(longitude):
# """Wraps decimal degrees longitude to [-180.0, 180.0]."""
# q, r = divmod(longitude, 360.0)
# if r > 180.0 or (r == 180.0 and q <= -1.0):
# return r - 360.0
# return r
# def NormalizeLatLng(latitude, longitude):
# """Wraps decimal degrees latitude and longitude to
2016-05-25 16:16:15 +00:00
# [-90.0, 90.0] and [-180.0, 180.0], respectively."""
2016-02-25 23:16:53 +00:00
# r = latitude % 360.0
# if r <= 90.0:
# return r, NormalizeLongitude(longitude)
# elif r >= 270.0:
# return r - 360, NormalizeLongitude(longitude)
# else:
# return 180 - r, NormalizeLongitude(longitude + 180.0)
# assert 180.0 == NormalizeLongitude(180.0)
# assert -180.0 == NormalizeLongitude(-180.0)
# assert -179.0 == NormalizeLongitude(181.0)
# assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0)
# assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0)
# assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0)
# assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0)
# assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0)
# 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)
2017-01-13 23:04:35 +00:00
# The code in logs/storage/validator/logs_validator_traits.cc treats this type
# as if it were annotated as ST_LOCATION.
2016-02-25 23:16:53 +00:00
# Corresponds to the JSON property `minLatLng`
# @return [Google::Apis::VisionV1::LatLng]
attr_accessor :min_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)
end
end
# 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
# standard</a>. Values must be within normalized ranges.
# Example of normalization code in Python:
# def NormalizeLongitude(longitude):
# """Wraps decimal degrees longitude to [-180.0, 180.0]."""
# q, r = divmod(longitude, 360.0)
# if r > 180.0 or (r == 180.0 and q <= -1.0):
# return r - 360.0
# return r
# def NormalizeLatLng(latitude, longitude):
# """Wraps decimal degrees latitude and longitude to
# [-90.0, 90.0] and [-180.0, 180.0], respectively."""
# r = latitude % 360.0
# if r <= 90.0:
# return r, NormalizeLongitude(longitude)
# elif r >= 270.0:
# return r - 360, NormalizeLongitude(longitude)
# else:
# return 180 - r, NormalizeLongitude(longitude + 180.0)
# assert 180.0 == NormalizeLongitude(180.0)
# assert -180.0 == NormalizeLongitude(-180.0)
# assert -179.0 == NormalizeLongitude(181.0)
# assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0)
# assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0)
# assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0)
# assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0)
# assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0)
# 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`
# @return [Float]
attr_accessor :latitude
# The longitude in degrees. It must be in the range [-180.0, +180.0].
# Corresponds to the JSON property `longitude`
# @return [Float]
attr_accessor :longitude
def initialize(**args)
2016-02-25 23:16:53 +00:00
update!(**args)
end
# Update properties of this object
def update!(**args)
@latitude = args[:latitude] if args.key?(:latitude)
@longitude = args[:longitude] if args.key?(:longitude)
2016-02-25 23:16:53 +00:00
end
end
# Represents a color in the RGBA color space. This representation is designed
# for simplicity of conversion to/from color representations in various
# languages over compactness; for example, the fields of this representation
# can be trivially provided to the constructor of "java.awt.Color" in Java; it
# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
# method in iOS; and, with just a little work, it can be easily formatted into
# a CSS "rgba()" string in JavaScript, as well. Here are some examples:
# Example (Java):
# import com.google.type.Color;
# // ...
# public static java.awt.Color fromProto(Color protocolor) `
# float alpha = protocolor.hasAlpha()
# ? protocolor.getAlpha().getValue()
# : 1.0;
# return new java.awt.Color(
# protocolor.getRed(),
# protocolor.getGreen(),
# protocolor.getBlue(),
# alpha);
# `
# public static Color toProto(java.awt.Color color) `
# float red = (float) color.getRed();
# float green = (float) color.getGreen();
# float blue = (float) color.getBlue();
# float denominator = 255.0;
# Color.Builder resultBuilder =
# Color
# .newBuilder()
# .setRed(red / denominator)
# .setGreen(green / denominator)
# .setBlue(blue / denominator);
# int alpha = color.getAlpha();
# if (alpha != 255) `
# result.setAlpha(
# FloatValue
# .newBuilder()
# .setValue(((float) alpha) / denominator)
# .build());
# `
# return resultBuilder.build();
# `
# // ...
# Example (iOS / Obj-C):
# // ...
# static UIColor* fromProto(Color* protocolor) `
# float red = [protocolor red];
# float green = [protocolor green];
# float blue = [protocolor blue];
# FloatValue* alpha_wrapper = [protocolor alpha];
# float alpha = 1.0;
# if (alpha_wrapper != nil) `
# alpha = [alpha_wrapper value];
# `
# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
# `
# static Color* toProto(UIColor* color) `
# CGFloat red, green, blue, alpha;
# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) `
# return nil;
# `
# Color* result = [Color alloc] init];
# [result setRed:red];
# [result setGreen:green];
# [result setBlue:blue];
# if (alpha <= 0.9999) `
# [result setAlpha:floatWrapperWithValue(alpha)];
# `
# [result autorelease];
# return result;
# `
# // ...
# Example (JavaScript):
# // ...
# var protoToCssColor = function(rgb_color) `
# var redFrac = rgb_color.red || 0.0;
# var greenFrac = rgb_color.green || 0.0;
# var blueFrac = rgb_color.blue || 0.0;
# var red = Math.floor(redFrac * 255);
# var green = Math.floor(greenFrac * 255);
# var blue = Math.floor(blueFrac * 255);
# if (!('alpha' in rgb_color)) `
# return rgbToCssColor_(red, green, blue);
# `
# var alphaFrac = rgb_color.alpha.value || 0.0;
# var rgbParams = [red, green, blue].join(',');
# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
# `;
# var rgbToCssColor_ = function(red, green, blue) `
# var rgbNumber = new Number((red << 16) | (green << 8) | blue);
# var hexString = rgbNumber.toString(16);
# var missingZeros = 6 - hexString.length;
# var resultBuilder = ['#'];
# for (var i = 0; i < missingZeros; i++) `
# resultBuilder.push('0');
# `
# resultBuilder.push(hexString);
# return resultBuilder.join('');
# `;
# // ...
class Color
2016-02-25 23:16:53 +00:00
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`
2016-02-25 23:16:53 +00:00
# @return [Float]
attr_accessor :red
2016-02-25 23:16:53 +00:00
# The amount of green in the color as a value in the interval [0, 1].
# Corresponds to the JSON property `green`
2016-02-25 23:16:53 +00:00
# @return [Float]
attr_accessor :green
2016-02-25 23:16:53 +00:00
# The amount of blue in the color as a value in the interval [0, 1].
# Corresponds to the JSON property `blue`
2016-02-25 23:16:53 +00:00
# @return [Float]
attr_accessor :blue
2016-02-25 23:16:53 +00:00
# The fraction of this color that should be applied to the pixel. That is,
# the final pixel color is defined by the equation:
# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
# This means that a value of 1.0 corresponds to a solid color, whereas
# a value of 0.0 corresponds to a completely transparent color. This
# uses a wrapper message rather than a simple float scalar so that it is
# possible to distinguish between a default value and the value being unset.
# If omitted, this color object is to be rendered as a solid color
# (as if the alpha value had been explicitly given with a value of 1.0).
# Corresponds to the JSON property `alpha`
2016-02-25 23:16:53 +00:00
# @return [Float]
attr_accessor :alpha
2016-05-25 16:16:15 +00:00
def initialize(**args)
update!(**args)
end
2016-02-25 23:16:53 +00:00
# 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)
end
end
2016-02-25 23:16:53 +00:00
# Stores image properties, such as dominant colors.
class ImageProperties
include Google::Apis::Core::Hashable
2016-02-25 23:16:53 +00:00
# Set of dominant colors and their corresponding scores.
# Corresponds to the JSON property `dominantColors`
# @return [Google::Apis::VisionV1::DominantColorsAnnotation]
attr_accessor :dominant_colors
2016-02-25 23:16:53 +00:00
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@dominant_colors = args[:dominant_colors] if args.key?(:dominant_colors)
2016-02-25 23:16:53 +00:00
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
2016-02-25 23:16:53 +00:00
include Google::Apis::Core::Hashable
# The feature type.
# Corresponds to the JSON property `type`
# @return [String]
attr_accessor :type
2016-02-25 23:16:53 +00:00
# Maximum number of results of this type.
# Corresponds to the JSON property `maxResults`
2016-02-25 23:16:53 +00:00
# @return [Fixnum]
attr_accessor :max_results
2016-02-25 23:16:53 +00:00
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@type = args[:type] if args.key?(:type)
@max_results = args[:max_results] if args.key?(:max_results)
2016-02-25 23:16:53 +00:00
end
end
#
class SafeSearchAnnotation
2016-02-25 23:16:53 +00:00
include Google::Apis::Core::Hashable
# 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
2016-02-25 23:16:53 +00:00
# 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
2016-02-25 23:16:53 +00:00
# Represents the adult content likelihood for the image.
# Corresponds to the JSON property `adult`
# @return [String]
attr_accessor :adult
2016-02-25 23:16:53 +00:00
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@spoof = args[:spoof] if args.key?(:spoof)
@medical = args[:medical] if args.key?(:medical)
@violence = args[:violence] if args.key?(:violence)
@adult = args[:adult] if args.key?(:adult)
2016-02-25 23:16:53 +00:00
end
end
# Set of dominant colors and their corresponding scores.
class DominantColorsAnnotation
2016-02-25 23:16:53 +00:00
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
2016-02-25 23:16:53 +00:00
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@colors = args[:colors] if args.key?(:colors)
2016-02-25 23:16:53 +00:00
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
2016-02-25 23:16:53 +00:00
include Google::Apis::Core::Hashable
# Y coordinate.
# Corresponds to the JSON property `y`
# @return [Fixnum]
attr_accessor :y
2016-02-25 23:16:53 +00:00
# X coordinate.
# Corresponds to the JSON property `x`
# @return [Fixnum]
attr_accessor :x
2016-02-25 23:16:53 +00:00
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)
2016-02-25 23:16:53 +00:00
end
end
# A bounding polygon for the detected image annotation.
class BoundingPoly
2016-02-25 23:16:53 +00:00
include Google::Apis::Core::Hashable
# The bounding polygon vertices.
# Corresponds to the JSON property `vertices`
# @return [Array<Google::Apis::VisionV1::Vertex>]
attr_accessor :vertices
2016-02-25 23:16:53 +00:00
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@vertices = args[:vertices] if args.key?(:vertices)
2016-02-25 23:16:53 +00:00
end
end
# Response to an image annotation request.
class AnnotateImageResponse
2016-02-25 23:16:53 +00:00
include Google::Apis::Core::Hashable
# 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, label detection has completed successfully.
# Corresponds to the JSON property `labelAnnotations`
# @return [Array<Google::Apis::VisionV1::EntityAnnotation>]
attr_accessor :label_annotations
# If present, safe-search annotation has completed successfully.
# Corresponds to the JSON property `safeSearchAnnotation`
# @return [Google::Apis::VisionV1::SafeSearchAnnotation]
attr_accessor :safe_search_annotation
# 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` which 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 purpose.
# - 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
# 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 or document (OCR) text detection has
# completed successfully.
# Corresponds to the JSON property `textAnnotations`
# @return [Array<Google::Apis::VisionV1::EntityAnnotation>]
attr_accessor :text_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, face detection has completed successfully.
# Corresponds to the JSON property `faceAnnotations`
# @return [Array<Google::Apis::VisionV1::FaceAnnotation>]
attr_accessor :face_annotations
2016-02-25 23:16:53 +00:00
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@logo_annotations = args[:logo_annotations] if args.key?(:logo_annotations)
@label_annotations = args[:label_annotations] if args.key?(:label_annotations)
@safe_search_annotation = args[:safe_search_annotation] if args.key?(:safe_search_annotation)
@error = args[:error] if args.key?(:error)
@landmark_annotations = args[:landmark_annotations] if args.key?(:landmark_annotations)
@text_annotations = args[:text_annotations] if args.key?(:text_annotations)
@image_properties_annotation = args[:image_properties_annotation] if args.key?(:image_properties_annotation)
@face_annotations = args[:face_annotations] if args.key?(:face_annotations)
2016-02-25 23:16:53 +00:00
end
end
# A `Property` consists of a user-supplied name/value pair.
class Property
2016-02-25 23:16:53 +00:00
include Google::Apis::Core::Hashable
# Value of the property.
# Corresponds to the JSON property `value`
2016-02-25 23:16:53 +00:00
# @return [String]
attr_accessor :value
2016-02-25 23:16:53 +00:00
# Name of the property.
# Corresponds to the JSON property `name`
2016-02-25 23:16:53 +00:00
# @return [String]
attr_accessor :name
2016-02-25 23:16:53 +00:00
def initialize(**args)
update!(**args)
end
2016-02-25 23:16:53 +00:00
# Update properties of this object
def update!(**args)
@value = args[:value] if args.key?(:value)
@name = args[:name] if args.key?(:name)
end
end
2016-02-25 23:16:53 +00:00
# Detected entity location information.
class LocationInfo
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
# specified otherwise, this must conform to the
# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84
# standard</a>. Values must be within normalized ranges.
# Example of normalization code in Python:
# def NormalizeLongitude(longitude):
# """Wraps decimal degrees longitude to [-180.0, 180.0]."""
# q, r = divmod(longitude, 360.0)
# if r > 180.0 or (r == 180.0 and q <= -1.0):
# return r - 360.0
# return r
# def NormalizeLatLng(latitude, longitude):
# """Wraps decimal degrees latitude and longitude to
# [-90.0, 90.0] and [-180.0, 180.0], respectively."""
# r = latitude % 360.0
# if r <= 90.0:
# return r, NormalizeLongitude(longitude)
# elif r >= 270.0:
# return r - 360, NormalizeLongitude(longitude)
# else:
# return 180 - r, NormalizeLongitude(longitude + 180.0)
# assert 180.0 == NormalizeLongitude(180.0)
# assert -180.0 == NormalizeLongitude(-180.0)
# assert -179.0 == NormalizeLongitude(181.0)
# assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0)
# assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0)
# assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0)
# assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0)
# assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0)
# 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
2016-02-25 23:16:53 +00:00
def initialize(**args)
update!(**args)
end
2016-02-25 23:16:53 +00:00
# Update properties of this object
def update!(**args)
@lat_lng = args[:lat_lng] if args.key?(:lat_lng)
end
end
2016-02-25 23:16:53 +00:00
# Response to a batch image annotation request.
class BatchAnnotateImagesResponse
include Google::Apis::Core::Hashable
2016-02-25 23:16:53 +00:00
# Individual responses to image annotation requests within the batch.
# Corresponds to the JSON property `responses`
# @return [Array<Google::Apis::VisionV1::AnnotateImageResponse>]
attr_accessor :responses
2016-02-25 23:16:53 +00:00
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@responses = args[:responses] if args.key?(:responses)
2016-02-25 23:16:53 +00:00
end
end
# External image source (Google Cloud Storage image location).
class ImageSource
2016-02-25 23:16:53 +00:00
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`
2016-02-25 23:16:53 +00:00
# @return [String]
attr_accessor :gcs_image_uri
2016-02-25 23:16:53 +00:00
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)
2016-02-25 23:16:53 +00:00
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
2016-02-25 23:16:53 +00:00
include Google::Apis::Core::Hashable
# Y coordinate.
# Corresponds to the JSON property `y`
2016-02-25 23:16:53 +00:00
# @return [Float]
attr_accessor :y
2016-02-25 23:16:53 +00:00
# X coordinate.
# Corresponds to the JSON property `x`
2016-02-25 23:16:53 +00:00
# @return [Float]
attr_accessor :x
2016-02-25 23:16:53 +00:00
# Z coordinate (or depth).
# Corresponds to the JSON property `z`
2016-02-25 23:16:53 +00:00
# @return [Float]
attr_accessor :z
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)
@z = args[:z] if args.key?(:z)
end
end
# 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
# 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
# Represents a color in the RGBA color space. This representation is designed
# for simplicity of conversion to/from color representations in various
# languages over compactness; for example, the fields of this representation
# can be trivially provided to the constructor of "java.awt.Color" in Java; it
# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
# method in iOS; and, with just a little work, it can be easily formatted into
# a CSS "rgba()" string in JavaScript, as well. Here are some examples:
# Example (Java):
# import com.google.type.Color;
# // ...
# public static java.awt.Color fromProto(Color protocolor) `
# float alpha = protocolor.hasAlpha()
# ? protocolor.getAlpha().getValue()
# : 1.0;
# return new java.awt.Color(
# protocolor.getRed(),
# protocolor.getGreen(),
# protocolor.getBlue(),
# alpha);
# `
# public static Color toProto(java.awt.Color color) `
# float red = (float) color.getRed();
# float green = (float) color.getGreen();
# float blue = (float) color.getBlue();
# float denominator = 255.0;
# Color.Builder resultBuilder =
# Color
# .newBuilder()
# .setRed(red / denominator)
# .setGreen(green / denominator)
# .setBlue(blue / denominator);
# int alpha = color.getAlpha();
# if (alpha != 255) `
# result.setAlpha(
# FloatValue
# .newBuilder()
# .setValue(((float) alpha) / denominator)
# .build());
# `
# return resultBuilder.build();
# `
# // ...
# Example (iOS / Obj-C):
# // ...
# static UIColor* fromProto(Color* protocolor) `
# float red = [protocolor red];
# float green = [protocolor green];
# float blue = [protocolor blue];
# FloatValue* alpha_wrapper = [protocolor alpha];
# float alpha = 1.0;
# if (alpha_wrapper != nil) `
# alpha = [alpha_wrapper value];
# `
# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
# `
# static Color* toProto(UIColor* color) `
# CGFloat red, green, blue, alpha;
# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) `
# return nil;
# `
# Color* result = [Color alloc] init];
# [result setRed:red];
# [result setGreen:green];
# [result setBlue:blue];
# if (alpha <= 0.9999) `
# [result setAlpha:floatWrapperWithValue(alpha)];
# `
# [result autorelease];
# return result;
# `
# // ...
# Example (JavaScript):
# // ...
# var protoToCssColor = function(rgb_color) `
# var redFrac = rgb_color.red || 0.0;
# var greenFrac = rgb_color.green || 0.0;
# var blueFrac = rgb_color.blue || 0.0;
# var red = Math.floor(redFrac * 255);
# var green = Math.floor(greenFrac * 255);
# var blue = Math.floor(blueFrac * 255);
# if (!('alpha' in rgb_color)) `
# return rgbToCssColor_(red, green, blue);
# `
# var alphaFrac = rgb_color.alpha.value || 0.0;
# var rgbParams = [red, green, blue].join(',');
# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
# `;
# var rgbToCssColor_ = function(red, green, blue) `
# var rgbNumber = new Number((red << 16) | (green << 8) | blue);
# var hexString = rgbNumber.toString(16);
# var missingZeros = 6 - hexString.length;
# var resultBuilder = ['#'];
# for (var i = 0; i < missingZeros; i++) `
# resultBuilder.push('0');
# `
# resultBuilder.push(hexString);
# return resultBuilder.join('');
# `;
# // ...
# Corresponds to the JSON property `color`
# @return [Google::Apis::VisionV1::Color]
attr_accessor :color
2016-02-25 23:16:53 +00:00
# Image-specific score for this color. Value in range [0, 1].
# Corresponds to the JSON property `score`
2016-02-25 23:16:53 +00:00
# @return [Float]
attr_accessor :score
2016-02-25 23:16:53 +00:00
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@pixel_fraction = args[:pixel_fraction] if args.key?(:pixel_fraction)
@color = args[:color] if args.key?(:color)
@score = args[:score] if args.key?(:score)
2016-02-25 23:16:53 +00:00
end
end
# Set of detected entity features.
class EntityAnnotation
2016-02-25 23:16:53 +00:00
include Google::Apis::Core::Hashable
# 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]
attr_accessor :mid
# The accuracy of the entity detection in an image.
# 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
# The language code for the locale in which the entity textual
# `description` is expressed.
# Corresponds to the JSON property `locale`
# @return [String]
attr_accessor :locale
# A bounding polygon for the detected image annotation.
# Corresponds to the JSON property `boundingPoly`
# @return [Google::Apis::VisionV1::BoundingPoly]
attr_accessor :bounding_poly
# 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
2016-02-25 23:16:53 +00:00
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@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)
@properties = args[:properties] if args.key?(:properties)
@score = args[:score] if args.key?(:score)
2016-02-25 23:16:53 +00:00
end
end
# A face-specific landmark (for example, a face feature).
# Landmark positions may fall outside the bounds of the image
# 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
2016-02-25 23:16:53 +00:00
include Google::Apis::Core::Hashable
# Face landmark type.
# Corresponds to the JSON property `type`
2016-05-25 16:16:15 +00:00
# @return [String]
attr_accessor :type
2016-05-25 16:16:15 +00:00
# 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
2016-02-25 23:16:53 +00:00
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@type = args[:type] if args.key?(:type)
@position = args[:position] if args.key?(:position)
2016-02-25 23:16:53 +00:00
end
end
# Client image to perform Google Cloud Vision API tasks over.
2016-02-25 23:16:53 +00:00
class Image
include Google::Apis::Core::Hashable
2016-02-25 23:16:53 +00:00
# Image content, represented as a stream of bytes.
2016-06-09 20:22:21 +00:00
# Note: as with all `bytes` fields, protobuffers use a pure binary
# representation, whereas JSON representations use base64.
2016-02-25 23:16:53 +00:00
# Corresponds to the JSON property `content`
# @return [String]
attr_accessor :content
# External image source (Google Cloud Storage image location).
# Corresponds to the JSON property `source`
# @return [Google::Apis::VisionV1::ImageSource]
attr_accessor :source
2016-02-25 23:16:53 +00:00
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@content = args[:content] if args.key?(:content)
@source = args[:source] if args.key?(:source)
2016-02-25 23:16:53 +00:00
end
end
# A face annotation object contains the results of face detection.
class FaceAnnotation
2016-02-25 23:16:53 +00:00
include Google::Apis::Core::Hashable
# A bounding polygon for the detected image annotation.
# Corresponds to the JSON property `fdBoundingPoly`
# @return [Google::Apis::VisionV1::BoundingPoly]
attr_accessor :fd_bounding_poly
2016-02-25 23:16:53 +00:00
# Anger likelihood.
# Corresponds to the JSON property `angerLikelihood`
# @return [String]
attr_accessor :anger_likelihood
2016-02-25 23:16:53 +00:00
# Detected face landmarks.
# Corresponds to the JSON property `landmarks`
# @return [Array<Google::Apis::VisionV1::Landmark>]
attr_accessor :landmarks
2016-02-25 23:16:53 +00:00
# Surprise likelihood.
# Corresponds to the JSON property `surpriseLikelihood`
# @return [String]
attr_accessor :surprise_likelihood
2016-02-25 23:16:53 +00:00
# Face landmarking confidence. Range [0, 1].
# Corresponds to the JSON property `landmarkingConfidence`
# @return [Float]
attr_accessor :landmarking_confidence
# Joy likelihood.
# Corresponds to the JSON property `joyLikelihood`
2016-02-25 23:16:53 +00:00
# @return [String]
attr_accessor :joy_likelihood
2016-02-25 23:16:53 +00:00
# Under-exposed likelihood.
# Corresponds to the JSON property `underExposedLikelihood`
# @return [String]
attr_accessor :under_exposed_likelihood
2016-05-25 16:16:15 +00:00
# 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
2016-02-25 23:16:53 +00:00
# Detection confidence. Range [0, 1].
# Corresponds to the JSON property `detectionConfidence`
# @return [Float]
attr_accessor :detection_confidence
2016-02-25 23:16:53 +00:00
# Blurred likelihood.
# Corresponds to the JSON property `blurredLikelihood`
# @return [String]
attr_accessor :blurred_likelihood
2016-02-25 23:16:53 +00:00
# Headwear likelihood.
# Corresponds to the JSON property `headwearLikelihood`
# @return [String]
attr_accessor :headwear_likelihood
# A bounding polygon for the detected image annotation.
# Corresponds to the JSON property `boundingPoly`
# @return [Google::Apis::VisionV1::BoundingPoly]
attr_accessor :bounding_poly
# 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.
# 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
2016-02-25 23:16:53 +00:00
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@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)
@landmarking_confidence = args[:landmarking_confidence] if args.key?(:landmarking_confidence)
@joy_likelihood = args[:joy_likelihood] if args.key?(:joy_likelihood)
@under_exposed_likelihood = args[:under_exposed_likelihood] if args.key?(:under_exposed_likelihood)
@pan_angle = args[:pan_angle] if args.key?(:pan_angle)
@detection_confidence = args[:detection_confidence] if args.key?(:detection_confidence)
@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)
2016-02-25 23:16:53 +00:00
end
end
# Multiple image annotation requests are batched into a single service call.
class BatchAnnotateImagesRequest
2016-02-25 23:16:53 +00:00
include Google::Apis::Core::Hashable
# Individual image annotation requests for this batch.
# Corresponds to the JSON property `requests`
# @return [Array<Google::Apis::VisionV1::AnnotateImageRequest>]
attr_accessor :requests
2016-02-25 23:16:53 +00:00
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@requests = args[:requests] if args.key?(:requests)
2016-02-25 23:16:53 +00:00
end
end
# Image context and/or feature-specific parameters.
class ImageContext
2016-02-25 23:16:53 +00:00
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
2016-05-25 16:16:15 +00:00
# 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
# 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](/vision/docs/languages).
# Corresponds to the JSON property `languageHints`
# @return [Array<String>]
attr_accessor :language_hints
2016-02-25 23:16:53 +00:00
2016-05-25 16:16:15 +00:00
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@lat_long_rect = args[:lat_long_rect] if args.key?(:lat_long_rect)
@language_hints = args[:language_hints] if args.key?(:language_hints)
2016-05-25 16:16:15 +00:00
end
end
# Request for performing Google Cloud Vision API tasks over a user-provided
# image, with user-requested features.
class AnnotateImageRequest
2016-05-25 16:16:15 +00:00
include Google::Apis::Core::Hashable
# Client image to perform Google Cloud Vision API tasks over.
# Corresponds to the JSON property `image`
# @return [Google::Apis::VisionV1::Image]
attr_accessor :image
2016-05-25 16:16:15 +00:00
# Requested features.
# Corresponds to the JSON property `features`
# @return [Array<Google::Apis::VisionV1::Feature>]
attr_accessor :features
2016-05-25 16:16:15 +00:00
# Image context and/or feature-specific parameters.
# Corresponds to the JSON property `imageContext`
# @return [Google::Apis::VisionV1::ImageContext]
attr_accessor :image_context
2016-02-25 23:16:53 +00:00
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@image = args[:image] if args.key?(:image)
@features = args[:features] if args.key?(:features)
@image_context = args[:image_context] if args.key?(:image_context)
2016-02-25 23:16:53 +00:00
end
end
end
end
end