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

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

[diff] [blame]

98

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

99

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

Bu Sun Kim

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

[diff] [blame]

100

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

Bu Sun Kim

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

[diff] [blame]

101

#

102

# The Google Cloud Storage URI of the form

103

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

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

104

# [Google Cloud Storage Request

Bu Sun Kim

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

[diff] [blame]

105

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

Bu Sun Kim

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

[diff] [blame]

106

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

Bu Sun Kim

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

[diff] [blame]

107

#

108

# 1. A Google Cloud Storage URI of the form

109

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

110

# [Google Cloud Storage Request

111

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

112

# info.

113

#

114

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

115

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

116

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

117

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

118

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

119

# depend on externally-hosted images for production applications.

120

#

121

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

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

122

# precedence.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

123

},

Bu Sun Kim

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

[diff] [blame^]

124

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

125

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

126

# representation, whereas JSON representations use base64.

127

#

128

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

129

# not work for AsyncBatchAnnotateImages requests.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

130

},

Bu Sun Kim

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

[diff] [blame]

131

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

Bu Sun Kim

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

[diff] [blame^]

132

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

133

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

134

# of doubles representing degrees latitude and degrees longitude. Unless

135

# specified otherwise, this must conform to the

136

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

137

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

138

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

139

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

140

},

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

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

147

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

148

},

149

},

150

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

151

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

152

},

Bu Sun Kim

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

[diff] [blame]

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

],

Bu Sun Kim

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

[diff] [blame]

163

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

Bu Sun Kim

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

[diff] [blame^]

164

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

165

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

166

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

167

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

168

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

169

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

170

# migrate existing products to these categories as well.

171

"A String",

172

],

Bu Sun Kim

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

[diff] [blame]

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.

Bu Sun Kim

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

[diff] [blame]

186

"x": 42, # X coordinate.

Bu Sun Kim

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

[diff] [blame]

187

"y": 42, # Y coordinate.

Bu Sun Kim

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

[diff] [blame]

188

},

189

],

190

},

Bu Sun Kim

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

[diff] [blame^]

191

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

192

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

193

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

194

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

195

#

196

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

197

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

198

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

199

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

200

#

201

# Format is:

202

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

203

},

204

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

205

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

206

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

207

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

208

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

209

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

210

# ignored.

211

3.14,

Bu Sun Kim

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

[diff] [blame]

212

],

Bu Sun Kim

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

[diff] [blame]

213

},

214

},

Bu Sun Kim

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

[diff] [blame^]

215

"features": [ # Requested features.

216

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

217

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

218

# be specified in the `features` list.

219

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

220

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

221

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

222

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

223

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

224

# "builtin/latest".

225

},

226

],

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

227

},

228

],

Bu Sun Kim

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

[diff] [blame]

229

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

230

#

231

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

232

#

233

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

234

#

235

# Supported location-ids:

236

# `us`: USA country only,

237

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

238

# `eu`: The European Union.

239

#

240

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

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

241

}

242

243

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

250

251

{ # Response to a batch image annotation request.

Bu Sun Kim

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

[diff] [blame]

252

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

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

253

{ # Response to an image annotation request.

Bu Sun Kim

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

[diff] [blame^]

254

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

Bu Sun Kim

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

[diff] [blame]

255

{ # Set of detected entity features.

Bu Sun Kim

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

[diff] [blame^]

256

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

Bu Sun Kim

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

[diff] [blame]

257

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

258

# The accuracy of the entity detection in an image.

259

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

260

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

261

# image. Range [0, 1].

Bu Sun Kim

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

[diff] [blame]

262

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

263

# for `LABEL_DETECTION` features.

264

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

265

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

266

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

267

# and range from 0 to 1.

268

"y": 3.14, # Y coordinate.

269

"x": 3.14, # X coordinate.

270

},

271

],

272

"vertices": [ # The bounding polygon vertices.

273

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

274

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

275

"x": 42, # X coordinate.

276

"y": 42, # Y coordinate.

277

},

278

],

279

},

Bu Sun Kim

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

[diff] [blame^]

280

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

281

# [Google Knowledge Graph Search

282

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

283

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

284

# `description` is expressed.

Bu Sun Kim

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

[diff] [blame]

285

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

286

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

287

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

288

# detected distant towering building, even though the confidence that

289

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

Bu Sun Kim

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

[diff] [blame^]

290

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

291

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

292

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

293

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

294

# Location information is usually present for landmarks.

295

{ # Detected entity location information.

296

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

297

# of doubles representing degrees latitude and degrees longitude. Unless

298

# specified otherwise, this must conform to the

299

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

300

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

301

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

302

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

303

},

304

},

305

],

Bu Sun Kim

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

[diff] [blame]

306

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

307

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

308

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

309

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

310

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

311

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

312

},

313

],

Bu Sun Kim

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

[diff] [blame^]

314

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

Bu Sun Kim

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

[diff] [blame]

315

},

316

],

Bu Sun Kim

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

[diff] [blame^]

317

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

318

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

319

# violence).

320

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

321

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

322

# funny or offensive.

323

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

324

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

325

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

326

# body areas.

327

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

328

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

329

# sexual activities.

330

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

331

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

332

},

333

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

334

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

335

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

336

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

337

{ # Metadata for online images.

338

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

339

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

Bu Sun Kim

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

[diff] [blame]

340

},

Bu Sun Kim

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

[diff] [blame^]

341

],

342

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

343

# Inferred from similar images on the open web.

344

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

345

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

346

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

347

# For more information, see

348

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

Bu Sun Kim

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

[diff] [blame]

349

},

Bu Sun Kim

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

[diff] [blame^]

350

],

351

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

352

{ # Metadata for online images.

353

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

354

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

355

},

356

],

357

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

358

{ # Entity deduced from similar images on the Internet.

359

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

360

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

361

# Not normalized and not comparable across different image queries.

362

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

363

},

364

],

365

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

366

# Can include resized copies of the query image.

367

{ # Metadata for online images.

368

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

369

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

370

},

371

],

372

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

373

{ # Metadata for web pages.

374

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

375

# Can include resized copies of the query image.

376

{ # Metadata for online images.

377

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

378

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

379

},

380

],

381

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

382

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

383

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

384

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

385

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

386

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

387

# crops.

388

{ # Metadata for online images.

389

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

390

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

391

},

392

],

Bu Sun Kim

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

[diff] [blame]

393

},

394

],

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

395

},

Bu Sun Kim

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

[diff] [blame]

396

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

Bu Sun Kim

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

[diff] [blame]

397

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

398

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

399

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

400

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

401

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

402

# image.

403

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

404

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

Bu Sun Kim

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

[diff] [blame]

405

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

Bu Sun Kim

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

[diff] [blame^]

406

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

Bu Sun Kim

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

[diff] [blame]

407

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

408

# information, see

409

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

Bu Sun Kim

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

[diff] [blame]

410

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

Bu Sun Kim

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

[diff] [blame]

411

},

412

],

Bu Sun Kim

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

[diff] [blame]

413

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

414

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

415

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

416

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

417

# and range from 0 to 1.

418

"y": 3.14, # Y coordinate.

419

"x": 3.14, # X coordinate.

420

},

421

],

422

"vertices": [ # The bounding polygon vertices.

423

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

424

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

425

"x": 42, # X coordinate.

Bu Sun Kim

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

[diff] [blame]

426

"y": 42, # Y coordinate.

Bu Sun Kim

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

[diff] [blame]

},

],

},

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

431

{ # Information about a product.

432

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

433

# to the query.

434

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

Bu Sun Kim

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

[diff] [blame^]

435

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

436

# 4096 characters long.

Bu Sun Kim

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

[diff] [blame]

437

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

438

#

439

# Format is:

440

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

441

#

442

# This field is ignored when creating a product.

Bu Sun Kim

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

[diff] [blame]

443

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

444

# constraints can be specified based on the product_labels.

445

#

446

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

447

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

448

# to be supported soon.

449

#

450

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

451

# 500 product_labels.

452

#

453

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

454

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

455

# will refuse to work for that ProductSet.

456

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

Bu Sun Kim

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

[diff] [blame]

457

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

458

# exceed 128 bytes.

Bu Sun Kim

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

[diff] [blame^]

459

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

460

# cannot exceed 128 bytes.

Bu Sun Kim

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

[diff] [blame]

461

},

462

],

Bu Sun Kim

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

[diff] [blame^]

463

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

464

# characters long.

465

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

466

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

467

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

468

# not be used for new products.

Bu Sun Kim

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

[diff] [blame]

469

},

470

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

471

# 1 (full confidence).

Bu Sun Kim

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

[diff] [blame]

},

],

},

],

Bu Sun Kim

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

[diff] [blame^]

476

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

477

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

478

# not reflected in the current results.

Bu Sun Kim

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

[diff] [blame]

479

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

480

{ # Information about a product.

481

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

482

# to the query.

483

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

Bu Sun Kim

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

[diff] [blame^]

484

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

485

# 4096 characters long.

Bu Sun Kim

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

[diff] [blame]

486

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

487

#

488

# Format is:

489

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

490

#

491

# This field is ignored when creating a product.

Bu Sun Kim

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

[diff] [blame]

492

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

493

# constraints can be specified based on the product_labels.

494

#

495

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

496

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

497

# to be supported soon.

498

#

499

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

500

# 500 product_labels.

501

#

502

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

503

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

504

# will refuse to work for that ProductSet.

505

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

Bu Sun Kim

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

[diff] [blame]

506

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

507

# exceed 128 bytes.

Bu Sun Kim

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

[diff] [blame^]

508

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

509

# cannot exceed 128 bytes.

Bu Sun Kim

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

[diff] [blame]

510

},

511

],

Bu Sun Kim

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

[diff] [blame^]

512

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

513

# characters long.

514

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

515

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

516

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

517

# not be used for new products.

Bu Sun Kim

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

[diff] [blame]

518

},

519

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

520

# 1 (full confidence).

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

521

},

522

],

Bu Sun Kim

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

[diff] [blame]

523

},

524

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

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

525

# completed successfully.

526

# This annotation provides the structural hierarchy for the OCR detected

527

# text.

528

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

Dan O'Meara

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

[diff] [blame]

529

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

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

530

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

Bu Sun Kim

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

[diff] [blame]

531

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

532

# to the TextAnnotation.TextProperty message definition below for more

533

# detail.

Bu Sun Kim

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

[diff] [blame^]

534

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

Bu Sun Kim

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

[diff] [blame]

535

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

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

536

{ # Detected page from OCR.

Bu Sun Kim

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

[diff] [blame^]

537

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

538

# TIFFs) the unit is pixels.

Bu Sun Kim

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

[diff] [blame]

539

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

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

540

{ # Logical element on the page.

Bu Sun Kim

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

[diff] [blame^]

541

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

542

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

543

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

544

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

545

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

546

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

547

# read in the 'natural' orientation.

548

# For example:

549

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

558

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

559

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

560

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

561

# and range from 0 to 1.

562

"y": 3.14, # Y coordinate.

563

"x": 3.14, # X coordinate.

564

},

565

],

566

"vertices": [ # The bounding polygon vertices.

567

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

568

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

569

"x": 42, # X coordinate.

570

"y": 42, # Y coordinate.

},

],

},

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

575

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

576

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

577

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

578

},

579

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

580

{ # Detected language for a structural component.

581

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

582

# information, see

583

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

584

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

},

],

},

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

589

{ # A word representation.

590

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

591

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

592

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

593

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

594

},

595

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

596

{ # Detected language for a structural component.

597

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

598

# information, see

599

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

600

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

},

],

},

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

605

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

606

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

607

{ # A single symbol representation.

608

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

609

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

610

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

611

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

612

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

613

# read in the 'natural' orientation.

614

# For example:

615

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

624

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

625

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

626

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

627

# and range from 0 to 1.

628

"y": 3.14, # Y coordinate.

629

"x": 3.14, # X coordinate.

630

},

631

],

632

"vertices": [ # The bounding polygon vertices.

633

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

634

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

635

"x": 42, # X coordinate.

636

"y": 42, # Y coordinate.

},

],

},

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

641

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

642

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

643

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

644

},

645

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

646

{ # Detected language for a structural component.

647

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

648

# information, see

649

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

650

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

},

],

},

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

655

},

656

],

657

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

658

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

659

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

660

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

661

# read in the 'natural' orientation.

662

# For example:

663

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

672

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

673

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

674

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

675

# and range from 0 to 1.

676

"y": 3.14, # Y coordinate.

677

"x": 3.14, # X coordinate.

678

},

679

],

680

"vertices": [ # The bounding polygon vertices.

681

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

682

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

683

"x": 42, # X coordinate.

684

"y": 42, # Y coordinate.

},

],

},

},

],

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

691

},

692

],

693

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

Bu Sun Kim

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

[diff] [blame]

694

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

Bu Sun Kim

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

[diff] [blame]

695

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

Bu Sun Kim

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

[diff] [blame]

696

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

Bu Sun Kim

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

[diff] [blame^]

697

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

Bu Sun Kim

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

[diff] [blame]

698

},

Bu Sun Kim

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

[diff] [blame]

699

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

700

{ # Detected language for a structural component.

701

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

702

# information, see

703

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

704

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

705

},

706

],

Bu Sun Kim

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

[diff] [blame]

707

},

Bu Sun Kim

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

[diff] [blame^]

708

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

Bu Sun Kim

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

[diff] [blame]

709

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

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

710

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

711

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

712

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

713

# read in the 'natural' orientation.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

714

# For example:

Bu Sun Kim

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

[diff] [blame]

715

#

716

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

722

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

729

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

Bu Sun Kim

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

[diff] [blame]

730

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

731

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

732

# and range from 0 to 1.

Bu Sun Kim

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

[diff] [blame]

733

"y": 3.14, # Y coordinate.

734

"x": 3.14, # X coordinate.

Bu Sun Kim

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

[diff] [blame]

735

},

736

],

Bu Sun Kim

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

[diff] [blame]

737

"vertices": [ # The bounding polygon vertices.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

738

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

739

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

740

"x": 42, # X coordinate.

Bu Sun Kim

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

[diff] [blame]

741

"y": 42, # Y coordinate.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

742

},

743

],

744

},

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

745

},

746

],

Bu Sun Kim

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

[diff] [blame^]

747

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

748

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

749

# TIFFs) the unit is pixels.

Bu Sun Kim

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

[diff] [blame]

750

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

Bu Sun Kim

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

[diff] [blame]

751

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

Bu Sun Kim

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

[diff] [blame]

752

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

Bu Sun Kim

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

[diff] [blame^]

753

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

Bu Sun Kim

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

[diff] [blame]

754

},

Bu Sun Kim

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

[diff] [blame]

755

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

756

{ # Detected language for a structural component.

757

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

758

# information, see

759

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

760

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

761

},

762

],

Bu Sun Kim

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

[diff] [blame]

763

},

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

764

},

765

],

766

},

Bu Sun Kim

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

[diff] [blame^]

767

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

768

# This will be sorted descending by confidence score.

769

{ # Set of detected objects with bounding boxes.

770

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

771

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

772

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

773

# information, see

774

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

775

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

Bu Sun Kim

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

[diff] [blame]

776

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

Bu Sun Kim

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

[diff] [blame]

777

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

778

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

779

# and range from 0 to 1.

Bu Sun Kim

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

[diff] [blame]

780

"y": 3.14, # Y coordinate.

781

"x": 3.14, # X coordinate.

Bu Sun Kim

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

[diff] [blame]

782

},

783

],

Bu Sun Kim

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

[diff] [blame]

784

"vertices": [ # The bounding polygon vertices.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

785

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

786

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

787

"x": 42, # X coordinate.

Bu Sun Kim

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

[diff] [blame]

788

"y": 42, # Y coordinate.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

789

},

790

],

791

},

Bu Sun Kim

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

[diff] [blame^]

792

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

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

793

},

794

],

Bu Sun Kim

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

[diff] [blame]

795

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

796

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

797

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

Jon Wayne Parrott

692617a

2017-01-06 09:58:29 -0800

[diff] [blame]

798

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

799

# the image that the color occupies in the image.

Bu Sun Kim

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

[diff] [blame]

800

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

Bu Sun Kim

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

[diff] [blame]

801

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

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

802

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

803

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

Bu Sun Kim

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

[diff] [blame]

804

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

805

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

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

806

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

807

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

Bu Sun Kim

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

[diff] [blame]

808

#

809

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

810

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

811

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

812

# space.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

813

#

Bu Sun Kim

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

[diff] [blame^]

814

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

815

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

816

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

817

#

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

818

# Example (Java):

819

#

820

# import com.google.type.Color;

821

#

822

# // ...

823

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

824

# float alpha = protocolor.hasAlpha()

825

# ? protocolor.getAlpha().getValue()

826

# : 1.0;

827

#

828

# return new java.awt.Color(

829

# protocolor.getRed(),

830

# protocolor.getGreen(),

831

# protocolor.getBlue(),

# alpha);

# }

#

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

836

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

837

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

838

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

839

# float denominator = 255.0;

840

# Color.Builder resultBuilder =

841

# Color

842

# .newBuilder()

843

# .setRed(red / denominator)

844

# .setGreen(green / denominator)

845

# .setBlue(blue / denominator);

846

# int alpha = color.getAlpha();

847

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

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

852

# .build());

853

# }

854

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

859

#

860

# // ...

861

# static UIColor* fromProto(Color* protocolor) {

862

# float red = [protocolor red];

863

# float green = [protocolor green];

864

# float blue = [protocolor blue];

865

# FloatValue* alpha_wrapper = [protocolor alpha];

866

# float alpha = 1.0;

867

# if (alpha_wrapper != nil) {

868

# alpha = [alpha_wrapper value];

869

# }

870

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

871

# }

872

#

873

# static Color* toProto(UIColor* color) {

874

# CGFloat red, green, blue, alpha;

Dan O'Meara

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

[diff] [blame]

875

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

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

876

# return nil;

877

# }

Bu Sun Kim

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

[diff] [blame]

878

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

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

879

# [result setRed:red];

880

# [result setGreen:green];

881

# [result setBlue:blue];

Dan O'Meara

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

[diff] [blame]

882

# if (alpha <= 0.9999) {

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

883

# [result setAlpha:floatWrapperWithValue(alpha)];

884

# }

885

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

895

# var redFrac = rgb_color.red || 0.0;

896

# var greenFrac = rgb_color.green || 0.0;

897

# var blueFrac = rgb_color.blue || 0.0;

898

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

899

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

900

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

901

#

Bu Sun Kim

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

[diff] [blame]

902

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

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

903

# return rgbToCssColor_(red, green, blue);

904

# }

905

#

906

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

Bu Sun Kim

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

[diff] [blame]

907

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

908

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

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

909

# };

910

#

911

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

Dan O'Meara

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

[diff] [blame]

912

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

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

913

# var hexString = rgbNumber.toString(16);

914

# var missingZeros = 6 - hexString.length;

Bu Sun Kim

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

[diff] [blame]

915

# var resultBuilder = ['#'];

Dan O'Meara

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

[diff] [blame]

916

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

Bu Sun Kim

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

[diff] [blame]

917

# resultBuilder.push('0');

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

918

# }

919

# resultBuilder.push(hexString);

Bu Sun Kim

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

[diff] [blame]

920

# return resultBuilder.join('');

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

921

# };

922

#

923

# // ...

Bu Sun Kim

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

[diff] [blame^]

924

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

Bu Sun Kim

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

[diff] [blame]

925

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

926

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

Bu Sun Kim

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

[diff] [blame]

927

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

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

928

# the final pixel color is defined by the equation:

929

#

930

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

931

#

932

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

933

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

934

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

935

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

936

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

937

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

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

938

},

Bu Sun Kim

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

[diff] [blame^]

939

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

940

# Value in range [0, 1].

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

},

],

},

},

Bu Sun Kim

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

[diff] [blame^]

945

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

946

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

947

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

948

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

949

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

950

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

951

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

952

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

953

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

954

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

955

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

956

# and range from 0 to 1.

957

"y": 3.14, # Y coordinate.

958

"x": 3.14, # X coordinate.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

959

},

Bu Sun Kim

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

[diff] [blame^]

960

],

961

"vertices": [ # The bounding polygon vertices.

962

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

963

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

964

"x": 42, # X coordinate.

965

"y": 42, # Y coordinate.

},

],

},

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

970

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

971

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

972

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

973

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

974

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

975

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

976

# are in the original image's scale.

977

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

978

# expectations. It is based on the landmarker results.

979

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

980

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

981

# appears in the image to be annotated.

982

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

983

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

984

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

985

# and range from 0 to 1.

986

"y": 3.14, # Y coordinate.

987

"x": 3.14, # X coordinate.

988

},

989

],

990

"vertices": [ # The bounding polygon vertices.

991

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

992

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

993

"x": 42, # X coordinate.

994

"y": 42, # Y coordinate.

},

],

},

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

999

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

1000

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

1001

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

1002

# [-180,180].

1003

"landmarks": [ # Detected face landmarks.

1004

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

1005

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

1006

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

1007

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

1008

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

1009

"y": 3.14, # Y coordinate.

1010

"x": 3.14, # X coordinate.

1011

},

1012

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

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

1013

},

1014

],

Bu Sun Kim

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

[diff] [blame^]

1015

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

1016

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

1017

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

1018

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

1019

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

1020

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

1021

},

1022

],

1023

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

1024

{ # Set of detected entity features.

1025

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

Bu Sun Kim

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

[diff] [blame]

1026

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

Bu Sun Kim

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

[diff] [blame]

1027

# The accuracy of the entity detection in an image.

Bu Sun Kim

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

[diff] [blame]

1028

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

Jon Wayne Parrott

692617a

2017-01-06 09:58:29 -0800

[diff] [blame]

1029

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

1030

# image. Range [0, 1].

Bu Sun Kim

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

[diff] [blame]

1031

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

1032

# for `LABEL_DETECTION` features.

Bu Sun Kim

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

[diff] [blame]

1033

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

Bu Sun Kim

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

[diff] [blame]

1034

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

1035

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

1036

# and range from 0 to 1.

Bu Sun Kim

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

[diff] [blame]

1037

"y": 3.14, # Y coordinate.

1038

"x": 3.14, # X coordinate.

Bu Sun Kim

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

[diff] [blame]

1039

},

1040

],

Bu Sun Kim

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

[diff] [blame]

1041

"vertices": [ # The bounding polygon vertices.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

1042

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

1043

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

1044

"x": 42, # X coordinate.

Bu Sun Kim

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

[diff] [blame]

1045

"y": 42, # Y coordinate.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

1046

},

1047

],

1048

},

Bu Sun Kim

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

[diff] [blame^]

1049

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

1050

# [Google Knowledge Graph Search

1051

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

1052

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

1053

# `description` is expressed.

Bu Sun Kim

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

[diff] [blame]

1054

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

1055

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

1056

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

1057

# detected distant towering building, even though the confidence that

1058

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

Bu Sun Kim

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

[diff] [blame^]

1059

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

1060

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

1061

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

1062

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

1063

# Location information is usually present for landmarks.

1064

{ # Detected entity location information.

1065

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

1066

# of doubles representing degrees latitude and degrees longitude. Unless

1067

# specified otherwise, this must conform to the

1068

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

1069

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

1070

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

1071

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

1072

},

1073

},

1074

],

Bu Sun Kim

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

[diff] [blame]

1075

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

Jon Wayne Parrott

692617a

2017-01-06 09:58:29 -0800

[diff] [blame]

1076

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

1077

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

Bu Sun Kim

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

[diff] [blame]

1078

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

1079

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

1080

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

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

1081

},

1082

],

Bu Sun Kim

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

[diff] [blame^]

1083

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

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

1084

},

1085

],

Bu Sun Kim

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

[diff] [blame]

1086

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

Bu Sun Kim

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

[diff] [blame]

1087

# comes from.

1088

# information about the source of that image.

Bu Sun Kim

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

[diff] [blame]

1089

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

Bu Sun Kim

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

[diff] [blame]

1090

# the file used to produce the image.

Bu Sun Kim

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

[diff] [blame^]

1091

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

Bu Sun Kim

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

[diff] [blame]

1092

},

Bu Sun Kim

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

[diff] [blame^]

1093

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

1094

"cropHints": [ # Crop hint results.

1095

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

1096

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

1097

# image.

1098

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

1099

# box are in the original image's scale.

1100

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

1101

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

1102

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

1103

# and range from 0 to 1.

1104

"y": 3.14, # Y coordinate.

1105

"x": 3.14, # X coordinate.

1106

},

1107

],

1108

"vertices": [ # The bounding polygon vertices.

1109

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

1110

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

1111

"x": 42, # X coordinate.

1112

"y": 42, # Y coordinate.

},

],

},

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

Bu Sun Kim

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

[diff] [blame]

1117

},

1118

],

Bu Sun Kim

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

[diff] [blame^]

1119

},

1120

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

1121

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

1122

# correct, even when `error` is set.

1123

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

1124

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

1125

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

1126

#

1127

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

1128

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

1129

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

1130

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

1131

# message types for APIs to use.

1132

{

1133

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

Bu Sun Kim

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

[diff] [blame]

1134

},

1135

],

Bu Sun Kim

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

[diff] [blame^]

1136

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

1137

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

1138

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

1139

},

1140

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

1141

{ # Set of detected entity features.

1142

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

1143

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

1144

# The accuracy of the entity detection in an image.

1145

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

1146

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

1147

# image. Range [0, 1].

1148

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

1149

# for `LABEL_DETECTION` features.

1150

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

1151

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

1152

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

1153

# and range from 0 to 1.

1154

"y": 3.14, # Y coordinate.

1155

"x": 3.14, # X coordinate.

Bu Sun Kim

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

[diff] [blame]

1156

},

1157

],

Bu Sun Kim

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

[diff] [blame^]

1158

"vertices": [ # The bounding polygon vertices.

1159

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

1160

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

1161

"x": 42, # X coordinate.

1162

"y": 42, # Y coordinate.

Bu Sun Kim

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

[diff] [blame]

1163

},

1164

],

1165

},

Bu Sun Kim

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

[diff] [blame^]

1166

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

1167

# [Google Knowledge Graph Search

1168

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

1169

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

1170

# `description` is expressed.

1171

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

1172

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

1173

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

1174

# detected distant towering building, even though the confidence that

1175

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

1176

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

1177

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

1178

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

1179

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

1180

# Location information is usually present for landmarks.

1181

{ # Detected entity location information.

1182

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

1183

# of doubles representing degrees latitude and degrees longitude. Unless

1184

# specified otherwise, this must conform to the

1185

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

1186

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

1187

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

1188

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

},

},

],

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

1193

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

1194

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

1195

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

1196

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

1197

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

1198

},

1199

],

1200

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

1201

},

1202

],

1203

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

1204

{ # Set of detected entity features.

1205

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

1206

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

1207

# The accuracy of the entity detection in an image.

1208

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

1209

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

1210

# image. Range [0, 1].

1211

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

1212

# for `LABEL_DETECTION` features.

1213

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

1214

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

1215

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

1216

# and range from 0 to 1.

1217

"y": 3.14, # Y coordinate.

1218

"x": 3.14, # X coordinate.

1219

},

1220

],

1221

"vertices": [ # The bounding polygon vertices.

1222

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

1223

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

1224

"x": 42, # X coordinate.

1225

"y": 42, # Y coordinate.

1226

},

1227

],

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1228

},

Bu Sun Kim

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

[diff] [blame^]

1229

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

1230

# [Google Knowledge Graph Search

1231

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

1232

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

1233

# `description` is expressed.

1234

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

1235

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

1236

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

1237

# detected distant towering building, even though the confidence that

1238

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

1239

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

1240

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

1241

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

1242

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

1243

# Location information is usually present for landmarks.

1244

{ # Detected entity location information.

1245

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

1246

# of doubles representing degrees latitude and degrees longitude. Unless

1247

# specified otherwise, this must conform to the

1248

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

1249

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

1250

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

1251

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

},

},

],

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

1256

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

1257

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

1258

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

1259

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

1260

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

1261

},

1262

],

1263

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

1264

},

1265

],

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

},

],

}</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

1271

Dan O'Meara

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

[diff] [blame]

1272

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

Bu Sun Kim

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

[diff] [blame]

1273

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

1274

1275

Progress and results can be retrieved through the

1276

`google.longrunning.Operations` interface.

1277

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

1278

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

1279

1280

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

1281

GCS bucket, each json file containing BatchAnnotateImagesResponse proto.

1282

1283

Args:

Dan O'Meara

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

[diff] [blame]

1284

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

1285

The object takes the form of:

1286

1287

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

Bu Sun Kim

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

[diff] [blame]

1288

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

1289

#

1290

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

1291

#

1292

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

1293

#

1294

# Supported location-ids:

1295

# `us`: USA country only,

1296

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

1297

# `eu`: The European Union.

1298

#

1299

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

1300

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

1301

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

1302

# Google Cloud Storage.

1303

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

1304

#

1305

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

1306

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

1307

# containing 20 response protos will be written under the prefix

1308

# `gcs_destination`.`uri`.

1309

#

1310

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

1311

# support for other output configurations.

1312

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

1313

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

1314

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

1315

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

1316

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

1317

# 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

1323

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

1324

# output files will begin with "filenameprefix".

1325

#

1326

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

1327

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

1328

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

1329

# specified.

1330

#

1331

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

1332

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

1333

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

1334

# and overflows into multiple sharded files.

1335

},

1336

},

Bu Sun Kim

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

[diff] [blame^]

1337

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

1338

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

1339

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

1340

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

1341

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

1342

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

1343

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

1344

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

1345

#

1346

# The Google Cloud Storage URI of the form

1347

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

1348

# [Google Cloud Storage Request

1349

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

1350

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

1351

#

1352

# 1. A Google Cloud Storage URI of the form

1353

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

1354

# [Google Cloud Storage Request

1355

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

1356

# info.

1357

#

1358

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

1359

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

1360

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

1361

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

1362

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

1363

# depend on externally-hosted images for production applications.

1364

#

1365

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

1366

# precedence.

1367

},

1368

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

1369

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

1370

# representation, whereas JSON representations use base64.

1371

#

1372

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

1373

# not work for AsyncBatchAnnotateImages requests.

1374

},

1375

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

1376

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

1377

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

1378

# of doubles representing degrees latitude and degrees longitude. Unless

1379

# specified otherwise, this must conform to the

1380

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

1381

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

1382

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

1383

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

1384

},

1385

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

1386

# of doubles representing degrees latitude and degrees longitude. Unless

1387

# specified otherwise, this must conform to the

1388

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

1389

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

1390

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

1391

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

1392

},

1393

},

1394

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

1395

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

1396

},

1397

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

1398

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

1399

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

1400

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

1401

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

1402

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

1403

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

1404

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

1405

"A String",

1406

],

1407

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

1408

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

1409

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

1410

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

1411

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

1412

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

1413

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

1414

# migrate existing products to these categories as well.

1415

"A String",

1416

],

1417

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

1418

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

1419

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

1420

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

1421

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

1422

# and range from 0 to 1.

1423

"y": 3.14, # Y coordinate.

1424

"x": 3.14, # X coordinate.

1425

},

1426

],

1427

"vertices": [ # The bounding polygon vertices.

1428

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

1429

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

1430

"x": 42, # X coordinate.

1431

"y": 42, # Y coordinate.

},

],

},

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

1436

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

1437

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

1438

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

1439

#

1440

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

1441

# acceptable, but "(color = red OR brand = Google)" is not acceptable.

1442

# "color: red" is not acceptable because it uses a ':' instead of an '='.

1443

"productSet": "A String", # The resource name of a ProductSet to be searched for similar images.

1444

#

1445

# Format is:

1446

# `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`.

1447

},

1448

"cropHintsParams": { # Parameters for crop hints annotation request. # Parameters for crop hints annotation request.

1449

"aspectRatios": [ # Aspect ratios in floats, representing the ratio of the width to the height

1450

# of the image. For example, if the desired aspect ratio is 4/3, the

1451

# corresponding float value should be 1.33333. If not specified, the

1452

# best possible crop is returned. The number of provided aspect ratios is

1453

# limited to a maximum of 16; any aspect ratios provided after the 16th are

# ignored.

3.14,

],

},

},

"features": [ # Requested features.

1460

{ # The type of Google Cloud Vision API detection to perform, and the maximum

1461

# number of results to return for that type. Multiple `Feature` objects can

1462

# be specified in the `features` list.

1463

"maxResults": 42, # Maximum number of results of this type. Does not apply to

1464

# `TEXT_DETECTION`, `DOCUMENT_TEXT_DETECTION`, or `CROP_HINTS`.

1465

"type": "A String", # The feature type.

1466

"model": "A String", # Model to use for the feature.

1467

# Supported values: "builtin/stable" (the default if unset) and

# "builtin/latest".

},

],

},

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1473

}

1474

1475

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1482

1483

{ # This resource represents a long-running operation that is the result of a

1484

# network API call.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1485

"done": True or False, # If the value is `false`, it means the operation is still in progress.

1486

# If `true`, the operation is completed, and either `error` or `response` is

1487

# available.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1488

"name": "A String", # The server-assigned name, which is only unique within the same service that

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1489

# originally returns it. If you use the default HTTP mapping, the

1490

# `name` should be a resource name ending with `operations/{unique_id}`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1491

"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]

1492

# different programming environments, including REST APIs and RPC APIs. It is

1493

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

1494

# three pieces of data: error code, error message, and error details.

1495

#

1496

# You can find out more about this error model and how to work with it in the

1497

# [API Design Guide](https://cloud.google.com/apis/design/errors).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1498

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1499

"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]

1500

# message types for APIs to use.

1501

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1502

"a_key": "", # Properties of the object. Contains field @type with type URL.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1503

},

1504

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1505

"message": "A String", # A developer-facing error message, which should be in English. Any

1506

# user-facing error message should be localized and sent in the

1507

# google.rpc.Status.details field, or localized by the client.

1508

},

1509

"response": { # The normal response of the operation in case of success. If the original

1510

# method returns no data on success, such as `Delete`, the response is

1511

# `google.protobuf.Empty`. If the original method is standard

1512

# `Get`/`Create`/`Update`, the response should be the resource. For other

1513

# methods, the response should have the type `XxxResponse`, where `Xxx`

1514

# is the original method name. For example, if the original method name

1515

# is `TakeSnapshot()`, the inferred response type is

1516

# `TakeSnapshotResponse`.

1517

"a_key": "", # Properties of the object. Contains field @type with type URL.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1518

},

1519

"metadata": { # Service-specific metadata associated with the operation. It typically

1520

# contains progress information and common metadata such as create time.

1521

# Some services might not provide such metadata. Any method that returns a

1522

# long-running operation should document the metadata type, if any.

1523

"a_key": "", # Properties of the object. Contains field @type with type URL.

Bu Sun Kim