google-cloud-vision-v1p4beta1 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.yardopts +12 -0
- data/AUTHENTICATION.md +169 -0
- data/LICENSE.md +201 -0
- data/README.md +139 -0
- data/lib/google/cloud/vision/v1p4beta1/face_pb.rb +35 -0
- data/lib/google/cloud/vision/v1p4beta1/geometry_pb.rb +40 -0
- data/lib/google/cloud/vision/v1p4beta1/image_annotator/client.rb +629 -0
- data/lib/google/cloud/vision/v1p4beta1/image_annotator/credentials.rb +52 -0
- data/lib/google/cloud/vision/v1p4beta1/image_annotator/helpers.rb +1228 -0
- data/lib/google/cloud/vision/v1p4beta1/image_annotator/operations.rb +664 -0
- data/lib/google/cloud/vision/v1p4beta1/image_annotator/paths.rb +52 -0
- data/lib/google/cloud/vision/v1p4beta1/image_annotator.rb +52 -0
- data/lib/google/cloud/vision/v1p4beta1/image_annotator_pb.rb +343 -0
- data/lib/google/cloud/vision/v1p4beta1/image_annotator_services_pb.rb +73 -0
- data/lib/google/cloud/vision/v1p4beta1/product_search/client.rb +2106 -0
- data/lib/google/cloud/vision/v1p4beta1/product_search/credentials.rb +52 -0
- data/lib/google/cloud/vision/v1p4beta1/product_search/operations.rb +664 -0
- data/lib/google/cloud/vision/v1p4beta1/product_search/paths.rb +109 -0
- data/lib/google/cloud/vision/v1p4beta1/product_search.rb +67 -0
- data/lib/google/cloud/vision/v1p4beta1/product_search_pb.rb +55 -0
- data/lib/google/cloud/vision/v1p4beta1/product_search_service_pb.rb +208 -0
- data/lib/google/cloud/vision/v1p4beta1/product_search_service_services_pb.rb +236 -0
- data/lib/google/cloud/vision/v1p4beta1/text_annotation_pb.rb +95 -0
- data/lib/google/cloud/vision/v1p4beta1/version.rb +28 -0
- data/lib/google/cloud/vision/v1p4beta1/web_detection_pb.rb +52 -0
- data/lib/google/cloud/vision/v1p4beta1.rb +39 -0
- data/lib/google-cloud-vision-v1p4beta1.rb +21 -0
- data/proto_docs/README.md +4 -0
- data/proto_docs/google/api/field_behavior.rb +71 -0
- data/proto_docs/google/api/resource.rb +283 -0
- data/proto_docs/google/cloud/vision/v1p4beta1/face.rb +68 -0
- data/proto_docs/google/cloud/vision/v1p4beta1/geometry.rb +82 -0
- data/proto_docs/google/cloud/vision/v1p4beta1/image_annotator.rb +989 -0
- data/proto_docs/google/cloud/vision/v1p4beta1/product_search.rb +136 -0
- data/proto_docs/google/cloud/vision/v1p4beta1/product_search_service.rb +676 -0
- data/proto_docs/google/cloud/vision/v1p4beta1/text_annotation.rb +286 -0
- data/proto_docs/google/cloud/vision/v1p4beta1/web_detection.rb +121 -0
- data/proto_docs/google/longrunning/operations.rb +164 -0
- data/proto_docs/google/protobuf/any.rb +141 -0
- data/proto_docs/google/protobuf/duration.rb +98 -0
- data/proto_docs/google/protobuf/empty.rb +36 -0
- data/proto_docs/google/protobuf/field_mask.rb +229 -0
- data/proto_docs/google/protobuf/timestamp.rb +129 -0
- data/proto_docs/google/protobuf/wrappers.rb +121 -0
- data/proto_docs/google/rpc/status.rb +46 -0
- data/proto_docs/google/type/color.rb +173 -0
- data/proto_docs/google/type/latlng.rb +38 -0
- metadata +240 -0
@@ -0,0 +1,989 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2021 Google LLC
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
18
|
+
|
19
|
+
|
20
|
+
module Google
|
21
|
+
module Cloud
|
22
|
+
module Vision
|
23
|
+
module V1p4beta1
|
24
|
+
# The type of Google Cloud Vision API detection to perform, and the maximum
|
25
|
+
# number of results to return for that type. Multiple `Feature` objects can
|
26
|
+
# be specified in the `features` list.
|
27
|
+
# @!attribute [rw] type
|
28
|
+
# @return [::Google::Cloud::Vision::V1p4beta1::Feature::Type]
|
29
|
+
# The feature type.
|
30
|
+
# @!attribute [rw] max_results
|
31
|
+
# @return [::Integer]
|
32
|
+
# Maximum number of results of this type. Does not apply to
|
33
|
+
# `TEXT_DETECTION`, `DOCUMENT_TEXT_DETECTION`, or `CROP_HINTS`.
|
34
|
+
# @!attribute [rw] model
|
35
|
+
# @return [::String]
|
36
|
+
# Model to use for the feature.
|
37
|
+
# Supported values: "builtin/stable" (the default if unset) and
|
38
|
+
# "builtin/latest".
|
39
|
+
class Feature
|
40
|
+
include ::Google::Protobuf::MessageExts
|
41
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
42
|
+
|
43
|
+
# Type of Google Cloud Vision API feature to be extracted.
|
44
|
+
module Type
|
45
|
+
# Unspecified feature type.
|
46
|
+
TYPE_UNSPECIFIED = 0
|
47
|
+
|
48
|
+
# Run face detection.
|
49
|
+
FACE_DETECTION = 1
|
50
|
+
|
51
|
+
# Run landmark detection.
|
52
|
+
LANDMARK_DETECTION = 2
|
53
|
+
|
54
|
+
# Run logo detection.
|
55
|
+
LOGO_DETECTION = 3
|
56
|
+
|
57
|
+
# Run label detection.
|
58
|
+
LABEL_DETECTION = 4
|
59
|
+
|
60
|
+
# Run text detection / optical character recognition (OCR). Text detection
|
61
|
+
# is optimized for areas of text within a larger image; if the image is
|
62
|
+
# a document, use `DOCUMENT_TEXT_DETECTION` instead.
|
63
|
+
TEXT_DETECTION = 5
|
64
|
+
|
65
|
+
# Run dense text document OCR. Takes precedence when both
|
66
|
+
# `DOCUMENT_TEXT_DETECTION` and `TEXT_DETECTION` are present.
|
67
|
+
DOCUMENT_TEXT_DETECTION = 11
|
68
|
+
|
69
|
+
# Run Safe Search to detect potentially unsafe
|
70
|
+
# or undesirable content.
|
71
|
+
SAFE_SEARCH_DETECTION = 6
|
72
|
+
|
73
|
+
# Compute a set of image properties, such as the
|
74
|
+
# image's dominant colors.
|
75
|
+
IMAGE_PROPERTIES = 7
|
76
|
+
|
77
|
+
# Run crop hints.
|
78
|
+
CROP_HINTS = 9
|
79
|
+
|
80
|
+
# Run web detection.
|
81
|
+
WEB_DETECTION = 10
|
82
|
+
|
83
|
+
# Run Product Search.
|
84
|
+
PRODUCT_SEARCH = 12
|
85
|
+
|
86
|
+
# Run localizer for object detection.
|
87
|
+
OBJECT_LOCALIZATION = 19
|
88
|
+
end
|
89
|
+
end
|
90
|
+
|
91
|
+
# External image source (Google Cloud Storage or web URL image location).
|
92
|
+
# @!attribute [rw] gcs_image_uri
|
93
|
+
# @return [::String]
|
94
|
+
# **Use `image_uri` instead.**
|
95
|
+
#
|
96
|
+
# The Google Cloud Storage URI of the form
|
97
|
+
# `gs://bucket_name/object_name`. Object versioning is not supported. See
|
98
|
+
# [Google Cloud Storage Request
|
99
|
+
# URIs](https://cloud.google.com/storage/docs/reference-uris) for more info.
|
100
|
+
# @!attribute [rw] image_uri
|
101
|
+
# @return [::String]
|
102
|
+
# The URI of the source image. Can be either:
|
103
|
+
#
|
104
|
+
# 1. A Google Cloud Storage URI of the form
|
105
|
+
# `gs://bucket_name/object_name`. Object versioning is not supported. See
|
106
|
+
# [Google Cloud Storage Request
|
107
|
+
# URIs](https://cloud.google.com/storage/docs/reference-uris) for more
|
108
|
+
# info.
|
109
|
+
#
|
110
|
+
# 2. A publicly-accessible image HTTP/HTTPS URL. When fetching images from
|
111
|
+
# HTTP/HTTPS URLs, Google cannot guarantee that the request will be
|
112
|
+
# completed. Your request may fail if the specified host denies the
|
113
|
+
# request (e.g. due to request throttling or DOS prevention), or if Google
|
114
|
+
# throttles requests to the site for abuse prevention. You should not
|
115
|
+
# depend on externally-hosted images for production applications.
|
116
|
+
#
|
117
|
+
# When both `gcs_image_uri` and `image_uri` are specified, `image_uri` takes
|
118
|
+
# precedence.
|
119
|
+
class ImageSource
|
120
|
+
include ::Google::Protobuf::MessageExts
|
121
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
122
|
+
end
|
123
|
+
|
124
|
+
# Client image to perform Google Cloud Vision API tasks over.
|
125
|
+
# @!attribute [rw] content
|
126
|
+
# @return [::String]
|
127
|
+
# Image content, represented as a stream of bytes.
|
128
|
+
# Note: As with all `bytes` fields, protobuffers use a pure binary
|
129
|
+
# representation, whereas JSON representations use base64.
|
130
|
+
# @!attribute [rw] source
|
131
|
+
# @return [::Google::Cloud::Vision::V1p4beta1::ImageSource]
|
132
|
+
# Google Cloud Storage image location, or publicly-accessible image
|
133
|
+
# URL. If both `content` and `source` are provided for an image, `content`
|
134
|
+
# takes precedence and is used to perform the image annotation request.
|
135
|
+
class Image
|
136
|
+
include ::Google::Protobuf::MessageExts
|
137
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
138
|
+
end
|
139
|
+
|
140
|
+
# A face annotation object contains the results of face detection.
|
141
|
+
# @!attribute [rw] bounding_poly
|
142
|
+
# @return [::Google::Cloud::Vision::V1p4beta1::BoundingPoly]
|
143
|
+
# The bounding polygon around the face. The coordinates of the bounding box
|
144
|
+
# are in the original image's scale.
|
145
|
+
# The bounding box is computed to "frame" the face in accordance with human
|
146
|
+
# expectations. It is based on the landmarker results.
|
147
|
+
# Note that one or more x and/or y coordinates may not be generated in the
|
148
|
+
# `BoundingPoly` (the polygon will be unbounded) if only a partial face
|
149
|
+
# appears in the image to be annotated.
|
150
|
+
# @!attribute [rw] fd_bounding_poly
|
151
|
+
# @return [::Google::Cloud::Vision::V1p4beta1::BoundingPoly]
|
152
|
+
# The `fd_bounding_poly` bounding polygon is tighter than the
|
153
|
+
# `boundingPoly`, and encloses only the skin part of the face. Typically, it
|
154
|
+
# is used to eliminate the face from any image analysis that detects the
|
155
|
+
# "amount of skin" visible in an image. It is not based on the
|
156
|
+
# landmarker results, only on the initial face detection, hence
|
157
|
+
# the <code>fd</code> (face detection) prefix.
|
158
|
+
# @!attribute [rw] landmarks
|
159
|
+
# @return [::Array<::Google::Cloud::Vision::V1p4beta1::FaceAnnotation::Landmark>]
|
160
|
+
# Detected face landmarks.
|
161
|
+
# @!attribute [rw] roll_angle
|
162
|
+
# @return [::Float]
|
163
|
+
# Roll angle, which indicates the amount of clockwise/anti-clockwise rotation
|
164
|
+
# of the face relative to the image vertical about the axis perpendicular to
|
165
|
+
# the face. Range [-180,180].
|
166
|
+
# @!attribute [rw] pan_angle
|
167
|
+
# @return [::Float]
|
168
|
+
# Yaw angle, which indicates the leftward/rightward angle that the face is
|
169
|
+
# pointing relative to the vertical plane perpendicular to the image. Range
|
170
|
+
# [-180,180].
|
171
|
+
# @!attribute [rw] tilt_angle
|
172
|
+
# @return [::Float]
|
173
|
+
# Pitch angle, which indicates the upwards/downwards angle that the face is
|
174
|
+
# pointing relative to the image's horizontal plane. Range [-180,180].
|
175
|
+
# @!attribute [rw] detection_confidence
|
176
|
+
# @return [::Float]
|
177
|
+
# Detection confidence. Range [0, 1].
|
178
|
+
# @!attribute [rw] landmarking_confidence
|
179
|
+
# @return [::Float]
|
180
|
+
# Face landmarking confidence. Range [0, 1].
|
181
|
+
# @!attribute [rw] joy_likelihood
|
182
|
+
# @return [::Google::Cloud::Vision::V1p4beta1::Likelihood]
|
183
|
+
# Joy likelihood.
|
184
|
+
# @!attribute [rw] sorrow_likelihood
|
185
|
+
# @return [::Google::Cloud::Vision::V1p4beta1::Likelihood]
|
186
|
+
# Sorrow likelihood.
|
187
|
+
# @!attribute [rw] anger_likelihood
|
188
|
+
# @return [::Google::Cloud::Vision::V1p4beta1::Likelihood]
|
189
|
+
# Anger likelihood.
|
190
|
+
# @!attribute [rw] surprise_likelihood
|
191
|
+
# @return [::Google::Cloud::Vision::V1p4beta1::Likelihood]
|
192
|
+
# Surprise likelihood.
|
193
|
+
# @!attribute [rw] under_exposed_likelihood
|
194
|
+
# @return [::Google::Cloud::Vision::V1p4beta1::Likelihood]
|
195
|
+
# Under-exposed likelihood.
|
196
|
+
# @!attribute [rw] blurred_likelihood
|
197
|
+
# @return [::Google::Cloud::Vision::V1p4beta1::Likelihood]
|
198
|
+
# Blurred likelihood.
|
199
|
+
# @!attribute [rw] headwear_likelihood
|
200
|
+
# @return [::Google::Cloud::Vision::V1p4beta1::Likelihood]
|
201
|
+
# Headwear likelihood.
|
202
|
+
# @!attribute [rw] recognition_result
|
203
|
+
# @return [::Array<::Google::Cloud::Vision::V1p4beta1::FaceRecognitionResult>]
|
204
|
+
# Additional recognition information. Only computed if
|
205
|
+
# image_context.face_recognition_params is provided, **and** a match is found
|
206
|
+
# to a {::Google::Cloud::Vision::V1p4beta1::Celebrity Celebrity} in the input
|
207
|
+
# [CelebritySet][google.cloud.vision.v1p4beta1.CelebritySet]. This field is
|
208
|
+
# sorted in order of decreasing confidence values.
|
209
|
+
class FaceAnnotation
|
210
|
+
include ::Google::Protobuf::MessageExts
|
211
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
212
|
+
|
213
|
+
# A face-specific landmark (for example, a face feature).
|
214
|
+
# @!attribute [rw] type
|
215
|
+
# @return [::Google::Cloud::Vision::V1p4beta1::FaceAnnotation::Landmark::Type]
|
216
|
+
# Face landmark type.
|
217
|
+
# @!attribute [rw] position
|
218
|
+
# @return [::Google::Cloud::Vision::V1p4beta1::Position]
|
219
|
+
# Face landmark position.
|
220
|
+
class Landmark
|
221
|
+
include ::Google::Protobuf::MessageExts
|
222
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
223
|
+
|
224
|
+
# Face landmark (feature) type.
|
225
|
+
# Left and right are defined from the vantage of the viewer of the image
|
226
|
+
# without considering mirror projections typical of photos. So, `LEFT_EYE`,
|
227
|
+
# typically, is the person's right eye.
|
228
|
+
module Type
|
229
|
+
# Unknown face landmark detected. Should not be filled.
|
230
|
+
UNKNOWN_LANDMARK = 0
|
231
|
+
|
232
|
+
# Left eye.
|
233
|
+
LEFT_EYE = 1
|
234
|
+
|
235
|
+
# Right eye.
|
236
|
+
RIGHT_EYE = 2
|
237
|
+
|
238
|
+
# Left of left eyebrow.
|
239
|
+
LEFT_OF_LEFT_EYEBROW = 3
|
240
|
+
|
241
|
+
# Right of left eyebrow.
|
242
|
+
RIGHT_OF_LEFT_EYEBROW = 4
|
243
|
+
|
244
|
+
# Left of right eyebrow.
|
245
|
+
LEFT_OF_RIGHT_EYEBROW = 5
|
246
|
+
|
247
|
+
# Right of right eyebrow.
|
248
|
+
RIGHT_OF_RIGHT_EYEBROW = 6
|
249
|
+
|
250
|
+
# Midpoint between eyes.
|
251
|
+
MIDPOINT_BETWEEN_EYES = 7
|
252
|
+
|
253
|
+
# Nose tip.
|
254
|
+
NOSE_TIP = 8
|
255
|
+
|
256
|
+
# Upper lip.
|
257
|
+
UPPER_LIP = 9
|
258
|
+
|
259
|
+
# Lower lip.
|
260
|
+
LOWER_LIP = 10
|
261
|
+
|
262
|
+
# Mouth left.
|
263
|
+
MOUTH_LEFT = 11
|
264
|
+
|
265
|
+
# Mouth right.
|
266
|
+
MOUTH_RIGHT = 12
|
267
|
+
|
268
|
+
# Mouth center.
|
269
|
+
MOUTH_CENTER = 13
|
270
|
+
|
271
|
+
# Nose, bottom right.
|
272
|
+
NOSE_BOTTOM_RIGHT = 14
|
273
|
+
|
274
|
+
# Nose, bottom left.
|
275
|
+
NOSE_BOTTOM_LEFT = 15
|
276
|
+
|
277
|
+
# Nose, bottom center.
|
278
|
+
NOSE_BOTTOM_CENTER = 16
|
279
|
+
|
280
|
+
# Left eye, top boundary.
|
281
|
+
LEFT_EYE_TOP_BOUNDARY = 17
|
282
|
+
|
283
|
+
# Left eye, right corner.
|
284
|
+
LEFT_EYE_RIGHT_CORNER = 18
|
285
|
+
|
286
|
+
# Left eye, bottom boundary.
|
287
|
+
LEFT_EYE_BOTTOM_BOUNDARY = 19
|
288
|
+
|
289
|
+
# Left eye, left corner.
|
290
|
+
LEFT_EYE_LEFT_CORNER = 20
|
291
|
+
|
292
|
+
# Right eye, top boundary.
|
293
|
+
RIGHT_EYE_TOP_BOUNDARY = 21
|
294
|
+
|
295
|
+
# Right eye, right corner.
|
296
|
+
RIGHT_EYE_RIGHT_CORNER = 22
|
297
|
+
|
298
|
+
# Right eye, bottom boundary.
|
299
|
+
RIGHT_EYE_BOTTOM_BOUNDARY = 23
|
300
|
+
|
301
|
+
# Right eye, left corner.
|
302
|
+
RIGHT_EYE_LEFT_CORNER = 24
|
303
|
+
|
304
|
+
# Left eyebrow, upper midpoint.
|
305
|
+
LEFT_EYEBROW_UPPER_MIDPOINT = 25
|
306
|
+
|
307
|
+
# Right eyebrow, upper midpoint.
|
308
|
+
RIGHT_EYEBROW_UPPER_MIDPOINT = 26
|
309
|
+
|
310
|
+
# Left ear tragion.
|
311
|
+
LEFT_EAR_TRAGION = 27
|
312
|
+
|
313
|
+
# Right ear tragion.
|
314
|
+
RIGHT_EAR_TRAGION = 28
|
315
|
+
|
316
|
+
# Left eye pupil.
|
317
|
+
LEFT_EYE_PUPIL = 29
|
318
|
+
|
319
|
+
# Right eye pupil.
|
320
|
+
RIGHT_EYE_PUPIL = 30
|
321
|
+
|
322
|
+
# Forehead glabella.
|
323
|
+
FOREHEAD_GLABELLA = 31
|
324
|
+
|
325
|
+
# Chin gnathion.
|
326
|
+
CHIN_GNATHION = 32
|
327
|
+
|
328
|
+
# Chin left gonion.
|
329
|
+
CHIN_LEFT_GONION = 33
|
330
|
+
|
331
|
+
# Chin right gonion.
|
332
|
+
CHIN_RIGHT_GONION = 34
|
333
|
+
end
|
334
|
+
end
|
335
|
+
end
|
336
|
+
|
337
|
+
# Detected entity location information.
|
338
|
+
# @!attribute [rw] lat_lng
|
339
|
+
# @return [::Google::Type::LatLng]
|
340
|
+
# lat/long location coordinates.
|
341
|
+
class LocationInfo
|
342
|
+
include ::Google::Protobuf::MessageExts
|
343
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
344
|
+
end
|
345
|
+
|
346
|
+
# A `Property` consists of a user-supplied name/value pair.
|
347
|
+
# @!attribute [rw] name
|
348
|
+
# @return [::String]
|
349
|
+
# Name of the property.
|
350
|
+
# @!attribute [rw] value
|
351
|
+
# @return [::String]
|
352
|
+
# Value of the property.
|
353
|
+
# @!attribute [rw] uint64_value
|
354
|
+
# @return [::Integer]
|
355
|
+
# Value of numeric properties.
|
356
|
+
class Property
|
357
|
+
include ::Google::Protobuf::MessageExts
|
358
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
359
|
+
end
|
360
|
+
|
361
|
+
# Set of detected entity features.
|
362
|
+
# @!attribute [rw] mid
|
363
|
+
# @return [::String]
|
364
|
+
# Opaque entity ID. Some IDs may be available in
|
365
|
+
# [Google Knowledge Graph Search
|
366
|
+
# API](https://developers.google.com/knowledge-graph/).
|
367
|
+
# @!attribute [rw] locale
|
368
|
+
# @return [::String]
|
369
|
+
# The language code for the locale in which the entity textual
|
370
|
+
# `description` is expressed.
|
371
|
+
# @!attribute [rw] description
|
372
|
+
# @return [::String]
|
373
|
+
# Entity textual description, expressed in its `locale` language.
|
374
|
+
# @!attribute [rw] score
|
375
|
+
# @return [::Float]
|
376
|
+
# Overall score of the result. Range [0, 1].
|
377
|
+
# @!attribute [rw] confidence
|
378
|
+
# @return [::Float]
|
379
|
+
# **Deprecated. Use `score` instead.**
|
380
|
+
# The accuracy of the entity detection in an image.
|
381
|
+
# For example, for an image in which the "Eiffel Tower" entity is detected,
|
382
|
+
# this field represents the confidence that there is a tower in the query
|
383
|
+
# image. Range [0, 1].
|
384
|
+
# @!attribute [rw] topicality
|
385
|
+
# @return [::Float]
|
386
|
+
# The relevancy of the ICA (Image Content Annotation) label to the
|
387
|
+
# image. For example, the relevancy of "tower" is likely higher to an image
|
388
|
+
# containing the detected "Eiffel Tower" than to an image containing a
|
389
|
+
# detected distant towering building, even though the confidence that
|
390
|
+
# there is a tower in each image may be the same. Range [0, 1].
|
391
|
+
# @!attribute [rw] bounding_poly
|
392
|
+
# @return [::Google::Cloud::Vision::V1p4beta1::BoundingPoly]
|
393
|
+
# Image region to which this entity belongs. Not produced
|
394
|
+
# for `LABEL_DETECTION` features.
|
395
|
+
# @!attribute [rw] locations
|
396
|
+
# @return [::Array<::Google::Cloud::Vision::V1p4beta1::LocationInfo>]
|
397
|
+
# The location information for the detected entity. Multiple
|
398
|
+
# `LocationInfo` elements can be present because one location may
|
399
|
+
# indicate the location of the scene in the image, and another location
|
400
|
+
# may indicate the location of the place where the image was taken.
|
401
|
+
# Location information is usually present for landmarks.
|
402
|
+
# @!attribute [rw] properties
|
403
|
+
# @return [::Array<::Google::Cloud::Vision::V1p4beta1::Property>]
|
404
|
+
# Some entities may have optional user-supplied `Property` (name/value)
|
405
|
+
# fields, such a score or string that qualifies the entity.
|
406
|
+
class EntityAnnotation
|
407
|
+
include ::Google::Protobuf::MessageExts
|
408
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
409
|
+
end
|
410
|
+
|
411
|
+
# Set of detected objects with bounding boxes.
|
412
|
+
# @!attribute [rw] mid
|
413
|
+
# @return [::String]
|
414
|
+
# Object ID that should align with EntityAnnotation mid.
|
415
|
+
# @!attribute [rw] language_code
|
416
|
+
# @return [::String]
|
417
|
+
# The BCP-47 language code, such as "en-US" or "sr-Latn". For more
|
418
|
+
# information, see
|
419
|
+
# http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
|
420
|
+
# @!attribute [rw] name
|
421
|
+
# @return [::String]
|
422
|
+
# Object name, expressed in its `language_code` language.
|
423
|
+
# @!attribute [rw] score
|
424
|
+
# @return [::Float]
|
425
|
+
# Score of the result. Range [0, 1].
|
426
|
+
# @!attribute [rw] bounding_poly
|
427
|
+
# @return [::Google::Cloud::Vision::V1p4beta1::BoundingPoly]
|
428
|
+
# Image region to which this object belongs. This must be populated.
|
429
|
+
class LocalizedObjectAnnotation
|
430
|
+
include ::Google::Protobuf::MessageExts
|
431
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
432
|
+
end
|
433
|
+
|
434
|
+
# Set of features pertaining to the image, computed by computer vision
|
435
|
+
# methods over safe-search verticals (for example, adult, spoof, medical,
|
436
|
+
# violence).
|
437
|
+
# @!attribute [rw] adult
|
438
|
+
# @return [::Google::Cloud::Vision::V1p4beta1::Likelihood]
|
439
|
+
# Represents the adult content likelihood for the image. Adult content may
|
440
|
+
# contain elements such as nudity, pornographic images or cartoons, or
|
441
|
+
# sexual activities.
|
442
|
+
# @!attribute [rw] spoof
|
443
|
+
# @return [::Google::Cloud::Vision::V1p4beta1::Likelihood]
|
444
|
+
# Spoof likelihood. The likelihood that an modification
|
445
|
+
# was made to the image's canonical version to make it appear
|
446
|
+
# funny or offensive.
|
447
|
+
# @!attribute [rw] medical
|
448
|
+
# @return [::Google::Cloud::Vision::V1p4beta1::Likelihood]
|
449
|
+
# Likelihood that this is a medical image.
|
450
|
+
# @!attribute [rw] violence
|
451
|
+
# @return [::Google::Cloud::Vision::V1p4beta1::Likelihood]
|
452
|
+
# Likelihood that this image contains violent content.
|
453
|
+
# @!attribute [rw] racy
|
454
|
+
# @return [::Google::Cloud::Vision::V1p4beta1::Likelihood]
|
455
|
+
# Likelihood that the request image contains racy content. Racy content may
|
456
|
+
# include (but is not limited to) skimpy or sheer clothing, strategically
|
457
|
+
# covered nudity, lewd or provocative poses, or close-ups of sensitive
|
458
|
+
# body areas.
|
459
|
+
class SafeSearchAnnotation
|
460
|
+
include ::Google::Protobuf::MessageExts
|
461
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
462
|
+
end
|
463
|
+
|
464
|
+
# Rectangle determined by min and max `LatLng` pairs.
|
465
|
+
# @!attribute [rw] min_lat_lng
|
466
|
+
# @return [::Google::Type::LatLng]
|
467
|
+
# Min lat/long pair.
|
468
|
+
# @!attribute [rw] max_lat_lng
|
469
|
+
# @return [::Google::Type::LatLng]
|
470
|
+
# Max lat/long pair.
|
471
|
+
class LatLongRect
|
472
|
+
include ::Google::Protobuf::MessageExts
|
473
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
474
|
+
end
|
475
|
+
|
476
|
+
# Color information consists of RGB channels, score, and the fraction of
|
477
|
+
# the image that the color occupies in the image.
|
478
|
+
# @!attribute [rw] color
|
479
|
+
# @return [::Google::Type::Color]
|
480
|
+
# RGB components of the color.
|
481
|
+
# @!attribute [rw] score
|
482
|
+
# @return [::Float]
|
483
|
+
# Image-specific score for this color. Value in range [0, 1].
|
484
|
+
# @!attribute [rw] pixel_fraction
|
485
|
+
# @return [::Float]
|
486
|
+
# The fraction of pixels the color occupies in the image.
|
487
|
+
# Value in range [0, 1].
|
488
|
+
class ColorInfo
|
489
|
+
include ::Google::Protobuf::MessageExts
|
490
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
491
|
+
end
|
492
|
+
|
493
|
+
# Set of dominant colors and their corresponding scores.
|
494
|
+
# @!attribute [rw] colors
|
495
|
+
# @return [::Array<::Google::Cloud::Vision::V1p4beta1::ColorInfo>]
|
496
|
+
# RGB color values with their score and pixel fraction.
|
497
|
+
class DominantColorsAnnotation
|
498
|
+
include ::Google::Protobuf::MessageExts
|
499
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
500
|
+
end
|
501
|
+
|
502
|
+
# Stores image properties, such as dominant colors.
|
503
|
+
# @!attribute [rw] dominant_colors
|
504
|
+
# @return [::Google::Cloud::Vision::V1p4beta1::DominantColorsAnnotation]
|
505
|
+
# If present, dominant colors completed successfully.
|
506
|
+
class ImageProperties
|
507
|
+
include ::Google::Protobuf::MessageExts
|
508
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
509
|
+
end
|
510
|
+
|
511
|
+
# Single crop hint that is used to generate a new crop when serving an image.
|
512
|
+
# @!attribute [rw] bounding_poly
|
513
|
+
# @return [::Google::Cloud::Vision::V1p4beta1::BoundingPoly]
|
514
|
+
# The bounding polygon for the crop region. The coordinates of the bounding
|
515
|
+
# box are in the original image's scale.
|
516
|
+
# @!attribute [rw] confidence
|
517
|
+
# @return [::Float]
|
518
|
+
# Confidence of this being a salient region. Range [0, 1].
|
519
|
+
# @!attribute [rw] importance_fraction
|
520
|
+
# @return [::Float]
|
521
|
+
# Fraction of importance of this salient region with respect to the original
|
522
|
+
# image.
|
523
|
+
class CropHint
|
524
|
+
include ::Google::Protobuf::MessageExts
|
525
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
526
|
+
end
|
527
|
+
|
528
|
+
# Set of crop hints that are used to generate new crops when serving images.
|
529
|
+
# @!attribute [rw] crop_hints
|
530
|
+
# @return [::Array<::Google::Cloud::Vision::V1p4beta1::CropHint>]
|
531
|
+
# Crop hint results.
|
532
|
+
class CropHintsAnnotation
|
533
|
+
include ::Google::Protobuf::MessageExts
|
534
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
535
|
+
end
|
536
|
+
|
537
|
+
# Parameters for crop hints annotation request.
|
538
|
+
# @!attribute [rw] aspect_ratios
|
539
|
+
# @return [::Array<::Float>]
|
540
|
+
# Aspect ratios in floats, representing the ratio of the width to the height
|
541
|
+
# of the image. For example, if the desired aspect ratio is 4/3, the
|
542
|
+
# corresponding float value should be 1.33333. If not specified, the
|
543
|
+
# best possible crop is returned. The number of provided aspect ratios is
|
544
|
+
# limited to a maximum of 16; any aspect ratios provided after the 16th are
|
545
|
+
# ignored.
|
546
|
+
class CropHintsParams
|
547
|
+
include ::Google::Protobuf::MessageExts
|
548
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
549
|
+
end
|
550
|
+
|
551
|
+
# Parameters for web detection request.
|
552
|
+
# @!attribute [rw] include_geo_results
|
553
|
+
# @return [::Boolean]
|
554
|
+
# Whether to include results derived from the geo information in the image.
|
555
|
+
class WebDetectionParams
|
556
|
+
include ::Google::Protobuf::MessageExts
|
557
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
558
|
+
end
|
559
|
+
|
560
|
+
# Parameters for text detections. This is used to control TEXT_DETECTION and
|
561
|
+
# DOCUMENT_TEXT_DETECTION features.
|
562
|
+
# @!attribute [rw] enable_text_detection_confidence_score
|
563
|
+
# @return [::Boolean]
|
564
|
+
# By default, Cloud Vision API only includes confidence score for
|
565
|
+
# DOCUMENT_TEXT_DETECTION result. Set the flag to true to include confidence
|
566
|
+
# score for TEXT_DETECTION as well.
|
567
|
+
class TextDetectionParams
|
568
|
+
include ::Google::Protobuf::MessageExts
|
569
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
570
|
+
end
|
571
|
+
|
572
|
+
# Image context and/or feature-specific parameters.
|
573
|
+
# @!attribute [rw] lat_long_rect
|
574
|
+
# @return [::Google::Cloud::Vision::V1p4beta1::LatLongRect]
|
575
|
+
# Not used.
|
576
|
+
# @!attribute [rw] language_hints
|
577
|
+
# @return [::Array<::String>]
|
578
|
+
# List of languages to use for TEXT_DETECTION. In most cases, an empty value
|
579
|
+
# yields the best results since it enables automatic language detection. For
|
580
|
+
# languages based on the Latin alphabet, setting `language_hints` is not
|
581
|
+
# needed. In rare cases, when the language of the text in the image is known,
|
582
|
+
# setting a hint will help get better results (although it will be a
|
583
|
+
# significant hindrance if the hint is wrong). Text detection returns an
|
584
|
+
# error if one or more of the specified languages is not one of the
|
585
|
+
# [supported languages](https://cloud.google.com/vision/docs/languages).
|
586
|
+
# @!attribute [rw] crop_hints_params
|
587
|
+
# @return [::Google::Cloud::Vision::V1p4beta1::CropHintsParams]
|
588
|
+
# Parameters for crop hints annotation request.
|
589
|
+
# @!attribute [rw] face_recognition_params
|
590
|
+
# @return [::Google::Cloud::Vision::V1p4beta1::FaceRecognitionParams]
|
591
|
+
# Parameters for face recognition.
|
592
|
+
# @!attribute [rw] product_search_params
|
593
|
+
# @return [::Google::Cloud::Vision::V1p4beta1::ProductSearchParams]
|
594
|
+
# Parameters for product search.
|
595
|
+
# @!attribute [rw] web_detection_params
|
596
|
+
# @return [::Google::Cloud::Vision::V1p4beta1::WebDetectionParams]
|
597
|
+
# Parameters for web detection.
|
598
|
+
# @!attribute [rw] text_detection_params
|
599
|
+
# @return [::Google::Cloud::Vision::V1p4beta1::TextDetectionParams]
|
600
|
+
# Parameters for text detection and document text detection.
|
601
|
+
class ImageContext
|
602
|
+
include ::Google::Protobuf::MessageExts
|
603
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
604
|
+
end
|
605
|
+
|
606
|
+
# Request for performing Google Cloud Vision API tasks over a user-provided
|
607
|
+
# image, with user-requested features, and with context information.
|
608
|
+
# @!attribute [rw] image
|
609
|
+
# @return [::Google::Cloud::Vision::V1p4beta1::Image]
|
610
|
+
# The image to be processed.
|
611
|
+
# @!attribute [rw] features
|
612
|
+
# @return [::Array<::Google::Cloud::Vision::V1p4beta1::Feature>]
|
613
|
+
# Requested features.
|
614
|
+
# @!attribute [rw] image_context
|
615
|
+
# @return [::Google::Cloud::Vision::V1p4beta1::ImageContext]
|
616
|
+
# Additional context that may accompany the image.
|
617
|
+
class AnnotateImageRequest
|
618
|
+
include ::Google::Protobuf::MessageExts
|
619
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
620
|
+
end
|
621
|
+
|
622
|
+
# If an image was produced from a file (e.g. a PDF), this message gives
|
623
|
+
# information about the source of that image.
|
624
|
+
# @!attribute [rw] uri
|
625
|
+
# @return [::String]
|
626
|
+
# The URI of the file used to produce the image.
|
627
|
+
# @!attribute [rw] page_number
|
628
|
+
# @return [::Integer]
|
629
|
+
# If the file was a PDF or TIFF, this field gives the page number within
|
630
|
+
# the file used to produce the image.
|
631
|
+
class ImageAnnotationContext
|
632
|
+
include ::Google::Protobuf::MessageExts
|
633
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
634
|
+
end
|
635
|
+
|
636
|
+
# Response to an image annotation request.
|
637
|
+
# @!attribute [rw] face_annotations
|
638
|
+
# @return [::Array<::Google::Cloud::Vision::V1p4beta1::FaceAnnotation>]
|
639
|
+
# If present, face detection has completed successfully.
|
640
|
+
# @!attribute [rw] landmark_annotations
|
641
|
+
# @return [::Array<::Google::Cloud::Vision::V1p4beta1::EntityAnnotation>]
|
642
|
+
# If present, landmark detection has completed successfully.
|
643
|
+
# @!attribute [rw] logo_annotations
|
644
|
+
# @return [::Array<::Google::Cloud::Vision::V1p4beta1::EntityAnnotation>]
|
645
|
+
# If present, logo detection has completed successfully.
|
646
|
+
# @!attribute [rw] label_annotations
|
647
|
+
# @return [::Array<::Google::Cloud::Vision::V1p4beta1::EntityAnnotation>]
|
648
|
+
# If present, label detection has completed successfully.
|
649
|
+
# @!attribute [rw] localized_object_annotations
|
650
|
+
# @return [::Array<::Google::Cloud::Vision::V1p4beta1::LocalizedObjectAnnotation>]
|
651
|
+
# If present, localized object detection has completed successfully.
|
652
|
+
# This will be sorted descending by confidence score.
|
653
|
+
# @!attribute [rw] text_annotations
|
654
|
+
# @return [::Array<::Google::Cloud::Vision::V1p4beta1::EntityAnnotation>]
|
655
|
+
# If present, text (OCR) detection has completed successfully.
|
656
|
+
# @!attribute [rw] full_text_annotation
|
657
|
+
# @return [::Google::Cloud::Vision::V1p4beta1::TextAnnotation]
|
658
|
+
# If present, text (OCR) detection or document (OCR) text detection has
|
659
|
+
# completed successfully.
|
660
|
+
# This annotation provides the structural hierarchy for the OCR detected
|
661
|
+
# text.
|
662
|
+
# @!attribute [rw] safe_search_annotation
|
663
|
+
# @return [::Google::Cloud::Vision::V1p4beta1::SafeSearchAnnotation]
|
664
|
+
# If present, safe-search annotation has completed successfully.
|
665
|
+
# @!attribute [rw] image_properties_annotation
|
666
|
+
# @return [::Google::Cloud::Vision::V1p4beta1::ImageProperties]
|
667
|
+
# If present, image properties were extracted successfully.
|
668
|
+
# @!attribute [rw] crop_hints_annotation
|
669
|
+
# @return [::Google::Cloud::Vision::V1p4beta1::CropHintsAnnotation]
|
670
|
+
# If present, crop hints have completed successfully.
|
671
|
+
# @!attribute [rw] web_detection
|
672
|
+
# @return [::Google::Cloud::Vision::V1p4beta1::WebDetection]
|
673
|
+
# If present, web detection has completed successfully.
|
674
|
+
# @!attribute [rw] product_search_results
|
675
|
+
# @return [::Google::Cloud::Vision::V1p4beta1::ProductSearchResults]
|
676
|
+
# If present, product search has completed successfully.
|
677
|
+
# @!attribute [rw] error
|
678
|
+
# @return [::Google::Rpc::Status]
|
679
|
+
# If set, represents the error message for the operation.
|
680
|
+
# Note that filled-in image annotations are guaranteed to be
|
681
|
+
# correct, even when `error` is set.
|
682
|
+
# @!attribute [rw] context
|
683
|
+
# @return [::Google::Cloud::Vision::V1p4beta1::ImageAnnotationContext]
|
684
|
+
# If present, contextual information is needed to understand where this image
|
685
|
+
# comes from.
|
686
|
+
class AnnotateImageResponse
|
687
|
+
include ::Google::Protobuf::MessageExts
|
688
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
689
|
+
end
|
690
|
+
|
691
|
+
# Multiple image annotation requests are batched into a single service call.
|
692
|
+
# @!attribute [rw] requests
|
693
|
+
# @return [::Array<::Google::Cloud::Vision::V1p4beta1::AnnotateImageRequest>]
|
694
|
+
# Required. Individual image annotation requests for this batch.
|
695
|
+
class BatchAnnotateImagesRequest
|
696
|
+
include ::Google::Protobuf::MessageExts
|
697
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
698
|
+
end
|
699
|
+
|
700
|
+
# Response to a batch image annotation request.
|
701
|
+
# @!attribute [rw] responses
|
702
|
+
# @return [::Array<::Google::Cloud::Vision::V1p4beta1::AnnotateImageResponse>]
|
703
|
+
# Individual responses to image annotation requests within the batch.
|
704
|
+
class BatchAnnotateImagesResponse
|
705
|
+
include ::Google::Protobuf::MessageExts
|
706
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
707
|
+
end
|
708
|
+
|
709
|
+
# A request to annotate one single file, e.g. a PDF, TIFF or GIF file.
|
710
|
+
# @!attribute [rw] input_config
|
711
|
+
# @return [::Google::Cloud::Vision::V1p4beta1::InputConfig]
|
712
|
+
# Required. Information about the input file.
|
713
|
+
# @!attribute [rw] features
|
714
|
+
# @return [::Array<::Google::Cloud::Vision::V1p4beta1::Feature>]
|
715
|
+
# Required. Requested features.
|
716
|
+
# @!attribute [rw] image_context
|
717
|
+
# @return [::Google::Cloud::Vision::V1p4beta1::ImageContext]
|
718
|
+
# Additional context that may accompany the image(s) in the file.
|
719
|
+
# @!attribute [rw] pages
|
720
|
+
# @return [::Array<::Integer>]
|
721
|
+
# Pages of the file to perform image annotation.
|
722
|
+
#
|
723
|
+
# Pages starts from 1, we assume the first page of the file is page 1.
|
724
|
+
# At most 5 pages are supported per request. Pages can be negative.
|
725
|
+
#
|
726
|
+
# Page 1 means the first page.
|
727
|
+
# Page 2 means the second page.
|
728
|
+
# Page -1 means the last page.
|
729
|
+
# Page -2 means the second to the last page.
|
730
|
+
#
|
731
|
+
# If the file is GIF instead of PDF or TIFF, page refers to GIF frames.
|
732
|
+
#
|
733
|
+
# If this field is empty, by default the service performs image annotation
|
734
|
+
# for the first 5 pages of the file.
|
735
|
+
class AnnotateFileRequest
|
736
|
+
include ::Google::Protobuf::MessageExts
|
737
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
738
|
+
end
|
739
|
+
|
740
|
+
# Response to a single file annotation request. A file may contain one or more
|
741
|
+
# images, which individually have their own responses.
|
742
|
+
# @!attribute [rw] input_config
|
743
|
+
# @return [::Google::Cloud::Vision::V1p4beta1::InputConfig]
|
744
|
+
# Information about the file for which this response is generated.
|
745
|
+
# @!attribute [rw] responses
|
746
|
+
# @return [::Array<::Google::Cloud::Vision::V1p4beta1::AnnotateImageResponse>]
|
747
|
+
# Individual responses to images found within the file. This field will be
|
748
|
+
# empty if the `error` field is set.
|
749
|
+
# @!attribute [rw] total_pages
|
750
|
+
# @return [::Integer]
|
751
|
+
# This field gives the total number of pages in the file.
|
752
|
+
# @!attribute [rw] error
|
753
|
+
# @return [::Google::Rpc::Status]
|
754
|
+
# If set, represents the error message for the failed request. The
|
755
|
+
# `responses` field will not be set in this case.
|
756
|
+
class AnnotateFileResponse
|
757
|
+
include ::Google::Protobuf::MessageExts
|
758
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
759
|
+
end
|
760
|
+
|
761
|
+
# A list of requests to annotate files using the BatchAnnotateFiles API.
|
762
|
+
# @!attribute [rw] requests
|
763
|
+
# @return [::Array<::Google::Cloud::Vision::V1p4beta1::AnnotateFileRequest>]
|
764
|
+
# Required. The list of file annotation requests. Right now we support only
|
765
|
+
# one AnnotateFileRequest in BatchAnnotateFilesRequest.
|
766
|
+
class BatchAnnotateFilesRequest
|
767
|
+
include ::Google::Protobuf::MessageExts
|
768
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
769
|
+
end
|
770
|
+
|
771
|
+
# A list of file annotation responses.
|
772
|
+
# @!attribute [rw] responses
|
773
|
+
# @return [::Array<::Google::Cloud::Vision::V1p4beta1::AnnotateFileResponse>]
|
774
|
+
# The list of file annotation responses, each response corresponding to each
|
775
|
+
# AnnotateFileRequest in BatchAnnotateFilesRequest.
|
776
|
+
class BatchAnnotateFilesResponse
|
777
|
+
include ::Google::Protobuf::MessageExts
|
778
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
779
|
+
end
|
780
|
+
|
781
|
+
# An offline file annotation request.
|
782
|
+
# @!attribute [rw] input_config
|
783
|
+
# @return [::Google::Cloud::Vision::V1p4beta1::InputConfig]
|
784
|
+
# Required. Information about the input file.
|
785
|
+
# @!attribute [rw] features
|
786
|
+
# @return [::Array<::Google::Cloud::Vision::V1p4beta1::Feature>]
|
787
|
+
# Required. Requested features.
|
788
|
+
# @!attribute [rw] image_context
|
789
|
+
# @return [::Google::Cloud::Vision::V1p4beta1::ImageContext]
|
790
|
+
# Additional context that may accompany the image(s) in the file.
|
791
|
+
# @!attribute [rw] output_config
|
792
|
+
# @return [::Google::Cloud::Vision::V1p4beta1::OutputConfig]
|
793
|
+
# Required. The desired output location and metadata (e.g. format).
|
794
|
+
class AsyncAnnotateFileRequest
|
795
|
+
include ::Google::Protobuf::MessageExts
|
796
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
797
|
+
end
|
798
|
+
|
799
|
+
# The response for a single offline file annotation request.
|
800
|
+
# @!attribute [rw] output_config
|
801
|
+
# @return [::Google::Cloud::Vision::V1p4beta1::OutputConfig]
|
802
|
+
# The output location and metadata from AsyncAnnotateFileRequest.
|
803
|
+
class AsyncAnnotateFileResponse
|
804
|
+
include ::Google::Protobuf::MessageExts
|
805
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
806
|
+
end
|
807
|
+
|
808
|
+
# Request for async image annotation for a list of images.
|
809
|
+
# @!attribute [rw] requests
|
810
|
+
# @return [::Array<::Google::Cloud::Vision::V1p4beta1::AnnotateImageRequest>]
|
811
|
+
# Required. Individual image annotation requests for this batch.
|
812
|
+
# @!attribute [rw] output_config
|
813
|
+
# @return [::Google::Cloud::Vision::V1p4beta1::OutputConfig]
|
814
|
+
# Required. The desired output location and metadata (e.g. format).
|
815
|
+
class AsyncBatchAnnotateImagesRequest
|
816
|
+
include ::Google::Protobuf::MessageExts
|
817
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
818
|
+
end
|
819
|
+
|
820
|
+
# Response to an async batch image annotation request.
|
821
|
+
# @!attribute [rw] output_config
|
822
|
+
# @return [::Google::Cloud::Vision::V1p4beta1::OutputConfig]
|
823
|
+
# The output location and metadata from AsyncBatchAnnotateImagesRequest.
|
824
|
+
class AsyncBatchAnnotateImagesResponse
|
825
|
+
include ::Google::Protobuf::MessageExts
|
826
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
827
|
+
end
|
828
|
+
|
829
|
+
# Multiple async file annotation requests are batched into a single service
|
830
|
+
# call.
|
831
|
+
# @!attribute [rw] requests
|
832
|
+
# @return [::Array<::Google::Cloud::Vision::V1p4beta1::AsyncAnnotateFileRequest>]
|
833
|
+
# Required. Individual async file annotation requests for this batch.
|
834
|
+
class AsyncBatchAnnotateFilesRequest
|
835
|
+
include ::Google::Protobuf::MessageExts
|
836
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
837
|
+
end
|
838
|
+
|
839
|
+
# Response to an async batch file annotation request.
|
840
|
+
# @!attribute [rw] responses
|
841
|
+
# @return [::Array<::Google::Cloud::Vision::V1p4beta1::AsyncAnnotateFileResponse>]
|
842
|
+
# The list of file annotation responses, one for each request in
|
843
|
+
# AsyncBatchAnnotateFilesRequest.
|
844
|
+
class AsyncBatchAnnotateFilesResponse
|
845
|
+
include ::Google::Protobuf::MessageExts
|
846
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
847
|
+
end
|
848
|
+
|
849
|
+
# The desired input location and metadata.
|
850
|
+
# @!attribute [rw] gcs_source
|
851
|
+
# @return [::Google::Cloud::Vision::V1p4beta1::GcsSource]
|
852
|
+
# The Google Cloud Storage location to read the input from.
|
853
|
+
# @!attribute [rw] content
|
854
|
+
# @return [::String]
|
855
|
+
# File content, represented as a stream of bytes.
|
856
|
+
# Note: As with all `bytes` fields, protobuffers use a pure binary
|
857
|
+
# representation, whereas JSON representations use base64.
|
858
|
+
#
|
859
|
+
# Currently, this field only works for BatchAnnotateFiles requests. It does
|
860
|
+
# not work for AsyncBatchAnnotateFiles requests.
|
861
|
+
# @!attribute [rw] mime_type
|
862
|
+
# @return [::String]
|
863
|
+
# The type of the file. Currently only "application/pdf", "image/tiff" and
|
864
|
+
# "image/gif" are supported. Wildcards are not supported.
|
865
|
+
class InputConfig
|
866
|
+
include ::Google::Protobuf::MessageExts
|
867
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
868
|
+
end
|
869
|
+
|
870
|
+
# The desired output location and metadata.
|
871
|
+
# @!attribute [rw] gcs_destination
|
872
|
+
# @return [::Google::Cloud::Vision::V1p4beta1::GcsDestination]
|
873
|
+
# The Google Cloud Storage location to write the output(s) to.
|
874
|
+
# @!attribute [rw] batch_size
|
875
|
+
# @return [::Integer]
|
876
|
+
# The max number of response protos to put into each output JSON file on
|
877
|
+
# Google Cloud Storage.
|
878
|
+
# The valid range is [1, 100]. If not specified, the default value is 20.
|
879
|
+
#
|
880
|
+
# For example, for one pdf file with 100 pages, 100 response protos will
|
881
|
+
# be generated. If `batch_size` = 20, then 5 json files each
|
882
|
+
# containing 20 response protos will be written under the prefix
|
883
|
+
# `gcs_destination`.`uri`.
|
884
|
+
#
|
885
|
+
# Currently, batch_size only applies to GcsDestination, with potential future
|
886
|
+
# support for other output configurations.
|
887
|
+
class OutputConfig
|
888
|
+
include ::Google::Protobuf::MessageExts
|
889
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
890
|
+
end
|
891
|
+
|
892
|
+
# The Google Cloud Storage location where the input will be read from.
|
893
|
+
# @!attribute [rw] uri
|
894
|
+
# @return [::String]
|
895
|
+
# Google Cloud Storage URI for the input file. This must only be a
|
896
|
+
# Google Cloud Storage object. Wildcards are not currently supported.
|
897
|
+
class GcsSource
|
898
|
+
include ::Google::Protobuf::MessageExts
|
899
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
900
|
+
end
|
901
|
+
|
902
|
+
# The Google Cloud Storage location where the output will be written to.
|
903
|
+
# @!attribute [rw] uri
|
904
|
+
# @return [::String]
|
905
|
+
# Google Cloud Storage URI prefix where the results will be stored. Results
|
906
|
+
# will be in JSON format and preceded by its corresponding input URI prefix.
|
907
|
+
# This field can either represent a gcs file prefix or gcs directory. In
|
908
|
+
# either case, the uri should be unique because in order to get all of the
|
909
|
+
# output files, you will need to do a wildcard gcs search on the uri prefix
|
910
|
+
# you provide.
|
911
|
+
#
|
912
|
+
# Examples:
|
913
|
+
#
|
914
|
+
# * File Prefix: gs://bucket-name/here/filenameprefix The output files
|
915
|
+
# will be created in gs://bucket-name/here/ and the names of the
|
916
|
+
# output files will begin with "filenameprefix".
|
917
|
+
#
|
918
|
+
# * Directory Prefix: gs://bucket-name/some/location/ The output files
|
919
|
+
# will be created in gs://bucket-name/some/location/ and the names of the
|
920
|
+
# output files could be anything because there was no filename prefix
|
921
|
+
# specified.
|
922
|
+
#
|
923
|
+
# If multiple outputs, each response is still AnnotateFileResponse, each of
|
924
|
+
# which contains some subset of the full list of AnnotateImageResponse.
|
925
|
+
# Multiple outputs can happen if, for example, the output JSON is too large
|
926
|
+
# and overflows into multiple sharded files.
|
927
|
+
class GcsDestination
|
928
|
+
include ::Google::Protobuf::MessageExts
|
929
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
930
|
+
end
|
931
|
+
|
932
|
+
# Contains metadata for the BatchAnnotateImages operation.
|
933
|
+
# @!attribute [rw] state
|
934
|
+
# @return [::Google::Cloud::Vision::V1p4beta1::OperationMetadata::State]
|
935
|
+
# Current state of the batch operation.
|
936
|
+
# @!attribute [rw] create_time
|
937
|
+
# @return [::Google::Protobuf::Timestamp]
|
938
|
+
# The time when the batch request was received.
|
939
|
+
# @!attribute [rw] update_time
|
940
|
+
# @return [::Google::Protobuf::Timestamp]
|
941
|
+
# The time when the operation result was last updated.
|
942
|
+
class OperationMetadata
|
943
|
+
include ::Google::Protobuf::MessageExts
|
944
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
945
|
+
|
946
|
+
# Batch operation states.
|
947
|
+
module State
|
948
|
+
# Invalid.
|
949
|
+
STATE_UNSPECIFIED = 0
|
950
|
+
|
951
|
+
# Request is received.
|
952
|
+
CREATED = 1
|
953
|
+
|
954
|
+
# Request is actively being processed.
|
955
|
+
RUNNING = 2
|
956
|
+
|
957
|
+
# The batch processing is done.
|
958
|
+
DONE = 3
|
959
|
+
|
960
|
+
# The batch processing was cancelled.
|
961
|
+
CANCELLED = 4
|
962
|
+
end
|
963
|
+
end
|
964
|
+
|
965
|
+
# A bucketized representation of likelihood, which is intended to give clients
|
966
|
+
# highly stable results across model upgrades.
|
967
|
+
module Likelihood
|
968
|
+
# Unknown likelihood.
|
969
|
+
UNKNOWN = 0
|
970
|
+
|
971
|
+
# It is very unlikely.
|
972
|
+
VERY_UNLIKELY = 1
|
973
|
+
|
974
|
+
# It is unlikely.
|
975
|
+
UNLIKELY = 2
|
976
|
+
|
977
|
+
# It is possible.
|
978
|
+
POSSIBLE = 3
|
979
|
+
|
980
|
+
# It is likely.
|
981
|
+
LIKELY = 4
|
982
|
+
|
983
|
+
# It is very likely.
|
984
|
+
VERY_LIKELY = 5
|
985
|
+
end
|
986
|
+
end
|
987
|
+
end
|
988
|
+
end
|
989
|
+
end
|