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

2019-06-14 16:50:42 -0700

[diff] [blame]

113

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

114

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

Bu Sun Kim

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

[diff] [blame]

115

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

116

#

117

# 1. A Google Cloud Storage URI of the form

118

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

119

# [Google Cloud Storage Request

120

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

121

# info.

122

#

123

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

124

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

125

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

126

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

127

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

128

# depend on externally-hosted images for production applications.

129

#

130

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

131

# precedence.

Bu Sun Kim

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

[diff] [blame]

132

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

133

#

134

# The Google Cloud Storage URI of the form

135

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

136

# [Google Cloud Storage Request

137

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

138

},

139

},

Bu Sun Kim

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

[diff] [blame]

140

"features": [ # Requested features.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

141

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

142

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

143

# be specified in the `features` list.

Bu Sun Kim

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

[diff] [blame]

144

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

145

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

146

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

Bu Sun Kim

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

[diff] [blame]

147

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

148

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

149

# "builtin/latest".

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

150

},

151

],

Bu Sun Kim

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

[diff] [blame]

152

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

153

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

154

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

155

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

156

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

157

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

158

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

159

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

160

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

161

"A String",

162

],

163

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

164

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

165

},

166

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

167

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

168

# of doubles representing degrees latitude and degrees longitude. Unless

169

# specified otherwise, this must conform to the

170

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

171

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

172

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

173

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

174

},

175

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

176

# of doubles representing degrees latitude and degrees longitude. Unless

177

# specified otherwise, this must conform to the

178

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

179

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

180

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

181

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

182

},

183

},

184

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

185

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

186

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

187

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

188

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

189

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

# ignored.

3.14,

],

},

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

195

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

196

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

197

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

198

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

199

#

200

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

201

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

202

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

203

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

204

#

205

# Format is:

206

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

207

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

208

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

209

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

210

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

211

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

212

# and range from 0 to 1.

213

"y": 3.14, # Y coordinate.

214

"x": 3.14, # X coordinate.

215

},

216

],

217

"vertices": [ # The bounding polygon vertices.

218

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

219

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

220

"y": 42, # Y coordinate.

221

"x": 42, # X coordinate.

},

],

},

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

226

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

227

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

228

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

229

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

230

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

231

# migrate existing products to these categories as well.

"A String",

],

},

},

Bu Sun Kim

2019-06-14 16:50:42 -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:

247

248

{ # Response to a batch image annotation request.

Bu Sun Kim

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

[diff] [blame]

249

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

250

{ # Response to an image annotation request.

Bu Sun Kim

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

[diff] [blame]

251

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

252

{ # Set of detected entity features.

Bu Sun Kim

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

[diff] [blame]

253

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

254

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

255

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

256

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

257

# detected distant towering building, even though the confidence that

258

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

Bu Sun Kim

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

[diff] [blame]

259

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

260

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

261

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

262

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

263

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

264

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

265

},

266

],

267

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

268

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

269

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

270

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

271

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

272

# Location information is usually present for landmarks.

273

{ # Detected entity location information.

Bu Sun Kim

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

[diff] [blame]

274

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

275

# of doubles representing degrees latitude and degrees longitude. Unless

276

# specified otherwise, this must conform to the

Bu Sun Kim

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

[diff] [blame]

277

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

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

278

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

Bu Sun Kim

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

[diff] [blame]

279

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

280

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

281

},

282

},

283

],

Bu Sun Kim

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

[diff] [blame]

284

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

285

# [Google Knowledge Graph Search

286

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

287

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

288

# The accuracy of the entity detection in an image.

289

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

290

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

291

# image. Range [0, 1].

292

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

293

# for `LABEL_DETECTION` features.

Bu Sun Kim

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

[diff] [blame]

294

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

295

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

296

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

297

# and range from 0 to 1.

Bu Sun Kim

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

[diff] [blame]

298

"y": 3.14, # Y coordinate.

299

"x": 3.14, # X coordinate.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

300

},

301

],

Bu Sun Kim

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

[diff] [blame]

302

"vertices": [ # The bounding polygon vertices.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

303

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

304

# 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]

305

"y": 42, # Y coordinate.

306

"x": 42, # X coordinate.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

307

},

308

],

309

},

Bu Sun Kim

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

[diff] [blame]

310

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

311

# `description` is expressed.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

312

},

313

],

Bu Sun Kim

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

[diff] [blame]

314

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

315

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

316

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

317

"landmarks": [ # Detected face landmarks.

318

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

319

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

320

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

321

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

322

"x": 3.14, # X coordinate.

323

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

324

"y": 3.14, # Y coordinate.

325

},

326

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

327

},

328

],

329

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

330

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

331

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

332

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

333

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

334

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

335

# [-180,180].

336

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

337

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

338

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

339

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

340

# are in the original image's scale.

341

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

342

# expectations. It is based on the landmarker results.

343

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

344

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

345

# appears in the image to be annotated.

346

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

347

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

348

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

349

# and range from 0 to 1.

350

"y": 3.14, # Y coordinate.

351

"x": 3.14, # X coordinate.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

352

},

353

],

Bu Sun Kim

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

[diff] [blame]

354

"vertices": [ # The bounding polygon vertices.

355

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

356

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

357

"y": 42, # Y coordinate.

358

"x": 42, # X coordinate.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

359

},

360

],

361

},

Bu Sun Kim

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

[diff] [blame]

362

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

363

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

364

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

365

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

366

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

367

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

368

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

369

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

370

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

371

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

372

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

373

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

374

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

375

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

376

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

377

# and range from 0 to 1.

378

"y": 3.14, # Y coordinate.

379

"x": 3.14, # X coordinate.

380

},

381

],

382

"vertices": [ # The bounding polygon vertices.

383

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

384

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

385

"y": 42, # Y coordinate.

386

"x": 42, # X coordinate.

387

},

388

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

389

},

Bu Sun Kim

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

[diff] [blame]

390

},

391

],

392

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

393

"cropHints": [ # Crop hint results.

394

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

395

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

396

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

397

# image.

398

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

399

# box are in the original image's scale.

400

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

401

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

402

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

403

# and range from 0 to 1.

404

"y": 3.14, # Y coordinate.

405

"x": 3.14, # X coordinate.

406

},

407

],

408

"vertices": [ # The bounding polygon vertices.

409

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

410

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

411

"y": 42, # Y coordinate.

412

"x": 42, # X coordinate.

413

},

414

],

415

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

416

},

417

],

418

},

Bu Sun Kim

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

[diff] [blame]

419

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

420

{ # Set of detected entity features.

421

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

422

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

423

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

424

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

425

# detected distant towering building, even though the confidence that

426

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

427

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

428

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

429

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

430

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

431

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

432

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

433

},

434

],

435

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

436

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

437

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

438

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

439

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

440

# Location information is usually present for landmarks.

441

{ # Detected entity location information.

442

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

443

# of doubles representing degrees latitude and degrees longitude. Unless

444

# specified otherwise, this must conform to the

445

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

446

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

447

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

448

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

},

},

],

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

453

# [Google Knowledge Graph Search

454

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

455

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

456

# The accuracy of the entity detection in an image.

457

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

458

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

459

# image. Range [0, 1].

460

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

461

# for `LABEL_DETECTION` features.

462

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

463

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

464

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

465

# and range from 0 to 1.

Bu Sun Kim

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

[diff] [blame]

466

"y": 3.14, # Y coordinate.

467

"x": 3.14, # X coordinate.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

468

},

469

],

Bu Sun Kim

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

[diff] [blame]

470

"vertices": [ # The bounding polygon vertices.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

471

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

472

# 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]

473

"y": 42, # Y coordinate.

474

"x": 42, # X coordinate.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

475

},

476

],

477

},

Bu Sun Kim

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

[diff] [blame]

478

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

479

# `description` is expressed.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

480

},

481

],

Bu Sun Kim

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

[diff] [blame]

482

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

483

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

484

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

485

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

486

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

487

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

488

# image.

489

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

490

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

491

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

492

# information, see

493

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

494

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

495

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

496

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

497

},

498

],

499

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

500

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

501

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

502

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

503

# and range from 0 to 1.

504

"y": 3.14, # Y coordinate.

505

"x": 3.14, # X coordinate.

506

},

507

],

508

"vertices": [ # The bounding polygon vertices.

509

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

510

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

511

"y": 42, # Y coordinate.

512

"x": 42, # X coordinate.

},

],

},

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

517

{ # Information about a product.

518

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

519

# to the query.

520

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

521

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

522

# 4096 characters long.

523

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

524

# characters long.

525

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

526

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

527

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

528

# not be used for new products.

529

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

530

# constraints can be specified based on the product_labels.

531

#

532

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

533

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

534

# to be supported soon.

535

#

536

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

537

# 500 product_labels.

538

#

539

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

540

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

541

# will refuse to work for that ProductSet.

542

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

543

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

544

# exceed 128 bytes.

545

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

546

# cannot exceed 128 bytes.

547

},

548

],

549

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

550

#

551

# Format is:

552

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

553

#

554

# This field is ignored when creating a product.

555

},

556

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

557

# 1 (full confidence).

},

],

},

],

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

563

{ # Information about a product.

564

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

565

# to the query.

566

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

567

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

568

# 4096 characters long.

569

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

570

# characters long.

571

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

572

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

573

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

574

# not be used for new products.

575

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

576

# constraints can be specified based on the product_labels.

577

#

578

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

579

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

580

# to be supported soon.

581

#

582

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

583

# 500 product_labels.

584

#

585

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

586

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

587

# will refuse to work for that ProductSet.

588

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

589

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

590

# exceed 128 bytes.

591

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

592

# cannot exceed 128 bytes.

593

},

594

],

595

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

596

#

597

# Format is:

598

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

599

#

600

# This field is ignored when creating a product.

601

},

602

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

603

# 1 (full confidence).

604

},

605

],

606

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

607

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

608

# not reflected in the current results.

609

},

610

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

611

# This will be sorted descending by confidence score.

612

{ # Set of detected objects with bounding boxes.

613

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

614

# information, see

615

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

616

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

617

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

618

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

619

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

620

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

621

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

622

# and range from 0 to 1.

623

"y": 3.14, # Y coordinate.

624

"x": 3.14, # X coordinate.

625

},

626

],

627

"vertices": [ # The bounding polygon vertices.

628

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

629

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

630

"y": 42, # Y coordinate.

631

"x": 42, # X coordinate.

},

],

},

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

636

},

637

],

638

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

639

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

640

# correct, even when `error` is set.

641

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

642

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

643

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

644

#

645

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

646

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

647

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

648

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

649

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

650

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

651

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

652

# message types for APIs to use.

653

{

654

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

},

],

},

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

659

# completed successfully.

660

# This annotation provides the structural hierarchy for the OCR detected

661

# text.

662

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

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

663

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

664

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

665

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

666

# to the TextAnnotation.TextProperty message definition below for more

667

# detail.

Bu Sun Kim

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

[diff] [blame]

668

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

669

{ # Detected page from OCR.

Bu Sun Kim

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

[diff] [blame]

670

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

671

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

672

# TIFFs) the unit is pixels.

Bu Sun Kim

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

[diff] [blame]

673

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

674

# TIFFs) the unit is pixels.

675

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

676

{ # Logical element on the page.

Bu Sun Kim

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

[diff] [blame]

677

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

678

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

679

{ # Detected language for a structural component.

680

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

681

# information, see

682

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

683

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

684

},

685

],

686

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

687

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

688

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

689

},

690

},

691

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

692

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

693

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

694

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

695

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

Bu Sun Kim

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

[diff] [blame]

696

# read in the 'natural' orientation.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

697

# For example:

698

#

699

# * when the text is horizontal it might look like:

#

# 0----1

# | |

# 3----2

#

Bu Sun Kim

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

[diff] [blame]

705

# * when it's rotated 180 degrees around the top-left corner it becomes:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

#

# 2----3

# | |

# 1----0

#

# and the vertex order will still be (0, 1, 2, 3).

Bu Sun Kim

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

[diff] [blame]

712

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

713

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

714

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

715

# and range from 0 to 1.

Bu Sun Kim

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

[diff] [blame]

716

"y": 3.14, # Y coordinate.

717

"x": 3.14, # X coordinate.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

718

},

719

],

Bu Sun Kim

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

[diff] [blame]

720

"vertices": [ # The bounding polygon vertices.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

721

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

722

# 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]

723

"y": 42, # Y coordinate.

724

"x": 42, # X coordinate.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

725

},

726

],

727

},

Bu Sun Kim

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

[diff] [blame]

728

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

729

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

730

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

Bu Sun Kim

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

[diff] [blame]

731

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

732

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

733

{ # Detected language for a structural component.

734

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

735

# information, see

736

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

737

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

738

},

739

],

740

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

741

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

742

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

743

},

744

},

745

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

746

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

747

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

748

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

Bu Sun Kim

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

[diff] [blame]

749

# read in the 'natural' orientation.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

750

# For example:

751

# * when the text is horizontal it might look like:

752

# 0----1

753

# | |

754

# 3----2

Bu Sun Kim

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

[diff] [blame]

755

# * when it's rotated 180 degrees around the top-left corner it becomes:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

# 2----3

# | |

# 1----0

# and the vertex order will still be (0, 1, 2, 3).

Bu Sun Kim

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

[diff] [blame]

760

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

761

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

762

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

763

# and range from 0 to 1.

Bu Sun Kim

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

[diff] [blame]

764

"y": 3.14, # Y coordinate.

765

"x": 3.14, # X coordinate.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

766

},

767

],

Bu Sun Kim

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

[diff] [blame]

768

"vertices": [ # The bounding polygon vertices.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

769

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

770

# 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]

771

"y": 42, # Y coordinate.

772

"x": 42, # X coordinate.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

773

},

774

],

775

},

Bu Sun Kim

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

[diff] [blame]

776

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

777

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

778

{ # A word representation.

Bu Sun Kim

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

[diff] [blame]

779

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

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

780

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

781

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

782

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

Bu Sun Kim

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

[diff] [blame]

783

# read in the 'natural' orientation.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

784

# For example:

785

# * when the text is horizontal it might look like:

786

# 0----1

787

# | |

788

# 3----2

Bu Sun Kim

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

[diff] [blame]

789

# * when it's rotated 180 degrees around the top-left corner it becomes:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

# 2----3

# | |

# 1----0

# and the vertex order will still be (0, 1, 2, 3).

Bu Sun Kim

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

[diff] [blame]

794

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

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

795

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

796

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

797

# and range from 0 to 1.

Bu Sun Kim

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

[diff] [blame]

798

"y": 3.14, # Y coordinate.

799

"x": 3.14, # X coordinate.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

800

},

801

],

Bu Sun Kim

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

[diff] [blame]

802

"vertices": [ # The bounding polygon vertices.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

803

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

804

# 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]

805

"y": 42, # Y coordinate.

806

"x": 42, # X coordinate.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

807

},

808

],

809

},

Bu Sun Kim

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

[diff] [blame]

810

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

811

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

812

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

813

{ # A single symbol representation.

814

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

815

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

816

{ # Detected language for a structural component.

817

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

818

# information, see

819

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

820

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

821

},

822

],

823

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

824

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

825

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

826

},

827

},

828

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

829

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

830

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

831

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

832

# read in the 'natural' orientation.

833

# For example:

834

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

843

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

844

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

845

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

846

# and range from 0 to 1.

847

"y": 3.14, # Y coordinate.

848

"x": 3.14, # X coordinate.

849

},

850

],

851

"vertices": [ # The bounding polygon vertices.

852

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

853

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

854

"y": 42, # Y coordinate.

855

"x": 42, # X coordinate.

},

],

},

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

860

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

861

},

Bu Sun Kim

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

[diff] [blame]

862

],

863

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

864

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

865

{ # Detected language for a structural component.

Bu Sun Kim

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

[diff] [blame]

866

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

867

# information, see

868

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

Bu Sun Kim

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

[diff] [blame]

869

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

870

},

871

],

Bu Sun Kim

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

[diff] [blame]

872

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

873

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

874

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

875

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

},

},

],

},

],

},

],

Bu Sun Kim

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

[diff] [blame]

883

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

884

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

885

{ # Detected language for a structural component.

886

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

887

# information, see

888

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

889

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

890

},

891

],

892

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

893

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

894

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

895

},

896

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

897

},

898

],

Bu Sun Kim

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

[diff] [blame]

899

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

900

},

Bu Sun Kim

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

[diff] [blame]

901

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

902

{ # Set of detected entity features.

Bu Sun Kim

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

[diff] [blame]

903

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

904

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

905

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

906

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

907

# detected distant towering building, even though the confidence that

908

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

Bu Sun Kim

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

[diff] [blame]

909

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

910

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

911

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

912

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

913

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

914

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

915

},

916

],

917

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

918

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

919

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

920

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

921

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

922

# Location information is usually present for landmarks.

923

{ # Detected entity location information.

Bu Sun Kim

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

[diff] [blame]

924

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

925

# of doubles representing degrees latitude and degrees longitude. Unless

926

# specified otherwise, this must conform to the

Bu Sun Kim

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

[diff] [blame]

927

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

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

928

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

Bu Sun Kim

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

[diff] [blame]

929

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

930

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

931

},

932

},

933

],

Bu Sun Kim

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

[diff] [blame]

934

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

935

# [Google Knowledge Graph Search

936

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

937

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

938

# The accuracy of the entity detection in an image.

939

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

940

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

941

# image. Range [0, 1].

942

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

943

# for `LABEL_DETECTION` features.

Bu Sun Kim

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

[diff] [blame]

944

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

945

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

946

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

947

# and range from 0 to 1.

Bu Sun Kim

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

[diff] [blame]

948

"y": 3.14, # Y coordinate.

949

"x": 3.14, # X coordinate.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

950

},

951

],

Bu Sun Kim

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

[diff] [blame]

952

"vertices": [ # The bounding polygon vertices.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

953

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

954

# 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]

955

"y": 42, # Y coordinate.

956

"x": 42, # X coordinate.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

957

},

958

],

959

},

Bu Sun Kim

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

[diff] [blame]

960

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

961

# `description` is expressed.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

962

},

963

],

Bu Sun Kim

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

[diff] [blame]

964

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

965

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

966

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

967

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

968

# the image that the color occupies in the image.

Bu Sun Kim

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

[diff] [blame]

969

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

970

# Value in range [0, 1].

971

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

972

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

973

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

Bu Sun Kim

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

[diff] [blame]

974

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

975

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

976

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

Bu Sun Kim

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

[diff] [blame]

977

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

978

#

979

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

980

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

981

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

# space.

#

# Example (Java):

#

# import com.google.type.Color;

987

#

988

# // ...

989

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

990

# float alpha = protocolor.hasAlpha()

991

# ? protocolor.getAlpha().getValue()

992

# : 1.0;

993

#

994

# return new java.awt.Color(

995

# protocolor.getRed(),

996

# protocolor.getGreen(),

997

# protocolor.getBlue(),

# alpha);

# }

#

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

1002

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

1003

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

1004

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

1005

# float denominator = 255.0;

1006

# Color.Builder resultBuilder =

1007

# Color

1008

# .newBuilder()

1009

# .setRed(red / denominator)

1010

# .setGreen(green / denominator)

1011

# .setBlue(blue / denominator);

1012

# int alpha = color.getAlpha();

1013

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

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

1018

# .build());

1019

# }

1020

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

1025

#

1026

# // ...

1027

# static UIColor* fromProto(Color* protocolor) {

1028

# float red = [protocolor red];

1029

# float green = [protocolor green];

1030

# float blue = [protocolor blue];

1031

# FloatValue* alpha_wrapper = [protocolor alpha];

1032

# float alpha = 1.0;

1033

# if (alpha_wrapper != nil) {

1034

# alpha = [alpha_wrapper value];

1035

# }

1036

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

1037

# }

1038

#

1039

# static Color* toProto(UIColor* color) {

1040

# CGFloat red, green, blue, alpha;

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1041

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1042

# return nil;

1043

# }

1044

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

1045

# [result setRed:red];

1046

# [result setGreen:green];

1047

# [result setBlue:blue];

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1048

# if (alpha <= 0.9999) {

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1049

# [result setAlpha:floatWrapperWithValue(alpha)];

1050

# }

1051

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

1061

# var redFrac = rgb_color.red || 0.0;

1062

# var greenFrac = rgb_color.green || 0.0;

1063

# var blueFrac = rgb_color.blue || 0.0;

1064

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

1065

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

1066

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

1067

#

Bu Sun Kim

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

[diff] [blame]

1068

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1069

# return rgbToCssColor_(red, green, blue);

1070

# }

1071

#

1072

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

Bu Sun Kim

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

[diff] [blame]

1073

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

1074

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1075

# };

1076

#

1077

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

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1078

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1079

# var hexString = rgbNumber.toString(16);

1080

# var missingZeros = 6 - hexString.length;

Bu Sun Kim

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

[diff] [blame]

1081

# var resultBuilder = ['#'];

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1082

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

Bu Sun Kim

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

[diff] [blame]

1083

# resultBuilder.push('0');

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1084

# }

1085

# resultBuilder.push(hexString);

Bu Sun Kim

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

[diff] [blame]

1086

# return resultBuilder.join('');

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1087

# };

1088

#

1089

# // ...

Bu Sun Kim

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

[diff] [blame]

1090

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

1091

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

1092

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

1093

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1094

# the final pixel color is defined by the equation:

1095

#

1096

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

1097

#

1098

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

1099

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

1100

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

1101

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

1102

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

1103

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1104

},

Bu Sun Kim

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

[diff] [blame]

1105

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

},

],

},

},

Bu Sun Kim

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

[diff] [blame]

1110

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1111

{ # Set of detected entity features.

Bu Sun Kim

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

[diff] [blame]

1112

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

1113

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

1114

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

1115

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1116

# detected distant towering building, even though the confidence that

1117

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

Bu Sun Kim

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

[diff] [blame]

1118

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

1119

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

1120

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

1121

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

1122

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

1123

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

1124

},

1125

],

1126

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

1127

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1128

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

1129

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

1130

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

1131

# Location information is usually present for landmarks.

1132

{ # Detected entity location information.

Bu Sun Kim

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

[diff] [blame]

1133

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1134

# of doubles representing degrees latitude and degrees longitude. Unless

1135

# specified otherwise, this must conform to the

Bu Sun Kim

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

[diff] [blame]

1136

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

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1137

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

Bu Sun Kim

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

[diff] [blame]

1138

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

1139

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1140

},

1141

},

1142

],

Bu Sun Kim

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

[diff] [blame]

1143

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1144

# [Google Knowledge Graph Search

1145

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

Bu Sun Kim

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

[diff] [blame]

1146

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

1147

# The accuracy of the entity detection in an image.

1148

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

1149

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

1150

# image. Range [0, 1].

1151

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1152

# for `LABEL_DETECTION` features.

Bu Sun Kim

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

[diff] [blame]

1153

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1154

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

1155

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

1156

# and range from 0 to 1.

Bu Sun Kim

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

[diff] [blame]

1157

"y": 3.14, # Y coordinate.

1158

"x": 3.14, # X coordinate.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1159

},

1160

],

Bu Sun Kim

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

[diff] [blame]

1161

"vertices": [ # The bounding polygon vertices.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1162

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

1163

# 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]

1164

"y": 42, # Y coordinate.

1165

"x": 42, # X coordinate.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1166

},

1167

],

1168

},

Bu Sun Kim

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

[diff] [blame]

1169

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

1170

# `description` is expressed.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1171

},

1172

],

Bu Sun Kim

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

[diff] [blame]

1173

"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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1174

# comes from.

1175

# information about the source of that image.

Bu Sun Kim

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

[diff] [blame]

1176

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

1177

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1178

# the file used to produce the image.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1179

},

Bu Sun Kim

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

[diff] [blame]

1180

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

1181

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

1182

{ # Metadata for online images.

1183

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

1184

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

1185

},

1186

],

1187

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

1188

# Inferred from similar images on the open web.

1189

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

1190

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

1191

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

1192

# For more information, see

1193

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

1194

},

1195

],

1196

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

1197

# Can include resized copies of the query image.

1198

{ # Metadata for online images.

1199

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

1200

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

1201

},

1202

],

1203

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

1204

{ # Entity deduced from similar images on the Internet.

1205

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

1206

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

1207

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

1208

# Not normalized and not comparable across different image queries.

1209

},

1210

],

1211

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

1212

{ # Metadata for web pages.

1213

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

1214

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

1215

# Can include resized copies of the query image.

1216

{ # Metadata for online images.

1217

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

1218

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

1219

},

1220

],

1221

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

1222

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

1223

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

1224

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

1225

# crops.

1226

{ # Metadata for online images.

1227

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

1228

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

1229

},

1230

],

1231

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

1232

},

1233

],

1234

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

1235

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

1236

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

1237

{ # Metadata for online images.

1238

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

1239

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1240

},

1241

],

1242

},

Bu Sun Kim

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

[diff] [blame]

1243

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

1244

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

1245

# violence).

1246

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

1247

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

1248

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

1249

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

1250

# body areas.

1251

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

1252

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

1253

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

1254

# sexual activities.

1255

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

1256

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

1257

# funny or offensive.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

},

},

],

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1265

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1266

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

1267

1268

Progress and results can be retrieved through the

1269

`google.longrunning.Operations` interface.

1270

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

1271

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

1272

1273

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

1274

GCS bucket, each json file containing BatchAnnotateImagesResponse proto.

1275

1276

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1277

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1278

The object takes the form of:

1279

1280

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

Bu Sun Kim

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

[diff] [blame]

1281

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

1282

#

1283

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

1284

#

1285

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

1286

#

1287

# Supported location-ids:

1288

# `us`: USA country only,

1289

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

1290

# `eu`: The European Union.

1291

#

1292

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

1293

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

1294

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

1295

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1296

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

1297

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

1298

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

1299

# 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

1305

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

Bu Sun Kim

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

[diff] [blame]

1306

# output files will begin with "filenameprefix".

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1307

#

1308

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

1309

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

1310

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

1311

# specified.

1312

#

1313

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

1314

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

1315

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

1316

# and overflows into multiple sharded files.

1317

},

Bu Sun Kim

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

[diff] [blame]

1318

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

1319

# Google Cloud Storage.

1320

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

1321

#

1322

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

1323

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

1324

# containing 20 response protos will be written under the prefix

1325

# `gcs_destination`.`uri`.

1326

#

1327

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

1328

# support for other output configurations.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1329

},

Bu Sun Kim

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

[diff] [blame]

1330

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1331

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

1332

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

Bu Sun Kim

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

[diff] [blame]

1333

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

1334

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1335

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

1336

# representation, whereas JSON representations use base64.

Bu Sun Kim

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

[diff] [blame]

1337

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1338

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

1339

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

Bu Sun Kim

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

[diff] [blame]

1340

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1341

#

1342

# 1. A Google Cloud Storage URI of the form

1343

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

1344

# [Google Cloud Storage Request

1345

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

1346

# info.

1347

#

1348

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

1349

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

1350

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

1351

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

1352

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

1353

# depend on externally-hosted images for production applications.

1354

#

1355

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

1356

# precedence.

Bu Sun Kim

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

[diff] [blame]

1357

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

1358

#

1359

# The Google Cloud Storage URI of the form

1360

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

1361

# [Google Cloud Storage Request

1362

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1363

},

1364

},

Bu Sun Kim

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

[diff] [blame]

1365

"features": [ # Requested features.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1366

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

1367

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

1368

# be specified in the `features` list.

Bu Sun Kim

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

[diff] [blame]

1369

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

1370

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1371

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

Bu Sun Kim

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

[diff] [blame]

1372

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

1373

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

1374

# "builtin/latest".

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1375

},

1376

],

Bu Sun Kim

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

[diff] [blame]

1377

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

1378

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

1379

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

1380

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

1381

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

1382

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

1383

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

1384

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

1385

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

1386

"A String",

1387

],

1388

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

1389

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

1390

},

1391

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

1392

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

1393

# of doubles representing degrees latitude and degrees longitude. Unless

1394

# specified otherwise, this must conform to the

1395

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

1396

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

1397

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

1398

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

1399

},

1400

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

1401

# of doubles representing degrees latitude and degrees longitude. Unless

1402

# specified otherwise, this must conform to the

1403

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

1404

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

1405

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

1406

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

1407

},

1408

},

1409

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

1410

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

1411

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

1412

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

1413

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

1414

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

# ignored.

3.14,

],

},

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

1420

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

1421

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

1422

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

1423

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

1424

#

1425

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

1426

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

1427

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

1428

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

1429

#

1430

# Format is:

1431

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

1432

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

1433

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

1434

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

1435

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

1436

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

1437

# and range from 0 to 1.

1438

"y": 3.14, # Y coordinate.

1439

"x": 3.14, # X coordinate.

1440

},

1441

],

1442

"vertices": [ # The bounding polygon vertices.

1443

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

1444

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

1445

"y": 42, # Y coordinate.

1446

"x": 42, # X coordinate.

},

],

},

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

1451

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

1452

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

1453

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

1454

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

1455

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

1456

# migrate existing products to these categories as well.

"A String",

],

},

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1461

},

1462

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1463

}

1464

1465

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1472

1473

{ # This resource represents a long-running operation that is the result of a

1474

# network API call.

Bu Sun Kim

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

[diff] [blame]

1475

"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.

1476

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

1477

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

1478

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

1479

#

1480

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

1481

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

1482

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

1483

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

1484

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

1485

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

1486

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

1487

# message types for APIs to use.

1488

{

1489

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

},

],

},

"metadata": { # Service-specific metadata associated with the operation. It typically

1494

# contains progress information and common metadata such as create time.

1495

# Some services might not provide such metadata. Any method that returns a

1496

# long-running operation should document the metadata type, if any.

1497

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

1498

},

1499

"done": True or False, # If the value is `false`, it means the operation is still in progress.

1500

# If `true`, the operation is completed, and either `error` or `response` is

1501

# available.

1502

"response": { # The normal response of the operation in case of success. If the original

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1503

# method returns no data on success, such as `Delete`, the response is

1504

# `google.protobuf.Empty`. If the original method is standard

1505

# `Get`/`Create`/`Update`, the response should be the resource. For other

1506

# methods, the response should have the type `XxxResponse`, where `Xxx`

1507

# is the original method name. For example, if the original method name

1508

# is `TakeSnapshot()`, the inferred response type is

1509

# `TakeSnapshotResponse`.

Bu Sun Kim

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

[diff] [blame]

1510

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1511

},

Bu Sun Kim

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

[diff] [blame]

1512

"name": "A String", # The server-assigned name, which is only unique within the same service that

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1513

# originally returns it. If you use the default HTTP mapping, the

1514

# `name` should be a resource name ending with `operations/{unique_id}`.

Bu Sun Kim