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

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

[diff] [blame]

200

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

201

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

Bu Sun Kim

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

[diff] [blame]

202

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

Bu Sun Kim

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

[diff] [blame]

203

#

204

# 1. A Google Cloud Storage URI of the form

205

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

206

# [Google Cloud Storage Request

207

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

208

# info.

209

#

210

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

211

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

212

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

213

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

214

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

215

# depend on externally-hosted images for production applications.

216

#

217

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

218

# precedence.

Bu Sun Kim

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

[diff] [blame]

219

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

Bu Sun Kim

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

[diff] [blame]

220

#

Bu Sun Kim

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

[diff] [blame]

221

# The Google Cloud Storage URI of the form

222

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

223

# [Google Cloud Storage Request

224

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

Bu Sun Kim

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

[diff] [blame]

225

},

226

},

Bu Sun Kim

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

[diff] [blame]

227

},

228

],

Bu Sun Kim

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

[diff] [blame]

229

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

230

#

231

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

232

#

233

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

234

#

235

# Supported location-ids:

236

# `us`: USA country only,

237

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

238

# `eu`: The European Union.

239

#

240

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

Bu Sun Kim

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

[diff] [blame]

241

}

242

243

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

250

251

{ # Response to a batch image annotation request.

Bu Sun Kim

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

[diff] [blame]

252

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

Bu Sun Kim

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

[diff] [blame]

253

{ # Response to an image annotation request.

Bu Sun Kim

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

[diff] [blame]

254

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

Bu Sun Kim

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

[diff] [blame]

255

# completed successfully.

256

# This annotation provides the structural hierarchy for the OCR detected

257

# text.

258

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

Dan O'Meara

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

[diff] [blame]

259

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

Bu Sun Kim

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

[diff] [blame]

260

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

261

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

262

# to the TextAnnotation.TextProperty message definition below for more

263

# detail.

Bu Sun Kim

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

[diff] [blame]

264

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

Bu Sun Kim

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

[diff] [blame]

265

{ # Detected page from OCR.

Bu Sun Kim

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

[diff] [blame]

266

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

267

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

Bu Sun Kim

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

[diff] [blame]

268

{ # Logical element on the page.

Bu Sun Kim

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

[diff] [blame]

269

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

Bu Sun Kim

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

[diff] [blame]

270

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

271

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

272

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

Bu Sun Kim

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

[diff] [blame]

273

# read in the 'natural' orientation.

Bu Sun Kim

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

[diff] [blame]

274

# For example:

275

#

276

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

#

# 0----1

# | |

# 3----2

#

Bu Sun Kim

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

[diff] [blame]

282

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

Bu Sun Kim

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

[diff] [blame]

#

# 2----3

# | |

# 1----0

#

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

Bu Sun Kim

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

[diff] [blame]

289

"vertices": [ # The bounding polygon vertices.

Bu Sun Kim

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

[diff] [blame]

290

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

291

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

Bu Sun Kim

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

[diff] [blame]

292

"y": 42, # Y coordinate.

293

"x": 42, # X coordinate.

Bu Sun Kim

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

[diff] [blame]

294

},

295

],

Bu Sun Kim

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

[diff] [blame]

296

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

297

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

298

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

299

# and range from 0 to 1.

300

"x": 3.14, # X coordinate.

301

"y": 3.14, # Y coordinate.

302

},

303

],

Bu Sun Kim

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

[diff] [blame]

304

},

Bu Sun Kim

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

[diff] [blame]

305

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

306

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

Bu Sun Kim

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

[diff] [blame]

307

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

Bu Sun Kim

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

[diff] [blame]

308

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

Bu Sun Kim

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

[diff] [blame]

309

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

310

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

311

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

Bu Sun Kim

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

[diff] [blame]

312

# read in the 'natural' orientation.

Bu Sun Kim

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

[diff] [blame]

313

# For example:

314

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

315

# 0----1

316

# | |

317

# 3----2

Bu Sun Kim

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

[diff] [blame]

318

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

Bu Sun Kim

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

[diff] [blame]

# 2----3

# | |

# 1----0

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

Bu Sun Kim

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

[diff] [blame]

323

"vertices": [ # The bounding polygon vertices.

Bu Sun Kim

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

[diff] [blame]

324

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

325

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

Bu Sun Kim

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

[diff] [blame]

326

"y": 42, # Y coordinate.

327

"x": 42, # X coordinate.

Bu Sun Kim

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

[diff] [blame]

328

},

329

],

Bu Sun Kim

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

[diff] [blame]

330

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

331

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

332

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

333

# and range from 0 to 1.

334

"x": 3.14, # X coordinate.

335

"y": 3.14, # Y coordinate.

336

},

337

],

Bu Sun Kim

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

[diff] [blame]

338

},

Bu Sun Kim

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

[diff] [blame]

339

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

Bu Sun Kim

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

[diff] [blame]

340

{ # A word representation.

Bu Sun Kim

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

[diff] [blame]

341

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

342

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

343

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

344

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

345

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

346

},

347

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

348

{ # Detected language for a structural component.

349

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

350

# information, see

351

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

352

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

353

},

354

],

355

},

Bu Sun Kim

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

[diff] [blame]

356

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

Dan O'Meara

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

[diff] [blame]

357

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

358

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

359

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

Bu Sun Kim

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

[diff] [blame]

360

# read in the 'natural' orientation.

Dan O'Meara

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

[diff] [blame]

361

# For example:

362

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

363

# 0----1

364

# | |

365

# 3----2

Bu Sun Kim

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

[diff] [blame]

366

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

Dan O'Meara

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

[diff] [blame]

# 2----3

# | |

# 1----0

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

Bu Sun Kim

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

[diff] [blame]

371

"vertices": [ # The bounding polygon vertices.

Dan O'Meara

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

[diff] [blame]

372

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

373

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

Bu Sun Kim

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

[diff] [blame]

374

"y": 42, # Y coordinate.

375

"x": 42, # X coordinate.

Dan O'Meara

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

[diff] [blame]

376

},

377

],

Bu Sun Kim

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

[diff] [blame]

378

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

379

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

380

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

381

# and range from 0 to 1.

382

"x": 3.14, # X coordinate.

383

"y": 3.14, # Y coordinate.

384

},

385

],

Dan O'Meara

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

[diff] [blame]

386

},

Bu Sun Kim

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

[diff] [blame]

387

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

388

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

389

{ # A single symbol representation.

Bu Sun Kim

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

[diff] [blame]

390

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

391

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

392

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

393

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

394

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

395

},

Bu Sun Kim

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

[diff] [blame]

396

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

397

{ # Detected language for a structural component.

398

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

399

# information, see

400

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

401

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

402

},

403

],

Bu Sun Kim

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

[diff] [blame]

404

},

405

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

406

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

407

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

408

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

409

# read in the 'natural' orientation.

410

# For example:

411

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

420

"vertices": [ # The bounding polygon vertices.

421

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

422

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

423

"y": 42, # Y coordinate.

424

"x": 42, # X coordinate.

425

},

426

],

Bu Sun Kim

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

[diff] [blame]

427

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

428

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

429

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

430

# and range from 0 to 1.

431

"x": 3.14, # X coordinate.

432

"y": 3.14, # Y coordinate.

433

},

434

],

Bu Sun Kim

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

[diff] [blame]

435

},

Bu Sun Kim

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

[diff] [blame]

436

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

Bu Sun Kim

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

[diff] [blame]

437

},

Bu Sun Kim

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

[diff] [blame]

438

],

Bu Sun Kim

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

[diff] [blame]

439

},

440

],

Bu Sun Kim

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

[diff] [blame]

441

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

442

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

443

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

444

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

445

},

446

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

447

{ # Detected language for a structural component.

448

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

449

# information, see

450

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

451

"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

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

[diff] [blame]

456

},

457

],

Bu Sun Kim

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

[diff] [blame]

458

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

459

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

460

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

461

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

462

},

463

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

464

{ # Detected language for a structural component.

465

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

466

# information, see

467

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

468

"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

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

[diff] [blame]

473

},

474

],

Bu Sun Kim

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

[diff] [blame]

475

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

476

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

477

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

478

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

479

},

Bu Sun Kim

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

[diff] [blame]

480

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

481

{ # Detected language for a structural component.

482

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

483

# information, see

484

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

485

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

486

},

487

],

Bu Sun Kim

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

[diff] [blame]

488

},

Bu Sun Kim

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

[diff] [blame]

489

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

490

# TIFFs) the unit is pixels.

491

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

492

# TIFFs) the unit is pixels.

Bu Sun Kim

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

[diff] [blame]

493

},

494

],

Bu Sun Kim

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

[diff] [blame]

495

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

Bu Sun Kim

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

[diff] [blame]

496

},

Bu Sun Kim

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

[diff] [blame]

497

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

498

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

499

# correct, even when `error` is set.

500

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

501

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

502

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

503

#

504

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

505

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

506

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

507

# message types for APIs to use.

508

{

509

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

510

},

511

],

512

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

513

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

514

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

515

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

516

},

Bu Sun Kim

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

[diff] [blame]

517

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

Bu Sun Kim

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

[diff] [blame]

518

{ # Set of detected entity features.

Bu Sun Kim

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

[diff] [blame]

519

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

520

# `description` is expressed.

Bu Sun Kim

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

[diff] [blame]

521

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

522

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

523

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

524

# detected distant towering building, even though the confidence that

525

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

526

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

527

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

528

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

529

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

530

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

531

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

532

},

533

],

Bu Sun Kim

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

[diff] [blame]

534

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

535

# [Google Knowledge Graph Search

536

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

537

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

538

# The accuracy of the entity detection in an image.

539

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

540

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

541

# image. Range [0, 1].

542

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

543

# for `LABEL_DETECTION` features.

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.

549

},

550

],

551

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

552

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

553

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

554

# and range from 0 to 1.

555

"x": 3.14, # X coordinate.

556

"y": 3.14, # Y coordinate.

},

],

},

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

561

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

562

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

563

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

564

# Location information is usually present for landmarks.

565

{ # Detected entity location information.

566

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

567

# of doubles representing degrees latitude and degrees longitude. Unless

568

# specified otherwise, this must conform to the

569

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

570

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

571

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

572

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

577

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

Bu Sun Kim

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

[diff] [blame]

578

},

579

],

Bu Sun Kim

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

[diff] [blame]

580

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

581

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

582

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

583

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

584

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

585

# [-180,180].

586

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

587

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

588

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

589

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

590

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

591

# are in the original image's scale.

592

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

593

# expectations. It is based on the landmarker results.

594

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

595

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

596

# appears in the image to be annotated.

597

"vertices": [ # The bounding polygon vertices.

598

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

599

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

600

"y": 42, # Y coordinate.

601

"x": 42, # X coordinate.

602

},

603

],

604

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

605

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

606

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

607

# and range from 0 to 1.

608

"x": 3.14, # X coordinate.

609

"y": 3.14, # Y coordinate.

},

],

},

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

614

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

615

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

616

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

617

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

618

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

619

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

620

"vertices": [ # The bounding polygon vertices.

621

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

622

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

623

"y": 42, # Y coordinate.

624

"x": 42, # X coordinate.

625

},

626

],

627

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

628

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

629

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

630

# and range from 0 to 1.

631

"x": 3.14, # X coordinate.

632

"y": 3.14, # Y coordinate.

},

],

},

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

637

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

638

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

639

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

640

"landmarks": [ # Detected face landmarks.

641

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

642

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

643

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

644

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

645

"x": 3.14, # X coordinate.

646

"y": 3.14, # Y coordinate.

647

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

648

},

649

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

650

},

651

],

652

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

653

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

654

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

655

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

656

},

657

],

658

"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

659

# comes from.

660

# information about the source of that image.

661

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

662

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

663

# the file used to produce the image.

664

},

Bu Sun Kim

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

[diff] [blame]

665

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

666

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

667

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

Bu Sun Kim

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

[diff] [blame]

668

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

669

# the image that the color occupies in the image.

Bu Sun Kim

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

[diff] [blame]

670

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

671

# Value in range [0, 1].

Bu Sun Kim

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

[diff] [blame]

672

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

673

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

Bu Sun Kim

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

[diff] [blame]

674

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

675

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

Bu Sun Kim

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

[diff] [blame]

676

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

677

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

Bu Sun Kim

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

[diff] [blame]

678

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

Bu Sun Kim

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

[diff] [blame]

679

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

Bu Sun Kim

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

[diff] [blame]

680

#

681

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

682

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

683

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

684

# space.

685

#

Bu Sun Kim

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

[diff] [blame]

686

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

687

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

688

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

689

#

Bu Sun Kim

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

[diff] [blame]

690

# Example (Java):

691

#

692

# import com.google.type.Color;

693

#

694

# // ...

695

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

696

# float alpha = protocolor.hasAlpha()

697

# ? protocolor.getAlpha().getValue()

698

# : 1.0;

699

#

700

# return new java.awt.Color(

701

# protocolor.getRed(),

702

# protocolor.getGreen(),

703

# protocolor.getBlue(),

# alpha);

# }

#

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

708

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

709

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

710

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

711

# float denominator = 255.0;

712

# Color.Builder resultBuilder =

713

# Color

714

# .newBuilder()

715

# .setRed(red / denominator)

716

# .setGreen(green / denominator)

717

# .setBlue(blue / denominator);

718

# int alpha = color.getAlpha();

719

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

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

724

# .build());

725

# }

726

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

731

#

732

# // ...

733

# static UIColor* fromProto(Color* protocolor) {

734

# float red = [protocolor red];

735

# float green = [protocolor green];

736

# float blue = [protocolor blue];

737

# FloatValue* alpha_wrapper = [protocolor alpha];

738

# float alpha = 1.0;

739

# if (alpha_wrapper != nil) {

740

# alpha = [alpha_wrapper value];

741

# }

742

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

743

# }

744

#

745

# static Color* toProto(UIColor* color) {

746

# CGFloat red, green, blue, alpha;

Dan O'Meara

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

[diff] [blame]

747

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

Bu Sun Kim

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

[diff] [blame]

748

# return nil;

749

# }

750

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

751

# [result setRed:red];

752

# [result setGreen:green];

753

# [result setBlue:blue];

Dan O'Meara

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

[diff] [blame]

754

# if (alpha <= 0.9999) {

Bu Sun Kim

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

[diff] [blame]

755

# [result setAlpha:floatWrapperWithValue(alpha)];

756

# }

757

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

767

# var redFrac = rgb_color.red || 0.0;

768

# var greenFrac = rgb_color.green || 0.0;

769

# var blueFrac = rgb_color.blue || 0.0;

770

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

771

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

772

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

773

#

Bu Sun Kim

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

[diff] [blame]

774

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

Bu Sun Kim

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

[diff] [blame]

775

# return rgbToCssColor_(red, green, blue);

776

# }

777

#

778

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

Bu Sun Kim

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

[diff] [blame]

779

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

780

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

Bu Sun Kim

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

[diff] [blame]

781

# };

782

#

783

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

Dan O'Meara

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

[diff] [blame]

784

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

Bu Sun Kim

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

[diff] [blame]

785

# var hexString = rgbNumber.toString(16);

786

# var missingZeros = 6 - hexString.length;

Bu Sun Kim

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

[diff] [blame]

787

# var resultBuilder = ['#'];

Dan O'Meara

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

[diff] [blame]

788

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

Bu Sun Kim

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

[diff] [blame]

789

# resultBuilder.push('0');

Bu Sun Kim

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

[diff] [blame]

790

# }

791

# resultBuilder.push(hexString);

Bu Sun Kim

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

[diff] [blame]

792

# return resultBuilder.join('');

Bu Sun Kim

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

[diff] [blame]

793

# };

794

#

795

# // ...

Bu Sun Kim

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

[diff] [blame]

796

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

797

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

798

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

799

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

Bu Sun Kim

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

[diff] [blame]

800

# the final pixel color is defined by the equation:

801

#

802

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

803

#

804

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

805

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

806

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

807

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

808

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

809

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

Bu Sun Kim

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

[diff] [blame]

810

},

Bu Sun Kim

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

[diff] [blame]

},

],

},

},

Bu Sun Kim

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

[diff] [blame]

815

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

816

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

817

{ # Metadata for online images.

Bu Sun Kim

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

[diff] [blame]

818

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

Bu Sun Kim

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

[diff] [blame]

819

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

Bu Sun Kim

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

[diff] [blame]

820

},

821

],

822

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

823

# Inferred from similar images on the open web.

824

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

825

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

826

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

827

# For more information, see

828

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

829

},

830

],

831

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

832

# Can include resized copies of the query image.

833

{ # Metadata for online images.

Bu Sun Kim

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

[diff] [blame]

834

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

Bu Sun Kim

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

[diff] [blame]

835

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

Bu Sun Kim

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

[diff] [blame]

836

},

837

],

838

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

839

{ # Entity deduced from similar images on the Internet.

Bu Sun Kim

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

[diff] [blame]

840

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

Bu Sun Kim

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

[diff] [blame]

841

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

Bu Sun Kim

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

[diff] [blame]

842

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

843

# Not normalized and not comparable across different image queries.

844

},

845

],

Bu Sun Kim

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

[diff] [blame]

846

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

847

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

848

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

849

{ # Metadata for online images.

Bu Sun Kim

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

[diff] [blame]

850

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

Bu Sun Kim

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

[diff] [blame]

851

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

852

},

853

],

854

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

855

{ # Metadata for web pages.

856

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

857

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

858

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

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

861

# crops.

862

{ # Metadata for online images.

863

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

864

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

865

},

866

],

867

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

868

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

869

# Can include resized copies of the query image.

870

{ # Metadata for online images.

871

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

872

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

873

},

874

],

Bu Sun Kim

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

[diff] [blame]

875

},

876

],

877

},

Bu Sun Kim

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

[diff] [blame]

878

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

879

{ # Set of detected entity features.

Bu Sun Kim

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

[diff] [blame]

880

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

881

# `description` is expressed.

Bu Sun Kim

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

[diff] [blame]

882

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

883

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

884

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

885

# detected distant towering building, even though the confidence that

886

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

887

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

888

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

889

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

890

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

891

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

892

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

893

},

894

],

Bu Sun Kim

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

[diff] [blame]

895

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

896

# [Google Knowledge Graph Search

897

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

898

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

899

# The accuracy of the entity detection in an image.

900

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

901

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

902

# image. Range [0, 1].

903

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

904

# for `LABEL_DETECTION` features.

905

"vertices": [ # The bounding polygon vertices.

906

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

907

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

908

"y": 42, # Y coordinate.

909

"x": 42, # X coordinate.

910

},

911

],

912

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

913

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

914

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

915

# and range from 0 to 1.

Bu Sun Kim

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

[diff] [blame]

916

"x": 3.14, # X coordinate.

Bu Sun Kim

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

[diff] [blame]

917

"y": 3.14, # Y coordinate.

918

},

Bu Sun Kim

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

[diff] [blame]

919

],

920

},

921

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

922

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

923

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

924

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

925

# Location information is usually present for landmarks.

926

{ # Detected entity location information.

927

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

928

# of doubles representing degrees latitude and degrees longitude. Unless

929

# specified otherwise, this must conform to the

930

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

931

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

932

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

933

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

934

},

Bu Sun Kim

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

[diff] [blame]

935

},

936

],

Bu Sun Kim

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

[diff] [blame]

937

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

938

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

Bu Sun Kim

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

[diff] [blame]

939

},

940

],

941

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

942

"cropHints": [ # Crop hint results.

943

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

944

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

945

# box are in the original image's scale.

Bu Sun Kim

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

[diff] [blame]

946

"vertices": [ # The bounding polygon vertices.

947

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

948

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

949

"y": 42, # Y coordinate.

950

"x": 42, # X coordinate.

951

},

952

],

Bu Sun Kim

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

[diff] [blame]

953

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

954

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

955

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

956

# and range from 0 to 1.

957

"x": 3.14, # X coordinate.

958

"y": 3.14, # Y coordinate.

959

},

960

],

Bu Sun Kim

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

[diff] [blame]

961

},

Bu Sun Kim

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

[diff] [blame]

962

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

963

# image.

964

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

965

},

966

],

967

},

Bu Sun Kim

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

[diff] [blame]

968

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

Bu Sun Kim

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

[diff] [blame]

969

{ # Set of detected entity features.

Bu Sun Kim

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

[diff] [blame]

970

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

971

# `description` is expressed.

Bu Sun Kim

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

[diff] [blame]

972

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

973

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

974

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

975

# detected distant towering building, even though the confidence that

976

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

977

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

978

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

979

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

980

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

981

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

982

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

983

},

984

],

Bu Sun Kim

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

[diff] [blame]

985

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

986

# [Google Knowledge Graph Search

987

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

988

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

989

# The accuracy of the entity detection in an image.

990

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

991

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

992

# image. Range [0, 1].

993

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

994

# for `LABEL_DETECTION` features.

995

"vertices": [ # The bounding polygon vertices.

996

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

997

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

998

"y": 42, # Y coordinate.

999

"x": 42, # X coordinate.

1000

},

1001

],

1002

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

1003

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

1004

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

1005

# and range from 0 to 1.

1006

"x": 3.14, # X coordinate.

1007

"y": 3.14, # Y coordinate.

},

],

},

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

1012

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

1013

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

1014

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

1015

# Location information is usually present for landmarks.

1016

{ # Detected entity location information.

1017

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

1018

# of doubles representing degrees latitude and degrees longitude. Unless

1019

# specified otherwise, this must conform to the

1020

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

1021

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

1022

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

1023

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

1028

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

Bu Sun Kim

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

[diff] [blame]

1029

},

1030

],

Bu Sun Kim

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

[diff] [blame]

1031

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

1032

# This will be sorted descending by confidence score.

1033

{ # Set of detected objects with bounding boxes.

1034

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

1035

"vertices": [ # The bounding polygon vertices.

1036

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

1037

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

1038

"y": 42, # Y coordinate.

1039

"x": 42, # X coordinate.

1040

},

1041

],

1042

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

1043

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

1044

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

1045

# and range from 0 to 1.

1046

"x": 3.14, # X coordinate.

1047

"y": 3.14, # Y coordinate.

},

],

},

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

1052

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

1053

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

1054

# information, see

1055

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

1056

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

1057

},

1058

],

1059

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

1060

{ # Set of detected entity features.

1061

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

1062

# `description` is expressed.

1063

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

1064

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

1065

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

1066

# detected distant towering building, even though the confidence that

1067

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

1068

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

1069

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

1070

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

1071

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

1072

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

1073

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

1074

},

1075

],

1076

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

1077

# [Google Knowledge Graph Search

1078

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

1079

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

1080

# The accuracy of the entity detection in an image.

1081

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

1082

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

1083

# image. Range [0, 1].

1084

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

1085

# for `LABEL_DETECTION` features.

1086

"vertices": [ # The bounding polygon vertices.

1087

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

1088

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

1089

"y": 42, # Y coordinate.

1090

"x": 42, # X coordinate.

1091

},

1092

],

1093

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

1094

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

1095

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

1096

# and range from 0 to 1.

1097

"x": 3.14, # X coordinate.

1098

"y": 3.14, # Y coordinate.

},

],

},

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

1103

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

1104

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

1105

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

1106

# Location information is usually present for landmarks.

1107

{ # Detected entity location information.

1108

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

1109

# of doubles representing degrees latitude and degrees longitude. Unless

1110

# specified otherwise, this must conform to the

1111

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

1112

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

1113

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

1114

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

1119

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

1120

},

1121

],

1122

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

1123

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

1124

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

1125

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

1126

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

1127

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

1128

# image.

1129

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

1130

"vertices": [ # The bounding polygon vertices.

1131

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

1132

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

1133

"y": 42, # Y coordinate.

1134

"x": 42, # X coordinate.

1135

},

1136

],

1137

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

1138

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

1139

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

1140

# and range from 0 to 1.

1141

"x": 3.14, # X coordinate.

1142

"y": 3.14, # Y coordinate.

},

],

},

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

1147

{ # Information about a product.

1148

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

1149

# to the query.

1150

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

1151

# 1 (full confidence).

1152

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

1153

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

1154

# 4096 characters long.

1155

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

1156

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

1157

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

1158

# not be used for new products.

1159

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

1160

# constraints can be specified based on the product_labels.

1161

#

1162

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

1163

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

1164

# to be supported soon.

1165

#

1166

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

1167

# 500 product_labels.

1168

#

1169

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

1170

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

1171

# will refuse to work for that ProductSet.

1172

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

1173

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

1174

# exceed 128 bytes.

1175

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

1176

# cannot exceed 128 bytes.

1177

},

1178

],

1179

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

1180

#

1181

# Format is:

1182

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

1183

#

1184

# This field is ignored when creating a product.

1185

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

1191

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

1192

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

1193

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

1194

# information, see

1195

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

1196

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

1197

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

},

],

},

],

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

1203

{ # Information about a product.

1204

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

1205

# to the query.

1206

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

1207

# 1 (full confidence).

1208

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

1209

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

1210

# 4096 characters long.

1211

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

1212

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

1213

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

1214

# not be used for new products.

1215

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

1216

# constraints can be specified based on the product_labels.

1217

#

1218

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

1219

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

1220

# to be supported soon.

1221

#

1222

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

1223

# 500 product_labels.

1224

#

1225

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

1226

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

1227

# will refuse to work for that ProductSet.

1228

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

1229

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

1230

# exceed 128 bytes.

1231

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

1232

# cannot exceed 128 bytes.

1233

},

1234

],

1235

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

1236

#

1237

# Format is:

1238

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

1239

#

1240

# This field is ignored when creating a product.

1241

"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

1247

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

1248

# not reflected in the current results.

1249

},

1250

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

1251

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

1252

# violence).

1253

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

1254

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

1255

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

1256

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

1257

# body areas.

1258

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

1259

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

1260

# funny or offensive.

1261

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

1262

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

1263

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

1264

# sexual activities.

1265

},

Bu Sun Kim

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

[diff] [blame]

},

],

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

1272

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

Bu Sun Kim

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

[diff] [blame]

1273

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

1274

1275

Progress and results can be retrieved through the

1276

`google.longrunning.Operations` interface.

1277

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

1278

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

1279

1280

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

1281

GCS bucket, each json file containing BatchAnnotateImagesResponse proto.

1282

1283

Args:

Dan O'Meara

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

[diff] [blame]

1284

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

1285

The object takes the form of:

1286

1287

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

Bu Sun Kim

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

[diff] [blame]

1288

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

1289

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

1290

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

1291

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

1292

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

1293

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

1294

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

1295

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

1296

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

1297

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

1298

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

1299

# migrate existing products to these categories as well.

1300

"A String",

1301

],

1302

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

1303

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

1304

"vertices": [ # The bounding polygon vertices.

1305

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

1306

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

1307

"y": 42, # Y coordinate.

1308

"x": 42, # X coordinate.

1309

},

1310

],

1311

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

1312

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

1313

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

1314

# and range from 0 to 1.

1315

"x": 3.14, # X coordinate.

1316

"y": 3.14, # Y coordinate.

},

],

},

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

1321

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

1322

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

1323

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

1324

#

1325

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

1326

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

1327

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

1328

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

1329

#

1330

# Format is:

1331

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

1332

},

1333

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

1334

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

1335

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

1336

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

1337

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

1338

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

1344

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

1345

},

1346

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

1347

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

1348

# of doubles representing degrees latitude and degrees longitude. Unless

1349

# specified otherwise, this must conform to the

1350

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

1351

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

1352

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

1353

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

1354

},

1355

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

1356

# of doubles representing degrees latitude and degrees longitude. Unless

1357

# specified otherwise, this must conform to the

1358

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

1359

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

1360

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

1361

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

1362

},

1363

},

1364

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

1365

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

1366

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

1367

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

1368

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

1369

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

1370

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

1371

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

"A String",

],

},

"features": [ # Requested features.

1376

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

1377

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

1378

# be specified in the `features` list.

1379

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

1380

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

1381

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

1382

# "builtin/latest".

1383

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

1384

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

1385

},

1386

],

1387

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

1388

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

1389

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

1390

# representation, whereas JSON representations use base64.

1391

#

1392

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

1393

# not work for AsyncBatchAnnotateImages requests.

1394

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

1395

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

1396

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

1397

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

1398

#

1399

# 1. A Google Cloud Storage URI of the form

1400

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

1401

# [Google Cloud Storage Request

1402

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

1403

# info.

1404

#

1405

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

1406

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

1407

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

1408

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

1409

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

1410

# depend on externally-hosted images for production applications.

1411

#

1412

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

1413

# precedence.

1414

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

1415

#

1416

# The Google Cloud Storage URI of the form

1417

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

1418

# [Google Cloud Storage Request

1419

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

},

},

},

],

Bu Sun Kim

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

[diff] [blame]

1424

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

1425

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

1426

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

Bu Sun Kim

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

[diff] [blame]

1427

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

1428

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

1429

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

1430

# 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

1436

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

Bu Sun Kim

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

[diff] [blame]

1437

# output files will begin with "filenameprefix".

Bu Sun Kim

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

[diff] [blame]

1438

#

1439

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

1440

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

1441

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

1442

# specified.

1443

#

1444

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

1445

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

1446

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

1447

# and overflows into multiple sharded files.

1448

},

Bu Sun Kim

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

[diff] [blame]

1449

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

1450

# Google Cloud Storage.

1451

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

1452

#

1453

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

1454

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

1455

# containing 20 response protos will be written under the prefix

1456

# `gcs_destination`.`uri`.

1457

#

1458

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

1459

# support for other output configurations.

Bu Sun Kim

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

[diff] [blame]

1460

},

Bu Sun Kim

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

[diff] [blame]

1461

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

1462

#

1463

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

1464

#

1465

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

1466

#

1467

# Supported location-ids:

1468

# `us`: USA country only,

1469

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

1470

# `eu`: The European Union.

1471

#

1472

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

Bu Sun Kim

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

[diff] [blame]

1473

}

1474

1475

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1482

1483

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

1484

# network API call.

Bu Sun Kim

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

[diff] [blame]

1485

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

1486

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

1487

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

1488

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

1489

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

1490

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

1491

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

1492

# `TakeSnapshotResponse`.

1493

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

1494

},

1495

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

1496

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

1497

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

1498

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

1499

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

1500

},

1501

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

1502

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

1503

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

1504

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

1505

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

1506

# available.

Bu Sun Kim