docs: update docs (#916)
* fix: re-run script
* test: fix noxfile
diff --git a/docs/dyn/vision_v1.projects.files.html b/docs/dyn/vision_v1.projects.files.html
index 83f2475..9fc3aac 100644
--- a/docs/dyn/vision_v1.projects.files.html
+++ b/docs/dyn/vision_v1.projects.files.html
@@ -124,10 +124,6 @@
# AnnotateFileRequest in BatchAnnotateFilesRequest.
{ # A request to annotate one single file, e.g. a PDF, TIFF or GIF file.
"inputConfig": { # The desired input location and metadata. # Required. Information about the input file.
- "gcsSource": { # The Google Cloud Storage location where the input will be read from. # The Google Cloud Storage location to read the input from.
- "uri": "A String", # Google Cloud Storage URI for the input file. This must only be a
- # Google Cloud Storage object. Wildcards are not currently supported.
- },
"mimeType": "A String", # The type of the file. Currently only "application/pdf", "image/tiff" and
# "image/gif" are supported. Wildcards are not supported.
"content": "A String", # File content, represented as a stream of bytes.
@@ -136,17 +132,21 @@
#
# Currently, this field only works for BatchAnnotateFiles requests. It does
# not work for AsyncBatchAnnotateFiles requests.
+ "gcsSource": { # The Google Cloud Storage location where the input will be read from. # The Google Cloud Storage location to read the input from.
+ "uri": "A String", # Google Cloud Storage URI for the input file. This must only be a
+ # Google Cloud Storage object. Wildcards are not currently supported.
+ },
},
"features": [ # Required. Requested features.
{ # The type of Google Cloud Vision API detection to perform, and the maximum
# number of results to return for that type. Multiple `Feature` objects can
# be specified in the `features` list.
- "model": "A String", # Model to use for the feature.
- # Supported values: "builtin/stable" (the default if unset) and
- # "builtin/latest".
"type": "A String", # The feature type.
"maxResults": 42, # Maximum number of results of this type. Does not apply to
# `TEXT_DETECTION`, `DOCUMENT_TEXT_DETECTION`, or `CROP_HINTS`.
+ "model": "A String", # Model to use for the feature.
+ # Supported values: "builtin/stable" (the default if unset) and
+ # "builtin/latest".
},
],
"imageContext": { # Image context and/or feature-specific parameters. # Additional context that may accompany the image(s) in the file.
@@ -192,15 +192,6 @@
],
},
"productSearchParams": { # Parameters for a product search request. # Parameters for product search.
- "productCategories": [ # The list of product categories to search in. Currently, we only consider
- # the first category, and either "homegoods-v2", "apparel-v2", "toys-v2",
- # "packagedgoods-v1", or "general-v1" should be specified. The legacy
- # categories "homegoods", "apparel", and "toys" are still supported but will
- # be deprecated. For new products, please use "homegoods-v2", "apparel-v2",
- # or "toys-v2" for better product search accuracy. It is recommended to
- # migrate existing products to these categories as well.
- "A String",
- ],
"filter": "A String", # The filtering expression. This can be used to restrict search results based
# on Product labels. We currently support an AND of OR of key-value
# expressions, where each expression within an OR must have the same key. An
@@ -226,11 +217,20 @@
"vertices": [ # The bounding polygon vertices.
{ # A vertex represents a 2D point in the image.
# NOTE: the vertex coordinates are in the same scale as the original image.
- "y": 42, # Y coordinate.
"x": 42, # X coordinate.
+ "y": 42, # Y coordinate.
},
],
},
+ "productCategories": [ # The list of product categories to search in. Currently, we only consider
+ # the first category, and either "homegoods-v2", "apparel-v2", "toys-v2",
+ # "packagedgoods-v1", or "general-v1" should be specified. The legacy
+ # categories "homegoods", "apparel", and "toys" are still supported but will
+ # be deprecated. For new products, please use "homegoods-v2", "apparel-v2",
+ # or "toys-v2" for better product search accuracy. It is recommended to
+ # migrate existing products to these categories as well.
+ "A String",
+ ],
},
},
"pages": [ # Pages of the file to perform image annotation.
@@ -266,30 +266,75 @@
# AnnotateFileRequest in BatchAnnotateFilesRequest.
{ # Response to a single file annotation request. A file may contain one or more
# images, which individually have their own responses.
- "error": { # The `Status` type defines a logical error model that is suitable for # If set, represents the error message for the failed request. The
- # `responses` field will not be set in this case.
- # different programming environments, including REST APIs and RPC APIs. It is
- # used by [gRPC](https://github.com/grpc). Each `Status` message contains
- # three pieces of data: error code, error message, and error details.
- #
- # You can find out more about this error model and how to work with it in the
- # [API Design Guide](https://cloud.google.com/apis/design/errors).
- "details": [ # A list of messages that carry the error details. There is a common set of
- # message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- ],
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "message": "A String", # A developer-facing error message, which should be in English. Any
- # user-facing error message should be localized and sent in the
- # google.rpc.Status.details field, or localized by the client.
- },
"responses": [ # Individual responses to images found within the file. This field will be
# empty if the `error` field is set.
{ # Response to an image annotation request.
+ "landmarkAnnotations": [ # If present, landmark detection has completed successfully.
+ { # Set of detected entity features.
+ "score": 3.14, # Overall score of the result. Range [0, 1].
+ "locations": [ # The location information for the detected entity. Multiple
+ # `LocationInfo` elements can be present because one location may
+ # indicate the location of the scene in the image, and another location
+ # may indicate the location of the place where the image was taken.
+ # Location information is usually present for landmarks.
+ { # Detected entity location information.
+ "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # lat/long location coordinates.
+ # of doubles representing degrees latitude and degrees longitude. Unless
+ # specified otherwise, this must conform to the
+ # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84
+ # standard</a>. Values must be within normalized ranges.
+ "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
+ "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
+ # [Google Knowledge Graph Search
+ # API](https://developers.google.com/knowledge-graph/).
+ "confidence": 3.14, # **Deprecated. Use `score` instead.**
+ # The accuracy of the entity detection in an image.
+ # For example, for an image in which the "Eiffel Tower" entity is detected,
+ # this field represents the confidence that there is a tower in the query
+ # image. Range [0, 1].
+ "locale": "A String", # The language code for the locale in which the entity textual
+ # `description` is expressed.
+ "boundingPoly": { # A bounding polygon for the detected image annotation. # Image region to which this entity belongs. Not produced
+ # for `LABEL_DETECTION` features.
+ "normalizedVertices": [ # The bounding polygon normalized vertices.
+ { # A vertex represents a 2D point in the image.
+ # NOTE: the normalized vertex coordinates are relative to the original image
+ # and range from 0 to 1.
+ "y": 3.14, # Y coordinate.
+ "x": 3.14, # X coordinate.
+ },
+ ],
+ "vertices": [ # The bounding polygon vertices.
+ { # A vertex represents a 2D point in the image.
+ # NOTE: the vertex coordinates are in the same scale as the original image.
+ "x": 42, # X coordinate.
+ "y": 42, # Y coordinate.
+ },
+ ],
+ },
+ "description": "A String", # Entity textual description, expressed in its `locale` language.
+ "topicality": 3.14, # The relevancy of the ICA (Image Content Annotation) label to the
+ # image. For example, the relevancy of "tower" is likely higher to an image
+ # containing the detected "Eiffel Tower" than to an image containing a
+ # detected distant towering building, even though the confidence that
+ # there is a tower in each image may be the same. Range [0, 1].
+ "properties": [ # Some entities may have optional user-supplied `Property` (name/value)
+ # fields, such a score or string that qualifies the entity.
+ { # A `Property` consists of a user-supplied name/value pair.
+ "value": "A String", # Value of the property.
+ "uint64Value": "A String", # Value of numeric properties.
+ "name": "A String", # Name of the property.
+ },
+ ],
+ },
+ ],
"faceAnnotations": [ # If present, face detection has completed successfully.
{ # A face annotation object contains the results of face detection.
+ "sorrowLikelihood": "A String", # Sorrow likelihood.
"tiltAngle": 3.14, # Pitch angle, which indicates the upwards/downwards angle that the face is
# pointing relative to the image's horizontal plane. Range [-180,180].
"fdBoundingPoly": { # A bounding polygon for the detected image annotation. # The `fd_bounding_poly` bounding polygon is tighter than the
@@ -309,14 +354,14 @@
"vertices": [ # The bounding polygon vertices.
{ # A vertex represents a 2D point in the image.
# NOTE: the vertex coordinates are in the same scale as the original image.
- "y": 42, # Y coordinate.
"x": 42, # X coordinate.
+ "y": 42, # Y coordinate.
},
],
},
- "angerLikelihood": "A String", # Anger likelihood.
"landmarks": [ # Detected face landmarks.
{ # A face-specific landmark (for example, a face feature).
+ "type": "A String", # Face landmark type.
"position": { # A 3D position in the image, used primarily for Face detection landmarks. # Face landmark position.
# A valid Position must have both x and y coordinates.
# The position coordinates are in the same scale as the original image.
@@ -324,10 +369,10 @@
"x": 3.14, # X coordinate.
"z": 3.14, # Z coordinate (or depth).
},
- "type": "A String", # Face landmark type.
},
],
"surpriseLikelihood": "A String", # Surprise likelihood.
+ "angerLikelihood": "A String", # Anger likelihood.
"landmarkingConfidence": 3.14, # Face landmarking confidence. Range [0, 1].
"joyLikelihood": "A String", # Joy likelihood.
"underExposedLikelihood": "A String", # Under-exposed likelihood.
@@ -355,15 +400,14 @@
"vertices": [ # The bounding polygon vertices.
{ # A vertex represents a 2D point in the image.
# NOTE: the vertex coordinates are in the same scale as the original image.
- "y": 42, # Y coordinate.
"x": 42, # X coordinate.
+ "y": 42, # Y coordinate.
},
],
},
"rollAngle": 3.14, # Roll angle, which indicates the amount of clockwise/anti-clockwise rotation
# of the face relative to the image vertical about the axis perpendicular to
# the face. Range [-180,180].
- "sorrowLikelihood": "A String", # Sorrow likelihood.
},
],
"cropHintsAnnotation": { # Set of crop hints that are used to generate new crops when serving images. # If present, crop hints have completed successfully.
@@ -385,8 +429,8 @@
"vertices": [ # The bounding polygon vertices.
{ # A vertex represents a 2D point in the image.
# NOTE: the vertex coordinates are in the same scale as the original image.
- "y": 42, # Y coordinate.
"x": 42, # X coordinate.
+ "y": 42, # Y coordinate.
},
],
},
@@ -435,8 +479,8 @@
"vertices": [ # The bounding polygon vertices.
{ # A vertex represents a 2D point in the image.
# NOTE: the vertex coordinates are in the same scale as the original image.
- "y": 42, # Y coordinate.
"x": 42, # X coordinate.
+ "y": 42, # Y coordinate.
},
],
},
@@ -457,9 +501,6 @@
},
],
"productSearchResults": { # Results for a product search request. # If present, product search has completed successfully.
- "indexTime": "A String", # Timestamp of the index which provided these results. Products added to the
- # product set and products removed from the product set after this time are
- # not reflected in the current results.
"productGroupedResults": [ # List of results grouped by products detected in the query image. Each entry
# corresponds to one bounding polygon in the query image, and contains the
# matching products specific to that region. There may be duplicate product
@@ -468,12 +509,12 @@
# image.
"objectAnnotations": [ # List of generic predictions for the object in the bounding box.
{ # Prediction for what the object in the bounding box is.
- "name": "A String", # Object name, expressed in its `language_code` language.
"score": 3.14, # Score of the result. Range [0, 1].
"languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more
# information, see
# http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
"mid": "A String", # Object ID that should align with EntityAnnotation mid.
+ "name": "A String", # Object name, expressed in its `language_code` language.
},
],
"boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon around the product detected in the query image.
@@ -488,8 +529,8 @@
"vertices": [ # The bounding polygon vertices.
{ # A vertex represents a 2D point in the image.
# NOTE: the vertex coordinates are in the same scale as the original image.
- "y": 42, # Y coordinate.
"x": 42, # X coordinate.
+ "y": 42, # Y coordinate.
},
],
},
@@ -583,10 +624,18 @@
# 1 (full confidence).
},
],
+ "indexTime": "A String", # Timestamp of the index which provided these results. Products added to the
+ # product set and products removed from the product set after this time are
+ # not reflected in the current results.
},
"localizedObjectAnnotations": [ # If present, localized object detection has completed successfully.
# This will be sorted descending by confidence score.
{ # Set of detected objects with bounding boxes.
+ "score": 3.14, # Score of the result. Range [0, 1].
+ "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more
+ # information, see
+ # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
+ "mid": "A String", # Object ID that should align with EntityAnnotation mid.
"name": "A String", # Object name, expressed in its `language_code` language.
"boundingPoly": { # A bounding polygon for the detected image annotation. # Image region to which this object belongs. This must be populated.
"normalizedVertices": [ # The bounding polygon normalized vertices.
@@ -600,16 +649,11 @@
"vertices": [ # The bounding polygon vertices.
{ # A vertex represents a 2D point in the image.
# NOTE: the vertex coordinates are in the same scale as the original image.
- "y": 42, # Y coordinate.
"x": 42, # X coordinate.
+ "y": 42, # Y coordinate.
},
],
},
- "score": 3.14, # Score of the result. Range [0, 1].
- "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more
- # information, see
- # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
- "mid": "A String", # Object ID that should align with EntityAnnotation mid.
},
],
"error": { # The `Status` type defines a logical error model that is suitable for # If set, represents the error message for the operation.
@@ -621,16 +665,16 @@
#
# You can find out more about this error model and how to work with it in the
# [API Design Guide](https://cloud.google.com/apis/design/errors).
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "message": "A String", # A developer-facing error message, which should be in English. Any
+ # user-facing error message should be localized and sent in the
+ # google.rpc.Status.details field, or localized by the client.
"details": [ # A list of messages that carry the error details. There is a common set of
# message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "message": "A String", # A developer-facing error message, which should be in English. Any
- # user-facing error message should be localized and sent in the
- # google.rpc.Status.details field, or localized by the client.
},
"fullTextAnnotation": { # TextAnnotation contains a structured representation of OCR extracted text. # If present, text (OCR) detection or document (OCR) text detection has
# completed successfully.
@@ -644,25 +688,21 @@
# detail.
"pages": [ # List of pages detected by OCR.
{ # Detected page from OCR.
- "height": 42, # Page height. For PDFs the unit is points. For images (including
- # TIFFs) the unit is pixels.
- "width": 42, # Page width. For PDFs the unit is points. For images (including
- # TIFFs) the unit is pixels.
"blocks": [ # List of blocks of text, images etc on this page.
{ # Logical element on the page.
"property": { # Additional information detected on the structural component. # Additional information detected for the block.
- "detectedLanguages": [ # A list of detected languages together with confidence.
- { # Detected language for a structural component.
- "confidence": 3.14, # Confidence of detected language. Range [0, 1].
- "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more
- # information, see
- # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
- },
- ],
"detectedBreak": { # Detected start or end of a structural component. # Detected start or end of a text segment.
"type": "A String", # Detected break type.
"isPrefix": True or False, # True if break prepends the element.
},
+ "detectedLanguages": [ # A list of detected languages together with confidence.
+ { # Detected language for a structural component.
+ "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more
+ # information, see
+ # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
+ "confidence": 3.14, # Confidence of detected language. Range [0, 1].
+ },
+ ],
},
"blockType": "A String", # Detected block type (text, image etc) for this block.
"boundingBox": { # A bounding polygon for the detected image annotation. # The bounding box for the block.
@@ -696,8 +736,8 @@
"vertices": [ # The bounding polygon vertices.
{ # A vertex represents a 2D point in the image.
# NOTE: the vertex coordinates are in the same scale as the original image.
- "y": 42, # Y coordinate.
"x": 42, # X coordinate.
+ "y": 42, # Y coordinate.
},
],
},
@@ -705,18 +745,18 @@
"paragraphs": [ # List of paragraphs in this block (if this blocks is of type text).
{ # Structural unit of text representing a number of words in certain order.
"property": { # Additional information detected on the structural component. # Additional information detected for the paragraph.
- "detectedLanguages": [ # A list of detected languages together with confidence.
- { # Detected language for a structural component.
- "confidence": 3.14, # Confidence of detected language. Range [0, 1].
- "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more
- # information, see
- # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
- },
- ],
"detectedBreak": { # Detected start or end of a structural component. # Detected start or end of a text segment.
"type": "A String", # Detected break type.
"isPrefix": True or False, # True if break prepends the element.
},
+ "detectedLanguages": [ # A list of detected languages together with confidence.
+ { # Detected language for a structural component.
+ "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more
+ # information, see
+ # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
+ "confidence": 3.14, # Confidence of detected language. Range [0, 1].
+ },
+ ],
},
"boundingBox": { # A bounding polygon for the detected image annotation. # The bounding box for the paragraph.
# The vertices are in the order of top-left, top-right, bottom-right,
@@ -744,8 +784,8 @@
"vertices": [ # The bounding polygon vertices.
{ # A vertex represents a 2D point in the image.
# NOTE: the vertex coordinates are in the same scale as the original image.
- "y": 42, # Y coordinate.
"x": 42, # X coordinate.
+ "y": 42, # Y coordinate.
},
],
},
@@ -778,8 +818,8 @@
"vertices": [ # The bounding polygon vertices.
{ # A vertex represents a 2D point in the image.
# NOTE: the vertex coordinates are in the same scale as the original image.
- "y": 42, # Y coordinate.
"x": 42, # X coordinate.
+ "y": 42, # Y coordinate.
},
],
},
@@ -787,6 +827,20 @@
"symbols": [ # List of symbols in the word.
# The order of the symbols follows the natural reading order.
{ # A single symbol representation.
+ "property": { # Additional information detected on the structural component. # Additional information detected for the symbol.
+ "detectedBreak": { # Detected start or end of a structural component. # Detected start or end of a text segment.
+ "type": "A String", # Detected break type.
+ "isPrefix": True or False, # True if break prepends the element.
+ },
+ "detectedLanguages": [ # A list of detected languages together with confidence.
+ { # Detected language for a structural component.
+ "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more
+ # information, see
+ # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
+ "confidence": 3.14, # Confidence of detected language. Range [0, 1].
+ },
+ ],
+ },
"boundingBox": { # A bounding polygon for the detected image annotation. # The bounding box for the symbol.
# The vertices are in the order of top-left, top-right, bottom-right,
# bottom-left. When a rotation of the bounding box is detected the rotation
@@ -813,42 +867,28 @@
"vertices": [ # The bounding polygon vertices.
{ # A vertex represents a 2D point in the image.
# NOTE: the vertex coordinates are in the same scale as the original image.
- "y": 42, # Y coordinate.
"x": 42, # X coordinate.
+ "y": 42, # Y coordinate.
},
],
},
"confidence": 3.14, # Confidence of the OCR results for the symbol. Range [0, 1].
"text": "A String", # The actual UTF-8 representation of the symbol.
- "property": { # Additional information detected on the structural component. # Additional information detected for the symbol.
- "detectedLanguages": [ # A list of detected languages together with confidence.
- { # Detected language for a structural component.
- "confidence": 3.14, # Confidence of detected language. Range [0, 1].
- "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more
- # information, see
- # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
- },
- ],
- "detectedBreak": { # Detected start or end of a structural component. # Detected start or end of a text segment.
- "type": "A String", # Detected break type.
- "isPrefix": True or False, # True if break prepends the element.
- },
- },
},
],
"property": { # Additional information detected on the structural component. # Additional information detected for the word.
- "detectedLanguages": [ # A list of detected languages together with confidence.
- { # Detected language for a structural component.
- "confidence": 3.14, # Confidence of detected language. Range [0, 1].
- "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more
- # information, see
- # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
- },
- ],
"detectedBreak": { # Detected start or end of a structural component. # Detected start or end of a text segment.
"type": "A String", # Detected break type.
"isPrefix": True or False, # True if break prepends the element.
},
+ "detectedLanguages": [ # A list of detected languages together with confidence.
+ { # Detected language for a structural component.
+ "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more
+ # information, see
+ # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
+ "confidence": 3.14, # Confidence of detected language. Range [0, 1].
+ },
+ ],
},
},
],
@@ -857,20 +897,24 @@
},
],
"property": { # Additional information detected on the structural component. # Additional information detected on the page.
- "detectedLanguages": [ # A list of detected languages together with confidence.
- { # Detected language for a structural component.
- "confidence": 3.14, # Confidence of detected language. Range [0, 1].
- "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more
- # information, see
- # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
- },
- ],
"detectedBreak": { # Detected start or end of a structural component. # Detected start or end of a text segment.
"type": "A String", # Detected break type.
"isPrefix": True or False, # True if break prepends the element.
},
+ "detectedLanguages": [ # A list of detected languages together with confidence.
+ { # Detected language for a structural component.
+ "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more
+ # information, see
+ # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
+ "confidence": 3.14, # Confidence of detected language. Range [0, 1].
+ },
+ ],
},
"confidence": 3.14, # Confidence of the OCR results on the page. Range [0, 1].
+ "height": 42, # Page height. For PDFs the unit is points. For images (including
+ # TIFFs) the unit is pixels.
+ "width": 42, # Page width. For PDFs the unit is points. For images (including
+ # TIFFs) the unit is pixels.
},
],
"text": "A String", # UTF-8 text detected on the pages.
@@ -917,8 +961,8 @@
"vertices": [ # The bounding polygon vertices.
{ # A vertex represents a 2D point in the image.
# NOTE: the vertex coordinates are in the same scale as the original image.
- "y": 42, # Y coordinate.
"x": 42, # X coordinate.
+ "y": 42, # Y coordinate.
},
],
},
@@ -943,6 +987,7 @@
"colors": [ # RGB color values with their score and pixel fraction.
{ # Color information consists of RGB channels, score, and the fraction of
# the image that the color occupies in the image.
+ "score": 3.14, # Image-specific score for this color. Value in range [0, 1].
"pixelFraction": 3.14, # The fraction of pixels the color occupies in the image.
# Value in range [0, 1].
"color": { # Represents a color in the RGBA color space. This representation is designed # RGB components of the color.
@@ -1079,7 +1124,6 @@
# If omitted, this color object is to be rendered as a solid color
# (as if the alpha value had been explicitly given with a value of 1.0).
},
- "score": 3.14, # Image-specific score for this color. Value in range [0, 1].
},
],
},
@@ -1126,8 +1170,8 @@
"vertices": [ # The bounding polygon vertices.
{ # A vertex represents a 2D point in the image.
# NOTE: the vertex coordinates are in the same scale as the original image.
- "y": 42, # Y coordinate.
"x": 42, # X coordinate.
+ "y": 42, # Y coordinate.
},
],
},
@@ -1155,19 +1199,34 @@
# the file used to produce the image.
},
"webDetection": { # Relevant information for the image from the Internet. # If present, web detection has completed successfully.
+ "visuallySimilarImages": [ # The visually similar image results.
+ { # Metadata for online images.
+ "score": 3.14, # (Deprecated) Overall relevancy score for the image.
+ "url": "A String", # The result image URL.
+ },
+ ],
+ "bestGuessLabels": [ # The service's best guess as to the topic of the request image.
+ # Inferred from similar images on the open web.
+ { # Label to provide extra metadata for the web detection.
+ "label": "A String", # Label for extra metadata.
+ "languageCode": "A String", # The BCP-47 language code for `label`, such as "en-US" or "sr-Latn".
+ # For more information, see
+ # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
+ },
+ ],
"fullMatchingImages": [ # Fully matching images from the Internet.
# Can include resized copies of the query image.
{ # Metadata for online images.
- "url": "A String", # The result image URL.
"score": 3.14, # (Deprecated) Overall relevancy score for the image.
+ "url": "A String", # The result image URL.
},
],
"webEntities": [ # Deduced entities from similar images on the Internet.
{ # Entity deduced from similar images on the Internet.
- "score": 3.14, # Overall relevancy score for the entity.
- # Not normalized and not comparable across different image queries.
"entityId": "A String", # Opaque entity ID.
"description": "A String", # Canonical description of the entity, in English.
+ "score": 3.14, # Overall relevancy score for the entity.
+ # Not normalized and not comparable across different image queries.
},
],
"pagesWithMatchingImages": [ # Web pages containing the matching images from the Internet.
@@ -1178,8 +1237,8 @@
# example an original image will likely have partial matching for its
# crops.
{ # Metadata for online images.
- "url": "A String", # The result image URL.
"score": 3.14, # (Deprecated) Overall relevancy score for the image.
+ "url": "A String", # The result image URL.
},
],
"url": "A String", # The result web page URL.
@@ -1187,8 +1246,8 @@
"fullMatchingImages": [ # Fully matching images on the page.
# Can include resized copies of the query image.
{ # Metadata for online images.
- "url": "A String", # The result image URL.
"score": 3.14, # (Deprecated) Overall relevancy score for the image.
+ "url": "A String", # The result image URL.
},
],
},
@@ -1197,23 +1256,8 @@
# Those images are similar enough to share some key-point features. For
# example an original image will likely have partial matching for its crops.
{ # Metadata for online images.
- "url": "A String", # The result image URL.
"score": 3.14, # (Deprecated) Overall relevancy score for the image.
- },
- ],
- "visuallySimilarImages": [ # The visually similar image results.
- { # Metadata for online images.
"url": "A String", # The result image URL.
- "score": 3.14, # (Deprecated) Overall relevancy score for the image.
- },
- ],
- "bestGuessLabels": [ # The service's best guess as to the topic of the request image.
- # Inferred from similar images on the open web.
- { # Label to provide extra metadata for the web detection.
- "label": "A String", # Label for extra metadata.
- "languageCode": "A String", # The BCP-47 language code for `label`, such as "en-US" or "sr-Latn".
- # For more information, see
- # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
},
],
},
@@ -1233,76 +1277,9 @@
# body areas.
"violence": "A String", # Likelihood that this image contains violent content.
},
- "landmarkAnnotations": [ # If present, landmark detection has completed successfully.
- { # Set of detected entity features.
- "score": 3.14, # Overall score of the result. Range [0, 1].
- "locations": [ # The location information for the detected entity. Multiple
- # `LocationInfo` elements can be present because one location may
- # indicate the location of the scene in the image, and another location
- # may indicate the location of the place where the image was taken.
- # Location information is usually present for landmarks.
- { # Detected entity location information.
- "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # lat/long location coordinates.
- # of doubles representing degrees latitude and degrees longitude. Unless
- # specified otherwise, this must conform to the
- # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84
- # standard</a>. Values must be within normalized ranges.
- "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
- "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
- # [Google Knowledge Graph Search
- # API](https://developers.google.com/knowledge-graph/).
- "confidence": 3.14, # **Deprecated. Use `score` instead.**
- # The accuracy of the entity detection in an image.
- # For example, for an image in which the "Eiffel Tower" entity is detected,
- # this field represents the confidence that there is a tower in the query
- # image. Range [0, 1].
- "locale": "A String", # The language code for the locale in which the entity textual
- # `description` is expressed.
- "boundingPoly": { # A bounding polygon for the detected image annotation. # Image region to which this entity belongs. Not produced
- # for `LABEL_DETECTION` features.
- "normalizedVertices": [ # The bounding polygon normalized vertices.
- { # A vertex represents a 2D point in the image.
- # NOTE: the normalized vertex coordinates are relative to the original image
- # and range from 0 to 1.
- "y": 3.14, # Y coordinate.
- "x": 3.14, # X coordinate.
- },
- ],
- "vertices": [ # The bounding polygon vertices.
- { # A vertex represents a 2D point in the image.
- # NOTE: the vertex coordinates are in the same scale as the original image.
- "y": 42, # Y coordinate.
- "x": 42, # X coordinate.
- },
- ],
- },
- "description": "A String", # Entity textual description, expressed in its `locale` language.
- "topicality": 3.14, # The relevancy of the ICA (Image Content Annotation) label to the
- # image. For example, the relevancy of "tower" is likely higher to an image
- # containing the detected "Eiffel Tower" than to an image containing a
- # detected distant towering building, even though the confidence that
- # there is a tower in each image may be the same. Range [0, 1].
- "properties": [ # Some entities may have optional user-supplied `Property` (name/value)
- # fields, such a score or string that qualifies the entity.
- { # A `Property` consists of a user-supplied name/value pair.
- "value": "A String", # Value of the property.
- "uint64Value": "A String", # Value of numeric properties.
- "name": "A String", # Name of the property.
- },
- ],
- },
- ],
},
],
"inputConfig": { # The desired input location and metadata. # Information about the file for which this response is generated.
- "gcsSource": { # The Google Cloud Storage location where the input will be read from. # The Google Cloud Storage location to read the input from.
- "uri": "A String", # Google Cloud Storage URI for the input file. This must only be a
- # Google Cloud Storage object. Wildcards are not currently supported.
- },
"mimeType": "A String", # The type of the file. Currently only "application/pdf", "image/tiff" and
# "image/gif" are supported. Wildcards are not supported.
"content": "A String", # File content, represented as a stream of bytes.
@@ -1311,8 +1288,31 @@
#
# Currently, this field only works for BatchAnnotateFiles requests. It does
# not work for AsyncBatchAnnotateFiles requests.
+ "gcsSource": { # The Google Cloud Storage location where the input will be read from. # The Google Cloud Storage location to read the input from.
+ "uri": "A String", # Google Cloud Storage URI for the input file. This must only be a
+ # Google Cloud Storage object. Wildcards are not currently supported.
+ },
},
"totalPages": 42, # This field gives the total number of pages in the file.
+ "error": { # The `Status` type defines a logical error model that is suitable for # If set, represents the error message for the failed request. The
+ # `responses` field will not be set in this case.
+ # different programming environments, including REST APIs and RPC APIs. It is
+ # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+ # three pieces of data: error code, error message, and error details.
+ #
+ # You can find out more about this error model and how to work with it in the
+ # [API Design Guide](https://cloud.google.com/apis/design/errors).
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "message": "A String", # A developer-facing error message, which should be in English. Any
+ # user-facing error message should be localized and sent in the
+ # google.rpc.Status.details field, or localized by the client.
+ "details": [ # A list of messages that carry the error details. There is a common set of
+ # message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
},
],
}</pre>
@@ -1347,6 +1347,32 @@
# call.
"requests": [ # Required. Individual async file annotation requests for this batch.
{ # An offline file annotation request.
+ "inputConfig": { # The desired input location and metadata. # Required. Information about the input file.
+ "mimeType": "A String", # The type of the file. Currently only "application/pdf", "image/tiff" and
+ # "image/gif" are supported. Wildcards are not supported.
+ "content": "A String", # File content, represented as a stream of bytes.
+ # Note: As with all `bytes` fields, protobuffers use a pure binary
+ # representation, whereas JSON representations use base64.
+ #
+ # Currently, this field only works for BatchAnnotateFiles requests. It does
+ # not work for AsyncBatchAnnotateFiles requests.
+ "gcsSource": { # The Google Cloud Storage location where the input will be read from. # The Google Cloud Storage location to read the input from.
+ "uri": "A String", # Google Cloud Storage URI for the input file. This must only be a
+ # Google Cloud Storage object. Wildcards are not currently supported.
+ },
+ },
+ "features": [ # Required. Requested features.
+ { # The type of Google Cloud Vision API detection to perform, and the maximum
+ # number of results to return for that type. Multiple `Feature` objects can
+ # be specified in the `features` list.
+ "type": "A String", # The feature type.
+ "maxResults": 42, # Maximum number of results of this type. Does not apply to
+ # `TEXT_DETECTION`, `DOCUMENT_TEXT_DETECTION`, or `CROP_HINTS`.
+ "model": "A String", # Model to use for the feature.
+ # Supported values: "builtin/stable" (the default if unset) and
+ # "builtin/latest".
+ },
+ ],
"imageContext": { # Image context and/or feature-specific parameters. # Additional context that may accompany the image(s) in the file.
"languageHints": [ # List of languages to use for TEXT_DETECTION. In most cases, an empty value
# yields the best results since it enables automatic language detection. For
@@ -1390,15 +1416,6 @@
],
},
"productSearchParams": { # Parameters for a product search request. # Parameters for product search.
- "productCategories": [ # The list of product categories to search in. Currently, we only consider
- # the first category, and either "homegoods-v2", "apparel-v2", "toys-v2",
- # "packagedgoods-v1", or "general-v1" should be specified. The legacy
- # categories "homegoods", "apparel", and "toys" are still supported but will
- # be deprecated. For new products, please use "homegoods-v2", "apparel-v2",
- # or "toys-v2" for better product search accuracy. It is recommended to
- # migrate existing products to these categories as well.
- "A String",
- ],
"filter": "A String", # The filtering expression. This can be used to restrict search results based
# on Product labels. We currently support an AND of OR of key-value
# expressions, where each expression within an OR must have the same key. An
@@ -1424,14 +1441,34 @@
"vertices": [ # The bounding polygon vertices.
{ # A vertex represents a 2D point in the image.
# NOTE: the vertex coordinates are in the same scale as the original image.
- "y": 42, # Y coordinate.
"x": 42, # X coordinate.
+ "y": 42, # Y coordinate.
},
],
},
+ "productCategories": [ # The list of product categories to search in. Currently, we only consider
+ # the first category, and either "homegoods-v2", "apparel-v2", "toys-v2",
+ # "packagedgoods-v1", or "general-v1" should be specified. The legacy
+ # categories "homegoods", "apparel", and "toys" are still supported but will
+ # be deprecated. For new products, please use "homegoods-v2", "apparel-v2",
+ # or "toys-v2" for better product search accuracy. It is recommended to
+ # migrate existing products to these categories as well.
+ "A String",
+ ],
},
},
"outputConfig": { # The desired output location and metadata. # Required. The desired output location and metadata (e.g. format).
+ "batchSize": 42, # The max number of response protos to put into each output JSON file on
+ # Google Cloud Storage.
+ # The valid range is [1, 100]. If not specified, the default value is 20.
+ #
+ # For example, for one pdf file with 100 pages, 100 response protos will
+ # be generated. If `batch_size` = 20, then 5 json files each
+ # containing 20 response protos will be written under the prefix
+ # `gcs_destination`.`uri`.
+ #
+ # Currently, batch_size only applies to GcsDestination, with potential future
+ # support for other output configurations.
"gcsDestination": { # The Google Cloud Storage location where the output will be written to. # The Google Cloud Storage location to write the output(s) to.
"uri": "A String", # Google Cloud Storage URI prefix where the results will be stored. Results
# will be in JSON format and preceded by its corresponding input URI prefix.
@@ -1456,44 +1493,7 @@
# Multiple outputs can happen if, for example, the output JSON is too large
# and overflows into multiple sharded files.
},
- "batchSize": 42, # The max number of response protos to put into each output JSON file on
- # Google Cloud Storage.
- # The valid range is [1, 100]. If not specified, the default value is 20.
- #
- # For example, for one pdf file with 100 pages, 100 response protos will
- # be generated. If `batch_size` = 20, then 5 json files each
- # containing 20 response protos will be written under the prefix
- # `gcs_destination`.`uri`.
- #
- # Currently, batch_size only applies to GcsDestination, with potential future
- # support for other output configurations.
},
- "inputConfig": { # The desired input location and metadata. # Required. Information about the input file.
- "gcsSource": { # The Google Cloud Storage location where the input will be read from. # The Google Cloud Storage location to read the input from.
- "uri": "A String", # Google Cloud Storage URI for the input file. This must only be a
- # Google Cloud Storage object. Wildcards are not currently supported.
- },
- "mimeType": "A String", # The type of the file. Currently only "application/pdf", "image/tiff" and
- # "image/gif" are supported. Wildcards are not supported.
- "content": "A String", # File content, represented as a stream of bytes.
- # Note: As with all `bytes` fields, protobuffers use a pure binary
- # representation, whereas JSON representations use base64.
- #
- # Currently, this field only works for BatchAnnotateFiles requests. It does
- # not work for AsyncBatchAnnotateFiles requests.
- },
- "features": [ # Required. Requested features.
- { # The type of Google Cloud Vision API detection to perform, and the maximum
- # number of results to return for that type. Multiple `Feature` objects can
- # be specified in the `features` list.
- "model": "A String", # Model to use for the feature.
- # Supported values: "builtin/stable" (the default if unset) and
- # "builtin/latest".
- "type": "A String", # The feature type.
- "maxResults": 42, # Maximum number of results of this type. Does not apply to
- # `TEXT_DETECTION`, `DOCUMENT_TEXT_DETECTION`, or `CROP_HINTS`.
- },
- ],
},
],
"parent": "A String", # Optional. Target project and location to make a call.
@@ -1543,16 +1543,16 @@
#
# You can find out more about this error model and how to work with it in the
# [API Design Guide](https://cloud.google.com/apis/design/errors).
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "message": "A String", # A developer-facing error message, which should be in English. Any
+ # user-facing error message should be localized and sent in the
+ # google.rpc.Status.details field, or localized by the client.
"details": [ # A list of messages that carry the error details. There is a common set of
# message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "message": "A String", # A developer-facing error message, which should be in English. Any
- # user-facing error message should be localized and sent in the
- # google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically
# contains progress information and common metadata such as create time.