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

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

76

<h2>Instance Methods</h2>

77

78

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

79

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

80

81

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

82

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

83

<h3>Method Details</h3>

84

85

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

86

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

87

88

Args:

89

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

90

91

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

92

93

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

94

95

Supported location-ids:

96

`us`: USA country only,

97

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

98

`eu`: The European Union.

99

100

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

101

body: object, The request body.

102

The object takes the form of:

103

104

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

Bu Sun Kim

6502091

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

[diff] [blame]

105

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

106

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

107

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

108

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

109

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

110

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

111

# representation, whereas JSON representations use base64.

112

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

113

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

114

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

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

115

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

116

#

117

# The Google Cloud Storage URI of the form

118

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

119

# [Google Cloud Storage Request

120

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

Bu Sun Kim

6502091

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

[diff] [blame]

121

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

122

#

123

# 1. A Google Cloud Storage URI of the form

124

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

125

# [Google Cloud Storage Request

126

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

127

# info.

128

#

129

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

130

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

131

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

132

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

133

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

134

# depend on externally-hosted images for production applications.

135

#

136

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

137

# precedence.

Bu Sun Kim

6502091

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

[diff] [blame]

138

},

139

},

140

"features": [ # Requested features.

141

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

142

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

143

# be specified in the `features` list.

144

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

145

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

146

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

147

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

148

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

# "builtin/latest".

},

],

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

153

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

154

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

155

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

156

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

157

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

158

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

159

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

160

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

161

"A String",

162

],

163

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

164

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

165

},

166

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

167

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

168

# of doubles representing degrees latitude and degrees longitude. Unless

169

# specified otherwise, this must conform to the

170

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

171

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

172

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

173

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

174

},

175

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

176

# of doubles representing degrees latitude and degrees longitude. Unless

177

# specified otherwise, this must conform to the

178

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

179

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

180

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

181

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

182

},

183

},

184

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

185

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

186

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

187

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

188

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

189

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

# ignored.

3.14,

],

},

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

Bu Sun Kim

6502091

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

[diff] [blame]

195

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

196

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

197

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

198

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

199

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

200

# and range from 0 to 1.

201

"y": 3.14, # Y coordinate.

202

"x": 3.14, # X coordinate.

203

},

204

],

205

"vertices": [ # The bounding polygon vertices.

206

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

207

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

208

"y": 42, # Y coordinate.

209

"x": 42, # X coordinate.

},

],

},

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

214

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

215

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

216

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

217

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

218

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

219

# migrate existing products to these categories as well.

220

"A String",

221

],

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

222

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

223

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

224

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

225

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

226

#

227

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

228

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

229

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

230

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

231

#

232

# Format is:

233

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

Bu Sun Kim

6502091

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

[diff] [blame]

},

},

},

],

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

238

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

239

#

240

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

241

#

242

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

243

#

244

# Supported location-ids:

245

# `us`: USA country only,

246

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

247

# `eu`: The European Union.

248

#

249

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

Bu Sun Kim

6502091

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

[diff] [blame]

250

}

251

252

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

259

260

{ # Response to a batch image annotation request.

261

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

262

{ # Response to an image annotation request.

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

263

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

264

# This will be sorted descending by confidence score.

265

{ # Set of detected objects with bounding boxes.

266

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

267

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

Bu Sun Kim

6502091

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

[diff] [blame]

268

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

269

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

270

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

271

# and range from 0 to 1.

272

"y": 3.14, # Y coordinate.

273

"x": 3.14, # X coordinate.

274

},

275

],

276

"vertices": [ # The bounding polygon vertices.

277

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

278

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

279

"y": 42, # Y coordinate.

280

"x": 42, # X coordinate.

281

},

282

],

283

},

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

284

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

285

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

286

# information, see

287

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

288

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

Bu Sun Kim

6502091

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

[diff] [blame]

289

},

290

],

291

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

292

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

293

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

294

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

295

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

296

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

297

# image.

Bu Sun Kim

6502091

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

[diff] [blame]

298

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

299

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

300

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

301

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

302

# and range from 0 to 1.

303

"y": 3.14, # Y coordinate.

304

"x": 3.14, # X coordinate.

305

},

306

],

307

"vertices": [ # The bounding polygon vertices.

308

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

309

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

310

"y": 42, # Y coordinate.

311

"x": 42, # X coordinate.

},

],

},

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

316

{ # Information about a product.

317

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

318

# to the query.

319

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

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

320

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

321

#

322

# Format is:

323

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

324

#

325

# This field is ignored when creating a product.

Bu Sun Kim

6502091

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

[diff] [blame]

326

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

327

# 4096 characters long.

328

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

329

# characters long.

330

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

331

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

332

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

333

# not be used for new products.

334

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

335

# constraints can be specified based on the product_labels.

336

#

337

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

338

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

339

# to be supported soon.

340

#

341

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

342

# 500 product_labels.

343

#

344

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

345

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

346

# will refuse to work for that ProductSet.

347

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

348

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

349

# exceed 128 bytes.

350

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

351

# cannot exceed 128 bytes.

352

},

353

],

Bu Sun Kim

6502091

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

[diff] [blame]

354

},

355

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

356

# 1 (full confidence).

357

},

358

],

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

359

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

360

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

361

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

362

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

363

# information, see

364

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

365

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

366

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

367

},

368

],

Bu Sun Kim

6502091

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

[diff] [blame]

369

},

370

],

371

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

372

{ # Information about a product.

373

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

374

# to the query.

375

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

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

376

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

377

#

378

# Format is:

379

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

380

#

381

# This field is ignored when creating a product.

Bu Sun Kim

6502091

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

[diff] [blame]

382

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

383

# 4096 characters long.

384

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

385

# characters long.

386

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

387

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

388

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

389

# not be used for new products.

390

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

391

# constraints can be specified based on the product_labels.

392

#

393

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

394

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

395

# to be supported soon.

396

#

397

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

398

# 500 product_labels.

399

#

400

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

401

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

402

# will refuse to work for that ProductSet.

403

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

404

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

405

# exceed 128 bytes.

406

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

407

# cannot exceed 128 bytes.

408

},

409

],

Bu Sun Kim

6502091

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

[diff] [blame]

410

},

411

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

412

# 1 (full confidence).

413

},

414

],

415

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

416

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

417

# not reflected in the current results.

418

},

Bu Sun Kim

6502091

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

[diff] [blame]

419

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

420

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

421

# correct, even when `error` is set.

422

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

423

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

424

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

425

#

426

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

427

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

Bu Sun Kim

6502091

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

[diff] [blame]

428

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

429

# message types for APIs to use.

430

{

431

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

432

},

433

],

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

434

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

435

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

436

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

437

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

Bu Sun Kim

6502091

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

[diff] [blame]

438

},

439

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

440

# completed successfully.

441

# This annotation provides the structural hierarchy for the OCR detected

442

# text.

443

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

444

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

445

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

446

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

447

# to the TextAnnotation.TextProperty message definition below for more

448

# detail.

449

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

450

{ # Detected page from OCR.

Bu Sun Kim

6502091

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

[diff] [blame]

451

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

452

{ # Logical element on the page.

453

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

454

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

455

{ # Detected language for a structural component.

456

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

457

# information, see

458

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

459

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

460

},

461

],

462

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

463

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

464

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

465

},

466

},

467

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

468

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

469

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

470

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

471

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

472

# read in the 'natural' orientation.

473

# For example:

474

#

475

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

488

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

489

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

490

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

491

# and range from 0 to 1.

492

"y": 3.14, # Y coordinate.

493

"x": 3.14, # X coordinate.

494

},

495

],

496

"vertices": [ # The bounding polygon vertices.

497

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

498

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

499

"y": 42, # Y coordinate.

500

"x": 42, # X coordinate.

},

],

},

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

505

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

506

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

507

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

508

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

509

{ # Detected language for a structural component.

510

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

511

# information, see

512

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

513

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

514

},

515

],

516

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

517

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

518

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

519

},

520

},

521

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

522

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

523

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

524

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

525

# read in the 'natural' orientation.

526

# For example:

527

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

536

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

537

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

538

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

539

# and range from 0 to 1.

540

"y": 3.14, # Y coordinate.

541

"x": 3.14, # X coordinate.

542

},

543

],

544

"vertices": [ # The bounding polygon vertices.

545

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

546

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

547

"y": 42, # Y coordinate.

548

"x": 42, # X coordinate.

},

],

},

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

553

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

554

{ # A word representation.

555

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

556

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

557

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

558

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

559

# read in the 'natural' orientation.

560

# For example:

561

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

570

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

571

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

572

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

573

# and range from 0 to 1.

574

"y": 3.14, # Y coordinate.

575

"x": 3.14, # X coordinate.

576

},

577

],

578

"vertices": [ # The bounding polygon vertices.

579

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

580

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

581

"y": 42, # Y coordinate.

582

"x": 42, # X coordinate.

},

],

},

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

587

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

588

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

589

{ # A single symbol representation.

590

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

591

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

592

{ # Detected language for a structural component.

593

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

594

# information, see

595

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

596

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

597

},

598

],

599

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

600

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

601

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

602

},

603

},

604

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

605

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

606

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

607

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

608

# read in the 'natural' orientation.

609

# For example:

610

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

619

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

620

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

621

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

622

# and range from 0 to 1.

623

"y": 3.14, # Y coordinate.

624

"x": 3.14, # X coordinate.

625

},

626

],

627

"vertices": [ # The bounding polygon vertices.

628

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

629

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

630

"y": 42, # Y coordinate.

631

"x": 42, # X coordinate.

},

],

},

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

636

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

637

},

638

],

639

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

640

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

641

{ # Detected language for a structural component.

642

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

643

# information, see

644

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

645

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

646

},

647

],

648

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

649

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

650

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

},

},

},

],

},

],

},

],

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

660

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

661

{ # Detected language for a structural component.

662

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

663

# information, see

664

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

665

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

666

},

667

],

668

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

669

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

670

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

671

},

672

},

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

673

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

674

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

675

# TIFFs) the unit is pixels.

676

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

677

# TIFFs) the unit is pixels.

Bu Sun Kim

6502091

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

[diff] [blame]

678

},

679

],

680

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

681

},

682

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

683

{ # Set of detected entity features.

Bu Sun Kim

6502091

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

[diff] [blame]

684

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

685

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

686

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

687

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

688

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

689

# Location information is usually present for landmarks.

690

{ # Detected entity location information.

691

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

692

# of doubles representing degrees latitude and degrees longitude. Unless

693

# specified otherwise, this must conform to the

694

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

695

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

696

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

697

"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

702

# [Google Knowledge Graph Search

703

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

704

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

705

# The accuracy of the entity detection in an image.

706

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

707

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

708

# image. Range [0, 1].

709

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

710

# for `LABEL_DETECTION` features.

711

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

712

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

713

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

714

# and range from 0 to 1.

715

"y": 3.14, # Y coordinate.

716

"x": 3.14, # X coordinate.

717

},

718

],

719

"vertices": [ # The bounding polygon vertices.

720

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

721

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

722

"y": 42, # Y coordinate.

723

"x": 42, # X coordinate.

},

],

},

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

728

# `description` is expressed.

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

729

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

730

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

731

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

732

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

733

# detected distant towering building, even though the confidence that

734

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

735

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

736

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

737

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

738

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

739

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

740

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

741

},

742

],

Bu Sun Kim

6502091

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

[diff] [blame]

743

},

744

],

745

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

746

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

747

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

748

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

749

# the image that the color occupies in the image.

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

750

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

Bu Sun Kim

6502091

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

[diff] [blame]

751

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

752

# Value in range [0, 1].

753

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

754

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

755

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

756

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

757

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

758

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

759

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

760

#

761

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

762

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

763

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

# space.

#

# Example (Java):

#

# import com.google.type.Color;

769

#

770

# // ...

771

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

772

# float alpha = protocolor.hasAlpha()

773

# ? protocolor.getAlpha().getValue()

774

# : 1.0;

775

#

776

# return new java.awt.Color(

777

# protocolor.getRed(),

778

# protocolor.getGreen(),

779

# protocolor.getBlue(),

# alpha);

# }

#

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

784

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

785

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

786

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

787

# float denominator = 255.0;

788

# Color.Builder resultBuilder =

789

# Color

790

# .newBuilder()

791

# .setRed(red / denominator)

792

# .setGreen(green / denominator)

793

# .setBlue(blue / denominator);

794

# int alpha = color.getAlpha();

795

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

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

800

# .build());

801

# }

802

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

807

#

808

# // ...

809

# static UIColor* fromProto(Color* protocolor) {

810

# float red = [protocolor red];

811

# float green = [protocolor green];

812

# float blue = [protocolor blue];

813

# FloatValue* alpha_wrapper = [protocolor alpha];

814

# float alpha = 1.0;

815

# if (alpha_wrapper != nil) {

816

# alpha = [alpha_wrapper value];

817

# }

818

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

819

# }

820

#

821

# static Color* toProto(UIColor* color) {

822

# CGFloat red, green, blue, alpha;

823

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

824

# return nil;

825

# }

826

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

827

# [result setRed:red];

828

# [result setGreen:green];

829

# [result setBlue:blue];

830

# if (alpha <= 0.9999) {

831

# [result setAlpha:floatWrapperWithValue(alpha)];

832

# }

833

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

843

# var redFrac = rgb_color.red || 0.0;

844

# var greenFrac = rgb_color.green || 0.0;

845

# var blueFrac = rgb_color.blue || 0.0;

846

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

847

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

848

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

849

#

850

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

851

# return rgbToCssColor_(red, green, blue);

852

# }

853

#

854

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

855

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

856

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

857

# };

858

#

859

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

860

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

861

# var hexString = rgbNumber.toString(16);

862

# var missingZeros = 6 - hexString.length;

863

# var resultBuilder = ['#'];

864

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

865

# resultBuilder.push('0');

866

# }

867

# resultBuilder.push(hexString);

868

# return resultBuilder.join('');

# };

#

# // ...

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

873

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

874

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

875

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

876

# the final pixel color is defined by the equation:

877

#

878

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

879

#

880

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

881

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

882

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

883

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

884

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

885

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

886

},

Bu Sun Kim

6502091

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

[diff] [blame]

},

],

},

},

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

892

{ # Set of detected entity features.

Bu Sun Kim

6502091

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

[diff] [blame]

893

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

894

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

895

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

896

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

897

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

898

# Location information is usually present for landmarks.

899

{ # Detected entity location information.

900

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

901

# of doubles representing degrees latitude and degrees longitude. Unless

902

# specified otherwise, this must conform to the

903

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

904

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

905

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

906

"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

911

# [Google Knowledge Graph Search

912

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

913

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

914

# The accuracy of the entity detection in an image.

915

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

916

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

917

# image. Range [0, 1].

918

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

919

# for `LABEL_DETECTION` features.

920

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

921

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

922

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

923

# and range from 0 to 1.

924

"y": 3.14, # Y coordinate.

925

"x": 3.14, # X coordinate.

926

},

927

],

928

"vertices": [ # The bounding polygon vertices.

929

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

930

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

931

"y": 42, # Y coordinate.

932

"x": 42, # X coordinate.

},

],

},

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

937

# `description` is expressed.

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

938

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

939

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

940

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

941

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

942

# detected distant towering building, even though the confidence that

943

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

944

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

945

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

946

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

947

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

948

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

949

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

950

},

951

],

Bu Sun Kim

6502091

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

[diff] [blame]

952

},

953

],

954

"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

955

# comes from.

956

# information about the source of that image.

957

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

958

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

959

# the file used to produce the image.

960

},

961

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

962

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

963

{ # Metadata for online images.

964

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

965

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

966

},

967

],

968

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

969

# Inferred from similar images on the open web.

970

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

971

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

972

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

973

# For more information, see

974

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

975

},

976

],

977

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

978

# Can include resized copies of the query image.

979

{ # Metadata for online images.

980

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

981

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

982

},

983

],

984

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

985

{ # Entity deduced from similar images on the Internet.

986

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

987

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

988

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

989

# Not normalized and not comparable across different image queries.

990

},

991

],

992

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

993

{ # Metadata for web pages.

Bu Sun Kim

6502091

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

[diff] [blame]

994

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

995

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

996

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

997

# crops.

998

{ # Metadata for online images.

999

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

1000

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

1001

},

1002

],

1003

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

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

1004

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

1005

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

1006

# Can include resized copies of the query image.

1007

{ # Metadata for online images.

1008

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

1009

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

1010

},

1011

],

1012

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

Bu Sun Kim

6502091

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

[diff] [blame]

1013

},

1014

],

1015

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

1016

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

1017

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

1018

{ # Metadata for online images.

1019

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

1020

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

},

],

},

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

1025

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

1026

# violence).

Bu Sun Kim

6502091

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

[diff] [blame]

1027

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

1028

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

1029

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

1030

# sexual activities.

1031

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

1032

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

1033

# funny or offensive.

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

1034

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

1035

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

1036

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

1037

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

1038

# body areas.

Bu Sun Kim

6502091

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

[diff] [blame]

1039

},

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

1040

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

1041

{ # Set of detected entity features.

1042

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

1043

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

1044

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

1045

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

1046

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

1047

# Location information is usually present for landmarks.

1048

{ # Detected entity location information.

1049

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

1050

# of doubles representing degrees latitude and degrees longitude. Unless

1051

# specified otherwise, this must conform to the

1052

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

1053

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

1054

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

1055

"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

1060

# [Google Knowledge Graph Search

1061

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

1062

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

1063

# The accuracy of the entity detection in an image.

1064

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

1065

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

1066

# image. Range [0, 1].

1067

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

1068

# for `LABEL_DETECTION` features.

1069

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

1070

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

1071

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

1072

# and range from 0 to 1.

1073

"y": 3.14, # Y coordinate.

1074

"x": 3.14, # X coordinate.

1075

},

1076

],

1077

"vertices": [ # The bounding polygon vertices.

1078

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

1079

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

1080

"y": 42, # Y coordinate.

1081

"x": 42, # X coordinate.

},

],

},

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

1086

# `description` is expressed.

1087

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

1088

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

1089

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

1090

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

1091

# detected distant towering building, even though the confidence that

1092

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

1093

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

1094

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

1095

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

1096

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

1097

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

1098

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

},

],

},

],

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

1104

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

1105

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

1106

"landmarks": [ # Detected face landmarks.

1107

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

1108

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

1109

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

1110

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

1111

"x": 3.14, # X coordinate.

1112

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

1113

"y": 3.14, # Y coordinate.

1114

},

1115

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

1116

},

1117

],

1118

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

1119

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

1120

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

1121

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

1122

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

1123

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

1124

# [-180,180].

1125

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

1126

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

1127

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

1128

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

1129

# are in the original image's scale.

1130

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

1131

# expectations. It is based on the landmarker results.

1132

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

1133

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

1134

# appears in the image to be annotated.

1135

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

1136

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

1137

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

1138

# and range from 0 to 1.

1139

"y": 3.14, # Y coordinate.

1140

"x": 3.14, # X coordinate.

1141

},

1142

],

1143

"vertices": [ # The bounding polygon vertices.

1144

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

1145

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

1146

"y": 42, # Y coordinate.

1147

"x": 42, # X coordinate.

},

],

},

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

1152

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

1153

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

1154

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

1155

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

1156

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

1157

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

1158

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

1159

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

1160

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

1161

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

1162

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

1163

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

1164

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

1165

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

1166

# and range from 0 to 1.

1167

"y": 3.14, # Y coordinate.

1168

"x": 3.14, # X coordinate.

1169

},

1170

],

1171

"vertices": [ # The bounding polygon vertices.

1172

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

1173

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

1174

"y": 42, # Y coordinate.

1175

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

1182

"cropHints": [ # Crop hint results.

1183

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

1184

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

1185

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

1186

# image.

1187

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

1188

# box are in the original image's scale.

1189

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

1190

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

1191

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

1192

# and range from 0 to 1.

1193

"y": 3.14, # Y coordinate.

1194

"x": 3.14, # X coordinate.

1195

},

1196

],

1197

"vertices": [ # The bounding polygon vertices.

1198

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

1199

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

1200

"y": 42, # Y coordinate.

1201

"x": 42, # X coordinate.

},

],

},

},

],

},

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

1209

{ # Set of detected entity features.

1210

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

1211

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

1212

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

1213

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

1214

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

1215

# Location information is usually present for landmarks.

1216

{ # Detected entity location information.

1217

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

1218

# of doubles representing degrees latitude and degrees longitude. Unless

1219

# specified otherwise, this must conform to the

1220

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

1221

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

1222

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

1223

"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

1228

# [Google Knowledge Graph Search

1229

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

1230

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

1231

# The accuracy of the entity detection in an image.

1232

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

1233

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

1234

# image. Range [0, 1].

1235

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

1236

# for `LABEL_DETECTION` features.

1237

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

1238

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

1239

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

1240

# and range from 0 to 1.

1241

"y": 3.14, # Y coordinate.

1242

"x": 3.14, # X coordinate.

1243

},

1244

],

1245

"vertices": [ # The bounding polygon vertices.

1246

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

1247

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

1248

"y": 42, # Y coordinate.

1249

"x": 42, # X coordinate.

},

],

},

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

1254

# `description` is expressed.

1255

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

1256

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

1257

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

1258

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

1259

# detected distant towering building, even though the confidence that

1260

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

1261

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

1262

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

1263

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

1264

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

1265

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

1266

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

},

],

},

],

Bu Sun Kim

6502091

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

[diff] [blame]

},

],

}</pre>

</div>

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

1278

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

1279

1280

Progress and results can be retrieved through the

1281

`google.longrunning.Operations` interface.

1282

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

1283

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

1284

1285

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

1286

GCS bucket, each json file containing BatchAnnotateImagesResponse proto.

1287

1288

Args:

1289

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

1290

1291

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

1292

1293

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

1294

1295

Supported location-ids:

1296

`us`: USA country only,

1297

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

1298

`eu`: The European Union.

1299

1300

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

1301

body: object, The request body.

1302

The object takes the form of:

1303

1304

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

Bu Sun Kim

6502091

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

[diff] [blame]

1305

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

1306

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

1307

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

1308

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

1309

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

1310

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

1311

# 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

1317

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

1318

# output files will begin with "filenameprefix".

1319

#

1320

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

1321

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

1322

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

1323

# specified.

1324

#

1325

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

1326

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

1327

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

1328

# and overflows into multiple sharded files.

1329

},

1330

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

1331

# Google Cloud Storage.

1332

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

1333

#

1334

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

1335

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

1336

# containing 20 response protos will be written under the prefix

1337

# `gcs_destination`.`uri`.

1338

#

1339

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

1340

# support for other output configurations.

1341

},

1342

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

1343

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

1344

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

1345

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

1346

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

1347

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

1348

# representation, whereas JSON representations use base64.

1349

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

1350

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

1351

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

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

1352

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

1353

#

1354

# The Google Cloud Storage URI of the form

1355

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

1356

# [Google Cloud Storage Request

1357

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

Bu Sun Kim

6502091

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

[diff] [blame]

1358

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

1359

#

1360

# 1. A Google Cloud Storage URI of the form

1361

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

1362

# [Google Cloud Storage Request

1363

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

1364

# info.

1365

#

1366

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

1367

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

1368

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

1369

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

1370

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

1371

# depend on externally-hosted images for production applications.

1372

#

1373

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

1374

# precedence.

Bu Sun Kim

6502091

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

[diff] [blame]

1375

},

1376

},

1377

"features": [ # Requested features.

1378

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

1379

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

1380

# be specified in the `features` list.

1381

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

1382

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

1383

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

1384

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

1385

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

# "builtin/latest".

},

],

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

1390

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

1391

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

1392

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

1393

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

1394

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

1395

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

1396

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

1397

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

1398

"A String",

1399

],

1400

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

1401

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

1402

},

1403

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

1404

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

1405

# of doubles representing degrees latitude and degrees longitude. Unless

1406

# specified otherwise, this must conform to the

1407

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

1408

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

1409

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

1410

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

1411

},

1412

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

1413

# of doubles representing degrees latitude and degrees longitude. Unless

1414

# specified otherwise, this must conform to the

1415

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

1416

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

1417

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

1418

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

1419

},

1420

},

1421

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

1422

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

1423

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

1424

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

1425

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

1426

# 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

6502091

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

[diff] [blame]

1432

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

1433

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

1434

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

1435

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

1436

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

1437

# and range from 0 to 1.

1438

"y": 3.14, # Y coordinate.

1439

"x": 3.14, # X coordinate.

1440

},

1441

],

1442

"vertices": [ # The bounding polygon vertices.

1443

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

1444

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

1445

"y": 42, # Y coordinate.

1446

"x": 42, # X coordinate.

},

],

},

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

1451

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

1452

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

1453

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

1454

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

1455

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

1456

# migrate existing products to these categories as well.

1457

"A String",

1458

],

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

1459

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

1460

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

1461

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

1462

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

1463

#

1464

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

1465

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

1466

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

1467

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

1468

#

1469

# Format is:

1470

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

Bu Sun Kim

6502091

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

[diff] [blame]

},

},

},

],

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

1475

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

1476

#

1477

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

1478

#

1479

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

1480

#

1481

# Supported location-ids:

1482

# `us`: USA country only,

1483

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

1484

# `eu`: The European Union.

1485

#

1486

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

Bu Sun Kim

6502091

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

[diff] [blame]

1487

}

1488

1489

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1496

1497

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

1498

# network API call.

1499

"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.

1500

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

1501

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

1502

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

1503

#

1504

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

1505

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

Bu Sun Kim

6502091

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

[diff] [blame]

1506

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

1507

# message types for APIs to use.

1508

{

1509

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

1510

},

1511

],

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

1512

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

1513

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

1514

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

1515

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

Bu Sun Kim

6502091

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

[diff] [blame]

1516

},

1517

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

1518

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

1519

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

1520

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

1521

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

1522

},

1523

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

1524

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

1525

# available.

1526

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

1527

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

1528

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

1529

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

1530

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

1531

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

1532

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

1533

# `TakeSnapshotResponse`.

1534

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

1535

},

1536

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

1537

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

1538

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

}</pre>

</div>

</body></html>