Blame - docs/dyn/vision_v1p2beta1.projects.images.html - platform/external/python/google-api-python-client

2020-10-06 16:46:05 -0700

[diff] [blame]

82

<p class="firstline">Run asynchronous image detection and annotation for a list of images. Progress and results can be retrieved through the `google.longrunning.Operations` interface. `Operation.metadata` contains `OperationMetadata` (metadata). `Operation.response` contains `AsyncBatchAnnotateImagesResponse` (results). This service will write image annotation outputs to json files in customer GCS bucket, each json file containing BatchAnnotateImagesResponse proto.</p>

83

84

<code><a href="#close">close()</a></code></p>

85

<p class="firstline">Close httplib2 connections.</p>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

86

<h3>Method Details</h3>

87

88

<code class="details" id="annotate">annotate(parent, body=None, x__xgafv=None)</code>

89

<pre>Run image detection and annotation for a batch of images.

90

91

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

92

parent: string, Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. (required)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

93

body: object, The request body.

94

The object takes the form of:

95

96

{ # Multiple image annotation requests are batched into a single service call.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

97

"parent": "A String", # Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

98

"requests": [ # Required. Individual image annotation requests for this batch.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

99

{ # Request for performing Google Cloud Vision API tasks over a user-provided image, with user-requested features, and with context information.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

100

"imageContext": { # Image context and/or feature-specific parameters. # Additional context that may accompany the image.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

101

"languageHints": [ # List of languages to use for TEXT_DETECTION. In most cases, an empty value yields the best results since it enables automatic language detection. For languages based on the Latin alphabet, setting `language_hints` is not needed. In rare cases, when the language of the text in the image is known, setting a hint will help get better results (although it will be a significant hindrance if the hint is wrong). Text detection returns an error if one or more of the specified languages is not one of the [supported languages](https://cloud.google.com/vision/docs/languages).

102

"A String",

103

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

104

"latLongRect": { # Rectangle determined by min and max `LatLng` pairs. # Not used.

105

"minLatLng": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the WGS84 standard. Values must be within normalized ranges. # Min lat/long pair.

106

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

107

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].

108

},

109

"maxLatLng": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the WGS84 standard. Values must be within normalized ranges. # Max lat/long pair.

110

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

111

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].

112

},

113

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

114

"cropHintsParams": { # Parameters for crop hints annotation request. # Parameters for crop hints annotation request.

115

"aspectRatios": [ # Aspect ratios in floats, representing the ratio of the width to the height of the image. For example, if the desired aspect ratio is 4/3, the corresponding float value should be 1.33333. If not specified, the best possible crop is returned. The number of provided aspect ratios is limited to a maximum of 16; any aspect ratios provided after the 16th are ignored.

116

3.14,

117

],

118

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

119

"webDetectionParams": { # Parameters for web detection request. # Parameters for web detection.

120

"includeGeoResults": True or False, # Whether to include results derived from the geo information in the image.

121

},

122

"productSearchParams": { # Parameters for a product search request. # Parameters for product search.

123

"filter": "A String", # The filtering expression. This can be used to restrict search results based on Product labels. We currently support an AND of OR of key-value expressions, where each expression within an OR must have the same key. An '=' should be used to connect the key and value. For example, "(color = red OR color = blue) AND brand = Google" is acceptable, but "(color = red OR brand = Google)" is not acceptable. "color: red" is not acceptable because it uses a ':' instead of an '='.

124

"productCategories": [ # The list of product categories to search in. Currently, we only consider the first category, and either "homegoods-v2", "apparel-v2", "toys-v2", "packagedgoods-v1", or "general-v1" should be specified. The legacy categories "homegoods", "apparel", and "toys" are still supported but will be deprecated. For new products, please use "homegoods-v2", "apparel-v2", or "toys-v2" for better product search accuracy. It is recommended to migrate existing products to these categories as well.

125

"A String",

126

],

127

"boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon around the area of interest in the image. If it is not specified, system discretion will be applied.

128

"normalizedVertices": [ # The bounding polygon normalized vertices.

129

{ # 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.

130

"x": 3.14, # X coordinate.

131

"y": 3.14, # Y coordinate.

132

},

133

],

134

"vertices": [ # The bounding polygon vertices.

135

{ # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.

136

"x": 42, # X coordinate.

137

"y": 42, # Y coordinate.

},

],

},

"productSet": "A String", # The resource name of a ProductSet to be searched for similar images. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`.

142

},

143

},

144

"image": { # Client image to perform Google Cloud Vision API tasks over. # The image to be processed.

145

"content": "A String", # Image content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateImages requests. It does not work for AsyncBatchAnnotateImages requests.

146

"source": { # External image source (Google Cloud Storage or web URL image location). # Google Cloud Storage image location, or publicly-accessible image URL. If both `content` and `source` are provided for an image, `content` takes precedence and is used to perform the image annotation request.

147

"imageUri": "A String", # The URI of the source image. Can be either: 1. A Google Cloud Storage URI of the form `gs://bucket_name/object_name`. Object versioning is not supported. See [Google Cloud Storage Request URIs](https://cloud.google.com/storage/docs/reference-uris) for more info. 2. A publicly-accessible image HTTP/HTTPS URL. When fetching images from HTTP/HTTPS URLs, Google cannot guarantee that the request will be completed. Your request may fail if the specified host denies the request (e.g. due to request throttling or DOS prevention), or if Google throttles requests to the site for abuse prevention. You should not depend on externally-hosted images for production applications. When both `gcs_image_uri` and `image_uri` are specified, `image_uri` takes precedence.

148

"gcsImageUri": "A String", # **Use `image_uri` instead.** The Google Cloud Storage URI of the form `gs://bucket_name/object_name`. Object versioning is not supported. See [Google Cloud Storage Request URIs](https://cloud.google.com/storage/docs/reference-uris) for more info.

149

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

150

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

151

"features": [ # Requested features.

152

{ # The type of Google Cloud Vision API detection to perform, and the maximum number of results to return for that type. Multiple `Feature` objects can be specified in the `features` list.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

153

"maxResults": 42, # Maximum number of results of this type. Does not apply to `TEXT_DETECTION`, `DOCUMENT_TEXT_DETECTION`, or `CROP_HINTS`.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

154

"model": "A String", # Model to use for the feature. Supported values: "builtin/stable" (the default if unset) and "builtin/latest".

155

"type": "A String", # The feature type.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

156

},

157

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

},

],

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

169

170

{ # Response to a batch image annotation request.

171

"responses": [ # Individual responses to image annotation requests within the batch.

172

{ # Response to an image annotation request.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

173

"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # If set, represents the error message for the operation. Note that filled-in image annotations are guaranteed to be correct, even when `error` is set.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

174

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

175

{

176

"a_key": "", # Properties of the object. Contains field @type with type URL.

177

},

178

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

179

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

180

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

181

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

182

"textAnnotations": [ # If present, text (OCR) detection has completed successfully.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

183

{ # Set of detected entity features.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

184

"locations": [ # The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks.

185

{ # Detected entity location information.

186

"latLng": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the WGS84 standard. Values must be within normalized ranges. # lat/long location coordinates.

187

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

188

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].

189

},

190

},

191

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

192

"confidence": 3.14, # **Deprecated. Use `score` instead.** The accuracy of the entity detection in an image. For example, for an image in which the "Eiffel Tower" entity is detected, this field represents the confidence that there is a tower in the query image. Range [0, 1].

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

193

"topicality": 3.14, # The relevancy of the ICA (Image Content Annotation) label to the image. For example, the relevancy of "tower" is likely higher to an image containing the detected "Eiffel Tower" than to an image containing a detected distant towering building, even though the confidence that there is a tower in each image may be the same. Range [0, 1].

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

194

"boundingPoly": { # A bounding polygon for the detected image annotation. # Image region to which this entity belongs. Not produced for `LABEL_DETECTION` features.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

195

"normalizedVertices": [ # The bounding polygon normalized vertices.

196

{ # 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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

197

"x": 3.14, # X coordinate.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

198

"y": 3.14, # Y coordinate.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

199

},

200

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

201

"vertices": [ # The bounding polygon vertices.

202

{ # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.

203

"x": 42, # X coordinate.

204

"y": 42, # Y coordinate.

205

},

206

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

207

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

208

"score": 3.14, # Overall score of the result. Range [0, 1].

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

209

"description": "A String", # Entity textual description, expressed in its `locale` language.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

210

"mid": "A String", # Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/).

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

211

"properties": [ # Some entities may have optional user-supplied `Property` (name/value) fields, such a score or string that qualifies the entity.

212

{ # A `Property` consists of a user-supplied name/value pair.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

213

"name": "A String", # Name of the property.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

214

"uint64Value": "A String", # Value of numeric properties.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

215

"value": "A String", # Value of the property.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

216

},

217

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

218

"locale": "A String", # The language code for the locale in which the entity textual `description` is expressed.

219

},

220

],

221

"localizedObjectAnnotations": [ # If present, localized object detection has completed successfully. This will be sorted descending by confidence score.

222

{ # Set of detected objects with bounding boxes.

223

"mid": "A String", # Object ID that should align with EntityAnnotation mid.

224

"boundingPoly": { # A bounding polygon for the detected image annotation. # Image region to which this object belongs. This must be populated.

225

"normalizedVertices": [ # The bounding polygon normalized vertices.

226

{ # 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.

227

"x": 3.14, # X coordinate.

228

"y": 3.14, # Y coordinate.

229

},

230

],

231

"vertices": [ # The bounding polygon vertices.

232

{ # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.

233

"x": 42, # X coordinate.

234

"y": 42, # Y coordinate.

},

],

},

"languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.

239

"name": "A String", # Object name, expressed in its `language_code` language.

240

"score": 3.14, # Score of the result. Range [0, 1].

241

},

242

],

243

"context": { # If an image was produced from a file (e.g. a PDF), this message gives information about the source of that image. # If present, contextual information is needed to understand where this image comes from.

244

"uri": "A String", # The URI of the file used to produce the image.

245

"pageNumber": 42, # If the file was a PDF or TIFF, this field gives the page number within the file used to produce the image.

246

},

247

"logoAnnotations": [ # If present, logo detection has completed successfully.

248

{ # Set of detected entity features.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

249

"locations": [ # The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks.

250

{ # Detected entity location information.

251

"latLng": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the WGS84 standard. Values must be within normalized ranges. # lat/long location coordinates.

252

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

253

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].

254

},

255

},

256

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

257

"confidence": 3.14, # **Deprecated. Use `score` instead.** The accuracy of the entity detection in an image. For example, for an image in which the "Eiffel Tower" entity is detected, this field represents the confidence that there is a tower in the query image. Range [0, 1].

258

"topicality": 3.14, # The relevancy of the ICA (Image Content Annotation) label to the image. For example, the relevancy of "tower" is likely higher to an image containing the detected "Eiffel Tower" than to an image containing a detected distant towering building, even though the confidence that there is a tower in each image may be the same. Range [0, 1].

259

"boundingPoly": { # A bounding polygon for the detected image annotation. # Image region to which this entity belongs. Not produced for `LABEL_DETECTION` features.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

260

"normalizedVertices": [ # The bounding polygon normalized vertices.

261

{ # 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.

262

"x": 3.14, # X coordinate.

263

"y": 3.14, # Y coordinate.

264

},

265

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

266

"vertices": [ # The bounding polygon vertices.

267

{ # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.

268

"x": 42, # X coordinate.

269

"y": 42, # Y coordinate.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

270

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

271

],

272

},

273

"score": 3.14, # Overall score of the result. Range [0, 1].

274

"description": "A String", # Entity textual description, expressed in its `locale` language.

275

"mid": "A String", # Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/).

276

"properties": [ # Some entities may have optional user-supplied `Property` (name/value) fields, such a score or string that qualifies the entity.

277

{ # A `Property` consists of a user-supplied name/value pair.

278

"name": "A String", # Name of the property.

279

"uint64Value": "A String", # Value of numeric properties.

280

"value": "A String", # Value of the property.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

281

},

282

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

283

"locale": "A String", # The language code for the locale in which the entity textual `description` is expressed.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

284

},

285

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

286

"fullTextAnnotation": { # TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail. # If present, text (OCR) detection or document (OCR) text detection has completed successfully. This annotation provides the structural hierarchy for the OCR detected text.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

287

"pages": [ # List of pages detected by OCR.

288

{ # Detected page from OCR.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

289

"confidence": 3.14, # Confidence of the OCR results on the page. Range [0, 1].

290

"height": 42, # Page height. For PDFs the unit is points. For images (including TIFFs) the unit is pixels.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

291

"blocks": [ # List of blocks of text, images etc on this page.

292

{ # Logical element on the page.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

293

"blockType": "A String", # Detected block type (text, image etc) for this block.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

294

"paragraphs": [ # List of paragraphs in this block (if this blocks is of type text).

295

{ # Structural unit of text representing a number of words in certain order.

296

"property": { # Additional information detected on the structural component. # Additional information detected for the paragraph.

297

"detectedLanguages": [ # A list of detected languages together with confidence.

298

{ # Detected language for a structural component.

299

"languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.

300

"confidence": 3.14, # Confidence of detected language. Range [0, 1].

301

},

302

],

303

"detectedBreak": { # Detected start or end of a structural component. # Detected start or end of a text segment.

304

"isPrefix": True or False, # True if break prepends the element.

305

"type": "A String", # Detected break type.

306

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

307

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

308

"words": [ # List of all words in this paragraph.

309

{ # A word representation.

310

"confidence": 3.14, # Confidence of the OCR results for the word. Range [0, 1].

311

"property": { # Additional information detected on the structural component. # Additional information detected for the word.

312

"detectedLanguages": [ # A list of detected languages together with confidence.

313

{ # Detected language for a structural component.

314

"languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.

315

"confidence": 3.14, # Confidence of detected language. Range [0, 1].

316

},

317

],

318

"detectedBreak": { # Detected start or end of a structural component. # Detected start or end of a text segment.

319

"isPrefix": True or False, # True if break prepends the element.

320

"type": "A String", # Detected break type.

321

},

322

},

323

"boundingBox": { # A bounding polygon for the detected image annotation. # The bounding box for the word. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3).

324

"normalizedVertices": [ # The bounding polygon normalized vertices.

325

{ # 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.

326

"x": 3.14, # X coordinate.

327

"y": 3.14, # Y coordinate.

328

},

329

],

330

"vertices": [ # The bounding polygon vertices.

331

{ # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.

332

"x": 42, # X coordinate.

333

"y": 42, # Y coordinate.

},

],

},

"symbols": [ # List of symbols in the word. The order of the symbols follows the natural reading order.

338

{ # A single symbol representation.

339

"confidence": 3.14, # Confidence of the OCR results for the symbol. Range [0, 1].

340

"property": { # Additional information detected on the structural component. # Additional information detected for the symbol.

341

"detectedLanguages": [ # A list of detected languages together with confidence.

342

{ # Detected language for a structural component.

343

"languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.

344

"confidence": 3.14, # Confidence of detected language. Range [0, 1].

345

},

346

],

347

"detectedBreak": { # Detected start or end of a structural component. # Detected start or end of a text segment.

348

"isPrefix": True or False, # True if break prepends the element.

349

"type": "A String", # Detected break type.

350

},

351

},

352

"boundingBox": { # A bounding polygon for the detected image annotation. # The bounding box for the symbol. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3).

353

"normalizedVertices": [ # The bounding polygon normalized vertices.

354

{ # 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.

355

"x": 3.14, # X coordinate.

356

"y": 3.14, # Y coordinate.

357

},

358

],

359

"vertices": [ # The bounding polygon vertices.

360

{ # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.

361

"x": 42, # X coordinate.

362

"y": 42, # Y coordinate.

},

],

},

"text": "A String", # The actual UTF-8 representation of the symbol.

},

],

},

],

"boundingBox": { # A bounding polygon for the detected image annotation. # The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3).

372

"normalizedVertices": [ # The bounding polygon normalized vertices.

373

{ # 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.

374

"x": 3.14, # X coordinate.

375

"y": 3.14, # Y coordinate.

376

},

377

],

378

"vertices": [ # The bounding polygon vertices.

379

{ # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.

380

"x": 42, # X coordinate.

381

"y": 42, # Y coordinate.

},

],

},

"confidence": 3.14, # Confidence of the OCR results for the paragraph. Range [0, 1].

386

},

387

],

388

"boundingBox": { # A bounding polygon for the detected image annotation. # The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3).

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

389

"normalizedVertices": [ # The bounding polygon normalized vertices.

390

{ # 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.

391

"x": 3.14, # X coordinate.

392

"y": 3.14, # Y coordinate.

393

},

394

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

395

"vertices": [ # The bounding polygon vertices.

396

{ # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.

397

"x": 42, # X coordinate.

398

"y": 42, # Y coordinate.

399

},

400

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

401

},

402

"property": { # Additional information detected on the structural component. # Additional information detected for the block.

403

"detectedLanguages": [ # A list of detected languages together with confidence.

404

{ # Detected language for a structural component.

405

"languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.

406

"confidence": 3.14, # Confidence of detected language. Range [0, 1].

407

},

408

],

409

"detectedBreak": { # Detected start or end of a structural component. # Detected start or end of a text segment.

410

"isPrefix": True or False, # True if break prepends the element.

411

"type": "A String", # Detected break type.

412

},

413

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

414

"confidence": 3.14, # Confidence of the OCR results on the block. Range [0, 1].

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

415

},

416

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

417

"property": { # Additional information detected on the structural component. # Additional information detected on the page.

418

"detectedLanguages": [ # A list of detected languages together with confidence.

419

{ # Detected language for a structural component.

420

"languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.

421

"confidence": 3.14, # Confidence of detected language. Range [0, 1].

422

},

423

],

424

"detectedBreak": { # Detected start or end of a structural component. # Detected start or end of a text segment.

425

"isPrefix": True or False, # True if break prepends the element.

426

"type": "A String", # Detected break type.

427

},

428

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

429

"width": 42, # Page width. For PDFs the unit is points. For images (including TIFFs) the unit is pixels.

430

},

431

],

432

"text": "A String", # UTF-8 text detected on the pages.

433

},

434

"imagePropertiesAnnotation": { # Stores image properties, such as dominant colors. # If present, image properties were extracted successfully.

435

"dominantColors": { # Set of dominant colors and their corresponding scores. # If present, dominant colors completed successfully.

436

"colors": [ # RGB color values with their score and pixel fraction.

437

{ # Color information consists of RGB channels, score, and the fraction of the image that the color occupies in the image.

438

"color": { # Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to/from color representations in various languages over compactness; for example, the fields of this representation can be trivially provided to the constructor of "java.awt.Color" in Java; it can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha" method in iOS; and, with just a little work, it can be easily formatted into a CSS "rgba()" string in JavaScript, as well. Note: this proto does not carry information about the absolute color space that should be used to interpret the RGB value (e.g. sRGB, Adobe RGB, DCI-P3, BT.2020, etc.). By default, applications SHOULD assume the sRGB color space. Note: when color equality needs to be decided, implementations, unless documented otherwise, will treat two colors to be equal if all their red, green, blue and alpha values each differ by at most 1e-5. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor_(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor_ = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ... # RGB components of the color.

439

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: pixel color = alpha * (this color) + (1.0 - alpha) * (background color) This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is to be rendered as a solid color (as if the alpha value had been explicitly given with a value of 1.0).

440

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

441

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

442

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

443

},

444

"pixelFraction": 3.14, # The fraction of pixels the color occupies in the image. Value in range [0, 1].

445

"score": 3.14, # Image-specific score for this color. Value in range [0, 1].

},

],

},

},

"webDetection": { # Relevant information for the image from the Internet. # If present, web detection has completed successfully.

451

"fullMatchingImages": [ # Fully matching images from the Internet. Can include resized copies of the query image.

452

{ # Metadata for online images.

453

"score": 3.14, # (Deprecated) Overall relevancy score for the image.

454

"url": "A String", # The result image URL.

455

},

456

],

457

"partialMatchingImages": [ # Partial matching images from the Internet. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops.

458

{ # Metadata for online images.

459

"score": 3.14, # (Deprecated) Overall relevancy score for the image.

460

"url": "A String", # The result image URL.

461

},

462

],

463

"pagesWithMatchingImages": [ # Web pages containing the matching images from the Internet.

464

{ # Metadata for web pages.

465

"url": "A String", # The result web page URL.

466

"score": 3.14, # (Deprecated) Overall relevancy score for the web page.

467

"fullMatchingImages": [ # Fully matching images on the page. Can include resized copies of the query image.

468

{ # Metadata for online images.

469

"score": 3.14, # (Deprecated) Overall relevancy score for the image.

470

"url": "A String", # The result image URL.

471

},

472

],

473

"partialMatchingImages": [ # Partial matching images on the page. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops.

474

{ # Metadata for online images.

475

"score": 3.14, # (Deprecated) Overall relevancy score for the image.

476

"url": "A String", # The result image URL.

477

},

478

],

479

"pageTitle": "A String", # Title for the web page, may contain HTML markups.

480

},

481

],

482

"bestGuessLabels": [ # The service's best guess as to the topic of the request image. Inferred from similar images on the open web.

483

{ # Label to provide extra metadata for the web detection.

484

"label": "A String", # Label for extra metadata.

485

"languageCode": "A String", # The BCP-47 language code for `label`, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.

486

},

487

],

488

"visuallySimilarImages": [ # The visually similar image results.

489

{ # Metadata for online images.

490

"score": 3.14, # (Deprecated) Overall relevancy score for the image.

491

"url": "A String", # The result image URL.

492

},

493

],

494

"webEntities": [ # Deduced entities from similar images on the Internet.

495

{ # Entity deduced from similar images on the Internet.

496

"score": 3.14, # Overall relevancy score for the entity. Not normalized and not comparable across different image queries.

497

"description": "A String", # Canonical description of the entity, in English.

498

"entityId": "A String", # Opaque entity ID.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

499

},

500

],

501

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

502

"landmarkAnnotations": [ # If present, landmark detection has completed successfully.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

503

{ # Set of detected entity features.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

504

"locations": [ # The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks.

505

{ # Detected entity location information.

506

"latLng": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the WGS84 standard. Values must be within normalized ranges. # lat/long location coordinates.

507

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

508

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].

509

},

510

},

511

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

512

"confidence": 3.14, # **Deprecated. Use `score` instead.** The accuracy of the entity detection in an image. For example, for an image in which the "Eiffel Tower" entity is detected, this field represents the confidence that there is a tower in the query image. Range [0, 1].

513

"topicality": 3.14, # The relevancy of the ICA (Image Content Annotation) label to the image. For example, the relevancy of "tower" is likely higher to an image containing the detected "Eiffel Tower" than to an image containing a detected distant towering building, even though the confidence that there is a tower in each image may be the same. Range [0, 1].

514

"boundingPoly": { # A bounding polygon for the detected image annotation. # Image region to which this entity belongs. Not produced for `LABEL_DETECTION` features.

515

"normalizedVertices": [ # The bounding polygon normalized vertices.

516

{ # 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.

517

"x": 3.14, # X coordinate.

518

"y": 3.14, # Y coordinate.

519

},

520

],

521

"vertices": [ # The bounding polygon vertices.

522

{ # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.

523

"x": 42, # X coordinate.

524

"y": 42, # Y coordinate.

},

],

},

"score": 3.14, # Overall score of the result. Range [0, 1].

529

"description": "A String", # Entity textual description, expressed in its `locale` language.

530

"mid": "A String", # Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/).

531

"properties": [ # Some entities may have optional user-supplied `Property` (name/value) fields, such a score or string that qualifies the entity.

532

{ # A `Property` consists of a user-supplied name/value pair.

533

"name": "A String", # Name of the property.

534

"uint64Value": "A String", # Value of numeric properties.

535

"value": "A String", # Value of the property.

536

},

537

],

538

"locale": "A String", # The language code for the locale in which the entity textual `description` is expressed.

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

539

},

540

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

541

"cropHintsAnnotation": { # Set of crop hints that are used to generate new crops when serving images. # If present, crop hints have completed successfully.

542

"cropHints": [ # Crop hint results.

543

{ # Single crop hint that is used to generate a new crop when serving an image.

544

"boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the crop region. The coordinates of the bounding box are in the original image's scale.

545

"normalizedVertices": [ # The bounding polygon normalized vertices.

546

{ # 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.

547

"x": 3.14, # X coordinate.

548

"y": 3.14, # Y coordinate.

549

},

550

],

551

"vertices": [ # The bounding polygon vertices.

552

{ # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.

553

"x": 42, # X coordinate.

554

"y": 42, # Y coordinate.

},

],

},

"importanceFraction": 3.14, # Fraction of importance of this salient region with respect to the original image.

559

"confidence": 3.14, # Confidence of this being a salient region. Range [0, 1].

},

],

},

"faceAnnotations": [ # If present, face detection has completed successfully.

564

{ # A face annotation object contains the results of face detection.

565

"panAngle": 3.14, # Yaw angle, which indicates the leftward/rightward angle that the face is pointing relative to the vertical plane perpendicular to the image. Range [-180,180].

566

"detectionConfidence": 3.14, # Detection confidence. Range [0, 1].

567

"blurredLikelihood": "A String", # Blurred likelihood.

568

"landmarks": [ # Detected face landmarks.

569

{ # A face-specific landmark (for example, a face feature).

570

"position": { # A 3D position in the image, used primarily for Face detection landmarks. A valid Position must have both x and y coordinates. The position coordinates are in the same scale as the original image. # Face landmark position.

571

"x": 3.14, # X coordinate.

572

"z": 3.14, # Z coordinate (or depth).

573

"y": 3.14, # Y coordinate.

574

},

575

"type": "A String", # Face landmark type.

576

},

577

],

578

"surpriseLikelihood": "A String", # Surprise likelihood.

579

"headwearLikelihood": "A String", # Headwear likelihood.

580

"rollAngle": 3.14, # Roll angle, which indicates the amount of clockwise/anti-clockwise rotation of the face relative to the image vertical about the axis perpendicular to the face. Range [-180,180].

581

"landmarkingConfidence": 3.14, # Face landmarking confidence. Range [0, 1].

582

"joyLikelihood": "A String", # Joy likelihood.

583

"fdBoundingPoly": { # A bounding polygon for the detected image annotation. # The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the "amount of skin" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the fd (face detection) prefix.

584

"normalizedVertices": [ # The bounding polygon normalized vertices.

585

{ # 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.

586

"x": 3.14, # X coordinate.

587

"y": 3.14, # Y coordinate.

588

},

589

],

590

"vertices": [ # The bounding polygon vertices.

591

{ # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.

592

"x": 42, # X coordinate.

593

"y": 42, # Y coordinate.

},

],

},

"underExposedLikelihood": "A String", # Under-exposed likelihood.

598

"angerLikelihood": "A String", # Anger likelihood.

599

"boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon around the face. The coordinates of the bounding box are in the original image's scale. The bounding box is computed to "frame" the face in accordance with human expectations. It is based on the landmarker results. Note that one or more x and/or y coordinates may not be generated in the `BoundingPoly` (the polygon will be unbounded) if only a partial face appears in the image to be annotated.

600

"normalizedVertices": [ # The bounding polygon normalized vertices.

601

{ # 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.

602

"x": 3.14, # X coordinate.

603

"y": 3.14, # Y coordinate.

604

},

605

],

606

"vertices": [ # The bounding polygon vertices.

607

{ # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.

608

"x": 42, # X coordinate.

609

"y": 42, # Y coordinate.

},

],

},

"tiltAngle": 3.14, # Pitch angle, which indicates the upwards/downwards angle that the face is pointing relative to the image's horizontal plane. Range [-180,180].

614

"sorrowLikelihood": "A String", # Sorrow likelihood.

615

},

616

],

617

"productSearchResults": { # Results for a product search request. # If present, product search has completed successfully.

618

"results": [ # List of results, one for each product match.

619

{ # Information about a product.

620

"image": "A String", # The resource name of the image from the product that is the closest match to the query.

621

"score": 3.14, # A confidence level on the match, ranging from 0 (no confidence) to 1 (full confidence).

622

"product": { # A Product contains ReferenceImages. # The Product.

623

"productCategory": "A String", # Immutable. The category for the product identified by the reference image. This should be one of "homegoods-v2", "apparel-v2", "toys-v2", "packagedgoods-v1" or "general-v1". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products.

624

"name": "A String", # The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product.

625

"productLabels": [ # Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. "1199". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 500 product_labels. Notice that the total number of distinct product_labels over all products in one ProductSet cannot exceed 1M, otherwise the product search pipeline will refuse to work for that ProductSet.

626

{ # A product label represented as a key-value pair.

627

"value": "A String", # The value of the label attached to the product. Cannot be empty and cannot exceed 128 bytes.

628

"key": "A String", # The key of the label attached to the product. Cannot be empty and cannot exceed 128 bytes.

629

},

630

],

631

"displayName": "A String", # The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long.

632

"description": "A String", # User-provided metadata to be stored with this product. Must be at most 4096 characters long.

},

},

],

"indexTime": "A String", # Timestamp of the index which provided these results. Products added to the product set and products removed from the product set after this time are not reflected in the current results.

637

"productGroupedResults": [ # List of results grouped by products detected in the query image. Each entry corresponds to one bounding polygon in the query image, and contains the matching products specific to that region. There may be duplicate product matches in the union of all the per-product results.

638

{ # Information about the products similar to a single product in a query image.

639

"boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon around the product detected in the query image.

640

"normalizedVertices": [ # The bounding polygon normalized vertices.

641

{ # 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.

642

"x": 3.14, # X coordinate.

643

"y": 3.14, # Y coordinate.

644

},

645

],

646

"vertices": [ # The bounding polygon vertices.

647

{ # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.

648

"x": 42, # X coordinate.

649

"y": 42, # Y coordinate.

},

],

},

"objectAnnotations": [ # List of generic predictions for the object in the bounding box.

654

{ # Prediction for what the object in the bounding box is.

655

"mid": "A String", # Object ID that should align with EntityAnnotation mid.

656

"name": "A String", # Object name, expressed in its `language_code` language.

657

"score": 3.14, # Score of the result. Range [0, 1].

658

"languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.

659

},

660

],

661

"results": [ # List of results, one for each product match.

662

{ # Information about a product.

663

"image": "A String", # The resource name of the image from the product that is the closest match to the query.

664

"score": 3.14, # A confidence level on the match, ranging from 0 (no confidence) to 1 (full confidence).

665

"product": { # A Product contains ReferenceImages. # The Product.

666

"productCategory": "A String", # Immutable. The category for the product identified by the reference image. This should be one of "homegoods-v2", "apparel-v2", "toys-v2", "packagedgoods-v1" or "general-v1". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products.

667

"name": "A String", # The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product.

668

"productLabels": [ # Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. "1199". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 500 product_labels. Notice that the total number of distinct product_labels over all products in one ProductSet cannot exceed 1M, otherwise the product search pipeline will refuse to work for that ProductSet.

669

{ # A product label represented as a key-value pair.

670

"value": "A String", # The value of the label attached to the product. Cannot be empty and cannot exceed 128 bytes.

671

"key": "A String", # The key of the label attached to the product. Cannot be empty and cannot exceed 128 bytes.

672

},

673

],

674

"displayName": "A String", # The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long.

675

"description": "A String", # User-provided metadata to be stored with this product. Must be at most 4096 characters long.

},

},

],

},

],

},

"labelAnnotations": [ # If present, label detection has completed successfully.

683

{ # Set of detected entity features.

684

"locations": [ # The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks.

685

{ # Detected entity location information.

686

"latLng": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the WGS84 standard. Values must be within normalized ranges. # lat/long location coordinates.

687

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

688

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].

},

},

],

"confidence": 3.14, # **Deprecated. Use `score` instead.** The accuracy of the entity detection in an image. For example, for an image in which the "Eiffel Tower" entity is detected, this field represents the confidence that there is a tower in the query image. Range [0, 1].

693

"topicality": 3.14, # The relevancy of the ICA (Image Content Annotation) label to the image. For example, the relevancy of "tower" is likely higher to an image containing the detected "Eiffel Tower" than to an image containing a detected distant towering building, even though the confidence that there is a tower in each image may be the same. Range [0, 1].

694

"boundingPoly": { # A bounding polygon for the detected image annotation. # Image region to which this entity belongs. Not produced for `LABEL_DETECTION` features.

695

"normalizedVertices": [ # The bounding polygon normalized vertices.

696

{ # 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.

697

"x": 3.14, # X coordinate.

698

"y": 3.14, # Y coordinate.

699

},

700

],

701

"vertices": [ # The bounding polygon vertices.

702

{ # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.

703

"x": 42, # X coordinate.

704

"y": 42, # Y coordinate.

},

],

},

"score": 3.14, # Overall score of the result. Range [0, 1].

709

"description": "A String", # Entity textual description, expressed in its `locale` language.

710

"mid": "A String", # Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/).

711

"properties": [ # Some entities may have optional user-supplied `Property` (name/value) fields, such a score or string that qualifies the entity.

712

{ # A `Property` consists of a user-supplied name/value pair.

713

"name": "A String", # Name of the property.

714

"uint64Value": "A String", # Value of numeric properties.

715

"value": "A String", # Value of the property.

716

},

717

],

718

"locale": "A String", # The language code for the locale in which the entity textual `description` is expressed.

719

},

720

],

721

"safeSearchAnnotation": { # Set of features pertaining to the image, computed by computer vision methods over safe-search verticals (for example, adult, spoof, medical, violence). # If present, safe-search annotation has completed successfully.

722

"adult": "A String", # Represents the adult content likelihood for the image. Adult content may contain elements such as nudity, pornographic images or cartoons, or sexual activities.

723

"violence": "A String", # Likelihood that this image contains violent content.

724

"spoof": "A String", # Spoof likelihood. The likelihood that an modification was made to the image's canonical version to make it appear funny or offensive.

725

"racy": "A String", # Likelihood that the request image contains racy content. Racy content may include (but is not limited to) skimpy or sheer clothing, strategically covered nudity, lewd or provocative poses, or close-ups of sensitive body areas.

726

"medical": "A String", # Likelihood that this is a medical image.

727

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

},

],

}</pre>

</div>

<code class="details" id="asyncBatchAnnotate">asyncBatchAnnotate(parent, body=None, x__xgafv=None)</code>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

735

<pre>Run asynchronous image detection and annotation for a list of images. Progress and results can be retrieved through the `google.longrunning.Operations` interface. `Operation.metadata` contains `OperationMetadata` (metadata). `Operation.response` contains `AsyncBatchAnnotateImagesResponse` (results). This service will write image annotation outputs to json files in customer GCS bucket, each json file containing BatchAnnotateImagesResponse proto.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

736

737

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

738

parent: string, Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. (required)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

739

body: object, The request body.

740

The object takes the form of:

741

742

{ # Request for async image annotation for a list of images.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

743

"parent": "A String", # Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

744

"requests": [ # Required. Individual image annotation requests for this batch.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

745

{ # Request for performing Google Cloud Vision API tasks over a user-provided image, with user-requested features, and with context information.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

746

"imageContext": { # Image context and/or feature-specific parameters. # Additional context that may accompany the image.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

747

"languageHints": [ # List of languages to use for TEXT_DETECTION. In most cases, an empty value yields the best results since it enables automatic language detection. For languages based on the Latin alphabet, setting `language_hints` is not needed. In rare cases, when the language of the text in the image is known, setting a hint will help get better results (although it will be a significant hindrance if the hint is wrong). Text detection returns an error if one or more of the specified languages is not one of the [supported languages](https://cloud.google.com/vision/docs/languages).

748

"A String",

749

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

750

"latLongRect": { # Rectangle determined by min and max `LatLng` pairs. # Not used.

751

"minLatLng": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the WGS84 standard. Values must be within normalized ranges. # Min lat/long pair.

752

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

753

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].

754

},

755

"maxLatLng": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the WGS84 standard. Values must be within normalized ranges. # Max lat/long pair.

756

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

757

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].

758

},

759

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

760

"cropHintsParams": { # Parameters for crop hints annotation request. # Parameters for crop hints annotation request.

761

"aspectRatios": [ # Aspect ratios in floats, representing the ratio of the width to the height of the image. For example, if the desired aspect ratio is 4/3, the corresponding float value should be 1.33333. If not specified, the best possible crop is returned. The number of provided aspect ratios is limited to a maximum of 16; any aspect ratios provided after the 16th are ignored.

762

3.14,

763

],

764

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

765

"webDetectionParams": { # Parameters for web detection request. # Parameters for web detection.

766

"includeGeoResults": True or False, # Whether to include results derived from the geo information in the image.

767

},

768

"productSearchParams": { # Parameters for a product search request. # Parameters for product search.

769

"filter": "A String", # The filtering expression. This can be used to restrict search results based on Product labels. We currently support an AND of OR of key-value expressions, where each expression within an OR must have the same key. An '=' should be used to connect the key and value. For example, "(color = red OR color = blue) AND brand = Google" is acceptable, but "(color = red OR brand = Google)" is not acceptable. "color: red" is not acceptable because it uses a ':' instead of an '='.

770

"productCategories": [ # The list of product categories to search in. Currently, we only consider the first category, and either "homegoods-v2", "apparel-v2", "toys-v2", "packagedgoods-v1", or "general-v1" should be specified. The legacy categories "homegoods", "apparel", and "toys" are still supported but will be deprecated. For new products, please use "homegoods-v2", "apparel-v2", or "toys-v2" for better product search accuracy. It is recommended to migrate existing products to these categories as well.

771

"A String",

772

],

773

"boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon around the area of interest in the image. If it is not specified, system discretion will be applied.

774

"normalizedVertices": [ # The bounding polygon normalized vertices.

775

{ # 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.

776

"x": 3.14, # X coordinate.

777

"y": 3.14, # Y coordinate.

778

},

779

],

780

"vertices": [ # The bounding polygon vertices.

781

{ # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.

782

"x": 42, # X coordinate.

783

"y": 42, # Y coordinate.

},

],

},

"productSet": "A String", # The resource name of a ProductSet to be searched for similar images. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`.

788

},

789

},

790

"image": { # Client image to perform Google Cloud Vision API tasks over. # The image to be processed.

791

"content": "A String", # Image content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateImages requests. It does not work for AsyncBatchAnnotateImages requests.

792

"source": { # External image source (Google Cloud Storage or web URL image location). # Google Cloud Storage image location, or publicly-accessible image URL. If both `content` and `source` are provided for an image, `content` takes precedence and is used to perform the image annotation request.

793

"imageUri": "A String", # The URI of the source image. Can be either: 1. A Google Cloud Storage URI of the form `gs://bucket_name/object_name`. Object versioning is not supported. See [Google Cloud Storage Request URIs](https://cloud.google.com/storage/docs/reference-uris) for more info. 2. A publicly-accessible image HTTP/HTTPS URL. When fetching images from HTTP/HTTPS URLs, Google cannot guarantee that the request will be completed. Your request may fail if the specified host denies the request (e.g. due to request throttling or DOS prevention), or if Google throttles requests to the site for abuse prevention. You should not depend on externally-hosted images for production applications. When both `gcs_image_uri` and `image_uri` are specified, `image_uri` takes precedence.

794

"gcsImageUri": "A String", # **Use `image_uri` instead.** The Google Cloud Storage URI of the form `gs://bucket_name/object_name`. Object versioning is not supported. See [Google Cloud Storage Request URIs](https://cloud.google.com/storage/docs/reference-uris) for more info.

795

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

796

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

797

"features": [ # Requested features.

798

{ # The type of Google Cloud Vision API detection to perform, and the maximum number of results to return for that type. Multiple `Feature` objects can be specified in the `features` list.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

799

"maxResults": 42, # Maximum number of results of this type. Does not apply to `TEXT_DETECTION`, `DOCUMENT_TEXT_DETECTION`, or `CROP_HINTS`.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

800

"model": "A String", # Model to use for the feature. Supported values: "builtin/stable" (the default if unset) and "builtin/latest".

801

"type": "A String", # The feature type.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

802

},

803

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

804

},

805

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

806

"outputConfig": { # The desired output location and metadata. # Required. The desired output location and metadata (e.g. format).

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

807

"gcsDestination": { # The Google Cloud Storage location where the output will be written to. # The Google Cloud Storage location to write the output(s) to.

808

"uri": "A String", # Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with "filenameprefix". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files.

809

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

810

"batchSize": 42, # The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

811

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

812

}

813

814

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

821

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

822

{ # This resource represents a long-running operation that is the result of a network API call.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

823

"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

824

"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

825

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

Bu Sun Kim

d059ad8

2020-07-22 17:02:09 -0700

[diff] [blame]

826

{

827

"a_key": "", # Properties of the object. Contains field @type with type URL.

828

},

829

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

830

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

831

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

Bu Sun Kim

d059ad8

2020-07-22 17:02:09 -0700

[diff] [blame]

832

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

833

"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.

834

"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.

835

"a_key": "", # Properties of the object. Contains field @type with type URL.

836

},

837

"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.

838

"a_key": "", # Properties of the object. Contains field @type with type URL.

839

},

Bu Sun Kim