Fix method doc signatures for multiline required parameters (#374)
* Fix method doc signatures for multiline required parameters.
Existing doc generator failed to recognize parameters as required when parameter descriptions
extended over more than one line. Besides presenting incorrect information, resulting
inconsistencies broke checks for automated sample generation.
* Regen docs
diff --git a/docs/dyn/vision_v1.images.html b/docs/dyn/vision_v1.images.html
index 9471feb..9fe90a4 100644
--- a/docs/dyn/vision_v1.images.html
+++ b/docs/dyn/vision_v1.images.html
@@ -256,11 +256,11 @@
"safeSearchAnnotation": { # Set of features pertaining to the image, computed by computer vision # If present, safe-search annotation has completed successfully.
# methods over safe-search verticals (for example, adult, spoof, medical,
# violence).
- "medical": "A String", # Likelihood that this is a medical image.
- "violence": "A String", # Violence likelihood.
"spoof": "A String", # Spoof likelihood. The likelihood that an modification
# was made to the image's canonical version to make it appear
# funny or offensive.
+ "violence": "A String", # Violence likelihood.
+ "medical": "A String", # Likelihood that this is a medical image.
"adult": "A String", # Represents the adult content likelihood for the image.
},
"textAnnotations": [ # If present, text (OCR) detection has completed successfully.
@@ -397,202 +397,68 @@
},
],
},
- "fullTextAnnotation": { # TextAnnotation contains a structured representation of OCR extracted text. # If present, text (OCR) detection or document (OCR) text detection has
- # completed successfully.
- # This annotation provides the structural hierarchy for the OCR detected
- # text.
- # The hierarchy of an OCR extracted text structure is like this:
- # TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol
- # Each structural component, starting from Page, may further have their own
- # properties. Properties describe detected languages, breaks etc.. Please
- # refer to the google.cloud.vision.v1.TextAnnotation.TextProperty message
- # definition below for more detail.
- "text": "A String", # UTF-8 text detected on the pages.
- "pages": [ # List of pages detected by OCR.
- { # Detected page from OCR.
- "width": 42, # Page width in pixels.
- "property": { # Additional information detected on the structural component. # Additional information detected on the page.
- "detectedBreak": { # Detected start or end of a structural component. # Detected start or end of a text segment.
- "isPrefix": True or False, # True if break prepends the element.
- "type": "A String", # Detected break type.
- },
- "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].
- },
- ],
- },
- "blocks": [ # List of blocks of text, images etc on this page.
- { # Logical element on the page.
- "boundingBox": { # A bounding polygon for the detected image annotation. # The bounding box for the block.
- # 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
- # is represented as around the top-left corner as defined when the text is
- # read in the 'natural' orientation.
- # For example:
- # * 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 vertice order will still be (0, 1, 2, 3).
- "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.
- },
- ],
- },
- "blockType": "A String", # Detected block type (text, image etc) for this block.
- "property": { # Additional information detected on the structural component. # Additional information detected for the block.
- "detectedBreak": { # Detected start or end of a structural component. # Detected start or end of a text segment.
- "isPrefix": True or False, # True if break prepends the element.
- "type": "A String", # Detected break type.
- },
- "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].
- },
- ],
- },
- "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.
- "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,
- # bottom-left. When a rotation of the bounding box is detected the rotation
- # is represented as around the top-left corner as defined when the text is
- # read in the 'natural' orientation.
- # For example:
- # * 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 vertice order will still be (0, 1, 2, 3).
- "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.
- },
- ],
- },
- "property": { # Additional information detected on the structural component. # Additional information detected for the paragraph.
- "detectedBreak": { # Detected start or end of a structural component. # Detected start or end of a text segment.
- "isPrefix": True or False, # True if break prepends the element.
- "type": "A String", # Detected break type.
- },
- "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].
- },
- ],
- },
- "words": [ # List of words in this paragraph.
- { # A word representation.
- "boundingBox": { # A bounding polygon for the detected image annotation. # The bounding box for the word.
- # 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
- # is represented as around the top-left corner as defined when the text is
- # read in the 'natural' orientation.
- # For example:
- # * 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 vertice order will still be (0, 1, 2, 3).
- "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.
- },
- ],
- },
- "symbols": [ # List of symbols in the word.
- # The order of the symbols follows the natural reading order.
- { # A single symbol representation.
- "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
- # is represented as around the top-left corner as defined when the text is
- # read in the 'natural' orientation.
- # For example:
- # * 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 vertice order will still be (0, 1, 2, 3).
- "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.
- },
- ],
- },
- "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.
- "detectedBreak": { # Detected start or end of a structural component. # Detected start or end of a text segment.
- "isPrefix": True or False, # True if break prepends the element.
- "type": "A String", # Detected break type.
- },
- "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].
- },
- ],
- },
- },
- ],
- "property": { # Additional information detected on the structural component. # Additional information detected for the word.
- "detectedBreak": { # Detected start or end of a structural component. # Detected start or end of a text segment.
- "isPrefix": True or False, # True if break prepends the element.
- "type": "A String", # Detected break type.
- },
- "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].
- },
- ],
- },
- },
- ],
- },
- ],
- },
- ],
- "height": 42, # Page height in pixels.
+ "error": { # The `Status` type defines a logical error model that is suitable for different # If set, represents the error message for the operation.
+ # Note that filled-in image annotations are guaranteed to be
+ # correct, even when `error` is set.
+ # programming environments, including REST APIs and RPC APIs. It is used by
+ # [gRPC](https://github.com/grpc). The error model is designed to be:
+ #
+ # - Simple to use and understand for most users
+ # - Flexible enough to meet unexpected needs
+ #
+ # # Overview
+ #
+ # The `Status` message contains three pieces of data: error code, error message,
+ # and error details. The error code should be an enum value of
+ # google.rpc.Code, but it may accept additional error codes if needed. The
+ # error message should be a developer-facing English message that helps
+ # developers *understand* and *resolve* the error. If a localized user-facing
+ # error message is needed, put the localized message in the error details or
+ # localize it in the client. The optional error details may contain arbitrary
+ # information about the error. There is a predefined set of error detail types
+ # in the package `google.rpc` which can be used for common error conditions.
+ #
+ # # Language mapping
+ #
+ # The `Status` message is the logical representation of the error model, but it
+ # is not necessarily the actual wire format. When the `Status` message is
+ # exposed in different client libraries and different wire protocols, it can be
+ # mapped differently. For example, it will likely be mapped to some exceptions
+ # in Java, but more likely mapped to some error codes in C.
+ #
+ # # Other uses
+ #
+ # The error model and the `Status` message can be used in a variety of
+ # environments, either with or without APIs, to provide a
+ # consistent developer experience across different environments.
+ #
+ # Example uses of this error model include:
+ #
+ # - Partial errors. If a service needs to return partial errors to the client,
+ # it may embed the `Status` in the normal response to indicate the partial
+ # errors.
+ #
+ # - Workflow errors. A typical workflow has multiple steps. Each step may
+ # have a `Status` message for error reporting purpose.
+ #
+ # - Batch operations. If a client uses batch request and batch response, the
+ # `Status` message should be used directly inside batch response, one for
+ # each error sub-response.
+ #
+ # - Asynchronous operations. If an API call embeds asynchronous operation
+ # results in its response, the status of those operations should be
+ # represented directly using the `Status` message.
+ #
+ # - Logging. If some API errors are stored in logs, the message `Status` could
+ # be used directly after any stripping needed for security/privacy reasons.
+ "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.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There will be a
+ # common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
},
@@ -836,9 +702,8 @@
# [-180,180].
"sorrowLikelihood": "A String", # Sorrow likelihood.
"landmarkingConfidence": 3.14, # Face landmarking confidence. Range [0, 1].
+ "underExposedLikelihood": "A String", # Under-exposed likelihood.
"detectionConfidence": 3.14, # Detection confidence. Range [0, 1].
- "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].
"joyLikelihood": "A String", # Joy likelihood.
"landmarks": [ # Detected face landmarks.
{ # A face-specific landmark (for example, a face feature).
@@ -858,7 +723,8 @@
],
"surpriseLikelihood": "A String", # Surprise likelihood.
"blurredLikelihood": "A String", # Blurred likelihood.
- "underExposedLikelihood": "A String", # Under-exposed 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].
"angerLikelihood": "A String", # Anger likelihood.
"boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon around the face. The coordinates of the bounding box
# are in the original image's scale, as returned in `ImageParams`.
@@ -1079,68 +945,202 @@
],
},
],
- "error": { # The `Status` type defines a logical error model that is suitable for different # If set, represents the error message for the operation.
- # Note that filled-in image annotations are guaranteed to be
- # correct, even when `error` is set.
- # programming environments, including REST APIs and RPC APIs. It is used by
- # [gRPC](https://github.com/grpc). The error model is designed to be:
- #
- # - Simple to use and understand for most users
- # - Flexible enough to meet unexpected needs
- #
- # # Overview
- #
- # The `Status` message contains three pieces of data: error code, error message,
- # and error details. The error code should be an enum value of
- # google.rpc.Code, but it may accept additional error codes if needed. The
- # error message should be a developer-facing English message that helps
- # developers *understand* and *resolve* the error. If a localized user-facing
- # error message is needed, put the localized message in the error details or
- # localize it in the client. The optional error details may contain arbitrary
- # information about the error. There is a predefined set of error detail types
- # in the package `google.rpc` which can be used for common error conditions.
- #
- # # Language mapping
- #
- # The `Status` message is the logical representation of the error model, but it
- # is not necessarily the actual wire format. When the `Status` message is
- # exposed in different client libraries and different wire protocols, it can be
- # mapped differently. For example, it will likely be mapped to some exceptions
- # in Java, but more likely mapped to some error codes in C.
- #
- # # Other uses
- #
- # The error model and the `Status` message can be used in a variety of
- # environments, either with or without APIs, to provide a
- # consistent developer experience across different environments.
- #
- # Example uses of this error model include:
- #
- # - Partial errors. If a service needs to return partial errors to the client,
- # it may embed the `Status` in the normal response to indicate the partial
- # errors.
- #
- # - Workflow errors. A typical workflow has multiple steps. Each step may
- # have a `Status` message for error reporting purpose.
- #
- # - Batch operations. If a client uses batch request and batch response, the
- # `Status` message should be used directly inside batch response, one for
- # each error sub-response.
- #
- # - Asynchronous operations. If an API call embeds asynchronous operation
- # results in its response, the status of those operations should be
- # represented directly using the `Status` message.
- #
- # - Logging. If some API errors are stored in logs, the message `Status` could
- # be used directly after any stripping needed for security/privacy reasons.
- "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.
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "details": [ # A list of messages that carry the error details. There will be a
- # common set of message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @type with type URL.
+ "fullTextAnnotation": { # TextAnnotation contains a structured representation of OCR extracted text. # If present, text (OCR) detection or document (OCR) text detection has
+ # completed successfully.
+ # This annotation provides the structural hierarchy for the OCR detected
+ # text.
+ # The hierarchy of an OCR extracted text structure is like this:
+ # TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol
+ # Each structural component, starting from Page, may further have their own
+ # properties. Properties describe detected languages, breaks etc.. Please
+ # refer to the google.cloud.vision.v1.TextAnnotation.TextProperty message
+ # definition below for more detail.
+ "text": "A String", # UTF-8 text detected on the pages.
+ "pages": [ # List of pages detected by OCR.
+ { # Detected page from OCR.
+ "width": 42, # Page width in pixels.
+ "property": { # Additional information detected on the structural component. # Additional information detected on the page.
+ "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].
+ },
+ ],
+ },
+ "blocks": [ # List of blocks of text, images etc on this page.
+ { # Logical element on the page.
+ "boundingBox": { # A bounding polygon for the detected image annotation. # The bounding box for the block.
+ # 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
+ # is represented as around the top-left corner as defined when the text is
+ # read in the 'natural' orientation.
+ # For example:
+ # * 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 vertice order will still be (0, 1, 2, 3).
+ "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.
+ },
+ ],
+ },
+ "blockType": "A String", # Detected block type (text, image etc) for this block.
+ "property": { # Additional information detected on the structural component. # Additional information detected for the block.
+ "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].
+ },
+ ],
+ },
+ "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.
+ "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,
+ # bottom-left. When a rotation of the bounding box is detected the rotation
+ # is represented as around the top-left corner as defined when the text is
+ # read in the 'natural' orientation.
+ # For example:
+ # * 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 vertice order will still be (0, 1, 2, 3).
+ "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.
+ },
+ ],
+ },
+ "property": { # Additional information detected on the structural component. # Additional information detected for the paragraph.
+ "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].
+ },
+ ],
+ },
+ "words": [ # List of words in this paragraph.
+ { # A word representation.
+ "boundingBox": { # A bounding polygon for the detected image annotation. # The bounding box for the word.
+ # 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
+ # is represented as around the top-left corner as defined when the text is
+ # read in the 'natural' orientation.
+ # For example:
+ # * 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 vertice order will still be (0, 1, 2, 3).
+ "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.
+ },
+ ],
+ },
+ "symbols": [ # List of symbols in the word.
+ # The order of the symbols follows the natural reading order.
+ { # A single symbol representation.
+ "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
+ # is represented as around the top-left corner as defined when the text is
+ # read in the 'natural' orientation.
+ # For example:
+ # * 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 vertice order will still be (0, 1, 2, 3).
+ "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.
+ },
+ ],
+ },
+ "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.
+ "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].
+ },
+ ],
+ },
+ },
+ ],
+ "property": { # Additional information detected on the structural component. # Additional information detected for the word.
+ "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].
+ },
+ ],
+ },
+ },
+ ],
+ },
+ ],
+ },
+ ],
+ "height": 42, # Page height in pixels.
},
],
},