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

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

[diff] [blame]

383

},

Bu Sun Kim

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

[diff] [blame]

384

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

Bu Sun Kim

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

[diff] [blame]

385

{ # Set of detected entity features.

Bu Sun Kim

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

[diff] [blame]

386

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

387

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

Bu Sun Kim

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

[diff] [blame]

388

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

389

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

390

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

391

# Location information is usually present for landmarks.

392

{ # Detected entity location information.

Bu Sun Kim

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

[diff] [blame]

393

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

394

# of doubles representing degrees latitude and degrees longitude. Unless

395

# specified otherwise, this must conform to the

Bu Sun Kim

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

[diff] [blame]

396

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

397

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

Bu Sun Kim

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

[diff] [blame]

398

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

399

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

400

},

401

},

402

],

Bu Sun Kim

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

[diff] [blame]

403

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

Bu Sun Kim

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

[diff] [blame]

404

# [Google Knowledge Graph Search

405

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

Bu Sun Kim

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

[diff] [blame]

406

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

407

# The accuracy of the entity detection in an image.

408

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

409

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

410

# image. Range [0, 1].

411

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

412

# `description` is expressed.

413

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

414

# for `LABEL_DETECTION` features.

Bu Sun Kim

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

[diff] [blame]

415

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

Bu Sun Kim

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

[diff] [blame]

416

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

417

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

418

# and range from 0 to 1.

Bu Sun Kim

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

[diff] [blame]

419

"y": 3.14, # Y coordinate.

420

"x": 3.14, # X coordinate.

Bu Sun Kim

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

[diff] [blame]

421

},

422

],

Bu Sun Kim

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

[diff] [blame]

423

"vertices": [ # The bounding polygon vertices.

Bu Sun Kim

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

[diff] [blame]

424

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

425

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

426

"y": 42, # Y coordinate.

427

"x": 42, # X coordinate.

Bu Sun Kim

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

[diff] [blame]

428

},

429

],

430

},

Bu Sun Kim

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

[diff] [blame]

431

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

432

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

433

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

434

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

435

# detected distant towering building, even though the confidence that

436

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

437

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

Bu Sun Kim

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

[diff] [blame]

438

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

439

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

Bu Sun Kim

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

[diff] [blame]

440

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

441

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

442

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

447

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

448

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

449

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

450

# not reflected in the current results.

451

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

452

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

453

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

454

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

455

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

456

# image.

457

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

458

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

459

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

460

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

461

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

462

# information, see

463

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

464

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

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

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

468

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

469

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

470

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

471

# and range from 0 to 1.

472

"y": 3.14, # Y coordinate.

473

"x": 3.14, # X coordinate.

474

},

475

],

476

"vertices": [ # The bounding polygon vertices.

477

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

478

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

479

"y": 42, # Y coordinate.

480

"x": 42, # X coordinate.

},

],

},

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

485

{ # Information about a product.

486

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

487

# to the query.

488

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

489

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

490

#

491

# Format is:

492

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

493

#

494

# This field is ignored when creating a product.

495

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

496

# 4096 characters long.

497

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

498

# characters long.

499

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

500

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

501

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

502

# not be used for new products.

503

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

504

# constraints can be specified based on the product_labels.

505

#

506

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

507

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

508

# to be supported soon.

509

#

510

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

511

# 500 product_labels.

512

#

513

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

514

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

515

# will refuse to work for that ProductSet.

516

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

517

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

518

# cannot exceed 128 bytes.

519

"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

525

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

530

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

531

{ # Information about a product.

532

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

533

# to the query.

534

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

535

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

536

#

537

# Format is:

538

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

539

#

540

# This field is ignored when creating a product.

541

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

542

# 4096 characters long.

543

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

544

# characters long.

545

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

546

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

547

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

548

# not be used for new products.

549

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

550

# constraints can be specified based on the product_labels.

551

#

552

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

553

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

554

# to be supported soon.

555

#

556

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

557

# 500 product_labels.

558

#

559

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

560

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

561

# will refuse to work for that ProductSet.

562

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

563

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

564

# cannot exceed 128 bytes.

565

"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

571

# 1 (full confidence).

Bu Sun Kim

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

[diff] [blame]

572

},

573

],

574

},

Bu Sun Kim

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

[diff] [blame]

575

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

Bu Sun Kim

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

[diff] [blame]

576

# This will be sorted descending by confidence score.

577

{ # Set of detected objects with bounding boxes.

Bu Sun Kim

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

[diff] [blame]

578

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

579

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

580

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

Bu Sun Kim

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

[diff] [blame]

581

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

582

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

583

# and range from 0 to 1.

Bu Sun Kim

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

[diff] [blame]

584

"y": 3.14, # Y coordinate.

585

"x": 3.14, # X coordinate.

Bu Sun Kim

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

[diff] [blame]

586

},

587

],

Bu Sun Kim

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

[diff] [blame]

588

"vertices": [ # The bounding polygon vertices.

Bu Sun Kim

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

[diff] [blame]

589

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

590

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

591

"y": 42, # Y coordinate.

592

"x": 42, # X coordinate.

Bu Sun Kim

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

[diff] [blame]

593

},

594

],

595

},

Bu Sun Kim

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

[diff] [blame]

596

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

597

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

598

# information, see

599

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

600

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

Bu Sun Kim

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

[diff] [blame]

601

},

602

],

Bu Sun Kim

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

[diff] [blame]

603

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

604

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

605

# correct, even when `error` is set.

606

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

607

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

608

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

609

#

610

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

611

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

612

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

613

# message types for APIs to use.

614

{

615

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

616

},

617

],

618

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

619

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

620

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

621

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

622

},

623

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

624

# completed successfully.

625

# This annotation provides the structural hierarchy for the OCR detected

626

# text.

627

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

Dan O'Meara

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

[diff] [blame]

628

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

Bu Sun Kim

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

[diff] [blame]

629

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

630

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

631

# to the TextAnnotation.TextProperty message definition below for more

632

# detail.

Bu Sun Kim

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

[diff] [blame]

633

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

Bu Sun Kim

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

[diff] [blame]

634

{ # Detected page from OCR.

Bu Sun Kim

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

[diff] [blame]

635

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

636

# TIFFs) the unit is pixels.

Bu Sun Kim

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

[diff] [blame]

637

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

638

# TIFFs) the unit is pixels.

639

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

Bu Sun Kim

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

[diff] [blame]

640

{ # Logical element on the page.

Bu Sun Kim

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

[diff] [blame]

641

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

642

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

643

{ # Detected language for a structural component.

644

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

645

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

646

# information, see

647

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

648

},

649

],

650

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

651

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

652

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

653

},

654

},

655

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

656

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

657

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

658

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

659

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

660

# read in the 'natural' orientation.

Bu Sun Kim

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

[diff] [blame]

661

# For example:

662

#

663

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

669

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

676

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

Bu Sun Kim

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

[diff] [blame]

677

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

678

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

679

# and range from 0 to 1.

Bu Sun Kim

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

[diff] [blame]

680

"y": 3.14, # Y coordinate.

681

"x": 3.14, # X coordinate.

Bu Sun Kim

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

[diff] [blame]

682

},

683

],

Bu Sun Kim

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

[diff] [blame]

684

"vertices": [ # The bounding polygon vertices.

Bu Sun Kim

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

[diff] [blame]

685

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

686

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

687

"y": 42, # Y coordinate.

688

"x": 42, # X coordinate.

Bu Sun Kim

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

[diff] [blame]

689

},

690

],

691

},

Bu Sun Kim

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

[diff] [blame]

692

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

693

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

694

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

Bu Sun Kim

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

[diff] [blame]

695

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

696

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

697

{ # Detected language for a structural component.

698

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

699

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

700

# information, see

701

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

702

},

703

],

704

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

705

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

706

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

707

},

708

},

709

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

710

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

711

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

712

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

713

# read in the 'natural' orientation.

Bu Sun Kim

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

[diff] [blame]

714

# For example:

715

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

716

# 0----1

717

# | |

718

# 3----2

Bu Sun Kim

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

[diff] [blame]

719

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

724

"normalizedVertices": [ # The bounding polygon normalized 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 normalized vertex coordinates are relative to the original image

727

# and range from 0 to 1.

Bu Sun Kim

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

[diff] [blame]

728

"y": 3.14, # Y coordinate.

729

"x": 3.14, # X coordinate.

Bu Sun Kim

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

[diff] [blame]

730

},

731

],

Bu Sun Kim

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

[diff] [blame]

732

"vertices": [ # The bounding polygon vertices.

Bu Sun Kim

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

[diff] [blame]

733

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

734

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

735

"y": 42, # Y coordinate.

736

"x": 42, # X coordinate.

Bu Sun Kim

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

[diff] [blame]

737

},

738

],

739

},

Bu Sun Kim

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

[diff] [blame]

740

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

741

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

Bu Sun Kim

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

[diff] [blame]

742

{ # A word representation.

Bu Sun Kim

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

[diff] [blame]

743

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

744

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

745

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

746

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

747

# read in the 'natural' orientation.

Bu Sun Kim

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

[diff] [blame]

748

# For example:

749

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

750

# 0----1

751

# | |

752

# 3----2

Bu Sun Kim

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

[diff] [blame]

753

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

758

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

Bu Sun Kim

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

[diff] [blame]

759

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

760

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

761

# and range from 0 to 1.

Bu Sun Kim

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

[diff] [blame]

762

"y": 3.14, # Y coordinate.

763

"x": 3.14, # X coordinate.

Bu Sun Kim

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

[diff] [blame]

764

},

765

],

Bu Sun Kim

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

[diff] [blame]

766

"vertices": [ # The bounding polygon vertices.

Bu Sun Kim

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

[diff] [blame]

767

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

768

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

769

"y": 42, # Y coordinate.

770

"x": 42, # X coordinate.

Bu Sun Kim

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

[diff] [blame]

771

},

772

],

773

},

Bu Sun Kim

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

[diff] [blame]

774

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

775

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

Bu Sun Kim

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

[diff] [blame]

776

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

777

{ # A single symbol representation.

Bu Sun Kim

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

[diff] [blame]

778

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

779

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

780

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

781

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

782

# read in the 'natural' orientation.

Bu Sun Kim

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

[diff] [blame]

783

# For example:

784

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

785

# 0----1

786

# | |

787

# 3----2

Bu Sun Kim

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

[diff] [blame]

788

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

789

# 2----3

790

# | |

791

# 1----0

Dan O'Meara

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

[diff] [blame]

792

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

Bu Sun Kim

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

[diff] [blame]

793

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

Bu Sun Kim

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

[diff] [blame]

794

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

795

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

796

# and range from 0 to 1.

Bu Sun Kim

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

[diff] [blame]

797

"y": 3.14, # Y coordinate.

798

"x": 3.14, # X coordinate.

Bu Sun Kim

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

[diff] [blame]

799

},

800

],

Bu Sun Kim

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

[diff] [blame]

801

"vertices": [ # The bounding polygon vertices.

Bu Sun Kim

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

[diff] [blame]

802

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

803

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

804

"y": 42, # Y coordinate.

805

"x": 42, # X coordinate.

Bu Sun Kim

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

[diff] [blame]

806

},

807

],

808

},

Bu Sun Kim

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

[diff] [blame]

809

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

810

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

811

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

812

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

Bu Sun Kim

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

[diff] [blame]

813

{ # Detected language for a structural component.

Bu Sun Kim

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

[diff] [blame]

814

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

815

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

816

# information, see

817

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

Bu Sun Kim

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

[diff] [blame]

818

},

819

],

Bu Sun Kim

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

[diff] [blame]

820

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

821

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

822

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

823

},

Bu Sun Kim

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

[diff] [blame]

824

},

825

},

826

],

Bu Sun Kim

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

[diff] [blame]

827

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

828

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

Bu Sun Kim

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

[diff] [blame]

829

{ # Detected language for a structural component.

Bu Sun Kim

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

[diff] [blame]

830

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

831

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

832

# information, see

833

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

Bu Sun Kim

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

[diff] [blame]

834

},

835

],

Bu Sun Kim

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

[diff] [blame]

836

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

837

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

838

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

839

},

Bu Sun Kim

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

[diff] [blame]

},

},

],

},

],

},

],

Bu Sun Kim

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

[diff] [blame]

847

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

848

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

849

{ # Detected language for a structural component.

850

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

851

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

852

# information, see

853

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

854

},

855

],

856

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

857

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

858

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

859

},

860

},

861

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

Bu Sun Kim

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

[diff] [blame]

862

},

863

],

Bu Sun Kim

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

[diff] [blame]

864

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

Bu Sun Kim

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

[diff] [blame]

865

},

Bu Sun Kim

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

[diff] [blame]

866

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

Bu Sun Kim

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

[diff] [blame]

867

{ # Set of detected entity features.

Bu Sun Kim

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

[diff] [blame]

868

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

869

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

Bu Sun Kim

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

[diff] [blame]

870

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

871

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

872

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

873

# Location information is usually present for landmarks.

874

{ # Detected entity location information.

Bu Sun Kim

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

[diff] [blame]

875

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

876

# of doubles representing degrees latitude and degrees longitude. Unless

877

# specified otherwise, this must conform to the

Bu Sun Kim

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

[diff] [blame]

878

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

879

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

Bu Sun Kim

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

[diff] [blame]

880

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

881

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

882

},

883

},

884

],

Bu Sun Kim

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

[diff] [blame]

885

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

Bu Sun Kim

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

[diff] [blame]

886

# [Google Knowledge Graph Search

887

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

Bu Sun Kim

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

[diff] [blame]

888

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

889

# The accuracy of the entity detection in an image.

890

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

891

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

892

# image. Range [0, 1].

893

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

894

# `description` is expressed.

895

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

896

# for `LABEL_DETECTION` features.

Bu Sun Kim

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

[diff] [blame]

897

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

Bu Sun Kim

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

[diff] [blame]

898

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

899

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

900

# and range from 0 to 1.

Bu Sun Kim

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

[diff] [blame]

901

"y": 3.14, # Y coordinate.

902

"x": 3.14, # X coordinate.

Bu Sun Kim

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

[diff] [blame]

903

},

904

],

Bu Sun Kim

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

[diff] [blame]

905

"vertices": [ # The bounding polygon vertices.

Bu Sun Kim

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

[diff] [blame]

906

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

907

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

908

"y": 42, # Y coordinate.

909

"x": 42, # X coordinate.

Bu Sun Kim

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

[diff] [blame]

910

},

911

],

912

},

Bu Sun Kim

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

[diff] [blame]

913

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

914

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

915

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

916

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

917

# detected distant towering building, even though the confidence that

918

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

919

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

Bu Sun Kim

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

[diff] [blame]

920

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

921

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

Bu Sun Kim

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

[diff] [blame]

922

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

923

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

924

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

929

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

930

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

931

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

Bu Sun Kim

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

[diff] [blame]

932

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

933

# the image that the color occupies in the image.

Bu Sun Kim

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

[diff] [blame]

934

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

935

# Value in range [0, 1].

936

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

937

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

938

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

Bu Sun Kim

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

[diff] [blame]

939

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

940

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

Bu Sun Kim

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

[diff] [blame]

941

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

942

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

Bu Sun Kim

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

[diff] [blame]

943

#

944

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

945

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

946

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

# space.

#

# Example (Java):

#

# import com.google.type.Color;

952

#

953

# // ...

954

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

955

# float alpha = protocolor.hasAlpha()

956

# ? protocolor.getAlpha().getValue()

957

# : 1.0;

958

#

959

# return new java.awt.Color(

960

# protocolor.getRed(),

961

# protocolor.getGreen(),

962

# protocolor.getBlue(),

# alpha);

# }

#

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

967

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

968

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

969

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

970

# float denominator = 255.0;

971

# Color.Builder resultBuilder =

972

# Color

973

# .newBuilder()

974

# .setRed(red / denominator)

975

# .setGreen(green / denominator)

976

# .setBlue(blue / denominator);

977

# int alpha = color.getAlpha();

978

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

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

983

# .build());

984

# }

985

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

990

#

991

# // ...

992

# static UIColor* fromProto(Color* protocolor) {

993

# float red = [protocolor red];

994

# float green = [protocolor green];

995

# float blue = [protocolor blue];

996

# FloatValue* alpha_wrapper = [protocolor alpha];

997

# float alpha = 1.0;

998

# if (alpha_wrapper != nil) {

999

# alpha = [alpha_wrapper value];

1000

# }

1001

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

1002

# }

1003

#

1004

# static Color* toProto(UIColor* color) {

1005

# CGFloat red, green, blue, alpha;

Dan O'Meara

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

[diff] [blame]

1006

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

Bu Sun Kim

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

[diff] [blame]

1007

# return nil;

1008

# }

1009

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

1010

# [result setRed:red];

1011

# [result setGreen:green];

1012

# [result setBlue:blue];

Dan O'Meara

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

[diff] [blame]

1013

# if (alpha <= 0.9999) {

Bu Sun Kim

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

[diff] [blame]

1014

# [result setAlpha:floatWrapperWithValue(alpha)];

1015

# }

1016

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

1026

# var redFrac = rgb_color.red || 0.0;

1027

# var greenFrac = rgb_color.green || 0.0;

1028

# var blueFrac = rgb_color.blue || 0.0;

1029

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

1030

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

1031

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

1032

#

Bu Sun Kim

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

[diff] [blame]

1033

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

Bu Sun Kim

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

[diff] [blame]

1034

# return rgbToCssColor_(red, green, blue);

1035

# }

1036

#

1037

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

Bu Sun Kim

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

[diff] [blame]

1038

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

1039

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

Bu Sun Kim

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

[diff] [blame]

1040

# };

1041

#

1042

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

Dan O'Meara

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

[diff] [blame]

1043

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

Bu Sun Kim

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

[diff] [blame]

1044

# var hexString = rgbNumber.toString(16);

1045

# var missingZeros = 6 - hexString.length;

Bu Sun Kim

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

[diff] [blame]

1046

# var resultBuilder = ['#'];

Dan O'Meara

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

[diff] [blame]

1047

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

Bu Sun Kim

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

[diff] [blame]

1048

# resultBuilder.push('0');

Bu Sun Kim

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

[diff] [blame]

1049

# }

1050

# resultBuilder.push(hexString);

Bu Sun Kim

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

[diff] [blame]

1051

# return resultBuilder.join('');

Bu Sun Kim

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

[diff] [blame]

1052

# };

1053

#

1054

# // ...

Bu Sun Kim

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

[diff] [blame]

1055

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

1056

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

1057

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

1058

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

1059

# the final pixel color is defined by the equation:

1060

#

1061

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

1062

#

1063

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

1064

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

1065

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

1066

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

1067

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

1068

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

1069

},

Bu Sun Kim

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

[diff] [blame]

1070

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

1075

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

Bu Sun Kim

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

[diff] [blame]

1076

{ # Set of detected entity features.

Bu Sun Kim

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

[diff] [blame]

1077

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

1078

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

Bu Sun Kim

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

[diff] [blame]

1079

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

1080

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

1081

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

1082

# Location information is usually present for landmarks.

1083

{ # Detected entity location information.

Bu Sun Kim

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

[diff] [blame]

1084

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

1085

# of doubles representing degrees latitude and degrees longitude. Unless

1086

# specified otherwise, this must conform to the

Bu Sun Kim

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

[diff] [blame]

1087

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

1088

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

Bu Sun Kim

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

[diff] [blame]

1089

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

1090

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

1091

},

1092

},

1093

],

Bu Sun Kim

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

[diff] [blame]

1094

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

Bu Sun Kim

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

[diff] [blame]

1095

# [Google Knowledge Graph Search

1096

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

Bu Sun Kim

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

[diff] [blame]

1097

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

Bu Sun Kim

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

[diff] [blame]

1098

# The accuracy of the entity detection in an image.

Bu Sun Kim

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

[diff] [blame]

1099

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

1100

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

1101

# image. Range [0, 1].

Bu Sun Kim

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

[diff] [blame]

1102

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

1103

# `description` is expressed.

Bu Sun Kim

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

[diff] [blame]

1104

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

1105

# for `LABEL_DETECTION` features.

Bu Sun Kim

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

[diff] [blame]

1106

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

Bu Sun Kim

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

[diff] [blame]

1107

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

1108

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

1109

# and range from 0 to 1.

Bu Sun Kim

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

[diff] [blame]

1110

"y": 3.14, # Y coordinate.

1111

"x": 3.14, # X coordinate.

Bu Sun Kim

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

[diff] [blame]

1112

},

1113

],

Bu Sun Kim

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

[diff] [blame]

1114

"vertices": [ # The bounding polygon vertices.

Bu Sun Kim

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

[diff] [blame]

1115

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

1116

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

1117

"y": 42, # Y coordinate.

1118

"x": 42, # X coordinate.

Bu Sun Kim

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

[diff] [blame]

1119

},

1120

],

1121

},

Bu Sun Kim

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

[diff] [blame]

1122

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

1123

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

1124

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

1125

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

1126

# detected distant towering building, even though the confidence that

1127

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

1128

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

Bu Sun Kim

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

[diff] [blame]

1129

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

1130

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

Bu Sun Kim

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

[diff] [blame]

1131

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

1132

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

1133

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

1138

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

1139

# comes from.

1140

# information about the source of that image.

Bu Sun Kim

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

[diff] [blame]

1141

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

1142

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

1143

# the file used to produce the image.

Bu Sun Kim

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

[diff] [blame]

1144

},

Bu Sun Kim

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

[diff] [blame]

1145

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

1146

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

1147

# Can include resized copies of the query image.

1148

{ # Metadata for online images.

1149

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

1150

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

1151

},

1152

],

1153

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

1154

{ # Entity deduced from similar images on the Internet.

1155

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

1156

# Not normalized and not comparable across different image queries.

1157

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

1158

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

1159

},

1160

],

1161

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

1162

{ # Metadata for web pages.

1163

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

1164

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

1165

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

1166

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

1167

# crops.

1168

{ # Metadata for online images.

1169

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

1170

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

1171

},

1172

],

1173

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

1174

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

1175

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

1176

# Can include resized copies of the query image.

1177

{ # Metadata for online images.

1178

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

1179

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

},

],

},

],

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

1185

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

1186

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

1187

{ # Metadata for online images.

1188

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

1189

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

1190

},

1191

],

1192

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

1193

{ # Metadata for online images.

1194

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

1195

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

1196

},

1197

],

1198

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

1199

# Inferred from similar images on the open web.

1200

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

1201

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

1202

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

1203

# For more information, see

1204

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

Bu Sun Kim

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

[diff] [blame]

1205

},

1206

],

1207

},

Bu Sun Kim

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

[diff] [blame]

1208

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

1209

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

1210

# violence).

1211

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

1212

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

1213

# sexual activities.

1214

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

1215

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

1216

# funny or offensive.

1217

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

1218

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

1219

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

1220

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

1221

# body areas.

1222

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

1223

},

1224

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

1225

{ # Set of detected entity features.

1226

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

1227

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

1228

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

1229

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

1230

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

1231

# Location information is usually present for landmarks.

1232

{ # Detected entity location information.

1233

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

1234

# of doubles representing degrees latitude and degrees longitude. Unless

1235

# specified otherwise, this must conform to the

1236

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

1237

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

1238

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

1239

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

1240

},

Bu Sun Kim

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

[diff] [blame]

1241

},

Bu Sun Kim

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

[diff] [blame]

1242

],

1243

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

1244

# [Google Knowledge Graph Search

1245

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

1246

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

1247

# The accuracy of the entity detection in an image.

1248

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

1249

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

1250

# image. Range [0, 1].

1251

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

1252

# `description` is expressed.

1253

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

1254

# for `LABEL_DETECTION` features.

1255

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

1256

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

1257

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

1258

# and range from 0 to 1.

1259

"y": 3.14, # Y coordinate.

1260

"x": 3.14, # X coordinate.

1261

},

1262

],

1263

"vertices": [ # The bounding polygon vertices.

1264

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

1265

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

1266

"y": 42, # Y coordinate.

1267

"x": 42, # X coordinate.

1268

},

1269

],

Bu Sun Kim

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

[diff] [blame]

1270

},

Bu Sun Kim

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

[diff] [blame]

1271

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

1272

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

1273

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

1274

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

1275

# detected distant towering building, even though the confidence that

1276

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

1277

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

1278

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

1279

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

1280

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

1281

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

1282

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

},

],

},

],

Bu Sun Kim

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

[diff] [blame]

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

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

1291

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

1292

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

1293

},

1294

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

1295

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

1296

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

1297

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

1298

# representation, whereas JSON representations use base64.

1299

#

1300

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

1301

# not work for AsyncBatchAnnotateFiles requests.

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

"maxLatLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # Max 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

"minLatLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # Min 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

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

1370

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

1371

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

1372

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

1373

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

1374

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

1375

# migrate existing products to these categories as well.

1376

"A String",

1377

],

1378

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

1379

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

1380

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

1381

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

1382

#

1383

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

1384

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

1385

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

1386

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

1387

#

1388

# Format is:

1389

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

1390

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

1391

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

1392

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

1393

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

1394

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

1395

# and range from 0 to 1.

1396

"y": 3.14, # Y coordinate.

1397

"x": 3.14, # X coordinate.

1398

},

1399

],

1400

"vertices": [ # The bounding polygon vertices.

1401

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

1402

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

1403

"y": 42, # Y coordinate.

1404

"x": 42, # X coordinate.

1405

},

1406

],

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

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

1449

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

1450

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

1451

},

1452

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

1453

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

1454

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

Bu Sun Kim

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

[diff] [blame]

1455

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

1456

# representation, whereas JSON representations use base64.

1457

#

1458

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

1459

# not work for AsyncBatchAnnotateFiles requests.

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

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

1466

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

1467

# "builtin/latest".

1468

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

1469

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

1470

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

},

],

},

],

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