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

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

[diff] [blame]

105

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

106

{ # Request for performing Google Cloud Vision API tasks over a user-provided

107

# image, with user-requested features, and with context information.

108

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

Bu Sun Kim

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

[diff] [blame]

109

"source": { # External image source (Google Cloud Storage or web URL image location). # Google Cloud Storage image location, or publicly-accessible image

110

# URL. If both `content` and `source` are provided for an image, `content`

111

# takes precedence and is used to perform the image annotation request.

112

"gcsImageUri": "A String", # **Use `image_uri` instead.**

113

#

114

# The Google Cloud Storage URI of the form

115

# `gs://bucket_name/object_name`. Object versioning is not supported. See

116

# [Google Cloud Storage Request

117

# URIs](https://cloud.google.com/storage/docs/reference-uris) for more info.

118

"imageUri": "A String", # The URI of the source image. Can be either:

119

#

120

# 1. A Google Cloud Storage URI of the form

121

# `gs://bucket_name/object_name`. Object versioning is not supported. See

122

# [Google Cloud Storage Request

123

# URIs](https://cloud.google.com/storage/docs/reference-uris) for more

124

# info.

125

#

126

# 2. A publicly-accessible image HTTP/HTTPS URL. When fetching images from

127

# HTTP/HTTPS URLs, Google cannot guarantee that the request will be

128

# completed. Your request may fail if the specified host denies the

129

# request (e.g. due to request throttling or DOS prevention), or if Google

130

# throttles requests to the site for abuse prevention. You should not

131

# depend on externally-hosted images for production applications.

132

#

133

# When both `gcs_image_uri` and `image_uri` are specified, `image_uri` takes

134

# precedence.

135

},

Bu Sun Kim

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

[diff] [blame]

136

"content": "A String", # Image content, represented as a stream of bytes.

137

# Note: As with all `bytes` fields, protobuffers use a pure binary

138

# representation, whereas JSON representations use base64.

139

#

140

# Currently, this field only works for BatchAnnotateImages requests. It does

141

# not work for AsyncBatchAnnotateImages requests.

Bu Sun Kim

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

[diff] [blame]

142

},

Bu Sun Kim

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

[diff] [blame]

143

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

Bu Sun Kim

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

[diff] [blame]

144

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

145

"maxLatLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # Max lat/long pair.

146

# of doubles representing degrees latitude and degrees longitude. Unless

147

# specified otherwise, this must conform to the

148

# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84

149

# standard</a>. Values must be within normalized ranges.

150

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

151

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

152

},

153

"minLatLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # Min lat/long pair.

154

# of doubles representing degrees latitude and degrees longitude. Unless

155

# specified otherwise, this must conform to the

156

# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84

157

# standard</a>. Values must be within normalized ranges.

158

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

159

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

160

},

161

},

162

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

163

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

164

},

Bu Sun Kim

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

[diff] [blame]

165

"languageHints": [ # List of languages to use for TEXT_DETECTION. In most cases, an empty value

166

# yields the best results since it enables automatic language detection. For

167

# languages based on the Latin alphabet, setting `language_hints` is not

168

# needed. In rare cases, when the language of the text in the image is known,

169

# setting a hint will help get better results (although it will be a

170

# significant hindrance if the hint is wrong). Text detection returns an

171

# error if one or more of the specified languages is not one of the

172

# [supported languages](https://cloud.google.com/vision/docs/languages).

173

"A String",

174

],

Bu Sun Kim

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

[diff] [blame]

175

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

Bu Sun Kim

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

[diff] [blame]

176

"productCategories": [ # The list of product categories to search in. Currently, we only consider

177

# the first category, and either "homegoods-v2", "apparel-v2", "toys-v2",

178

# "packagedgoods-v1", or "general-v1" should be specified. The legacy

179

# categories "homegoods", "apparel", and "toys" are still supported but will

180

# be deprecated. For new products, please use "homegoods-v2", "apparel-v2",

181

# or "toys-v2" for better product search accuracy. It is recommended to

182

# migrate existing products to these categories as well.

183

"A String",

184

],

Bu Sun Kim

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

[diff] [blame]

185

"boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon around the area of interest in the image.

186

# If it is not specified, system discretion will be applied.

187

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

188

{ # A vertex represents a 2D point in the image.

189

# NOTE: the normalized vertex coordinates are relative to the original image

190

# and range from 0 to 1.

191

"y": 3.14, # Y coordinate.

192

"x": 3.14, # X coordinate.

193

},

194

],

195

"vertices": [ # The bounding polygon vertices.

196

{ # A vertex represents a 2D point in the image.

197

# NOTE: the vertex coordinates are in the same scale as the original image.

Bu Sun Kim

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

[diff] [blame]

198

"x": 42, # X coordinate.

Bu Sun Kim

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

[diff] [blame]

199

"y": 42, # Y coordinate.

Bu Sun Kim

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

[diff] [blame]

200

},

201

],

202

},

Bu Sun Kim

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

[diff] [blame]

203

"filter": "A String", # The filtering expression. This can be used to restrict search results based

204

# on Product labels. We currently support an AND of OR of key-value

205

# expressions, where each expression within an OR must have the same key. An

206

# '=' should be used to connect the key and value.

207

#

208

# For example, "(color = red OR color = blue) AND brand = Google" is

209

# acceptable, but "(color = red OR brand = Google)" is not acceptable.

210

# "color: red" is not acceptable because it uses a ':' instead of an '='.

211

"productSet": "A String", # The resource name of a ProductSet to be searched for similar images.

212

#

213

# Format is:

214

# `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`.

215

},

216

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

217

"aspectRatios": [ # Aspect ratios in floats, representing the ratio of the width to the height

218

# of the image. For example, if the desired aspect ratio is 4/3, the

219

# corresponding float value should be 1.33333. If not specified, the

220

# best possible crop is returned. The number of provided aspect ratios is

221

# limited to a maximum of 16; any aspect ratios provided after the 16th are

222

# ignored.

223

3.14,

Bu Sun Kim

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

[diff] [blame]

224

],

Bu Sun Kim

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

[diff] [blame]

225

},

226

},

Bu Sun Kim

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

[diff] [blame]

227

"features": [ # Requested features.

228

{ # The type of Google Cloud Vision API detection to perform, and the maximum

229

# number of results to return for that type. Multiple `Feature` objects can

230

# be specified in the `features` list.

231

"maxResults": 42, # Maximum number of results of this type. Does not apply to

232

# `TEXT_DETECTION`, `DOCUMENT_TEXT_DETECTION`, or `CROP_HINTS`.

233

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

234

"model": "A String", # Model to use for the feature.

235

# Supported values: "builtin/stable" (the default if unset) and

236

# "builtin/latest".

237

},

238

],

Bu Sun Kim

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

[diff] [blame]

239

},

240

],

Bu Sun Kim

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

[diff] [blame]

241

"parent": "A String", # Optional. Target project and location to make a call.

242

#

243

# Format: `projects/{project-id}/locations/{location-id}`.

244

#

245

# If no parent is specified, a region will be chosen automatically.

246

#

247

# Supported location-ids:

248

# `us`: USA country only,

249

# `asia`: East asia areas, like Japan, Taiwan,

250

# `eu`: The European Union.

251

#

252

# Example: `projects/project-A/locations/eu`.

Bu Sun Kim

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

[diff] [blame]

253

}

254

255

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

262

263

{ # Response to a batch image annotation request.

264

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

265

{ # Response to an image annotation request.

Bu Sun Kim

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

[diff] [blame]

266

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

Bu Sun Kim

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

[diff] [blame]

267

{ # Set of detected entity features.

Bu Sun Kim

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

[diff] [blame]

268

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

Bu Sun Kim

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

[diff] [blame]

269

"confidence": 3.14, # **Deprecated. Use `score` instead.**

270

# The accuracy of the entity detection in an image.

271

# For example, for an image in which the "Eiffel Tower" entity is detected,

272

# this field represents the confidence that there is a tower in the query

273

# image. Range [0, 1].

Bu Sun Kim

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

[diff] [blame]

274

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

275

# for `LABEL_DETECTION` features.

276

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

277

{ # A vertex represents a 2D point in the image.

278

# NOTE: the normalized vertex coordinates are relative to the original image

279

# and range from 0 to 1.

280

"y": 3.14, # Y coordinate.

281

"x": 3.14, # X coordinate.

282

},

283

],

284

"vertices": [ # The bounding polygon vertices.

285

{ # A vertex represents a 2D point in the image.

286

# NOTE: the vertex coordinates are in the same scale as the original image.

287

"x": 42, # X coordinate.

288

"y": 42, # Y coordinate.

289

},

290

],

291

},

Bu Sun Kim

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

[diff] [blame]

292

"mid": "A String", # Opaque entity ID. Some IDs may be available in

293

# [Google Knowledge Graph Search

294

# API](https://developers.google.com/knowledge-graph/).

295

"locale": "A String", # The language code for the locale in which the entity textual

296

# `description` is expressed.

Bu Sun Kim

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

[diff] [blame]

297

"topicality": 3.14, # The relevancy of the ICA (Image Content Annotation) label to the

298

# image. For example, the relevancy of "tower" is likely higher to an image

299

# containing the detected "Eiffel Tower" than to an image containing a

300

# detected distant towering building, even though the confidence that

301

# there is a tower in each image may be the same. Range [0, 1].

Bu Sun Kim

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

[diff] [blame]

302

"locations": [ # The location information for the detected entity. Multiple

303

# `LocationInfo` elements can be present because one location may

304

# indicate the location of the scene in the image, and another location

305

# may indicate the location of the place where the image was taken.

306

# Location information is usually present for landmarks.

307

{ # Detected entity location information.

308

"latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # lat/long location coordinates.

309

# of doubles representing degrees latitude and degrees longitude. Unless

310

# specified otherwise, this must conform to the

311

# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84

312

# standard</a>. Values must be within normalized ranges.

313

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

314

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

315

},

316

},

317

],

Bu Sun Kim

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

[diff] [blame]

318

"properties": [ # Some entities may have optional user-supplied `Property` (name/value)

319

# fields, such a score or string that qualifies the entity.

320

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

321

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

322

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

323

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

324

},

325

],

Bu Sun Kim

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

[diff] [blame]

326

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

Bu Sun Kim

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

[diff] [blame]

327

},

328

],

Bu Sun Kim

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

[diff] [blame]

329

"safeSearchAnnotation": { # Set of features pertaining to the image, computed by computer vision # If present, safe-search annotation has completed successfully.

330

# methods over safe-search verticals (for example, adult, spoof, medical,

331

# violence).

332

"spoof": "A String", # Spoof likelihood. The likelihood that an modification

333

# was made to the image's canonical version to make it appear

334

# funny or offensive.

335

"racy": "A String", # Likelihood that the request image contains racy content. Racy content may

336

# include (but is not limited to) skimpy or sheer clothing, strategically

337

# covered nudity, lewd or provocative poses, or close-ups of sensitive

338

# body areas.

339

"adult": "A String", # Represents the adult content likelihood for the image. Adult content may

340

# contain elements such as nudity, pornographic images or cartoons, or

341

# sexual activities.

342

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

343

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

344

},

345

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

346

"partialMatchingImages": [ # Partial matching images from the Internet.

347

# Those images are similar enough to share some key-point features. For

348

# example an original image will likely have partial matching for its crops.

349

{ # Metadata for online images.

350

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

351

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

Bu Sun Kim

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

[diff] [blame]

352

},

Bu Sun Kim

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

[diff] [blame]

353

],

354

"bestGuessLabels": [ # The service's best guess as to the topic of the request image.

355

# Inferred from similar images on the open web.

356

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

357

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

358

"languageCode": "A String", # The BCP-47 language code for `label`, such as "en-US" or "sr-Latn".

359

# For more information, see

360

# http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.

Bu Sun Kim

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

[diff] [blame]

361

},

Bu Sun Kim

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

[diff] [blame]

362

],

363

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

364

{ # Metadata for online images.

365

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

366

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

367

},

368

],

369

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

370

{ # Entity deduced from similar images on the Internet.

371

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

372

"score": 3.14, # Overall relevancy score for the entity.

373

# Not normalized and not comparable across different image queries.

374

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

375

},

376

],

377

"fullMatchingImages": [ # Fully matching images from the Internet.

378

# Can include resized copies of the query image.

379

{ # Metadata for online images.

380

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

381

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

382

},

383

],

384

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

385

{ # Metadata for web pages.

386

"fullMatchingImages": [ # Fully matching images on the page.

387

# Can include resized copies of the query image.

388

{ # Metadata for online images.

389

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

390

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

391

},

392

],

393

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

394

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

395

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

396

"partialMatchingImages": [ # Partial matching images on the page.

397

# Those images are similar enough to share some key-point features. For

398

# example an original image will likely have partial matching for its

399

# crops.

400

{ # Metadata for online images.

401

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

402

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

403

},

404

],

Bu Sun Kim

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

[diff] [blame]

405

},

406

],

407

},

Bu Sun Kim

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

[diff] [blame]

408

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

Bu Sun Kim

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

[diff] [blame]

409

"productGroupedResults": [ # List of results grouped by products detected in the query image. Each entry

410

# corresponds to one bounding polygon in the query image, and contains the

411

# matching products specific to that region. There may be duplicate product

412

# matches in the union of all the per-product results.

413

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

414

# image.

415

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

416

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

Bu Sun Kim

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

[diff] [blame]

417

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

Bu Sun Kim

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

[diff] [blame]

418

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

Bu Sun Kim

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

[diff] [blame]

419

"languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more

420

# information, see

421

# http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.

Bu Sun Kim

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

[diff] [blame]

422

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

Bu Sun Kim

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

[diff] [blame]

423

},

424

],

425

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

426

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

427

{ # A vertex represents a 2D point in the image.

428

# NOTE: the normalized vertex coordinates are relative to the original image

429

# and range from 0 to 1.

430

"y": 3.14, # Y coordinate.

431

"x": 3.14, # X coordinate.

432

},

433

],

434

"vertices": [ # The bounding polygon vertices.

435

{ # A vertex represents a 2D point in the image.

436

# NOTE: the vertex coordinates are in the same scale as the original image.

Bu Sun Kim

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

[diff] [blame]

437

"x": 42, # X coordinate.

Bu Sun Kim

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

[diff] [blame]

438

"y": 42, # Y coordinate.

Bu Sun Kim

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

[diff] [blame]

},

],

},

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

443

{ # Information about a product.

444

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

445

# to the query.

446

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

Bu Sun Kim

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

[diff] [blame]

447

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

448

# 4096 characters long.

Bu Sun Kim

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

[diff] [blame]

449

"name": "A String", # The resource name of the product.

450

#

451

# Format is:

452

# `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`.

453

#

454

# This field is ignored when creating a product.

Bu Sun Kim

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

[diff] [blame]

455

"productLabels": [ # Key-value pairs that can be attached to a product. At query time,

456

# constraints can be specified based on the product_labels.

457

#

458

# Note that integer values can be provided as strings, e.g. "1199". Only

459

# strings with integer values can match a range-based restriction which is

460

# to be supported soon.

461

#

462

# Multiple values can be assigned to the same key. One product may have up to

463

# 500 product_labels.

464

#

465

# Notice that the total number of distinct product_labels over all products

466

# in one ProductSet cannot exceed 1M, otherwise the product search pipeline

467

# will refuse to work for that ProductSet.

468

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

Bu Sun Kim

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

[diff] [blame]

469

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

470

# exceed 128 bytes.

Bu Sun Kim

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

[diff] [blame]

471

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

472

# cannot exceed 128 bytes.

Bu Sun Kim

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

[diff] [blame]

473

},

474

],

Bu Sun Kim

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

[diff] [blame]

475

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

476

# characters long.

477

"productCategory": "A String", # Immutable. The category for the product identified by the reference image. This should

478

# be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories

479

# "homegoods", "apparel", and "toys" are still supported, but these should

480

# not be used for new products.

Bu Sun Kim

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

[diff] [blame]

481

},

482

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

483

# 1 (full confidence).

},

],

},

],

Bu Sun Kim

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

[diff] [blame]

488

"indexTime": "A String", # Timestamp of the index which provided these results. Products added to the

489

# product set and products removed from the product set after this time are

490

# not reflected in the current results.

Bu Sun Kim

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

[diff] [blame]

491

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

492

{ # Information about a product.

493

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

494

# to the query.

495

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

Bu Sun Kim

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

[diff] [blame]

496

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

497

# 4096 characters long.

Bu Sun Kim

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

[diff] [blame]

498

"name": "A String", # The resource name of the product.

499

#

500

# Format is:

501

# `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`.

502

#

503

# This field is ignored when creating a product.

Bu Sun Kim

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

[diff] [blame]

504

"productLabels": [ # Key-value pairs that can be attached to a product. At query time,

505

# constraints can be specified based on the product_labels.

506

#

507

# Note that integer values can be provided as strings, e.g. "1199". Only

508

# strings with integer values can match a range-based restriction which is

509

# to be supported soon.

510

#

511

# Multiple values can be assigned to the same key. One product may have up to

512

# 500 product_labels.

513

#

514

# Notice that the total number of distinct product_labels over all products

515

# in one ProductSet cannot exceed 1M, otherwise the product search pipeline

516

# will refuse to work for that ProductSet.

517

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

Bu Sun Kim

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

[diff] [blame]

518

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

519

# exceed 128 bytes.

Bu Sun Kim

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

[diff] [blame]

520

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

521

# cannot exceed 128 bytes.

Bu Sun Kim

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

[diff] [blame]

522

},

523

],

Bu Sun Kim

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

[diff] [blame]

524

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

525

# characters long.

526

"productCategory": "A String", # Immutable. The category for the product identified by the reference image. This should

527

# be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories

528

# "homegoods", "apparel", and "toys" are still supported, but these should

529

# not be used for new products.

Bu Sun Kim

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

[diff] [blame]

530

},

531

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

532

# 1 (full confidence).

533

},

534

],

Bu Sun Kim

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

[diff] [blame]

535

},

536

"fullTextAnnotation": { # TextAnnotation contains a structured representation of OCR extracted text. # If present, text (OCR) detection or document (OCR) text detection has

537

# completed successfully.

538

# This annotation provides the structural hierarchy for the OCR detected

539

# text.

540

# The hierarchy of an OCR extracted text structure is like this:

541

# TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol

542

# Each structural component, starting from Page, may further have their own

543

# properties. Properties describe detected languages, breaks etc.. Please refer

544

# to the TextAnnotation.TextProperty message definition below for more

545

# detail.

Bu Sun Kim

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

[diff] [blame]

546

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

Bu Sun Kim

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

[diff] [blame]

547

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

548

{ # Detected page from OCR.

Bu Sun Kim

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

[diff] [blame]

549

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

550

# TIFFs) the unit is pixels.

Bu Sun Kim

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

[diff] [blame]

551

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

552

{ # Logical element on the page.

Bu Sun Kim

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

[diff] [blame]

553

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

554

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

555

"boundingBox": { # A bounding polygon for the detected image annotation. # The bounding box for the paragraph.

556

# The vertices are in the order of top-left, top-right, bottom-right,

557

# bottom-left. When a rotation of the bounding box is detected the rotation

558

# is represented as around the top-left corner as defined when the text is

559

# read in the 'natural' orientation.

560

# For example:

561

# * 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).

570

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

571

{ # A vertex represents a 2D point in the image.

572

# NOTE: the normalized vertex coordinates are relative to the original image

573

# and range from 0 to 1.

574

"y": 3.14, # Y coordinate.

575

"x": 3.14, # X coordinate.

576

},

577

],

578

"vertices": [ # The bounding polygon vertices.

579

{ # A vertex represents a 2D point in the image.

580

# NOTE: the vertex coordinates are in the same scale as the original image.

581

"x": 42, # X coordinate.

582

"y": 42, # Y coordinate.

},

],

},

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

587

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

588

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

589

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

590

},

591

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

592

{ # Detected language for a structural component.

593

"languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more

594

# information, see

595

# http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.

596

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

},

],

},

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

601

{ # A word representation.

602

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

603

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

604

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

605

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

606

},

607

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

608

{ # Detected language for a structural component.

609

"languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more

610

# information, see

611

# http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.

612

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

},

],

},

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

617

"symbols": [ # List of symbols in the word.

618

# The order of the symbols follows the natural reading order.

619

{ # A single symbol representation.

620

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

621

"boundingBox": { # A bounding polygon for the detected image annotation. # The bounding box for the symbol.

622

# The vertices are in the order of top-left, top-right, bottom-right,

623

# bottom-left. When a rotation of the bounding box is detected the rotation

624

# is represented as around the top-left corner as defined when the text is

625

# read in the 'natural' orientation.

626

# For example:

627

# * 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).

636

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

637

{ # A vertex represents a 2D point in the image.

638

# NOTE: the normalized vertex coordinates are relative to the original image

639

# and range from 0 to 1.

640

"y": 3.14, # Y coordinate.

641

"x": 3.14, # X coordinate.

642

},

643

],

644

"vertices": [ # The bounding polygon vertices.

645

{ # A vertex represents a 2D point in the image.

646

# NOTE: the vertex coordinates are in the same scale as the original image.

647

"x": 42, # X coordinate.

648

"y": 42, # Y coordinate.

},

],

},

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

653

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

654

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

655

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

656

},

657

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

658

{ # Detected language for a structural component.

659

"languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more

660

# information, see

661

# http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.

662

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

},

],

},

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

667

},

668

],

669

"boundingBox": { # A bounding polygon for the detected image annotation. # The bounding box for the word.

670

# The vertices are in the order of top-left, top-right, bottom-right,

671

# bottom-left. When a rotation of the bounding box is detected the rotation

672

# is represented as around the top-left corner as defined when the text is

673

# read in the 'natural' orientation.

674

# For example:

675

# * 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).

684

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

685

{ # A vertex represents a 2D point in the image.

686

# NOTE: the normalized vertex coordinates are relative to the original image

687

# and range from 0 to 1.

688

"y": 3.14, # Y coordinate.

689

"x": 3.14, # X coordinate.

690

},

691

],

692

"vertices": [ # The bounding polygon vertices.

693

{ # A vertex represents a 2D point in the image.

694

# NOTE: the vertex coordinates are in the same scale as the original image.

695

"x": 42, # X coordinate.

696

"y": 42, # Y coordinate.

},

],

},

},

],

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

703

},

704

],

705

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

Bu Sun Kim

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

[diff] [blame]

706

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

Bu Sun Kim

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

[diff] [blame]

707

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

Bu Sun Kim

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

[diff] [blame]

708

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

Bu Sun Kim

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

[diff] [blame]

709

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

Bu Sun Kim

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

[diff] [blame]

710

},

Bu Sun Kim

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

[diff] [blame]

711

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

712

{ # Detected language for a structural component.

713

"languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more

714

# information, see

715

# http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.

716

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

717

},

718

],

Bu Sun Kim

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

[diff] [blame]

719

},

Bu Sun Kim

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

[diff] [blame]

720

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

Bu Sun Kim

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

[diff] [blame]

721

"boundingBox": { # A bounding polygon for the detected image annotation. # The bounding box for the block.

722

# The vertices are in the order of top-left, top-right, bottom-right,

723

# bottom-left. When a rotation of the bounding box is detected the rotation

724

# is represented as around the top-left corner as defined when the text is

725

# read in the 'natural' orientation.

726

# For example:

727

#

728

# * 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).

741

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

742

{ # A vertex represents a 2D point in the image.

743

# NOTE: the normalized vertex coordinates are relative to the original image

744

# and range from 0 to 1.

745

"y": 3.14, # Y coordinate.

746

"x": 3.14, # X coordinate.

747

},

748

],

749

"vertices": [ # The bounding polygon vertices.

750

{ # A vertex represents a 2D point in the image.

751

# NOTE: the vertex coordinates are in the same scale as the original image.

Bu Sun Kim

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

[diff] [blame]

752

"x": 42, # X coordinate.

Bu Sun Kim

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

[diff] [blame]

753

"y": 42, # Y coordinate.

Bu Sun Kim

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

[diff] [blame]

754

},

755

],

756

},

Bu Sun Kim

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

[diff] [blame]

757

},

758

],

Bu Sun Kim

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

[diff] [blame]

759

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

760

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

761

# TIFFs) the unit is pixels.

Bu Sun Kim

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

[diff] [blame]

762

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

Bu Sun Kim

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

[diff] [blame]

763

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

Bu Sun Kim

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

[diff] [blame]

764

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

Bu Sun Kim

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

[diff] [blame]

765

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

Bu Sun Kim

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

[diff] [blame]

766

},

Bu Sun Kim

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

[diff] [blame]

767

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

768

{ # Detected language for a structural component.

769

"languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more

770

# information, see

771

# http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.

772

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

773

},

774

],

Bu Sun Kim

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

[diff] [blame]

775

},

Bu Sun Kim

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

[diff] [blame]

776

},

777

],

Bu Sun Kim

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

[diff] [blame]

778

},

Bu Sun Kim

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

[diff] [blame]

779

"localizedObjectAnnotations": [ # If present, localized object detection has completed successfully.

780

# This will be sorted descending by confidence score.

781

{ # Set of detected objects with bounding boxes.

782

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

783

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

784

"languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more

785

# information, see

786

# http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.

787

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

Bu Sun Kim

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

[diff] [blame]

788

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

789

{ # A vertex represents a 2D point in the image.

790

# NOTE: the normalized vertex coordinates are relative to the original image

791

# and range from 0 to 1.

792

"y": 3.14, # Y coordinate.

793

"x": 3.14, # X coordinate.

794

},

795

],

796

"vertices": [ # The bounding polygon vertices.

797

{ # A vertex represents a 2D point in the image.

798

# NOTE: the vertex coordinates are in the same scale as the original image.

Bu Sun Kim

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

[diff] [blame]

799

"x": 42, # X coordinate.

Bu Sun Kim

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

[diff] [blame]

800

"y": 42, # Y coordinate.

Bu Sun Kim

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

[diff] [blame]

801

},

802

],

803

},

Bu Sun Kim

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

[diff] [blame]

804

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

Bu Sun Kim

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

[diff] [blame]

805

},

806

],

807

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

808

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

809

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

810

{ # Color information consists of RGB channels, score, and the fraction of

811

# the image that the color occupies in the image.

Bu Sun Kim

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

[diff] [blame]

812

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

Bu Sun Kim

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

[diff] [blame]

813

"color": { # Represents a color in the RGBA color space. This representation is designed # RGB components of the color.

814

# for simplicity of conversion to/from color representations in various

815

# languages over compactness; for example, the fields of this representation

816

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

817

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

818

# method in iOS; and, with just a little work, it can be easily formatted into

819

# a CSS "rgba()" string in JavaScript, as well.

820

#

821

# Note: this proto does not carry information about the absolute color space

822

# that should be used to interpret the RGB value (e.g. sRGB, Adobe RGB,

823

# DCI-P3, BT.2020, etc.). By default, applications SHOULD assume the sRGB color

824

# space.

825

#

Bu Sun Kim

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

[diff] [blame]

826

# Note: when color equality needs to be decided, implementations, unless

827

# documented otherwise, will treat two colors to be equal if all their red,

828

# green, blue and alpha values each differ by at most 1e-5.

829

#

Bu Sun Kim

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

[diff] [blame]

830

# Example (Java):

831

#

832

# import com.google.type.Color;

833

#

834

# // ...

835

# public static java.awt.Color fromProto(Color protocolor) {

836

# float alpha = protocolor.hasAlpha()

837

# ? protocolor.getAlpha().getValue()

838

# : 1.0;

839

#

840

# return new java.awt.Color(

841

# protocolor.getRed(),

842

# protocolor.getGreen(),

843

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

848

# float red = (float) color.getRed();

849

# float green = (float) color.getGreen();

850

# float blue = (float) color.getBlue();

851

# float denominator = 255.0;

852

# Color.Builder resultBuilder =

853

# Color

854

# .newBuilder()

855

# .setRed(red / denominator)

856

# .setGreen(green / denominator)

857

# .setBlue(blue / denominator);

858

# int alpha = color.getAlpha();

859

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

864

# .build());

865

# }

866

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

871

#

872

# // ...

873

# static UIColor* fromProto(Color* protocolor) {

874

# float red = [protocolor red];

875

# float green = [protocolor green];

876

# float blue = [protocolor blue];

877

# FloatValue* alpha_wrapper = [protocolor alpha];

878

# float alpha = 1.0;

879

# if (alpha_wrapper != nil) {

880

# alpha = [alpha_wrapper value];

881

# }

882

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

883

# }

884

#

885

# static Color* toProto(UIColor* color) {

886

# CGFloat red, green, blue, alpha;

887

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

888

# return nil;

889

# }

890

# Color* result = [[Color alloc] init];

891

# [result setRed:red];

892

# [result setGreen:green];

893

# [result setBlue:blue];

894

# if (alpha <= 0.9999) {

895

# [result setAlpha:floatWrapperWithValue(alpha)];

896

# }

897

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

907

# var redFrac = rgb_color.red || 0.0;

908

# var greenFrac = rgb_color.green || 0.0;

909

# var blueFrac = rgb_color.blue || 0.0;

910

# var red = Math.floor(redFrac * 255);

911

# var green = Math.floor(greenFrac * 255);

912

# var blue = Math.floor(blueFrac * 255);

913

#

914

# if (!('alpha' in rgb_color)) {

915

# return rgbToCssColor_(red, green, blue);

916

# }

917

#

918

# var alphaFrac = rgb_color.alpha.value || 0.0;

919

# var rgbParams = [red, green, blue].join(',');

920

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

921

# };

922

#

923

# var rgbToCssColor_ = function(red, green, blue) {

924

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

925

# var hexString = rgbNumber.toString(16);

926

# var missingZeros = 6 - hexString.length;

927

# var resultBuilder = ['#'];

928

# for (var i = 0; i < missingZeros; i++) {

929

# resultBuilder.push('0');

930

# }

931

# resultBuilder.push(hexString);

932

# return resultBuilder.join('');

933

# };

934

#

935

# // ...

Bu Sun Kim

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

[diff] [blame]

936

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

Bu Sun Kim

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

[diff] [blame]

937

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

938

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

Bu Sun Kim

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

[diff] [blame]

939

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

940

# the final pixel color is defined by the equation:

941

#

942

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

943

#

944

# This means that a value of 1.0 corresponds to a solid color, whereas

945

# a value of 0.0 corresponds to a completely transparent color. This

946

# uses a wrapper message rather than a simple float scalar so that it is

947

# possible to distinguish between a default value and the value being unset.

948

# If omitted, this color object is to be rendered as a solid color

949

# (as if the alpha value had been explicitly given with a value of 1.0).

950

},

Bu Sun Kim

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

[diff] [blame]

951

"pixelFraction": 3.14, # The fraction of pixels the color occupies in the image.

952

# Value in range [0, 1].

Bu Sun Kim

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

[diff] [blame]

},

],

},

},

Bu Sun Kim

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

[diff] [blame]

957

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

958

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

959

"fdBoundingPoly": { # A bounding polygon for the detected image annotation. # The `fd_bounding_poly` bounding polygon is tighter than the

960

# `boundingPoly`, and encloses only the skin part of the face. Typically, it

961

# is used to eliminate the face from any image analysis that detects the

962

# "amount of skin" visible in an image. It is not based on the

963

# landmarker results, only on the initial face detection, hence

964

# the <code>fd</code> (face detection) prefix.

965

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

966

{ # A vertex represents a 2D point in the image.

967

# NOTE: the normalized vertex coordinates are relative to the original image

968

# and range from 0 to 1.

969

"y": 3.14, # Y coordinate.

970

"x": 3.14, # X coordinate.

Bu Sun Kim

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

[diff] [blame]

971

},

Bu Sun Kim

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

[diff] [blame]

972

],

973

"vertices": [ # The bounding polygon vertices.

974

{ # A vertex represents a 2D point in the image.

975

# NOTE: the vertex coordinates are in the same scale as the original image.

976

"x": 42, # X coordinate.

977

"y": 42, # Y coordinate.

},

],

},

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

982

"rollAngle": 3.14, # Roll angle, which indicates the amount of clockwise/anti-clockwise rotation

983

# of the face relative to the image vertical about the axis perpendicular to

984

# the face. Range [-180,180].

985

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

986

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

987

"boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon around the face. The coordinates of the bounding box

988

# are in the original image's scale.

989

# The bounding box is computed to "frame" the face in accordance with human

990

# expectations. It is based on the landmarker results.

991

# Note that one or more x and/or y coordinates may not be generated in the

992

# `BoundingPoly` (the polygon will be unbounded) if only a partial face

993

# appears in the image to be annotated.

994

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

995

{ # A vertex represents a 2D point in the image.

996

# NOTE: the normalized vertex coordinates are relative to the original image

997

# and range from 0 to 1.

998

"y": 3.14, # Y coordinate.

999

"x": 3.14, # X coordinate.

1000

},

1001

],

1002

"vertices": [ # The bounding polygon vertices.

1003

{ # A vertex represents a 2D point in the image.

1004

# NOTE: the vertex coordinates are in the same scale as the original image.

1005

"x": 42, # X coordinate.

1006

"y": 42, # Y coordinate.

},

],

},

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

1011

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

1012

"panAngle": 3.14, # Yaw angle, which indicates the leftward/rightward angle that the face is

1013

# pointing relative to the vertical plane perpendicular to the image. Range

1014

# [-180,180].

1015

"landmarks": [ # Detected face landmarks.

1016

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

1017

"position": { # A 3D position in the image, used primarily for Face detection landmarks. # Face landmark position.

1018

# A valid Position must have both x and y coordinates.

1019

# The position coordinates are in the same scale as the original image.

1020

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

1021

"y": 3.14, # Y coordinate.

1022

"x": 3.14, # X coordinate.

1023

},

1024

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

Bu Sun Kim

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

[diff] [blame]

1025

},

1026

],

Bu Sun Kim

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

[diff] [blame]

1027

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

1028

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

1029

"tiltAngle": 3.14, # Pitch angle, which indicates the upwards/downwards angle that the face is

1030

# pointing relative to the image's horizontal plane. Range [-180,180].

1031

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

1032

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

1033

},

1034

],

1035

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

1036

{ # Set of detected entity features.

1037

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

Bu Sun Kim

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

[diff] [blame]

1038

"confidence": 3.14, # **Deprecated. Use `score` instead.**

1039

# The accuracy of the entity detection in an image.

1040

# For example, for an image in which the "Eiffel Tower" entity is detected,

1041

# this field represents the confidence that there is a tower in the query

1042

# image. Range [0, 1].

Bu Sun Kim

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

[diff] [blame]

1043

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

1044

# for `LABEL_DETECTION` features.

1045

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

1046

{ # A vertex represents a 2D point in the image.

1047

# NOTE: the normalized vertex coordinates are relative to the original image

1048

# and range from 0 to 1.

1049

"y": 3.14, # Y coordinate.

1050

"x": 3.14, # X coordinate.

1051

},

1052

],

1053

"vertices": [ # The bounding polygon vertices.

1054

{ # A vertex represents a 2D point in the image.

1055

# NOTE: the vertex coordinates are in the same scale as the original image.

Bu Sun Kim

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

[diff] [blame]

1056

"x": 42, # X coordinate.

Bu Sun Kim

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

[diff] [blame]

1057

"y": 42, # Y coordinate.

Bu Sun Kim

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

[diff] [blame]

1058

},

1059

],

1060

},

Bu Sun Kim

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

[diff] [blame]

1061

"mid": "A String", # Opaque entity ID. Some IDs may be available in

1062

# [Google Knowledge Graph Search

1063

# API](https://developers.google.com/knowledge-graph/).

1064

"locale": "A String", # The language code for the locale in which the entity textual

1065

# `description` is expressed.

Bu Sun Kim

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

[diff] [blame]

1066

"topicality": 3.14, # The relevancy of the ICA (Image Content Annotation) label to the

1067

# image. For example, the relevancy of "tower" is likely higher to an image

1068

# containing the detected "Eiffel Tower" than to an image containing a

1069

# detected distant towering building, even though the confidence that

1070

# there is a tower in each image may be the same. Range [0, 1].

Bu Sun Kim

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

[diff] [blame]

1071

"locations": [ # The location information for the detected entity. Multiple

1072

# `LocationInfo` elements can be present because one location may

1073

# indicate the location of the scene in the image, and another location

1074

# may indicate the location of the place where the image was taken.

1075

# Location information is usually present for landmarks.

1076

{ # Detected entity location information.

1077

"latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # lat/long location coordinates.

1078

# of doubles representing degrees latitude and degrees longitude. Unless

1079

# specified otherwise, this must conform to the

1080

# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84

1081

# standard</a>. Values must be within normalized ranges.

1082

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

1083

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

1084

},

1085

},

1086

],

Bu Sun Kim

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

[diff] [blame]

1087

"properties": [ # Some entities may have optional user-supplied `Property` (name/value)

1088

# fields, such a score or string that qualifies the entity.

1089

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

1090

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

1091

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

1092

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

1093

},

1094

],

Bu Sun Kim

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

[diff] [blame]

1095

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

Bu Sun Kim

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

[diff] [blame]

1096

},

1097

],

1098

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

1099

# comes from.

1100

# information about the source of that image.

Bu Sun Kim

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

[diff] [blame]

1101

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

1102

# the file used to produce the image.

Bu Sun Kim

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

[diff] [blame]

1103

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

Bu Sun Kim

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

[diff] [blame]

1104

},

Bu Sun Kim

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

[diff] [blame]

1105

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

1106

"cropHints": [ # Crop hint results.

1107

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

1108

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

1109

# image.

1110

"boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the crop region. The coordinates of the bounding

1111

# box are in the original image's scale.

1112

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

1113

{ # A vertex represents a 2D point in the image.

1114

# NOTE: the normalized vertex coordinates are relative to the original image

1115

# and range from 0 to 1.

1116

"y": 3.14, # Y coordinate.

1117

"x": 3.14, # X coordinate.

1118

},

1119

],

1120

"vertices": [ # The bounding polygon vertices.

1121

{ # A vertex represents a 2D point in the image.

1122

# NOTE: the vertex coordinates are in the same scale as the original image.

1123

"x": 42, # X coordinate.

1124

"y": 42, # Y coordinate.

},

],

},

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

Bu Sun Kim

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

[diff] [blame]

1129

},

1130

],

Bu Sun Kim

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

[diff] [blame]

1131

},

1132

"error": { # The `Status` type defines a logical error model that is suitable for # If set, represents the error message for the operation.

1133

# Note that filled-in image annotations are guaranteed to be

1134

# correct, even when `error` is set.

1135

# different programming environments, including REST APIs and RPC APIs. It is

1136

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

1137

# three pieces of data: error code, error message, and error details.

1138

#

1139

# You can find out more about this error model and how to work with it in the

1140

# [API Design Guide](https://cloud.google.com/apis/design/errors).

1141

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

1142

"details": [ # A list of messages that carry the error details. There is a common set of

1143

# message types for APIs to use.

1144

{

1145

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

Bu Sun Kim

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

[diff] [blame]

1146

},

1147

],

Bu Sun Kim

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

[diff] [blame]

1148

"message": "A String", # A developer-facing error message, which should be in English. Any

1149

# user-facing error message should be localized and sent in the

1150

# google.rpc.Status.details field, or localized by the client.

1151

},

1152

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

1153

{ # Set of detected entity features.

1154

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

1155

"confidence": 3.14, # **Deprecated. Use `score` instead.**

1156

# The accuracy of the entity detection in an image.

1157

# For example, for an image in which the "Eiffel Tower" entity is detected,

1158

# this field represents the confidence that there is a tower in the query

1159

# image. Range [0, 1].

1160

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

1161

# for `LABEL_DETECTION` features.

1162

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

1163

{ # A vertex represents a 2D point in the image.

1164

# NOTE: the normalized vertex coordinates are relative to the original image

1165

# and range from 0 to 1.

1166

"y": 3.14, # Y coordinate.

1167

"x": 3.14, # X coordinate.

Bu Sun Kim

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

[diff] [blame]

1168

},

1169

],

Bu Sun Kim

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

[diff] [blame]

1170

"vertices": [ # The bounding polygon vertices.

1171

{ # A vertex represents a 2D point in the image.

1172

# NOTE: the vertex coordinates are in the same scale as the original image.

1173

"x": 42, # X coordinate.

1174

"y": 42, # Y coordinate.

Bu Sun Kim

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

[diff] [blame]

1175

},

1176

],

1177

},

Bu Sun Kim

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

[diff] [blame]

1178

"mid": "A String", # Opaque entity ID. Some IDs may be available in

1179

# [Google Knowledge Graph Search

1180

# API](https://developers.google.com/knowledge-graph/).

1181

"locale": "A String", # The language code for the locale in which the entity textual

1182

# `description` is expressed.

1183

"topicality": 3.14, # The relevancy of the ICA (Image Content Annotation) label to the

1184

# image. For example, the relevancy of "tower" is likely higher to an image

1185

# containing the detected "Eiffel Tower" than to an image containing a

1186

# detected distant towering building, even though the confidence that

1187

# there is a tower in each image may be the same. Range [0, 1].

1188

"locations": [ # The location information for the detected entity. Multiple

1189

# `LocationInfo` elements can be present because one location may

1190

# indicate the location of the scene in the image, and another location

1191

# may indicate the location of the place where the image was taken.

1192

# Location information is usually present for landmarks.

1193

{ # Detected entity location information.

1194

"latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # lat/long location coordinates.

1195

# of doubles representing degrees latitude and degrees longitude. Unless

1196

# specified otherwise, this must conform to the

1197

# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84

1198

# standard</a>. Values must be within normalized ranges.

1199

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

1200

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

},

},

],

"properties": [ # Some entities may have optional user-supplied `Property` (name/value)

1205

# fields, such a score or string that qualifies the entity.

1206

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

1207

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

1208

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

1209

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

1210

},

1211

],

1212

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

1213

},

1214

],

1215

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

1216

{ # Set of detected entity features.

1217

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

1218

"confidence": 3.14, # **Deprecated. Use `score` instead.**

1219

# The accuracy of the entity detection in an image.

1220

# For example, for an image in which the "Eiffel Tower" entity is detected,

1221

# this field represents the confidence that there is a tower in the query

1222

# image. Range [0, 1].

1223

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

1224

# for `LABEL_DETECTION` features.

1225

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

1226

{ # A vertex represents a 2D point in the image.

1227

# NOTE: the normalized vertex coordinates are relative to the original image

1228

# and range from 0 to 1.

1229

"y": 3.14, # Y coordinate.

1230

"x": 3.14, # X coordinate.

1231

},

1232

],

1233

"vertices": [ # The bounding polygon vertices.

1234

{ # A vertex represents a 2D point in the image.

1235

# NOTE: the vertex coordinates are in the same scale as the original image.

1236

"x": 42, # X coordinate.

1237

"y": 42, # Y coordinate.

1238

},

1239

],

Bu Sun Kim

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

[diff] [blame]

1240

},

Bu Sun Kim

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

[diff] [blame]

1241

"mid": "A String", # Opaque entity ID. Some IDs may be available in

1242

# [Google Knowledge Graph Search

1243

# API](https://developers.google.com/knowledge-graph/).

1244

"locale": "A String", # The language code for the locale in which the entity textual

1245

# `description` is expressed.

1246

"topicality": 3.14, # The relevancy of the ICA (Image Content Annotation) label to the

1247

# image. For example, the relevancy of "tower" is likely higher to an image

1248

# containing the detected "Eiffel Tower" than to an image containing a

1249

# detected distant towering building, even though the confidence that

1250

# there is a tower in each image may be the same. Range [0, 1].

1251

"locations": [ # The location information for the detected entity. Multiple

1252

# `LocationInfo` elements can be present because one location may

1253

# indicate the location of the scene in the image, and another location

1254

# may indicate the location of the place where the image was taken.

1255

# Location information is usually present for landmarks.

1256

{ # Detected entity location information.

1257

"latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # lat/long location coordinates.

1258

# of doubles representing degrees latitude and degrees longitude. Unless

1259

# specified otherwise, this must conform to the

1260

# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84

1261

# standard</a>. Values must be within normalized ranges.

1262

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

1263

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

},

},

],

"properties": [ # Some entities may have optional user-supplied `Property` (name/value)

1268

# fields, such a score or string that qualifies the entity.

1269

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

1270

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

1271

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

1272

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

1273

},

1274

],

1275

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

1276

},

1277

],

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>

1285

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

1286

1287

Progress and results can be retrieved through the

1288

`google.longrunning.Operations` interface.

1289

`Operation.metadata` contains `OperationMetadata` (metadata).

1290

`Operation.response` contains `AsyncBatchAnnotateImagesResponse` (results).

1291

1292

This service will write image annotation outputs to json files in customer

1293

GCS bucket, each json file containing BatchAnnotateImagesResponse proto.

1294

1295

Args:

1296

parent: string, Optional. Target project and location to make a call.

1297

1298

Format: `projects/{project-id}/locations/{location-id}`.

1299

1300

If no parent is specified, a region will be chosen automatically.

1301

1302

Supported location-ids:

1303

`us`: USA country only,

1304

`asia`: East asia areas, like Japan, Taiwan,

1305

`eu`: The European Union.

1306

1307

Example: `projects/project-A/locations/eu`. (required)

1308

body: object, The request body.

1309

The object takes the form of:

1310

1311

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

Bu Sun Kim

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

[diff] [blame]

1312

"parent": "A String", # Optional. Target project and location to make a call.

1313

#

1314

# Format: `projects/{project-id}/locations/{location-id}`.

1315

#

1316

# If no parent is specified, a region will be chosen automatically.

1317

#

1318

# Supported location-ids:

1319

# `us`: USA country only,

1320

# `asia`: East asia areas, like Japan, Taiwan,

1321

# `eu`: The European Union.

1322

#

1323

# Example: `projects/project-A/locations/eu`.

1324

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

1325

"batchSize": 42, # The max number of response protos to put into each output JSON file on

1326

# Google Cloud Storage.

1327

# The valid range is [1, 100]. If not specified, the default value is 20.

1328

#

1329

# For example, for one pdf file with 100 pages, 100 response protos will

1330

# be generated. If `batch_size` = 20, then 5 json files each

1331

# containing 20 response protos will be written under the prefix

1332

# `gcs_destination`.`uri`.

1333

#

1334

# Currently, batch_size only applies to GcsDestination, with potential future

1335

# support for other output configurations.

1336

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

1337

"uri": "A String", # Google Cloud Storage URI prefix where the results will be stored. Results

1338

# will be in JSON format and preceded by its corresponding input URI prefix.

1339

# This field can either represent a gcs file prefix or gcs directory. In

1340

# either case, the uri should be unique because in order to get all of the

1341

# 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

1347

# will be created in gs://bucket-name/here/ and the names of the

1348

# output files will begin with "filenameprefix".

1349

#

1350

# * Directory Prefix: gs://bucket-name/some/location/ The output files

1351

# will be created in gs://bucket-name/some/location/ and the names of the

1352

# output files could be anything because there was no filename prefix

1353

# specified.

1354

#

1355

# If multiple outputs, each response is still AnnotateFileResponse, each of

1356

# which contains some subset of the full list of AnnotateImageResponse.

1357

# Multiple outputs can happen if, for example, the output JSON is too large

1358

# and overflows into multiple sharded files.

1359

},

1360

},

Bu Sun Kim

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

[diff] [blame]

1361

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

1362

{ # Request for performing Google Cloud Vision API tasks over a user-provided

1363

# image, with user-requested features, and with context information.

1364

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

1365

"source": { # External image source (Google Cloud Storage or web URL image location). # Google Cloud Storage image location, or publicly-accessible image

1366

# URL. If both `content` and `source` are provided for an image, `content`

1367

# takes precedence and is used to perform the image annotation request.

1368

"gcsImageUri": "A String", # **Use `image_uri` instead.**

1369

#

1370

# The Google Cloud Storage URI of the form

1371

# `gs://bucket_name/object_name`. Object versioning is not supported. See

1372

# [Google Cloud Storage Request

1373

# URIs](https://cloud.google.com/storage/docs/reference-uris) for more info.

1374

"imageUri": "A String", # The URI of the source image. Can be either:

1375

#

1376

# 1. A Google Cloud Storage URI of the form

1377

# `gs://bucket_name/object_name`. Object versioning is not supported. See

1378

# [Google Cloud Storage Request

1379

# URIs](https://cloud.google.com/storage/docs/reference-uris) for more

1380

# info.

1381

#

1382

# 2. A publicly-accessible image HTTP/HTTPS URL. When fetching images from

1383

# HTTP/HTTPS URLs, Google cannot guarantee that the request will be

1384

# completed. Your request may fail if the specified host denies the

1385

# request (e.g. due to request throttling or DOS prevention), or if Google

1386

# throttles requests to the site for abuse prevention. You should not

1387

# depend on externally-hosted images for production applications.

1388

#

1389

# When both `gcs_image_uri` and `image_uri` are specified, `image_uri` takes

1390

# precedence.

1391

},

1392

"content": "A String", # Image content, represented as a stream of bytes.

1393

# Note: As with all `bytes` fields, protobuffers use a pure binary

1394

# representation, whereas JSON representations use base64.

1395

#

1396

# Currently, this field only works for BatchAnnotateImages requests. It does

1397

# not work for AsyncBatchAnnotateImages requests.

1398

},

1399

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

1400

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

1401

"maxLatLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # Max lat/long pair.

1402

# of doubles representing degrees latitude and degrees longitude. Unless

1403

# specified otherwise, this must conform to the

1404

# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84

1405

# standard</a>. Values must be within normalized ranges.

1406

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

1407

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

1408

},

1409

"minLatLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # Min lat/long pair.

1410

# of doubles representing degrees latitude and degrees longitude. Unless

1411

# specified otherwise, this must conform to the

1412

# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84

1413

# standard</a>. Values must be within normalized ranges.

1414

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

1415

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

1416

},

1417

},

1418

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

1419

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

1420

},

1421

"languageHints": [ # List of languages to use for TEXT_DETECTION. In most cases, an empty value

1422

# yields the best results since it enables automatic language detection. For

1423

# languages based on the Latin alphabet, setting `language_hints` is not

1424

# needed. In rare cases, when the language of the text in the image is known,

1425

# setting a hint will help get better results (although it will be a

1426

# significant hindrance if the hint is wrong). Text detection returns an

1427

# error if one or more of the specified languages is not one of the

1428

# [supported languages](https://cloud.google.com/vision/docs/languages).

1429

"A String",

1430

],

1431

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

1432

"productCategories": [ # The list of product categories to search in. Currently, we only consider

1433

# the first category, and either "homegoods-v2", "apparel-v2", "toys-v2",

1434

# "packagedgoods-v1", or "general-v1" should be specified. The legacy

1435

# categories "homegoods", "apparel", and "toys" are still supported but will

1436

# be deprecated. For new products, please use "homegoods-v2", "apparel-v2",

1437

# or "toys-v2" for better product search accuracy. It is recommended to

1438

# migrate existing products to these categories as well.

1439

"A String",

1440

],

1441

"boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon around the area of interest in the image.

1442

# If it is not specified, system discretion will be applied.

1443

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

1444

{ # A vertex represents a 2D point in the image.

1445

# NOTE: the normalized vertex coordinates are relative to the original image

1446

# and range from 0 to 1.

1447

"y": 3.14, # Y coordinate.

1448

"x": 3.14, # X coordinate.

1449

},

1450

],

1451

"vertices": [ # The bounding polygon vertices.

1452

{ # A vertex represents a 2D point in the image.

1453

# NOTE: the vertex coordinates are in the same scale as the original image.

1454

"x": 42, # X coordinate.

1455

"y": 42, # Y coordinate.

},

],

},

"filter": "A String", # The filtering expression. This can be used to restrict search results based

1460

# on Product labels. We currently support an AND of OR of key-value

1461

# expressions, where each expression within an OR must have the same key. An

1462

# '=' should be used to connect the key and value.

1463

#

1464

# For example, "(color = red OR color = blue) AND brand = Google" is

1465

# acceptable, but "(color = red OR brand = Google)" is not acceptable.

1466

# "color: red" is not acceptable because it uses a ':' instead of an '='.

1467

"productSet": "A String", # The resource name of a ProductSet to be searched for similar images.

1468

#

1469

# Format is:

1470

# `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`.

1471

},

1472

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

1473

"aspectRatios": [ # Aspect ratios in floats, representing the ratio of the width to the height

1474

# of the image. For example, if the desired aspect ratio is 4/3, the

1475

# corresponding float value should be 1.33333. If not specified, the

1476

# best possible crop is returned. The number of provided aspect ratios is

1477

# limited to a maximum of 16; any aspect ratios provided after the 16th are

# ignored.

3.14,

],

},

},

"features": [ # Requested features.

1484

{ # The type of Google Cloud Vision API detection to perform, and the maximum

1485

# number of results to return for that type. Multiple `Feature` objects can

1486

# be specified in the `features` list.

1487

"maxResults": 42, # Maximum number of results of this type. Does not apply to

1488

# `TEXT_DETECTION`, `DOCUMENT_TEXT_DETECTION`, or `CROP_HINTS`.

1489

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

1490

"model": "A String", # Model to use for the feature.

1491

# Supported values: "builtin/stable" (the default if unset) and

# "builtin/latest".

},

],

},

],

Bu Sun Kim

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

[diff] [blame]

1497

}

1498

1499

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1506

1507

{ # This resource represents a long-running operation that is the result of a

1508

# network API call.

1509

"done": True or False, # If the value is `false`, it means the operation is still in progress.

1510

# If `true`, the operation is completed, and either `error` or `response` is

1511

# available.

Bu Sun Kim