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

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

[diff] [blame]

286

},

Bu Sun Kim

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

[diff] [blame]

287

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

Bu Sun Kim

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

[diff] [blame]

288

{ # Set of detected entity features.

Bu Sun Kim

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

[diff] [blame]

289

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

290

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

291

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

292

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

293

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

294

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

295

},

296

],

297

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

298

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

Bu Sun Kim

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

[diff] [blame]

299

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

300

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

301

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

302

# Location information is usually present for landmarks.

303

{ # Detected entity location information.

Bu Sun Kim

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

[diff] [blame]

304

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

305

# of doubles representing degrees latitude and degrees longitude. Unless

306

# specified otherwise, this must conform to the

Bu Sun Kim

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

[diff] [blame]

307

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

308

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

Bu Sun Kim

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

[diff] [blame]

309

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

310

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

311

},

312

},

313

],

Bu Sun Kim

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

[diff] [blame]

314

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

315

# [Google Knowledge Graph Search

316

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

317

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

318

# The accuracy of the entity detection in an image.

319

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

320

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

321

# image. Range [0, 1].

322

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

323

# `description` is expressed.

324

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

325

# for `LABEL_DETECTION` features.

Bu Sun Kim

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

[diff] [blame]

326

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

Bu Sun Kim

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

[diff] [blame]

327

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

328

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

329

# and range from 0 to 1.

Bu Sun Kim

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

[diff] [blame]

330

"y": 3.14, # Y coordinate.

331

"x": 3.14, # X coordinate.

Bu Sun Kim

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

[diff] [blame]

332

},

333

],

Bu Sun Kim

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

[diff] [blame]

334

"vertices": [ # The bounding polygon vertices.

Bu Sun Kim

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

[diff] [blame]

335

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

336

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

337

"y": 42, # Y coordinate.

338

"x": 42, # X coordinate.

Bu Sun Kim

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

[diff] [blame]

339

},

340

],

341

},

Bu Sun Kim

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

[diff] [blame]

342

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

343

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

344

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

345

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

346

# detected distant towering building, even though the confidence that

347

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

Bu Sun Kim

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

[diff] [blame]

348

},

349

],

Bu Sun Kim

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

[diff] [blame]

350

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

351

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

352

{ # Entity deduced from similar images on the Internet.

353

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

354

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

355

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

356

# Not normalized and not comparable across different image queries.

Bu Sun Kim

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

[diff] [blame]

357

},

358

],

Bu Sun Kim

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

[diff] [blame]

359

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

Bu Sun Kim

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

[diff] [blame]

360

{ # Metadata for web pages.

Bu Sun Kim

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

[diff] [blame]

361

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

362

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

Bu Sun Kim

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

[diff] [blame]

363

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

364

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

365

# crops.

366

{ # Metadata for online images.

Bu Sun Kim

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

[diff] [blame]

367

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

368

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

Bu Sun Kim

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

[diff] [blame]

369

},

370

],

Bu Sun Kim

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

[diff] [blame]

371

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

372

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

373

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

Bu Sun Kim

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

[diff] [blame]

374

# Can include resized copies of the query image.

375

{ # Metadata for online images.

Bu Sun Kim

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

[diff] [blame]

376

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

377

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

Bu Sun Kim

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

[diff] [blame]

},

],

},

],

Bu Sun Kim

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

[diff] [blame]

382

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

Bu Sun Kim

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

[diff] [blame]

383

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

384

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

385

{ # Metadata for online images.

Bu Sun Kim

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

[diff] [blame]

386

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

387

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

Bu Sun Kim

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

[diff] [blame]

388

},

389

],

Bu Sun Kim

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

[diff] [blame]

390

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

391

{ # Metadata for online images.

392

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

393

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

Bu Sun Kim

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

[diff] [blame]

394

},

395

],

Bu Sun Kim

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

[diff] [blame]

396

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

Bu Sun Kim

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

[diff] [blame]

397

# Inferred from similar images on the open web.

398

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

Bu Sun Kim

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

[diff] [blame]

399

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

400

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

Bu Sun Kim

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

[diff] [blame]

401

# For more information, see

402

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

Bu Sun Kim

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

[diff] [blame]

403

},

404

],

405

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

406

# Can include resized copies of the query image.

407

{ # Metadata for online images.

408

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

409

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

Bu Sun Kim

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

[diff] [blame]

410

},

411

],

412

},

Bu Sun Kim

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

[diff] [blame]

413

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

414

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

415

# violence).

416

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

417

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

418

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

419

# body areas.

420

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

421

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

422

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

423

# sexual activities.

424

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

425

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

426

# funny or offensive.

427

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

428

},

429

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

430

{ # Set of detected entity features.

431

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

432

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

433

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

434

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

435

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

436

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

437

},

438

],

439

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

440

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

441

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

442

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

443

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

444

# Location information is usually present for landmarks.

445

{ # Detected entity location information.

446

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

447

# of doubles representing degrees latitude and degrees longitude. Unless

448

# specified otherwise, this must conform to the

449

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

450

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

451

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

452

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

},

},

],

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

457

# [Google Knowledge Graph Search

458

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

459

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

460

# The accuracy of the entity detection in an image.

461

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

462

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

463

# image. Range [0, 1].

464

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

465

# `description` is expressed.

466

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

467

# for `LABEL_DETECTION` features.

468

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

Bu Sun Kim

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

[diff] [blame]

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.

Bu Sun Kim

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

[diff] [blame]

472

"y": 3.14, # Y coordinate.

473

"x": 3.14, # X coordinate.

Bu Sun Kim

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

[diff] [blame]

474

},

475

],

Bu Sun Kim

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

[diff] [blame]

476

"vertices": [ # The bounding polygon vertices.

Bu Sun Kim

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

[diff] [blame]

477

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

478

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

479

"y": 42, # Y coordinate.

480

"x": 42, # X coordinate.

Bu Sun Kim

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

[diff] [blame]

481

},

482

],

483

},

Bu Sun Kim

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

[diff] [blame]

484

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

485

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

486

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

487

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

488

# detected distant towering building, even though the confidence that

489

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

Bu Sun Kim

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

[diff] [blame]

490

},

491

],

Bu Sun Kim

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

[diff] [blame]

492

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

493

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

494

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

495

# are in the original image's scale.

496

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

497

# expectations. It is based on the landmarker results.

498

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

499

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

500

# appears in the image to be annotated.

501

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

502

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

503

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

504

# and range from 0 to 1.

505

"y": 3.14, # Y coordinate.

506

"x": 3.14, # X coordinate.

507

},

508

],

509

"vertices": [ # The bounding polygon vertices.

510

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

511

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

512

"y": 42, # Y coordinate.

513

"x": 42, # X coordinate.

},

],

},

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

518

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

519

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

520

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

521

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

522

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

523

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

524

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

525

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

526

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

527

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

528

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

529

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

530

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

531

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

532

# and range from 0 to 1.

533

"y": 3.14, # Y coordinate.

534

"x": 3.14, # X coordinate.

535

},

536

],

537

"vertices": [ # The bounding polygon vertices.

538

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

539

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

540

"y": 42, # Y coordinate.

541

"x": 42, # X coordinate.

},

],

},

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

546

"landmarks": [ # Detected face landmarks.

547

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

548

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

549

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

550

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

551

"y": 3.14, # Y coordinate.

552

"x": 3.14, # X coordinate.

553

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

554

},

555

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

556

},

557

],

558

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

559

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

560

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

561

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

562

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

563

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

564

# [-180,180].

565

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

566

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

567

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

568

},

569

],

570

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

571

"cropHints": [ # Crop hint results.

572

{ # Single crop hint that is used to generate a new crop when serving an image.

573

"confidence": 3.14, # Confidence of this being a salient region. Range [0, 1].

574

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

575

# image.

576

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

577

# box are in the original image's scale.

578

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

579

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

580

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

581

# and range from 0 to 1.

582

"y": 3.14, # Y coordinate.

583

"x": 3.14, # X coordinate.

584

},

585

],

586

"vertices": [ # The bounding polygon vertices.

587

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

588

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

589

"y": 42, # Y coordinate.

590

"x": 42, # X coordinate.

},

],

},

},

],

},

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

598

{ # Set of detected entity features.

599

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

600

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

601

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

602

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

603

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

604

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

605

},

606

],

607

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

608

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

609

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

610

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

611

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

612

# Location information is usually present for landmarks.

613

{ # Detected entity location information.

614

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

615

# of doubles representing degrees latitude and degrees longitude. Unless

616

# specified otherwise, this must conform to the

617

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

618

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

619

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

620

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

},

},

],

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

625

# [Google Knowledge Graph Search

626

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

627

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

628

# The accuracy of the entity detection in an image.

629

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

630

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

631

# image. Range [0, 1].

632

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

633

# `description` is expressed.

634

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

635

# for `LABEL_DETECTION` features.

636

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

637

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

638

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

639

# and range from 0 to 1.

640

"y": 3.14, # Y coordinate.

641

"x": 3.14, # X coordinate.

642

},

643

],

644

"vertices": [ # The bounding polygon vertices.

645

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

646

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

647

"y": 42, # Y coordinate.

648

"x": 42, # X coordinate.

},

],

},

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

653

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

654

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

655

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

656

# detected distant towering building, even though the confidence that

657

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

658

},

659

],

660

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

661

# This will be sorted descending by confidence score.

662

{ # Set of detected objects with bounding boxes.

663

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

664

# information, see

665

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

666

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

667

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

668

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

669

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

670

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

671

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

672

# and range from 0 to 1.

673

"y": 3.14, # Y coordinate.

674

"x": 3.14, # X coordinate.

675

},

676

],

677

"vertices": [ # The bounding polygon vertices.

678

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

679

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

680

"y": 42, # Y coordinate.

681

"x": 42, # X coordinate.

},

],

},

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

686

},

687

],

688

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

689

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

690

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

691

# not reflected in the current results.

692

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

693

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

694

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

695

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

696

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

697

# image.

698

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

699

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

700

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

701

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

702

# information, see

703

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

704

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

705

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

706

},

707

],

708

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

709

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

710

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

711

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

712

# and range from 0 to 1.

713

"y": 3.14, # Y coordinate.

714

"x": 3.14, # X coordinate.

715

},

716

],

717

"vertices": [ # The bounding polygon vertices.

718

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

719

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

720

"y": 42, # Y coordinate.

721

"x": 42, # X coordinate.

},

],

},

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

726

{ # Information about a product.

727

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

728

# to the query.

729

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

730

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

731

#

732

# Format is:

733

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

734

#

735

# This field is ignored when creating a product.

736

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

737

# 4096 characters long.

738

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

739

# characters long.

740

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

741

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

742

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

743

# not be used for new products.

744

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

745

# constraints can be specified based on the product_labels.

746

#

747

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

748

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

749

# to be supported soon.

750

#

751

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

752

# 500 product_labels.

753

#

754

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

755

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

756

# will refuse to work for that ProductSet.

757

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

758

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

759

# cannot exceed 128 bytes.

760

"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

766

# 1 (full confidence).

},

],

},

],

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

772

{ # Information about a product.

773

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

774

# to the query.

775

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

776

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

777

#

778

# Format is:

779

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

780

#

781

# This field is ignored when creating a product.

782

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

783

# 4096 characters long.

784

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

785

# characters long.

786

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

787

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

788

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

789

# not be used for new products.

790

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

791

# constraints can be specified based on the product_labels.

792

#

793

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

794

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

795

# to be supported soon.

796

#

797

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

798

# 500 product_labels.

799

#

800

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

801

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

802

# will refuse to work for that ProductSet.

803

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

804

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

805

# cannot exceed 128 bytes.

806

"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

812

# 1 (full confidence).

},

],

},

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

817

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

818

# correct, even when `error` is set.

819

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

820

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

821

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

822

#

823

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

824

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

825

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

826

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

827

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

828

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

829

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

830

# message types for APIs to use.

831

{

832

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

},

],

},

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

Bu Sun Kim

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

[diff] [blame]

837

# completed successfully.

838

# This annotation provides the structural hierarchy for the OCR detected

839

# text.

840

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

Dan O'Meara

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

[diff] [blame]

841

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

Bu Sun Kim

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

[diff] [blame]

842

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

843

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

844

# to the TextAnnotation.TextProperty message definition below for more

845

# detail.

Bu Sun Kim

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

[diff] [blame]

846

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

Bu Sun Kim

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

[diff] [blame]

847

{ # Detected page from OCR.

Bu Sun Kim

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

[diff] [blame]

848

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

Bu Sun Kim

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

[diff] [blame]

849

# TIFFs) the unit is pixels.

Bu Sun Kim

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

[diff] [blame]

850

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

Bu Sun Kim

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

[diff] [blame]

851

{ # Logical element on the page.

Bu Sun Kim

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

[diff] [blame]

852

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

853

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

854

{ # Detected language for a structural component.

855

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

856

# information, see

857

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

858

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

859

},

860

],

861

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

862

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

863

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

864

},

865

},

866

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

867

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

868

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

869

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

870

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

871

# read in the 'natural' orientation.

Bu Sun Kim

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

[diff] [blame]

872

# For example:

873

#

874

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

880

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

887

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

Bu Sun Kim

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

[diff] [blame]

888

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

889

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

890

# and range from 0 to 1.

Bu Sun Kim

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

[diff] [blame]

891

"y": 3.14, # Y coordinate.

892

"x": 3.14, # X coordinate.

Bu Sun Kim

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

[diff] [blame]

893

},

894

],

Bu Sun Kim

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

[diff] [blame]

895

"vertices": [ # The bounding polygon vertices.

Bu Sun Kim

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

[diff] [blame]

896

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

897

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

898

"y": 42, # Y coordinate.

899

"x": 42, # X coordinate.

Bu Sun Kim

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

[diff] [blame]

900

},

901

],

902

},

Bu Sun Kim

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

[diff] [blame]

903

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

904

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

905

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

Bu Sun Kim

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

[diff] [blame]

906

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

907

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

908

{ # Detected language for a structural component.

909

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

910

# information, see

911

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

912

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

913

},

914

],

915

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

916

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

917

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

918

},

919

},

920

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

921

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

922

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

923

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

924

# read in the 'natural' orientation.

Bu Sun Kim

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

[diff] [blame]

925

# For example:

926

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

927

# 0----1

928

# | |

929

# 3----2

Bu Sun Kim

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

[diff] [blame]

930

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

935

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

Bu Sun Kim

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

[diff] [blame]

936

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

937

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

938

# and range from 0 to 1.

Bu Sun Kim

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

[diff] [blame]

939

"y": 3.14, # Y coordinate.

940

"x": 3.14, # X coordinate.

Bu Sun Kim

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

[diff] [blame]

941

},

942

],

Bu Sun Kim

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

[diff] [blame]

943

"vertices": [ # The bounding polygon vertices.

Bu Sun Kim

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

[diff] [blame]

944

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

945

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

946

"y": 42, # Y coordinate.

947

"x": 42, # X coordinate.

Bu Sun Kim

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

[diff] [blame]

948

},

949

],

950

},

Bu Sun Kim

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

[diff] [blame]

951

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

952

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

Bu Sun Kim

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

[diff] [blame]

953

{ # A word representation.

Bu Sun Kim

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

[diff] [blame]

954

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

955

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

956

{ # Detected language for a structural component.

957

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

958

# information, see

959

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

960

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

961

},

962

],

963

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

964

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

965

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

966

},

967

},

968

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

Dan O'Meara

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

[diff] [blame]

969

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

970

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

971

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

972

# read in the 'natural' orientation.

Dan O'Meara

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

[diff] [blame]

973

# For example:

974

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

975

# 0----1

976

# | |

977

# 3----2

Bu Sun Kim

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

[diff] [blame]

978

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

Dan O'Meara

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

[diff] [blame]

# 2----3

# | |

# 1----0

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

Bu Sun Kim

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

[diff] [blame]

983

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

Dan O'Meara

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

[diff] [blame]

984

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

985

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

986

# and range from 0 to 1.

Bu Sun Kim

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

[diff] [blame]

987

"y": 3.14, # Y coordinate.

988

"x": 3.14, # X coordinate.

Dan O'Meara

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

[diff] [blame]

989

},

990

],

Bu Sun Kim

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

[diff] [blame]

991

"vertices": [ # The bounding polygon vertices.

Dan O'Meara

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

[diff] [blame]

992

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

993

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

994

"y": 42, # Y coordinate.

995

"x": 42, # X coordinate.

Dan O'Meara

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

[diff] [blame]

996

},

997

],

998

},

Bu Sun Kim

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

[diff] [blame]

999

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

1000

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

Bu Sun Kim

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

[diff] [blame]

1001

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

1002

{ # A single symbol representation.

Bu Sun Kim

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

[diff] [blame]

1003

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

1004

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

1005

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

1006

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

1007

# read in the 'natural' orientation.

Bu Sun Kim

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

[diff] [blame]

1008

# For example:

1009

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

1010

# 0----1

1011

# | |

1012

# 3----2

Bu Sun Kim

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

[diff] [blame]

1013

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

1014

# 2----3

1015

# | |

1016

# 1----0

Dan O'Meara

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

[diff] [blame]

1017

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

Bu Sun Kim

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

[diff] [blame]

1018

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

Bu Sun Kim

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

[diff] [blame]

1019

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

1020

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

1021

# and range from 0 to 1.

Bu Sun Kim

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

[diff] [blame]

1022

"y": 3.14, # Y coordinate.

1023

"x": 3.14, # X coordinate.

Bu Sun Kim

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

[diff] [blame]

1024

},

1025

],

Bu Sun Kim

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

[diff] [blame]

1026

"vertices": [ # The bounding polygon vertices.

Bu Sun Kim

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

[diff] [blame]

1027

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

1028

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

1029

"y": 42, # Y coordinate.

1030

"x": 42, # X coordinate.

Bu Sun Kim

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

[diff] [blame]

1031

},

1032

],

1033

},

Bu Sun Kim

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

[diff] [blame]

1034

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

1035

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

1036

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

1037

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

Bu Sun Kim

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

[diff] [blame]

1038

{ # Detected language for a structural component.

Bu Sun Kim

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

[diff] [blame]

1039

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

1040

# information, see

1041

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

Bu Sun Kim

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

[diff] [blame]

1042

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

Bu Sun Kim

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

[diff] [blame]

1043

},

1044

],

Bu Sun Kim

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

[diff] [blame]

1045

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

1046

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

1047

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

1048

},

Bu Sun Kim

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

[diff] [blame]

1049

},

1050

},

1051

],

Bu Sun Kim

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

[diff] [blame]

},

],

},

],

},

],

Bu Sun Kim

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

[diff] [blame]

1058

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

1059

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

1060

{ # Detected language for a structural component.

1061

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

1062

# information, see

1063

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

1064

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

1065

},

1066

],

1067

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

1068

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

1069

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

1070

},

1071

},

1072

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

1073

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

1074

# TIFFs) the unit is pixels.

1075

},

1076

],

Bu Sun Kim

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

[diff] [blame]

1077

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

Bu Sun Kim

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

[diff] [blame]

1078

},

Bu Sun Kim

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

[diff] [blame]

1079

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

Bu Sun Kim

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

[diff] [blame]

1080

{ # Set of detected entity features.

Bu Sun Kim

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

[diff] [blame]

1081

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

1082

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

1083

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

1084

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

1085

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

1086

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

1087

},

1088

],

1089

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

1090

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

Bu Sun Kim

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

[diff] [blame]

1091

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

1092

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

1093

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

1094

# Location information is usually present for landmarks.

1095

{ # Detected entity location information.

Bu Sun Kim

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

[diff] [blame]

1096

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

1097

# of doubles representing degrees latitude and degrees longitude. Unless

1098

# specified otherwise, this must conform to the

Bu Sun Kim

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

[diff] [blame]

1099

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

1100

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

Bu Sun Kim

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

[diff] [blame]

1101

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

1102

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

1103

},

1104

},

1105

],

Bu Sun Kim

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

[diff] [blame]

1106

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

1107

# [Google Knowledge Graph Search

1108

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

1109

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

1110

# The accuracy of the entity detection in an image.

1111

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

1112

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

1113

# image. Range [0, 1].

1114

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

1115

# `description` is expressed.

1116

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

1117

# for `LABEL_DETECTION` features.

Bu Sun Kim

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

[diff] [blame]

1118

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

Bu Sun Kim

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

[diff] [blame]

1119

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

1120

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

1121

# and range from 0 to 1.

Bu Sun Kim

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

[diff] [blame]

1122

"y": 3.14, # Y coordinate.

1123

"x": 3.14, # X coordinate.

Bu Sun Kim

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

[diff] [blame]

1124

},

1125

],

Bu Sun Kim

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

[diff] [blame]

1126

"vertices": [ # The bounding polygon vertices.

Bu Sun Kim

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

[diff] [blame]

1127

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

1128

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

1129

"y": 42, # Y coordinate.

1130

"x": 42, # X coordinate.

Bu Sun Kim

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

[diff] [blame]

1131

},

1132

],

1133

},

Bu Sun Kim

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

[diff] [blame]

1134

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

1135

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

1136

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

1137

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

1138

# detected distant towering building, even though the confidence that

1139

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

Bu Sun Kim

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

[diff] [blame]

1140

},

1141

],

Bu Sun Kim

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

[diff] [blame]

1142

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

1143

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

1144

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

Bu Sun Kim

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

[diff] [blame]

1145

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

1146

# the image that the color occupies in the image.

Bu Sun Kim

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

[diff] [blame]

1147

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

1148

# Value in range [0, 1].

1149

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

1150

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

1151

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

Bu Sun Kim

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

[diff] [blame]

1152

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

1153

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

Bu Sun Kim

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

[diff] [blame]

1154

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

1155

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

Bu Sun Kim

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

[diff] [blame]

1156

#

1157

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

1158

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

1159

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

# space.

#

# Example (Java):

#

# import com.google.type.Color;

1165

#

1166

# // ...

1167

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

1168

# float alpha = protocolor.hasAlpha()

1169

# ? protocolor.getAlpha().getValue()

1170

# : 1.0;

1171

#

1172

# return new java.awt.Color(

1173

# protocolor.getRed(),

1174

# protocolor.getGreen(),

1175

# protocolor.getBlue(),

# alpha);

# }

#

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

1180

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

1181

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

1182

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

1183

# float denominator = 255.0;

1184

# Color.Builder resultBuilder =

1185

# Color

1186

# .newBuilder()

1187

# .setRed(red / denominator)

1188

# .setGreen(green / denominator)

1189

# .setBlue(blue / denominator);

1190

# int alpha = color.getAlpha();

1191

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

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

1196

# .build());

1197

# }

1198

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

1203

#

1204

# // ...

1205

# static UIColor* fromProto(Color* protocolor) {

1206

# float red = [protocolor red];

1207

# float green = [protocolor green];

1208

# float blue = [protocolor blue];

1209

# FloatValue* alpha_wrapper = [protocolor alpha];

1210

# float alpha = 1.0;

1211

# if (alpha_wrapper != nil) {

1212

# alpha = [alpha_wrapper value];

1213

# }

1214

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

1215

# }

1216

#

1217

# static Color* toProto(UIColor* color) {

1218

# CGFloat red, green, blue, alpha;

Dan O'Meara

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

[diff] [blame]

1219

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

Bu Sun Kim

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

[diff] [blame]

1220

# return nil;

1221

# }

1222

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

1223

# [result setRed:red];

1224

# [result setGreen:green];

1225

# [result setBlue:blue];

Dan O'Meara

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

[diff] [blame]

1226

# if (alpha <= 0.9999) {

Bu Sun Kim

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

[diff] [blame]

1227

# [result setAlpha:floatWrapperWithValue(alpha)];

1228

# }

1229

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

1239

# var redFrac = rgb_color.red || 0.0;

1240

# var greenFrac = rgb_color.green || 0.0;

1241

# var blueFrac = rgb_color.blue || 0.0;

1242

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

1243

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

1244

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

1245

#

Bu Sun Kim

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

[diff] [blame]

1246

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

Bu Sun Kim

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

[diff] [blame]

1247

# return rgbToCssColor_(red, green, blue);

1248

# }

1249

#

1250

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

Bu Sun Kim

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

[diff] [blame]

1251

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

1252

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

Bu Sun Kim

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

[diff] [blame]

1253

# };

1254

#

1255

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

Dan O'Meara

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

[diff] [blame]

1256

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

Bu Sun Kim

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

[diff] [blame]

1257

# var hexString = rgbNumber.toString(16);

1258

# var missingZeros = 6 - hexString.length;

Bu Sun Kim

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

[diff] [blame]

1259

# var resultBuilder = ['#'];

Dan O'Meara

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

[diff] [blame]

1260

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

Bu Sun Kim

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

[diff] [blame]

1261

# resultBuilder.push('0');

Bu Sun Kim

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

[diff] [blame]

1262

# }

1263

# resultBuilder.push(hexString);

Bu Sun Kim

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

[diff] [blame]

1264

# return resultBuilder.join('');

Bu Sun Kim

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

[diff] [blame]

1265

# };

1266

#

1267

# // ...

Bu Sun Kim

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

[diff] [blame]

1268

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

1269

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

1270

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

1271

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

1272

# the final pixel color is defined by the equation:

1273

#

1274

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

1275

#

1276

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

1277

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

1278

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

1279

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

1280

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

1281

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

1282

},

Bu Sun Kim

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

[diff] [blame]

1283

"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

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

[diff] [blame]

1288

},

1289

],

Bu Sun Kim

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

[diff] [blame]

1290

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

1291

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

1292

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

1293

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

1294

},

1295

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

1296

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

1297

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

1298

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

1299

# representation, whereas JSON representations use base64.

1300

#

1301

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

1302

# not work for AsyncBatchAnnotateFiles requests.

Bu Sun Kim

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

[diff] [blame]

},

},

],

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

1310

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

Bu Sun Kim

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

[diff] [blame]

1311

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

1312

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

1313

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

1314

`google.longrunning.Operations` interface.

1315

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

1316

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

1317

1318

Args:

Dan O'Meara

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

[diff] [blame]

1319

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

1320

The object takes the form of:

1321

1322

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

1323

# call.

Bu Sun Kim

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

[diff] [blame]

1324

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

Bu Sun Kim

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

[diff] [blame]

1325

{ # An offline file annotation request.

Bu Sun Kim

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

[diff] [blame]

1326

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

1327

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

Bu Sun Kim

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

[diff] [blame]

1328

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

1329

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

1330

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

1331

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

1332

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

1333

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

Dan O'Meara

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

[diff] [blame]

1334

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

Bu Sun Kim

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

[diff] [blame]

1335

"A String",

Bu Sun Kim

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

[diff] [blame]

1336

],

Bu Sun Kim

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

[diff] [blame]

1337

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

1338

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

1339

},

1340

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

1341

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

1342

# of doubles representing degrees latitude and degrees longitude. Unless

1343

# specified otherwise, this must conform to the

1344

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

1345

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

1346

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

1347

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

1348

},

1349

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

1350

# of doubles representing degrees latitude and degrees longitude. Unless

1351

# specified otherwise, this must conform to the

1352

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

1353

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

1354

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

1355

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

Bu Sun Kim

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

[diff] [blame]

1356

},

1357

},

Bu Sun Kim

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

[diff] [blame]

1358

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

1359

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

Bu Sun Kim

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

[diff] [blame]

1360

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

1361

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

1362

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

1363

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

# ignored.

3.14,

],

},

Bu Sun Kim

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

[diff] [blame]

1368

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

1369

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

1370

#

1371

# Format is:

1372

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

1373

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

1374

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

1375

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

1376

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

1377

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

1378

# and range from 0 to 1.

1379

"y": 3.14, # Y coordinate.

1380

"x": 3.14, # X coordinate.

1381

},

1382

],

1383

"vertices": [ # The bounding polygon vertices.

1384

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

1385

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

1386

"y": 42, # Y coordinate.

1387

"x": 42, # X coordinate.

},

],

},

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

1392

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

1393

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

1394

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

1395

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

1396

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

1397

# migrate existing products to these categories as well.

1398

"A String",

1399

],

1400

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

1401

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

1402

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

1403

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

1404

#

1405

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

1406

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

1407

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

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

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

1466

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

Bu Sun Kim

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

[diff] [blame]

1467

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

Bu Sun Kim

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

[diff] [blame]

1468

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

1469

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

1470

# "builtin/latest".

Bu Sun Kim

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

[diff] [blame]

},

],

},

],

Bu Sun Kim

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

[diff] [blame]

1475

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

Dan O'Meara

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

[diff] [blame]

1476

#

1477

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

1478

#

1479

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

1480

#

1481

# Supported location-ids:

1482

# `us`: USA country only,

1483

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

1484

# `eu`: The European Union.

1485

#

1486

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

Bu Sun Kim

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

[diff] [blame]

1487

}

1488

1489

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1496

1497

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

1498

# network API call.

Bu Sun Kim

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

[diff] [blame]

1499

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

Bu Sun Kim

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

[diff] [blame]

1500

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

1501

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

1502

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

1503

#

1504

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

1505

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

Bu Sun Kim

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

[diff] [blame]

1506

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

1507

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

Bu Sun Kim

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

[diff] [blame]

1508

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

1509

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

Bu Sun Kim

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

[diff] [blame]

1510

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

Bu Sun Kim

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

[diff] [blame]

1511

# message types for APIs to use.

1512

{

Bu Sun Kim

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

[diff] [blame]

1513

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

Bu Sun Kim

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

[diff] [blame]

1514

},

1515

],

1516

},

Bu Sun Kim

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

[diff] [blame]

1517

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

1518

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

1519

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

1520

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

1521

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

1522

},

1523

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

Bu Sun Kim

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

[diff] [blame]

1524

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

1525

# available.

Bu Sun Kim

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

[diff] [blame]

1526

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

Bu Sun Kim

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

[diff] [blame]

1527

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

1528

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

1529

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

1530

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

1531

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

1532

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

1533

# `TakeSnapshotResponse`.

Bu Sun Kim

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

[diff] [blame]

1534

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

Bu Sun Kim

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

[diff] [blame]

1535

},

Bu Sun Kim

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

[diff] [blame]

1536

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

Bu Sun Kim