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

<h1><a href="vision_v1p1beta1.html">Cloud Vision API</a> . <a href="vision_v1p1beta1.projects.html">projects</a> . <a href="vision_v1p1beta1.projects.images.html">images</a></h1>

76

<h2>Instance Methods</h2>

77

78

<code><a href="#annotate">annotate(parent, body=None, x__xgafv=None)</a></code></p>

79

<p class="firstline">Run image detection and annotation for a batch of images.</p>

80

81

<code><a href="#asyncBatchAnnotate">asyncBatchAnnotate(parent, body=None, x__xgafv=None)</a></code></p>

82

<p class="firstline">Run asynchronous image detection and annotation for a list of images.</p>

83

<h3>Method Details</h3>

84

85

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

86

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

87

88

Args:

89

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

90

91

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

92

93

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

94

95

Supported location-ids:

96

`us`: USA country only,

97

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

98

`eu`: The European Union.

99

100

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

101

body: object, The request body.

102

The object takes the form of:

103

104

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

105

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

106

#

107

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

108

#

109

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

110

#

111

# Supported location-ids:

112

# `us`: USA country only,

113

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

114

# `eu`: The European Union.

115

#

116

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

117

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

118

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

119

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

120

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

121

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

122

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

123

# representation, whereas JSON representations use base64.

124

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

125

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

126

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

127

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

128

#

129

# 1. A Google Cloud Storage URI of the form

130

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

131

# [Google Cloud Storage Request

132

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

133

# info.

134

#

135

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

136

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

137

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

138

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

139

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

140

# depend on externally-hosted images for production applications.

141

#

142

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

143

# precedence.

144

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

145

#

146

# The Google Cloud Storage URI of the form

147

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

148

# [Google Cloud Storage Request

149

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

150

},

151

},

152

"features": [ # Requested features.

153

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

154

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

155

# be specified in the `features` list.

156

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

157

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

158

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

159

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

160

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

# "builtin/latest".

},

],

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

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

],

175

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

176

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

177

},

178

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

179

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

180

# of doubles representing degrees latitude and degrees longitude. Unless

181

# specified otherwise, this must conform to the

182

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

183

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

184

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

185

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

186

},

187

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

188

# of doubles representing degrees latitude and degrees longitude. Unless

189

# specified otherwise, this must conform to the

190

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

191

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

192

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

193

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

194

},

195

},

196

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

197

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

198

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

199

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

200

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

201

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

207

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

208

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

209

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

210

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

211

#

212

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

213

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

214

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

215

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

216

#

217

# Format is:

218

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

219

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

220

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

221

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

222

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

223

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

224

# and range from 0 to 1.

225

"y": 3.14, # Y coordinate.

226

"x": 3.14, # X coordinate.

227

},

228

],

229

"vertices": [ # The bounding polygon vertices.

230

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

231

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

232

"y": 42, # Y coordinate.

233

"x": 42, # X coordinate.

},

],

},

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

238

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

239

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

240

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

241

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

242

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

243

# migrate existing products to these categories as well.

"A String",

],

},

},

},

],

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

259

260

{ # Response to a batch image annotation request.

261

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

262

{ # Response to an image annotation request.

263

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

264

{ # Set of detected entity features.

265

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

266

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

267

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

268

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

269

# detected distant towering building, even though the confidence that

270

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

271

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

272

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

273

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

274

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

275

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

276

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

277

},

278

],

279

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

280

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

281

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

282

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

283

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

284

# Location information is usually present for landmarks.

285

{ # Detected entity location information.

286

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

287

# of doubles representing degrees latitude and degrees longitude. Unless

288

# specified otherwise, this must conform to the

289

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

290

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

291

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

292

"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

297

# [Google Knowledge Graph Search

298

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

299

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

300

# The accuracy of the entity detection in an image.

301

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

302

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

303

# image. Range [0, 1].

304

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

305

# for `LABEL_DETECTION` features.

306

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

307

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

308

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

309

# and range from 0 to 1.

310

"y": 3.14, # Y coordinate.

311

"x": 3.14, # X coordinate.

312

},

313

],

314

"vertices": [ # The bounding polygon vertices.

315

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

316

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

317

"y": 42, # Y coordinate.

318

"x": 42, # X coordinate.

},

],

},

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

323

# `description` is expressed.

324

},

325

],

326

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

327

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

328

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

329

"landmarks": [ # Detected face landmarks.

330

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

331

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

332

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

333

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

334

"x": 3.14, # X coordinate.

335

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

336

"y": 3.14, # Y coordinate.

337

},

338

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

339

},

340

],

341

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

342

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

343

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

344

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

345

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

346

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

347

# [-180,180].

348

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

349

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

350

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

351

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

352

# are in the original image's scale.

353

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

354

# expectations. It is based on the landmarker results.

355

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

356

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

357

# appears in the image to be annotated.

358

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

359

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

360

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

361

# and range from 0 to 1.

362

"y": 3.14, # Y coordinate.

363

"x": 3.14, # X coordinate.

364

},

365

],

366

"vertices": [ # The bounding polygon vertices.

367

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

368

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

369

"y": 42, # Y coordinate.

370

"x": 42, # X coordinate.

},

],

},

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

375

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

376

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

377

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

378

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

379

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

380

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

381

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

382

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

383

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

384

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

385

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

386

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

387

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

388

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

389

# and range from 0 to 1.

390

"y": 3.14, # Y coordinate.

391

"x": 3.14, # X coordinate.

392

},

393

],

394

"vertices": [ # The bounding polygon vertices.

395

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

396

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

397

"y": 42, # Y coordinate.

398

"x": 42, # X coordinate.

},

],

},

},

],

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

405

"cropHints": [ # Crop hint results.

406

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

407

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

408

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

409

# image.

410

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

411

# box are in the original image's scale.

412

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

413

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

414

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

415

# and range from 0 to 1.

416

"y": 3.14, # Y coordinate.

417

"x": 3.14, # X coordinate.

418

},

419

],

420

"vertices": [ # The bounding polygon vertices.

421

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

422

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

423

"y": 42, # Y coordinate.

424

"x": 42, # X coordinate.

},

],

},

},

],

},

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

432

{ # Set of detected entity features.

433

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

434

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

435

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

436

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

437

# detected distant towering building, even though the confidence that

438

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

439

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

440

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

441

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

442

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

443

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

444

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

445

},

446

],

447

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

448

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

449

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

450

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

451

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

452

# Location information is usually present for landmarks.

453

{ # Detected entity location information.

454

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

455

# of doubles representing degrees latitude and degrees longitude. Unless

456

# specified otherwise, this must conform to the

457

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

458

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

459

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

460

"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

465

# [Google Knowledge Graph Search

466

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

467

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

468

# The accuracy of the entity detection in an image.

469

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

470

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

471

# image. Range [0, 1].

472

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

473

# for `LABEL_DETECTION` features.

474

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

475

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

476

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

477

# and range from 0 to 1.

478

"y": 3.14, # Y coordinate.

479

"x": 3.14, # X coordinate.

480

},

481

],

482

"vertices": [ # The bounding polygon vertices.

483

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

484

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

485

"y": 42, # Y coordinate.

486

"x": 42, # X coordinate.

},

],

},

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

491

# `description` is expressed.

492

},

493

],

494

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

495

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

496

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

497

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

498

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

499

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

500

# image.

501

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

502

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

503

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

504

# information, see

505

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

506

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

507

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

508

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

509

},

510

],

511

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

512

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

513

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

514

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

515

# and range from 0 to 1.

516

"y": 3.14, # Y coordinate.

517

"x": 3.14, # X coordinate.

518

},

519

],

520

"vertices": [ # The bounding polygon vertices.

521

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

522

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

523

"y": 42, # Y coordinate.

524

"x": 42, # X coordinate.

},

],

},

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

529

{ # Information about a product.

530

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

531

# to the query.

532

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

533

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

534

# 4096 characters long.

535

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

536

# characters long.

537

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

538

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

539

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

540

# not be used for new products.

541

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

542

# constraints can be specified based on the product_labels.

543

#

544

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

545

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

546

# to be supported soon.

547

#

548

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

549

# 500 product_labels.

550

#

551

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

552

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

553

# will refuse to work for that ProductSet.

554

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

555

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

556

# exceed 128 bytes.

557

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

558

# cannot exceed 128 bytes.

559

},

560

],

561

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

562

#

563

# Format is:

564

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

565

#

566

# This field is ignored when creating a product.

567

},

568

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

569

# 1 (full confidence).

},

],

},

],

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

575

{ # Information about a product.

576

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

577

# to the query.

578

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

579

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

580

# 4096 characters long.

581

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

582

# characters long.

583

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

584

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

585

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

586

# not be used for new products.

587

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

588

# constraints can be specified based on the product_labels.

589

#

590

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

591

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

592

# to be supported soon.

593

#

594

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

595

# 500 product_labels.

596

#

597

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

598

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

599

# will refuse to work for that ProductSet.

600

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

601

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

602

# exceed 128 bytes.

603

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

604

# cannot exceed 128 bytes.

605

},

606

],

607

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

608

#

609

# Format is:

610

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

611

#

612

# This field is ignored when creating a product.

613

},

614

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

615

# 1 (full confidence).

616

},

617

],

618

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

619

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

620

# not reflected in the current results.

621

},

622

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

623

# This will be sorted descending by confidence score.

624

{ # Set of detected objects with bounding boxes.

625

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

626

# information, see

627

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

628

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

629

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

630

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

631

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

632

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

633

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

634

# and range from 0 to 1.

635

"y": 3.14, # Y coordinate.

636

"x": 3.14, # X coordinate.

637

},

638

],

639

"vertices": [ # The bounding polygon vertices.

640

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

641

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

642

"y": 42, # Y coordinate.

643

"x": 42, # X coordinate.

},

],

},

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

648

},

649

],

650

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

651

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

652

# correct, even when `error` is set.

653

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

654

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

655

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

656

#

657

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

658

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

659

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

660

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

661

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

662

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

663

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

664

# message types for APIs to use.

665

{

666

"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

671

# completed successfully.

672

# This annotation provides the structural hierarchy for the OCR detected

673

# text.

674

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

675

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

676

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

677

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

678

# to the TextAnnotation.TextProperty message definition below for more

679

# detail.

680

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

681

{ # Detected page from OCR.

682

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

683

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

684

# TIFFs) the unit is pixels.

685

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

686

# TIFFs) the unit is pixels.

687

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

688

{ # Logical element on the page.

689

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

690

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

691

{ # Detected language for a structural component.

692

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

693

# information, see

694

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

695

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

696

},

697

],

698

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

699

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

700

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

701

},

702

},

703

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

704

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

705

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

706

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

707

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

708

# read in the 'natural' orientation.

709

# For example:

710

#

711

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

724

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

725

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

726

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

727

# and range from 0 to 1.

728

"y": 3.14, # Y coordinate.

729

"x": 3.14, # X coordinate.

730

},

731

],

732

"vertices": [ # The bounding polygon vertices.

733

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

734

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

735

"y": 42, # Y coordinate.

736

"x": 42, # X coordinate.

},

],

},

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

741

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

742

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

743

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

744

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

745

{ # Detected language for a structural component.

746

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

747

# information, see

748

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

749

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

750

},

751

],

752

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

753

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

754

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

755

},

756

},

757

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

758

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

759

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

760

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

761

# read in the 'natural' orientation.

762

# For example:

763

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

772

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

773

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

774

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

775

# and range from 0 to 1.

776

"y": 3.14, # Y coordinate.

777

"x": 3.14, # X coordinate.

778

},

779

],

780

"vertices": [ # The bounding polygon vertices.

781

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

782

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

783

"y": 42, # Y coordinate.

784

"x": 42, # X coordinate.

},

],

},

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

789

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

790

{ # A word representation.

791

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

792

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

793

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

794

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

795

# read in the 'natural' orientation.

796

# For example:

797

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

806

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

807

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

808

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

809

# and range from 0 to 1.

810

"y": 3.14, # Y coordinate.

811

"x": 3.14, # X coordinate.

812

},

813

],

814

"vertices": [ # The bounding polygon vertices.

815

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

816

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

817

"y": 42, # Y coordinate.

818

"x": 42, # X coordinate.

},

],

},

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

823

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

824

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

825

{ # A single symbol representation.

826

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

827

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

828

{ # Detected language for a structural component.

829

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

830

# information, see

831

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

832

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

833

},

834

],

835

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

836

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

837

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

838

},

839

},

840

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

841

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

842

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

843

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

844

# read in the 'natural' orientation.

845

# For example:

846

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

855

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

856

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

857

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

858

# and range from 0 to 1.

859

"y": 3.14, # Y coordinate.

860

"x": 3.14, # X coordinate.

861

},

862

],

863

"vertices": [ # The bounding polygon vertices.

864

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

865

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

866

"y": 42, # Y coordinate.

867

"x": 42, # X coordinate.

},

],

},

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

872

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

873

},

874

],

875

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

876

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

877

{ # Detected language for a structural component.

878

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

879

# information, see

880

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

881

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

882

},

883

],

884

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

885

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

886

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

},

},

},

],

},

],

},

],

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

896

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

897

{ # Detected language for a structural component.

898

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

899

# information, see

900

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

901

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

902

},

903

],

904

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

905

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

906

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

},

},

},

],

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

912

},

913

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

914

{ # Set of detected entity features.

915

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

916

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

917

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

918

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

919

# detected distant towering building, even though the confidence that

920

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

921

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

922

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

923

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

924

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

925

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

926

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

927

},

928

],

929

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

930

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

931

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

932

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

933

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

934

# Location information is usually present for landmarks.

935

{ # Detected entity location information.

936

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

937

# of doubles representing degrees latitude and degrees longitude. Unless

938

# specified otherwise, this must conform to the

939

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

940

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

941

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

942

"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

947

# [Google Knowledge Graph Search

948

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

949

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

950

# The accuracy of the entity detection in an image.

951

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

952

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

953

# image. Range [0, 1].

954

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

955

# for `LABEL_DETECTION` features.

956

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

957

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

958

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

959

# and range from 0 to 1.

960

"y": 3.14, # Y coordinate.

961

"x": 3.14, # X coordinate.

962

},

963

],

964

"vertices": [ # The bounding polygon vertices.

965

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

966

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

967

"y": 42, # Y coordinate.

968

"x": 42, # X coordinate.

},

],

},

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

973

# `description` is expressed.

974

},

975

],

976

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

977

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

978

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

979

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

980

# the image that the color occupies in the image.

981

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

982

# Value in range [0, 1].

983

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

984

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

985

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

986

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

987

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

988

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

989

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

990

#

991

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

992

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

993

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

# space.

#

# Example (Java):

#

# import com.google.type.Color;

999

#

1000

# // ...

1001

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

1002

# float alpha = protocolor.hasAlpha()

1003

# ? protocolor.getAlpha().getValue()

1004

# : 1.0;

1005

#

1006

# return new java.awt.Color(

1007

# protocolor.getRed(),

1008

# protocolor.getGreen(),

1009

# protocolor.getBlue(),

# alpha);

# }

#

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

1014

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

1015

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

1016

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

1017

# float denominator = 255.0;

1018

# Color.Builder resultBuilder =

1019

# Color

1020

# .newBuilder()

1021

# .setRed(red / denominator)

1022

# .setGreen(green / denominator)

1023

# .setBlue(blue / denominator);

1024

# int alpha = color.getAlpha();

1025

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

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

1030

# .build());

1031

# }

1032

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

1037

#

1038

# // ...

1039

# static UIColor* fromProto(Color* protocolor) {

1040

# float red = [protocolor red];

1041

# float green = [protocolor green];

1042

# float blue = [protocolor blue];

1043

# FloatValue* alpha_wrapper = [protocolor alpha];

1044

# float alpha = 1.0;

1045

# if (alpha_wrapper != nil) {

1046

# alpha = [alpha_wrapper value];

1047

# }

1048

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

1049

# }

1050

#

1051

# static Color* toProto(UIColor* color) {

1052

# CGFloat red, green, blue, alpha;

1053

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

1054

# return nil;

1055

# }

1056

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

1057

# [result setRed:red];

1058

# [result setGreen:green];

1059

# [result setBlue:blue];

1060

# if (alpha <= 0.9999) {

1061

# [result setAlpha:floatWrapperWithValue(alpha)];

1062

# }

1063

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

1073

# var redFrac = rgb_color.red || 0.0;

1074

# var greenFrac = rgb_color.green || 0.0;

1075

# var blueFrac = rgb_color.blue || 0.0;

1076

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

1077

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

1078

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

1079

#

1080

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

1081

# return rgbToCssColor_(red, green, blue);

1082

# }

1083

#

1084

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

1085

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

1086

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

1087

# };

1088

#

1089

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

1090

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

1091

# var hexString = rgbNumber.toString(16);

1092

# var missingZeros = 6 - hexString.length;

1093

# var resultBuilder = ['#'];

1094

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

1095

# resultBuilder.push('0');

1096

# }

1097

# resultBuilder.push(hexString);

1098

# return resultBuilder.join('');

# };

#

# // ...

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

1103

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

1104

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

1105

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

1106

# the final pixel color is defined by the equation:

1107

#

1108

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

1109

#

1110

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

1111

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

1112

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

1113

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

1114

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

1115

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

1116

},

1117

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

},

],

},

},

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

1123

{ # Set of detected entity features.

1124

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

1125

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

1126

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

1127

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

1128

# detected distant towering building, even though the confidence that

1129

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

1130

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

1131

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

1132

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

1133

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

1134

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

1135

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

1136

},

1137

],

1138

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

1139

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

1140

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

1141

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

1142

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

1143

# Location information is usually present for landmarks.

1144

{ # Detected entity location information.

1145

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

1146

# of doubles representing degrees latitude and degrees longitude. Unless

1147

# specified otherwise, this must conform to the

1148

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

1149

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

1150

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

1151

"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

1156

# [Google Knowledge Graph Search

1157

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

1158

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

1159

# The accuracy of the entity detection in an image.

1160

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

1161

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

1162

# image. Range [0, 1].

1163

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

1164

# for `LABEL_DETECTION` features.

1165

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

1166

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

1167

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

1168

# and range from 0 to 1.

1169

"y": 3.14, # Y coordinate.

1170

"x": 3.14, # X coordinate.

1171

},

1172

],

1173

"vertices": [ # The bounding polygon vertices.

1174

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

1175

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

1176

"y": 42, # Y coordinate.

1177

"x": 42, # X coordinate.

},

],

},

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

1182

# `description` is expressed.

1183

},

1184

],

1185

"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

1186

# comes from.

1187

# information about the source of that image.

1188

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

1189

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

1190

# the file used to produce the image.

1191

},

1192

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

1193

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

1194

{ # Metadata for online images.

1195

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

1196

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

1197

},

1198

],

1199

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

1200

# Inferred from similar images on the open web.

1201

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

1202

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

1203

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

1204

# For more information, see

1205

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

1206

},

1207

],

1208

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

1209

# Can include resized copies of the query image.

1210

{ # Metadata for online images.

1211

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

1212

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

1213

},

1214

],

1215

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

1216

{ # Entity deduced from similar images on the Internet.

1217

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

1218

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

1219

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

1220

# Not normalized and not comparable across different image queries.

1221

},

1222

],

1223

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

1224

{ # Metadata for web pages.

1225

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

1226

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

1227

# Can include resized copies of the query image.

1228

{ # Metadata for online images.

1229

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

1230

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

1231

},

1232

],

1233

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

1234

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

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

1237

# crops.

1238

{ # Metadata for online images.

1239

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

1240

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

1241

},

1242

],

1243

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

1244

},

1245

],

1246

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

1247

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

1248

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

1249

{ # Metadata for online images.

1250

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

1251

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

},

],

},

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

1256

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

1257

# violence).

1258

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

1259

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

1260

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

1261

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

1262

# body areas.

1263

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

1264

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

1265

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

1266

# sexual activities.

1267

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

1268

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

1269

# funny or offensive.

},

},

],

}</pre>

</div>

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

1278

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

1279

1280

Progress and results can be retrieved through the

1281

`google.longrunning.Operations` interface.

1282

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

1283

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

1284

1285

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

1286

GCS bucket, each json file containing BatchAnnotateImagesResponse proto.

1287

1288

Args:

1289

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

1290

1291

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

1292

1293

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

1294

1295

Supported location-ids:

1296

`us`: USA country only,

1297

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

1298

`eu`: The European Union.

1299

1300

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

1301

body: object, The request body.

1302

The object takes the form of:

1303

1304

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

1305

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

1306

#

1307

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

1308

#

1309

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

1310

#

1311

# Supported location-ids:

1312

# `us`: USA country only,

1313

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

1314

# `eu`: The European Union.

1315

#

1316

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

1317

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

1318

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

1319

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

1320

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

1321

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

1322

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

1323

# 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

1329

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

1330

# output files will begin with "filenameprefix".

1331

#

1332

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

1333

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

1334

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

1335

# specified.

1336

#

1337

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

1338

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

1339

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

1340

# and overflows into multiple sharded files.

1341

},

1342

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

1343

# Google Cloud Storage.

1344

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

1345

#

1346

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

1347

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

1348

# containing 20 response protos will be written under the prefix

1349

# `gcs_destination`.`uri`.

1350

#

1351

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

1352

# support for other output configurations.

1353

},

1354

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

1355

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

1356

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

1357

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

1358

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

1359

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

1360

# representation, whereas JSON representations use base64.

1361

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

1362

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

1363

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

1364

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

1365

#

1366

# 1. A Google Cloud Storage URI of the form

1367

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

1368

# [Google Cloud Storage Request

1369

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

1370

# info.

1371

#

1372

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

1373

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

1374

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

1375

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

1376

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

1377

# depend on externally-hosted images for production applications.

1378

#

1379

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

1380

# precedence.

1381

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

1382

#

1383

# The Google Cloud Storage URI of the form

1384

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

1385

# [Google Cloud Storage Request

1386

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

1387

},

1388

},

1389

"features": [ # Requested features.

1390

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

1391

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

1392

# be specified in the `features` list.

1393

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

1394

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

1395

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

1396

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

1397

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

# "builtin/latest".

},

],

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

1402

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

1403

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

1404

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

1405

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

1406

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

1407

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

1408

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

1409

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

1410

"A String",

1411

],

1412

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

1413

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

1414

},

1415

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

1416

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

1417

# of doubles representing degrees latitude and degrees longitude. Unless

1418

# specified otherwise, this must conform to the

1419

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

1420

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

1421

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

1422

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

1423

},

1424

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

1425

# of doubles representing degrees latitude and degrees longitude. Unless

1426

# specified otherwise, this must conform to the

1427

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

1428

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

1429

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

1430

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

1431

},

1432

},

1433

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

1434

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

1435

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

1436

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

1437

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

1438

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

1444

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

1445

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

1446

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

1447

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

1448

#

1449

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

1450

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

1451

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

1452

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

1453

#

1454

# Format is:

1455

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

1456

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

1457

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

1458

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

1459

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

1460

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

1461

# and range from 0 to 1.

1462

"y": 3.14, # Y coordinate.

1463

"x": 3.14, # X coordinate.

1464

},

1465

],

1466

"vertices": [ # The bounding polygon vertices.

1467

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

1468

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

1469

"y": 42, # Y coordinate.

1470

"x": 42, # X coordinate.

},

],

},

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

1475

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

1476

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

1477

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

1478

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

1479

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

1480

# migrate existing products to these categories as well.

"A String",

],

},

},

},

],

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1496

1497

{ # This resource represents a long-running operation that is the result of a

1498

# network API call.

1499

"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.

1500

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

1501

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

1502

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

1503

#

1504

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

1505

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

1506

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

1507

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

1508

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

1509

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

1510

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

1511

# message types for APIs to use.

1512

{

1513

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

},

],

},

"metadata": { # Service-specific metadata associated with the operation. It typically

1518

# contains progress information and common metadata such as create time.

1519

# Some services might not provide such metadata. Any method that returns a

1520

# long-running operation should document the metadata type, if any.

1521

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

1522

},

1523

"done": True or False, # If the value is `false`, it means the operation is still in progress.

1524

# If `true`, the operation is completed, and either `error` or `response` is

1525

# available.

1526

"response": { # The normal response of the operation in case of success. If the original

1527

# method returns no data on success, such as `Delete`, the response is

1528

# `google.protobuf.Empty`. If the original method is standard

1529

# `Get`/`Create`/`Update`, the response should be the resource. For other

1530

# methods, the response should have the type `XxxResponse`, where `Xxx`

1531

# is the original method name. For example, if the original method name

1532

# is `TakeSnapshot()`, the inferred response type is

1533

# `TakeSnapshotResponse`.

1534

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

1535

},

1536

"name": "A String", # The server-assigned name, which is only unique within the same service that

1537

# originally returns it. If you use the default HTTP mapping, the

1538

# `name` should be a resource name ending with `operations/{unique_id}`.

}</pre>

</div>

</body></html>