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

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

[diff] [blame]

101

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

102

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

Bu Sun Kim

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

[diff] [blame]

103

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

104

#

105

# The Google Cloud Storage URI of the form

106

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

107

# [Google Cloud Storage Request

108

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

Bu Sun Kim

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

[diff] [blame]

109

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

Bu Sun Kim

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

[diff] [blame]

110

#

111

# 1. A Google Cloud Storage URI of the form

112

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

113

# [Google Cloud Storage Request

114

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

115

# info.

116

#

117

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

118

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

119

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

120

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

121

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

122

# depend on externally-hosted images for production applications.

123

#

124

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

125

# precedence.

126

},

127

},

Bu Sun Kim

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

[diff] [blame]

128

"features": [ # Requested features.

Bu Sun Kim

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

[diff] [blame]

129

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

130

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

131

# be specified in the `features` list.

Bu Sun Kim

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

[diff] [blame]

132

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

133

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

134

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

Bu Sun Kim

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

[diff] [blame]

135

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

136

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

137

# "builtin/latest".

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

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

141

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

142

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

143

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

144

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

145

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

146

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

147

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

148

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

149

"A String",

150

],

151

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

152

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

153

},

154

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

155

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

156

# of doubles representing degrees latitude and degrees longitude. Unless

157

# specified otherwise, this must conform to the

158

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

159

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

160

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

161

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

162

},

163

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

164

# of doubles representing degrees latitude and degrees longitude. Unless

165

# specified otherwise, this must conform to the

166

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

167

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

168

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

169

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

170

},

171

},

172

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

173

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

174

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

175

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

176

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

177

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

Bu Sun Kim

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

[diff] [blame]

183

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

184

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

185

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

186

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

187

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

188

# and range from 0 to 1.

189

"y": 3.14, # Y coordinate.

190

"x": 3.14, # X coordinate.

191

},

192

],

193

"vertices": [ # The bounding polygon vertices.

194

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

195

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

196

"y": 42, # Y coordinate.

197

"x": 42, # X coordinate.

},

],

},

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

202

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

203

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

204

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

205

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

206

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

207

# migrate existing products to these categories as well.

208

"A String",

209

],

Bu Sun Kim

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

[diff] [blame]

210

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

211

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

212

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

213

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

214

#

215

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

216

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

217

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

218

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

219

#

220

# Format is:

221

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

Bu Sun Kim

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

[diff] [blame]

222

},

223

},

Bu Sun Kim

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

[diff] [blame]

224

},

225

],

Bu Sun Kim

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

[diff] [blame]

226

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

227

#

228

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

229

#

230

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

231

#

232

# Supported location-ids:

233

# `us`: USA country only,

234

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

235

# `eu`: The European Union.

236

#

237

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

Bu Sun Kim

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

[diff] [blame]

238

}

239

240

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-27 12:20:54 -0700

[diff] [blame]

251

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

252

# This will be sorted descending by confidence score.

253

{ # Set of detected objects with bounding boxes.

254

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

255

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

256

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

Bu Sun Kim

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

[diff] [blame]

257

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

258

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

259

# and range from 0 to 1.

Bu Sun Kim

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

[diff] [blame]

260

"y": 3.14, # Y coordinate.

261

"x": 3.14, # X coordinate.

Bu Sun Kim

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

[diff] [blame]

262

},

263

],

Bu Sun Kim

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

[diff] [blame]

264

"vertices": [ # The bounding polygon vertices.

Bu Sun Kim

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

[diff] [blame]

265

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

266

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

267

"y": 42, # Y coordinate.

268

"x": 42, # X coordinate.

Bu Sun Kim

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

[diff] [blame]

269

},

270

],

271

},

Bu Sun Kim

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

[diff] [blame]

272

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

273

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

274

# information, see

275

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

276

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

Bu Sun Kim

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

[diff] [blame]

277

},

278

],

Bu Sun Kim

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

[diff] [blame]

279

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

280

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

281

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

282

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

283

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

284

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

285

# image.

Bu Sun Kim

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

[diff] [blame]

286

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

287

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

288

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

289

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

290

# and range from 0 to 1.

291

"y": 3.14, # Y coordinate.

292

"x": 3.14, # X coordinate.

293

},

294

],

295

"vertices": [ # The bounding polygon vertices.

296

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

297

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

298

"y": 42, # Y coordinate.

299

"x": 42, # X coordinate.

},

],

},

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

304

{ # Information about a product.

305

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

306

# to the query.

307

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

Bu Sun Kim

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

[diff] [blame]

308

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

309

#

310

# Format is:

311

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

312

#

313

# This field is ignored when creating a product.

Bu Sun Kim

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

[diff] [blame]

314

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

315

# 4096 characters long.

316

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

317

# characters long.

318

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

319

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

320

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

321

# not be used for new products.

322

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

323

# constraints can be specified based on the product_labels.

324

#

325

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

326

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

327

# to be supported soon.

328

#

329

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

330

# 500 product_labels.

331

#

332

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

333

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

334

# will refuse to work for that ProductSet.

335

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

336

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

337

# exceed 128 bytes.

338

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

339

# cannot exceed 128 bytes.

340

},

341

],

Bu Sun Kim

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

[diff] [blame]

342

},

343

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

344

# 1 (full confidence).

345

},

346

],

Bu Sun Kim

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

[diff] [blame]

347

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

348

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

349

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

350

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

351

# information, see

352

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

353

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

354

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

355

},

356

],

Bu Sun Kim

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

[diff] [blame]

357

},

358

],

359

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

360

{ # Information about a product.

361

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

362

# to the query.

363

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

Bu Sun Kim

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

[diff] [blame]

364

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

365

#

366

# Format is:

367

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

368

#

369

# This field is ignored when creating a product.

Bu Sun Kim

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

[diff] [blame]

370

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

371

# 4096 characters long.

372

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

373

# characters long.

374

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

375

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

376

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

377

# not be used for new products.

378

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

379

# constraints can be specified based on the product_labels.

380

#

381

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

382

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

383

# to be supported soon.

384

#

385

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

386

# 500 product_labels.

387

#

388

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

389

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

390

# will refuse to work for that ProductSet.

391

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

392

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

393

# exceed 128 bytes.

394

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

395

# cannot exceed 128 bytes.

396

},

397

],

Bu Sun Kim

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

[diff] [blame]

398

},

399

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

400

# 1 (full confidence).

401

},

402

],

403

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

404

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

405

# not reflected in the current results.

406

},

Bu Sun Kim

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

[diff] [blame]

407

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

408

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

409

# correct, even when `error` is set.

410

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

411

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

412

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

413

#

414

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

415

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

Bu Sun Kim

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

[diff] [blame]

416

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

417

# message types for APIs to use.

418

{

419

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

420

},

421

],

Bu Sun Kim

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

[diff] [blame]

422

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

423

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

424

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

425

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

Bu Sun Kim

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

[diff] [blame]

426

},

427

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

428

# completed successfully.

429

# This annotation provides the structural hierarchy for the OCR detected

430

# text.

431

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

Dan O'Meara

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

[diff] [blame]

432

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

Bu Sun Kim

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

[diff] [blame]

433

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

434

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

435

# to the TextAnnotation.TextProperty message definition below for more

436

# detail.

Bu Sun Kim

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

[diff] [blame]

437

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

Bu Sun Kim

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

[diff] [blame]

438

{ # Detected page from OCR.

Bu Sun Kim

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

[diff] [blame]

439

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

Bu Sun Kim

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

[diff] [blame]

440

{ # Logical element on the page.

Bu Sun Kim

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

[diff] [blame]

441

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

442

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

443

{ # Detected language for a structural component.

444

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

445

# information, see

446

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

447

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

448

},

449

],

450

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

451

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

452

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

453

},

454

},

455

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

456

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

457

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

458

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

459

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

460

# read in the 'natural' orientation.

Bu Sun Kim

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

[diff] [blame]

461

# For example:

462

#

463

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

469

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

476

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

Bu Sun Kim

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

[diff] [blame]

477

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

478

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

479

# and range from 0 to 1.

Bu Sun Kim

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

[diff] [blame]

480

"y": 3.14, # Y coordinate.

481

"x": 3.14, # X coordinate.

Bu Sun Kim

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

[diff] [blame]

482

},

483

],

Bu Sun Kim

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

[diff] [blame]

484

"vertices": [ # The bounding polygon vertices.

Bu Sun Kim

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

[diff] [blame]

485

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

486

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

487

"y": 42, # Y coordinate.

488

"x": 42, # X coordinate.

Bu Sun Kim

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

[diff] [blame]

489

},

490

],

491

},

Bu Sun Kim

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

[diff] [blame]

492

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

493

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

494

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

Bu Sun Kim

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

[diff] [blame]

495

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

496

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

497

{ # Detected language for a structural component.

498

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

499

# information, see

500

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

501

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

502

},

503

],

504

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

505

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

506

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

507

},

508

},

509

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

510

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

511

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

512

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

513

# read in the 'natural' orientation.

Bu Sun Kim

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

[diff] [blame]

514

# For example:

515

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

516

# 0----1

517

# | |

518

# 3----2

Bu Sun Kim

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

[diff] [blame]

519

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

524

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

Bu Sun Kim

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

[diff] [blame]

525

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

526

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

527

# and range from 0 to 1.

Bu Sun Kim

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

[diff] [blame]

528

"y": 3.14, # Y coordinate.

529

"x": 3.14, # X coordinate.

Bu Sun Kim

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

[diff] [blame]

530

},

531

],

Bu Sun Kim

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

[diff] [blame]

532

"vertices": [ # The bounding polygon vertices.

Bu Sun Kim

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

[diff] [blame]

533

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

534

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

535

"y": 42, # Y coordinate.

536

"x": 42, # X coordinate.

Bu Sun Kim

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

[diff] [blame]

537

},

538

],

539

},

Bu Sun Kim

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

[diff] [blame]

540

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

541

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

Bu Sun Kim

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

[diff] [blame]

542

{ # A word representation.

Bu Sun Kim

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

[diff] [blame]

543

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

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

Bu Sun Kim

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

[diff] [blame]

547

# read in the 'natural' orientation.

Dan O'Meara

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

[diff] [blame]

548

# For example:

549

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

550

# 0----1

551

# | |

552

# 3----2

Bu Sun Kim

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

[diff] [blame]

553

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

558

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

Dan O'Meara

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

[diff] [blame]

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.

Bu Sun Kim

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

[diff] [blame]

562

"y": 3.14, # Y coordinate.

563

"x": 3.14, # X coordinate.

Dan O'Meara

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

[diff] [blame]

564

},

565

],

Bu Sun Kim

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

[diff] [blame]

566

"vertices": [ # The bounding polygon vertices.

Dan O'Meara

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

[diff] [blame]

567

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

568

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

569

"y": 42, # Y coordinate.

570

"x": 42, # X coordinate.

Dan O'Meara

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

[diff] [blame]

571

},

572

],

573

},

Bu Sun Kim

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

[diff] [blame]

574

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

575

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

576

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

577

{ # A single symbol representation.

578

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

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

585

},

586

],

587

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

588

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

589

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

590

},

591

},

592

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

593

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

594

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

595

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

596

# read in the 'natural' orientation.

597

# For example:

598

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

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.

},

],

},

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

624

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

Bu Sun Kim

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

[diff] [blame]

625

},

Bu Sun Kim

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

[diff] [blame]

626

],

627

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

628

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

Bu Sun Kim

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

[diff] [blame]

629

{ # Detected language for a structural component.

Bu Sun Kim

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

[diff] [blame]

630

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

631

# information, see

632

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

Bu Sun Kim

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

[diff] [blame]

633

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

Bu Sun Kim

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

[diff] [blame]

634

},

635

],

Bu Sun Kim

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

[diff] [blame]

636

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

637

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

638

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

639

},

Bu Sun Kim

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

[diff] [blame]

},

},

],

},

],

},

],

Bu Sun Kim

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

[diff] [blame]

647

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

648

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

649

{ # Detected language for a structural component.

650

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

651

# information, see

652

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

653

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

654

},

655

],

656

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

657

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

658

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

659

},

660

},

Bu Sun Kim

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

[diff] [blame]

661

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

662

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

663

# TIFFs) the unit is pixels.

664

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

665

# TIFFs) the unit is pixels.

Bu Sun Kim

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

[diff] [blame]

666

},

667

],

Bu Sun Kim

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

[diff] [blame]

668

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

Bu Sun Kim

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

[diff] [blame]

669

},

Bu Sun Kim

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

[diff] [blame]

670

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

Bu Sun Kim

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

[diff] [blame]

671

{ # Set of detected entity features.

Bu Sun Kim

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

[diff] [blame]

672

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

673

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

Bu Sun Kim

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

[diff] [blame]

674

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

675

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

676

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

677

# Location information is usually present for landmarks.

678

{ # Detected entity location information.

Bu Sun Kim

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

[diff] [blame]

679

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

680

# of doubles representing degrees latitude and degrees longitude. Unless

681

# specified otherwise, this must conform to the

Bu Sun Kim

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

[diff] [blame]

682

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

683

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

Bu Sun Kim

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

[diff] [blame]

684

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

685

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

686

},

687

},

688

],

Bu Sun Kim

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

[diff] [blame]

689

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

690

# [Google Knowledge Graph Search

691

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

692

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

693

# The accuracy of the entity detection in an image.

694

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

695

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

696

# image. Range [0, 1].

697

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

698

# for `LABEL_DETECTION` features.

Bu Sun Kim

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

[diff] [blame]

699

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

Bu Sun Kim

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

[diff] [blame]

700

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

701

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

702

# and range from 0 to 1.

Bu Sun Kim

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

[diff] [blame]

703

"y": 3.14, # Y coordinate.

704

"x": 3.14, # X coordinate.

Bu Sun Kim

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

[diff] [blame]

705

},

706

],

Bu Sun Kim

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

[diff] [blame]

707

"vertices": [ # The bounding polygon vertices.

Bu Sun Kim

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

[diff] [blame]

708

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

709

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

710

"y": 42, # Y coordinate.

711

"x": 42, # X coordinate.

Bu Sun Kim

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

[diff] [blame]

712

},

713

],

714

},

Bu Sun Kim

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

[diff] [blame]

715

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

716

# `description` is expressed.

Bu Sun Kim

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

[diff] [blame]

717

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

718

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

719

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

720

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

721

# detected distant towering building, even though the confidence that

722

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

723

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

724

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

725

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

726

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

727

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

728

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

729

},

730

],

Bu Sun Kim

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

[diff] [blame]

731

},

732

],

Bu Sun Kim

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

[diff] [blame]

733

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

734

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

735

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

Bu Sun Kim

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

[diff] [blame]

736

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

737

# the image that the color occupies in the image.

Bu Sun Kim

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

[diff] [blame]

738

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

739

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

740

# Value in range [0, 1].

741

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

742

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

743

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

Bu Sun Kim

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

[diff] [blame]

744

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

745

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

Bu Sun Kim

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

[diff] [blame]

746

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

747

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

Bu Sun Kim

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

[diff] [blame]

748

#

749

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

750

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

751

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

# space.

#

# Example (Java):

#

# import com.google.type.Color;

757

#

758

# // ...

759

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

760

# float alpha = protocolor.hasAlpha()

761

# ? protocolor.getAlpha().getValue()

762

# : 1.0;

763

#

764

# return new java.awt.Color(

765

# protocolor.getRed(),

766

# protocolor.getGreen(),

767

# protocolor.getBlue(),

# alpha);

# }

#

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

772

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

773

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

774

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

775

# float denominator = 255.0;

776

# Color.Builder resultBuilder =

777

# Color

778

# .newBuilder()

779

# .setRed(red / denominator)

780

# .setGreen(green / denominator)

781

# .setBlue(blue / denominator);

782

# int alpha = color.getAlpha();

783

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

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

788

# .build());

789

# }

790

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

795

#

796

# // ...

797

# static UIColor* fromProto(Color* protocolor) {

798

# float red = [protocolor red];

799

# float green = [protocolor green];

800

# float blue = [protocolor blue];

801

# FloatValue* alpha_wrapper = [protocolor alpha];

802

# float alpha = 1.0;

803

# if (alpha_wrapper != nil) {

804

# alpha = [alpha_wrapper value];

805

# }

806

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

807

# }

808

#

809

# static Color* toProto(UIColor* color) {

810

# CGFloat red, green, blue, alpha;

Dan O'Meara

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

[diff] [blame]

811

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

Bu Sun Kim

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

[diff] [blame]

812

# return nil;

813

# }

814

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

815

# [result setRed:red];

816

# [result setGreen:green];

817

# [result setBlue:blue];

Dan O'Meara

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

[diff] [blame]

818

# if (alpha <= 0.9999) {

Bu Sun Kim

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

[diff] [blame]

819

# [result setAlpha:floatWrapperWithValue(alpha)];

820

# }

821

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

831

# var redFrac = rgb_color.red || 0.0;

832

# var greenFrac = rgb_color.green || 0.0;

833

# var blueFrac = rgb_color.blue || 0.0;

834

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

835

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

836

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

837

#

Bu Sun Kim

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

[diff] [blame]

838

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

Bu Sun Kim

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

[diff] [blame]

839

# return rgbToCssColor_(red, green, blue);

840

# }

841

#

842

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

Bu Sun Kim

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

[diff] [blame]

843

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

844

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

Bu Sun Kim

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

[diff] [blame]

845

# };

846

#

847

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

Dan O'Meara

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

[diff] [blame]

848

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

Bu Sun Kim

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

[diff] [blame]

849

# var hexString = rgbNumber.toString(16);

850

# var missingZeros = 6 - hexString.length;

Bu Sun Kim

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

[diff] [blame]

851

# var resultBuilder = ['#'];

Dan O'Meara

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

[diff] [blame]

852

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

Bu Sun Kim

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

[diff] [blame]

853

# resultBuilder.push('0');

Bu Sun Kim

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

[diff] [blame]

854

# }

855

# resultBuilder.push(hexString);

Bu Sun Kim

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

[diff] [blame]

856

# return resultBuilder.join('');

Bu Sun Kim

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

[diff] [blame]

857

# };

858

#

859

# // ...

Bu Sun Kim

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

[diff] [blame]

860

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

861

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

862

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

863

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

864

# the final pixel color is defined by the equation:

865

#

866

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

867

#

868

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

869

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

870

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

871

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

872

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

873

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

874

},

Bu Sun Kim

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

[diff] [blame]

},

],

},

},

Bu Sun Kim

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

[diff] [blame]

879

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

Bu Sun Kim

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

[diff] [blame]

880

{ # Set of detected entity features.

Bu Sun Kim

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

[diff] [blame]

881

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

882

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

Bu Sun Kim

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

[diff] [blame]

883

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

884

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

885

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

886

# Location information is usually present for landmarks.

887

{ # Detected entity location information.

Bu Sun Kim

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

[diff] [blame]

888

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

889

# of doubles representing degrees latitude and degrees longitude. Unless

890

# specified otherwise, this must conform to the

Bu Sun Kim

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

[diff] [blame]

891

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

892

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

Bu Sun Kim

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

[diff] [blame]

893

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

894

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

895

},

896

},

897

],

Bu Sun Kim

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

[diff] [blame]

898

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

Bu Sun Kim

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

[diff] [blame]

899

# [Google Knowledge Graph Search

900

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

Bu Sun Kim

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

[diff] [blame]

901

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

902

# The accuracy of the entity detection in an image.

903

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

904

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

905

# image. Range [0, 1].

906

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

907

# for `LABEL_DETECTION` features.

Bu Sun Kim

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

[diff] [blame]

908

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

Bu Sun Kim

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

[diff] [blame]

909

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

910

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

911

# and range from 0 to 1.

Bu Sun Kim

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

[diff] [blame]

912

"y": 3.14, # Y coordinate.

913

"x": 3.14, # X coordinate.

Bu Sun Kim

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

[diff] [blame]

914

},

915

],

Bu Sun Kim

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

[diff] [blame]

916

"vertices": [ # The bounding polygon vertices.

Bu Sun Kim

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

[diff] [blame]

917

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

918

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

919

"y": 42, # Y coordinate.

920

"x": 42, # X coordinate.

Bu Sun Kim

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

[diff] [blame]

921

},

922

],

923

},

Bu Sun Kim

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

[diff] [blame]

924

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

925

# `description` is expressed.

Bu Sun Kim

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

[diff] [blame]

926

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

927

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

928

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

929

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

930

# detected distant towering building, even though the confidence that

931

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

932

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

933

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

934

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

935

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

936

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

937

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

938

},

939

],

Bu Sun Kim

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

[diff] [blame]

940

},

941

],

Bu Sun Kim

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

[diff] [blame]

942

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

943

# comes from.

944

# information about the source of that image.

Bu Sun Kim

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

[diff] [blame]

945

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

946

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

947

# the file used to produce the image.

Bu Sun Kim

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

[diff] [blame]

948

},

Bu Sun Kim

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

[diff] [blame]

949

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

950

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

951

{ # Metadata for online images.

952

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

953

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

954

},

955

],

956

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

957

# Inferred from similar images on the open web.

958

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

959

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

960

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

961

# For more information, see

962

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

963

},

964

],

965

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

966

# Can include resized copies of the query image.

967

{ # Metadata for online images.

968

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

969

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

970

},

971

],

972

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

973

{ # Entity deduced from similar images on the Internet.

974

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

975

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

976

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

977

# Not normalized and not comparable across different image queries.

978

},

979

],

980

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

981

{ # Metadata for web pages.

Bu Sun Kim

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

[diff] [blame]

982

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

983

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

984

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

985

# crops.

986

{ # Metadata for online images.

987

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

988

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

989

},

990

],

991

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

Bu Sun Kim

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

[diff] [blame]

992

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

993

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

994

# Can include resized copies of the query image.

995

{ # Metadata for online images.

996

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

997

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

998

},

999

],

1000

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

Bu Sun Kim

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

[diff] [blame]

1001

},

1002

],

1003

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

1004

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

1005

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

1006

{ # Metadata for online images.

1007

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

1008

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

Bu Sun Kim

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

[diff] [blame]

1009

},

1010

],

1011

},

Bu Sun Kim

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

[diff] [blame]

1012

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

1013

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

1014

# violence).

Bu Sun Kim

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

[diff] [blame]

1015

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

1016

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

1017

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

1018

# sexual activities.

1019

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

1020

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

1021

# funny or offensive.

Bu Sun Kim

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

[diff] [blame]

1022

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

1023

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

1024

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

1025

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

1026

# body areas.

Bu Sun Kim

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

[diff] [blame]

1027

},

Bu Sun Kim

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

[diff] [blame]

1028

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

1029

{ # Set of detected entity features.

1030

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

1031

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

1032

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

1033

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

1034

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

1035

# Location information is usually present for landmarks.

1036

{ # Detected entity location information.

1037

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

1038

# of doubles representing degrees latitude and degrees longitude. Unless

1039

# specified otherwise, this must conform to the

1040

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

1041

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

1042

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

1043

"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

1048

# [Google Knowledge Graph Search

1049

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

1050

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

1051

# The accuracy of the entity detection in an image.

1052

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

1053

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

1054

# image. Range [0, 1].

1055

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

1056

# for `LABEL_DETECTION` features.

1057

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

1058

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

1059

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

1060

# and range from 0 to 1.

1061

"y": 3.14, # Y coordinate.

1062

"x": 3.14, # X coordinate.

1063

},

1064

],

1065

"vertices": [ # The bounding polygon vertices.

1066

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

1067

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

1068

"y": 42, # Y coordinate.

1069

"x": 42, # X coordinate.

},

],

},

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

1074

# `description` is expressed.

1075

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

1076

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

1077

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

1078

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

1079

# detected distant towering building, even though the confidence that

1080

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

1081

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

1082

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

1083

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

1084

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

1085

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

1086

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

},

],

},

],

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

1092

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

1093

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

1094

"landmarks": [ # Detected face landmarks.

1095

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

1096

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

1097

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

1098

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

1099

"x": 3.14, # X coordinate.

1100

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

1101

"y": 3.14, # Y coordinate.

1102

},

1103

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

1104

},

1105

],

1106

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

1107

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

1108

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

1109

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

1110

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

1111

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

1112

# [-180,180].

1113

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

1114

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

1115

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

1116

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

1117

# are in the original image's scale.

1118

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

1119

# expectations. It is based on the landmarker results.

1120

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

1121

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

1122

# appears in the image to be annotated.

1123

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

1124

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

1125

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

1126

# and range from 0 to 1.

1127

"y": 3.14, # Y coordinate.

1128

"x": 3.14, # X coordinate.

1129

},

1130

],

1131

"vertices": [ # The bounding polygon vertices.

1132

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

1133

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

1134

"y": 42, # Y coordinate.

1135

"x": 42, # X coordinate.

},

],

},

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

1140

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

1141

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

1142

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

1143

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

1144

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

1145

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

1146

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

1147

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

1148

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

1149

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

1150

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

1151

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

1152

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

1153

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

1154

# and range from 0 to 1.

1155

"y": 3.14, # Y coordinate.

1156

"x": 3.14, # X coordinate.

1157

},

1158

],

1159

"vertices": [ # The bounding polygon vertices.

1160

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

1161

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

1162

"y": 42, # Y coordinate.

1163

"x": 42, # X coordinate.

},

],

},

},

],

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

1170

"cropHints": [ # Crop hint results.

1171

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

1172

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

1173

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

1174

# image.

1175

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

1176

# box are in the original image's scale.

1177

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

1178

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

1179

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

1180

# and range from 0 to 1.

1181

"y": 3.14, # Y coordinate.

1182

"x": 3.14, # X coordinate.

1183

},

1184

],

1185

"vertices": [ # The bounding polygon vertices.

1186

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

1187

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

1188

"y": 42, # Y coordinate.

1189

"x": 42, # X coordinate.

},

],

},

},

],

},

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

1197

{ # Set of detected entity features.

1198

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

1199

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

1200

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

1201

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

1202

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

1203

# Location information is usually present for landmarks.

1204

{ # Detected entity location information.

1205

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

1206

# of doubles representing degrees latitude and degrees longitude. Unless

1207

# specified otherwise, this must conform to the

1208

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

1209

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

1210

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

1211

"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

1216

# [Google Knowledge Graph Search

1217

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

1218

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

1219

# The accuracy of the entity detection in an image.

1220

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

1221

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

1222

# image. Range [0, 1].

1223

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

1224

# for `LABEL_DETECTION` features.

1225

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

1226

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

1227

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

1228

# and range from 0 to 1.

1229

"y": 3.14, # Y coordinate.

1230

"x": 3.14, # X coordinate.

1231

},

1232

],

1233

"vertices": [ # The bounding polygon vertices.

1234

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

1235

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

1236

"y": 42, # Y coordinate.

1237

"x": 42, # X coordinate.

},

],

},

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

1242

# `description` is expressed.

1243

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

1244

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

1245

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

1246

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

1247

# detected distant towering building, even though the confidence that

1248

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

1249

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

1250

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

1251

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

1252

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

1253

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

1254

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

},

],

},

],

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

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

1282

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

1283

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

1284

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

1285

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

1286

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

1287

# 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

1293

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

1294

# output files will begin with "filenameprefix".

Bu Sun Kim

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

[diff] [blame]

1295

#

1296

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

1297

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

1298

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

1299

# specified.

1300

#

1301

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

1302

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

1303

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

1304

# and overflows into multiple sharded files.

1305

},

Bu Sun Kim

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

[diff] [blame]

1306

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

1307

# Google Cloud Storage.

1308

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

1309

#

1310

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

1311

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

1312

# containing 20 response protos will be written under the prefix

1313

# `gcs_destination`.`uri`.

1314

#

1315

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

1316

# support for other output configurations.

Bu Sun Kim

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

[diff] [blame]

1317

},

Bu Sun Kim

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

[diff] [blame]

1318

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

Bu Sun Kim

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

[diff] [blame]

1319

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

1320

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

Bu Sun Kim

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

[diff] [blame]

1321

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

1322

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

Bu Sun Kim

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

[diff] [blame]

1323

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

1324

# representation, whereas JSON representations use base64.

Bu Sun Kim

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

[diff] [blame]

1325

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

1326

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

1327

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

Bu Sun Kim

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

[diff] [blame]

1328

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

1329

#

1330

# The Google Cloud Storage URI of the form

1331

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

1332

# [Google Cloud Storage Request

1333

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

Bu Sun Kim

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

[diff] [blame]

1334

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

Bu Sun Kim

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

[diff] [blame]

1335

#

1336

# 1. A Google Cloud Storage URI of the form

1337

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

1338

# [Google Cloud Storage Request

1339

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

1340

# info.

1341

#

1342

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

1343

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

1344

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

1345

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

1346

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

1347

# depend on externally-hosted images for production applications.

1348

#

1349

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

1350

# precedence.

1351

},

1352

},

Bu Sun Kim

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

[diff] [blame]

1353

"features": [ # Requested features.

Bu Sun Kim

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

[diff] [blame]

1354

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

1355

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

1356

# be specified in the `features` list.

Bu Sun Kim

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

[diff] [blame]

1357

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

1358

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

1359

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

Bu Sun Kim

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

[diff] [blame]

1360

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

1361

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

1362

# "builtin/latest".

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

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

1366

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

1367

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

1368

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

1369

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

1370

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

1371

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

1372

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

1373

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

1374

"A String",

1375

],

1376

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

1377

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

1378

},

1379

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

1380

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

1381

# of doubles representing degrees latitude and degrees longitude. Unless

1382

# specified otherwise, this must conform to the

1383

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

1384

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

1385

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

1386

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

1387

},

1388

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

1389

# of doubles representing degrees latitude and degrees longitude. Unless

1390

# specified otherwise, this must conform to the

1391

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

1392

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

1393

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

1394

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

1395

},

1396

},

1397

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

1398

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

1399

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

1400

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

1401

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

1402

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

Bu Sun Kim

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

[diff] [blame]

1408

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

1409

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

1410

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

1411

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

1412

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

1413

# and range from 0 to 1.

1414

"y": 3.14, # Y coordinate.

1415

"x": 3.14, # X coordinate.

1416

},

1417

],

1418

"vertices": [ # The bounding polygon vertices.

1419

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

1420

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

1421

"y": 42, # Y coordinate.

1422

"x": 42, # X coordinate.

},

],

},

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

1427

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

1428

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

1429

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

1430

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

1431

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

1432

# migrate existing products to these categories as well.

1433

"A String",

1434

],

Bu Sun Kim

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

[diff] [blame]

1435

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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1447

},

1448

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1449

},

1450

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1451

"parent": "A String", # Optional. Target project and location to make a call.

1452

#

1453

# Format: `projects/{project-id}/locations/{location-id}`.

1454

#

1455

# If no parent is specified, a region will be chosen automatically.

1456

#

1457

# Supported location-ids:

1458

# `us`: USA country only,

1459

# `asia`: East asia areas, like Japan, Taiwan,

1460

# `eu`: The European Union.

1461

#

1462

# Example: `projects/project-A/locations/eu`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1463

}

1464

1465

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1472

1473

{ # This resource represents a long-running operation that is the result of a

1474

# network API call.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1475

"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.

1476

# different programming environments, including REST APIs and RPC APIs. It is

1477

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

1478

# three pieces of data: error code, error message, and error details.

1479

#

1480

# You can find out more about this error model and how to work with it in the

1481

# [API Design Guide](https://cloud.google.com/apis/design/errors).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1482

"details": [ # A list of messages that carry the error details. There is a common set of

1483

# message types for APIs to use.

1484

{

1485

"a_key": "", # Properties of the object. Contains field @type with type URL.

1486

},

1487

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1488

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

1489

"message": "A String", # A developer-facing error message, which should be in English. Any

1490

# user-facing error message should be localized and sent in the

1491

# google.rpc.Status.details field, or localized by the client.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1492

},

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.

1500

# If `true`, the operation is completed, and either `error` or `response` is

1501

# available.

1502

"response": { # The normal response of the operation in case of success. If the original

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1503

# method returns no data on success, such as `Delete`, the response is

1504

# `google.protobuf.Empty`. If the original method is standard

1505

# `Get`/`Create`/`Update`, the response should be the resource. For other

1506

# methods, the response should have the type `XxxResponse`, where `Xxx`

1507

# is the original method name. For example, if the original method name

1508

# is `TakeSnapshot()`, the inferred response type is

1509

# `TakeSnapshotResponse`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1510

"a_key": "", # Properties of the object. Contains field @type with type URL.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1511

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1512

"name": "A String", # The server-assigned name, which is only unique within the same service that

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1513

# originally returns it. If you use the default HTTP mapping, the

1514

# `name` should be a resource name ending with `operations/{unique_id}`.

Bu Sun Kim