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

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

[diff] [blame]

444

},

445

],

446

},

Bu Sun Kim

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

[diff] [blame]

447

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

448

{ # Set of detected entity features.

449

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

450

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

451

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

452

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

453

# detected distant towering building, even though the confidence that

454

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

455

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

456

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

457

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

458

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

459

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

460

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

461

},

462

],

463

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

464

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

465

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

466

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

467

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

468

# Location information is usually present for landmarks.

469

{ # Detected entity location information.

470

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

471

# of doubles representing degrees latitude and degrees longitude. Unless

472

# specified otherwise, this must conform to the

473

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

474

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

475

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

476

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

},

},

],

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

481

# [Google Knowledge Graph Search

482

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

483

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

484

# The accuracy of the entity detection in an image.

485

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

486

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

487

# image. Range [0, 1].

488

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

489

# for `LABEL_DETECTION` features.

490

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

Bu Sun Kim

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

[diff] [blame]

491

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

492

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

493

# and range from 0 to 1.

Bu Sun Kim

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

[diff] [blame]

494

"y": 3.14, # Y coordinate.

495

"x": 3.14, # X coordinate.

Bu Sun Kim

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

[diff] [blame]

496

},

497

],

Bu Sun Kim

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

[diff] [blame]

498

"vertices": [ # The bounding polygon vertices.

Bu Sun Kim

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

[diff] [blame]

499

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

500

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

501

"y": 42, # Y coordinate.

502

"x": 42, # X coordinate.

Bu Sun Kim

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

[diff] [blame]

503

},

504

],

505

},

Bu Sun Kim

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

[diff] [blame]

506

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

507

# `description` is expressed.

Bu Sun Kim

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

[diff] [blame]

508

},

509

],

Bu Sun Kim

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

[diff] [blame]

510

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

511

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

512

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

513

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

514

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

515

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

516

# image.

517

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

518

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

519

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

520

# information, see

521

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

522

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

523

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

524

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

525

},

526

],

527

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

528

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

529

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

530

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

531

# and range from 0 to 1.

532

"y": 3.14, # Y coordinate.

533

"x": 3.14, # X coordinate.

534

},

535

],

536

"vertices": [ # The bounding polygon vertices.

537

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

538

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

539

"y": 42, # Y coordinate.

540

"x": 42, # X coordinate.

},

],

},

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

545

{ # Information about a product.

546

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

547

# to the query.

548

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

549

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

550

# 4096 characters long.

551

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

552

# characters long.

553

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

554

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

555

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

556

# not be used for new products.

557

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

558

# constraints can be specified based on the product_labels.

559

#

560

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

561

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

562

# to be supported soon.

563

#

564

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

565

# 500 product_labels.

566

#

567

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

568

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

569

# will refuse to work for that ProductSet.

570

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

571

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

572

# exceed 128 bytes.

573

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

574

# cannot exceed 128 bytes.

575

},

576

],

577

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

578

#

579

# Format is:

580

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

581

#

582

# This field is ignored when creating a product.

583

},

584

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

585

# 1 (full confidence).

},

],

},

],

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

591

{ # Information about a product.

592

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

593

# to the query.

594

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

595

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

596

# 4096 characters long.

597

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

598

# characters long.

599

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

600

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

601

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

602

# not be used for new products.

603

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

604

# constraints can be specified based on the product_labels.

605

#

606

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

607

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

608

# to be supported soon.

609

#

610

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

611

# 500 product_labels.

612

#

613

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

614

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

615

# will refuse to work for that ProductSet.

616

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

617

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

618

# exceed 128 bytes.

619

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

620

# cannot exceed 128 bytes.

621

},

622

],

623

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

624

#

625

# Format is:

626

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

627

#

628

# This field is ignored when creating a product.

629

},

630

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

631

# 1 (full confidence).

632

},

633

],

634

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

635

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

636

# not reflected in the current results.

637

},

638

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

639

# This will be sorted descending by confidence score.

640

{ # Set of detected objects with bounding boxes.

641

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

642

# information, see

643

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

644

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

645

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

646

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

647

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

648

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

649

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

650

# and range from 0 to 1.

651

"y": 3.14, # Y coordinate.

652

"x": 3.14, # X coordinate.

653

},

654

],

655

"vertices": [ # The bounding polygon vertices.

656

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

657

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

658

"y": 42, # Y coordinate.

659

"x": 42, # X coordinate.

},

],

},

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

664

},

665

],

666

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

667

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

668

# correct, even when `error` is set.

669

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

670

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

671

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

672

#

673

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

674

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

675

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

676

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

677

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

678

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

679

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

680

# message types for APIs to use.

681

{

682

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

},

],

},

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

687

# completed successfully.

688

# This annotation provides the structural hierarchy for the OCR detected

689

# text.

690

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

Dan O'Meara

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

[diff] [blame]

691

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

Bu Sun Kim

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

[diff] [blame]

692

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

693

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

694

# to the TextAnnotation.TextProperty message definition below for more

695

# detail.

Bu Sun Kim

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

[diff] [blame]

696

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

Bu Sun Kim

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

[diff] [blame]

697

{ # Detected page from OCR.

Bu Sun Kim

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

[diff] [blame]

698

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

699

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

Bu Sun Kim

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

[diff] [blame]

700

# TIFFs) the unit is pixels.

Bu Sun Kim

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

[diff] [blame]

701

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

702

# TIFFs) the unit is pixels.

703

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

Bu Sun Kim

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

[diff] [blame]

704

{ # Logical element on the page.

Bu Sun Kim

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

[diff] [blame]

705

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

706

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

707

{ # Detected language for a structural component.

708

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

709

# information, see

710

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

711

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

712

},

713

],

714

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

715

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

716

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

717

},

718

},

719

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

720

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

721

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

722

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

723

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

724

# read in the 'natural' orientation.

Bu Sun Kim

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

[diff] [blame]

725

# For example:

726

#

727

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

733

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

740

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

Bu Sun Kim

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

[diff] [blame]

741

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

742

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

743

# and range from 0 to 1.

Bu Sun Kim

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

[diff] [blame]

744

"y": 3.14, # Y coordinate.

745

"x": 3.14, # X coordinate.

Bu Sun Kim

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

[diff] [blame]

746

},

747

],

Bu Sun Kim

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

[diff] [blame]

748

"vertices": [ # The bounding polygon vertices.

Bu Sun Kim

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

[diff] [blame]

749

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

750

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

751

"y": 42, # Y coordinate.

752

"x": 42, # X coordinate.

Bu Sun Kim

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

[diff] [blame]

753

},

754

],

755

},

Bu Sun Kim

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

[diff] [blame]

756

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

757

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

758

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

Bu Sun Kim

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

[diff] [blame]

759

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

760

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

761

{ # Detected language for a structural component.

762

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

763

# information, see

764

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

765

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

766

},

767

],

768

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

769

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

770

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

771

},

772

},

773

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

774

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

775

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

776

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

777

# read in the 'natural' orientation.

Bu Sun Kim

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

[diff] [blame]

778

# For example:

779

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

780

# 0----1

781

# | |

782

# 3----2

Bu Sun Kim

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

[diff] [blame]

783

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

788

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

Bu Sun Kim

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

[diff] [blame]

789

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

790

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

791

# and range from 0 to 1.

Bu Sun Kim

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

[diff] [blame]

792

"y": 3.14, # Y coordinate.

793

"x": 3.14, # X coordinate.

Bu Sun Kim

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

[diff] [blame]

794

},

795

],

Bu Sun Kim

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

[diff] [blame]

796

"vertices": [ # The bounding polygon vertices.

Bu Sun Kim

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

[diff] [blame]

797

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

798

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

799

"y": 42, # Y coordinate.

800

"x": 42, # X coordinate.

Bu Sun Kim

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

[diff] [blame]

801

},

802

],

803

},

Bu Sun Kim

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

[diff] [blame]

804

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

805

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

Bu Sun Kim

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

[diff] [blame]

806

{ # A word representation.

Bu Sun Kim

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

[diff] [blame]

807

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

808

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

809

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

810

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

811

# read in the 'natural' orientation.

Dan O'Meara

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

[diff] [blame]

812

# For example:

813

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

814

# 0----1

815

# | |

816

# 3----2

Bu Sun Kim

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

[diff] [blame]

817

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

822

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

Dan O'Meara

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

[diff] [blame]

823

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

824

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

825

# and range from 0 to 1.

Bu Sun Kim

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

[diff] [blame]

826

"y": 3.14, # Y coordinate.

827

"x": 3.14, # X coordinate.

Dan O'Meara

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

[diff] [blame]

828

},

829

],

Bu Sun Kim

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

[diff] [blame]

830

"vertices": [ # The bounding polygon vertices.

Dan O'Meara

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

[diff] [blame]

831

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

832

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

833

"y": 42, # Y coordinate.

834

"x": 42, # X coordinate.

Dan O'Meara

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

[diff] [blame]

835

},

836

],

837

},

Bu Sun Kim

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

[diff] [blame]

838

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

839

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

840

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

841

{ # A single symbol representation.

842

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

843

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

844

{ # Detected language for a structural component.

845

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

846

# information, see

847

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

848

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

849

},

850

],

851

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

852

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

853

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

854

},

855

},

856

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

857

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

858

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

859

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

860

# read in the 'natural' orientation.

861

# For example:

862

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

871

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

872

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

873

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

874

# and range from 0 to 1.

875

"y": 3.14, # Y coordinate.

876

"x": 3.14, # X coordinate.

877

},

878

],

879

"vertices": [ # The bounding polygon vertices.

880

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

881

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

882

"y": 42, # Y coordinate.

883

"x": 42, # X coordinate.

},

],

},

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

888

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

Bu Sun Kim

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

[diff] [blame]

889

},

Bu Sun Kim

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

[diff] [blame]

890

],

891

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

892

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

Bu Sun Kim

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

[diff] [blame]

893

{ # Detected language for a structural component.

Bu Sun Kim

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

[diff] [blame]

894

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

Bu Sun Kim

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

[diff] [blame]

895

# information, see

896

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

Bu Sun Kim

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

[diff] [blame]

897

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

Bu Sun Kim

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

[diff] [blame]

898

},

899

],

Bu Sun Kim

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

[diff] [blame]

900

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

901

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

902

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

903

},

Bu Sun Kim

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

[diff] [blame]

},

},

],

},

],

},

],

Bu Sun Kim

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

[diff] [blame]

911

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

912

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

913

{ # Detected language for a structural component.

914

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

915

# information, see

916

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

917

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

918

},

919

],

920

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

921

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

922

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

923

},

924

},

Bu Sun Kim

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

[diff] [blame]

925

},

926

],

Bu Sun Kim

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

[diff] [blame]

927

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

Bu Sun Kim

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

[diff] [blame]

928

},

Bu Sun Kim

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

[diff] [blame]

929

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

Bu Sun Kim

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

[diff] [blame]

930

{ # Set of detected entity features.

Bu Sun Kim

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

[diff] [blame]

931

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

932

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

933

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

934

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

Bu Sun Kim

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

[diff] [blame]

935

# detected distant towering building, even though the confidence that

936

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

Bu Sun Kim

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

[diff] [blame]

937

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

938

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

939

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

940

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

941

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

942

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

943

},

944

],

945

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

946

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

Bu Sun Kim

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

[diff] [blame]

947

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

948

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

949

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

950

# Location information is usually present for landmarks.

951

{ # Detected entity location information.

Bu Sun Kim

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

[diff] [blame]

952

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

Bu Sun Kim

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

[diff] [blame]

953

# of doubles representing degrees latitude and degrees longitude. Unless

954

# specified otherwise, this must conform to the

Bu Sun Kim

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

[diff] [blame]

955

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

Dan O'Meara

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

[diff] [blame]

956

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

Bu Sun Kim

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

[diff] [blame]

957

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

958

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

Bu Sun Kim

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

[diff] [blame]

959

},

960

},

961

],

Bu Sun Kim

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

[diff] [blame]

962

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

963

# [Google Knowledge Graph Search

964

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

965

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

966

# The accuracy of the entity detection in an image.

967

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

968

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

969

# image. Range [0, 1].

970

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

Bu Sun Kim

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

[diff] [blame]

971

# for `LABEL_DETECTION` features.

Bu Sun Kim

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

[diff] [blame]

972

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

Bu Sun Kim

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

[diff] [blame]

973

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

974

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

975

# and range from 0 to 1.

Bu Sun Kim

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

[diff] [blame]

976

"y": 3.14, # Y coordinate.

977

"x": 3.14, # X coordinate.

Bu Sun Kim

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

[diff] [blame]

978

},

979

],

Bu Sun Kim

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

[diff] [blame]

980

"vertices": [ # The bounding polygon vertices.

Bu Sun Kim

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

[diff] [blame]

981

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

982

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

983

"y": 42, # Y coordinate.

984

"x": 42, # X coordinate.

Bu Sun Kim

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

[diff] [blame]

985

},

986

],

987

},

Bu Sun Kim

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

[diff] [blame]

988

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

989

# `description` is expressed.

Bu Sun Kim

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

[diff] [blame]

990

},

991

],

Bu Sun Kim

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

[diff] [blame]

992

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

993

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

994

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

Bu Sun Kim

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

[diff] [blame]

995

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

996

# the image that the color occupies in the image.

Bu Sun Kim

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

[diff] [blame]

997

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

998

# Value in range [0, 1].

999

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

1000

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

1001

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

Bu Sun Kim

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

[diff] [blame]

1002

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

1003

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

Bu Sun Kim

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

[diff] [blame]

1004

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

1005

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

Bu Sun Kim

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

[diff] [blame]

1006

#

1007

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

1008

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

1009

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

# space.

#

# Example (Java):

#

# import com.google.type.Color;

1015

#

1016

# // ...

1017

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

1018

# float alpha = protocolor.hasAlpha()

1019

# ? protocolor.getAlpha().getValue()

1020

# : 1.0;

1021

#

1022

# return new java.awt.Color(

1023

# protocolor.getRed(),

1024

# protocolor.getGreen(),

1025

# protocolor.getBlue(),

# alpha);

# }

#

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

1030

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

1031

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

1032

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

1033

# float denominator = 255.0;

1034

# Color.Builder resultBuilder =

1035

# Color

1036

# .newBuilder()

1037

# .setRed(red / denominator)

1038

# .setGreen(green / denominator)

1039

# .setBlue(blue / denominator);

1040

# int alpha = color.getAlpha();

1041

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

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

1046

# .build());

1047

# }

1048

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

1053

#

1054

# // ...

1055

# static UIColor* fromProto(Color* protocolor) {

1056

# float red = [protocolor red];

1057

# float green = [protocolor green];

1058

# float blue = [protocolor blue];

1059

# FloatValue* alpha_wrapper = [protocolor alpha];

1060

# float alpha = 1.0;

1061

# if (alpha_wrapper != nil) {

1062

# alpha = [alpha_wrapper value];

1063

# }

1064

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

1065

# }

1066

#

1067

# static Color* toProto(UIColor* color) {

1068

# CGFloat red, green, blue, alpha;

Dan O'Meara

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

[diff] [blame]

1069

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

Bu Sun Kim

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

[diff] [blame]

1070

# return nil;

1071

# }

1072

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

1073

# [result setRed:red];

1074

# [result setGreen:green];

1075

# [result setBlue:blue];

Dan O'Meara

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

[diff] [blame]

1076

# if (alpha <= 0.9999) {

Bu Sun Kim

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

[diff] [blame]

1077

# [result setAlpha:floatWrapperWithValue(alpha)];

1078

# }

1079

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

1089

# var redFrac = rgb_color.red || 0.0;

1090

# var greenFrac = rgb_color.green || 0.0;

1091

# var blueFrac = rgb_color.blue || 0.0;

1092

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

1093

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

1094

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

1095

#

Bu Sun Kim

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

[diff] [blame]

1096

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

Bu Sun Kim

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

[diff] [blame]

1097

# return rgbToCssColor_(red, green, blue);

1098

# }

1099

#

1100

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

Bu Sun Kim

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

[diff] [blame]

1101

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

1102

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

Bu Sun Kim

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

[diff] [blame]

1103

# };

1104

#

1105

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

Dan O'Meara

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

[diff] [blame]

1106

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

Bu Sun Kim

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

[diff] [blame]

1107

# var hexString = rgbNumber.toString(16);

1108

# var missingZeros = 6 - hexString.length;

Bu Sun Kim

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

[diff] [blame]

1109

# var resultBuilder = ['#'];

Dan O'Meara

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

[diff] [blame]

1110

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

Bu Sun Kim

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

[diff] [blame]

1111

# resultBuilder.push('0');

Bu Sun Kim

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

[diff] [blame]

1112

# }

1113

# resultBuilder.push(hexString);

Bu Sun Kim

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

[diff] [blame]

1114

# return resultBuilder.join('');

Bu Sun Kim

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

[diff] [blame]

1115

# };

1116

#

1117

# // ...

Bu Sun Kim

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

[diff] [blame]

1118

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

1119

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

1120

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

1121

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

1122

# the final pixel color is defined by the equation:

1123

#

1124

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

1125

#

1126

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

1127

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

1128

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

1129

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

1130

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

1131

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

1132

},

Bu Sun Kim

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

[diff] [blame]

1133

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

Bu Sun Kim

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

[diff] [blame]

},

],

},

},

Bu Sun Kim

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

[diff] [blame]

1138

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

Bu Sun Kim

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

[diff] [blame]

1139

{ # Set of detected entity features.

Bu Sun Kim

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

[diff] [blame]

1140

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

1141

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

1142

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

1143

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

Bu Sun Kim

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

[diff] [blame]

1144

# detected distant towering building, even though the confidence that

1145

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

Bu Sun Kim

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

[diff] [blame]

1146

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

1147

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

1148

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

1149

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

1150

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

1151

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

1152

},

1153

],

1154

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

1155

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

Bu Sun Kim

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

[diff] [blame]

1156

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

1157

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

1158

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

1159

# Location information is usually present for landmarks.

1160

{ # Detected entity location information.

Bu Sun Kim

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

[diff] [blame]

1161

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

Bu Sun Kim

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

[diff] [blame]

1162

# of doubles representing degrees latitude and degrees longitude. Unless

1163

# specified otherwise, this must conform to the

Bu Sun Kim

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

[diff] [blame]

1164

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

Dan O'Meara

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

[diff] [blame]

1165

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

Bu Sun Kim

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

[diff] [blame]

1166

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

1167

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

Bu Sun Kim

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

[diff] [blame]

1168

},

1169

},

1170

],

Bu Sun Kim

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

[diff] [blame]

1171

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

Bu Sun Kim

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

[diff] [blame]

1172

# [Google Knowledge Graph Search

1173

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

Bu Sun Kim

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

[diff] [blame]

1174

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

1175

# The accuracy of the entity detection in an image.

1176

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

1177

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

1178

# image. Range [0, 1].

1179

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

Bu Sun Kim

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

[diff] [blame]

1180

# for `LABEL_DETECTION` features.

Bu Sun Kim

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

[diff] [blame]

1181

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

Bu Sun Kim

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

[diff] [blame]

1182

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

1183

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

1184

# and range from 0 to 1.

Bu Sun Kim

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

[diff] [blame]

1185

"y": 3.14, # Y coordinate.

1186

"x": 3.14, # X coordinate.

Bu Sun Kim

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

[diff] [blame]

1187

},

1188

],

Bu Sun Kim

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

[diff] [blame]

1189

"vertices": [ # The bounding polygon vertices.

Bu Sun Kim

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

[diff] [blame]

1190

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

1191

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

1192

"y": 42, # Y coordinate.

1193

"x": 42, # X coordinate.

Bu Sun Kim

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

[diff] [blame]

1194

},

1195

],

1196

},

Bu Sun Kim

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

[diff] [blame]

1197

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

1198

# `description` is expressed.

Bu Sun Kim

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

[diff] [blame]

1199

},

1200

],

Bu Sun Kim

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

[diff] [blame]

1201

"context": { # If an image was produced from a file (e.g. a PDF), this message gives # If present, contextual information is needed to understand where this image

Bu Sun Kim

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

[diff] [blame]

1202

# comes from.

1203

# information about the source of that image.

Bu Sun Kim

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

[diff] [blame]

1204

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

1205

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

Bu Sun Kim

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

[diff] [blame]

1206

# the file used to produce the image.

Bu Sun Kim

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

[diff] [blame]

1207

},

Bu Sun Kim

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

[diff] [blame]

1208

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

1209

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

1210

{ # Metadata for online images.

1211

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

1212

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

1213

},

1214

],

1215

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

1216

# Inferred from similar images on the open web.

1217

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

1218

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

1219

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

1220

# For more information, see

1221

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

1222

},

1223

],

1224

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

1225

# Can include resized copies of the query image.

1226

{ # Metadata for online images.

1227

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

1228

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

1229

},

1230

],

1231

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

1232

{ # Entity deduced from similar images on the Internet.

1233

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

1234

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

1235

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

1236

# Not normalized and not comparable across different image queries.

1237

},

1238

],

1239

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

1240

{ # Metadata for web pages.

1241

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

1242

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

1243

# Can include resized copies of the query image.

1244

{ # Metadata for online images.

1245

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

1246

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

1247

},

1248

],

1249

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

1250

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

1251

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

1252

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

1253

# crops.

1254

{ # Metadata for online images.

1255

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

1256

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

1257

},

1258

],

1259

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

1260

},

1261

],

1262

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

1263

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

1264

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

1265

{ # Metadata for online images.

1266

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

1267

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

Bu Sun Kim

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

[diff] [blame]

1268

},

1269

],

1270

},

Bu Sun Kim

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

[diff] [blame]

1271

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

1272

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

1273

# violence).

1274

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

1275

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

1276

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

1277

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

1278

# body areas.

1279

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

1280

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

1281

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

1282

# sexual activities.

1283

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

1284

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

1285

# funny or offensive.

Bu Sun Kim

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

[diff] [blame]

1286

},

1287

},

1288

],

Bu Sun Kim

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

[diff] [blame]

1289

"inputConfig": { # The desired input location and metadata. # Information about the file for which this response is generated.

1290

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

1291

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

1292

# representation, whereas JSON representations use base64.

1293

#

1294

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

1295

# not work for AsyncBatchAnnotateFiles requests.

1296

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

1297

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

1298

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

1299

},

1300

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

1301

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

Bu Sun Kim

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

[diff] [blame]

1302

},

Bu Sun Kim

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

[diff] [blame]

1303

"totalPages": 42, # This field gives the total number of pages in the file.

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]

1310

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

Bu Sun Kim

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

[diff] [blame]

1311

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

1312

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

1313

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

1314

`google.longrunning.Operations` interface.

1315

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

1316

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

1317

1318

Args:

Dan O'Meara

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

[diff] [blame]

1319

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

1320

The object takes the form of:

1321

1322

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

1323

# call.

Bu Sun Kim

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

[diff] [blame]

1324

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

Bu Sun Kim

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

[diff] [blame]

1325

{ # An offline file annotation request.

Bu Sun Kim

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

[diff] [blame]

1326

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

1327

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

Bu Sun Kim

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

[diff] [blame]

1328

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

1329

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

1330

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

1331

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

1332

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

1333

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

Dan O'Meara

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

[diff] [blame]

1334

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

Bu Sun Kim

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

[diff] [blame]

1335

"A String",

Bu Sun Kim

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

[diff] [blame]

1336

],

Bu Sun Kim

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

[diff] [blame]

1337

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

1338

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

1339

},

1340

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

1341

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

1342

# of doubles representing degrees latitude and degrees longitude. Unless

1343

# specified otherwise, this must conform to the

1344

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

1345

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

1346

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

1347

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

1348

},

1349

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

1350

# of doubles representing degrees latitude and degrees longitude. Unless

1351

# specified otherwise, this must conform to the

1352

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

1353

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

1354

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

1355

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

Bu Sun Kim

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

[diff] [blame]

1356

},

1357

},

Bu Sun Kim

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

[diff] [blame]

1358

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

1359

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

Bu Sun Kim

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

[diff] [blame]

1360

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

1361

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

1362

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

1363

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

# ignored.

3.14,

],

},

Bu Sun Kim

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

[diff] [blame]

1368

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

1369

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

1370

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

1371

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

1372

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

1373

#

1374

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

1375

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

1376

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

1377

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

1378

#

1379

# Format is:

1380

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

1381

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

1382

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

1383

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

1384

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

1385

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

1386

# and range from 0 to 1.

1387

"y": 3.14, # Y coordinate.

1388

"x": 3.14, # X coordinate.

1389

},

1390

],

1391

"vertices": [ # The bounding polygon vertices.

1392

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

1393

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

1394

"y": 42, # Y coordinate.

1395

"x": 42, # X coordinate.

},

],

},

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

1400

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

1401

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

1402

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

1403

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

1404

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

1405

# migrate existing products to these categories as well.

1406

"A String",

1407

],

Bu Sun Kim

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

[diff] [blame]

1408

},

1409

},

Bu Sun Kim

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

[diff] [blame]

1410

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

1411

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

1412

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

1413

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

1414

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

1415

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

1416

# 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

1422

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

1423

# output files will begin with "filenameprefix".

Bu Sun Kim

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

[diff] [blame]

1424

#

1425

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

1426

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

1427

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

1428

# specified.

1429

#

1430

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

1431

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

1432

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

1433

# and overflows into multiple sharded files.

1434

},

Bu Sun Kim

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

[diff] [blame]

1435

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

1436

# Google Cloud Storage.

1437

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

1438

#

1439

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

1440

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

1441

# containing 20 response protos will be written under the prefix

1442

# `gcs_destination`.`uri`.

1443

#

1444

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

1445

# support for other output configurations.

Bu Sun Kim

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

[diff] [blame]

1446

},

Bu Sun Kim

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

[diff] [blame]

1447

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

1448

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

Bu Sun Kim

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

[diff] [blame]

1449

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

1450

# representation, whereas JSON representations use base64.

1451

#

1452

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

1453

# not work for AsyncBatchAnnotateFiles requests.

Bu Sun Kim

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

[diff] [blame]

1454

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

1455

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

1456

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

1457

},

Bu Sun Kim

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

[diff] [blame]

1458

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

1459

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

Bu Sun Kim

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

[diff] [blame]

1460

},

Bu Sun Kim

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

[diff] [blame]

1461

"features": [ # Required. Requested features.

Bu Sun Kim

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

[diff] [blame]

1462

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

1463

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

1464

# be specified in the `features` list.

Bu Sun Kim

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

[diff] [blame]

1465

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

1466

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

Bu Sun Kim

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

[diff] [blame]

1467

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

Bu Sun Kim

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

[diff] [blame]

1468

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

1469

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

1470

# "builtin/latest".

Bu Sun Kim

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

[diff] [blame]

},

],

},

],

Bu Sun Kim

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

[diff] [blame]

1475

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

Dan O'Meara

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

[diff] [blame]

1476

#

1477

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

1478

#

1479

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

1480

#

1481

# Supported location-ids:

1482

# `us`: USA country only,

1483

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

1484

# `eu`: The European Union.

1485

#

1486

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

Bu Sun Kim

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

[diff] [blame]

1487

}

1488

1489

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1496

1497

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

1498

# network API call.

Bu Sun Kim

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

[diff] [blame]

1499

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

1500

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

1501

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

1502

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

1503

#

1504

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

1505

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

1506

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

1507

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

1508

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

1509

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

1510

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

1511

# message types for APIs to use.

1512

{

1513

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

},

],

},

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

1518

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

1519

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

1520

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

1521

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

1522

},

1523

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

1524

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

1525

# available.

1526

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

Bu Sun Kim

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

[diff] [blame]

1527

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

1528

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

1529

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

1530

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

1531

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

1532

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

1533

# `TakeSnapshotResponse`.

Bu Sun Kim

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

[diff] [blame]

1534

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

Bu Sun Kim

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

[diff] [blame]

1535

},

Bu Sun Kim

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

[diff] [blame]

1536

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

Bu Sun Kim

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

[diff] [blame]

1537

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

1538

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

Bu Sun Kim