1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="vision_v1.html">Cloud Vision API</a> . <a href="vision_v1.projects.html">projects</a> . <a href="vision_v1.projects.locations.html">locations</a> . <a href="vision_v1.projects.locations.products.html">products</a> . <a href="vision_v1.projects.locations.products.referenceImages.html">referenceImages</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#create">create(parent, body, referenceImageId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates and returns a new ReferenceImage resource.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Permanently deletes a reference image.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets information associated with a ReferenceImage.</p>
<p class="toc_element">
<code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists reference images.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="create">create(parent, body, referenceImageId=None, x__xgafv=None)</code>
<pre>Creates and returns a new ReferenceImage resource.
The `bounding_poly` field is optional. If `bounding_poly` is not specified,
the system will try to detect regions of interest in the image that are
compatible with the product_category on the parent product. If it is
specified, detection is ALWAYS skipped. The system converts polygons into
non-rotated rectangles.
Note that the pipeline will resize the image if the image resolution is too
large to process (above 50MP).
Possible errors:
* Returns INVALID_ARGUMENT if the image_uri is missing or longer than 4096
characters.
* Returns INVALID_ARGUMENT if the product does not exist.
* Returns INVALID_ARGUMENT if bounding_poly is not provided, and nothing
compatible with the parent product's product_category is detected.
* Returns INVALID_ARGUMENT if bounding_poly contains more than 10 polygons.
Args:
parent: string, Resource name of the product in which to create the reference image.
Format is
`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. (required)
body: object, The request body. (required)
The object takes the form of:
{ # A `ReferenceImage` represents a product image and its associated metadata,
# such as bounding boxes.
"boundingPolys": [ # Bounding polygons around the areas of interest in the reference image.
# Optional. If this field is empty, the system will try to detect regions of
# interest. At most 10 bounding polygons will be used.
#
# The provided shape is converted into a non-rotated rectangle. Once
# converted, the small edge of the rectangle must be greater than or equal
# to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5
# is not).
{ # A bounding polygon for the detected image annotation.
"normalizedVertices": [ # The bounding polygon normalized vertices.
{ # A vertex represents a 2D point in the image.
# NOTE: the normalized vertex coordinates are relative to the original image
# and range from 0 to 1.
"y": 3.14, # Y coordinate.
"x": 3.14, # X coordinate.
},
],
"vertices": [ # The bounding polygon vertices.
{ # A vertex represents a 2D point in the image.
# NOTE: the vertex coordinates are in the same scale as the original image.
"y": 42, # Y coordinate.
"x": 42, # X coordinate.
},
],
},
],
"name": "A String", # The resource name of the reference image.
#
# Format is:
#
# `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`.
#
# This field is ignored when creating a reference image.
"uri": "A String", # The Google Cloud Storage URI of the reference image.
#
# The URI must start with `gs://`.
#
# Required.
}
referenceImageId: string, A user-supplied resource id for the ReferenceImage to be added. If set,
the server will attempt to use this value as the resource id. If it is
already in use, an error is returned with code ALREADY_EXISTS. Must be at
most 128 characters long. It cannot contain the character `/`.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A `ReferenceImage` represents a product image and its associated metadata,
# such as bounding boxes.
"boundingPolys": [ # Bounding polygons around the areas of interest in the reference image.
# Optional. If this field is empty, the system will try to detect regions of
# interest. At most 10 bounding polygons will be used.
#
# The provided shape is converted into a non-rotated rectangle. Once
# converted, the small edge of the rectangle must be greater than or equal
# to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5
# is not).
{ # A bounding polygon for the detected image annotation.
"normalizedVertices": [ # The bounding polygon normalized vertices.
{ # A vertex represents a 2D point in the image.
# NOTE: the normalized vertex coordinates are relative to the original image
# and range from 0 to 1.
"y": 3.14, # Y coordinate.
"x": 3.14, # X coordinate.
},
],
"vertices": [ # The bounding polygon vertices.
{ # A vertex represents a 2D point in the image.
# NOTE: the vertex coordinates are in the same scale as the original image.
"y": 42, # Y coordinate.
"x": 42, # X coordinate.
},
],
},
],
"name": "A String", # The resource name of the reference image.
#
# Format is:
#
# `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`.
#
# This field is ignored when creating a reference image.
"uri": "A String", # The Google Cloud Storage URI of the reference image.
#
# The URI must start with `gs://`.
#
# Required.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
<pre>Permanently deletes a reference image.
The image metadata will be deleted right away, but search queries
against ProductSets containing the image may still work until all related
caches are refreshed.
The actual image files are not deleted from Google Cloud Storage.
Args:
name: string, The resource name of the reference image to delete.
Format is:
`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A generic empty message that you can re-use to avoid defining duplicated
# empty messages in your APIs. A typical example is to use it as the request
# or the response type of an API method. For instance:
#
# service Foo {
# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
# }
#
# The JSON representation for `Empty` is empty JSON object `{}`.
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Gets information associated with a ReferenceImage.
Possible errors:
* Returns NOT_FOUND if the specified image does not exist.
Args:
name: string, The resource name of the ReferenceImage to get.
Format is:
`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A `ReferenceImage` represents a product image and its associated metadata,
# such as bounding boxes.
"boundingPolys": [ # Bounding polygons around the areas of interest in the reference image.
# Optional. If this field is empty, the system will try to detect regions of
# interest. At most 10 bounding polygons will be used.
#
# The provided shape is converted into a non-rotated rectangle. Once
# converted, the small edge of the rectangle must be greater than or equal
# to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5
# is not).
{ # A bounding polygon for the detected image annotation.
"normalizedVertices": [ # The bounding polygon normalized vertices.
{ # A vertex represents a 2D point in the image.
# NOTE: the normalized vertex coordinates are relative to the original image
# and range from 0 to 1.
"y": 3.14, # Y coordinate.
"x": 3.14, # X coordinate.
},
],
"vertices": [ # The bounding polygon vertices.
{ # A vertex represents a 2D point in the image.
# NOTE: the vertex coordinates are in the same scale as the original image.
"y": 42, # Y coordinate.
"x": 42, # X coordinate.
},
],
},
],
"name": "A String", # The resource name of the reference image.
#
# Format is:
#
# `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`.
#
# This field is ignored when creating a reference image.
"uri": "A String", # The Google Cloud Storage URI of the reference image.
#
# The URI must start with `gs://`.
#
# Required.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists reference images.
Possible errors:
* Returns NOT_FOUND if the parent product does not exist.
* Returns INVALID_ARGUMENT if the page_size is greater than 100, or less
than 1.
Args:
parent: string, Resource name of the product containing the reference images.
Format is
`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. (required)
pageSize: integer, The maximum number of items to return. Default 10, maximum 100.
pageToken: string, A token identifying a page of results to be returned. This is the value
of `nextPageToken` returned in a previous reference image list request.
Defaults to the first page if not specified.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for the `ListReferenceImages` method.
"nextPageToken": "A String", # The next_page_token returned from a previous List request, if any.
"pageSize": 42, # The maximum number of items to return. Default 10, maximum 100.
"referenceImages": [ # The list of reference images.
{ # A `ReferenceImage` represents a product image and its associated metadata,
# such as bounding boxes.
"boundingPolys": [ # Bounding polygons around the areas of interest in the reference image.
# Optional. If this field is empty, the system will try to detect regions of
# interest. At most 10 bounding polygons will be used.
#
# The provided shape is converted into a non-rotated rectangle. Once
# converted, the small edge of the rectangle must be greater than or equal
# to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5
# is not).
{ # A bounding polygon for the detected image annotation.
"normalizedVertices": [ # The bounding polygon normalized vertices.
{ # A vertex represents a 2D point in the image.
# NOTE: the normalized vertex coordinates are relative to the original image
# and range from 0 to 1.
"y": 3.14, # Y coordinate.
"x": 3.14, # X coordinate.
},
],
"vertices": [ # The bounding polygon vertices.
{ # A vertex represents a 2D point in the image.
# NOTE: the vertex coordinates are in the same scale as the original image.
"y": 42, # Y coordinate.
"x": 42, # X coordinate.
},
],
},
],
"name": "A String", # The resource name of the reference image.
#
# Format is:
#
# `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`.
#
# This field is ignored when creating a reference image.
"uri": "A String", # The Google Cloud Storage URI of the reference image.
#
# The URI must start with `gs://`.
#
# Required.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>
|
