Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(127)

Side by Side Diff: discovery/googleapis/vision__v1.json

Issue 2779563003: Api-roll 47: 2017-03-27 (Closed)
Patch Set: Created 3 years, 9 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch
« no previous file with comments | « discovery/googleapis/tracing__v1.json ('k') | discovery/googleapis/webmasters__v3.json » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
1 { 1 {
2 "auth": { 2 "auth": {
3 "oauth2": { 3 "oauth2": {
4 "scopes": { 4 "scopes": {
5 "https://www.googleapis.com/auth/cloud-platform": { 5 "https://www.googleapis.com/auth/cloud-platform": {
6 "description": "View and manage your data across Google Clou d Platform services" 6 "description": "View and manage your data across Google Clou d Platform services"
7 } 7 }
8 } 8 }
9 } 9 }
10 }, 10 },
11 "basePath": "", 11 "basePath": "",
12 "baseUrl": "https://vision.googleapis.com/", 12 "baseUrl": "https://vision.googleapis.com/",
13 "batchPath": "batch", 13 "batchPath": "batch",
14 "canonicalName": "Vision", 14 "canonicalName": "Vision",
15 "description": "Integrates Google Vision features, including image labeling, face, logo, and landmark detection, optical character recognition (OCR), and de tection of explicit content, into applications.", 15 "description": "Integrates Google Vision features, including image labeling, face, logo, and landmark detection, optical character recognition (OCR), and de tection of explicit content, into applications.",
16 "discoveryVersion": "v1", 16 "discoveryVersion": "v1",
17 "documentationLink": "https://cloud.google.com/vision/", 17 "documentationLink": "https://cloud.google.com/vision/",
18 "icons": { 18 "icons": {
19 "x16": "http://www.google.com/images/icons/product/search-16.gif", 19 "x16": "http://www.google.com/images/icons/product/search-16.gif",
20 "x32": "http://www.google.com/images/icons/product/search-32.gif" 20 "x32": "http://www.google.com/images/icons/product/search-32.gif"
21 }, 21 },
22 "id": "vision:v1", 22 "id": "vision:v1",
23 "kind": "discovery#restDescription", 23 "kind": "discovery#restDescription",
24 "name": "vision", 24 "name": "vision",
25 "ownerDomain": "google.com", 25 "ownerDomain": "google.com",
26 "ownerName": "Google", 26 "ownerName": "Google",
27 "parameters": { 27 "parameters": {
28 "upload_protocol": {
29 "description": "Upload protocol for media (e.g. \"raw\", \"multipart \").",
30 "location": "query",
31 "type": "string"
32 },
33 "prettyPrint": {
34 "default": "true",
35 "description": "Returns response with indentations and line breaks." ,
36 "location": "query",
37 "type": "boolean"
38 },
39 "fields": {
40 "description": "Selector specifying which fields to include in a par tial response.",
41 "location": "query",
42 "type": "string"
43 },
44 "uploadType": {
45 "description": "Legacy upload protocol for media (e.g. \"media\", \" multipart\").",
46 "location": "query",
47 "type": "string"
48 },
28 "callback": { 49 "callback": {
29 "description": "JSONP", 50 "description": "JSONP",
30 "location": "query", 51 "location": "query",
31 "type": "string" 52 "type": "string"
32 }, 53 },
33 "$.xgafv": { 54 "$.xgafv": {
34 "description": "V1 error format.", 55 "description": "V1 error format.",
35 "enum": [ 56 "enum": [
36 "1", 57 "1",
37 "2" 58 "2"
(...skipping 14 matching lines...) Expand all
52 "proto" 73 "proto"
53 ], 74 ],
54 "enumDescriptions": [ 75 "enumDescriptions": [
55 "Responses with Content-Type of application/json", 76 "Responses with Content-Type of application/json",
56 "Media download with context-dependent Content-Type", 77 "Media download with context-dependent Content-Type",
57 "Responses with Content-Type of application/x-protobuf" 78 "Responses with Content-Type of application/x-protobuf"
58 ], 79 ],
59 "location": "query", 80 "location": "query",
60 "type": "string" 81 "type": "string"
61 }, 82 },
83 "key": {
84 "description": "API key. Your API key identifies your project and pr ovides you with API access, quota, and reports. Required unless you provide an O Auth 2.0 token.",
85 "location": "query",
86 "type": "string"
87 },
62 "access_token": { 88 "access_token": {
63 "description": "OAuth access token.", 89 "description": "OAuth access token.",
64 "location": "query", 90 "location": "query",
65 "type": "string" 91 "type": "string"
66 }, 92 },
67 "key": {
68 "description": "API key. Your API key identifies your project and pr ovides you with API access, quota, and reports. Required unless you provide an O Auth 2.0 token.",
69 "location": "query",
70 "type": "string"
71 },
72 "quotaUser": { 93 "quotaUser": {
73 "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exc eed 40 characters.", 94 "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exc eed 40 characters.",
74 "location": "query", 95 "location": "query",
75 "type": "string" 96 "type": "string"
76 }, 97 },
77 "pp": { 98 "pp": {
78 "default": "true", 99 "default": "true",
79 "description": "Pretty-print response.", 100 "description": "Pretty-print response.",
80 "location": "query", 101 "location": "query",
81 "type": "boolean" 102 "type": "boolean"
82 }, 103 },
83 "oauth_token": {
84 "description": "OAuth 2.0 token for the current user.",
85 "location": "query",
86 "type": "string"
87 },
88 "bearer_token": { 104 "bearer_token": {
89 "description": "OAuth bearer token.", 105 "description": "OAuth bearer token.",
90 "location": "query", 106 "location": "query",
91 "type": "string" 107 "type": "string"
92 }, 108 },
93 "upload_protocol": { 109 "oauth_token": {
94 "description": "Upload protocol for media (e.g. \"raw\", \"multipart \").", 110 "description": "OAuth 2.0 token for the current user.",
95 "location": "query",
96 "type": "string"
97 },
98 "prettyPrint": {
99 "default": "true",
100 "description": "Returns response with indentations and line breaks." ,
101 "location": "query",
102 "type": "boolean"
103 },
104 "fields": {
105 "description": "Selector specifying which fields to include in a par tial response.",
106 "location": "query",
107 "type": "string"
108 },
109 "uploadType": {
110 "description": "Legacy upload protocol for media (e.g. \"media\", \" multipart\").",
111 "location": "query", 111 "location": "query",
112 "type": "string" 112 "type": "string"
113 } 113 }
114 }, 114 },
115 "protocol": "rest", 115 "protocol": "rest",
116 "resources": { 116 "resources": {
117 "images": { 117 "images": {
118 "methods": { 118 "methods": {
119 "annotate": { 119 "annotate": {
120 "description": "Run image detection and annotation for a bat ch of images.", 120 "description": "Run image detection and annotation for a bat ch of images.",
121 "httpMethod": "POST", 121 "httpMethod": "POST",
122 "id": "vision.images.annotate", 122 "id": "vision.images.annotate",
123 "parameterOrder": [], 123 "parameterOrder": [],
124 "parameters": {}, 124 "parameters": {},
125 "path": "v1/images:annotate", 125 "path": "v1/images:annotate",
126 "request": { 126 "request": {
127 "$ref": "BatchAnnotateImagesRequest" 127 "$ref": "BatchAnnotateImagesRequest"
128 }, 128 },
129 "response": { 129 "response": {
130 "$ref": "BatchAnnotateImagesResponse" 130 "$ref": "BatchAnnotateImagesResponse"
131 }, 131 },
132 "scopes": [ 132 "scopes": [
133 "https://www.googleapis.com/auth/cloud-platform" 133 "https://www.googleapis.com/auth/cloud-platform"
134 ] 134 ]
135 } 135 }
136 } 136 }
137 } 137 }
138 }, 138 },
139 "revision": "20170301", 139 "revision": "20170321",
140 "rootUrl": "https://vision.googleapis.com/", 140 "rootUrl": "https://vision.googleapis.com/",
141 "schemas": { 141 "schemas": {
142 "ColorInfo": { 142 "CropHintsParams": {
143 "description": "Color information consists of RGB channels, score, a nd the fraction of\nthe image that the color occupies in the image.", 143 "description": "Parameters for crop hints annotation request.",
144 "id": "ColorInfo", 144 "id": "CropHintsParams",
145 "properties": { 145 "properties": {
146 "score": { 146 "aspectRatios": {
147 "description": "Image-specific score for this color. Value i n range [0, 1].", 147 "description": "Aspect ratios in floats, representing the ra tio of the width to the height\nof the image. For example, if the desired aspect ratio is 4/3, the\ncorresponding float value should be 1.33333. If not specifi ed, the\nbest possible crop is returned. The number of provided aspect ratios is \nlimited to a maximum of 16; any aspect ratios provided after the 16th are\nign ored.",
148 "items": {
149 "format": "float",
150 "type": "number"
151 },
152 "type": "array"
153 }
154 },
155 "type": "object"
156 },
157 "Block": {
158 "description": "Logical element on the page.",
159 "id": "Block",
160 "properties": {
161 "boundingBox": {
162 "$ref": "BoundingPoly",
163 "description": "The bounding box for the block.\nThe vertice s are in the order of top-left, top-right, bottom-right,\nbottom-left. When a ro tation of the bounding box is detected the rotation\nis represented as around th e top-left corner as defined when the text is\nread in the 'natural' orientation .\nFor example:\n * when the text is horizontal it might look like:\n 0---- 1\n | |\n 3----2\n * when it's rotated 180 degrees around the top-le ft corner it becomes:\n 2----3\n | |\n 1----0\n and the vertice order will still be (0, 1, 2, 3)."
164 },
165 "paragraphs": {
166 "description": "List of paragraphs in this block (if this bl ocks is of type text).",
167 "items": {
168 "$ref": "Paragraph"
169 },
170 "type": "array"
171 },
172 "property": {
173 "$ref": "TextProperty",
174 "description": "Additional information detected for the bloc k."
175 },
176 "blockType": {
177 "description": "Detected block type (text, image etc) for th is block.",
178 "enum": [
179 "UNKNOWN",
180 "TEXT",
181 "TABLE",
182 "PICTURE",
183 "RULER",
184 "BARCODE"
185 ],
186 "enumDescriptions": [
187 "Unknown block type.",
188 "Regular text block.",
189 "Table block.",
190 "Image block.",
191 "Horizontal/vertical line box.",
192 "Barcode block."
193 ],
194 "type": "string"
195 }
196 },
197 "type": "object"
198 },
199 "Property": {
200 "description": "A `Property` consists of a user-supplied name/value pair.",
201 "id": "Property",
202 "properties": {
203 "value": {
204 "description": "Value of the property.",
205 "type": "string"
206 },
207 "uint64Value": {
208 "description": "Value of numeric properties.",
209 "format": "uint64",
210 "type": "string"
211 },
212 "name": {
213 "description": "Name of the property.",
214 "type": "string"
215 }
216 },
217 "type": "object"
218 },
219 "LocationInfo": {
220 "description": "Detected entity location information.",
221 "id": "LocationInfo",
222 "properties": {
223 "latLng": {
224 "$ref": "LatLng",
225 "description": "lat/long location coordinates."
226 }
227 },
228 "type": "object"
229 },
230 "ImageSource": {
231 "description": "External image source (Google Cloud Storage image lo cation).",
232 "id": "ImageSource",
233 "properties": {
234 "gcsImageUri": {
235 "description": "NOTE: For new code `image_uri` below is pref erred.\nGoogle Cloud Storage image URI, which must be in the following form:\n`g s://bucket_name/object_name` (for details, see\n[Google Cloud Storage Request\nU RIs](https://cloud.google.com/storage/docs/reference-uris)).\nNOTE: Cloud Storag e object versioning is not supported.",
236 "type": "string"
237 },
238 "imageUri": {
239 "description": "Image URI which supports:\n1) Google Cloud S torage image URI, which must be in the following form:\n`gs://bucket_name/object _name` (for details, see\n[Google Cloud Storage Request\nURIs](https://cloud.goo gle.com/storage/docs/reference-uris)).\nNOTE: Cloud Storage object versioning is not supported.\n2) Publicly accessible image HTTP/HTTPS URL.\nThis is preferred over the legacy `gcs_image_uri` above. When both\n`gcs_image_uri` and `image_ur i` are specified, `image_uri` takes\nprecedence.",
240 "type": "string"
241 }
242 },
243 "type": "object"
244 },
245 "BatchAnnotateImagesResponse": {
246 "description": "Response to a batch image annotation request.",
247 "id": "BatchAnnotateImagesResponse",
248 "properties": {
249 "responses": {
250 "description": "Individual responses to image annotation req uests within the batch.",
251 "items": {
252 "$ref": "AnnotateImageResponse"
253 },
254 "type": "array"
255 }
256 },
257 "type": "object"
258 },
259 "WebDetection": {
260 "description": "Relevant information for the image from the Internet .",
261 "id": "WebDetection",
262 "properties": {
263 "partialMatchingImages": {
264 "description": "Partial matching images from the Internet.\n Those images are similar enough to share some key-point features. For\nexample a n original image will likely have partial matching for its crops.",
265 "items": {
266 "$ref": "WebImage"
267 },
268 "type": "array"
269 },
270 "visuallySimilarImages": {
271 "description": "The visually similar image results.",
272 "items": {
273 "$ref": "WebImage"
274 },
275 "type": "array"
276 },
277 "fullMatchingImages": {
278 "description": "Fully matching images from the Internet.\nTh ey're definite neardups and most often a copy of the query image with\nmerely a size change.",
279 "items": {
280 "$ref": "WebImage"
281 },
282 "type": "array"
283 },
284 "webEntities": {
285 "description": "Deduced entities from similar images on the Internet.",
286 "items": {
287 "$ref": "WebEntity"
288 },
289 "type": "array"
290 },
291 "pagesWithMatchingImages": {
292 "description": "Web pages containing the matching images fro m the Internet.",
293 "items": {
294 "$ref": "WebPage"
295 },
296 "type": "array"
297 }
298 },
299 "type": "object"
300 },
301 "Position": {
302 "description": "A 3D position in the image, used primarily for Face detection landmarks.\nA valid Position must have both x and y coordinates.\nThe position coordinates are in the same scale as the original image.",
303 "id": "Position",
304 "properties": {
305 "y": {
306 "description": "Y coordinate.",
148 "format": "float", 307 "format": "float",
149 "type": "number" 308 "type": "number"
150 }, 309 },
151 "pixelFraction": { 310 "x": {
152 "description": "The fraction of pixels the color occupies in the image.\nValue in range [0, 1].", 311 "description": "X coordinate.",
153 "format": "float", 312 "format": "float",
154 "type": "number" 313 "type": "number"
155 }, 314 },
156 "color": { 315 "z": {
157 "$ref": "Color", 316 "description": "Z coordinate (or depth).",
158 "description": "RGB components of the color." 317 "format": "float",
318 "type": "number"
159 } 319 }
160 }, 320 },
161 "type": "object" 321 "type": "object"
162 }, 322 },
163 "WebPage": { 323 "WebPage": {
164 "description": "Metadata for web pages.", 324 "description": "Metadata for web pages.",
165 "id": "WebPage", 325 "id": "WebPage",
166 "properties": { 326 "properties": {
167 "url": {
168 "description": "The result web page URL.",
169 "type": "string"
170 },
171 "score": { 327 "score": {
172 "description": "Overall relevancy score for the web page.\nN ot normalized and not comparable across different image queries.", 328 "description": "Overall relevancy score for the web page.\nN ot normalized and not comparable across different image queries.",
173 "format": "float", 329 "format": "float",
174 "type": "number" 330 "type": "number"
331 },
332 "url": {
333 "description": "The result web page URL.",
334 "type": "string"
175 } 335 }
336 },
337 "type": "object"
338 },
339 "ColorInfo": {
340 "description": "Color information consists of RGB channels, score, a nd the fraction of\nthe image that the color occupies in the image.",
341 "id": "ColorInfo",
342 "properties": {
343 "pixelFraction": {
344 "description": "The fraction of pixels the color occupies in the image.\nValue in range [0, 1].",
345 "format": "float",
346 "type": "number"
347 },
348 "color": {
349 "$ref": "Color",
350 "description": "RGB components of the color."
351 },
352 "score": {
353 "description": "Image-specific score for this color. Value i n range [0, 1].",
354 "format": "float",
355 "type": "number"
356 }
176 }, 357 },
177 "type": "object" 358 "type": "object"
178 }, 359 },
179 "EntityAnnotation": { 360 "EntityAnnotation": {
180 "description": "Set of detected entity features.", 361 "description": "Set of detected entity features.",
181 "id": "EntityAnnotation", 362 "id": "EntityAnnotation",
182 "properties": { 363 "properties": {
183 "score": {
184 "description": "Overall score of the result. Range [0, 1].",
185 "format": "float",
186 "type": "number"
187 },
188 "locations": {
189 "description": "The location information for the detected en tity. Multiple\n`LocationInfo` elements can be present because one location may\ nindicate the location of the scene in the image, and another location\nmay indi cate the location of the place where the image was taken.\nLocation information is usually present for landmarks.",
190 "items": {
191 "$ref": "LocationInfo"
192 },
193 "type": "array"
194 },
195 "mid": {
196 "description": "Opaque entity ID. Some IDs may be available in\n[Google Knowledge Graph Search API](https://developers.google.com/knowledge- graph/).",
197 "type": "string"
198 },
199 "confidence": { 364 "confidence": {
200 "description": "The accuracy of the entity detection in an i mage.\nFor example, for an image in which the \"Eiffel Tower\" entity is detecte d,\nthis field represents the confidence that there is a tower in the query\nima ge. Range [0, 1].", 365 "description": "The accuracy of the entity detection in an i mage.\nFor example, for an image in which the \"Eiffel Tower\" entity is detecte d,\nthis field represents the confidence that there is a tower in the query\nima ge. Range [0, 1].",
201 "format": "float", 366 "format": "float",
202 "type": "number" 367 "type": "number"
203 }, 368 },
204 "locale": { 369 "locale": {
205 "description": "The language code for the locale in which th e entity textual\n`description` is expressed.", 370 "description": "The language code for the locale in which th e entity textual\n`description` is expressed.",
206 "type": "string" 371 "type": "string"
207 }, 372 },
208 "boundingPoly": { 373 "boundingPoly": {
209 "$ref": "BoundingPoly", 374 "$ref": "BoundingPoly",
210 "description": "Image region to which this entity belongs. C urrently not produced\nfor `LABEL_DETECTION` features. For `TEXT_DETECTION` (OCR ), `boundingPoly`s\nare produced for the entire text detected in an image region , followed by\n`boundingPoly`s for each word within the detected text." 375 "description": "Image region to which this entity belongs. C urrently not produced\nfor `LABEL_DETECTION` features. For `TEXT_DETECTION` (OCR ), `boundingPoly`s\nare produced for the entire text detected in an image region , followed by\n`boundingPoly`s for each word within the detected text."
211 }, 376 },
377 "description": {
378 "description": "Entity textual description, expressed in its `locale` language.",
379 "type": "string"
380 },
212 "topicality": { 381 "topicality": {
213 "description": "The relevancy of the ICA (Image Content Anno tation) label to the\nimage. For example, the relevancy of \"tower\" is likely h igher to an image\ncontaining the detected \"Eiffel Tower\" than to an image con taining a\ndetected distant towering building, even though the confidence that\n there is a tower in each image may be the same. Range [0, 1].", 382 "description": "The relevancy of the ICA (Image Content Anno tation) label to the\nimage. For example, the relevancy of \"tower\" is likely h igher to an image\ncontaining the detected \"Eiffel Tower\" than to an image con taining a\ndetected distant towering building, even though the confidence that\n there is a tower in each image may be the same. Range [0, 1].",
214 "format": "float", 383 "format": "float",
215 "type": "number" 384 "type": "number"
216 }, 385 },
217 "description": {
218 "description": "Entity textual description, expressed in its `locale` language.",
219 "type": "string"
220 },
221 "properties": { 386 "properties": {
222 "description": "Some entities may have optional user-supplie d `Property` (name/value)\nfields, such a score or string that qualifies the ent ity.", 387 "description": "Some entities may have optional user-supplie d `Property` (name/value)\nfields, such a score or string that qualifies the ent ity.",
223 "items": { 388 "items": {
224 "$ref": "Property" 389 "$ref": "Property"
225 }, 390 },
226 "type": "array" 391 "type": "array"
392 },
393 "score": {
394 "description": "Overall score of the result. Range [0, 1].",
395 "format": "float",
396 "type": "number"
397 },
398 "locations": {
399 "description": "The location information for the detected en tity. Multiple\n`LocationInfo` elements can be present because one location may\ nindicate the location of the scene in the image, and another location\nmay indi cate the location of the place where the image was taken.\nLocation information is usually present for landmarks.",
400 "items": {
401 "$ref": "LocationInfo"
402 },
403 "type": "array"
404 },
405 "mid": {
406 "description": "Opaque entity ID. Some IDs may be available in\n[Google Knowledge Graph Search API](https://developers.google.com/knowledge- graph/).",
407 "type": "string"
227 } 408 }
228 }, 409 },
229 "type": "object" 410 "type": "object"
230 }, 411 },
231 "CropHint": { 412 "CropHint": {
232 "description": "Single crop hint that is used to generate a new crop when serving an image.", 413 "description": "Single crop hint that is used to generate a new crop when serving an image.",
233 "id": "CropHint", 414 "id": "CropHint",
234 "properties": { 415 "properties": {
235 "boundingPoly": {
236 "$ref": "BoundingPoly",
237 "description": "The bounding polygon for the crop region. Th e coordinates of the bounding\nbox are in the original image's scale, as returne d in `ImageParams`."
238 },
239 "confidence": { 416 "confidence": {
240 "description": "Confidence of this being a salient region. Range [0, 1].", 417 "description": "Confidence of this being a salient region. Range [0, 1].",
241 "format": "float", 418 "format": "float",
242 "type": "number" 419 "type": "number"
243 }, 420 },
244 "importanceFraction": { 421 "importanceFraction": {
245 "description": "Fraction of importance of this salient regio n with respect to the original\nimage.", 422 "description": "Fraction of importance of this salient regio n with respect to the original\nimage.",
246 "format": "float", 423 "format": "float",
247 "type": "number" 424 "type": "number"
425 },
426 "boundingPoly": {
427 "$ref": "BoundingPoly",
428 "description": "The bounding polygon for the crop region. Th e coordinates of the bounding\nbox are in the original image's scale, as returne d in `ImageParams`."
248 } 429 }
249 }, 430 },
250 "type": "object" 431 "type": "object"
251 }, 432 },
252 "Landmark": { 433 "Landmark": {
253 "description": "A face-specific landmark (for example, a face featur e).\nLandmark positions may fall outside the bounds of the image\nif the face is near one or more edges of the image.\nTherefore it is NOT guaranteed that `0 <= x < width` or\n`0 <= y < height`.", 434 "description": "A face-specific landmark (for example, a face featur e).\nLandmark positions may fall outside the bounds of the image\nif the face is near one or more edges of the image.\nTherefore it is NOT guaranteed that `0 <= x < width` or\n`0 <= y < height`.",
254 "id": "Landmark", 435 "id": "Landmark",
255 "properties": { 436 "properties": {
256 "type": { 437 "type": {
257 "description": "Face landmark type.", 438 "description": "Face landmark type.",
(...skipping 111 matching lines...) Expand 10 before | Expand all | Expand 10 after
369 "symbols": { 550 "symbols": {
370 "description": "List of symbols in the word.\nThe order of t he symbols follows the natural reading order.", 551 "description": "List of symbols in the word.\nThe order of t he symbols follows the natural reading order.",
371 "items": { 552 "items": {
372 "$ref": "Symbol" 553 "$ref": "Symbol"
373 }, 554 },
374 "type": "array" 555 "type": "array"
375 } 556 }
376 }, 557 },
377 "type": "object" 558 "type": "object"
378 }, 559 },
379 "Image": {
380 "description": "Client image to perform Google Cloud Vision API task s over.",
381 "id": "Image",
382 "properties": {
383 "content": {
384 "description": "Image content, represented as a stream of by tes.\nNote: as with all `bytes` fields, protobuffers use a pure binary\nrepresen tation, whereas JSON representations use base64.",
385 "format": "byte",
386 "type": "string"
387 },
388 "source": {
389 "$ref": "ImageSource",
390 "description": "Google Cloud Storage image location. If both `content` and `source`\nare provided for an image, `content` takes precedence a nd is\nused to perform the image annotation request."
391 }
392 },
393 "type": "object"
394 },
395 "Paragraph": { 560 "Paragraph": {
396 "description": "Structural unit of text representing a number of wor ds in certain order.", 561 "description": "Structural unit of text representing a number of wor ds in certain order.",
397 "id": "Paragraph", 562 "id": "Paragraph",
398 "properties": { 563 "properties": {
399 "property": {
400 "$ref": "TextProperty",
401 "description": "Additional information detected for the para graph."
402 },
403 "boundingBox": { 564 "boundingBox": {
404 "$ref": "BoundingPoly", 565 "$ref": "BoundingPoly",
405 "description": "The bounding box for the paragraph.\nThe ver tices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as aroun d the top-left corner as defined when the text is\nread in the 'natural' orienta tion.\nFor example:\n * when the text is horizontal it might look like:\n 0 ----1\n | |\n 3----2\n * when it's rotated 180 degrees around the to p-left corner it becomes:\n 2----3\n | |\n 1----0\n and the vert ice order will still be (0, 1, 2, 3)." 566 "description": "The bounding box for the paragraph.\nThe ver tices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as aroun d the top-left corner as defined when the text is\nread in the 'natural' orienta tion.\nFor example:\n * when the text is horizontal it might look like:\n 0 ----1\n | |\n 3----2\n * when it's rotated 180 degrees around the to p-left corner it becomes:\n 2----3\n | |\n 1----0\n and the vert ice order will still be (0, 1, 2, 3)."
406 }, 567 },
407 "words": { 568 "words": {
408 "description": "List of words in this paragraph.", 569 "description": "List of words in this paragraph.",
409 "items": { 570 "items": {
410 "$ref": "Word" 571 "$ref": "Word"
411 }, 572 },
412 "type": "array" 573 "type": "array"
574 },
575 "property": {
576 "$ref": "TextProperty",
577 "description": "Additional information detected for the para graph."
413 } 578 }
414 }, 579 },
415 "type": "object" 580 "type": "object"
581 },
582 "Image": {
583 "description": "Client image to perform Google Cloud Vision API task s over.",
584 "id": "Image",
585 "properties": {
586 "content": {
587 "description": "Image content, represented as a stream of by tes.\nNote: as with all `bytes` fields, protobuffers use a pure binary\nrepresen tation, whereas JSON representations use base64.",
588 "format": "byte",
589 "type": "string"
590 },
591 "source": {
592 "$ref": "ImageSource",
593 "description": "Google Cloud Storage image location. If both `content` and `source`\nare provided for an image, `content` takes precedence a nd is\nused to perform the image annotation request."
594 }
595 },
596 "type": "object"
416 }, 597 },
417 "FaceAnnotation": { 598 "FaceAnnotation": {
418 "description": "A face annotation object contains the results of fac e detection.", 599 "description": "A face annotation object contains the results of fac e detection.",
419 "id": "FaceAnnotation", 600 "id": "FaceAnnotation",
420 "properties": { 601 "properties": {
421 "underExposedLikelihood": { 602 "sorrowLikelihood": {
422 "description": "Under-exposed likelihood.", 603 "description": "Sorrow likelihood.",
423 "enum": [ 604 "enum": [
424 "UNKNOWN", 605 "UNKNOWN",
425 "VERY_UNLIKELY", 606 "VERY_UNLIKELY",
426 "UNLIKELY", 607 "UNLIKELY",
427 "POSSIBLE", 608 "POSSIBLE",
428 "LIKELY", 609 "LIKELY",
429 "VERY_LIKELY" 610 "VERY_LIKELY"
430 ], 611 ],
431 "enumDescriptions": [ 612 "enumDescriptions": [
432 "Unknown likelihood.", 613 "Unknown likelihood.",
433 "It is very unlikely that the image belongs to the speci fied vertical.", 614 "It is very unlikely that the image belongs to the speci fied vertical.",
434 "It is unlikely that the image belongs to the specified vertical.", 615 "It is unlikely that the image belongs to the specified vertical.",
435 "It is possible that the image belongs to the specified vertical.", 616 "It is possible that the image belongs to the specified vertical.",
436 "It is likely that the image belongs to the specified ve rtical.", 617 "It is likely that the image belongs to the specified ve rtical.",
437 "It is very likely that the image belongs to the specifi ed vertical." 618 "It is very likely that the image belongs to the specifi ed vertical."
438 ], 619 ],
439 "type": "string" 620 "type": "string"
440 }, 621 },
441 "panAngle": { 622 "tiltAngle": {
442 "description": "Yaw angle, which indicates the leftward/righ tward angle that the face is\npointing relative to the vertical plane perpendicu lar to the image. Range\n[-180,180].", 623 "description": "Pitch angle, which indicates the upwards/dow nwards angle that the face is\npointing relative to the image's horizontal plane . Range [-180,180].",
443 "format": "float", 624 "format": "float",
444 "type": "number" 625 "type": "number"
445 }, 626 },
446 "detectionConfidence": { 627 "fdBoundingPoly": {
447 "description": "Detection confidence. Range [0, 1].", 628 "$ref": "BoundingPoly",
448 "format": "float", 629 "description": "The `fd_bounding_poly` bounding polygon is t ighter than the\n`boundingPoly`, and encloses only the skin part of the face. Ty pically, it\nis used to eliminate the face from any image analysis that detects the\n\"amount of skin\" visible in an image. It is not based on the\nlandmarker results, only on the initial face detection, hence\nthe <code>fd</code> (face de tection) prefix."
449 "type": "number"
450 }, 630 },
451 "blurredLikelihood": { 631 "angerLikelihood": {
452 "description": "Blurred likelihood.", 632 "description": "Anger likelihood.",
453 "enum": [ 633 "enum": [
454 "UNKNOWN", 634 "UNKNOWN",
455 "VERY_UNLIKELY", 635 "VERY_UNLIKELY",
456 "UNLIKELY", 636 "UNLIKELY",
457 "POSSIBLE", 637 "POSSIBLE",
458 "LIKELY", 638 "LIKELY",
459 "VERY_LIKELY" 639 "VERY_LIKELY"
460 ], 640 ],
461 "enumDescriptions": [ 641 "enumDescriptions": [
462 "Unknown likelihood.", 642 "Unknown likelihood.",
463 "It is very unlikely that the image belongs to the speci fied vertical.", 643 "It is very unlikely that the image belongs to the speci fied vertical.",
464 "It is unlikely that the image belongs to the specified vertical.", 644 "It is unlikely that the image belongs to the specified vertical.",
465 "It is possible that the image belongs to the specified vertical.", 645 "It is possible that the image belongs to the specified vertical.",
466 "It is likely that the image belongs to the specified ve rtical.", 646 "It is likely that the image belongs to the specified ve rtical.",
467 "It is very likely that the image belongs to the specifi ed vertical." 647 "It is very likely that the image belongs to the specifi ed vertical."
468 ], 648 ],
469 "type": "string" 649 "type": "string"
470 }, 650 },
471 "headwearLikelihood": { 651 "landmarks": {
472 "description": "Headwear likelihood.", 652 "description": "Detected face landmarks.",
653 "items": {
654 "$ref": "Landmark"
655 },
656 "type": "array"
657 },
658 "surpriseLikelihood": {
659 "description": "Surprise likelihood.",
473 "enum": [ 660 "enum": [
474 "UNKNOWN", 661 "UNKNOWN",
475 "VERY_UNLIKELY", 662 "VERY_UNLIKELY",
476 "UNLIKELY", 663 "UNLIKELY",
477 "POSSIBLE", 664 "POSSIBLE",
478 "LIKELY", 665 "LIKELY",
479 "VERY_LIKELY" 666 "VERY_LIKELY"
480 ], 667 ],
481 "enumDescriptions": [ 668 "enumDescriptions": [
482 "Unknown likelihood.", 669 "Unknown likelihood.",
483 "It is very unlikely that the image belongs to the speci fied vertical.", 670 "It is very unlikely that the image belongs to the speci fied vertical.",
484 "It is unlikely that the image belongs to the specified vertical.", 671 "It is unlikely that the image belongs to the specified vertical.",
485 "It is possible that the image belongs to the specified vertical.", 672 "It is possible that the image belongs to the specified vertical.",
486 "It is likely that the image belongs to the specified ve rtical.", 673 "It is likely that the image belongs to the specified ve rtical.",
487 "It is very likely that the image belongs to the specifi ed vertical." 674 "It is very likely that the image belongs to the specifi ed vertical."
488 ], 675 ],
489 "type": "string" 676 "type": "string"
490 }, 677 },
491 "boundingPoly": { 678 "landmarkingConfidence": {
492 "$ref": "BoundingPoly", 679 "description": "Face landmarking confidence. Range [0, 1].",
493 "description": "The bounding polygon around the face. The co ordinates of the bounding box\nare in the original image's scale, as returned in `ImageParams`.\nThe bounding box is computed to \"frame\" the face in accordanc e with human\nexpectations. It is based on the landmarker results.\nNote that on e or more x and/or y coordinates may not be generated in the\n`BoundingPoly` (th e polygon will be unbounded) if only a partial face\nappears in the image to be annotated."
494 },
495 "rollAngle": {
496 "description": "Roll angle, which indicates the amount of cl ockwise/anti-clockwise rotation\nof the face relative to the image vertical abou t the axis perpendicular to\nthe face. Range [-180,180].",
497 "format": "float", 680 "format": "float",
498 "type": "number" 681 "type": "number"
499 }, 682 },
500 "sorrowLikelihood": { 683 "joyLikelihood": {
501 "description": "Sorrow likelihood.", 684 "description": "Joy likelihood.",
502 "enum": [ 685 "enum": [
503 "UNKNOWN", 686 "UNKNOWN",
504 "VERY_UNLIKELY", 687 "VERY_UNLIKELY",
505 "UNLIKELY", 688 "UNLIKELY",
506 "POSSIBLE", 689 "POSSIBLE",
507 "LIKELY", 690 "LIKELY",
508 "VERY_LIKELY" 691 "VERY_LIKELY"
509 ], 692 ],
510 "enumDescriptions": [ 693 "enumDescriptions": [
511 "Unknown likelihood.", 694 "Unknown likelihood.",
512 "It is very unlikely that the image belongs to the speci fied vertical.", 695 "It is very unlikely that the image belongs to the speci fied vertical.",
513 "It is unlikely that the image belongs to the specified vertical.", 696 "It is unlikely that the image belongs to the specified vertical.",
514 "It is possible that the image belongs to the specified vertical.", 697 "It is possible that the image belongs to the specified vertical.",
515 "It is likely that the image belongs to the specified ve rtical.", 698 "It is likely that the image belongs to the specified ve rtical.",
516 "It is very likely that the image belongs to the specifi ed vertical." 699 "It is very likely that the image belongs to the specifi ed vertical."
517 ], 700 ],
518 "type": "string" 701 "type": "string"
519 }, 702 },
520 "tiltAngle": { 703 "detectionConfidence": {
521 "description": "Pitch angle, which indicates the upwards/dow nwards angle that the face is\npointing relative to the image's horizontal plane . Range [-180,180].", 704 "description": "Detection confidence. Range [0, 1].",
522 "format": "float", 705 "format": "float",
523 "type": "number" 706 "type": "number"
524 }, 707 },
525 "fdBoundingPoly": { 708 "panAngle": {
526 "$ref": "BoundingPoly", 709 "description": "Yaw angle, which indicates the leftward/righ tward angle that the face is\npointing relative to the vertical plane perpendicu lar to the image. Range\n[-180,180].",
527 "description": "The `fd_bounding_poly` bounding polygon is t ighter than the\n`boundingPoly`, and encloses only the skin part of the face. Ty pically, it\nis used to eliminate the face from any image analysis that detects the\n\"amount of skin\" visible in an image. It is not based on the\nlandmarker results, only on the initial face detection, hence\nthe <code>fd</code> (face de tection) prefix." 710 "format": "float",
711 "type": "number"
528 }, 712 },
529 "surpriseLikelihood": { 713 "underExposedLikelihood": {
530 "description": "Surprise likelihood.", 714 "description": "Under-exposed likelihood.",
531 "enum": [ 715 "enum": [
532 "UNKNOWN", 716 "UNKNOWN",
533 "VERY_UNLIKELY", 717 "VERY_UNLIKELY",
534 "UNLIKELY", 718 "UNLIKELY",
535 "POSSIBLE", 719 "POSSIBLE",
536 "LIKELY", 720 "LIKELY",
537 "VERY_LIKELY" 721 "VERY_LIKELY"
538 ], 722 ],
539 "enumDescriptions": [ 723 "enumDescriptions": [
540 "Unknown likelihood.", 724 "Unknown likelihood.",
541 "It is very unlikely that the image belongs to the speci fied vertical.", 725 "It is very unlikely that the image belongs to the speci fied vertical.",
542 "It is unlikely that the image belongs to the specified vertical.", 726 "It is unlikely that the image belongs to the specified vertical.",
543 "It is possible that the image belongs to the specified vertical.", 727 "It is possible that the image belongs to the specified vertical.",
544 "It is likely that the image belongs to the specified ve rtical.", 728 "It is likely that the image belongs to the specified ve rtical.",
545 "It is very likely that the image belongs to the specifi ed vertical." 729 "It is very likely that the image belongs to the specifi ed vertical."
546 ], 730 ],
547 "type": "string" 731 "type": "string"
548 }, 732 },
549 "angerLikelihood": { 733 "blurredLikelihood": {
550 "description": "Anger likelihood.", 734 "description": "Blurred likelihood.",
551 "enum": [ 735 "enum": [
552 "UNKNOWN", 736 "UNKNOWN",
553 "VERY_UNLIKELY", 737 "VERY_UNLIKELY",
554 "UNLIKELY", 738 "UNLIKELY",
555 "POSSIBLE", 739 "POSSIBLE",
556 "LIKELY", 740 "LIKELY",
557 "VERY_LIKELY" 741 "VERY_LIKELY"
558 ], 742 ],
559 "enumDescriptions": [ 743 "enumDescriptions": [
560 "Unknown likelihood.", 744 "Unknown likelihood.",
561 "It is very unlikely that the image belongs to the speci fied vertical.", 745 "It is very unlikely that the image belongs to the speci fied vertical.",
562 "It is unlikely that the image belongs to the specified vertical.", 746 "It is unlikely that the image belongs to the specified vertical.",
563 "It is possible that the image belongs to the specified vertical.", 747 "It is possible that the image belongs to the specified vertical.",
564 "It is likely that the image belongs to the specified ve rtical.", 748 "It is likely that the image belongs to the specified ve rtical.",
565 "It is very likely that the image belongs to the specifi ed vertical." 749 "It is very likely that the image belongs to the specifi ed vertical."
566 ], 750 ],
567 "type": "string" 751 "type": "string"
568 }, 752 },
569 "landmarks": { 753 "headwearLikelihood": {
570 "description": "Detected face landmarks.", 754 "description": "Headwear likelihood.",
571 "items": {
572 "$ref": "Landmark"
573 },
574 "type": "array"
575 },
576 "landmarkingConfidence": {
577 "description": "Face landmarking confidence. Range [0, 1].",
578 "format": "float",
579 "type": "number"
580 },
581 "joyLikelihood": {
582 "description": "Joy likelihood.",
583 "enum": [ 755 "enum": [
584 "UNKNOWN", 756 "UNKNOWN",
585 "VERY_UNLIKELY", 757 "VERY_UNLIKELY",
586 "UNLIKELY", 758 "UNLIKELY",
587 "POSSIBLE", 759 "POSSIBLE",
588 "LIKELY", 760 "LIKELY",
589 "VERY_LIKELY" 761 "VERY_LIKELY"
590 ], 762 ],
591 "enumDescriptions": [ 763 "enumDescriptions": [
592 "Unknown likelihood.", 764 "Unknown likelihood.",
593 "It is very unlikely that the image belongs to the speci fied vertical.", 765 "It is very unlikely that the image belongs to the speci fied vertical.",
594 "It is unlikely that the image belongs to the specified vertical.", 766 "It is unlikely that the image belongs to the specified vertical.",
595 "It is possible that the image belongs to the specified vertical.", 767 "It is possible that the image belongs to the specified vertical.",
596 "It is likely that the image belongs to the specified ve rtical.", 768 "It is likely that the image belongs to the specified ve rtical.",
597 "It is very likely that the image belongs to the specifi ed vertical." 769 "It is very likely that the image belongs to the specifi ed vertical."
598 ], 770 ],
599 "type": "string" 771 "type": "string"
772 },
773 "boundingPoly": {
774 "$ref": "BoundingPoly",
775 "description": "The bounding polygon around the face. The co ordinates of the bounding box\nare in the original image's scale, as returned in `ImageParams`.\nThe bounding box is computed to \"frame\" the face in accordanc e with human\nexpectations. It is based on the landmarker results.\nNote that on e or more x and/or y coordinates may not be generated in the\n`BoundingPoly` (th e polygon will be unbounded) if only a partial face\nappears in the image to be annotated."
776 },
777 "rollAngle": {
778 "description": "Roll angle, which indicates the amount of cl ockwise/anti-clockwise rotation\nof the face relative to the image vertical abou t the axis perpendicular to\nthe face. Range [-180,180].",
779 "format": "float",
780 "type": "number"
600 } 781 }
601 }, 782 },
602 "type": "object" 783 "type": "object"
603 }, 784 },
604 "BatchAnnotateImagesRequest": { 785 "BatchAnnotateImagesRequest": {
605 "description": "Multiple image annotation requests are batched into a single service call.", 786 "description": "Multiple image annotation requests are batched into a single service call.",
606 "id": "BatchAnnotateImagesRequest", 787 "id": "BatchAnnotateImagesRequest",
607 "properties": { 788 "properties": {
608 "requests": { 789 "requests": {
609 "description": "Individual image annotation requests for thi s batch.", 790 "description": "Individual image annotation requests for thi s batch.",
(...skipping 33 matching lines...) Expand 10 before | Expand all | Expand 10 after
643 ], 824 ],
644 "type": "string" 825 "type": "string"
645 } 826 }
646 }, 827 },
647 "type": "object" 828 "type": "object"
648 }, 829 },
649 "ImageContext": { 830 "ImageContext": {
650 "description": "Image context and/or feature-specific parameters.", 831 "description": "Image context and/or feature-specific parameters.",
651 "id": "ImageContext", 832 "id": "ImageContext",
652 "properties": { 833 "properties": {
834 "latLongRect": {
835 "$ref": "LatLongRect",
836 "description": "lat/long rectangle that specifies the locati on of the image."
837 },
653 "cropHintsParams": { 838 "cropHintsParams": {
654 "$ref": "CropHintsParams", 839 "$ref": "CropHintsParams",
655 "description": "Parameters for crop hints annotation request ." 840 "description": "Parameters for crop hints annotation request ."
656 }, 841 },
657 "languageHints": { 842 "languageHints": {
658 "description": "List of languages to use for TEXT_DETECTION. In most cases, an empty value\nyields the best results since it enables automat ic language detection. For\nlanguages based on the Latin alphabet, setting `lang uage_hints` is not\nneeded. In rare cases, when the language of the text in the image is known,\nsetting a hint will help get better results (although it will b e a\nsignificant hindrance if the hint is wrong). Text detection returns an\nerr or if one or more of the specified languages is not one of the\n[supported langu ages](/vision/docs/languages).", 843 "description": "List of languages to use for TEXT_DETECTION. In most cases, an empty value\nyields the best results since it enables automat ic language detection. For\nlanguages based on the Latin alphabet, setting `lang uage_hints` is not\nneeded. In rare cases, when the language of the text in the image is known,\nsetting a hint will help get better results (although it will b e a\nsignificant hindrance if the hint is wrong). Text detection returns an\nerr or if one or more of the specified languages is not one of the\n[supported langu ages](/vision/docs/languages).",
659 "items": { 844 "items": {
660 "type": "string" 845 "type": "string"
661 }, 846 },
662 "type": "array" 847 "type": "array"
663 },
664 "latLongRect": {
665 "$ref": "LatLongRect",
666 "description": "lat/long rectangle that specifies the locati on of the image."
667 } 848 }
668 }, 849 },
669 "type": "object" 850 "type": "object"
670 }, 851 },
671 "Page": { 852 "Page": {
672 "description": "Detected page from OCR.", 853 "description": "Detected page from OCR.",
673 "id": "Page", 854 "id": "Page",
674 "properties": { 855 "properties": {
675 "property": {
676 "$ref": "TextProperty",
677 "description": "Additional information detected on the page. "
678 },
679 "height": {
680 "description": "Page height in pixels.",
681 "format": "int32",
682 "type": "integer"
683 },
684 "width": { 856 "width": {
685 "description": "Page width in pixels.", 857 "description": "Page width in pixels.",
686 "format": "int32", 858 "format": "int32",
687 "type": "integer" 859 "type": "integer"
688 }, 860 },
689 "blocks": { 861 "blocks": {
690 "description": "List of blocks of text, images etc on this p age.", 862 "description": "List of blocks of text, images etc on this p age.",
691 "items": { 863 "items": {
692 "$ref": "Block" 864 "$ref": "Block"
693 }, 865 },
694 "type": "array" 866 "type": "array"
867 },
868 "property": {
869 "$ref": "TextProperty",
870 "description": "Additional information detected on the page. "
871 },
872 "height": {
873 "description": "Page height in pixels.",
874 "format": "int32",
875 "type": "integer"
695 } 876 }
696 }, 877 },
697 "type": "object" 878 "type": "object"
698 }, 879 },
699 "AnnotateImageRequest": { 880 "AnnotateImageRequest": {
700 "description": "Request for performing Google Cloud Vision API tasks over a user-provided\nimage, with user-requested features.", 881 "description": "Request for performing Google Cloud Vision API tasks over a user-provided\nimage, with user-requested features.",
701 "id": "AnnotateImageRequest", 882 "id": "AnnotateImageRequest",
702 "properties": { 883 "properties": {
703 "image": { 884 "image": {
704 "$ref": "Image", 885 "$ref": "Image",
(...skipping 10 matching lines...) Expand all
715 "$ref": "ImageContext", 896 "$ref": "ImageContext",
716 "description": "Additional context that may accompany the im age." 897 "description": "Additional context that may accompany the im age."
717 } 898 }
718 }, 899 },
719 "type": "object" 900 "type": "object"
720 }, 901 },
721 "Status": { 902 "Status": {
722 "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RP C APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is desig ned to be:\n\n- Simple to use and understand for most users\n- Flexible enough t o meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pie ces of data: error code, error message,\nand error details. The error code shoul d be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message tha t helps\ndevelopers *understand* and *resolve* the error. If a localized user-fa cing\nerror message is needed, put the localized message in the error details or \nlocalize it in the client. The optional error details may contain arbitrary\ni nformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` which can be used for common error conditions.\n\n# Lan guage mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` mes sage is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some except ions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\ n\nThe error model and the `Status` message can be used in a variety of\nenviron ments, either with or without APIs, to provide a\nconsistent developer experienc e across different environments.\n\nExample uses of this error model include:\n\ n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting purpose.\n\n- Batch operati ons. If a client uses batch request and batch response, the\n `Status` messag e should be used directly inside batch response, one for\n each error sub-res ponse.\n\n- Asynchronous operations. If an API call embeds asynchronous operatio n\n results in its response, the status of those operations should be\n re presented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any s tripping needed for security/privacy reasons.", 903 "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RP C APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is desig ned to be:\n\n- Simple to use and understand for most users\n- Flexible enough t o meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pie ces of data: error code, error message,\nand error details. The error code shoul d be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message tha t helps\ndevelopers *understand* and *resolve* the error. If a localized user-fa cing\nerror message is needed, put the localized message in the error details or \nlocalize it in the client. The optional error details may contain arbitrary\ni nformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` which can be used for common error conditions.\n\n# Lan guage mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` mes sage is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some except ions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\ n\nThe error model and the `Status` message can be used in a variety of\nenviron ments, either with or without APIs, to provide a\nconsistent developer experienc e across different environments.\n\nExample uses of this error model include:\n\ n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting purpose.\n\n- Batch operati ons. If a client uses batch request and batch response, the\n `Status` messag e should be used directly inside batch response, one for\n each error sub-res ponse.\n\n- Asynchronous operations. If an API call embeds asynchronous operatio n\n results in its response, the status of those operations should be\n re presented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any s tripping needed for security/privacy reasons.",
723 "id": "Status", 904 "id": "Status",
724 "properties": { 905 "properties": {
725 "code": {
726 "description": "The status code, which should be an enum val ue of google.rpc.Code.",
727 "format": "int32",
728 "type": "integer"
729 },
730 "message": {
731 "description": "A developer-facing error message, which shou ld be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
732 "type": "string"
733 },
734 "details": { 906 "details": {
735 "description": "A list of messages that carry the error deta ils. There will be a\ncommon set of message types for APIs to use.", 907 "description": "A list of messages that carry the error deta ils. There will be a\ncommon set of message types for APIs to use.",
736 "items": { 908 "items": {
737 "additionalProperties": { 909 "additionalProperties": {
738 "description": "Properties of the object. Contains f ield @type with type URL.", 910 "description": "Properties of the object. Contains f ield @type with type URL.",
739 "type": "any" 911 "type": "any"
740 }, 912 },
741 "type": "object" 913 "type": "object"
742 }, 914 },
743 "type": "array" 915 "type": "array"
916 },
917 "code": {
918 "description": "The status code, which should be an enum val ue of google.rpc.Code.",
919 "format": "int32",
920 "type": "integer"
921 },
922 "message": {
923 "description": "A developer-facing error message, which shou ld be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
924 "type": "string"
744 } 925 }
745 }, 926 },
746 "type": "object" 927 "type": "object"
747 }, 928 },
748 "LatLongRect": { 929 "LatLongRect": {
749 "description": "Rectangle determined by min and max `LatLng` pairs." , 930 "description": "Rectangle determined by min and max `LatLng` pairs." ,
750 "id": "LatLongRect", 931 "id": "LatLongRect",
751 "properties": { 932 "properties": {
933 "maxLatLng": {
934 "$ref": "LatLng",
935 "description": "Max lat/long pair."
936 },
752 "minLatLng": { 937 "minLatLng": {
753 "$ref": "LatLng", 938 "$ref": "LatLng",
754 "description": "Min lat/long pair." 939 "description": "Min lat/long pair."
755 },
756 "maxLatLng": {
757 "$ref": "LatLng",
758 "description": "Max lat/long pair."
759 } 940 }
760 }, 941 },
761 "type": "object" 942 "type": "object"
762 }, 943 },
763 "Symbol": { 944 "Symbol": {
764 "description": "A single symbol representation.", 945 "description": "A single symbol representation.",
765 "id": "Symbol", 946 "id": "Symbol",
766 "properties": { 947 "properties": {
767 "text": {
768 "description": "The actual UTF-8 representation of the symbo l.",
769 "type": "string"
770 },
771 "property": { 948 "property": {
772 "$ref": "TextProperty", 949 "$ref": "TextProperty",
773 "description": "Additional information detected for the symb ol." 950 "description": "Additional information detected for the symb ol."
774 }, 951 },
775 "boundingBox": { 952 "boundingBox": {
776 "$ref": "BoundingPoly", 953 "$ref": "BoundingPoly",
777 "description": "The bounding box for the symbol.\nThe vertic es are in the order of top-left, top-right, bottom-right,\nbottom-left. When a r otation of the bounding box is detected the rotation\nis represented as around t he top-left corner as defined when the text is\nread in the 'natural' orientatio n.\nFor example:\n * when the text is horizontal it might look like:\n 0--- -1\n | |\n 3----2\n * when it's rotated 180 degrees around the top-l eft corner it becomes:\n 2----3\n | |\n 1----0\n and the vertice order will still be (0, 1, 2, 3)." 954 "description": "The bounding box for the symbol.\nThe vertic es are in the order of top-left, top-right, bottom-right,\nbottom-left. When a r otation of the bounding box is detected the rotation\nis represented as around t he top-left corner as defined when the text is\nread in the 'natural' orientatio n.\nFor example:\n * when the text is horizontal it might look like:\n 0--- -1\n | |\n 3----2\n * when it's rotated 180 degrees around the top-l eft corner it becomes:\n 2----3\n | |\n 1----0\n and the vertice order will still be (0, 1, 2, 3)."
955 },
956 "text": {
957 "description": "The actual UTF-8 representation of the symbo l.",
958 "type": "string"
778 } 959 }
779 }, 960 },
780 "type": "object" 961 "type": "object"
781 }, 962 },
782 "CropHintsAnnotation": { 963 "CropHintsAnnotation": {
783 "description": "Set of crop hints that are used to generate new crop s when serving images.", 964 "description": "Set of crop hints that are used to generate new crop s when serving images.",
784 "id": "CropHintsAnnotation", 965 "id": "CropHintsAnnotation",
785 "properties": { 966 "properties": {
786 "cropHints": { 967 "cropHints": {
787 "description": "Crop hint results.", 968 "description": "Crop hint results.",
(...skipping 42 matching lines...) Expand 10 before | Expand all | Expand 10 after
830 "type": "number" 1011 "type": "number"
831 }, 1012 },
832 "alpha": { 1013 "alpha": {
833 "description": "The fraction of this color that should be ap plied to the pixel. That is,\nthe final pixel color is defined by the equation:\ n\n pixel color = alpha * (this color) + (1.0 - alpha) * (background color)\n\n This means that a value of 1.0 corresponds to a solid color, whereas\na value of 0.0 corresponds to a completely transparent color. This\nuses a wrapper message rather than a simple float scalar so that it is\npossible to distinguish betwee n a default value and the value being unset.\nIf omitted, this color object is t o be rendered as a solid color\n(as if the alpha value had been explicitly given with a value of 1.0).", 1014 "description": "The fraction of this color that should be ap plied to the pixel. That is,\nthe final pixel color is defined by the equation:\ n\n pixel color = alpha * (this color) + (1.0 - alpha) * (background color)\n\n This means that a value of 1.0 corresponds to a solid color, whereas\na value of 0.0 corresponds to a completely transparent color. This\nuses a wrapper message rather than a simple float scalar so that it is\npossible to distinguish betwee n a default value and the value being unset.\nIf omitted, this color object is t o be rendered as a solid color\n(as if the alpha value had been explicitly given with a value of 1.0).",
834 "format": "float", 1015 "format": "float",
835 "type": "number" 1016 "type": "number"
836 } 1017 }
837 }, 1018 },
838 "type": "object" 1019 "type": "object"
839 }, 1020 },
840 "ImageProperties": {
841 "description": "Stores image properties, such as dominant colors.",
842 "id": "ImageProperties",
843 "properties": {
844 "dominantColors": {
845 "$ref": "DominantColorsAnnotation",
846 "description": "If present, dominant colors completed succes sfully."
847 }
848 },
849 "type": "object"
850 },
851 "Feature": { 1021 "Feature": {
852 "description": "Users describe the type of Google Cloud Vision API t asks to perform over\nimages by using *Feature*s. Each Feature indicates a type of image\ndetection task to perform. Features encode the Cloud Vision API\nverti cal to operate on and the number of top-scoring results to return.", 1022 "description": "Users describe the type of Google Cloud Vision API t asks to perform over\nimages by using *Feature*s. Each Feature indicates a type of image\ndetection task to perform. Features encode the Cloud Vision API\nverti cal to operate on and the number of top-scoring results to return.",
853 "id": "Feature", 1023 "id": "Feature",
854 "properties": { 1024 "properties": {
855 "type": { 1025 "type": {
856 "description": "The feature type.", 1026 "description": "The feature type.",
857 "enum": [ 1027 "enum": [
858 "TYPE_UNSPECIFIED", 1028 "TYPE_UNSPECIFIED",
859 "FACE_DETECTION", 1029 "FACE_DETECTION",
860 "LANDMARK_DETECTION", 1030 "LANDMARK_DETECTION",
(...skipping 22 matching lines...) Expand all
883 "type": "string" 1053 "type": "string"
884 }, 1054 },
885 "maxResults": { 1055 "maxResults": {
886 "description": "Maximum number of results of this type.", 1056 "description": "Maximum number of results of this type.",
887 "format": "int32", 1057 "format": "int32",
888 "type": "integer" 1058 "type": "integer"
889 } 1059 }
890 }, 1060 },
891 "type": "object" 1061 "type": "object"
892 }, 1062 },
1063 "ImageProperties": {
1064 "description": "Stores image properties, such as dominant colors.",
1065 "id": "ImageProperties",
1066 "properties": {
1067 "dominantColors": {
1068 "$ref": "DominantColorsAnnotation",
1069 "description": "If present, dominant colors completed succes sfully."
1070 }
1071 },
1072 "type": "object"
1073 },
893 "SafeSearchAnnotation": { 1074 "SafeSearchAnnotation": {
894 "description": "Set of features pertaining to the image, computed by computer vision\nmethods over safe-search verticals (for example, adult, spoof, medical,\nviolence).", 1075 "description": "Set of features pertaining to the image, computed by computer vision\nmethods over safe-search verticals (for example, adult, spoof, medical,\nviolence).",
895 "id": "SafeSearchAnnotation", 1076 "id": "SafeSearchAnnotation",
896 "properties": { 1077 "properties": {
897 "violence": { 1078 "spoof": {
898 "description": "Violence likelihood.", 1079 "description": "Spoof likelihood. The likelihood that an mod ification\nwas made to the image's canonical version to make it appear\nfunny or offensive.",
899 "enum": [ 1080 "enum": [
900 "UNKNOWN", 1081 "UNKNOWN",
901 "VERY_UNLIKELY", 1082 "VERY_UNLIKELY",
902 "UNLIKELY", 1083 "UNLIKELY",
903 "POSSIBLE", 1084 "POSSIBLE",
904 "LIKELY", 1085 "LIKELY",
905 "VERY_LIKELY" 1086 "VERY_LIKELY"
906 ], 1087 ],
907 "enumDescriptions": [ 1088 "enumDescriptions": [
908 "Unknown likelihood.", 1089 "Unknown likelihood.",
909 "It is very unlikely that the image belongs to the speci fied vertical.", 1090 "It is very unlikely that the image belongs to the speci fied vertical.",
910 "It is unlikely that the image belongs to the specified vertical.", 1091 "It is unlikely that the image belongs to the specified vertical.",
911 "It is possible that the image belongs to the specified vertical.", 1092 "It is possible that the image belongs to the specified vertical.",
912 "It is likely that the image belongs to the specified ve rtical.", 1093 "It is likely that the image belongs to the specified ve rtical.",
913 "It is very likely that the image belongs to the specifi ed vertical." 1094 "It is very likely that the image belongs to the specifi ed vertical."
914 ], 1095 ],
915 "type": "string" 1096 "type": "string"
916 }, 1097 },
917 "adult": { 1098 "medical": {
918 "description": "Represents the adult content likelihood for the image.", 1099 "description": "Likelihood that this is a medical image.",
919 "enum": [ 1100 "enum": [
920 "UNKNOWN", 1101 "UNKNOWN",
921 "VERY_UNLIKELY", 1102 "VERY_UNLIKELY",
922 "UNLIKELY", 1103 "UNLIKELY",
923 "POSSIBLE", 1104 "POSSIBLE",
924 "LIKELY", 1105 "LIKELY",
925 "VERY_LIKELY" 1106 "VERY_LIKELY"
926 ], 1107 ],
927 "enumDescriptions": [ 1108 "enumDescriptions": [
928 "Unknown likelihood.", 1109 "Unknown likelihood.",
929 "It is very unlikely that the image belongs to the speci fied vertical.", 1110 "It is very unlikely that the image belongs to the speci fied vertical.",
930 "It is unlikely that the image belongs to the specified vertical.", 1111 "It is unlikely that the image belongs to the specified vertical.",
931 "It is possible that the image belongs to the specified vertical.", 1112 "It is possible that the image belongs to the specified vertical.",
932 "It is likely that the image belongs to the specified ve rtical.", 1113 "It is likely that the image belongs to the specified ve rtical.",
933 "It is very likely that the image belongs to the specifi ed vertical." 1114 "It is very likely that the image belongs to the specifi ed vertical."
934 ], 1115 ],
935 "type": "string" 1116 "type": "string"
936 }, 1117 },
937 "spoof": { 1118 "violence": {
938 "description": "Spoof likelihood. The likelihood that an mod ification\nwas made to the image's canonical version to make it appear\nfunny or offensive.", 1119 "description": "Violence likelihood.",
939 "enum": [ 1120 "enum": [
940 "UNKNOWN", 1121 "UNKNOWN",
941 "VERY_UNLIKELY", 1122 "VERY_UNLIKELY",
942 "UNLIKELY", 1123 "UNLIKELY",
943 "POSSIBLE", 1124 "POSSIBLE",
944 "LIKELY", 1125 "LIKELY",
945 "VERY_LIKELY" 1126 "VERY_LIKELY"
946 ], 1127 ],
947 "enumDescriptions": [ 1128 "enumDescriptions": [
948 "Unknown likelihood.", 1129 "Unknown likelihood.",
949 "It is very unlikely that the image belongs to the speci fied vertical.", 1130 "It is very unlikely that the image belongs to the speci fied vertical.",
950 "It is unlikely that the image belongs to the specified vertical.", 1131 "It is unlikely that the image belongs to the specified vertical.",
951 "It is possible that the image belongs to the specified vertical.", 1132 "It is possible that the image belongs to the specified vertical.",
952 "It is likely that the image belongs to the specified ve rtical.", 1133 "It is likely that the image belongs to the specified ve rtical.",
953 "It is very likely that the image belongs to the specifi ed vertical." 1134 "It is very likely that the image belongs to the specifi ed vertical."
954 ], 1135 ],
955 "type": "string" 1136 "type": "string"
956 }, 1137 },
957 "medical": { 1138 "adult": {
958 "description": "Likelihood that this is a medical image.", 1139 "description": "Represents the adult content likelihood for the image.",
959 "enum": [ 1140 "enum": [
960 "UNKNOWN", 1141 "UNKNOWN",
961 "VERY_UNLIKELY", 1142 "VERY_UNLIKELY",
962 "UNLIKELY", 1143 "UNLIKELY",
963 "POSSIBLE", 1144 "POSSIBLE",
964 "LIKELY", 1145 "LIKELY",
965 "VERY_LIKELY" 1146 "VERY_LIKELY"
966 ], 1147 ],
967 "enumDescriptions": [ 1148 "enumDescriptions": [
968 "Unknown likelihood.", 1149 "Unknown likelihood.",
(...skipping 19 matching lines...) Expand all
988 }, 1169 },
989 "type": "array" 1170 "type": "array"
990 } 1171 }
991 }, 1172 },
992 "type": "object" 1173 "type": "object"
993 }, 1174 },
994 "TextAnnotation": { 1175 "TextAnnotation": {
995 "description": "TextAnnotation contains a structured representation of OCR extracted text.\nThe hierarchy of an OCR extracted text structure is like this:\n TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol\nEach structural component, starting from Page, may further have their own\npropertie s. Properties describe detected languages, breaks etc.. Please\nrefer to the goo gle.cloud.vision.v1.TextAnnotation.TextProperty message\ndefinition below for mo re detail.", 1176 "description": "TextAnnotation contains a structured representation of OCR extracted text.\nThe hierarchy of an OCR extracted text structure is like this:\n TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol\nEach structural component, starting from Page, may further have their own\npropertie s. Properties describe detected languages, breaks etc.. Please\nrefer to the goo gle.cloud.vision.v1.TextAnnotation.TextProperty message\ndefinition below for mo re detail.",
996 "id": "TextAnnotation", 1177 "id": "TextAnnotation",
997 "properties": { 1178 "properties": {
998 "text": {
999 "description": "UTF-8 text detected on the pages.",
1000 "type": "string"
1001 },
1002 "pages": { 1179 "pages": {
1003 "description": "List of pages detected by OCR.", 1180 "description": "List of pages detected by OCR.",
1004 "items": { 1181 "items": {
1005 "$ref": "Page" 1182 "$ref": "Page"
1006 }, 1183 },
1007 "type": "array" 1184 "type": "array"
1185 },
1186 "text": {
1187 "description": "UTF-8 text detected on the pages.",
1188 "type": "string"
1008 } 1189 }
1009 }, 1190 },
1010 "type": "object" 1191 "type": "object"
1011 }, 1192 },
1012 "DetectedLanguage": { 1193 "DetectedLanguage": {
1013 "description": "Detected language for a structural component.", 1194 "description": "Detected language for a structural component.",
1014 "id": "DetectedLanguage", 1195 "id": "DetectedLanguage",
1015 "properties": { 1196 "properties": {
1016 "languageCode": { 1197 "languageCode": {
1017 "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more\ninformation, see\nhttp://www.unicode.org/reports/tr35/ #Unicode_locale_identifier.", 1198 "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more\ninformation, see\nhttp://www.unicode.org/reports/tr35/ #Unicode_locale_identifier.",
1018 "type": "string" 1199 "type": "string"
1019 }, 1200 },
1020 "confidence": { 1201 "confidence": {
1021 "description": "Confidence of detected language. Range [0, 1 ].", 1202 "description": "Confidence of detected language. Range [0, 1 ].",
1022 "format": "float", 1203 "format": "float",
1023 "type": "number" 1204 "type": "number"
1024 } 1205 }
1025 }, 1206 },
1026 "type": "object" 1207 "type": "object"
1027 }, 1208 },
1028 "Vertex": { 1209 "Vertex": {
1029 "description": "A vertex represents a 2D point in the image.\nNOTE: the vertex coordinates are in the same scale as the original image.", 1210 "description": "A vertex represents a 2D point in the image.\nNOTE: the vertex coordinates are in the same scale as the original image.",
1030 "id": "Vertex", 1211 "id": "Vertex",
1031 "properties": { 1212 "properties": {
1213 "y": {
1214 "description": "Y coordinate.",
1215 "format": "int32",
1216 "type": "integer"
1217 },
1032 "x": { 1218 "x": {
1033 "description": "X coordinate.", 1219 "description": "X coordinate.",
1034 "format": "int32", 1220 "format": "int32",
1035 "type": "integer" 1221 "type": "integer"
1036 },
1037 "y": {
1038 "description": "Y coordinate.",
1039 "format": "int32",
1040 "type": "integer"
1041 } 1222 }
1042 }, 1223 },
1043 "type": "object" 1224 "type": "object"
1044 }, 1225 },
1045 "WebEntity": { 1226 "WebEntity": {
1046 "description": "Entity deduced from similar images on the Internet." , 1227 "description": "Entity deduced from similar images on the Internet." ,
1047 "id": "WebEntity", 1228 "id": "WebEntity",
1048 "properties": { 1229 "properties": {
1049 "entityId": { 1230 "entityId": {
1050 "description": "Opaque entity ID.", 1231 "description": "Opaque entity ID.",
1051 "type": "string" 1232 "type": "string"
1052 }, 1233 },
1053 "description": { 1234 "description": {
1054 "description": "Canonical description of the entity, in Engl ish.", 1235 "description": "Canonical description of the entity, in Engl ish.",
1055 "type": "string" 1236 "type": "string"
1056 }, 1237 },
1057 "score": { 1238 "score": {
1058 "description": "Overall relevancy score for the entity.\nNot normalized and not comparable across different image queries.", 1239 "description": "Overall relevancy score for the entity.\nNot normalized and not comparable across different image queries.",
1059 "format": "float", 1240 "format": "float",
1060 "type": "number" 1241 "type": "number"
1061 } 1242 }
1062 }, 1243 },
1063 "type": "object" 1244 "type": "object"
1064 }, 1245 },
1065 "BoundingPoly": {
1066 "description": "A bounding polygon for the detected image annotation .",
1067 "id": "BoundingPoly",
1068 "properties": {
1069 "vertices": {
1070 "description": "The bounding polygon vertices.",
1071 "items": {
1072 "$ref": "Vertex"
1073 },
1074 "type": "array"
1075 }
1076 },
1077 "type": "object"
1078 },
1079 "TextProperty": { 1246 "TextProperty": {
1080 "description": "Additional information detected on the structural co mponent.", 1247 "description": "Additional information detected on the structural co mponent.",
1081 "id": "TextProperty", 1248 "id": "TextProperty",
1082 "properties": { 1249 "properties": {
1083 "detectedLanguages": { 1250 "detectedLanguages": {
1084 "description": "A list of detected languages together with c onfidence.", 1251 "description": "A list of detected languages together with c onfidence.",
1085 "items": { 1252 "items": {
1086 "$ref": "DetectedLanguage" 1253 "$ref": "DetectedLanguage"
1087 }, 1254 },
1088 "type": "array" 1255 "type": "array"
1089 }, 1256 },
1090 "detectedBreak": { 1257 "detectedBreak": {
1091 "$ref": "DetectedBreak", 1258 "$ref": "DetectedBreak",
1092 "description": "Detected start or end of a text segment." 1259 "description": "Detected start or end of a text segment."
1093 } 1260 }
1094 }, 1261 },
1095 "type": "object" 1262 "type": "object"
1096 }, 1263 },
1264 "BoundingPoly": {
1265 "description": "A bounding polygon for the detected image annotation .",
1266 "id": "BoundingPoly",
1267 "properties": {
1268 "vertices": {
1269 "description": "The bounding polygon vertices.",
1270 "items": {
1271 "$ref": "Vertex"
1272 },
1273 "type": "array"
1274 }
1275 },
1276 "type": "object"
1277 },
1097 "AnnotateImageResponse": { 1278 "AnnotateImageResponse": {
1098 "description": "Response to an image annotation request.", 1279 "description": "Response to an image annotation request.",
1099 "id": "AnnotateImageResponse", 1280 "id": "AnnotateImageResponse",
1100 "properties": { 1281 "properties": {
1101 "logoAnnotations": {
1102 "description": "If present, logo detection has completed suc cessfully.",
1103 "items": {
1104 "$ref": "EntityAnnotation"
1105 },
1106 "type": "array"
1107 },
1108 "cropHintsAnnotation": {
1109 "$ref": "CropHintsAnnotation",
1110 "description": "If present, crop hints have completed succes sfully."
1111 },
1112 "webDetection": {
1113 "$ref": "WebDetection",
1114 "description": "If present, web detection has completed succ essfully."
1115 },
1116 "labelAnnotations": {
1117 "description": "If present, label detection has completed su ccessfully.",
1118 "items": {
1119 "$ref": "EntityAnnotation"
1120 },
1121 "type": "array"
1122 },
1123 "safeSearchAnnotation": {
1124 "$ref": "SafeSearchAnnotation",
1125 "description": "If present, safe-search annotation has compl eted successfully."
1126 },
1127 "error": { 1282 "error": {
1128 "$ref": "Status", 1283 "$ref": "Status",
1129 "description": "If set, represents the error message for the operation.\nNote that filled-in image annotations are guaranteed to be\ncorrect , even when `error` is set." 1284 "description": "If set, represents the error message for the operation.\nNote that filled-in image annotations are guaranteed to be\ncorrect , even when `error` is set."
1130 }, 1285 },
1131 "fullTextAnnotation": { 1286 "fullTextAnnotation": {
1132 "$ref": "TextAnnotation", 1287 "$ref": "TextAnnotation",
1133 "description": "If present, text (OCR) detection or document (OCR) text detection has\ncompleted successfully.\nThis annotation provides the structural hierarchy for the OCR detected\ntext." 1288 "description": "If present, text (OCR) detection or document (OCR) text detection has\ncompleted successfully.\nThis annotation provides the structural hierarchy for the OCR detected\ntext."
1134 }, 1289 },
1135 "landmarkAnnotations": { 1290 "landmarkAnnotations": {
1136 "description": "If present, landmark detection has completed successfully.", 1291 "description": "If present, landmark detection has completed successfully.",
1137 "items": { 1292 "items": {
1138 "$ref": "EntityAnnotation" 1293 "$ref": "EntityAnnotation"
1139 }, 1294 },
1140 "type": "array" 1295 "type": "array"
1141 }, 1296 },
1142 "textAnnotations": { 1297 "textAnnotations": {
1143 "description": "If present, text (OCR) detection has complet ed successfully.", 1298 "description": "If present, text (OCR) detection has complet ed successfully.",
1144 "items": { 1299 "items": {
1145 "$ref": "EntityAnnotation" 1300 "$ref": "EntityAnnotation"
1146 }, 1301 },
1147 "type": "array" 1302 "type": "array"
1148 }, 1303 },
1304 "faceAnnotations": {
1305 "description": "If present, face detection has completed suc cessfully.",
1306 "items": {
1307 "$ref": "FaceAnnotation"
1308 },
1309 "type": "array"
1310 },
1149 "imagePropertiesAnnotation": { 1311 "imagePropertiesAnnotation": {
1150 "$ref": "ImageProperties", 1312 "$ref": "ImageProperties",
1151 "description": "If present, image properties were extracted successfully." 1313 "description": "If present, image properties were extracted successfully."
1152 }, 1314 },
1153 "faceAnnotations": { 1315 "logoAnnotations": {
1154 "description": "If present, face detection has completed suc cessfully.", 1316 "description": "If present, logo detection has completed suc cessfully.",
1155 "items": { 1317 "items": {
1156 "$ref": "FaceAnnotation" 1318 "$ref": "EntityAnnotation"
1157 },
1158 "type": "array"
1159 }
1160 },
1161 "type": "object"
1162 },
1163 "CropHintsParams": {
1164 "description": "Parameters for crop hints annotation request.",
1165 "id": "CropHintsParams",
1166 "properties": {
1167 "aspectRatios": {
1168 "description": "Aspect ratios in floats, representing the ra tio of the width to the height\nof the image. For example, if the desired aspect ratio is 4/3, the\ncorresponding float value should be 1.33333. If not specifi ed, the\nbest possible crop is returned. The number of provided aspect ratios is \nlimited to a maximum of 16; any aspect ratios provided after the 16th are\nign ored.",
1169 "items": {
1170 "format": "float",
1171 "type": "number"
1172 },
1173 "type": "array"
1174 }
1175 },
1176 "type": "object"
1177 },
1178 "Block": {
1179 "description": "Logical element on the page.",
1180 "id": "Block",
1181 "properties": {
1182 "paragraphs": {
1183 "description": "List of paragraphs in this block (if this bl ocks is of type text).",
1184 "items": {
1185 "$ref": "Paragraph"
1186 }, 1319 },
1187 "type": "array" 1320 "type": "array"
1188 }, 1321 },
1189 "property": { 1322 "webDetection": {
1190 "$ref": "TextProperty", 1323 "$ref": "WebDetection",
1191 "description": "Additional information detected for the bloc k." 1324 "description": "If present, web detection has completed succ essfully."
1192 }, 1325 },
1193 "blockType": { 1326 "cropHintsAnnotation": {
1194 "description": "Detected block type (text, image etc) for th is block.", 1327 "$ref": "CropHintsAnnotation",
1195 "enum": [ 1328 "description": "If present, crop hints have completed succes sfully."
1196 "UNKNOWN",
1197 "TEXT",
1198 "TABLE",
1199 "PICTURE",
1200 "RULER",
1201 "BARCODE"
1202 ],
1203 "enumDescriptions": [
1204 "Unknown block type.",
1205 "Regular text block.",
1206 "Table block.",
1207 "Image block.",
1208 "Horizontal/vertical line box.",
1209 "Barcode block."
1210 ],
1211 "type": "string"
1212 }, 1329 },
1213 "boundingBox": { 1330 "safeSearchAnnotation": {
1214 "$ref": "BoundingPoly", 1331 "$ref": "SafeSearchAnnotation",
1215 "description": "The bounding box for the block.\nThe vertice s are in the order of top-left, top-right, bottom-right,\nbottom-left. When a ro tation of the bounding box is detected the rotation\nis represented as around th e top-left corner as defined when the text is\nread in the 'natural' orientation .\nFor example:\n * when the text is horizontal it might look like:\n 0---- 1\n | |\n 3----2\n * when it's rotated 180 degrees around the top-le ft corner it becomes:\n 2----3\n | |\n 1----0\n and the vertice order will still be (0, 1, 2, 3)." 1332 "description": "If present, safe-search annotation has compl eted successfully."
1216 } 1333 },
1217 }, 1334 "labelAnnotations": {
1218 "type": "object" 1335 "description": "If present, label detection has completed su ccessfully.",
1219 },
1220 "BatchAnnotateImagesResponse": {
1221 "description": "Response to a batch image annotation request.",
1222 "id": "BatchAnnotateImagesResponse",
1223 "properties": {
1224 "responses": {
1225 "description": "Individual responses to image annotation req uests within the batch.",
1226 "items": { 1336 "items": {
1227 "$ref": "AnnotateImageResponse" 1337 "$ref": "EntityAnnotation"
1228 }, 1338 },
1229 "type": "array" 1339 "type": "array"
1230 } 1340 }
1231 }, 1341 },
1232 "type": "object" 1342 "type": "object"
1233 },
1234 "WebDetection": {
1235 "description": "Relevant information for the image from the Internet .",
1236 "id": "WebDetection",
1237 "properties": {
1238 "webEntities": {
1239 "description": "Deduced entities from similar images on the Internet.",
1240 "items": {
1241 "$ref": "WebEntity"
1242 },
1243 "type": "array"
1244 },
1245 "pagesWithMatchingImages": {
1246 "description": "Web pages containing the matching images fro m the Internet.",
1247 "items": {
1248 "$ref": "WebPage"
1249 },
1250 "type": "array"
1251 },
1252 "partialMatchingImages": {
1253 "description": "Partial matching images from the Internet.\n Those images are similar enough to share some key-point features. For\nexample a n original image will likely have partial matching for its crops.",
1254 "items": {
1255 "$ref": "WebImage"
1256 },
1257 "type": "array"
1258 },
1259 "fullMatchingImages": {
1260 "description": "Fully matching images from the Internet.\nTh ey're definite neardups and most often a copy of the query image with\nmerely a size change.",
1261 "items": {
1262 "$ref": "WebImage"
1263 },
1264 "type": "array"
1265 }
1266 },
1267 "type": "object"
1268 },
1269 "ImageSource": {
1270 "description": "External image source (Google Cloud Storage image lo cation).",
1271 "id": "ImageSource",
1272 "properties": {
1273 "gcsImageUri": {
1274 "description": "NOTE: For new code `image_uri` below is pref erred.\nGoogle Cloud Storage image URI, which must be in the following form:\n`g s://bucket_name/object_name` (for details, see\n[Google Cloud Storage Request\nU RIs](https://cloud.google.com/storage/docs/reference-uris)).\nNOTE: Cloud Storag e object versioning is not supported.",
1275 "type": "string"
1276 },
1277 "imageUri": {
1278 "description": "Image URI which supports:\n1) Google Cloud S torage image URI, which must be in the following form:\n`gs://bucket_name/object _name` (for details, see\n[Google Cloud Storage Request\nURIs](https://cloud.goo gle.com/storage/docs/reference-uris)).\nNOTE: Cloud Storage object versioning is not supported.\n2) Publicly accessible image HTTP/HTTPS URL.\nThis is preferred over the legacy `gcs_image_uri` above. When both\n`gcs_image_uri` and `image_ur i` are specified, `image_uri` takes\nprecedence.",
1279 "type": "string"
1280 }
1281 },
1282 "type": "object"
1283 },
1284 "Property": {
1285 "description": "A `Property` consists of a user-supplied name/value pair.",
1286 "id": "Property",
1287 "properties": {
1288 "uint64Value": {
1289 "description": "Value of numeric properties.",
1290 "format": "uint64",
1291 "type": "string"
1292 },
1293 "name": {
1294 "description": "Name of the property.",
1295 "type": "string"
1296 },
1297 "value": {
1298 "description": "Value of the property.",
1299 "type": "string"
1300 }
1301 },
1302 "type": "object"
1303 },
1304 "LocationInfo": {
1305 "description": "Detected entity location information.",
1306 "id": "LocationInfo",
1307 "properties": {
1308 "latLng": {
1309 "$ref": "LatLng",
1310 "description": "lat/long location coordinates."
1311 }
1312 },
1313 "type": "object"
1314 },
1315 "Position": {
1316 "description": "A 3D position in the image, used primarily for Face detection landmarks.\nA valid Position must have both x and y coordinates.\nThe position coordinates are in the same scale as the original image.",
1317 "id": "Position",
1318 "properties": {
1319 "y": {
1320 "description": "Y coordinate.",
1321 "format": "float",
1322 "type": "number"
1323 },
1324 "x": {
1325 "description": "X coordinate.",
1326 "format": "float",
1327 "type": "number"
1328 },
1329 "z": {
1330 "description": "Z coordinate (or depth).",
1331 "format": "float",
1332 "type": "number"
1333 }
1334 },
1335 "type": "object"
1336 } 1343 }
1337 }, 1344 },
1338 "servicePath": "", 1345 "servicePath": "",
1339 "title": "Google Cloud Vision API", 1346 "title": "Google Cloud Vision API",
1340 "version": "v1" 1347 "version": "v1"
1341 } 1348 }
OLDNEW
« no previous file with comments | « discovery/googleapis/tracing__v1.json ('k') | discovery/googleapis/webmasters__v3.json » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698