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

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

[diff] [blame]

564

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

565

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

566

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

Bu Sun Kim

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

[diff] [blame]

567

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

568

# the image that the color occupies in the image.

Bu Sun Kim

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

[diff] [blame]

569

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

570

# Value in range [0, 1].

571

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

572

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

573

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

Bu Sun Kim

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

[diff] [blame]

574

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

575

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

Bu Sun Kim

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

[diff] [blame]

576

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

577

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

Bu Sun Kim

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

[diff] [blame]

578

#

579

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

580

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

581

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

582

# space.

583

#

Bu Sun Kim

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

[diff] [blame]

584

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

585

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

586

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

587

#

Bu Sun Kim

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

[diff] [blame]

588

# Example (Java):

589

#

590

# import com.google.type.Color;

591

#

592

# // ...

593

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

594

# float alpha = protocolor.hasAlpha()

595

# ? protocolor.getAlpha().getValue()

596

# : 1.0;

597

#

598

# return new java.awt.Color(

599

# protocolor.getRed(),

600

# protocolor.getGreen(),

601

# protocolor.getBlue(),

# alpha);

# }

#

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

606

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

607

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

608

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

609

# float denominator = 255.0;

610

# Color.Builder resultBuilder =

611

# Color

612

# .newBuilder()

613

# .setRed(red / denominator)

614

# .setGreen(green / denominator)

615

# .setBlue(blue / denominator);

616

# int alpha = color.getAlpha();

617

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

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

622

# .build());

623

# }

624

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

629

#

630

# // ...

631

# static UIColor* fromProto(Color* protocolor) {

632

# float red = [protocolor red];

633

# float green = [protocolor green];

634

# float blue = [protocolor blue];

635

# FloatValue* alpha_wrapper = [protocolor alpha];

636

# float alpha = 1.0;

637

# if (alpha_wrapper != nil) {

638

# alpha = [alpha_wrapper value];

639

# }

640

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

641

# }

642

#

643

# static Color* toProto(UIColor* color) {

644

# CGFloat red, green, blue, alpha;

Dan O'Meara

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

[diff] [blame]

645

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

Bu Sun Kim

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

[diff] [blame]

646

# return nil;

647

# }

648

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

649

# [result setRed:red];

650

# [result setGreen:green];

651

# [result setBlue:blue];

Dan O'Meara

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

[diff] [blame]

652

# if (alpha <= 0.9999) {

Bu Sun Kim

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

[diff] [blame]

653

# [result setAlpha:floatWrapperWithValue(alpha)];

654

# }

655

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

665

# var redFrac = rgb_color.red || 0.0;

666

# var greenFrac = rgb_color.green || 0.0;

667

# var blueFrac = rgb_color.blue || 0.0;

668

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

669

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

670

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

671

#

Bu Sun Kim

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

[diff] [blame]

672

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

Bu Sun Kim

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

[diff] [blame]

673

# return rgbToCssColor_(red, green, blue);

674

# }

675

#

676

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

Bu Sun Kim

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

[diff] [blame]

677

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

678

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

Bu Sun Kim

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

[diff] [blame]

679

# };

680

#

681

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

Dan O'Meara

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

[diff] [blame]

682

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

Bu Sun Kim

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

[diff] [blame]

683

# var hexString = rgbNumber.toString(16);

684

# var missingZeros = 6 - hexString.length;

Bu Sun Kim

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

[diff] [blame]

685

# var resultBuilder = ['#'];

Dan O'Meara

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

[diff] [blame]

686

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

Bu Sun Kim

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

[diff] [blame]

687

# resultBuilder.push('0');

Bu Sun Kim

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

[diff] [blame]

688

# }

689

# resultBuilder.push(hexString);

Bu Sun Kim

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

[diff] [blame]

690

# return resultBuilder.join('');

Bu Sun Kim

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

[diff] [blame]

691

# };

692

#

693

# // ...

Bu Sun Kim

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

[diff] [blame]

694

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

Bu Sun Kim

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

[diff] [blame]

695

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

696

# the final pixel color is defined by the equation:

697

#

698

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

699

#

700

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

701

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

702

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

703

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

704

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

705

# (as if the alpha value had been explicitly given with a value of 1.0).

Bu Sun Kim

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

[diff] [blame]

706

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

707

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

Bu Sun Kim

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

[diff] [blame]

708

},

Bu Sun Kim

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

[diff] [blame]

709

"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-07-22 17:02:09 -0700

[diff] [blame]

714

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

715

"cropHints": [ # Crop hint results.

716

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

717

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

718

# box are in the original image's scale.

719

"vertices": [ # The bounding polygon vertices.

720

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

721

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

722

"x": 42, # X coordinate.

723

"y": 42, # Y coordinate.

724

},

725

],

726

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

727

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

728

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

729

# and range from 0 to 1.

730

"x": 3.14, # X coordinate.

731

"y": 3.14, # Y coordinate.

},

],

},

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

736

# image.

737

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

},

],

},

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

742

# completed successfully.

743

# This annotation provides the structural hierarchy for the OCR detected

744

# text.

745

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

746

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

747

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

748

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

749

# to the TextAnnotation.TextProperty message definition below for more

750

# detail.

751

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

752

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

753

{ # Detected page from OCR.

754

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

755

{ # Logical element on the page.

756

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

757

"paragraphs": [ # List of paragraphs in this block (if this blocks is of type text).

758

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

759

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

760

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

761

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

762

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

763

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

764

},

765

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

766

{ # Detected language for a structural component.

767

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

768

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

769

# information, see

770

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

},

],

},

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

775

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

776

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

777

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

778

# read in the 'natural' orientation.

779

# For example:

780

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

# 0----1

# | |

# 3----2

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

# 2----3

# | |

# 1----0

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

789

"vertices": [ # The bounding polygon vertices.

790

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

791

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

792

"x": 42, # X coordinate.

793

"y": 42, # Y coordinate.

794

},

795

],

796

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

797

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

798

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

799

# and range from 0 to 1.

800

"x": 3.14, # X coordinate.

801

"y": 3.14, # Y coordinate.

},

],

},

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

806

{ # A word representation.

807

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

808

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

809

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

810

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

811

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

812

# read in the 'natural' orientation.

813

# For example:

814

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

# 0----1

# | |

# 3----2

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

# 2----3

# | |

# 1----0

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

823

"vertices": [ # The bounding polygon vertices.

824

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

825

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

826

"x": 42, # X coordinate.

827

"y": 42, # Y coordinate.

828

},

829

],

830

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

831

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

832

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

833

# and range from 0 to 1.

834

"x": 3.14, # X coordinate.

835

"y": 3.14, # Y coordinate.

},

],

},

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

840

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

841

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

842

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

843

},

844

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

845

{ # Detected language for a structural component.

846

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

847

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

848

# information, see

849

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

},

],

},

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

854

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

855

{ # A single symbol representation.

856

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

857

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

858

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

859

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

860

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

861

},

862

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

863

{ # Detected language for a structural component.

864

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

865

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

866

# information, see

867

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

},

],

},

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

872

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

873

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

874

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

875

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

876

# read in the 'natural' orientation.

877

# For example:

878

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

# 0----1

# | |

# 3----2

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

# 2----3

# | |

# 1----0

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

887

"vertices": [ # The bounding polygon vertices.

888

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

889

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

890

"x": 42, # X coordinate.

891

"y": 42, # Y coordinate.

892

},

893

],

894

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

895

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

896

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

897

# and range from 0 to 1.

898

"x": 3.14, # X coordinate.

899

"y": 3.14, # Y coordinate.

},

],

},

},

],

},

],

},

],

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

910

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

911

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

912

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

913

# read in the 'natural' orientation.

914

# For example:

915

#

916

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

#

# 0----1

# | |

# 3----2

#

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

#

# 2----3

# | |

# 1----0

#

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

929

"vertices": [ # The bounding polygon vertices.

930

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

931

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

932

"x": 42, # X coordinate.

933

"y": 42, # Y coordinate.

934

},

935

],

936

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

937

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

938

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

939

# and range from 0 to 1.

940

"x": 3.14, # X coordinate.

941

"y": 3.14, # Y coordinate.

},

],

},

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

946

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

947

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

948

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

949

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

950

},

951

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

952

{ # Detected language for a structural component.

953

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

954

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

955

# information, see

956

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

},

],

},

},

],

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

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

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

968

{ # Detected language for a structural component.

969

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

970

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

971

# information, see

972

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

},

],

},

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

977

# TIFFs) the unit is pixels.

978

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

979

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

980

# TIFFs) the unit is pixels.

},

],

},

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

985

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

986

# correct, even when `error` is set.

987

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

988

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

989

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

990

#

991

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

992

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

993

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

994

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

995

# message types for APIs to use.

996

{

997

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

998

},

999

],

1000

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

1001

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

1002

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

1003

},

1004

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

1005

# This will be sorted descending by confidence score.

1006

{ # Set of detected objects with bounding boxes.

1007

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

1008

"vertices": [ # The bounding polygon vertices.

1009

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

1010

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

1011

"x": 42, # X coordinate.

1012

"y": 42, # Y coordinate.

1013

},

1014

],

Bu Sun Kim

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

[diff] [blame]

1015

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

1016

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

1017

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

1018

# and range from 0 to 1.

1019

"x": 3.14, # X coordinate.

1020

"y": 3.14, # Y coordinate.

1021

},

1022

],

Bu Sun Kim

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

[diff] [blame]

1023

},

Bu Sun Kim

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

[diff] [blame]

1024

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

1025

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

1026

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

1027

# information, see

1028

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

1029

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

1030

},

1031

],

1032

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

1033

{ # Set of detected entity features.

Bu Sun Kim

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

[diff] [blame]

1034

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

1035

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

1036

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

1037

# detected distant towering building, even though the confidence that

1038

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

Bu Sun Kim

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

[diff] [blame]

1039

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

1040

# `description` is expressed.

Bu Sun Kim

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

[diff] [blame]

1041

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

1042

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

1043

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

1044

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

1045

# Location information is usually present for landmarks.

1046

{ # Detected entity location information.

1047

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

1048

# of doubles representing degrees latitude and degrees longitude. Unless

1049

# specified otherwise, this must conform to the

1050

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

1051

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

1052

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

1053

"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

1058

# [Google Knowledge Graph Search

1059

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

Bu Sun Kim

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

[diff] [blame]

1060

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

Bu Sun Kim

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

[diff] [blame]

1061

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

1062

# The accuracy of the entity detection in an image.

1063

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

1064

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

1065

# image. Range [0, 1].

Bu Sun Kim

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

[diff] [blame]

1066

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

1067

# for `LABEL_DETECTION` features.

1068

"vertices": [ # The bounding polygon vertices.

1069

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

1070

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

1071

"x": 42, # X coordinate.

1072

"y": 42, # Y coordinate.

1073

},

1074

],

1075

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

1076

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

1077

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

1078

# and range from 0 to 1.

1079

"x": 3.14, # X coordinate.

1080

"y": 3.14, # Y coordinate.

},

],

},

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

1085

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

1086

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

1087

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

1088

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

1089

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

1090

},

1091

],

1092

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

1093

},

1094

],

1095

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

1096

{ # Set of detected entity features.

1097

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

1098

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

1099

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

1100

# detected distant towering building, even though the confidence that

1101

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

1102

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

1103

# `description` is expressed.

1104

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

1105

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

1106

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

1107

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

1108

# Location information is usually present for landmarks.

1109

{ # Detected entity location information.

1110

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

1111

# of doubles representing degrees latitude and degrees longitude. Unless

1112

# specified otherwise, this must conform to the

1113

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

1114

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

1115

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

1116

"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

1121

# [Google Knowledge Graph Search

1122

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

1123

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

1124

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

1125

# The accuracy of the entity detection in an image.

1126

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

1127

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

1128

# image. Range [0, 1].

1129

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

1130

# for `LABEL_DETECTION` features.

1131

"vertices": [ # The bounding polygon vertices.

1132

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

1133

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

1134

"x": 42, # X coordinate.

1135

"y": 42, # Y coordinate.

1136

},

1137

],

1138

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

1139

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

1140

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

1141

# and range from 0 to 1.

1142

"x": 3.14, # X coordinate.

1143

"y": 3.14, # Y coordinate.

},

],

},

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

1148

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

1149

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

1150

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

1151

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

1152

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

1153

},

1154

],

1155

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

Bu Sun Kim

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

[diff] [blame]

1156

},

1157

],

1158

"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

1159

# comes from.

1160

# information about the source of that image.

1161

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

1162

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

1163

# the file used to produce the image.

1164

},

Bu Sun Kim

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

[diff] [blame]

1165

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

1166

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

1167

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

1168

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

1169

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

1170

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

1171

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

1172

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

1173

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

1174

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

1175

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

1176

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

1177

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

1178

# [-180,180].

1179

"landmarks": [ # Detected face landmarks.

1180

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

1181

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

1182

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

1183

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

1184

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

1185

"y": 3.14, # Y coordinate.

1186

"x": 3.14, # X coordinate.

1187

},

1188

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

1189

},

1190

],

1191

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

1192

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

1193

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

1194

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

1195

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

1196

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

1197

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

1198

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

1199

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

1200

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

1201

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

1202

"vertices": [ # The bounding polygon vertices.

1203

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

1204

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

1205

"x": 42, # X coordinate.

1206

"y": 42, # Y coordinate.

Bu Sun Kim

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

[diff] [blame]

1207

},

1208

],

Bu Sun Kim

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

[diff] [blame]

1209

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

1210

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

1211

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

1212

# and range from 0 to 1.

1213

"x": 3.14, # X coordinate.

1214

"y": 3.14, # Y coordinate.

1215

},

1216

],

Bu Sun Kim

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

[diff] [blame]

1217

},

Bu Sun Kim

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

[diff] [blame]

1218

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

1219

# are in the original image's scale.

1220

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

1221

# expectations. It is based on the landmarker results.

1222

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

1223

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

1224

# appears in the image to be annotated.

Bu Sun Kim

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

[diff] [blame]

1225

"vertices": [ # The bounding polygon vertices.

1226

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

1227

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

1228

"x": 42, # X coordinate.

1229

"y": 42, # Y coordinate.

1230

},

1231

],

Bu Sun Kim

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

[diff] [blame]

1232

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

1233

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

1234

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

1235

# and range from 0 to 1.

1236

"x": 3.14, # X coordinate.

1237

"y": 3.14, # Y coordinate.

1238

},

1239

],

Bu Sun Kim

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

[diff] [blame]

1240

},

Bu Sun Kim

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

[diff] [blame]

1241

},

1242

],

Bu Sun Kim

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

[diff] [blame]

1243

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

Bu Sun Kim

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

[diff] [blame]

1244

{ # Set of detected entity features.

Bu Sun Kim

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

[diff] [blame]

1245

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

1246

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

1247

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

1248

# detected distant towering building, even though the confidence that

1249

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

Bu Sun Kim

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

[diff] [blame]

1250

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

1251

# `description` is expressed.

Bu Sun Kim

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

[diff] [blame]

1252

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

1253

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

1254

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

1255

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

1256

# Location information is usually present for landmarks.

1257

{ # Detected entity location information.

1258

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

1259

# of doubles representing degrees latitude and degrees longitude. Unless

1260

# specified otherwise, this must conform to the

1261

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

1262

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

1263

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

1264

"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

1269

# [Google Knowledge Graph Search

1270

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

Bu Sun Kim

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

[diff] [blame]

1271

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

Bu Sun Kim

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

[diff] [blame]

1272

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

1273

# The accuracy of the entity detection in an image.

1274

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

1275

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

1276

# image. Range [0, 1].

Bu Sun Kim

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

[diff] [blame]

1277

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

1278

# for `LABEL_DETECTION` features.

1279

"vertices": [ # The bounding polygon vertices.

1280

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

1281

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

1282

"x": 42, # X coordinate.

1283

"y": 42, # Y coordinate.

1284

},

1285

],

1286

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

1287

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

1288

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

1289

# and range from 0 to 1.

1290

"x": 3.14, # X coordinate.

1291

"y": 3.14, # Y coordinate.

},

],

},

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

1296

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

1297

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

1298

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

1299

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

1300

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

1301

},

1302

],

1303

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

Bu Sun Kim

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

[diff] [blame]

1304

},

1305

],

Bu Sun Kim

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

[diff] [blame]

1306

},

1307

],

Bu Sun Kim

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

[diff] [blame]

},

],

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

1314

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

Bu Sun Kim

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

[diff] [blame]

1315

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

1316

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

1317

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

1318

`google.longrunning.Operations` interface.

1319

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

1320

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

1321

1322

Args:

Dan O'Meara

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

[diff] [blame]

1323

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

1324

The object takes the form of:

1325

1326

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

1327

# call.

Bu Sun Kim

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

[diff] [blame]

1328

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

Bu Sun Kim

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

[diff] [blame]

1329

{ # An offline file annotation request.

Bu Sun Kim

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

[diff] [blame]

1330

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

Bu Sun Kim

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

[diff] [blame]

1331

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

1332

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

1333

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

1334

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

1335

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

1336

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

1341

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

Bu Sun Kim

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

[diff] [blame]

1342

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

1343

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

1344

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

1345

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

1346

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

1347

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

1348

# migrate existing products to these categories as well.

1349

"A String",

1350

],

Bu Sun Kim

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

[diff] [blame]

1351

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

1352

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

Bu Sun Kim

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

[diff] [blame]

1353

"vertices": [ # The bounding polygon vertices.

1354

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

1355

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

1356

"x": 42, # X coordinate.

1357

"y": 42, # Y coordinate.

1358

},

1359

],

Bu Sun Kim

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

[diff] [blame]

1360

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

1361

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

1362

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

1363

# and range from 0 to 1.

1364

"x": 3.14, # X coordinate.

1365

"y": 3.14, # Y coordinate.

1366

},

1367

],

Bu Sun Kim

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

[diff] [blame]

1368

},

Bu Sun Kim

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

[diff] [blame]

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

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

1374

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

1375

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

1376

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

1377

#

1378

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

1379

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

1380

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

Bu Sun Kim

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

[diff] [blame]

1381

},

1382

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

1383

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

1384

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

1385

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

1386

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

1387

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

1388

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

1389

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

1390

"A String",

1391

],

Bu Sun Kim

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

[diff] [blame]

1392

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

1393

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

1394

# of doubles representing degrees latitude and degrees longitude. Unless

1395

# specified otherwise, this must conform to the

1396

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

1397

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

1398

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

1399

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

1400

},

1401

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

1402

# of doubles representing degrees latitude and degrees longitude. Unless

1403

# specified otherwise, this must conform to the

1404

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

1405

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

1406

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

1407

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

1408

},

Bu Sun Kim

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

[diff] [blame]

1409

},

Bu Sun Kim

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

[diff] [blame]

1410

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

1411

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

1412

},

Bu Sun Kim

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

[diff] [blame]

1413

},

Bu Sun Kim

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

[diff] [blame]

1414

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

1415

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

1416

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

1417

# representation, whereas JSON representations use base64.

1418

#

1419

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

1420

# not work for AsyncBatchAnnotateFiles requests.

1421

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

1422

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

1423

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

1424

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

1425

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

1426

},

1427

},

1428

"features": [ # Required. Requested features.

1429

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

1430

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

1431

# be specified in the `features` list.

1432

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

1433

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

1434

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

1435

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

1436

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

1437

# "builtin/latest".

1438

},

1439

],

Bu Sun Kim

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

[diff] [blame]

1440

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

Bu Sun Kim

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

[diff] [blame]

1441

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

1442

# Google Cloud Storage.

1443

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

1444

#

1445

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

1446

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

1447

# containing 20 response protos will be written under the prefix

1448

# `gcs_destination`.`uri`.

1449

#

1450

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

1451

# support for other output configurations.

Bu Sun Kim

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

[diff] [blame]

1452

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

1453

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

1454

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

1455

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

1456

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

1457

# 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

1463

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

1464

# output files will begin with "filenameprefix".

Bu Sun Kim

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

[diff] [blame]

1465

#

1466

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

1467

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

1468

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

1469

# specified.

1470

#

1471

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

1472

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

1473

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

1474

# and overflows into multiple sharded files.

1475

},

1476

},

Bu Sun Kim

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

[diff] [blame]

1477

},

1478

],

Bu Sun Kim

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

[diff] [blame]

1479

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

Dan O'Meara

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

[diff] [blame]

1480

#

1481

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

1482

#

1483

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

1484

#

1485

# Supported location-ids:

1486

# `us`: USA country only,

1487

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

1488

# `eu`: The European Union.

1489

#

1490

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

Bu Sun Kim

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

[diff] [blame]

1491

}

1492

1493

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1500

1501

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

1502

# network API call.

Bu Sun Kim

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

[diff] [blame]

1503

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

1504

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

1505

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

1506

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

1507

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

1508

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

1509

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

1510

# `TakeSnapshotResponse`.

Bu Sun Kim

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

[diff] [blame]

1511

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

Bu Sun Kim

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

[diff] [blame]

1512

},

Bu Sun Kim

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

[diff] [blame]

1513

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

1514

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

1515

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

1516

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

1517

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

1518

},

Bu Sun Kim

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

[diff] [blame]

1519

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

1520

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

1521

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

Bu Sun Kim