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

<h1><a href="vision_v1p2beta1.html">Cloud Vision API</a> . <a href="vision_v1p2beta1.projects.html">projects</a> . <a href="vision_v1p2beta1.projects.files.html">files</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">Service that performs image detection and annotation for a batch of files.</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 generic</p>

83

<h3>Method Details</h3>

84

85

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

86

<pre>Service that performs image detection and annotation for a batch of files.

87

Now only "application/pdf", "image/tiff" and "image/gif" are supported.

88

89

This service will extract at most 5 (customers can specify which 5 in

90

AnnotateFileRequest.pages) frames (gif) or pages (pdf or tiff) from each

91

file provided and perform detection and annotation for each image

extracted.

Args:

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

96

97

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

98

99

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

100

101

Supported location-ids:

102

`us`: USA country only,

103

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

104

`eu`: The European Union.

105

106

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

107

body: object, The request body.

108

The object takes the form of:

109

110

{ # A list of requests to annotate files using the BatchAnnotateFiles API.

111

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

112

#

113

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

114

#

115

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

116

#

117

# Supported location-ids:

118

# `us`: USA country only,

119

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

120

# `eu`: The European Union.

121

#

122

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

123

"requests": [ # Required. The list of file annotation requests. Right now we support only one

124

# AnnotateFileRequest in BatchAnnotateFilesRequest.

125

{ # A request to annotate one single file, e.g. a PDF, TIFF or GIF file.

126

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

127

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

128

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

129

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

130

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

131

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

132

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

133

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

134

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

135

"A String",

136

],

137

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

138

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

139

},

140

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

141

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

142

# of doubles representing degrees latitude and degrees longitude. Unless

143

# specified otherwise, this must conform to the

144

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

145

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

146

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

147

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

148

},

149

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

150

# of doubles representing degrees latitude and degrees longitude. Unless

151

# specified otherwise, this must conform to the

152

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

153

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

154

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

155

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

156

},

157

},

158

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

159

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

160

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

161

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

162

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

163

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

169

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

170

#

171

# Format is:

172

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

173

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

174

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

175

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

176

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

177

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

178

# and range from 0 to 1.

179

"y": 3.14, # Y coordinate.

180

"x": 3.14, # X coordinate.

181

},

182

],

183

"vertices": [ # The bounding polygon vertices.

184

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

185

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

186

"y": 42, # Y coordinate.

187

"x": 42, # X coordinate.

},

],

},

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

192

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

193

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

194

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

195

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

196

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

197

# migrate existing products to these categories as well.

198

"A String",

199

],

200

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

201

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

202

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

203

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

204

#

205

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

206

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

207

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

208

},

209

},

210

"pages": [ # Pages of the file to perform image annotation.

211

#

212

# Pages starts from 1, we assume the first page of the file is page 1.

213

# At most 5 pages are supported per request. Pages can be negative.

214

#

215

# Page 1 means the first page.

216

# Page 2 means the second page.

217

# Page -1 means the last page.

218

# Page -2 means the second to the last page.

219

#

220

# If the file is GIF instead of PDF or TIFF, page refers to GIF frames.

221

#

222

# If this field is empty, by default the service performs image annotation

223

# for the first 5 pages of the file.

224

42,

225

],

226

"inputConfig": { # The desired input location and metadata. # Required. Information about the input file.

227

"gcsSource": { # The Google Cloud Storage location where the input will be read from. # The Google Cloud Storage location to read the input from.

228

"uri": "A String", # Google Cloud Storage URI for the input file. This must only be a

229

# Google Cloud Storage object. Wildcards are not currently supported.

230

},

231

"mimeType": "A String", # The type of the file. Currently only "application/pdf", "image/tiff" and

232

# "image/gif" are supported. Wildcards are not supported.

233

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

234

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

235

# representation, whereas JSON representations use base64.

236

#

237

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

238

# not work for AsyncBatchAnnotateFiles requests.

239

},

240

"features": [ # Required. Requested features.

241

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

242

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

243

# be specified in the `features` list.

244

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

245

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

246

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

247

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

248

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

# "builtin/latest".

},

],

},

],

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

263

264

{ # A list of file annotation responses.

265

"responses": [ # The list of file annotation responses, each response corresponding to each

266

# AnnotateFileRequest in BatchAnnotateFilesRequest.

267

{ # Response to a single file annotation request. A file may contain one or more

268

# images, which individually have their own responses.

269

"totalPages": 42, # This field gives the total number of pages in the file.

270

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

271

# `responses` field will not be set in this case.

272

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

273

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

274

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

275

#

276

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

277

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

278

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

279

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

280

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

281

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

282

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

283

# message types for APIs to use.

284

{

285

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

},

],

},

"responses": [ # Individual responses to images found within the file. This field will be

290

# empty if the `error` field is set.

291

{ # Response to an image annotation request.

292

"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

293

# comes from.

294

# information about the source of that image.

295

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

296

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

297

# the file used to produce the image.

298

},

299

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

300

{ # Set of detected entity features.

301

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

302

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

303

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

304

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

305

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

306

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

307

},

308

],

309

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

310

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

311

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

312

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

313

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

314

# Location information is usually present for landmarks.

315

{ # Detected entity location information.

316

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

317

# of doubles representing degrees latitude and degrees longitude. Unless

318

# specified otherwise, this must conform to the

319

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

320

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

321

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

322

"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

327

# [Google Knowledge Graph Search

328

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

329

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

330

# The accuracy of the entity detection in an image.

331

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

332

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

333

# image. Range [0, 1].

334

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

335

# `description` is expressed.

336

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

337

# for `LABEL_DETECTION` features.

338

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

339

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

340

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

341

# and range from 0 to 1.

342

"y": 3.14, # Y coordinate.

343

"x": 3.14, # X coordinate.

344

},

345

],

346

"vertices": [ # The bounding polygon vertices.

347

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

348

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

349

"y": 42, # Y coordinate.

350

"x": 42, # X coordinate.

},

],

},

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

355

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

356

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

357

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

358

# detected distant towering building, even though the confidence that

359

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

360

},

361

],

362

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

363

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

364

{ # Entity deduced from similar images on the Internet.

365

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

366

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

367

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

368

# Not normalized and not comparable across different image queries.

369

},

370

],

371

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

372

{ # Metadata for web pages.

373

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

374

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

375

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

376

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

377

# crops.

378

{ # Metadata for online images.

379

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

380

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

381

},

382

],

383

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

384

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

385

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

386

# Can include resized copies of the query image.

387

{ # Metadata for online images.

388

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

389

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

},

],

},

],

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

395

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

396

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

397

{ # Metadata for online images.

398

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

399

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

400

},

401

],

402

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

403

{ # Metadata for online images.

404

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

405

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

406

},

407

],

408

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

409

# Inferred from similar images on the open web.

410

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

411

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

412

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

413

# For more information, see

414

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

415

},

416

],

417

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

418

# Can include resized copies of the query image.

419

{ # Metadata for online images.

420

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

421

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

426

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

427

# violence).

428

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

429

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

430

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

431

# body areas.

432

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

433

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

434

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

435

# sexual activities.

436

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

437

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

438

# funny or offensive.

439

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

440

},

441

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

442

{ # Set of detected entity features.

443

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

444

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

445

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

446

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

447

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

448

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

449

},

450

],

451

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

452

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

453

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

454

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

455

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

456

# Location information is usually present for landmarks.

457

{ # Detected entity location information.

458

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

459

# of doubles representing degrees latitude and degrees longitude. Unless

460

# specified otherwise, this must conform to the

461

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

462

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

463

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

464

"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

469

# [Google Knowledge Graph Search

470

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

471

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

472

# The accuracy of the entity detection in an image.

473

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

474

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

475

# image. Range [0, 1].

476

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

477

# `description` is expressed.

478

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

479

# for `LABEL_DETECTION` features.

480

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

481

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

482

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

483

# and range from 0 to 1.

484

"y": 3.14, # Y coordinate.

485

"x": 3.14, # X coordinate.

486

},

487

],

488

"vertices": [ # The bounding polygon vertices.

489

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

490

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

491

"y": 42, # Y coordinate.

492

"x": 42, # X coordinate.

},

],

},

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

497

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

498

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

499

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

500

# detected distant towering building, even though the confidence that

501

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

502

},

503

],

504

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

505

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

506

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

507

# are in the original image's scale.

508

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

509

# expectations. It is based on the landmarker results.

510

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

511

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

512

# appears in the image to be annotated.

513

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

514

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

515

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

516

# and range from 0 to 1.

517

"y": 3.14, # Y coordinate.

518

"x": 3.14, # X coordinate.

519

},

520

],

521

"vertices": [ # The bounding polygon vertices.

522

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

523

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

524

"y": 42, # Y coordinate.

525

"x": 42, # X coordinate.

},

],

},

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

530

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

531

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

532

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

533

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

534

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

535

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

536

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

537

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

538

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

539

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

540

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

541

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

542

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

543

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

544

# and range from 0 to 1.

545

"y": 3.14, # Y coordinate.

546

"x": 3.14, # X coordinate.

547

},

548

],

549

"vertices": [ # The bounding polygon vertices.

550

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

551

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

552

"y": 42, # Y coordinate.

553

"x": 42, # X coordinate.

},

],

},

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

558

"landmarks": [ # Detected face landmarks.

559

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

560

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

561

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

562

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

563

"y": 3.14, # Y coordinate.

564

"x": 3.14, # X coordinate.

565

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

566

},

567

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

568

},

569

],

570

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

571

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

572

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

573

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

574

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

575

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

576

# [-180,180].

577

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

578

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

579

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

580

},

581

],

582

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

583

"cropHints": [ # Crop hint results.

584

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

585

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

586

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

587

# image.

588

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

589

# box are in the original image's scale.

590

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

591

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

592

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

593

# and range from 0 to 1.

594

"y": 3.14, # Y coordinate.

595

"x": 3.14, # X coordinate.

596

},

597

],

598

"vertices": [ # The bounding polygon vertices.

599

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

600

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

601

"y": 42, # Y coordinate.

602

"x": 42, # X coordinate.

},

],

},

},

],

},

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

610

{ # Set of detected entity features.

611

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

612

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

613

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

614

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

615

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

616

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

617

},

618

],

619

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

620

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

621

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

622

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

623

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

624

# Location information is usually present for landmarks.

625

{ # Detected entity location information.

626

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

627

# of doubles representing degrees latitude and degrees longitude. Unless

628

# specified otherwise, this must conform to the

629

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

630

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

631

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

632

"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

637

# [Google Knowledge Graph Search

638

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

639

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

640

# The accuracy of the entity detection in an image.

641

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

642

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

643

# image. Range [0, 1].

644

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

645

# `description` is expressed.

646

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

647

# for `LABEL_DETECTION` features.

648

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

649

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

650

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

651

# and range from 0 to 1.

652

"y": 3.14, # Y coordinate.

653

"x": 3.14, # X coordinate.

654

},

655

],

656

"vertices": [ # The bounding polygon vertices.

657

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

658

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

659

"y": 42, # Y coordinate.

660

"x": 42, # X coordinate.

},

],

},

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

665

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

666

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

667

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

668

# detected distant towering building, even though the confidence that

669

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

670

},

671

],

672

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

673

# This will be sorted descending by confidence score.

674

{ # Set of detected objects with bounding boxes.

675

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

676

# information, see

677

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

678

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

679

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

680

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

681

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

682

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

683

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

684

# and range from 0 to 1.

685

"y": 3.14, # Y coordinate.

686

"x": 3.14, # X coordinate.

687

},

688

],

689

"vertices": [ # The bounding polygon vertices.

690

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

691

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

692

"y": 42, # Y coordinate.

693

"x": 42, # X coordinate.

},

],

},

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

698

},

699

],

700

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

701

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

702

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

703

# not reflected in the current results.

704

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

705

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

706

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

707

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

708

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

709

# image.

710

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

711

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

712

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

713

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

714

# information, see

715

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

716

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

717

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

718

},

719

],

720

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

721

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

722

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

723

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

724

# and range from 0 to 1.

725

"y": 3.14, # Y coordinate.

726

"x": 3.14, # X coordinate.

727

},

728

],

729

"vertices": [ # The bounding polygon vertices.

730

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

731

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

732

"y": 42, # Y coordinate.

733

"x": 42, # X coordinate.

},

],

},

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

738

{ # Information about a product.

739

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

740

# to the query.

741

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

742

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

743

#

744

# Format is:

745

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

746

#

747

# This field is ignored when creating a product.

748

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

749

# 4096 characters long.

750

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

751

# characters long.

752

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

753

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

754

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

755

# not be used for new products.

756

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

757

# constraints can be specified based on the product_labels.

758

#

759

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

760

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

761

# to be supported soon.

762

#

763

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

764

# 500 product_labels.

765

#

766

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

767

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

768

# will refuse to work for that ProductSet.

769

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

770

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

771

# cannot exceed 128 bytes.

772

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

# exceed 128 bytes.

},

],

},

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

778

# 1 (full confidence).

},

],

},

],

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

784

{ # Information about a product.

785

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

786

# to the query.

787

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

788

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

789

#

790

# Format is:

791

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

792

#

793

# This field is ignored when creating a product.

794

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

795

# 4096 characters long.

796

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

797

# characters long.

798

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

799

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

800

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

801

# not be used for new products.

802

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

803

# constraints can be specified based on the product_labels.

804

#

805

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

806

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

807

# to be supported soon.

808

#

809

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

810

# 500 product_labels.

811

#

812

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

813

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

814

# will refuse to work for that ProductSet.

815

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

816

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

817

# cannot exceed 128 bytes.

818

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

# exceed 128 bytes.

},

],

},

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

824

# 1 (full confidence).

},

],

},

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

829

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

830

# correct, even when `error` is set.

831

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

832

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

833

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

834

#

835

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

836

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

837

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

838

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

839

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

840

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

841

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

842

# message types for APIs to use.

843

{

844

"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

849

# completed successfully.

850

# This annotation provides the structural hierarchy for the OCR detected

851

# text.

852

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

853

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

854

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

855

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

856

# to the TextAnnotation.TextProperty message definition below for more

857

# detail.

858

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

859

{ # Detected page from OCR.

860

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

861

# TIFFs) the unit is pixels.

862

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

863

{ # Logical element on the page.

864

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

865

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

866

{ # Detected language for a structural component.

867

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

868

# information, see

869

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

870

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

871

},

872

],

873

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

874

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

875

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

876

},

877

},

878

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

879

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

880

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

881

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

882

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

883

# read in the 'natural' orientation.

884

# For example:

885

#

886

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

899

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

900

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

901

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

902

# and range from 0 to 1.

903

"y": 3.14, # Y coordinate.

904

"x": 3.14, # X coordinate.

905

},

906

],

907

"vertices": [ # The bounding polygon vertices.

908

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

909

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

910

"y": 42, # Y coordinate.

911

"x": 42, # X coordinate.

},

],

},

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

916

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

917

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

918

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

919

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

920

{ # Detected language for a structural component.

921

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

922

# information, see

923

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

924

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

925

},

926

],

927

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

928

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

929

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

930

},

931

},

932

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

933

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

934

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

935

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

936

# read in the 'natural' orientation.

937

# For example:

938

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

947

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

948

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

949

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

950

# and range from 0 to 1.

951

"y": 3.14, # Y coordinate.

952

"x": 3.14, # X coordinate.

953

},

954

],

955

"vertices": [ # The bounding polygon vertices.

956

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

957

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

958

"y": 42, # Y coordinate.

959

"x": 42, # X coordinate.

},

],

},

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

964

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

965

{ # A word representation.

966

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

967

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

968

{ # Detected language for a structural component.

969

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

970

# information, see

971

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

972

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

973

},

974

],

975

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

976

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

977

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

978

},

979

},

980

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

981

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

982

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

983

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

984

# read in the 'natural' orientation.

985

# For example:

986

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

995

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

996

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

997

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

998

# and range from 0 to 1.

999

"y": 3.14, # Y coordinate.

1000

"x": 3.14, # X coordinate.

1001

},

1002

],

1003

"vertices": [ # The bounding polygon vertices.

1004

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

1005

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

1006

"y": 42, # Y coordinate.

1007

"x": 42, # X coordinate.

},

],

},

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

1012

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

1013

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

1014

{ # A single symbol representation.

1015

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

1016

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

1017

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

1018

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

1019

# read in the 'natural' orientation.

1020

# For example:

1021

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

1030

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

1031

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

1032

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

1033

# and range from 0 to 1.

1034

"y": 3.14, # Y coordinate.

1035

"x": 3.14, # X coordinate.

1036

},

1037

],

1038

"vertices": [ # The bounding polygon vertices.

1039

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

1040

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

1041

"y": 42, # Y coordinate.

1042

"x": 42, # X coordinate.

},

],

},

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

1047

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

1048

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

1049

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

1050

{ # Detected language for a structural component.

1051

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

1052

# information, see

1053

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

1054

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

1055

},

1056

],

1057

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

1058

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

1059

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

},

},

},

],

},

],

},

],

},

],

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

1071

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

1072

{ # Detected language for a structural component.

1073

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

1074

# information, see

1075

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

1076

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

1077

},

1078

],

1079

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

1080

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

1081

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

1082

},

1083

},

1084

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

1085

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

1086

# TIFFs) the unit is pixels.

1087

},

1088

],

1089

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

1090

},

1091

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

1092

{ # Set of detected entity features.

1093

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

1094

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

1095

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

1096

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

1097

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

1098

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

1099

},

1100

],

1101

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

1102

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

1103

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

1104

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

1105

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

1106

# Location information is usually present for landmarks.

1107

{ # Detected entity location information.

1108

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

1109

# of doubles representing degrees latitude and degrees longitude. Unless

1110

# specified otherwise, this must conform to the

1111

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

1112

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

1113

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

1114

"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

1119

# [Google Knowledge Graph Search

1120

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

1121

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

1122

# The accuracy of the entity detection in an image.

1123

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

1124

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

1125

# image. Range [0, 1].

1126

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

1127

# `description` is expressed.

1128

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

1129

# for `LABEL_DETECTION` features.

1130

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

1131

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

1132

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

1133

# and range from 0 to 1.

1134

"y": 3.14, # Y coordinate.

1135

"x": 3.14, # X coordinate.

1136

},

1137

],

1138

"vertices": [ # The bounding polygon vertices.

1139

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

1140

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

1141

"y": 42, # Y coordinate.

1142

"x": 42, # X coordinate.

},

],

},

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

1147

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

1148

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

1149

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

1150

# detected distant towering building, even though the confidence that

1151

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

1152

},

1153

],

1154

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

1155

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

1156

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

1157

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

1158

# the image that the color occupies in the image.

1159

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

1160

# Value in range [0, 1].

1161

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

1162

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

1163

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

1164

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

1165

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

1166

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

1167

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

1168

#

1169

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

1170

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

1171

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

# space.

#

# Example (Java):

#

# import com.google.type.Color;

1177

#

1178

# // ...

1179

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

1180

# float alpha = protocolor.hasAlpha()

1181

# ? protocolor.getAlpha().getValue()

1182

# : 1.0;

1183

#

1184

# return new java.awt.Color(

1185

# protocolor.getRed(),

1186

# protocolor.getGreen(),

1187

# protocolor.getBlue(),

# alpha);

# }

#

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

1192

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

1193

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

1194

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

1195

# float denominator = 255.0;

1196

# Color.Builder resultBuilder =

1197

# Color

1198

# .newBuilder()

1199

# .setRed(red / denominator)

1200

# .setGreen(green / denominator)

1201

# .setBlue(blue / denominator);

1202

# int alpha = color.getAlpha();

1203

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

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

1208

# .build());

1209

# }

1210

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

1215

#

1216

# // ...

1217

# static UIColor* fromProto(Color* protocolor) {

1218

# float red = [protocolor red];

1219

# float green = [protocolor green];

1220

# float blue = [protocolor blue];

1221

# FloatValue* alpha_wrapper = [protocolor alpha];

1222

# float alpha = 1.0;

1223

# if (alpha_wrapper != nil) {

1224

# alpha = [alpha_wrapper value];

1225

# }

1226

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

1227

# }

1228

#

1229

# static Color* toProto(UIColor* color) {

1230

# CGFloat red, green, blue, alpha;

1231

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

1232

# return nil;

1233

# }

1234

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

1235

# [result setRed:red];

1236

# [result setGreen:green];

1237

# [result setBlue:blue];

1238

# if (alpha <= 0.9999) {

1239

# [result setAlpha:floatWrapperWithValue(alpha)];

1240

# }

1241

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

1251

# var redFrac = rgb_color.red || 0.0;

1252

# var greenFrac = rgb_color.green || 0.0;

1253

# var blueFrac = rgb_color.blue || 0.0;

1254

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

1255

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

1256

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

1257

#

1258

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

1259

# return rgbToCssColor_(red, green, blue);

1260

# }

1261

#

1262

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

1263

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

1264

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

1265

# };

1266

#

1267

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

1268

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

1269

# var hexString = rgbNumber.toString(16);

1270

# var missingZeros = 6 - hexString.length;

1271

# var resultBuilder = ['#'];

1272

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

1273

# resultBuilder.push('0');

1274

# }

1275

# resultBuilder.push(hexString);

1276

# return resultBuilder.join('');

# };

#

# // ...

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

1281

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

1282

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

1283

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

1284

# the final pixel color is defined by the equation:

1285

#

1286

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

1287

#

1288

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

1289

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

1290

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

1291

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

1292

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

1293

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

1294

},

1295

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

},

],

},

},

},

],

"inputConfig": { # The desired input location and metadata. # Information about the file for which this response is generated.

1303

"gcsSource": { # The Google Cloud Storage location where the input will be read from. # The Google Cloud Storage location to read the input from.

1304

"uri": "A String", # Google Cloud Storage URI for the input file. This must only be a

1305

# Google Cloud Storage object. Wildcards are not currently supported.

1306

},

1307

"mimeType": "A String", # The type of the file. Currently only "application/pdf", "image/tiff" and

1308

# "image/gif" are supported. Wildcards are not supported.

1309

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

1310

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

1311

# representation, whereas JSON representations use base64.

1312

#

1313

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

1314

# not work for AsyncBatchAnnotateFiles requests.

},

},

],

}</pre>

</div>

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

1323

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

1324

files, such as PDF files, which may contain multiple pages and multiple

1325

images per page. Progress and results can be retrieved through the

1326

`google.longrunning.Operations` interface.

1327

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

1328

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

1329

1330

Args:

1331

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

1332

1333

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

1334

1335

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

1336

1337

Supported location-ids:

1338

`us`: USA country only,

1339

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

1340

`eu`: The European Union.

1341

1342

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

1343

body: object, The request body.

1344

The object takes the form of:

1345

1346

{ # Multiple async file annotation requests are batched into a single service

1347

# call.

1348

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

1349

{ # An offline file annotation request.

1350

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

1351

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

1352

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

1353

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

1354

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

1355

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

1356

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

1357

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

1358

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

1359

"A String",

1360

],

1361

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

1362

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

1363

},

1364

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

1365

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

1366

# of doubles representing degrees latitude and degrees longitude. Unless

1367

# specified otherwise, this must conform to the

1368

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

1369

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

1370

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

1371

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

1372

},

1373

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

1374

# of doubles representing degrees latitude and degrees longitude. Unless

1375

# specified otherwise, this must conform to the

1376

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

1377

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

1378

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

1379

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

1380

},

1381

},

1382

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

1383

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

1384

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

1385

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

1386

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

1387

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

1393

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

1394

#

1395

# Format is:

1396

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

1397

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

1398

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

1399

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

1400

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

1401

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

1402

# and range from 0 to 1.

1403

"y": 3.14, # Y coordinate.

1404

"x": 3.14, # X coordinate.

1405

},

1406

],

1407

"vertices": [ # The bounding polygon vertices.

1408

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

1409

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

1410

"y": 42, # Y coordinate.

1411

"x": 42, # X coordinate.

},

],

},

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

1416

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

1417

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

1418

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

1419

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

1420

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

1421

# migrate existing products to these categories as well.

1422

"A String",

1423

],

1424

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

1425

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

1426

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

1427

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

1428

#

1429

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

1430

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

1431

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

1432

},

1433

},

1434

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

1435

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

1436

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

1437

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

1438

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

1439

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

1440

# 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

1446

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

1447

# output files will begin with "filenameprefix".

1448

#

1449

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

1450

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

1451

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

1452

# specified.

1453

#

1454

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

1455

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

1456

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

1457

# and overflows into multiple sharded files.

1458

},

1459

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

1460

# Google Cloud Storage.

1461

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

1462

#

1463

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

1464

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

1465

# containing 20 response protos will be written under the prefix

1466

# `gcs_destination`.`uri`.

1467

#

1468

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

1469

# support for other output configurations.

1470

},

1471

"inputConfig": { # The desired input location and metadata. # Required. Information about the input file.

1472

"gcsSource": { # The Google Cloud Storage location where the input will be read from. # The Google Cloud Storage location to read the input from.

1473

"uri": "A String", # Google Cloud Storage URI for the input file. This must only be a

1474

# Google Cloud Storage object. Wildcards are not currently supported.

1475

},

1476

"mimeType": "A String", # The type of the file. Currently only "application/pdf", "image/tiff" and

1477

# "image/gif" are supported. Wildcards are not supported.

1478

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

1479

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

1480

# representation, whereas JSON representations use base64.

1481

#

1482

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

1483

# not work for AsyncBatchAnnotateFiles requests.

1484

},

1485

"features": [ # Required. Requested features.

1486

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

1487

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

1488

# be specified in the `features` list.

1489

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

1490

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

1491

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

1492

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

1493

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

# "builtin/latest".

},

],

},

],

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

1500

#

1501

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

1502

#

1503

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

1504

#

1505

# Supported location-ids:

1506

# `us`: USA country only,

1507

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

1508

# `eu`: The European Union.

1509

#

1510

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

1511

}

1512

1513

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1520

1521

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

1522

# network API call.

1523

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

1524

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

1525

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

1526

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

1527

#

1528

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

1529

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

1530

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

1531

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

1532

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

1533

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

1534

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

1535

# message types for APIs to use.

1536

{

1537

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

},

],

},

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

1542

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

1543

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

1544

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

1545

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

1546

},

1547

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

1548

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

1549

# available.

1550

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

1551

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

1552

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

1553

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

1554

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

1555

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

1556

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

1557

# `TakeSnapshotResponse`.

1558

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

1559

},

1560

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

1561

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

1562

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

}</pre>

</div>

</body></html>