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

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

[diff] [blame]

420

"x": 42, # X coordinate.

Bu Sun Kim

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

[diff] [blame^]

421

"y": 42, # Y coordinate.

Bu Sun Kim

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

[diff] [blame]

},

],

},

},

],

Bu Sun Kim

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

[diff] [blame]

427

},

Bu Sun Kim

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

[diff] [blame]

428

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

Bu Sun Kim

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

[diff] [blame]

429

{ # Set of detected entity features.

Bu Sun Kim

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

[diff] [blame]

430

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

431

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

Bu Sun Kim

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

[diff] [blame]

432

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

433

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

434

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

435

# Location information is usually present for landmarks.

436

{ # Detected entity location information.

Bu Sun Kim

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

[diff] [blame]

437

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

438

# of doubles representing degrees latitude and degrees longitude. Unless

439

# specified otherwise, this must conform to the

Bu Sun Kim

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

[diff] [blame]

440

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

441

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

Bu Sun Kim

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

[diff] [blame]

442

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

443

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

444

},

445

},

446

],

Bu Sun Kim

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

[diff] [blame]

447

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

Bu Sun Kim

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

[diff] [blame]

448

# [Google Knowledge Graph Search

449

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

Bu Sun Kim

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

[diff] [blame]

450

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

451

# The accuracy of the entity detection in an image.

452

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

453

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

454

# image. Range [0, 1].

455

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

456

# `description` is expressed.

457

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

458

# for `LABEL_DETECTION` features.

Bu Sun Kim

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

[diff] [blame]

459

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

Bu Sun Kim

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

[diff] [blame]

460

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

461

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

462

# and range from 0 to 1.

Bu Sun Kim

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

[diff] [blame]

463

"y": 3.14, # Y coordinate.

464

"x": 3.14, # X coordinate.

Bu Sun Kim

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

[diff] [blame]

465

},

466

],

Bu Sun Kim

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

[diff] [blame]

467

"vertices": [ # The bounding polygon vertices.

Bu Sun Kim

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

[diff] [blame]

468

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

469

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

470

"x": 42, # X coordinate.

Bu Sun Kim

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

[diff] [blame^]

471

"y": 42, # Y coordinate.

Bu Sun Kim

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

[diff] [blame]

472

},

473

],

474

},

Bu Sun Kim

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

[diff] [blame]

475

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

476

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

477

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

478

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

479

# detected distant towering building, even though the confidence that

480

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

481

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

Bu Sun Kim

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

[diff] [blame]

482

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

483

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

Bu Sun Kim

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

[diff] [blame]

484

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

485

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

486

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

Bu Sun Kim

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

[diff] [blame]

},

],

},

],

Bu Sun Kim

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

[diff] [blame]

491

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

Bu Sun Kim

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

[diff] [blame]

492

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

493

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

494

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

495

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

496

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

497

# image.

498

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

499

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

Bu Sun Kim

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

[diff] [blame]

500

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

501

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

502

# information, see

503

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

504

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

Bu Sun Kim

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

[diff] [blame^]

505

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

Bu Sun Kim

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

[diff] [blame]

506

},

507

],

Bu Sun Kim

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

[diff] [blame]

508

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

509

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

510

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

511

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

512

# and range from 0 to 1.

513

"y": 3.14, # Y coordinate.

514

"x": 3.14, # X coordinate.

515

},

516

],

517

"vertices": [ # The bounding polygon vertices.

518

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

519

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

520

"x": 42, # X coordinate.

Bu Sun Kim

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

[diff] [blame^]

521

"y": 42, # Y coordinate.

Bu Sun Kim

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

[diff] [blame]

},

],

},

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

526

{ # Information about a product.

527

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

528

# to the query.

529

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

530

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

531

#

532

# Format is:

533

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

534

#

535

# This field is ignored when creating a product.

536

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

537

# 4096 characters long.

538

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

539

# characters long.

540

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

541

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

542

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

543

# not be used for new products.

544

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

545

# constraints can be specified based on the product_labels.

546

#

547

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

548

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

549

# to be supported soon.

550

#

551

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

552

# 500 product_labels.

553

#

554

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

555

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

556

# will refuse to work for that ProductSet.

557

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

558

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

559

# cannot exceed 128 bytes.

560

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

# exceed 128 bytes.

},

],

},

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

566

# 1 (full confidence).

Bu Sun Kim

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

[diff] [blame]

},

],

},

],

Bu Sun Kim

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

[diff] [blame]

571

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

572

{ # Information about a product.

573

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

574

# to the query.

575

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

576

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

577

#

578

# Format is:

579

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

580

#

581

# This field is ignored when creating a product.

582

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

583

# 4096 characters long.

584

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

585

# characters long.

586

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

587

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

588

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

589

# not be used for new products.

590

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

591

# constraints can be specified based on the product_labels.

592

#

593

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

594

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

595

# to be supported soon.

596

#

597

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

598

# 500 product_labels.

599

#

600

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

601

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

602

# will refuse to work for that ProductSet.

603

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

604

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

605

# cannot exceed 128 bytes.

606

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

# exceed 128 bytes.

},

],

},

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

612

# 1 (full confidence).

Bu Sun Kim

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

[diff] [blame]

613

},

614

],

Bu Sun Kim

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

[diff] [blame^]

615

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

616

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

617

# not reflected in the current results.

Bu Sun Kim

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

[diff] [blame]

618

},

Bu Sun Kim

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

[diff] [blame]

619

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

Bu Sun Kim

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

[diff] [blame]

620

# This will be sorted descending by confidence score.

621

{ # Set of detected objects with bounding boxes.

Bu Sun Kim

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

[diff] [blame^]

622

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

623

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

624

# information, see

625

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

626

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

Bu Sun Kim

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

[diff] [blame]

627

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

628

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

629

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

Bu Sun Kim

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

[diff] [blame]

630

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

631

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

632

# and range from 0 to 1.

Bu Sun Kim

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

[diff] [blame]

633

"y": 3.14, # Y coordinate.

634

"x": 3.14, # X coordinate.

Bu Sun Kim

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

[diff] [blame]

635

},

636

],

Bu Sun Kim

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

[diff] [blame]

637

"vertices": [ # The bounding polygon vertices.

Bu Sun Kim

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

[diff] [blame]

638

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

639

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

640

"x": 42, # X coordinate.

Bu Sun Kim

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

[diff] [blame^]

641

"y": 42, # Y coordinate.

Bu Sun Kim

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

[diff] [blame]

642

},

643

],

644

},

Bu Sun Kim

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

[diff] [blame]

645

},

646

],

Bu Sun Kim

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

[diff] [blame]

647

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

648

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

649

# correct, even when `error` is set.

650

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

651

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

652

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

653

#

654

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

655

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

Bu Sun Kim

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

[diff] [blame^]

656

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

657

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

658

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

659

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

Bu Sun Kim

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

[diff] [blame]

660

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

661

# message types for APIs to use.

662

{

663

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

664

},

665

],

Bu Sun Kim

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

[diff] [blame]

666

},

667

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

668

# completed successfully.

669

# This annotation provides the structural hierarchy for the OCR detected

670

# text.

671

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

Dan O'Meara

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

[diff] [blame]

672

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

Bu Sun Kim

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

[diff] [blame]

673

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

674

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

675

# to the TextAnnotation.TextProperty message definition below for more

676

# detail.

Bu Sun Kim

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

[diff] [blame]

677

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

Bu Sun Kim

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

[diff] [blame]

678

{ # Detected page from OCR.

Bu Sun Kim

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

[diff] [blame]

679

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

Bu Sun Kim

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

[diff] [blame]

680

{ # Logical element on the page.

Bu Sun Kim

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

[diff] [blame]

681

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

Bu Sun Kim

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

[diff] [blame]

682

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

683

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

684

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

685

},

Bu Sun Kim

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

[diff] [blame^]

686

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

687

{ # Detected language for a structural component.

688

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

689

# information, see

690

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

691

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

692

},

693

],

Bu Sun Kim

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

[diff] [blame]

694

},

695

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

696

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

697

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

698

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

699

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

700

# read in the 'natural' orientation.

Bu Sun Kim

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

[diff] [blame]

701

# For example:

702

#

703

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

709

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

716

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

Bu Sun Kim

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

[diff] [blame]

717

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

718

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

719

# and range from 0 to 1.

Bu Sun Kim

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

[diff] [blame]

720

"y": 3.14, # Y coordinate.

721

"x": 3.14, # X coordinate.

Bu Sun Kim

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

[diff] [blame]

722

},

723

],

Bu Sun Kim

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

[diff] [blame]

724

"vertices": [ # The bounding polygon vertices.

Bu Sun Kim

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

[diff] [blame]

725

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

726

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

727

"x": 42, # X coordinate.

Bu Sun Kim

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

[diff] [blame^]

728

"y": 42, # Y coordinate.

Bu Sun Kim

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

[diff] [blame]

729

},

730

],

731

},

Bu Sun Kim

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

[diff] [blame]

732

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

733

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

734

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

Bu Sun Kim

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

[diff] [blame]

735

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

Bu Sun Kim

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

[diff] [blame]

736

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

737

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

738

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

739

},

Bu Sun Kim

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

[diff] [blame^]

740

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

741

{ # Detected language for a structural component.

742

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

743

# information, see

744

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

745

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

746

},

747

],

Bu Sun Kim

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

[diff] [blame]

748

},

749

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

750

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

751

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

752

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

753

# read in the 'natural' orientation.

Bu Sun Kim

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

[diff] [blame]

754

# For example:

755

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

756

# 0----1

757

# | |

758

# 3----2

Bu Sun Kim

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

[diff] [blame]

759

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

764

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

Bu Sun Kim

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

[diff] [blame]

765

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

766

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

767

# and range from 0 to 1.

Bu Sun Kim

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

[diff] [blame]

768

"y": 3.14, # Y coordinate.

769

"x": 3.14, # X coordinate.

Bu Sun Kim

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

[diff] [blame]

770

},

771

],

Bu Sun Kim

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

[diff] [blame]

772

"vertices": [ # The bounding polygon vertices.

Bu Sun Kim

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

[diff] [blame]

773

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

774

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

775

"x": 42, # X coordinate.

Bu Sun Kim

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

[diff] [blame^]

776

"y": 42, # Y coordinate.

Bu Sun Kim

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

[diff] [blame]

777

},

778

],

779

},

Bu Sun Kim

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

[diff] [blame]

780

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

781

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

Bu Sun Kim

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

[diff] [blame]

782

{ # A word representation.

Bu Sun Kim

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

[diff] [blame]

783

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

Bu Sun Kim

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

[diff] [blame]

784

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

785

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

786

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

787

# read in the 'natural' orientation.

Bu Sun Kim

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

[diff] [blame]

788

# For example:

789

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

790

# 0----1

791

# | |

792

# 3----2

Bu Sun Kim

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

[diff] [blame]

793

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

798

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

Bu Sun Kim

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

[diff] [blame]

799

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

800

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

801

# and range from 0 to 1.

Bu Sun Kim

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

[diff] [blame]

802

"y": 3.14, # Y coordinate.

803

"x": 3.14, # X coordinate.

Bu Sun Kim

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

[diff] [blame]

804

},

805

],

Bu Sun Kim

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

[diff] [blame]

806

"vertices": [ # The bounding polygon vertices.

Bu Sun Kim

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

[diff] [blame]

807

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

808

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

809

"x": 42, # X coordinate.

Bu Sun Kim

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

[diff] [blame^]

810

"y": 42, # Y coordinate.

Bu Sun Kim

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

[diff] [blame]

811

},

812

],

813

},

Bu Sun Kim

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

[diff] [blame]

814

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

815

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

Bu Sun Kim

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

[diff] [blame]

816

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

817

{ # A single symbol representation.

Bu Sun Kim

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

[diff] [blame^]

818

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

819

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

820

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

821

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

822

},

823

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

824

{ # Detected language for a structural component.

825

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

826

# information, see

827

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

828

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

829

},

830

],

831

},

Bu Sun Kim

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

[diff] [blame]

832

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

Bu Sun Kim

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

[diff] [blame]

833

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

834

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

835

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

836

# read in the 'natural' orientation.

Bu Sun Kim

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

[diff] [blame]

837

# For example:

838

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

839

# 0----1

840

# | |

841

# 3----2

Bu Sun Kim

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

[diff] [blame]

842

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

843

# 2----3

844

# | |

845

# 1----0

Dan O'Meara

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

[diff] [blame]

846

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

Bu Sun Kim

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

[diff] [blame]

847

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

Bu Sun Kim

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

[diff] [blame]

848

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

849

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

850

# and range from 0 to 1.

Bu Sun Kim

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

[diff] [blame]

851

"y": 3.14, # Y coordinate.

852

"x": 3.14, # X coordinate.

Bu Sun Kim

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

[diff] [blame]

853

},

854

],

Bu Sun Kim

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

[diff] [blame]

855

"vertices": [ # The bounding polygon vertices.

Bu Sun Kim

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

[diff] [blame]

856

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

857

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

858

"x": 42, # X coordinate.

Bu Sun Kim

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

[diff] [blame^]

859

"y": 42, # Y coordinate.

Bu Sun Kim

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

[diff] [blame]

860

},

861

],

862

},

Bu Sun Kim

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

[diff] [blame]

863

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

864

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

Bu Sun Kim

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

[diff] [blame]

865

},

866

],

Bu Sun Kim

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

[diff] [blame]

867

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

Bu Sun Kim

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

[diff] [blame]

868

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

869

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

870

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

871

},

Bu Sun Kim

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

[diff] [blame^]

872

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

873

{ # Detected language for a structural component.

874

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

875

# information, see

876

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

877

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

878

},

879

],

Bu Sun Kim

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

[diff] [blame]

},

},

],

},

],

},

],

Bu Sun Kim

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

[diff] [blame]

887

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

Bu Sun Kim

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

[diff] [blame]

888

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

889

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

890

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

891

},

Bu Sun Kim

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

[diff] [blame^]

892

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

893

{ # Detected language for a structural component.

894

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

895

# information, see

896

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

897

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

898

},

899

],

Bu Sun Kim

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

[diff] [blame]

900

},

901

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

Bu Sun Kim

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

[diff] [blame^]

902

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

903

# TIFFs) the unit is pixels.

904

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

905

# TIFFs) the unit is pixels.

Bu Sun Kim

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

[diff] [blame]

906

},

907

],

Bu Sun Kim

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

[diff] [blame]

908

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

Bu Sun Kim

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

[diff] [blame]

909

},

Bu Sun Kim

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

[diff] [blame]

910

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

Bu Sun Kim

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

[diff] [blame]

911

{ # Set of detected entity features.

Bu Sun Kim

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

[diff] [blame]

912

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

913

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

Bu Sun Kim

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

[diff] [blame]

914

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

915

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

916

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

917

# Location information is usually present for landmarks.

918

{ # Detected entity location information.

Bu Sun Kim

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

[diff] [blame]

919

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

920

# of doubles representing degrees latitude and degrees longitude. Unless

921

# specified otherwise, this must conform to the

Bu Sun Kim

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

[diff] [blame]

922

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

923

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

Bu Sun Kim

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

[diff] [blame]

924

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

925

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

926

},

927

},

928

],

Bu Sun Kim

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

[diff] [blame]

929

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

Bu Sun Kim

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

[diff] [blame]

930

# [Google Knowledge Graph Search

931

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

Bu Sun Kim

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

[diff] [blame]

932

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

933

# The accuracy of the entity detection in an image.

934

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

935

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

936

# image. Range [0, 1].

937

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

938

# `description` is expressed.

939

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

940

# for `LABEL_DETECTION` features.

Bu Sun Kim

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

[diff] [blame]

941

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

Bu Sun Kim

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

[diff] [blame]

942

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

943

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

944

# and range from 0 to 1.

Bu Sun Kim

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

[diff] [blame]

945

"y": 3.14, # Y coordinate.

946

"x": 3.14, # X coordinate.

Bu Sun Kim

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

[diff] [blame]

947

},

948

],

Bu Sun Kim

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

[diff] [blame]

949

"vertices": [ # The bounding polygon vertices.

Bu Sun Kim

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

[diff] [blame]

950

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

951

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

952

"x": 42, # X coordinate.

Bu Sun Kim

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

[diff] [blame^]

953

"y": 42, # Y coordinate.

Bu Sun Kim

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

[diff] [blame]

954

},

955

],

956

},

Bu Sun Kim

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

[diff] [blame]

957

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

958

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

959

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

960

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

961

# detected distant towering building, even though the confidence that

962

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

963

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

Bu Sun Kim

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

[diff] [blame]

964

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

965

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

Bu Sun Kim

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

[diff] [blame]

966

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

967

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

968

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

Bu Sun Kim

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

[diff] [blame]

},

],

},

],

Bu Sun Kim

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

[diff] [blame]

973

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

974

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

975

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

Bu Sun Kim

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

[diff] [blame]

976

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

977

# the image that the color occupies in the image.

Bu Sun Kim

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

[diff] [blame^]

978

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

979

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

980

# Value in range [0, 1].

981

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

982

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

983

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

Bu Sun Kim

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

[diff] [blame]

984

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

985

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

Bu Sun Kim

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

[diff] [blame]

986

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

987

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

Bu Sun Kim

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

[diff] [blame]

988

#

989

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

990

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

991

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

# space.

#

# Example (Java):

#

# import com.google.type.Color;

997

#

998

# // ...

999

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

1000

# float alpha = protocolor.hasAlpha()

1001

# ? protocolor.getAlpha().getValue()

1002

# : 1.0;

1003

#

1004

# return new java.awt.Color(

1005

# protocolor.getRed(),

1006

# protocolor.getGreen(),

1007

# protocolor.getBlue(),

# alpha);

# }

#

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

1012

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

1013

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

1014

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

1015

# float denominator = 255.0;

1016

# Color.Builder resultBuilder =

1017

# Color

1018

# .newBuilder()

1019

# .setRed(red / denominator)

1020

# .setGreen(green / denominator)

1021

# .setBlue(blue / denominator);

1022

# int alpha = color.getAlpha();

1023

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

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

1028

# .build());

1029

# }

1030

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

1035

#

1036

# // ...

1037

# static UIColor* fromProto(Color* protocolor) {

1038

# float red = [protocolor red];

1039

# float green = [protocolor green];

1040

# float blue = [protocolor blue];

1041

# FloatValue* alpha_wrapper = [protocolor alpha];

1042

# float alpha = 1.0;

1043

# if (alpha_wrapper != nil) {

1044

# alpha = [alpha_wrapper value];

1045

# }

1046

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

1047

# }

1048

#

1049

# static Color* toProto(UIColor* color) {

1050

# CGFloat red, green, blue, alpha;

Dan O'Meara

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

[diff] [blame]

1051

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

Bu Sun Kim

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

[diff] [blame]

1052

# return nil;

1053

# }

1054

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

1055

# [result setRed:red];

1056

# [result setGreen:green];

1057

# [result setBlue:blue];

Dan O'Meara

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

[diff] [blame]

1058

# if (alpha <= 0.9999) {

Bu Sun Kim

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

[diff] [blame]

1059

# [result setAlpha:floatWrapperWithValue(alpha)];

1060

# }

1061

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

1071

# var redFrac = rgb_color.red || 0.0;

1072

# var greenFrac = rgb_color.green || 0.0;

1073

# var blueFrac = rgb_color.blue || 0.0;

1074

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

1075

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

1076

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

1077

#

Bu Sun Kim

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

[diff] [blame]

1078

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

Bu Sun Kim

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

[diff] [blame]

1079

# return rgbToCssColor_(red, green, blue);

1080

# }

1081

#

1082

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

Bu Sun Kim

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

[diff] [blame]

1083

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

1084

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

Bu Sun Kim

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

[diff] [blame]

1085

# };

1086

#

1087

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

Dan O'Meara

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

[diff] [blame]

1088

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

Bu Sun Kim

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

[diff] [blame]

1089

# var hexString = rgbNumber.toString(16);

1090

# var missingZeros = 6 - hexString.length;

Bu Sun Kim

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

[diff] [blame]

1091

# var resultBuilder = ['#'];

Dan O'Meara

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

[diff] [blame]

1092

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

Bu Sun Kim

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

[diff] [blame]

1093

# resultBuilder.push('0');

Bu Sun Kim

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

[diff] [blame]

1094

# }

1095

# resultBuilder.push(hexString);

Bu Sun Kim

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

[diff] [blame]

1096

# return resultBuilder.join('');

Bu Sun Kim

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

[diff] [blame]

1097

# };

1098

#

1099

# // ...

Bu Sun Kim

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

[diff] [blame]

1100

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

1101

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

1102

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

1103

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

1104

# the final pixel color is defined by the equation:

1105

#

1106

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

1107

#

1108

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

1109

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

1110

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

1111

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

1112

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

1113

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

1114

},

Bu Sun Kim

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

[diff] [blame]

},

],

},

},

Bu Sun Kim

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

[diff] [blame]

1119

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

Bu Sun Kim

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

[diff] [blame]

1120

{ # Set of detected entity features.

Bu Sun Kim

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

[diff] [blame]

1121

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

1122

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

Bu Sun Kim

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

[diff] [blame]

1123

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

1124

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

1125

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

1126

# Location information is usually present for landmarks.

1127

{ # Detected entity location information.

Bu Sun Kim

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

[diff] [blame]

1128

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

1129

# of doubles representing degrees latitude and degrees longitude. Unless

1130

# specified otherwise, this must conform to the

Bu Sun Kim

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

[diff] [blame]

1131

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

1132

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

Bu Sun Kim

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

[diff] [blame]

1133

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

1134

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

1135

},

1136

},

1137

],

Bu Sun Kim

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

[diff] [blame]

1138

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

Bu Sun Kim

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

[diff] [blame]

1139

# [Google Knowledge Graph Search

1140

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

Bu Sun Kim

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

[diff] [blame]

1141

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

Bu Sun Kim

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

[diff] [blame]

1142

# The accuracy of the entity detection in an image.

Bu Sun Kim

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

[diff] [blame]

1143

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

Bu Sun Kim

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

[diff] [blame]

1144

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

1145

# image. Range [0, 1].

Bu Sun Kim

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

[diff] [blame]

1146

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

Bu Sun Kim

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

[diff] [blame]

1147

# `description` is expressed.

Bu Sun Kim

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

[diff] [blame]

1148

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

1149

# for `LABEL_DETECTION` features.

Bu Sun Kim

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

[diff] [blame]

1150

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

Bu Sun Kim

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

[diff] [blame]

1151

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

1152

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

1153

# and range from 0 to 1.

Bu Sun Kim

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

[diff] [blame]

1154

"y": 3.14, # Y coordinate.

1155

"x": 3.14, # X coordinate.

Bu Sun Kim

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

[diff] [blame]

1156

},

1157

],

Bu Sun Kim

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

[diff] [blame]

1158

"vertices": [ # The bounding polygon vertices.

Bu Sun Kim

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

[diff] [blame]

1159

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

1160

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

1161

"x": 42, # X coordinate.

Bu Sun Kim

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

[diff] [blame^]

1162

"y": 42, # Y coordinate.

Bu Sun Kim

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

[diff] [blame]

1163

},

1164

],

1165

},

Bu Sun Kim

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

[diff] [blame]

1166

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

1167

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

1168

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

1169

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

1170

# detected distant towering building, even though the confidence that

1171

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

1172

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

Bu Sun Kim

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

[diff] [blame]

1173

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

1174

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

Bu Sun Kim

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

[diff] [blame]

1175

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

1176

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

1177

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

Bu Sun Kim

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

[diff] [blame]

},

],

},

],

Bu Sun Kim

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

[diff] [blame]

1182

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

1183

# comes from.

1184

# information about the source of that image.

Bu Sun Kim

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

[diff] [blame]

1185

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

1186

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

1187

# the file used to produce the image.

Bu Sun Kim

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

[diff] [blame]

1188

},

Bu Sun Kim

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

[diff] [blame]

1189

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

Bu Sun Kim

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

[diff] [blame^]

1190

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

1191

{ # Metadata for online images.

1192

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

1193

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

1194

},

1195

],

1196

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

1197

# Inferred from similar images on the open web.

1198

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

1199

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

1200

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

1201

# For more information, see

1202

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

1203

},

1204

],

Bu Sun Kim

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

[diff] [blame]

1205

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

1206

# Can include resized copies of the query image.

1207

{ # Metadata for online images.

Bu Sun Kim

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

[diff] [blame]

1208

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

Bu Sun Kim

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

[diff] [blame^]

1209

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

Bu Sun Kim

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

[diff] [blame]

1210

},

1211

],

1212

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

1213

{ # Entity deduced from similar images on the Internet.

Bu Sun Kim

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

[diff] [blame]

1214

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

1215

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

Bu Sun Kim

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

[diff] [blame^]

1216

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

1217

# Not normalized and not comparable across different image queries.

Bu Sun Kim

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

[diff] [blame]

1218

},

1219

],

1220

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

1221

{ # Metadata for web pages.

1222

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

1223

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

1224

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

1225

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

1226

# crops.

1227

{ # Metadata for online images.

Bu Sun Kim

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

[diff] [blame]

1228

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

Bu Sun Kim

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

[diff] [blame^]

1229

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

Bu Sun Kim

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

[diff] [blame]

1230

},

1231

],

1232

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

1233

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

1234

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

1235

# Can include resized copies of the query image.

1236

{ # Metadata for online images.

Bu Sun Kim

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

[diff] [blame]

1237

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

Bu Sun Kim

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

[diff] [blame^]

1238

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

Bu Sun Kim

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

[diff] [blame]

},

],

},

],

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

1244

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

1245

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

1246

{ # Metadata for online images.

Bu Sun Kim

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

[diff] [blame]

1247

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

Bu Sun Kim

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

[diff] [blame]

1248

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

Bu Sun Kim

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

[diff] [blame]

1249

},

1250

],

1251

},

Bu Sun Kim

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

[diff] [blame]

1252

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

1253

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

1254

# violence).

1255

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

1256

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

1257

# sexual activities.

1258

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

1259

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

1260

# funny or offensive.

1261

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

1262

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

1263

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

1264

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

1265

# body areas.

1266

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

1267

},

Bu Sun Kim

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

[diff] [blame]

1268

},

1269

],

Bu Sun Kim

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

[diff] [blame]

1270

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

Bu Sun Kim

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

[diff] [blame]

1271

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

1272

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

1273

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

1274

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

1275

# representation, whereas JSON representations use base64.

1276

#

1277

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

1278

# not work for AsyncBatchAnnotateFiles requests.

Bu Sun Kim

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

[diff] [blame^]

1279

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

1280

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

1281

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

1282

},

Bu Sun Kim

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

[diff] [blame]

1283

},

Bu Sun Kim

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

[diff] [blame]

1284

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

Bu Sun Kim

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

[diff] [blame^]

1285

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

1286

# `responses` field will not be set in this case.

1287

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

1288

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

1289

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

1290

#

1291

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

1292

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

1293

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

1294

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

1295

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

1296

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

1297

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

1298

# message types for APIs to use.

1299

{

1300

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

1301

},

1302

],

1303

},

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-27 12:20:54 -0700

[diff] [blame^]

1326

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

1327

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

1328

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

1329

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

1330

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

1331

# representation, whereas JSON representations use base64.

1332

#

1333

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

1334

# not work for AsyncBatchAnnotateFiles requests.

1335

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

1336

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

1337

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

1338

},

1339

},

1340

"features": [ # Required. Requested features.

1341

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

1342

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

1343

# be specified in the `features` list.

1344

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

1345

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

1346

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

1347

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

1348

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

1349

# "builtin/latest".

1350

},

1351

],

Bu Sun Kim

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

[diff] [blame]

1352

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

1353

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

1354

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

1355

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

1356

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

1357

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

1358

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

1359

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

1360

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

Bu Sun Kim

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

[diff] [blame]

1361

"A String",

Bu Sun Kim

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

[diff] [blame]

1362

],

Bu Sun Kim

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

[diff] [blame]

1363

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

1364

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

1365

},

1366

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

1367

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

1368

# of doubles representing degrees latitude and degrees longitude. Unless

1369

# specified otherwise, this must conform to the

1370

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

1371

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

1372

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

1373

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

1374

},

1375

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

1376

# of doubles representing degrees latitude and degrees longitude. Unless

1377

# specified otherwise, this must conform to the

1378

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

1379

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

1380

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

1381

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

1382

},

1383

},

Bu Sun Kim

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

[diff] [blame]

1384

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

1385

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

1386

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

1387

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

1388

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

1389

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

1394

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

Bu Sun Kim

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

[diff] [blame]

1395

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

1396

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

1397

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

1398

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

1399

#

1400

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

1401

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

1402

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

1403

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

1404

#

1405

# Format is:

1406

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

1407

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

1408

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

1409

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

1410

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

1411

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

1412

# and range from 0 to 1.

1413

"y": 3.14, # Y coordinate.

1414

"x": 3.14, # X coordinate.

1415

},

1416

],

1417

"vertices": [ # The bounding polygon vertices.

1418

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

1419

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

1420

"x": 42, # X coordinate.

Bu Sun Kim

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

[diff] [blame^]

1421

"y": 42, # Y coordinate.

Bu Sun Kim

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

[diff] [blame]

1422

},

1423

],

1424

},

Bu Sun Kim

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

[diff] [blame^]

1425

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

1426

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

1427

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

1428

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

1429

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

1430

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

1431

# migrate existing products to these categories as well.

1432

"A String",

1433

],

Bu Sun Kim

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

[diff] [blame]

1434

},

1435

},

Bu Sun Kim

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

[diff] [blame]

1436

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

Bu Sun Kim

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

[diff] [blame^]

1437

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

1438

# Google Cloud Storage.

1439

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

1440

#

1441

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

1442

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

1443

# containing 20 response protos will be written under the prefix

1444

# `gcs_destination`.`uri`.

1445

#

1446

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

1447

# support for other output configurations.

Bu Sun Kim

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

[diff] [blame]

1448

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

1449

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

1450

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

1451

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

1452

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

1453

# 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

1459

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

1460

# output files will begin with "filenameprefix".

Bu Sun Kim

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

[diff] [blame]

1461

#

1462

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

1463

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

1464

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

1465

# specified.

1466

#

1467

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

1468

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

1469

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

1470

# and overflows into multiple sharded files.

1471

},

1472

},

Bu Sun Kim

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

[diff] [blame]

1473

},

1474

],

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

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

1500

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

1501

# available.

1502

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

1503

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

1504

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

1505

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

1506

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

1507

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

1508

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

1509

# `TakeSnapshotResponse`.

Bu Sun Kim

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

[diff] [blame]

1510

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

Bu Sun Kim

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

[diff] [blame]

1511

},

Bu Sun Kim

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

[diff] [blame]

1512

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

1513

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

1514

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

Bu Sun Kim

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

[diff] [blame]

1515

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

Bu Sun Kim