docs: update docs/dyn (#1096)
This PR was generated using Autosynth. :rainbow:
Synth log will be available here:
https://source.cloud.google.com/results/invocations/6f0f288a-a1e8-4b2d-a85f-00b1c6150185/targets
- [ ] To automatically regenerate this PR, check this box.
Source-Link: https://github.com/googleapis/synthtool/commit/39b7149da4026765385403632db3c6f63db96b2c
Source-Link: https://github.com/googleapis/synthtool/commit/9a7d9fbb7045c34c9d3d22c1ff766eeae51f04c9
Source-Link: https://github.com/googleapis/synthtool/commit/dc9903a8c30c3662b6098f0e4a97f221d67268b2
Source-Link: https://github.com/googleapis/synthtool/commit/7fcc405a579d5d53a726ff3da1b7c8c08f0f2d58
Source-Link: https://github.com/googleapis/synthtool/commit/d5fc0bcf9ea9789c5b0e3154a9e3b29e5cea6116
Source-Link: https://github.com/googleapis/synthtool/commit/e89175cf074dccc4babb4eca66ae913696e47a71
Source-Link: https://github.com/googleapis/synthtool/commit/7d652819519dfa24da9e14548232e4aaba71a11c
Source-Link: https://github.com/googleapis/synthtool/commit/7db8a6c5ffb12a6e4c2f799c18f00f7f3d60e279
Source-Link: https://github.com/googleapis/synthtool/commit/1f1148d3c7a7a52f0c98077f976bd9b3c948ee2b
Source-Link: https://github.com/googleapis/synthtool/commit/2c8aecedd55b0480fb4e123b6e07fa5b12953862
Source-Link: https://github.com/googleapis/synthtool/commit/3d3e94c4e02370f307a9a200b0c743c3d8d19f29
Source-Link: https://github.com/googleapis/synthtool/commit/c7824ea48ff6d4d42dfae0849aec8a85acd90bd9
Source-Link: https://github.com/googleapis/synthtool/commit/ba9918cd22874245b55734f57470c719b577e591
Source-Link: https://github.com/googleapis/synthtool/commit/b19b401571e77192f8dd38eab5fb2300a0de9324
Source-Link: https://github.com/googleapis/synthtool/commit/6542bd723403513626f61642fc02ddca528409aa
diff --git a/docs/dyn/datalabeling_v1beta1.projects.datasets.evaluations.exampleComparisons.html b/docs/dyn/datalabeling_v1beta1.projects.datasets.evaluations.exampleComparisons.html
index f78dc34..1948431 100644
--- a/docs/dyn/datalabeling_v1beta1.projects.datasets.evaluations.exampleComparisons.html
+++ b/docs/dyn/datalabeling_v1beta1.projects.datasets.evaluations.exampleComparisons.html
@@ -112,78 +112,53 @@
An object of the form:
{ # Results of searching example comparisons.
- "nextPageToken": "A String", # A token to retrieve next page of results.
"exampleComparisons": [ # A list of example comparisons matching the search criteria.
{ # Example comparisons comparing ground truth output and predictions for a specific input.
"groundTruthExample": { # An Example is a piece of data and its annotation. For example, an image with label "house". # The ground truth output for the input.
- "imagePayload": { # Container of information about an image. # The image payload, a container of the image bytes/uri.
- "mimeType": "A String", # Image format.
- "imageThumbnail": "A String", # A byte string of a thumbnail image.
- "signedUri": "A String", # Signed uri of the image file in the service bucket.
- "imageUri": "A String", # Image uri from the user bucket.
- },
"annotations": [ # Output only. Annotations for the piece of data in Example. One piece of data can have multiple annotations.
{ # Annotation for Example. Each example may have one or more annotations. For example in image classification problem, each image might have one or more labels. We call labels binded with this image an Annotation.
- "annotationSource": "A String", # Output only. The source of the annotation.
+ "name": "A String", # Output only. Unique name of this annotation, format is: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset}/examples/{example_id}/annotations/{annotation_id}
"annotationMetadata": { # Additional information associated with the annotation. # Output only. Annotation metadata, including information like votes for labels.
"operatorMetadata": { # General information useful for labels coming from contributors. # Metadata related to human labeling.
- "totalVotes": 42, # The total number of contributors that answer this question.
"comments": [ # Comments from contributors.
"A String",
],
- "score": 3.14, # Confidence score corresponding to a label. For examle, if 3 contributors have answered the question and 2 of them agree on the final label, the confidence score will be 0.67 (2/3).
"labelVotes": 42, # The total number of contributors that choose this label.
+ "score": 3.14, # Confidence score corresponding to a label. For examle, if 3 contributors have answered the question and 2 of them agree on the final label, the confidence score will be 0.67 (2/3).
+ "totalVotes": 42, # The total number of contributors that answer this question.
},
},
- "name": "A String", # Output only. Unique name of this annotation, format is: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset}/examples/{example_id}/annotations/{annotation_id}
"annotationSentiment": "A String", # Output only. Sentiment for this annotation.
+ "annotationSource": "A String", # Output only. The source of the annotation.
"annotationValue": { # Annotation value for an example. # Output only. This is the actual annotation value, e.g classification, bounding box values are stored here.
- "videoClassificationAnnotation": { # Video classification annotation. # Annotation value for video classification case.
- "annotationSpec": { # Container of information related to one possible annotation that can be used in a labeling task. For example, an image classification task where images are labeled as `dog` or `cat` must reference an AnnotationSpec for `dog` and an AnnotationSpec for `cat`. # Label of the segment specified by time_segment.
- "displayName": "A String", # Required. The display name of the AnnotationSpec. Maximum of 64 characters.
- "description": "A String", # Optional. User-provided description of the annotation specification. The description can be up to 10,000 characters long.
- "index": 42, # Output only. This is the integer index of the AnnotationSpec. The index for the whole AnnotationSpecSet is sequential starting from 0. For example, an AnnotationSpecSet with classes `dog` and `cat`, might contain one AnnotationSpec with `{ display_name: "dog", index: 0 }` and one AnnotationSpec with `{ display_name: "cat", index: 1 }`. This is especially useful for model training as it encodes the string labels into numeric values.
- },
- "timeSegment": { # A time period inside of an example that has a time dimension (e.g. video). # The time segment of the video to which the annotation applies.
- "startTimeOffset": "A String", # Start of the time segment (inclusive), represented as the duration since the example start.
- "endTimeOffset": "A String", # End of the time segment (exclusive), represented as the duration since the example start.
- },
- },
"imageClassificationAnnotation": { # Image classification annotation definition. # Annotation value for image classification case.
"annotationSpec": { # Container of information related to one possible annotation that can be used in a labeling task. For example, an image classification task where images are labeled as `dog` or `cat` must reference an AnnotationSpec for `dog` and an AnnotationSpec for `cat`. # Label of image.
- "displayName": "A String", # Required. The display name of the AnnotationSpec. Maximum of 64 characters.
"description": "A String", # Optional. User-provided description of the annotation specification. The description can be up to 10,000 characters long.
+ "displayName": "A String", # Required. The display name of the AnnotationSpec. Maximum of 64 characters.
"index": 42, # Output only. This is the integer index of the AnnotationSpec. The index for the whole AnnotationSpecSet is sequential starting from 0. For example, an AnnotationSpecSet with classes `dog` and `cat`, might contain one AnnotationSpec with `{ display_name: "dog", index: 0 }` and one AnnotationSpec with `{ display_name: "cat", index: 1 }`. This is especially useful for model training as it encodes the string labels into numeric values.
},
},
"imageSegmentationAnnotation": { # Image segmentation annotation. # Annotation value for image segmentation.
- "mimeType": "A String", # Image format.
"imageBytes": "A String", # A byte string of a full image's color map.
+ "mimeType": "A String", # Image format.
"annotationColors": { # The mapping between rgb color and annotation spec. The key is the rgb color represented in format of rgb(0, 0, 0). The value is the AnnotationSpec.
"a_key": { # Container of information related to one possible annotation that can be used in a labeling task. For example, an image classification task where images are labeled as `dog` or `cat` must reference an AnnotationSpec for `dog` and an AnnotationSpec for `cat`.
- "displayName": "A String", # Required. The display name of the AnnotationSpec. Maximum of 64 characters.
"description": "A String", # Optional. User-provided description of the annotation specification. The description can be up to 10,000 characters long.
+ "displayName": "A String", # Required. The display name of the AnnotationSpec. Maximum of 64 characters.
"index": 42, # Output only. This is the integer index of the AnnotationSpec. The index for the whole AnnotationSpecSet is sequential starting from 0. For example, an AnnotationSpecSet with classes `dog` and `cat`, might contain one AnnotationSpec with `{ display_name: "dog", index: 0 }` and one AnnotationSpec with `{ display_name: "cat", index: 1 }`. This is especially useful for model training as it encodes the string labels into numeric values.
},
},
},
- "videoEventAnnotation": { # Video event annotation. # Annotation value for video event case.
- "timeSegment": { # A time period inside of an example that has a time dimension (e.g. video). # The time segment of the video to which the annotation applies.
- "startTimeOffset": "A String", # Start of the time segment (inclusive), represented as the duration since the example start.
- "endTimeOffset": "A String", # End of the time segment (exclusive), represented as the duration since the example start.
- },
- "annotationSpec": { # Container of information related to one possible annotation that can be used in a labeling task. For example, an image classification task where images are labeled as `dog` or `cat` must reference an AnnotationSpec for `dog` and an AnnotationSpec for `cat`. # Label of the event in this annotation.
- "displayName": "A String", # Required. The display name of the AnnotationSpec. Maximum of 64 characters.
- "description": "A String", # Optional. User-provided description of the annotation specification. The description can be up to 10,000 characters long.
- "index": 42, # Output only. This is the integer index of the AnnotationSpec. The index for the whole AnnotationSpecSet is sequential starting from 0. For example, an AnnotationSpecSet with classes `dog` and `cat`, might contain one AnnotationSpec with `{ display_name: "dog", index: 0 }` and one AnnotationSpec with `{ display_name: "cat", index: 1 }`. This is especially useful for model training as it encodes the string labels into numeric values.
- },
- },
"videoObjectTrackingAnnotation": { # Video object tracking annotation. # Annotation value for video object detection and tracking case.
"annotationSpec": { # Container of information related to one possible annotation that can be used in a labeling task. For example, an image classification task where images are labeled as `dog` or `cat` must reference an AnnotationSpec for `dog` and an AnnotationSpec for `cat`. # Label of the object tracked in this annotation.
- "displayName": "A String", # Required. The display name of the AnnotationSpec. Maximum of 64 characters.
"description": "A String", # Optional. User-provided description of the annotation specification. The description can be up to 10,000 characters long.
+ "displayName": "A String", # Required. The display name of the AnnotationSpec. Maximum of 64 characters.
"index": 42, # Output only. This is the integer index of the AnnotationSpec. The index for the whole AnnotationSpecSet is sequential starting from 0. For example, an AnnotationSpecSet with classes `dog` and `cat`, might contain one AnnotationSpec with `{ display_name: "dog", index: 0 }` and one AnnotationSpec with `{ display_name: "cat", index: 1 }`. This is especially useful for model training as it encodes the string labels into numeric values.
},
+ "timeSegment": { # A time period inside of an example that has a time dimension (e.g. video). # The time segment of the video to which object tracking applies.
+ "endTimeOffset": "A String", # End of the time segment (exclusive), represented as the duration since the example start.
+ "startTimeOffset": "A String", # Start of the time segment (inclusive), represented as the duration since the example start.
+ },
"objectTrackingFrames": [ # The list of frames where this object track appears.
{ # Video frame level annotation for object detection and tracking.
"normalizedBoundingPoly": { # Normalized bounding polygon.
@@ -197,23 +172,64 @@
"boundingPoly": { # A bounding polygon in the image.
"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.
},
],
},
"timeOffset": "A String", # The time offset of this frame relative to the beginning of the video.
},
],
- "timeSegment": { # A time period inside of an example that has a time dimension (e.g. video). # The time segment of the video to which object tracking applies.
- "startTimeOffset": "A String", # Start of the time segment (inclusive), represented as the duration since the example start.
+ },
+ "imagePolylineAnnotation": { # A polyline for the image annotation. # Annotation value for image polyline cases. Polyline here is different from BoundingPoly. It is formed by line segments connected to each other but not closed form(Bounding Poly). The line segments can cross each other.
+ "polyline": { # A line with multiple line segments.
+ "vertices": [ # The polyline 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.
+ },
+ ],
+ },
+ "annotationSpec": { # Container of information related to one possible annotation that can be used in a labeling task. For example, an image classification task where images are labeled as `dog` or `cat` must reference an AnnotationSpec for `dog` and an AnnotationSpec for `cat`. # Label of this polyline.
+ "description": "A String", # Optional. User-provided description of the annotation specification. The description can be up to 10,000 characters long.
+ "displayName": "A String", # Required. The display name of the AnnotationSpec. Maximum of 64 characters.
+ "index": 42, # Output only. This is the integer index of the AnnotationSpec. The index for the whole AnnotationSpecSet is sequential starting from 0. For example, an AnnotationSpecSet with classes `dog` and `cat`, might contain one AnnotationSpec with `{ display_name: "dog", index: 0 }` and one AnnotationSpec with `{ display_name: "cat", index: 1 }`. This is especially useful for model training as it encodes the string labels into numeric values.
+ },
+ "normalizedPolyline": { # Normalized polyline.
+ "normalizedVertices": [ # The normalized polyline 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.
+ },
+ ],
+ },
+ },
+ "textEntityExtractionAnnotation": { # Text entity extraction annotation. # Annotation value for text entity extraction case.
+ "annotationSpec": { # Container of information related to one possible annotation that can be used in a labeling task. For example, an image classification task where images are labeled as `dog` or `cat` must reference an AnnotationSpec for `dog` and an AnnotationSpec for `cat`. # Label of the text entities.
+ "description": "A String", # Optional. User-provided description of the annotation specification. The description can be up to 10,000 characters long.
+ "displayName": "A String", # Required. The display name of the AnnotationSpec. Maximum of 64 characters.
+ "index": 42, # Output only. This is the integer index of the AnnotationSpec. The index for the whole AnnotationSpecSet is sequential starting from 0. For example, an AnnotationSpecSet with classes `dog` and `cat`, might contain one AnnotationSpec with `{ display_name: "dog", index: 0 }` and one AnnotationSpec with `{ display_name: "cat", index: 1 }`. This is especially useful for model training as it encodes the string labels into numeric values.
+ },
+ "sequentialSegment": { # Start and end position in a sequence (e.g. text segment). # Position of the entity.
+ "end": 42, # End position (exclusive).
+ "start": 42, # Start position (inclusive).
+ },
+ },
+ "videoClassificationAnnotation": { # Video classification annotation. # Annotation value for video classification case.
+ "timeSegment": { # A time period inside of an example that has a time dimension (e.g. video). # The time segment of the video to which the annotation applies.
"endTimeOffset": "A String", # End of the time segment (exclusive), represented as the duration since the example start.
+ "startTimeOffset": "A String", # Start of the time segment (inclusive), represented as the duration since the example start.
+ },
+ "annotationSpec": { # Container of information related to one possible annotation that can be used in a labeling task. For example, an image classification task where images are labeled as `dog` or `cat` must reference an AnnotationSpec for `dog` and an AnnotationSpec for `cat`. # Label of the segment specified by time_segment.
+ "description": "A String", # Optional. User-provided description of the annotation specification. The description can be up to 10,000 characters long.
+ "displayName": "A String", # Required. The display name of the AnnotationSpec. Maximum of 64 characters.
+ "index": 42, # Output only. This is the integer index of the AnnotationSpec. The index for the whole AnnotationSpecSet is sequential starting from 0. For example, an AnnotationSpecSet with classes `dog` and `cat`, might contain one AnnotationSpec with `{ display_name: "dog", index: 0 }` and one AnnotationSpec with `{ display_name: "cat", index: 1 }`. This is especially useful for model training as it encodes the string labels into numeric values.
},
},
"textClassificationAnnotation": { # Text classification annotation. # Annotation value for text classification case.
"annotationSpec": { # Container of information related to one possible annotation that can be used in a labeling task. For example, an image classification task where images are labeled as `dog` or `cat` must reference an AnnotationSpec for `dog` and an AnnotationSpec for `cat`. # Label of the text.
- "displayName": "A String", # Required. The display name of the AnnotationSpec. Maximum of 64 characters.
"description": "A String", # Optional. User-provided description of the annotation specification. The description can be up to 10,000 characters long.
+ "displayName": "A String", # Required. The display name of the AnnotationSpec. Maximum of 64 characters.
"index": 42, # Output only. This is the integer index of the AnnotationSpec. The index for the whole AnnotationSpecSet is sequential starting from 0. For example, an AnnotationSpecSet with classes `dog` and `cat`, might contain one AnnotationSpec with `{ display_name: "dog", index: 0 }` and one AnnotationSpec with `{ display_name: "cat", index: 1 }`. This is especially useful for model training as it encodes the string labels into numeric values.
},
},
@@ -227,52 +243,29 @@
],
},
"annotationSpec": { # Container of information related to one possible annotation that can be used in a labeling task. For example, an image classification task where images are labeled as `dog` or `cat` must reference an AnnotationSpec for `dog` and an AnnotationSpec for `cat`. # Label of object in this bounding polygon.
- "displayName": "A String", # Required. The display name of the AnnotationSpec. Maximum of 64 characters.
"description": "A String", # Optional. User-provided description of the annotation specification. The description can be up to 10,000 characters long.
+ "displayName": "A String", # Required. The display name of the AnnotationSpec. Maximum of 64 characters.
"index": 42, # Output only. This is the integer index of the AnnotationSpec. The index for the whole AnnotationSpecSet is sequential starting from 0. For example, an AnnotationSpecSet with classes `dog` and `cat`, might contain one AnnotationSpec with `{ display_name: "dog", index: 0 }` and one AnnotationSpec with `{ display_name: "cat", index: 1 }`. This is especially useful for model training as it encodes the string labels into numeric values.
},
"boundingPoly": { # A bounding polygon in the image.
"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.
},
],
},
},
- "textEntityExtractionAnnotation": { # Text entity extraction annotation. # Annotation value for text entity extraction case.
- "annotationSpec": { # Container of information related to one possible annotation that can be used in a labeling task. For example, an image classification task where images are labeled as `dog` or `cat` must reference an AnnotationSpec for `dog` and an AnnotationSpec for `cat`. # Label of the text entities.
- "displayName": "A String", # Required. The display name of the AnnotationSpec. Maximum of 64 characters.
+ "videoEventAnnotation": { # Video event annotation. # Annotation value for video event case.
+ "timeSegment": { # A time period inside of an example that has a time dimension (e.g. video). # The time segment of the video to which the annotation applies.
+ "endTimeOffset": "A String", # End of the time segment (exclusive), represented as the duration since the example start.
+ "startTimeOffset": "A String", # Start of the time segment (inclusive), represented as the duration since the example start.
+ },
+ "annotationSpec": { # Container of information related to one possible annotation that can be used in a labeling task. For example, an image classification task where images are labeled as `dog` or `cat` must reference an AnnotationSpec for `dog` and an AnnotationSpec for `cat`. # Label of the event in this annotation.
"description": "A String", # Optional. User-provided description of the annotation specification. The description can be up to 10,000 characters long.
- "index": 42, # Output only. This is the integer index of the AnnotationSpec. The index for the whole AnnotationSpecSet is sequential starting from 0. For example, an AnnotationSpecSet with classes `dog` and `cat`, might contain one AnnotationSpec with `{ display_name: "dog", index: 0 }` and one AnnotationSpec with `{ display_name: "cat", index: 1 }`. This is especially useful for model training as it encodes the string labels into numeric values.
- },
- "sequentialSegment": { # Start and end position in a sequence (e.g. text segment). # Position of the entity.
- "end": 42, # End position (exclusive).
- "start": 42, # Start position (inclusive).
- },
- },
- "imagePolylineAnnotation": { # A polyline for the image annotation. # Annotation value for image polyline cases. Polyline here is different from BoundingPoly. It is formed by line segments connected to each other but not closed form(Bounding Poly). The line segments can cross each other.
- "normalizedPolyline": { # Normalized polyline.
- "normalizedVertices": [ # The normalized polyline 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.
- },
- ],
- },
- "annotationSpec": { # Container of information related to one possible annotation that can be used in a labeling task. For example, an image classification task where images are labeled as `dog` or `cat` must reference an AnnotationSpec for `dog` and an AnnotationSpec for `cat`. # Label of this polyline.
"displayName": "A String", # Required. The display name of the AnnotationSpec. Maximum of 64 characters.
- "description": "A String", # Optional. User-provided description of the annotation specification. The description can be up to 10,000 characters long.
"index": 42, # Output only. This is the integer index of the AnnotationSpec. The index for the whole AnnotationSpecSet is sequential starting from 0. For example, an AnnotationSpecSet with classes `dog` and `cat`, might contain one AnnotationSpec with `{ display_name: "dog", index: 0 }` and one AnnotationSpec with `{ display_name: "cat", index: 1 }`. This is especially useful for model training as it encodes the string labels into numeric values.
},
- "polyline": { # A line with multiple line segments.
- "vertices": [ # The polyline 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.
- },
- ],
- },
},
},
},
@@ -280,10 +273,17 @@
"textPayload": { # Container of information about a piece of text. # The text payload, a container of the text content.
"textContent": "A String", # Text content.
},
+ "name": "A String", # Output only. Name of the example, in format of: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}/examples/{example_id}
+ "imagePayload": { # Container of information about an image. # The image payload, a container of the image bytes/uri.
+ "signedUri": "A String", # Signed uri of the image file in the service bucket.
+ "imageThumbnail": "A String", # A byte string of a thumbnail image.
+ "mimeType": "A String", # Image format.
+ "imageUri": "A String", # Image uri from the user bucket.
+ },
"videoPayload": { # Container of information of a video. # The video payload, a container of the video uri.
- "signedUri": "A String", # Signed uri of the video file in the service bucket.
"mimeType": "A String", # Video format.
"videoUri": "A String", # Video uri from the user bucket.
+ "signedUri": "A String", # Signed uri of the video file in the service bucket.
"videoThumbnails": [ # The list of video thumbnails.
{ # Container of information of a video thumbnail.
"timeOffset": "A String", # Time offset relative to the beginning of the video, corresponding to the video frame where the thumbnail has been extracted from.
@@ -292,78 +292,53 @@
],
"frameRate": 3.14, # FPS of the video.
},
- "name": "A String", # Output only. Name of the example, in format of: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}/examples/{example_id}
},
"modelCreatedExamples": [ # Predictions by the model for the input.
{ # An Example is a piece of data and its annotation. For example, an image with label "house".
- "imagePayload": { # Container of information about an image. # The image payload, a container of the image bytes/uri.
- "mimeType": "A String", # Image format.
- "imageThumbnail": "A String", # A byte string of a thumbnail image.
- "signedUri": "A String", # Signed uri of the image file in the service bucket.
- "imageUri": "A String", # Image uri from the user bucket.
- },
"annotations": [ # Output only. Annotations for the piece of data in Example. One piece of data can have multiple annotations.
{ # Annotation for Example. Each example may have one or more annotations. For example in image classification problem, each image might have one or more labels. We call labels binded with this image an Annotation.
- "annotationSource": "A String", # Output only. The source of the annotation.
+ "name": "A String", # Output only. Unique name of this annotation, format is: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset}/examples/{example_id}/annotations/{annotation_id}
"annotationMetadata": { # Additional information associated with the annotation. # Output only. Annotation metadata, including information like votes for labels.
"operatorMetadata": { # General information useful for labels coming from contributors. # Metadata related to human labeling.
- "totalVotes": 42, # The total number of contributors that answer this question.
"comments": [ # Comments from contributors.
"A String",
],
- "score": 3.14, # Confidence score corresponding to a label. For examle, if 3 contributors have answered the question and 2 of them agree on the final label, the confidence score will be 0.67 (2/3).
"labelVotes": 42, # The total number of contributors that choose this label.
+ "score": 3.14, # Confidence score corresponding to a label. For examle, if 3 contributors have answered the question and 2 of them agree on the final label, the confidence score will be 0.67 (2/3).
+ "totalVotes": 42, # The total number of contributors that answer this question.
},
},
- "name": "A String", # Output only. Unique name of this annotation, format is: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset}/examples/{example_id}/annotations/{annotation_id}
"annotationSentiment": "A String", # Output only. Sentiment for this annotation.
+ "annotationSource": "A String", # Output only. The source of the annotation.
"annotationValue": { # Annotation value for an example. # Output only. This is the actual annotation value, e.g classification, bounding box values are stored here.
- "videoClassificationAnnotation": { # Video classification annotation. # Annotation value for video classification case.
- "annotationSpec": { # Container of information related to one possible annotation that can be used in a labeling task. For example, an image classification task where images are labeled as `dog` or `cat` must reference an AnnotationSpec for `dog` and an AnnotationSpec for `cat`. # Label of the segment specified by time_segment.
- "displayName": "A String", # Required. The display name of the AnnotationSpec. Maximum of 64 characters.
- "description": "A String", # Optional. User-provided description of the annotation specification. The description can be up to 10,000 characters long.
- "index": 42, # Output only. This is the integer index of the AnnotationSpec. The index for the whole AnnotationSpecSet is sequential starting from 0. For example, an AnnotationSpecSet with classes `dog` and `cat`, might contain one AnnotationSpec with `{ display_name: "dog", index: 0 }` and one AnnotationSpec with `{ display_name: "cat", index: 1 }`. This is especially useful for model training as it encodes the string labels into numeric values.
- },
- "timeSegment": { # A time period inside of an example that has a time dimension (e.g. video). # The time segment of the video to which the annotation applies.
- "startTimeOffset": "A String", # Start of the time segment (inclusive), represented as the duration since the example start.
- "endTimeOffset": "A String", # End of the time segment (exclusive), represented as the duration since the example start.
- },
- },
"imageClassificationAnnotation": { # Image classification annotation definition. # Annotation value for image classification case.
"annotationSpec": { # Container of information related to one possible annotation that can be used in a labeling task. For example, an image classification task where images are labeled as `dog` or `cat` must reference an AnnotationSpec for `dog` and an AnnotationSpec for `cat`. # Label of image.
- "displayName": "A String", # Required. The display name of the AnnotationSpec. Maximum of 64 characters.
"description": "A String", # Optional. User-provided description of the annotation specification. The description can be up to 10,000 characters long.
+ "displayName": "A String", # Required. The display name of the AnnotationSpec. Maximum of 64 characters.
"index": 42, # Output only. This is the integer index of the AnnotationSpec. The index for the whole AnnotationSpecSet is sequential starting from 0. For example, an AnnotationSpecSet with classes `dog` and `cat`, might contain one AnnotationSpec with `{ display_name: "dog", index: 0 }` and one AnnotationSpec with `{ display_name: "cat", index: 1 }`. This is especially useful for model training as it encodes the string labels into numeric values.
},
},
"imageSegmentationAnnotation": { # Image segmentation annotation. # Annotation value for image segmentation.
- "mimeType": "A String", # Image format.
"imageBytes": "A String", # A byte string of a full image's color map.
+ "mimeType": "A String", # Image format.
"annotationColors": { # The mapping between rgb color and annotation spec. The key is the rgb color represented in format of rgb(0, 0, 0). The value is the AnnotationSpec.
"a_key": { # Container of information related to one possible annotation that can be used in a labeling task. For example, an image classification task where images are labeled as `dog` or `cat` must reference an AnnotationSpec for `dog` and an AnnotationSpec for `cat`.
- "displayName": "A String", # Required. The display name of the AnnotationSpec. Maximum of 64 characters.
"description": "A String", # Optional. User-provided description of the annotation specification. The description can be up to 10,000 characters long.
+ "displayName": "A String", # Required. The display name of the AnnotationSpec. Maximum of 64 characters.
"index": 42, # Output only. This is the integer index of the AnnotationSpec. The index for the whole AnnotationSpecSet is sequential starting from 0. For example, an AnnotationSpecSet with classes `dog` and `cat`, might contain one AnnotationSpec with `{ display_name: "dog", index: 0 }` and one AnnotationSpec with `{ display_name: "cat", index: 1 }`. This is especially useful for model training as it encodes the string labels into numeric values.
},
},
},
- "videoEventAnnotation": { # Video event annotation. # Annotation value for video event case.
- "timeSegment": { # A time period inside of an example that has a time dimension (e.g. video). # The time segment of the video to which the annotation applies.
- "startTimeOffset": "A String", # Start of the time segment (inclusive), represented as the duration since the example start.
- "endTimeOffset": "A String", # End of the time segment (exclusive), represented as the duration since the example start.
- },
- "annotationSpec": { # Container of information related to one possible annotation that can be used in a labeling task. For example, an image classification task where images are labeled as `dog` or `cat` must reference an AnnotationSpec for `dog` and an AnnotationSpec for `cat`. # Label of the event in this annotation.
- "displayName": "A String", # Required. The display name of the AnnotationSpec. Maximum of 64 characters.
- "description": "A String", # Optional. User-provided description of the annotation specification. The description can be up to 10,000 characters long.
- "index": 42, # Output only. This is the integer index of the AnnotationSpec. The index for the whole AnnotationSpecSet is sequential starting from 0. For example, an AnnotationSpecSet with classes `dog` and `cat`, might contain one AnnotationSpec with `{ display_name: "dog", index: 0 }` and one AnnotationSpec with `{ display_name: "cat", index: 1 }`. This is especially useful for model training as it encodes the string labels into numeric values.
- },
- },
"videoObjectTrackingAnnotation": { # Video object tracking annotation. # Annotation value for video object detection and tracking case.
"annotationSpec": { # Container of information related to one possible annotation that can be used in a labeling task. For example, an image classification task where images are labeled as `dog` or `cat` must reference an AnnotationSpec for `dog` and an AnnotationSpec for `cat`. # Label of the object tracked in this annotation.
- "displayName": "A String", # Required. The display name of the AnnotationSpec. Maximum of 64 characters.
"description": "A String", # Optional. User-provided description of the annotation specification. The description can be up to 10,000 characters long.
+ "displayName": "A String", # Required. The display name of the AnnotationSpec. Maximum of 64 characters.
"index": 42, # Output only. This is the integer index of the AnnotationSpec. The index for the whole AnnotationSpecSet is sequential starting from 0. For example, an AnnotationSpecSet with classes `dog` and `cat`, might contain one AnnotationSpec with `{ display_name: "dog", index: 0 }` and one AnnotationSpec with `{ display_name: "cat", index: 1 }`. This is especially useful for model training as it encodes the string labels into numeric values.
},
+ "timeSegment": { # A time period inside of an example that has a time dimension (e.g. video). # The time segment of the video to which object tracking applies.
+ "endTimeOffset": "A String", # End of the time segment (exclusive), represented as the duration since the example start.
+ "startTimeOffset": "A String", # Start of the time segment (inclusive), represented as the duration since the example start.
+ },
"objectTrackingFrames": [ # The list of frames where this object track appears.
{ # Video frame level annotation for object detection and tracking.
"normalizedBoundingPoly": { # Normalized bounding polygon.
@@ -377,23 +352,64 @@
"boundingPoly": { # A bounding polygon in the image.
"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.
},
],
},
"timeOffset": "A String", # The time offset of this frame relative to the beginning of the video.
},
],
- "timeSegment": { # A time period inside of an example that has a time dimension (e.g. video). # The time segment of the video to which object tracking applies.
- "startTimeOffset": "A String", # Start of the time segment (inclusive), represented as the duration since the example start.
+ },
+ "imagePolylineAnnotation": { # A polyline for the image annotation. # Annotation value for image polyline cases. Polyline here is different from BoundingPoly. It is formed by line segments connected to each other but not closed form(Bounding Poly). The line segments can cross each other.
+ "polyline": { # A line with multiple line segments.
+ "vertices": [ # The polyline 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.
+ },
+ ],
+ },
+ "annotationSpec": { # Container of information related to one possible annotation that can be used in a labeling task. For example, an image classification task where images are labeled as `dog` or `cat` must reference an AnnotationSpec for `dog` and an AnnotationSpec for `cat`. # Label of this polyline.
+ "description": "A String", # Optional. User-provided description of the annotation specification. The description can be up to 10,000 characters long.
+ "displayName": "A String", # Required. The display name of the AnnotationSpec. Maximum of 64 characters.
+ "index": 42, # Output only. This is the integer index of the AnnotationSpec. The index for the whole AnnotationSpecSet is sequential starting from 0. For example, an AnnotationSpecSet with classes `dog` and `cat`, might contain one AnnotationSpec with `{ display_name: "dog", index: 0 }` and one AnnotationSpec with `{ display_name: "cat", index: 1 }`. This is especially useful for model training as it encodes the string labels into numeric values.
+ },
+ "normalizedPolyline": { # Normalized polyline.
+ "normalizedVertices": [ # The normalized polyline 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.
+ },
+ ],
+ },
+ },
+ "textEntityExtractionAnnotation": { # Text entity extraction annotation. # Annotation value for text entity extraction case.
+ "annotationSpec": { # Container of information related to one possible annotation that can be used in a labeling task. For example, an image classification task where images are labeled as `dog` or `cat` must reference an AnnotationSpec for `dog` and an AnnotationSpec for `cat`. # Label of the text entities.
+ "description": "A String", # Optional. User-provided description of the annotation specification. The description can be up to 10,000 characters long.
+ "displayName": "A String", # Required. The display name of the AnnotationSpec. Maximum of 64 characters.
+ "index": 42, # Output only. This is the integer index of the AnnotationSpec. The index for the whole AnnotationSpecSet is sequential starting from 0. For example, an AnnotationSpecSet with classes `dog` and `cat`, might contain one AnnotationSpec with `{ display_name: "dog", index: 0 }` and one AnnotationSpec with `{ display_name: "cat", index: 1 }`. This is especially useful for model training as it encodes the string labels into numeric values.
+ },
+ "sequentialSegment": { # Start and end position in a sequence (e.g. text segment). # Position of the entity.
+ "end": 42, # End position (exclusive).
+ "start": 42, # Start position (inclusive).
+ },
+ },
+ "videoClassificationAnnotation": { # Video classification annotation. # Annotation value for video classification case.
+ "timeSegment": { # A time period inside of an example that has a time dimension (e.g. video). # The time segment of the video to which the annotation applies.
"endTimeOffset": "A String", # End of the time segment (exclusive), represented as the duration since the example start.
+ "startTimeOffset": "A String", # Start of the time segment (inclusive), represented as the duration since the example start.
+ },
+ "annotationSpec": { # Container of information related to one possible annotation that can be used in a labeling task. For example, an image classification task where images are labeled as `dog` or `cat` must reference an AnnotationSpec for `dog` and an AnnotationSpec for `cat`. # Label of the segment specified by time_segment.
+ "description": "A String", # Optional. User-provided description of the annotation specification. The description can be up to 10,000 characters long.
+ "displayName": "A String", # Required. The display name of the AnnotationSpec. Maximum of 64 characters.
+ "index": 42, # Output only. This is the integer index of the AnnotationSpec. The index for the whole AnnotationSpecSet is sequential starting from 0. For example, an AnnotationSpecSet with classes `dog` and `cat`, might contain one AnnotationSpec with `{ display_name: "dog", index: 0 }` and one AnnotationSpec with `{ display_name: "cat", index: 1 }`. This is especially useful for model training as it encodes the string labels into numeric values.
},
},
"textClassificationAnnotation": { # Text classification annotation. # Annotation value for text classification case.
"annotationSpec": { # Container of information related to one possible annotation that can be used in a labeling task. For example, an image classification task where images are labeled as `dog` or `cat` must reference an AnnotationSpec for `dog` and an AnnotationSpec for `cat`. # Label of the text.
- "displayName": "A String", # Required. The display name of the AnnotationSpec. Maximum of 64 characters.
"description": "A String", # Optional. User-provided description of the annotation specification. The description can be up to 10,000 characters long.
+ "displayName": "A String", # Required. The display name of the AnnotationSpec. Maximum of 64 characters.
"index": 42, # Output only. This is the integer index of the AnnotationSpec. The index for the whole AnnotationSpecSet is sequential starting from 0. For example, an AnnotationSpecSet with classes `dog` and `cat`, might contain one AnnotationSpec with `{ display_name: "dog", index: 0 }` and one AnnotationSpec with `{ display_name: "cat", index: 1 }`. This is especially useful for model training as it encodes the string labels into numeric values.
},
},
@@ -407,52 +423,29 @@
],
},
"annotationSpec": { # Container of information related to one possible annotation that can be used in a labeling task. For example, an image classification task where images are labeled as `dog` or `cat` must reference an AnnotationSpec for `dog` and an AnnotationSpec for `cat`. # Label of object in this bounding polygon.
- "displayName": "A String", # Required. The display name of the AnnotationSpec. Maximum of 64 characters.
"description": "A String", # Optional. User-provided description of the annotation specification. The description can be up to 10,000 characters long.
+ "displayName": "A String", # Required. The display name of the AnnotationSpec. Maximum of 64 characters.
"index": 42, # Output only. This is the integer index of the AnnotationSpec. The index for the whole AnnotationSpecSet is sequential starting from 0. For example, an AnnotationSpecSet with classes `dog` and `cat`, might contain one AnnotationSpec with `{ display_name: "dog", index: 0 }` and one AnnotationSpec with `{ display_name: "cat", index: 1 }`. This is especially useful for model training as it encodes the string labels into numeric values.
},
"boundingPoly": { # A bounding polygon in the image.
"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.
},
],
},
},
- "textEntityExtractionAnnotation": { # Text entity extraction annotation. # Annotation value for text entity extraction case.
- "annotationSpec": { # Container of information related to one possible annotation that can be used in a labeling task. For example, an image classification task where images are labeled as `dog` or `cat` must reference an AnnotationSpec for `dog` and an AnnotationSpec for `cat`. # Label of the text entities.
- "displayName": "A String", # Required. The display name of the AnnotationSpec. Maximum of 64 characters.
+ "videoEventAnnotation": { # Video event annotation. # Annotation value for video event case.
+ "timeSegment": { # A time period inside of an example that has a time dimension (e.g. video). # The time segment of the video to which the annotation applies.
+ "endTimeOffset": "A String", # End of the time segment (exclusive), represented as the duration since the example start.
+ "startTimeOffset": "A String", # Start of the time segment (inclusive), represented as the duration since the example start.
+ },
+ "annotationSpec": { # Container of information related to one possible annotation that can be used in a labeling task. For example, an image classification task where images are labeled as `dog` or `cat` must reference an AnnotationSpec for `dog` and an AnnotationSpec for `cat`. # Label of the event in this annotation.
"description": "A String", # Optional. User-provided description of the annotation specification. The description can be up to 10,000 characters long.
- "index": 42, # Output only. This is the integer index of the AnnotationSpec. The index for the whole AnnotationSpecSet is sequential starting from 0. For example, an AnnotationSpecSet with classes `dog` and `cat`, might contain one AnnotationSpec with `{ display_name: "dog", index: 0 }` and one AnnotationSpec with `{ display_name: "cat", index: 1 }`. This is especially useful for model training as it encodes the string labels into numeric values.
- },
- "sequentialSegment": { # Start and end position in a sequence (e.g. text segment). # Position of the entity.
- "end": 42, # End position (exclusive).
- "start": 42, # Start position (inclusive).
- },
- },
- "imagePolylineAnnotation": { # A polyline for the image annotation. # Annotation value for image polyline cases. Polyline here is different from BoundingPoly. It is formed by line segments connected to each other but not closed form(Bounding Poly). The line segments can cross each other.
- "normalizedPolyline": { # Normalized polyline.
- "normalizedVertices": [ # The normalized polyline 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.
- },
- ],
- },
- "annotationSpec": { # Container of information related to one possible annotation that can be used in a labeling task. For example, an image classification task where images are labeled as `dog` or `cat` must reference an AnnotationSpec for `dog` and an AnnotationSpec for `cat`. # Label of this polyline.
"displayName": "A String", # Required. The display name of the AnnotationSpec. Maximum of 64 characters.
- "description": "A String", # Optional. User-provided description of the annotation specification. The description can be up to 10,000 characters long.
"index": 42, # Output only. This is the integer index of the AnnotationSpec. The index for the whole AnnotationSpecSet is sequential starting from 0. For example, an AnnotationSpecSet with classes `dog` and `cat`, might contain one AnnotationSpec with `{ display_name: "dog", index: 0 }` and one AnnotationSpec with `{ display_name: "cat", index: 1 }`. This is especially useful for model training as it encodes the string labels into numeric values.
},
- "polyline": { # A line with multiple line segments.
- "vertices": [ # The polyline 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.
- },
- ],
- },
},
},
},
@@ -460,10 +453,17 @@
"textPayload": { # Container of information about a piece of text. # The text payload, a container of the text content.
"textContent": "A String", # Text content.
},
+ "name": "A String", # Output only. Name of the example, in format of: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}/examples/{example_id}
+ "imagePayload": { # Container of information about an image. # The image payload, a container of the image bytes/uri.
+ "signedUri": "A String", # Signed uri of the image file in the service bucket.
+ "imageThumbnail": "A String", # A byte string of a thumbnail image.
+ "mimeType": "A String", # Image format.
+ "imageUri": "A String", # Image uri from the user bucket.
+ },
"videoPayload": { # Container of information of a video. # The video payload, a container of the video uri.
- "signedUri": "A String", # Signed uri of the video file in the service bucket.
"mimeType": "A String", # Video format.
"videoUri": "A String", # Video uri from the user bucket.
+ "signedUri": "A String", # Signed uri of the video file in the service bucket.
"videoThumbnails": [ # The list of video thumbnails.
{ # Container of information of a video thumbnail.
"timeOffset": "A String", # Time offset relative to the beginning of the video, corresponding to the video frame where the thumbnail has been extracted from.
@@ -472,11 +472,11 @@
],
"frameRate": 3.14, # FPS of the video.
},
- "name": "A String", # Output only. Name of the example, in format of: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}/examples/{example_id}
},
],
},
],
+ "nextPageToken": "A String", # A token to retrieve next page of results.
}</pre>
</div>