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

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.

Bu Sun Kim

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

[diff] [blame^]

108

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

109

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

110

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

111

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

112

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

113

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

114

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

115

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

116

# migrate existing products to these categories as well.

117

"A String",

118

],

119

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

120

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

121

"vertices": [ # The bounding polygon vertices.

122

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

123

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

124

"y": 42, # Y coordinate.

125

"x": 42, # X coordinate.

126

},

127

],

128

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

129

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

130

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

131

# and range from 0 to 1.

132

"x": 3.14, # X coordinate.

133

"y": 3.14, # Y coordinate.

},

],

},

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

138

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

139

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

140

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

141

#

142

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

143

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

144

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

145

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

146

#

147

# Format is:

148

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

149

},

150

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

151

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

152

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

153

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

154

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

155

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

# ignored.

3.14,

],

},

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

161

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

162

},

163

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

164

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

165

# of doubles representing degrees latitude and degrees longitude. Unless

166

# specified otherwise, this must conform to the

167

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

168

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

169

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

170

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

171

},

172

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

173

# of doubles representing degrees latitude and degrees longitude. Unless

174

# specified otherwise, this must conform to the

175

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

176

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

177

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

178

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

179

},

180

},

181

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

182

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

183

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

184

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

185

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

186

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

187

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

188

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

"A String",

],

},

"features": [ # Requested features.

193

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

194

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

195

# be specified in the `features` list.

196

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

197

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

198

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

199

# "builtin/latest".

200

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

201

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

202

},

203

],

Bu Sun Kim

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

[diff] [blame]

204

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

205

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

206

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

207

# representation, whereas JSON representations use base64.

Bu Sun Kim

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

[diff] [blame^]

208

#

209

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

210

# not work for AsyncBatchAnnotateImages requests.

Bu Sun Kim

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

[diff] [blame]

211

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

212

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

213

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

214

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

215

#

216

# 1. A Google Cloud Storage URI of the form

217

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

218

# [Google Cloud Storage Request

219

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

220

# info.

221

#

222

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

223

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

224

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

225

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

226

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

227

# depend on externally-hosted images for production applications.

228

#

229

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

230

# precedence.

Bu Sun Kim

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

[diff] [blame^]

231

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

Bu Sun Kim

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

[diff] [blame]

232

#

Bu Sun Kim

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

[diff] [blame^]

233

# The Google Cloud Storage URI of the form

234

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

235

# [Google Cloud Storage Request

236

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

Bu Sun Kim

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

[diff] [blame]

},

},

},

],

Bu Sun Kim

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

[diff] [blame]

241

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

242

#

243

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

244

#

245

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

246

#

247

# Supported location-ids:

248

# `us`: USA country only,

249

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

250

# `eu`: The European Union.

251

#

252

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

Bu Sun Kim

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

[diff] [blame]

253

}

254

255

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

262

263

{ # Response to a batch image annotation request.

264

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

265

{ # Response to an image annotation request.

Bu Sun Kim

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

[diff] [blame]

266

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

267

# completed successfully.

268

# This annotation provides the structural hierarchy for the OCR detected

269

# text.

270

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

271

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

272

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

273

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

274

# to the TextAnnotation.TextProperty message definition below for more

275

# detail.

276

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

277

{ # Detected page from OCR.

Bu Sun Kim

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

[diff] [blame^]

278

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

Bu Sun Kim

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

[diff] [blame]

279

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

280

{ # Logical element on the page.

Bu Sun Kim

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

[diff] [blame]

281

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

282

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

283

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

284

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

285

# read in the 'natural' orientation.

286

# For example:

287

#

288

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

Bu Sun Kim

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

[diff] [blame]

301

"vertices": [ # The bounding polygon vertices.

302

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

303

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

304

"y": 42, # Y coordinate.

305

"x": 42, # X coordinate.

306

},

307

],

Bu Sun Kim

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

[diff] [blame^]

308

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

309

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

310

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

311

# and range from 0 to 1.

312

"x": 3.14, # X coordinate.

313

"y": 3.14, # Y coordinate.

314

},

315

],

Bu Sun Kim

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

[diff] [blame]

316

},

317

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

318

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

319

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

Bu Sun Kim

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

[diff] [blame]

320

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

321

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

322

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

323

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

324

# read in the 'natural' orientation.

325

# For example:

326

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

Bu Sun Kim

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

[diff] [blame]

335

"vertices": [ # The bounding polygon vertices.

336

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

337

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

338

"y": 42, # Y coordinate.

339

"x": 42, # X coordinate.

340

},

341

],

Bu Sun Kim

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

[diff] [blame^]

342

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

343

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

344

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

345

# and range from 0 to 1.

346

"x": 3.14, # X coordinate.

347

"y": 3.14, # Y coordinate.

348

},

349

],

Bu Sun Kim

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

[diff] [blame]

350

},

Bu Sun Kim

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

[diff] [blame]

351

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

352

{ # A word representation.

Bu Sun Kim

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

[diff] [blame^]

353

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

354

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

355

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

356

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

357

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

358

},

359

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

360

{ # Detected language for a structural component.

361

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

362

# information, see

363

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

364

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

365

},

366

],

367

},

Bu Sun Kim

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

[diff] [blame]

368

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

369

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

370

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

371

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

372

# read in the 'natural' orientation.

373

# For example:

374

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

Bu Sun Kim

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

[diff] [blame]

383

"vertices": [ # The bounding polygon vertices.

384

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

385

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

386

"y": 42, # Y coordinate.

387

"x": 42, # X coordinate.

388

},

389

],

Bu Sun Kim

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

[diff] [blame^]

390

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

391

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

392

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

393

# and range from 0 to 1.

394

"x": 3.14, # X coordinate.

395

"y": 3.14, # Y coordinate.

396

},

397

],

Bu Sun Kim

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

[diff] [blame]

398

},

Bu Sun Kim

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

[diff] [blame]

399

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

400

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

401

{ # A single symbol representation.

Bu Sun Kim

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

[diff] [blame^]

402

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

Bu Sun Kim

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

[diff] [blame]

403

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

Bu Sun Kim

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

[diff] [blame^]

404

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

405

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

406

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

407

},

Bu Sun Kim

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

[diff] [blame]

408

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

409

{ # Detected language for a structural component.

410

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

411

# information, see

412

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

413

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

414

},

415

],

Bu Sun Kim

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

[diff] [blame]

416

},

417

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

418

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

419

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

420

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

421

# read in the 'natural' orientation.

422

# For example:

423

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

Bu Sun Kim

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

[diff] [blame]

432

"vertices": [ # The bounding polygon vertices.

433

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

434

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

435

"y": 42, # Y coordinate.

436

"x": 42, # X coordinate.

437

},

438

],

Bu Sun Kim

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

[diff] [blame^]

439

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

440

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

441

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

442

# and range from 0 to 1.

443

"x": 3.14, # X coordinate.

444

"y": 3.14, # Y coordinate.

445

},

446

],

Bu Sun Kim

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

[diff] [blame]

447

},

Bu Sun Kim

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

[diff] [blame]

448

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

449

},

450

],

Bu Sun Kim

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

[diff] [blame]

451

},

452

],

Bu Sun Kim

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

[diff] [blame^]

453

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

454

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

455

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

456

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

457

},

458

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

459

{ # Detected language for a structural component.

460

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

461

# information, see

462

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

463

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

},

],

},

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

Bu Sun Kim

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

[diff] [blame]

468

},

469

],

Bu Sun Kim

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

[diff] [blame^]

470

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

471

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

472

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

473

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

474

},

475

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

476

{ # Detected language for a structural component.

477

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

478

# information, see

479

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

480

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

},

],

},

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

Bu Sun Kim

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

[diff] [blame]

485

},

486

],

487

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

Bu Sun Kim

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

[diff] [blame^]

488

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

489

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

490

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

491

},

Bu Sun Kim

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

[diff] [blame]

492

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

493

{ # Detected language for a structural component.

494

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

495

# information, see

496

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

497

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

498

},

499

],

Bu Sun Kim

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

[diff] [blame]

500

},

Bu Sun Kim

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

[diff] [blame]

501

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

502

# TIFFs) the unit is pixels.

503

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

504

# TIFFs) the unit is pixels.

Bu Sun Kim

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

[diff] [blame]

505

},

506

],

507

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

508

},

Bu Sun Kim

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

[diff] [blame^]

509

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

510

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

511

# correct, even when `error` is set.

512

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

513

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

514

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

515

#

516

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

517

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

518

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

519

# message types for APIs to use.

520

{

521

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

522

},

523

],

524

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

525

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

526

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

527

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

528

},

Bu Sun Kim

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

[diff] [blame]

529

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

530

{ # Set of detected entity features.

Bu Sun Kim

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

[diff] [blame]

531

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

532

# `description` is expressed.

Bu Sun Kim

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

[diff] [blame]

533

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

534

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

535

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

536

# detected distant towering building, even though the confidence that

537

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

538

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

539

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

540

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

541

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

542

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

543

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

544

},

545

],

Bu Sun Kim

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

[diff] [blame^]

546

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

547

# [Google Knowledge Graph Search

548

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

549

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

550

# The accuracy of the entity detection in an image.

551

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

552

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

553

# image. Range [0, 1].

554

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

555

# for `LABEL_DETECTION` features.

556

"vertices": [ # The bounding polygon vertices.

557

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

558

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

559

"y": 42, # Y coordinate.

560

"x": 42, # X coordinate.

561

},

562

],

563

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

564

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

565

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

566

# and range from 0 to 1.

567

"x": 3.14, # X coordinate.

568

"y": 3.14, # Y coordinate.

},

],

},

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

573

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

574

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

575

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

576

# Location information is usually present for landmarks.

577

{ # Detected entity location information.

578

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

579

# of doubles representing degrees latitude and degrees longitude. Unless

580

# specified otherwise, this must conform to the

581

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

582

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

583

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

584

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

},

},

],

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

589

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

Bu Sun Kim

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

[diff] [blame]

590

},

591

],

Bu Sun Kim

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

[diff] [blame^]

592

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

593

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

594

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

595

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

596

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

597

# [-180,180].

598

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

599

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

600

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

601

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

602

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

603

# are in the original image's scale.

604

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

605

# expectations. It is based on the landmarker results.

606

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

607

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

608

# appears in the image to be annotated.

609

"vertices": [ # The bounding polygon vertices.

610

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

611

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

612

"y": 42, # Y coordinate.

613

"x": 42, # X coordinate.

614

},

615

],

616

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

617

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

618

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

619

# and range from 0 to 1.

620

"x": 3.14, # X coordinate.

621

"y": 3.14, # Y coordinate.

},

],

},

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

626

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

627

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

628

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

629

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

630

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

631

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

632

"vertices": [ # The bounding polygon vertices.

633

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

634

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

635

"y": 42, # Y coordinate.

636

"x": 42, # X coordinate.

637

},

638

],

639

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

640

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

641

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

642

# and range from 0 to 1.

643

"x": 3.14, # X coordinate.

644

"y": 3.14, # Y coordinate.

},

],

},

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

649

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

650

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

651

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

652

"landmarks": [ # Detected face landmarks.

653

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

654

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

655

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

656

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

657

"x": 3.14, # X coordinate.

658

"y": 3.14, # Y coordinate.

659

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

660

},

661

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

662

},

663

],

664

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

665

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

666

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

667

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

668

},

669

],

670

"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

671

# comes from.

672

# information about the source of that image.

673

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

674

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

675

# the file used to produce the image.

676

},

Bu Sun Kim

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

[diff] [blame]

677

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

678

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

679

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

680

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

681

# the image that the color occupies in the image.

682

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

683

# Value in range [0, 1].

Bu Sun Kim

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

[diff] [blame^]

684

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

685

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

686

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

687

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

688

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

689

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

690

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

691

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

692

#

693

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

694

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

695

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

696

# space.

697

#

Bu Sun Kim

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

[diff] [blame^]

698

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

699

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

700

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

701

#

Bu Sun Kim

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

[diff] [blame]

702

# Example (Java):

703

#

704

# import com.google.type.Color;

705

#

706

# // ...

707

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

708

# float alpha = protocolor.hasAlpha()

709

# ? protocolor.getAlpha().getValue()

710

# : 1.0;

711

#

712

# return new java.awt.Color(

713

# protocolor.getRed(),

714

# protocolor.getGreen(),

715

# protocolor.getBlue(),

# alpha);

# }

#

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

720

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

721

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

722

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

723

# float denominator = 255.0;

724

# Color.Builder resultBuilder =

725

# Color

726

# .newBuilder()

727

# .setRed(red / denominator)

728

# .setGreen(green / denominator)

729

# .setBlue(blue / denominator);

730

# int alpha = color.getAlpha();

731

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

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

736

# .build());

737

# }

738

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

743

#

744

# // ...

745

# static UIColor* fromProto(Color* protocolor) {

746

# float red = [protocolor red];

747

# float green = [protocolor green];

748

# float blue = [protocolor blue];

749

# FloatValue* alpha_wrapper = [protocolor alpha];

750

# float alpha = 1.0;

751

# if (alpha_wrapper != nil) {

752

# alpha = [alpha_wrapper value];

753

# }

754

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

755

# }

756

#

757

# static Color* toProto(UIColor* color) {

758

# CGFloat red, green, blue, alpha;

759

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

760

# return nil;

761

# }

762

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

763

# [result setRed:red];

764

# [result setGreen:green];

765

# [result setBlue:blue];

766

# if (alpha <= 0.9999) {

767

# [result setAlpha:floatWrapperWithValue(alpha)];

768

# }

769

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

779

# var redFrac = rgb_color.red || 0.0;

780

# var greenFrac = rgb_color.green || 0.0;

781

# var blueFrac = rgb_color.blue || 0.0;

782

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

783

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

784

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

785

#

786

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

787

# return rgbToCssColor_(red, green, blue);

788

# }

789

#

790

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

791

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

792

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

793

# };

794

#

795

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

796

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

797

# var hexString = rgbNumber.toString(16);

798

# var missingZeros = 6 - hexString.length;

799

# var resultBuilder = ['#'];

800

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

801

# resultBuilder.push('0');

802

# }

803

# resultBuilder.push(hexString);

804

# return resultBuilder.join('');

805

# };

806

#

807

# // ...

Bu Sun Kim

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

[diff] [blame]

808

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

Bu Sun Kim

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

[diff] [blame^]

809

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

810

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

Bu Sun Kim

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

[diff] [blame]

811

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

812

# the final pixel color is defined by the equation:

813

#

814

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

815

#

816

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

817

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

818

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

819

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

820

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

821

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

822

},

Bu Sun Kim

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

[diff] [blame]

},

],

},

},

Bu Sun Kim

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

[diff] [blame]

827

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

828

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

829

{ # Metadata for online images.

Bu Sun Kim

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

[diff] [blame]

830

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

Bu Sun Kim

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

[diff] [blame^]

831

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

Bu Sun Kim

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

[diff] [blame]

832

},

833

],

834

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

835

# Inferred from similar images on the open web.

836

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

837

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

838

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

839

# For more information, see

840

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

841

},

842

],

843

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

844

# Can include resized copies of the query image.

845

{ # Metadata for online images.

Bu Sun Kim

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

[diff] [blame]

846

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

Bu Sun Kim

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

[diff] [blame^]

847

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

Bu Sun Kim

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

[diff] [blame]

848

},

849

],

850

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

851

{ # Entity deduced from similar images on the Internet.

Bu Sun Kim

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

[diff] [blame]

852

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

Bu Sun Kim

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

[diff] [blame^]

853

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

Bu Sun Kim

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

[diff] [blame]

854

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

855

# Not normalized and not comparable across different image queries.

856

},

857

],

Bu Sun Kim

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

[diff] [blame]

858

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

859

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

860

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

861

{ # Metadata for online images.

Bu Sun Kim

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

[diff] [blame]

862

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

Bu Sun Kim

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

[diff] [blame^]

863

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

864

},

865

],

866

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

867

{ # Metadata for web pages.

868

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

869

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

870

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

871

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

872

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

873

# crops.

874

{ # Metadata for online images.

875

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

876

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

877

},

878

],

879

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

880

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

881

# Can include resized copies of the query image.

882

{ # Metadata for online images.

883

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

884

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

885

},

886

],

Bu Sun Kim

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

[diff] [blame]

887

},

888

],

889

},

Bu Sun Kim

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

[diff] [blame]

890

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

891

{ # Set of detected entity features.

Bu Sun Kim

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

[diff] [blame]

892

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

893

# `description` is expressed.

Bu Sun Kim

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

[diff] [blame]

894

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

895

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

896

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

897

# detected distant towering building, even though the confidence that

898

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

899

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

900

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

901

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

902

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

903

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

904

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

905

},

906

],

Bu Sun Kim

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

[diff] [blame^]

907

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

908

# [Google Knowledge Graph Search

909

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

910

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

911

# The accuracy of the entity detection in an image.

912

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

913

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

914

# image. Range [0, 1].

915

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

916

# for `LABEL_DETECTION` features.

917

"vertices": [ # The bounding polygon vertices.

918

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

919

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

920

"y": 42, # Y coordinate.

921

"x": 42, # X coordinate.

922

},

923

],

924

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

925

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

926

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

927

# and range from 0 to 1.

Bu Sun Kim

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

[diff] [blame]

928

"x": 3.14, # X coordinate.

Bu Sun Kim

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

[diff] [blame]

929

"y": 3.14, # Y coordinate.

930

},

Bu Sun Kim

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

[diff] [blame^]

931

],

932

},

933

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

934

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

935

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

936

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

937

# Location information is usually present for landmarks.

938

{ # Detected entity location information.

939

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

940

# of doubles representing degrees latitude and degrees longitude. Unless

941

# specified otherwise, this must conform to the

942

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

943

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

944

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

945

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

946

},

Bu Sun Kim

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

[diff] [blame]

947

},

948

],

Bu Sun Kim

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

[diff] [blame^]

949

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

950

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

Bu Sun Kim

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

[diff] [blame]

951

},

952

],

953

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

954

"cropHints": [ # Crop hint results.

955

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

Bu Sun Kim

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

[diff] [blame]

956

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

957

# box are in the original image's scale.

Bu Sun Kim

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

[diff] [blame]

958

"vertices": [ # The bounding polygon vertices.

959

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

960

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

961

"y": 42, # Y coordinate.

962

"x": 42, # X coordinate.

963

},

964

],

Bu Sun Kim

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

[diff] [blame^]

965

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

966

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

967

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

968

# and range from 0 to 1.

969

"x": 3.14, # X coordinate.

970

"y": 3.14, # Y coordinate.

971

},

972

],

Bu Sun Kim

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

[diff] [blame]

973

},

Bu Sun Kim

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

[diff] [blame^]

974

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

975

# image.

976

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

Bu Sun Kim

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

[diff] [blame]

977

},

978

],

979

},

Bu Sun Kim

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

[diff] [blame^]

980

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

Bu Sun Kim

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

[diff] [blame]

981

{ # Set of detected entity features.

Bu Sun Kim

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

[diff] [blame]

982

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

983

# `description` is expressed.

Bu Sun Kim

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

[diff] [blame]

984

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

985

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

986

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

987

# detected distant towering building, even though the confidence that

988

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

989

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

990

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

991

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

992

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

993

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

994

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

995

},

996

],

Bu Sun Kim

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

[diff] [blame^]

997

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

998

# [Google Knowledge Graph Search

999

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

1000

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

1001

# The accuracy of the entity detection in an image.

1002

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

1003

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

1004

# image. Range [0, 1].

1005

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

1006

# for `LABEL_DETECTION` features.

1007

"vertices": [ # The bounding polygon vertices.

1008

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

1009

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

1010

"y": 42, # Y coordinate.

1011

"x": 42, # X coordinate.

1012

},

1013

],

1014

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

1015

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

1016

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

1017

# and range from 0 to 1.

1018

"x": 3.14, # X coordinate.

1019

"y": 3.14, # Y coordinate.

},

],

},

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

1024

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

1025

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

1026

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

1027

# Location information is usually present for landmarks.

1028

{ # Detected entity location information.

1029

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

1030

# of doubles representing degrees latitude and degrees longitude. Unless

1031

# specified otherwise, this must conform to the

1032

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

1033

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

1034

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

1035

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

},

},

],

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

1040

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

Bu Sun Kim

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

[diff] [blame]

1041

},

1042

],

Bu Sun Kim

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

[diff] [blame^]

1043

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

1044

# This will be sorted descending by confidence score.

1045

{ # Set of detected objects with bounding boxes.

1046

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

1047

"vertices": [ # The bounding polygon vertices.

1048

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

1049

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

1050

"y": 42, # Y coordinate.

1051

"x": 42, # X coordinate.

1052

},

1053

],

1054

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

1055

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

1056

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

1057

# and range from 0 to 1.

1058

"x": 3.14, # X coordinate.

1059

"y": 3.14, # Y coordinate.

},

],

},

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

1064

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

1065

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

1066

# information, see

1067

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

1068

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

1069

},

1070

],

1071

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

1072

{ # Set of detected entity features.

1073

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

1074

# `description` is expressed.

1075

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

1076

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

1077

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

1078

# detected distant towering building, even though the confidence that

1079

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

1080

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

1081

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

1082

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

1083

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

1084

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

1085

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

1086

},

1087

],

1088

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

1089

# [Google Knowledge Graph Search

1090

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

1091

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

1092

# The accuracy of the entity detection in an image.

1093

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

1094

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

1095

# image. Range [0, 1].

1096

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

1097

# for `LABEL_DETECTION` features.

1098

"vertices": [ # The bounding polygon vertices.

1099

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

1100

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

1101

"y": 42, # Y coordinate.

1102

"x": 42, # X coordinate.

1103

},

1104

],

1105

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

1106

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

1107

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

1108

# and range from 0 to 1.

1109

"x": 3.14, # X coordinate.

1110

"y": 3.14, # Y coordinate.

},

],

},

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

1115

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

1116

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

1117

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

1118

# Location information is usually present for landmarks.

1119

{ # Detected entity location information.

1120

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

1121

# of doubles representing degrees latitude and degrees longitude. Unless

1122

# specified otherwise, this must conform to the

1123

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

1124

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

1125

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

1126

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

},

},

],

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

1131

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

1132

},

1133

],

1134

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

1135

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

1136

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

1137

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

1138

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

1139

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

1140

# image.

1141

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

1142

"vertices": [ # The bounding polygon vertices.

1143

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

1144

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

1145

"y": 42, # Y coordinate.

1146

"x": 42, # X coordinate.

1147

},

1148

],

1149

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

1150

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

1151

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

1152

# and range from 0 to 1.

1153

"x": 3.14, # X coordinate.

1154

"y": 3.14, # Y coordinate.

},

],

},

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

1159

{ # Information about a product.

1160

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

1161

# to the query.

1162

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

1163

# 1 (full confidence).

1164

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

1165

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

1166

# 4096 characters long.

1167

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

1168

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

1169

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

1170

# not be used for new products.

1171

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

1172

# constraints can be specified based on the product_labels.

1173

#

1174

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

1175

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

1176

# to be supported soon.

1177

#

1178

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

1179

# 500 product_labels.

1180

#

1181

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

1182

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

1183

# will refuse to work for that ProductSet.

1184

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

1185

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

1186

# exceed 128 bytes.

1187

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

1188

# cannot exceed 128 bytes.

1189

},

1190

],

1191

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

1192

#

1193

# Format is:

1194

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

1195

#

1196

# This field is ignored when creating a product.

1197

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

# characters long.

},

},

],

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

1203

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

1204

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

1205

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

1206

# information, see

1207

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

1208

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

1209

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

},

],

},

],

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

1215

{ # Information about a product.

1216

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

1217

# to the query.

1218

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

1219

# 1 (full confidence).

1220

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

1221

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

1222

# 4096 characters long.

1223

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

1224

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

1225

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

1226

# not be used for new products.

1227

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

1228

# constraints can be specified based on the product_labels.

1229

#

1230

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

1231

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

1232

# to be supported soon.

1233

#

1234

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

1235

# 500 product_labels.

1236

#

1237

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

1238

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

1239

# will refuse to work for that ProductSet.

1240

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

1241

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

1242

# exceed 128 bytes.

1243

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

1244

# cannot exceed 128 bytes.

1245

},

1246

],

1247

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

1248

#

1249

# Format is:

1250

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

1251

#

1252

# This field is ignored when creating a product.

1253

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

# characters long.

},

},

],

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

1259

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

1260

# not reflected in the current results.

1261

},

1262

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

1263

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

1264

# violence).

1265

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

1266

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

1267

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

1268

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

1269

# body areas.

1270

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

1271

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

1272

# funny or offensive.

1273

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

1274

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

1275

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

1276

# sexual activities.

1277

},

Bu Sun Kim

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

[diff] [blame]

},

],

}</pre>

</div>

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

1285

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

1286

1287

Progress and results can be retrieved through the

1288

`google.longrunning.Operations` interface.

1289

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

1290

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

1291

1292

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

1293

GCS bucket, each json file containing BatchAnnotateImagesResponse proto.

1294

1295

Args:

1296

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

1297

1298

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

1299

1300

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

1301

1302

Supported location-ids:

1303

`us`: USA country only,

1304

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

1305

`eu`: The European Union.

1306

1307

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

1308

body: object, The request body.

1309

The object takes the form of:

1310

1311

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

Bu Sun Kim

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

[diff] [blame^]

1312

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

1313

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

1314

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

1315

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

1316

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

1317

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

1318

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

1319

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

1320

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

1321

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

1322

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

1323

# migrate existing products to these categories as well.

1324

"A String",

1325

],

1326

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

1327

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

1328

"vertices": [ # The bounding polygon vertices.

1329

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

1330

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

1331

"y": 42, # Y coordinate.

1332

"x": 42, # X coordinate.

1333

},

1334

],

1335

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

1336

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

1337

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

1338

# and range from 0 to 1.

1339

"x": 3.14, # X coordinate.

1340

"y": 3.14, # Y coordinate.

},

],

},

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

1345

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

1346

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

1347

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

1348

#

1349

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

1350

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

1351

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

1352

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

1353

#

1354

# Format is:

1355

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

1356

},

1357

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

1358

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

1359

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

1360

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

1361

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

1362

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

# ignored.

3.14,

],

},

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

1368

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

1369

},

1370

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

1371

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

1372

# of doubles representing degrees latitude and degrees longitude. Unless

1373

# specified otherwise, this must conform to the

1374

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

1375

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

1376

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

1377

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

1378

},

1379

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

1380

# of doubles representing degrees latitude and degrees longitude. Unless

1381

# specified otherwise, this must conform to the

1382

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

1383

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

1384

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

1385

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

1386

},

1387

},

1388

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

1389

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

1390

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

1391

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

1392

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

1393

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

1394

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

1395

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

"A String",

],

},

"features": [ # Requested features.

1400

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

1401

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

1402

# be specified in the `features` list.

1403

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

1404

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

1405

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

1406

# "builtin/latest".

1407

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

1408

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

1409

},

1410

],

1411

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

1412

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

1413

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

1414

# representation, whereas JSON representations use base64.

1415

#

1416

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

1417

# not work for AsyncBatchAnnotateImages requests.

1418

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

1419

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

1420

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

1421

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

1422

#

1423

# 1. A Google Cloud Storage URI of the form

1424

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

1425

# [Google Cloud Storage Request

1426

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

1427

# info.

1428

#

1429

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

1430

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

1431

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

1432

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

1433

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

1434

# depend on externally-hosted images for production applications.

1435

#

1436

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

1437

# precedence.

1438

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

1439

#

1440

# The Google Cloud Storage URI of the form

1441

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

1442

# [Google Cloud Storage Request

1443

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

},

},

},

],

Bu Sun Kim

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

[diff] [blame]

1448

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

1449

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

1450

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

1451

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

1452

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

1453

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

1454

# 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

1460

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

1461

# output files will begin with "filenameprefix".

1462

#

1463

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

1464

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

1465

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

1466

# specified.

1467

#

1468

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

1469

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

1470

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

1471

# and overflows into multiple sharded files.

1472

},

1473

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

1474

# Google Cloud Storage.

1475

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

1476

#

1477

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

1478

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

1479

# containing 20 response protos will be written under the prefix

1480

# `gcs_destination`.`uri`.

1481

#

1482

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

1483

# support for other output configurations.

1484

},

Bu Sun Kim

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

[diff] [blame]

1485

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

1486

#

1487

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

1488

#

1489

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

1490

#

1491

# Supported location-ids:

1492

# `us`: USA country only,

1493

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

1494

# `eu`: The European Union.

1495

#

1496

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

Bu Sun Kim

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

[diff] [blame]

1497

}

1498

1499

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1506

1507

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

1508

# network API call.

Bu Sun Kim

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

[diff] [blame^]

1509

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

1510

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

1511

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

1512

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

1513

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

1514

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

1515

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

1516

# `TakeSnapshotResponse`.

1517

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

1518

},

1519

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

1520

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

1521

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

1522

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

1523

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

1524

},

1525

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

1526

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

1527

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

1528

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

1529

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

1530

# available.

Bu Sun Kim