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

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

[diff] [blame]

295

# completed successfully.

296

# This annotation provides the structural hierarchy for the OCR detected

297

# text.

298

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

Dan O'Meara

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

[diff] [blame]

299

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

Bu Sun Kim

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

[diff] [blame]

300

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

301

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

302

# to the TextAnnotation.TextProperty message definition below for more

303

# detail.

Bu Sun Kim

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

[diff] [blame]

304

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

Bu Sun Kim

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

[diff] [blame]

305

{ # Detected page from OCR.

Bu Sun Kim

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

[diff] [blame^]

306

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

307

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

Bu Sun Kim

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

[diff] [blame]

308

{ # Logical element on the page.

Bu Sun Kim

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

[diff] [blame]

309

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

310

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

311

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

312

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

313

# read in the 'natural' orientation.

Bu Sun Kim

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

[diff] [blame]

314

# For example:

315

#

316

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

322

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

329

"vertices": [ # The bounding polygon vertices.

Bu Sun Kim

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

[diff] [blame]

330

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

331

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

332

"y": 42, # Y coordinate.

333

"x": 42, # X coordinate.

Bu Sun Kim

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

[diff] [blame]

334

},

335

],

Bu Sun Kim

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

[diff] [blame^]

336

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

337

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

338

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

339

# and range from 0 to 1.

340

"x": 3.14, # X coordinate.

341

"y": 3.14, # Y coordinate.

342

},

343

],

Bu Sun Kim

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

[diff] [blame]

344

},

Bu Sun Kim

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

[diff] [blame]

345

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

346

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

347

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

Bu Sun Kim

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

[diff] [blame]

348

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

349

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

350

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

351

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

352

# read in the 'natural' orientation.

Bu Sun Kim

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

[diff] [blame]

353

# For example:

354

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

355

# 0----1

356

# | |

357

# 3----2

Bu Sun Kim

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

[diff] [blame]

358

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

363

"vertices": [ # The bounding polygon vertices.

Bu Sun Kim

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

[diff] [blame]

364

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

365

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

366

"y": 42, # Y coordinate.

367

"x": 42, # X coordinate.

Bu Sun Kim

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

[diff] [blame]

368

},

369

],

Bu Sun Kim

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

[diff] [blame^]

370

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

371

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

372

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

373

# and range from 0 to 1.

374

"x": 3.14, # X coordinate.

375

"y": 3.14, # Y coordinate.

376

},

377

],

Bu Sun Kim

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

[diff] [blame]

378

},

Bu Sun Kim

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

[diff] [blame]

379

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

Bu Sun Kim

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

[diff] [blame]

380

{ # A word representation.

Bu Sun Kim

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

[diff] [blame^]

381

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

382

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

383

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

384

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

385

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

386

},

387

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

388

{ # Detected language for a structural component.

389

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

390

# information, see

391

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

392

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

393

},

394

],

395

},

Bu Sun Kim

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

[diff] [blame]

396

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

397

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

398

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

399

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

400

# read in the 'natural' orientation.

Dan O'Meara

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

[diff] [blame]

401

# For example:

402

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

403

# 0----1

404

# | |

405

# 3----2

Bu Sun Kim

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

[diff] [blame]

406

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

411

"vertices": [ # The bounding polygon vertices.

Dan O'Meara

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

[diff] [blame]

412

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

413

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

414

"y": 42, # Y coordinate.

415

"x": 42, # X coordinate.

Dan O'Meara

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

[diff] [blame]

416

},

417

],

Bu Sun Kim

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

[diff] [blame^]

418

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

419

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

420

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

421

# and range from 0 to 1.

422

"x": 3.14, # X coordinate.

423

"y": 3.14, # Y coordinate.

424

},

425

],

Dan O'Meara

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

[diff] [blame]

426

},

Bu Sun Kim

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

[diff] [blame]

427

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

428

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

429

{ # A single symbol representation.

Bu Sun Kim

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

[diff] [blame^]

430

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

431

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

432

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

433

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

434

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

435

},

Bu Sun Kim

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

[diff] [blame]

436

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

437

{ # Detected language for a structural component.

438

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

439

# information, see

440

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

441

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

442

},

443

],

Bu Sun Kim

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

[diff] [blame]

444

},

445

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

446

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

447

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

448

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

449

# read in the 'natural' orientation.

450

# For example:

451

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

460

"vertices": [ # The bounding polygon vertices.

461

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

462

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

463

"y": 42, # Y coordinate.

464

"x": 42, # X coordinate.

465

},

466

],

Bu Sun Kim

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

[diff] [blame^]

467

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

468

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

469

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

470

# and range from 0 to 1.

471

"x": 3.14, # X coordinate.

472

"y": 3.14, # Y coordinate.

473

},

474

],

Bu Sun Kim

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

[diff] [blame]

475

},

Bu Sun Kim

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

[diff] [blame]

476

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

Bu Sun Kim

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

[diff] [blame]

477

},

Bu Sun Kim

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

[diff] [blame]

478

],

Bu Sun Kim

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

[diff] [blame]

479

},

480

],

Bu Sun Kim

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

[diff] [blame^]

481

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

482

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

483

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

484

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

485

},

486

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

487

{ # Detected language for a structural component.

488

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

489

# information, see

490

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

491

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

496

},

497

],

Bu Sun Kim

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

[diff] [blame^]

498

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

499

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

500

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

501

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

502

},

503

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

504

{ # Detected language for a structural component.

505

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

506

# information, see

507

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

508

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

513

},

514

],

Bu Sun Kim

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

[diff] [blame]

515

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

516

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

517

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

518

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

519

},

Bu Sun Kim

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

[diff] [blame]

520

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

521

{ # Detected language for a structural component.

522

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

523

# information, see

524

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

525

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

526

},

527

],

Bu Sun Kim

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

[diff] [blame]

528

},

Bu Sun Kim

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

[diff] [blame]

529

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

530

# TIFFs) the unit is pixels.

531

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

532

# TIFFs) the unit is pixels.

Bu Sun Kim

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

[diff] [blame]

533

},

534

],

Bu Sun Kim

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

[diff] [blame]

535

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

Bu Sun Kim

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

[diff] [blame]

536

},

Bu Sun Kim

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

[diff] [blame^]

537

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

538

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

539

# correct, even when `error` is set.

540

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

541

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

542

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

543

#

544

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

545

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

546

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

547

# message types for APIs to use.

548

{

549

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

550

},

551

],

552

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

553

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

554

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

555

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

556

},

Bu Sun Kim

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

[diff] [blame]

557

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

Bu Sun Kim

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

[diff] [blame]

558

{ # Set of detected entity features.

Bu Sun Kim

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

[diff] [blame]

559

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

560

# `description` is expressed.

Bu Sun Kim

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

[diff] [blame]

561

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

562

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

563

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

564

# detected distant towering building, even though the confidence that

565

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

566

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

567

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

568

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

569

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

570

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

571

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

572

},

573

],

Bu Sun Kim

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

[diff] [blame^]

574

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

575

# [Google Knowledge Graph Search

576

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

577

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

578

# The accuracy of the entity detection in an image.

579

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

580

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

581

# image. Range [0, 1].

582

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

583

# for `LABEL_DETECTION` features.

584

"vertices": [ # The bounding polygon vertices.

585

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

586

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

587

"y": 42, # Y coordinate.

588

"x": 42, # X coordinate.

589

},

590

],

591

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

592

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

593

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

594

# and range from 0 to 1.

595

"x": 3.14, # X coordinate.

596

"y": 3.14, # Y coordinate.

},

],

},

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

601

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

602

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

603

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

604

# Location information is usually present for landmarks.

605

{ # Detected entity location information.

606

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

607

# of doubles representing degrees latitude and degrees longitude. Unless

608

# specified otherwise, this must conform to the

609

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

610

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

611

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

612

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

617

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

Bu Sun Kim

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

[diff] [blame]

618

},

619

],

Bu Sun Kim

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

[diff] [blame^]

620

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

621

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

622

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

623

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

624

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

625

# [-180,180].

626

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

627

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

628

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

629

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

630

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

631

# are in the original image's scale.

632

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

633

# expectations. It is based on the landmarker results.

634

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

635

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

636

# appears in the image to be annotated.

637

"vertices": [ # The bounding polygon vertices.

638

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

639

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

640

"y": 42, # Y coordinate.

641

"x": 42, # X coordinate.

642

},

643

],

644

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

645

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

646

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

647

# and range from 0 to 1.

648

"x": 3.14, # X coordinate.

649

"y": 3.14, # Y coordinate.

},

],

},

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

654

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

655

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

656

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

657

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

658

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

659

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

660

"vertices": [ # The bounding polygon vertices.

661

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

662

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

663

"y": 42, # Y coordinate.

664

"x": 42, # X coordinate.

665

},

666

],

667

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

668

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

669

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

670

# and range from 0 to 1.

671

"x": 3.14, # X coordinate.

672

"y": 3.14, # Y coordinate.

},

],

},

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

677

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

678

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

679

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

680

"landmarks": [ # Detected face landmarks.

681

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

682

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

683

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

684

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

685

"x": 3.14, # X coordinate.

686

"y": 3.14, # Y coordinate.

687

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

688

},

689

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

690

},

691

],

692

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

693

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

694

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

695

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

696

},

697

],

698

"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

699

# comes from.

700

# information about the source of that image.

701

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

702

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

703

# the file used to produce the image.

704

},

Bu Sun Kim

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

[diff] [blame]

705

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

706

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

707

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

Bu Sun Kim

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

[diff] [blame]

708

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

709

# the image that the color occupies in the image.

Bu Sun Kim

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

[diff] [blame]

710

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

711

# Value in range [0, 1].

Bu Sun Kim

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

[diff] [blame^]

712

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

713

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

714

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

715

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

Bu Sun Kim

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

[diff] [blame]

716

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

717

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

Bu Sun Kim

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

[diff] [blame]

718

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

719

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

Bu Sun Kim

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

[diff] [blame]

720

#

721

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

722

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

723

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

724

# space.

725

#

Bu Sun Kim

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

[diff] [blame^]

726

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

727

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

728

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

729

#

Bu Sun Kim

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

[diff] [blame]

730

# Example (Java):

731

#

732

# import com.google.type.Color;

733

#

734

# // ...

735

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

736

# float alpha = protocolor.hasAlpha()

737

# ? protocolor.getAlpha().getValue()

738

# : 1.0;

739

#

740

# return new java.awt.Color(

741

# protocolor.getRed(),

742

# protocolor.getGreen(),

743

# protocolor.getBlue(),

# alpha);

# }

#

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

748

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

749

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

750

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

751

# float denominator = 255.0;

752

# Color.Builder resultBuilder =

753

# Color

754

# .newBuilder()

755

# .setRed(red / denominator)

756

# .setGreen(green / denominator)

757

# .setBlue(blue / denominator);

758

# int alpha = color.getAlpha();

759

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

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

764

# .build());

765

# }

766

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

771

#

772

# // ...

773

# static UIColor* fromProto(Color* protocolor) {

774

# float red = [protocolor red];

775

# float green = [protocolor green];

776

# float blue = [protocolor blue];

777

# FloatValue* alpha_wrapper = [protocolor alpha];

778

# float alpha = 1.0;

779

# if (alpha_wrapper != nil) {

780

# alpha = [alpha_wrapper value];

781

# }

782

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

783

# }

784

#

785

# static Color* toProto(UIColor* color) {

786

# CGFloat red, green, blue, alpha;

Dan O'Meara

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

[diff] [blame]

787

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

Bu Sun Kim

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

[diff] [blame]

788

# return nil;

789

# }

790

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

791

# [result setRed:red];

792

# [result setGreen:green];

793

# [result setBlue:blue];

Dan O'Meara

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

[diff] [blame]

794

# if (alpha <= 0.9999) {

Bu Sun Kim

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

[diff] [blame]

795

# [result setAlpha:floatWrapperWithValue(alpha)];

796

# }

797

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

807

# var redFrac = rgb_color.red || 0.0;

808

# var greenFrac = rgb_color.green || 0.0;

809

# var blueFrac = rgb_color.blue || 0.0;

810

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

811

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

812

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

813

#

Bu Sun Kim

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

[diff] [blame]

814

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

Bu Sun Kim

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

[diff] [blame]

815

# return rgbToCssColor_(red, green, blue);

816

# }

817

#

818

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

Bu Sun Kim

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

[diff] [blame]

819

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

820

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

Bu Sun Kim

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

[diff] [blame]

821

# };

822

#

823

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

Dan O'Meara

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

[diff] [blame]

824

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

Bu Sun Kim

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

[diff] [blame]

825

# var hexString = rgbNumber.toString(16);

826

# var missingZeros = 6 - hexString.length;

Bu Sun Kim

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

[diff] [blame]

827

# var resultBuilder = ['#'];

Dan O'Meara

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

[diff] [blame]

828

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

Bu Sun Kim

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

[diff] [blame]

829

# resultBuilder.push('0');

Bu Sun Kim

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

[diff] [blame]

830

# }

831

# resultBuilder.push(hexString);

Bu Sun Kim

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

[diff] [blame]

832

# return resultBuilder.join('');

Bu Sun Kim

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

[diff] [blame]

833

# };

834

#

835

# // ...

Bu Sun Kim

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

[diff] [blame]

836

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

837

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

838

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

839

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

840

# the final pixel color is defined by the equation:

841

#

842

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

843

#

844

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

845

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

846

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

847

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

848

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

849

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

850

},

Bu Sun Kim

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

[diff] [blame]

},

],

},

},

Bu Sun Kim

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

[diff] [blame]

855

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

856

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

857

{ # Metadata for online images.

Bu Sun Kim

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

[diff] [blame]

858

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

Bu Sun Kim

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

[diff] [blame^]

859

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

Bu Sun Kim

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

[diff] [blame]

860

},

861

],

862

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

863

# Inferred from similar images on the open web.

864

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

865

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

866

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

867

# For more information, see

868

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

869

},

870

],

871

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

872

# Can include resized copies of the query image.

873

{ # Metadata for online images.

Bu Sun Kim

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

[diff] [blame]

874

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

Bu Sun Kim

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

[diff] [blame^]

875

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

Bu Sun Kim

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

[diff] [blame]

876

},

877

],

878

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

879

{ # Entity deduced from similar images on the Internet.

Bu Sun Kim

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

[diff] [blame]

880

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

Bu Sun Kim

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

[diff] [blame^]

881

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

Bu Sun Kim

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

[diff] [blame]

882

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

883

# Not normalized and not comparable across different image queries.

884

},

885

],

Bu Sun Kim

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

[diff] [blame]

886

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

887

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

888

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

889

{ # Metadata for online images.

Bu Sun Kim

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

[diff] [blame]

890

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

Bu Sun Kim

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

[diff] [blame^]

891

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

892

},

893

],

894

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

895

{ # Metadata for web pages.

896

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

897

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

898

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

899

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

900

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

901

# crops.

902

{ # Metadata for online images.

903

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

904

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

905

},

906

],

907

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

908

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

909

# Can include resized copies of the query image.

910

{ # Metadata for online images.

911

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

912

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

913

},

914

],

Bu Sun Kim

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

[diff] [blame]

915

},

916

],

917

},

Bu Sun Kim

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

[diff] [blame]

918

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

919

{ # Set of detected entity features.

Bu Sun Kim

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

[diff] [blame]

920

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

921

# `description` is expressed.

Bu Sun Kim

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

[diff] [blame]

922

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

923

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

924

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

925

# detected distant towering building, even though the confidence that

926

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

927

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

928

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

929

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

930

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

931

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

932

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

933

},

934

],

Bu Sun Kim

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

[diff] [blame^]

935

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

936

# [Google Knowledge Graph Search

937

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

938

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

939

# The accuracy of the entity detection in an image.

940

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

941

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

942

# image. Range [0, 1].

943

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

944

# for `LABEL_DETECTION` features.

945

"vertices": [ # The bounding polygon vertices.

946

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

947

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

948

"y": 42, # Y coordinate.

949

"x": 42, # X coordinate.

950

},

951

],

952

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

953

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

954

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

955

# and range from 0 to 1.

Bu Sun Kim

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

[diff] [blame]

956

"x": 3.14, # X coordinate.

Bu Sun Kim

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

[diff] [blame]

957

"y": 3.14, # Y coordinate.

958

},

Bu Sun Kim

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

[diff] [blame^]

959

],

960

},

961

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

962

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

963

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

964

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

965

# Location information is usually present for landmarks.

966

{ # Detected entity location information.

967

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

968

# of doubles representing degrees latitude and degrees longitude. Unless

969

# specified otherwise, this must conform to the

970

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

971

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

972

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

973

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

974

},

Bu Sun Kim

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

[diff] [blame]

975

},

976

],

Bu Sun Kim

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

[diff] [blame^]

977

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

978

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

Bu Sun Kim

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

[diff] [blame]

979

},

980

],

981

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

982

"cropHints": [ # Crop hint results.

983

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

984

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

985

# box are in the original image's scale.

Bu Sun Kim

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

[diff] [blame]

986

"vertices": [ # The bounding polygon vertices.

987

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

988

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

989

"y": 42, # Y coordinate.

990

"x": 42, # X coordinate.

991

},

992

],

Bu Sun Kim

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

[diff] [blame^]

993

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

994

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

995

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

996

# and range from 0 to 1.

997

"x": 3.14, # X coordinate.

998

"y": 3.14, # Y coordinate.

999

},

1000

],

Bu Sun Kim

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

[diff] [blame]

1001

},

Bu Sun Kim

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

[diff] [blame^]

1002

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

1003

# image.

1004

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

1005

},

1006

],

1007

},

Bu Sun Kim

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

[diff] [blame^]

1008

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

Bu Sun Kim

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

[diff] [blame]

1009

{ # Set of detected entity features.

Bu Sun Kim

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

[diff] [blame]

1010

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

1011

# `description` is expressed.

Bu Sun Kim

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

[diff] [blame]

1012

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

1013

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

1014

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

1015

# detected distant towering building, even though the confidence that

1016

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

1017

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

1018

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

1019

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

1020

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

1021

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

1022

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

1023

},

1024

],

Bu Sun Kim

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

[diff] [blame^]

1025

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

1026

# [Google Knowledge Graph Search

1027

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

1028

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

1029

# The accuracy of the entity detection in an image.

1030

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

1031

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

1032

# image. Range [0, 1].

1033

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

1034

# for `LABEL_DETECTION` features.

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.

},

],

},

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

1052

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

1053

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

1054

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

1055

# Location information is usually present for landmarks.

1056

{ # Detected entity location information.

1057

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

1058

# of doubles representing degrees latitude and degrees longitude. Unless

1059

# specified otherwise, this must conform to the

1060

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

1061

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

1062

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

1063

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

1068

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

Bu Sun Kim

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

[diff] [blame]

1069

},

1070

],

Bu Sun Kim

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

[diff] [blame^]

1071

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

1072

# This will be sorted descending by confidence score.

1073

{ # Set of detected objects with bounding boxes.

1074

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

1075

"vertices": [ # The bounding polygon vertices.

1076

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

1077

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

1078

"y": 42, # Y coordinate.

1079

"x": 42, # X coordinate.

1080

},

1081

],

1082

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

1083

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

1084

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

1085

# and range from 0 to 1.

1086

"x": 3.14, # X coordinate.

1087

"y": 3.14, # Y coordinate.

},

],

},

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

1092

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

1093

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

1094

# information, see

1095

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

1096

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

1097

},

1098

],

1099

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

1100

{ # Set of detected entity features.

1101

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

1102

# `description` is expressed.

1103

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

1104

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

1105

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

1106

# detected distant towering building, even though the confidence that

1107

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

1108

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

1109

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

1110

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

1111

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

1112

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

1113

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

1114

},

1115

],

1116

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

1117

# [Google Knowledge Graph Search

1118

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

1119

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

1120

# The accuracy of the entity detection in an image.

1121

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

1122

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

1123

# image. Range [0, 1].

1124

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

1125

# for `LABEL_DETECTION` features.

1126

"vertices": [ # The bounding polygon vertices.

1127

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

1128

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

1129

"y": 42, # Y coordinate.

1130

"x": 42, # X coordinate.

1131

},

1132

],

1133

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

1134

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

1135

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

1136

# and range from 0 to 1.

1137

"x": 3.14, # X coordinate.

1138

"y": 3.14, # Y coordinate.

},

],

},

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

1143

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

1144

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

1145

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

1146

# Location information is usually present for landmarks.

1147

{ # Detected entity location information.

1148

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

1149

# of doubles representing degrees latitude and degrees longitude. Unless

1150

# specified otherwise, this must conform to the

1151

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

1152

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

1153

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

1154

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

1159

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

1160

},

1161

],

1162

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

1163

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

1164

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

1165

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

1166

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

1167

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

1168

# image.

1169

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

1170

"vertices": [ # The bounding polygon vertices.

1171

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

1172

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

1173

"y": 42, # Y coordinate.

1174

"x": 42, # X coordinate.

1175

},

1176

],

1177

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

1178

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

1179

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

1180

# and range from 0 to 1.

1181

"x": 3.14, # X coordinate.

1182

"y": 3.14, # Y coordinate.

},

],

},

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

1187

{ # Information about a product.

1188

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

1189

# to the query.

1190

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

1191

# 1 (full confidence).

1192

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

1193

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

1194

# 4096 characters long.

1195

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

1196

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

1197

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

1198

# not be used for new products.

1199

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

1200

# constraints can be specified based on the product_labels.

1201

#

1202

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

1203

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

1204

# to be supported soon.

1205

#

1206

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

1207

# 500 product_labels.

1208

#

1209

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

1210

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

1211

# will refuse to work for that ProductSet.

1212

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

1213

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

1214

# exceed 128 bytes.

1215

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

1216

# cannot exceed 128 bytes.

1217

},

1218

],

1219

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

1220

#

1221

# Format is:

1222

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

1223

#

1224

# This field is ignored when creating a product.

1225

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

1231

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

1232

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

1233

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

1234

# information, see

1235

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

1236

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

1237

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

},

],

},

],

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

1243

{ # Information about a product.

1244

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

1245

# to the query.

1246

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

1247

# 1 (full confidence).

1248

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

1249

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

1250

# 4096 characters long.

1251

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

1252

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

1253

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

1254

# not be used for new products.

1255

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

1256

# constraints can be specified based on the product_labels.

1257

#

1258

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

1259

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

1260

# to be supported soon.

1261

#

1262

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

1263

# 500 product_labels.

1264

#

1265

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

1266

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

1267

# will refuse to work for that ProductSet.

1268

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

1269

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

1270

# exceed 128 bytes.

1271

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

1272

# cannot exceed 128 bytes.

1273

},

1274

],

1275

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

1276

#

1277

# Format is:

1278

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

1279

#

1280

# This field is ignored when creating a product.

1281

"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

1287

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

1288

# not reflected in the current results.

1289

},

1290

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

1291

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

1292

# violence).

1293

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

1294

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

1295

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

1296

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

1297

# body areas.

1298

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

1299

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

1300

# funny or offensive.

1301

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

1302

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

1303

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

1304

# sexual activities.

1305

},

Bu Sun Kim

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

[diff] [blame]

1306

},

1307

],

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]

1314

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

Bu Sun Kim

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

[diff] [blame]

1315

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

1316

files, such as PDF files, which may contain multiple pages and multiple

1317

images per page. Progress and results can be retrieved through the

1318

`google.longrunning.Operations` interface.

1319

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

1320

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

1321

1322

Args:

Dan O'Meara

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

[diff] [blame]

1323

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

1324

The object takes the form of:

1325

1326

{ # Multiple async file annotation requests are batched into a single service

1327

# call.

Bu Sun Kim

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

[diff] [blame]

1328

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

Bu Sun Kim

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

[diff] [blame]

1329

{ # An offline file annotation request.

Bu Sun Kim

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

[diff] [blame]

1330

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

Bu Sun Kim

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

[diff] [blame]

1331

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

Bu Sun Kim

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

[diff] [blame]

1332

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

1333

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

1334

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

1335

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

1336

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

1337

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

1338

# migrate existing products to these categories as well.

1339

"A String",

1340

],

Bu Sun Kim

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

[diff] [blame^]

1341

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

1342

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

1343

"vertices": [ # The bounding polygon vertices.

1344

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

1345

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

1346

"y": 42, # Y coordinate.

1347

"x": 42, # X coordinate.

1348

},

1349

],

1350

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

1351

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

1352

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

1353

# and range from 0 to 1.

1354

"x": 3.14, # X coordinate.

1355

"y": 3.14, # Y coordinate.

1356

},

1357

],

1358

},

Bu Sun Kim

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

[diff] [blame]

1359

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

1360

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

1361

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

1362

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

1363

#

1364

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

1365

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

1366

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

1367

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

1368

#

1369

# Format is:

1370

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

Bu Sun Kim

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

[diff] [blame]

1371

},

Bu Sun Kim

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

[diff] [blame^]

1372

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

1373

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

1374

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

1375

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

1376

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

1377

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

1383

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

1384

},

1385

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

1386

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

1387

# of doubles representing degrees latitude and degrees longitude. Unless

1388

# specified otherwise, this must conform to the

1389

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

1390

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

1391

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

1392

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

1393

},

1394

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

1395

# of doubles representing degrees latitude and degrees longitude. Unless

1396

# specified otherwise, this must conform to the

1397

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

1398

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

1399

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

1400

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

1401

},

1402

},

1403

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

1404

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

1405

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

1406

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

1407

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

1408

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

1409

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

1410

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

1411

"A String",

1412

],

Bu Sun Kim

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

[diff] [blame]

1413

},

Bu Sun Kim

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

[diff] [blame^]

1414

"features": [ # Required. Requested features.

1415

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

1416

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

1417

# be specified in the `features` list.

1418

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

1419

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

1420

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

1421

# "builtin/latest".

1422

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

1423

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

1424

},

1425

],

Bu Sun Kim

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

[diff] [blame]

1426

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

1427

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

1428

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

1429

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

1430

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

1431

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

1432

# 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

1438

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

1439

# output files will begin with "filenameprefix".

Bu Sun Kim

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

[diff] [blame]

1440

#

1441

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

1442

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

1443

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

1444

# specified.

1445

#

1446

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

1447

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

1448

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

1449

# and overflows into multiple sharded files.

1450

},

Bu Sun Kim

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

[diff] [blame]

1451

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

1452

# Google Cloud Storage.

1453

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

1454

#

1455

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

1456

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

1457

# containing 20 response protos will be written under the prefix

1458

# `gcs_destination`.`uri`.

1459

#

1460

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

1461

# support for other output configurations.

Bu Sun Kim

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

[diff] [blame]

1462

},

Bu Sun Kim

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

[diff] [blame]

1463

"inputConfig": { # The desired input location and metadata. # Required. Information about the input file.

Bu Sun Kim

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

[diff] [blame]

1464

"gcsSource": { # The Google Cloud Storage location where the input will be read from. # The Google Cloud Storage location to read the input from.

1465

"uri": "A String", # Google Cloud Storage URI for the input file. This must only be a

Bu Sun Kim

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

[diff] [blame]

1466

# Google Cloud Storage object. Wildcards are not currently supported.

1467

},

Bu Sun Kim

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

[diff] [blame]

1468

"mimeType": "A String", # The type of the file. Currently only "application/pdf", "image/tiff" and

1469

# "image/gif" are supported. Wildcards are not supported.

Bu Sun Kim

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

[diff] [blame^]

1470

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

1471

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

1472

# representation, whereas JSON representations use base64.

1473

#

1474

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

1475

# not work for AsyncBatchAnnotateFiles requests.

Bu Sun Kim

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

[diff] [blame]

1476

},

Bu Sun Kim

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

[diff] [blame]

1477

},

1478

],

Bu Sun Kim

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

[diff] [blame]

1479

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

Dan O'Meara

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

[diff] [blame]

1480

#

1481

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

1482

#

1483

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

1484

#

1485

# Supported location-ids:

1486

# `us`: USA country only,

1487

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

1488

# `eu`: The European Union.

1489

#

1490

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

Bu Sun Kim

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

[diff] [blame]

1491

}

1492

1493

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1500

1501

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

1502

# network API call.

Bu Sun Kim

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

[diff] [blame^]

1503

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

1504

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

1505

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

1506

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

1507

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

1508

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

1509

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

1510

# `TakeSnapshotResponse`.

1511

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

1512

},

1513

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

1514

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

1515

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

1516

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

1517

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

1518

},

1519

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

1520

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

1521

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

1522

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

1523

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

1524

# available.

Bu Sun Kim