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

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

[diff] [blame]

113

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

114

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

Bu Sun Kim

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

[diff] [blame]

115

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

Bu Sun Kim

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

[diff] [blame]

116

#

117

# 1. A Google Cloud Storage URI of the form

118

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

119

# [Google Cloud Storage Request

120

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

121

# info.

122

#

123

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

124

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

125

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

126

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

127

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

128

# depend on externally-hosted images for production applications.

129

#

130

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

131

# precedence.

Bu Sun Kim

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

[diff] [blame]

132

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

133

#

134

# The Google Cloud Storage URI of the form

135

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

136

# [Google Cloud Storage Request

137

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

Bu Sun Kim

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

[diff] [blame]

138

},

139

},

Bu Sun Kim

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

[diff] [blame]

140

"features": [ # Requested features.

Bu Sun Kim

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

[diff] [blame]

141

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

142

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

143

# be specified in the `features` list.

Bu Sun Kim

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

[diff] [blame]

144

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

145

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

Bu Sun Kim

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

[diff] [blame]

146

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

Bu Sun Kim

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

[diff] [blame]

147

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

148

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

149

# "builtin/latest".

Bu Sun Kim

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

[diff] [blame]

150

},

151

],

Bu Sun Kim

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

[diff] [blame]

152

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

153

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

154

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

155

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

156

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

157

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

158

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

159

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

160

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

161

"A String",

162

],

163

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

164

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

165

},

166

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

167

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

168

# of doubles representing degrees latitude and degrees longitude. Unless

169

# specified otherwise, this must conform to the

170

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

171

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

172

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

173

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

174

},

175

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

176

# of doubles representing degrees latitude and degrees longitude. Unless

177

# specified otherwise, this must conform to the

178

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

179

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

180

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

181

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

182

},

183

},

184

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

185

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

186

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

187

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

188

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

189

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

# ignored.

3.14,

],

},

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

195

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

196

#

197

# Format is:

198

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

199

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

200

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

201

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

202

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

203

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

204

# and range from 0 to 1.

205

"y": 3.14, # Y coordinate.

206

"x": 3.14, # X coordinate.

207

},

208

],

209

"vertices": [ # The bounding polygon vertices.

210

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

211

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

212

"y": 42, # Y coordinate.

213

"x": 42, # X coordinate.

},

],

},

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

218

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

219

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

220

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

221

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

222

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

223

# migrate existing products to these categories as well.

224

"A String",

225

],

226

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

227

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

228

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

229

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

230

#

231

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

232

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

233

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

234

},

235

},

Bu Sun Kim

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

[diff] [blame]

},

],

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

247

248

{ # Response to a batch image annotation request.

Bu Sun Kim

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

[diff] [blame]

249

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

Bu Sun Kim

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

[diff] [blame]

250

{ # Response to an image annotation request.

Bu Sun Kim

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

[diff] [blame]

251

"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

252

# comes from.

253

# information about the source of that image.

254

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

255

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

256

# the file used to produce the image.

Bu Sun Kim

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

[diff] [blame]

257

},

Bu Sun Kim

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

[diff] [blame]

258

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

Bu Sun Kim

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

[diff] [blame]

259

{ # Set of detected entity features.

Bu Sun Kim

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

[diff] [blame]

260

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

261

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

262

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

263

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

264

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

265

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

266

},

267

],

268

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

269

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

Bu Sun Kim

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

[diff] [blame]

270

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

271

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

272

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

273

# Location information is usually present for landmarks.

274

{ # Detected entity location information.

Bu Sun Kim

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

[diff] [blame]

275

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

Bu Sun Kim

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

[diff] [blame]

276

# of doubles representing degrees latitude and degrees longitude. Unless

277

# specified otherwise, this must conform to the

Bu Sun Kim

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

[diff] [blame]

278

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

Dan O'Meara

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

[diff] [blame]

279

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

Bu Sun Kim

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

[diff] [blame]

280

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

281

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

Bu Sun Kim

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

[diff] [blame]

282

},

283

},

284

],

Bu Sun Kim

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

[diff] [blame]

285

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

286

# [Google Knowledge Graph Search

287

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

288

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

289

# The accuracy of the entity detection in an image.

290

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

291

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

292

# image. Range [0, 1].

293

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

294

# `description` is expressed.

295

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

Bu Sun Kim

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

[diff] [blame]

296

# for `LABEL_DETECTION` features.

Bu Sun Kim

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

[diff] [blame]

297

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

Bu Sun Kim

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

[diff] [blame]

298

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

299

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

300

# and range from 0 to 1.

Bu Sun Kim

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

[diff] [blame]

301

"y": 3.14, # Y coordinate.

302

"x": 3.14, # X coordinate.

Bu Sun Kim

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

[diff] [blame]

303

},

304

],

Bu Sun Kim

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

[diff] [blame]

305

"vertices": [ # The bounding polygon vertices.

Bu Sun Kim

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

[diff] [blame]

306

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

307

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

Bu Sun Kim

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

[diff] [blame]

308

"y": 42, # Y coordinate.

309

"x": 42, # X coordinate.

Bu Sun Kim

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

[diff] [blame]

310

},

311

],

312

},

Bu Sun Kim

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

[diff] [blame]

313

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

314

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

315

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

316

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

317

# detected distant towering building, even though the confidence that

318

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

Bu Sun Kim

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

[diff] [blame]

319

},

320

],

Bu Sun Kim

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

[diff] [blame]

321

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

322

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

323

{ # Entity deduced from similar images on the Internet.

324

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

325

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

326

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

327

# Not normalized and not comparable across different image queries.

Bu Sun Kim

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

[diff] [blame]

328

},

329

],

Bu Sun Kim

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

[diff] [blame]

330

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

Bu Sun Kim

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

[diff] [blame]

331

{ # Metadata for web pages.

Bu Sun Kim

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

[diff] [blame]

332

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

333

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

Bu Sun Kim

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

[diff] [blame]

334

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

335

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

336

# crops.

337

{ # Metadata for online images.

Bu Sun Kim

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

[diff] [blame]

338

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

339

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

Bu Sun Kim

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

[diff] [blame]

340

},

341

],

Bu Sun Kim

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

[diff] [blame]

342

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

343

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

344

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

Bu Sun Kim

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

[diff] [blame]

345

# Can include resized copies of the query image.

346

{ # Metadata for online images.

Bu Sun Kim

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

[diff] [blame]

347

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

348

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

Bu Sun Kim

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

[diff] [blame]

},

],

},

],

Bu Sun Kim

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

[diff] [blame]

353

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

Bu Sun Kim

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

[diff] [blame]

354

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

355

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

356

{ # Metadata for online images.

Bu Sun Kim

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

[diff] [blame]

357

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

358

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

Bu Sun Kim

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

[diff] [blame]

359

},

360

],

Bu Sun Kim

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

[diff] [blame]

361

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

362

{ # Metadata for online images.

363

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

364

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

Bu Sun Kim

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

[diff] [blame]

365

},

366

],

Bu Sun Kim

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

[diff] [blame]

367

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

Bu Sun Kim

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

[diff] [blame]

368

# Inferred from similar images on the open web.

369

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

Bu Sun Kim

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

[diff] [blame]

370

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

371

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

Bu Sun Kim

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

[diff] [blame]

372

# For more information, see

373

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

Bu Sun Kim

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

[diff] [blame]

374

},

375

],

376

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

377

# Can include resized copies of the query image.

378

{ # Metadata for online images.

379

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

380

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

Bu Sun Kim

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

[diff] [blame]

381

},

382

],

383

},

Bu Sun Kim

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

[diff] [blame]

384

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

385

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

386

# violence).

387

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

388

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

389

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

390

# body areas.

391

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

392

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

393

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

394

# sexual activities.

395

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

396

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

397

# funny or offensive.

398

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

399

},

400

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

401

{ # Set of detected entity features.

402

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

403

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

404

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

405

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

406

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

407

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

408

},

409

],

410

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

411

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

412

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

413

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

414

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

415

# Location information is usually present for landmarks.

416

{ # Detected entity location information.

417

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

418

# of doubles representing degrees latitude and degrees longitude. Unless

419

# specified otherwise, this must conform to the

420

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

421

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

422

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

423

"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

428

# [Google Knowledge Graph Search

429

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

430

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

431

# The accuracy of the entity detection in an image.

432

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

433

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

434

# image. Range [0, 1].

435

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

436

# `description` is expressed.

437

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

438

# for `LABEL_DETECTION` features.

439

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

Bu Sun Kim

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

[diff] [blame]

440

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

441

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

442

# and range from 0 to 1.

Bu Sun Kim

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

[diff] [blame]

443

"y": 3.14, # Y coordinate.

444

"x": 3.14, # X coordinate.

Bu Sun Kim

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

[diff] [blame]

445

},

446

],

Bu Sun Kim

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

[diff] [blame]

447

"vertices": [ # The bounding polygon vertices.

Bu Sun Kim

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

[diff] [blame]

448

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

449

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

Bu Sun Kim

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

[diff] [blame]

450

"y": 42, # Y coordinate.

451

"x": 42, # X coordinate.

Bu Sun Kim

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

[diff] [blame]

452

},

453

],

454

},

Bu Sun Kim

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

[diff] [blame]

455

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

456

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

457

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

458

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

459

# detected distant towering building, even though the confidence that

460

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

Bu Sun Kim

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

[diff] [blame]

461

},

462

],

Bu Sun Kim

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

[diff] [blame]

463

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

464

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

465

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

466

# are in the original image's scale.

467

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

468

# expectations. It is based on the landmarker results.

469

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

470

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

471

# appears in the image to be annotated.

472

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

473

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

474

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

475

# and range from 0 to 1.

476

"y": 3.14, # Y coordinate.

477

"x": 3.14, # X coordinate.

478

},

479

],

480

"vertices": [ # The bounding polygon vertices.

481

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

482

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

483

"y": 42, # Y coordinate.

484

"x": 42, # X coordinate.

},

],

},

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

489

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

490

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

491

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

492

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

493

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

494

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

495

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

496

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

497

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

498

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

499

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

500

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

501

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

502

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

503

# and range from 0 to 1.

504

"y": 3.14, # Y coordinate.

505

"x": 3.14, # X coordinate.

506

},

507

],

508

"vertices": [ # The bounding polygon vertices.

509

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

510

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

511

"y": 42, # Y coordinate.

512

"x": 42, # X coordinate.

},

],

},

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

517

"landmarks": [ # Detected face landmarks.

518

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

519

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

520

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

521

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

522

"y": 3.14, # Y coordinate.

523

"x": 3.14, # X coordinate.

524

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

525

},

526

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

527

},

528

],

529

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

530

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

531

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

532

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

533

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

534

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

535

# [-180,180].

536

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

537

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

538

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

539

},

540

],

541

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

542

"cropHints": [ # Crop hint results.

543

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

544

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

545

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

546

# image.

547

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

548

# box are in the original image's scale.

549

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

550

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

551

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

552

# and range from 0 to 1.

553

"y": 3.14, # Y coordinate.

554

"x": 3.14, # X coordinate.

555

},

556

],

557

"vertices": [ # The bounding polygon vertices.

558

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

559

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

560

"y": 42, # Y coordinate.

561

"x": 42, # X coordinate.

},

],

},

},

],

},

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

569

{ # Set of detected entity features.

570

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

571

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

572

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

573

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

574

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

575

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

576

},

577

],

578

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

579

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

580

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

581

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

582

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

583

# Location information is usually present for landmarks.

584

{ # Detected entity location information.

585

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

586

# of doubles representing degrees latitude and degrees longitude. Unless

587

# specified otherwise, this must conform to the

588

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

589

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

590

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

591

"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

596

# [Google Knowledge Graph Search

597

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

598

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

599

# The accuracy of the entity detection in an image.

600

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

601

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

602

# image. Range [0, 1].

603

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

604

# `description` is expressed.

605

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

606

# for `LABEL_DETECTION` features.

607

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

608

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

609

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

610

# and range from 0 to 1.

611

"y": 3.14, # Y coordinate.

612

"x": 3.14, # X coordinate.

613

},

614

],

615

"vertices": [ # The bounding polygon vertices.

616

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

617

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

618

"y": 42, # Y coordinate.

619

"x": 42, # X coordinate.

},

],

},

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

624

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

625

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

626

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

627

# detected distant towering building, even though the confidence that

628

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

629

},

630

],

631

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

632

# This will be sorted descending by confidence score.

633

{ # Set of detected objects with bounding boxes.

634

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

635

# information, see

636

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

637

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

638

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

639

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

640

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

641

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

642

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

643

# and range from 0 to 1.

644

"y": 3.14, # Y coordinate.

645

"x": 3.14, # X coordinate.

646

},

647

],

648

"vertices": [ # The bounding polygon vertices.

649

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

650

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

651

"y": 42, # Y coordinate.

652

"x": 42, # X coordinate.

},

],

},

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

657

},

658

],

659

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

660

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

661

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

662

# not reflected in the current results.

663

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

664

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

665

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

666

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

667

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

668

# image.

669

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

670

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

671

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

672

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

673

# information, see

674

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

675

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

676

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

677

},

678

],

679

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

680

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

681

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

682

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

683

# and range from 0 to 1.

684

"y": 3.14, # Y coordinate.

685

"x": 3.14, # X coordinate.

686

},

687

],

688

"vertices": [ # The bounding polygon vertices.

689

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

690

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

691

"y": 42, # Y coordinate.

692

"x": 42, # X coordinate.

},

],

},

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

697

{ # Information about a product.

698

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

699

# to the query.

700

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

701

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

702

#

703

# Format is:

704

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

705

#

706

# This field is ignored when creating a product.

707

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

708

# 4096 characters long.

709

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

710

# characters long.

711

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

712

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

713

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

714

# not be used for new products.

715

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

716

# constraints can be specified based on the product_labels.

717

#

718

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

719

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

720

# to be supported soon.

721

#

722

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

723

# 500 product_labels.

724

#

725

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

726

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

727

# will refuse to work for that ProductSet.

728

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

729

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

730

# cannot exceed 128 bytes.

731

"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

737

# 1 (full confidence).

},

],

},

],

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

743

{ # Information about a product.

744

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

745

# to the query.

746

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

747

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

748

#

749

# Format is:

750

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

751

#

752

# This field is ignored when creating a product.

753

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

754

# 4096 characters long.

755

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

756

# characters long.

757

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

758

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

759

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

760

# not be used for new products.

761

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

762

# constraints can be specified based on the product_labels.

763

#

764

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

765

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

766

# to be supported soon.

767

#

768

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

769

# 500 product_labels.

770

#

771

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

772

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

773

# will refuse to work for that ProductSet.

774

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

775

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

776

# cannot exceed 128 bytes.

777

"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

783

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

788

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

789

# correct, even when `error` is set.

790

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

791

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

792

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

793

#

794

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

795

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

796

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

797

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

798

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

799

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

800

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

801

# message types for APIs to use.

802

{

803

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

},

],

},

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

Bu Sun Kim

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

[diff] [blame]

808

# completed successfully.

809

# This annotation provides the structural hierarchy for the OCR detected

810

# text.

811

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

Dan O'Meara

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

[diff] [blame]

812

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

Bu Sun Kim

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

[diff] [blame]

813

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

814

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

815

# to the TextAnnotation.TextProperty message definition below for more

816

# detail.

Bu Sun Kim

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

[diff] [blame]

817

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

Bu Sun Kim

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

[diff] [blame]

818

{ # Detected page from OCR.

Bu Sun Kim

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

[diff] [blame]

819

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

Bu Sun Kim

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

[diff] [blame]

820

# TIFFs) the unit is pixels.

Bu Sun Kim

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

[diff] [blame]

821

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

Bu Sun Kim

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

[diff] [blame]

822

{ # Logical element on the page.

Bu Sun Kim

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

[diff] [blame]

823

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

824

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

825

{ # Detected language for a structural component.

826

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

827

# information, see

828

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

829

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

830

},

831

],

832

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

833

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

834

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

835

},

836

},

837

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

838

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

Bu Sun Kim

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

[diff] [blame]

839

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

840

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

841

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

Bu Sun Kim

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

[diff] [blame]

842

# read in the 'natural' orientation.

Bu Sun Kim

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

[diff] [blame]

843

# For example:

844

#

845

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

#

# 0----1

# | |

# 3----2

#

Bu Sun Kim

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

[diff] [blame]

851

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

Bu Sun Kim

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

[diff] [blame]

#

# 2----3

# | |

# 1----0

#

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

Bu Sun Kim

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

[diff] [blame]

858

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

Bu Sun Kim

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

[diff] [blame]

859

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

860

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

861

# and range from 0 to 1.

Bu Sun Kim

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

[diff] [blame]

862

"y": 3.14, # Y coordinate.

863

"x": 3.14, # X coordinate.

Bu Sun Kim

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

[diff] [blame]

864

},

865

],

Bu Sun Kim

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

[diff] [blame]

866

"vertices": [ # The bounding polygon vertices.

Bu Sun Kim

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

[diff] [blame]

867

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

868

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

Bu Sun Kim

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

[diff] [blame]

869

"y": 42, # Y coordinate.

870

"x": 42, # X coordinate.

Bu Sun Kim

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

[diff] [blame]

871

},

872

],

873

},

Bu Sun Kim

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

[diff] [blame]

874

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

875

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

Bu Sun Kim

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

[diff] [blame]

876

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

Bu Sun Kim

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

[diff] [blame]

877

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

878

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

879

{ # Detected language for a structural component.

880

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

881

# information, see

882

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

883

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

884

},

885

],

886

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

887

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

888

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

889

},

890

},

891

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

Bu Sun Kim

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

[diff] [blame]

892

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

893

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

894

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

Bu Sun Kim

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

[diff] [blame]

895

# read in the 'natural' orientation.

Bu Sun Kim

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

[diff] [blame]

896

# For example:

897

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

898

# 0----1

899

# | |

900

# 3----2

Bu Sun Kim

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

[diff] [blame]

901

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

Bu Sun Kim

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

[diff] [blame]

# 2----3

# | |

# 1----0

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

Bu Sun Kim

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

[diff] [blame]

906

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

Bu Sun Kim

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

[diff] [blame]

907

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

908

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

909

# and range from 0 to 1.

Bu Sun Kim

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

[diff] [blame]

910

"y": 3.14, # Y coordinate.

911

"x": 3.14, # X coordinate.

Bu Sun Kim

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

[diff] [blame]

912

},

913

],

Bu Sun Kim

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

[diff] [blame]

914

"vertices": [ # The bounding polygon vertices.

Bu Sun Kim

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

[diff] [blame]

915

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

916

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

Bu Sun Kim

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

[diff] [blame]

917

"y": 42, # Y coordinate.

918

"x": 42, # X coordinate.

Bu Sun Kim

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

[diff] [blame]

919

},

920

],

921

},

Bu Sun Kim

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

[diff] [blame]

922

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

923

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

Bu Sun Kim

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

[diff] [blame]

924

{ # A word representation.

Bu Sun Kim

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

[diff] [blame]

925

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

926

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

927

{ # Detected language for a structural component.

928

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

929

# information, see

930

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

931

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

932

},

933

],

934

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

935

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

936

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

937

},

938

},

939

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

Dan O'Meara

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

[diff] [blame]

940

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

941

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

942

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

Bu Sun Kim

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

[diff] [blame]

943

# read in the 'natural' orientation.

Dan O'Meara

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

[diff] [blame]

944

# For example:

945

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

946

# 0----1

947

# | |

948

# 3----2

Bu Sun Kim

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

[diff] [blame]

949

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

Dan O'Meara

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

[diff] [blame]

# 2----3

# | |

# 1----0

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

Bu Sun Kim

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

[diff] [blame]

954

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

Dan O'Meara

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

[diff] [blame]

955

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

956

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

957

# and range from 0 to 1.

Bu Sun Kim

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

[diff] [blame]

958

"y": 3.14, # Y coordinate.

959

"x": 3.14, # X coordinate.

Dan O'Meara

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

[diff] [blame]

960

},

961

],

Bu Sun Kim

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

[diff] [blame]

962

"vertices": [ # The bounding polygon vertices.

Dan O'Meara

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

[diff] [blame]

963

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

964

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

Bu Sun Kim

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

[diff] [blame]

965

"y": 42, # Y coordinate.

966

"x": 42, # X coordinate.

Dan O'Meara

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

[diff] [blame]

967

},

968

],

969

},

Bu Sun Kim

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

[diff] [blame]

970

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

971

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

Bu Sun Kim

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

[diff] [blame]

972

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

973

{ # A single symbol representation.

Bu Sun Kim

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

[diff] [blame]

974

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

Bu Sun Kim

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

[diff] [blame]

975

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

976

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

977

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

Bu Sun Kim

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

[diff] [blame]

978

# read in the 'natural' orientation.

Bu Sun Kim

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

[diff] [blame]

979

# For example:

980

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

981

# 0----1

982

# | |

983

# 3----2

Bu Sun Kim

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

[diff] [blame]

984

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

Bu Sun Kim

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

[diff] [blame]

985

# 2----3

986

# | |

987

# 1----0

Dan O'Meara

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

[diff] [blame]

988

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

Bu Sun Kim

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

[diff] [blame]

989

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

Bu Sun Kim

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

[diff] [blame]

990

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

991

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

992

# and range from 0 to 1.

Bu Sun Kim

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

[diff] [blame]

993

"y": 3.14, # Y coordinate.

994

"x": 3.14, # X coordinate.

Bu Sun Kim

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

[diff] [blame]

995

},

996

],

Bu Sun Kim

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

[diff] [blame]

997

"vertices": [ # The bounding polygon vertices.

Bu Sun Kim

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

[diff] [blame]

998

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

999

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

Bu Sun Kim

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

[diff] [blame]

1000

"y": 42, # Y coordinate.

1001

"x": 42, # X coordinate.

Bu Sun Kim

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

[diff] [blame]

1002

},

1003

],

1004

},

Bu Sun Kim

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

[diff] [blame]

1005

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

1006

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

1007

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

1008

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

Bu Sun Kim

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

[diff] [blame]

1009

{ # Detected language for a structural component.

Bu Sun Kim

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

[diff] [blame]

1010

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

Bu Sun Kim

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

[diff] [blame]

1011

# information, see

1012

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

Bu Sun Kim

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

[diff] [blame]

1013

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

Bu Sun Kim

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

[diff] [blame]

1014

},

1015

],

Bu Sun Kim

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

[diff] [blame]

1016

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

1017

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

1018

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

1019

},

Bu Sun Kim

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

[diff] [blame]

1020

},

1021

},

1022

],

Bu Sun Kim

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

[diff] [blame]

},

],

},

],

},

],

Bu Sun Kim

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

[diff] [blame]

1029

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

1030

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

1031

{ # Detected language for a structural component.

1032

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

1033

# information, see

1034

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

1035

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

1036

},

1037

],

1038

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

1039

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

1040

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

1041

},

1042

},

1043

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

1044

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

Bu Sun Kim

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

[diff] [blame]

1045

# TIFFs) the unit is pixels.

1046

},

1047

],

Bu Sun Kim

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

[diff] [blame]

1048

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

Bu Sun Kim

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

[diff] [blame]

1049

},

Bu Sun Kim

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

[diff] [blame]

1050

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

Bu Sun Kim

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

[diff] [blame]

1051

{ # Set of detected entity features.

Bu Sun Kim

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

[diff] [blame]

1052

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

1053

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

1054

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

1055

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

1056

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

1057

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

1058

},

1059

],

1060

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

1061

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

Bu Sun Kim

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

[diff] [blame]

1062

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

1063

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

1064

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

1065

# Location information is usually present for landmarks.

1066

{ # Detected entity location information.

Bu Sun Kim

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

[diff] [blame]

1067

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

Bu Sun Kim

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

[diff] [blame]

1068

# of doubles representing degrees latitude and degrees longitude. Unless

1069

# specified otherwise, this must conform to the

Bu Sun Kim

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

[diff] [blame]

1070

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

Dan O'Meara

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

[diff] [blame]

1071

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

Bu Sun Kim

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

[diff] [blame]

1072

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

1073

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

Bu Sun Kim

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

[diff] [blame]

1074

},

1075

},

1076

],

Bu Sun Kim

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

[diff] [blame]

1077

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

1078

# [Google Knowledge Graph Search

1079

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

1080

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

1081

# The accuracy of the entity detection in an image.

1082

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

1083

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

1084

# image. Range [0, 1].

1085

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

1086

# `description` is expressed.

1087

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

Bu Sun Kim

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

[diff] [blame]

1088

# for `LABEL_DETECTION` features.

Bu Sun Kim

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

[diff] [blame]

1089

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

Bu Sun Kim

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

[diff] [blame]

1090

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

1091

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

1092

# and range from 0 to 1.

Bu Sun Kim

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

[diff] [blame]

1093

"y": 3.14, # Y coordinate.

1094

"x": 3.14, # X coordinate.

Bu Sun Kim

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

[diff] [blame]

1095

},

1096

],

Bu Sun Kim

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

[diff] [blame]

1097

"vertices": [ # The bounding polygon vertices.

Bu Sun Kim

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

[diff] [blame]

1098

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

1099

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

Bu Sun Kim

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

[diff] [blame]

1100

"y": 42, # Y coordinate.

1101

"x": 42, # X coordinate.

Bu Sun Kim

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

[diff] [blame]

1102

},

1103

],

1104

},

Bu Sun Kim

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

[diff] [blame]

1105

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

1106

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

1107

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

1108

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

1109

# detected distant towering building, even though the confidence that

1110

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

Bu Sun Kim

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

[diff] [blame]

1111

},

1112

],

Bu Sun Kim

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

[diff] [blame]

1113

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

1114

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

1115

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

Bu Sun Kim

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

[diff] [blame]

1116

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

1117

# the image that the color occupies in the image.

Bu Sun Kim

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

[diff] [blame]

1118

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

1119

# Value in range [0, 1].

1120

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

Bu Sun Kim

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

[diff] [blame]

1121

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

1122

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

Bu Sun Kim

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

[diff] [blame]

1123

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

1124

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

Bu Sun Kim

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

[diff] [blame]

1125

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

Bu Sun Kim

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

[diff] [blame]

1126

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

Bu Sun Kim

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

[diff] [blame]

1127

#

1128

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

1129

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

1130

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

# space.

#

# Example (Java):

#

# import com.google.type.Color;

1136

#

1137

# // ...

1138

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

1139

# float alpha = protocolor.hasAlpha()

1140

# ? protocolor.getAlpha().getValue()

1141

# : 1.0;

1142

#

1143

# return new java.awt.Color(

1144

# protocolor.getRed(),

1145

# protocolor.getGreen(),

1146

# protocolor.getBlue(),

# alpha);

# }

#

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

1151

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

1152

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

1153

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

1154

# float denominator = 255.0;

1155

# Color.Builder resultBuilder =

1156

# Color

1157

# .newBuilder()

1158

# .setRed(red / denominator)

1159

# .setGreen(green / denominator)

1160

# .setBlue(blue / denominator);

1161

# int alpha = color.getAlpha();

1162

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

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

1167

# .build());

1168

# }

1169

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

1174

#

1175

# // ...

1176

# static UIColor* fromProto(Color* protocolor) {

1177

# float red = [protocolor red];

1178

# float green = [protocolor green];

1179

# float blue = [protocolor blue];

1180

# FloatValue* alpha_wrapper = [protocolor alpha];

1181

# float alpha = 1.0;

1182

# if (alpha_wrapper != nil) {

1183

# alpha = [alpha_wrapper value];

1184

# }

1185

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

1186

# }

1187

#

1188

# static Color* toProto(UIColor* color) {

1189

# CGFloat red, green, blue, alpha;

Dan O'Meara

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

[diff] [blame]

1190

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

Bu Sun Kim

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

[diff] [blame]

1191

# return nil;

1192

# }

1193

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

1194

# [result setRed:red];

1195

# [result setGreen:green];

1196

# [result setBlue:blue];

Dan O'Meara

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

[diff] [blame]

1197

# if (alpha <= 0.9999) {

Bu Sun Kim

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

[diff] [blame]

1198

# [result setAlpha:floatWrapperWithValue(alpha)];

1199

# }

1200

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

1210

# var redFrac = rgb_color.red || 0.0;

1211

# var greenFrac = rgb_color.green || 0.0;

1212

# var blueFrac = rgb_color.blue || 0.0;

1213

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

1214

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

1215

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

1216

#

Bu Sun Kim

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

[diff] [blame]

1217

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

Bu Sun Kim

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

[diff] [blame]

1218

# return rgbToCssColor_(red, green, blue);

1219

# }

1220

#

1221

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

Bu Sun Kim

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

[diff] [blame]

1222

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

1223

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

Bu Sun Kim

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

[diff] [blame]

1224

# };

1225

#

1226

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

Dan O'Meara

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

[diff] [blame]

1227

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

Bu Sun Kim

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

[diff] [blame]

1228

# var hexString = rgbNumber.toString(16);

1229

# var missingZeros = 6 - hexString.length;

Bu Sun Kim

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

[diff] [blame]

1230

# var resultBuilder = ['#'];

Dan O'Meara

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

[diff] [blame]

1231

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

Bu Sun Kim

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

[diff] [blame]

1232

# resultBuilder.push('0');

Bu Sun Kim

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

[diff] [blame]

1233

# }

1234

# resultBuilder.push(hexString);

Bu Sun Kim

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

[diff] [blame]

1235

# return resultBuilder.join('');

Bu Sun Kim

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

[diff] [blame]

1236

# };

1237

#

1238

# // ...

Bu Sun Kim

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

[diff] [blame]

1239

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

1240

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

1241

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

1242

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

Bu Sun Kim

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

[diff] [blame]

1243

# the final pixel color is defined by the equation:

1244

#

1245

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

1246

#

1247

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

1248

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

1249

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

1250

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

1251

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

1252

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

Bu Sun Kim

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

[diff] [blame]

1253

},

Bu Sun Kim

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

[diff] [blame]

1254

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

Bu Sun Kim

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

[diff] [blame]

},

],

},

},

Bu Sun Kim

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

[diff] [blame]

},

],

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

1265

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

Bu Sun Kim

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

[diff] [blame]

1266

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

1267

1268

Progress and results can be retrieved through the

1269

`google.longrunning.Operations` interface.

1270

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

1271

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

1272

1273

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

1274

GCS bucket, each json file containing BatchAnnotateImagesResponse proto.

1275

1276

Args:

Dan O'Meara

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

[diff] [blame]

1277

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

1278

The object takes the form of:

1279

1280

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

Bu Sun Kim

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

[diff] [blame]

1281

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

1282

#

1283

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

1284

#

1285

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

1286

#

1287

# Supported location-ids:

1288

# `us`: USA country only,

1289

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

1290

# `eu`: The European Union.

1291

#

1292

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

1293

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

1294

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

1295

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

Bu Sun Kim

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

[diff] [blame]

1296

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

1297

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

1298

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

1299

# output files, you will need to do a wildcard gcs search on the uri prefix

# you provide.

#

# Examples:

#

# * File Prefix: gs://bucket-name/here/filenameprefix The output files

1305

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

Bu Sun Kim

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

[diff] [blame]

1306

# output files will begin with "filenameprefix".

Bu Sun Kim

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

[diff] [blame]

1307

#

1308

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

1309

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

1310

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

1311

# specified.

1312

#

1313

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

1314

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

1315

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

1316

# and overflows into multiple sharded files.

1317

},

Bu Sun Kim

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

[diff] [blame]

1318

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

1319

# Google Cloud Storage.

1320

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

1321

#

1322

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

1323

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

1324

# containing 20 response protos will be written under the prefix

1325

# `gcs_destination`.`uri`.

1326

#

1327

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

1328

# support for other output configurations.

Bu Sun Kim

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

[diff] [blame]

1329

},

Bu Sun Kim

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

[diff] [blame]

1330

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

Bu Sun Kim

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

[diff] [blame]

1331

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

1332

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

Bu Sun Kim

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

[diff] [blame]

1333

"image": { # Client image to perform Google Cloud Vision API tasks over. # The image to be processed.

1334

"content": "A String", # Image content, represented as a stream of bytes.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1335

# Note: As with all `bytes` fields, protobuffers use a pure binary

1336

# representation, whereas JSON representations use base64.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1337

"source": { # External image source (Google Cloud Storage or web URL image location). # Google Cloud Storage image location, or publicly-accessible image

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1338

# URL. If both `content` and `source` are provided for an image, `content`

1339

# takes precedence and is used to perform the image annotation request.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1340

"imageUri": "A String", # The URI of the source image. Can be either:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1341

#

1342

# 1. A Google Cloud Storage URI of the form

1343

# `gs://bucket_name/object_name`. Object versioning is not supported. See

1344

# [Google Cloud Storage Request

1345

# URIs](https://cloud.google.com/storage/docs/reference-uris) for more

1346

# info.

1347

#

1348

# 2. A publicly-accessible image HTTP/HTTPS URL. When fetching images from

1349

# HTTP/HTTPS URLs, Google cannot guarantee that the request will be

1350

# completed. Your request may fail if the specified host denies the

1351

# request (e.g. due to request throttling or DOS prevention), or if Google

1352

# throttles requests to the site for abuse prevention. You should not

1353

# depend on externally-hosted images for production applications.

1354

#

1355

# When both `gcs_image_uri` and `image_uri` are specified, `image_uri` takes

1356

# precedence.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1357

"gcsImageUri": "A String", # **Use `image_uri` instead.**

1358

#

1359

# The Google Cloud Storage URI of the form

1360

# `gs://bucket_name/object_name`. Object versioning is not supported. See

1361

# [Google Cloud Storage Request

1362

# URIs](https://cloud.google.com/storage/docs/reference-uris) for more info.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1363

},

1364

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1365

"features": [ # Requested features.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1366

{ # The type of Google Cloud Vision API detection to perform, and the maximum

1367

# number of results to return for that type. Multiple `Feature` objects can

1368

# be specified in the `features` list.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1369

"type": "A String", # The feature type.

1370

"maxResults": 42, # Maximum number of results of this type. Does not apply to

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1371

# `TEXT_DETECTION`, `DOCUMENT_TEXT_DETECTION`, or `CROP_HINTS`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1372

"model": "A String", # Model to use for the feature.

1373

# Supported values: "builtin/stable" (the default if unset) and

1374

# "builtin/latest".

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1375

},

1376

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1377

"imageContext": { # Image context and/or feature-specific parameters. # Additional context that may accompany the image.

1378

"languageHints": [ # List of languages to use for TEXT_DETECTION. In most cases, an empty value

1379

# yields the best results since it enables automatic language detection. For

1380

# languages based on the Latin alphabet, setting `language_hints` is not

1381

# needed. In rare cases, when the language of the text in the image is known,

1382

# setting a hint will help get better results (although it will be a

1383

# significant hindrance if the hint is wrong). Text detection returns an

1384

# error if one or more of the specified languages is not one of the

1385

# [supported languages](https://cloud.google.com/vision/docs/languages).

1386

"A String",

1387

],

1388

"webDetectionParams": { # Parameters for web detection request. # Parameters for web detection.

1389

"includeGeoResults": True or False, # Whether to include results derived from the geo information in the image.

1390

},

1391

"latLongRect": { # Rectangle determined by min and max `LatLng` pairs. # Not used.

1392

"minLatLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # Min lat/long pair.

1393

# of doubles representing degrees latitude and degrees longitude. Unless

1394

# specified otherwise, this must conform to the

1395

# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84

1396

# standard</a>. Values must be within normalized ranges.

1397

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

1398

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].

1399

},

1400

"maxLatLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # Max lat/long pair.

1401

# of doubles representing degrees latitude and degrees longitude. Unless

1402

# specified otherwise, this must conform to the

1403

# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84

1404

# standard</a>. Values must be within normalized ranges.

1405

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

1406

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].

1407

},

1408

},

1409

"cropHintsParams": { # Parameters for crop hints annotation request. # Parameters for crop hints annotation request.

1410

"aspectRatios": [ # Aspect ratios in floats, representing the ratio of the width to the height

1411

# of the image. For example, if the desired aspect ratio is 4/3, the

1412

# corresponding float value should be 1.33333. If not specified, the

1413

# best possible crop is returned. The number of provided aspect ratios is

1414

# limited to a maximum of 16; any aspect ratios provided after the 16th are

# ignored.

3.14,

],

},

"productSearchParams": { # Parameters for a product search request. # Parameters for product search.

1420

"productSet": "A String", # The resource name of a ProductSet to be searched for similar images.

1421

#

1422

# Format is:

1423

# `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`.

1424

"boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon around the area of interest in the image.

1425

# If it is not specified, system discretion will be applied.

1426

"normalizedVertices": [ # The bounding polygon normalized vertices.

1427

{ # A vertex represents a 2D point in the image.

1428

# NOTE: the normalized vertex coordinates are relative to the original image

1429

# and range from 0 to 1.

1430

"y": 3.14, # Y coordinate.

1431

"x": 3.14, # X coordinate.

1432

},

1433

],

1434

"vertices": [ # The bounding polygon vertices.

1435

{ # A vertex represents a 2D point in the image.

1436

# NOTE: the vertex coordinates are in the same scale as the original image.

1437

"y": 42, # Y coordinate.

1438

"x": 42, # X coordinate.

},

],

},

"productCategories": [ # The list of product categories to search in. Currently, we only consider

1443

# the first category, and either "homegoods-v2", "apparel-v2", "toys-v2",

1444

# "packagedgoods-v1", or "general-v1" should be specified. The legacy

1445

# categories "homegoods", "apparel", and "toys" are still supported but will

1446

# be deprecated. For new products, please use "homegoods-v2", "apparel-v2",

1447

# or "toys-v2" for better product search accuracy. It is recommended to

1448

# migrate existing products to these categories as well.

1449

"A String",

1450

],

1451

"filter": "A String", # The filtering expression. This can be used to restrict search results based

1452

# on Product labels. We currently support an AND of OR of key-value

1453

# expressions, where each expression within an OR must have the same key. An

1454

# '=' should be used to connect the key and value.

1455

#

1456

# For example, "(color = red OR color = blue) AND brand = Google" is

1457

# acceptable, but "(color = red OR brand = Google)" is not acceptable.

1458

# "color: red" is not acceptable because it uses a ':' instead of an '='.

1459

},

1460

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1461

},

1462

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1463

}

1464

1465

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1472

1473

{ # This resource represents a long-running operation that is the result of a

1474

# network API call.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1475

"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1476

# different programming environments, including REST APIs and RPC APIs. It is

1477

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

1478

# three pieces of data: error code, error message, and error details.

1479

#

1480

# You can find out more about this error model and how to work with it in the

1481

# [API Design Guide](https://cloud.google.com/apis/design/errors).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1482

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

1483

"message": "A String", # A developer-facing error message, which should be in English. Any

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1484

# user-facing error message should be localized and sent in the

1485

# google.rpc.Status.details field, or localized by the client.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1486

"details": [ # A list of messages that carry the error details. There is a common set of

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1487

# message types for APIs to use.

1488

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1489

"a_key": "", # Properties of the object. Contains field @type with type URL.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1490

},

1491

],

1492

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1493

"metadata": { # Service-specific metadata associated with the operation. It typically

1494

# contains progress information and common metadata such as create time.

1495

# Some services might not provide such metadata. Any method that returns a

1496

# long-running operation should document the metadata type, if any.

1497

"a_key": "", # Properties of the object. Contains field @type with type URL.

1498

},

1499

"done": True or False, # If the value is `false`, it means the operation is still in progress.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1500

# If `true`, the operation is completed, and either `error` or `response` is

1501

# available.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1502

"response": { # The normal response of the operation in case of success. If the original

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1503

# method returns no data on success, such as `Delete`, the response is

1504

# `google.protobuf.Empty`. If the original method is standard

1505

# `Get`/`Create`/`Update`, the response should be the resource. For other

1506

# methods, the response should have the type `XxxResponse`, where `Xxx`

1507

# is the original method name. For example, if the original method name

1508

# is `TakeSnapshot()`, the inferred response type is

1509

# `TakeSnapshotResponse`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1510

"a_key": "", # Properties of the object. Contains field @type with type URL.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1511

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1512

"name": "A String", # The server-assigned name, which is only unique within the same service that

Bu Sun Kim