chore: update docs/dyn , add static discovery files to discovery_cache/documents (#1111)
This PR was generated using Autosynth. :rainbow:
Synth log will be available here:
https://source.cloud.google.com/results/invocations/78f53313-0c78-4a29-8841-f031665a4c6a/targets
- [ ] To automatically regenerate this PR, check this box.
Source-Link: https://github.com/googleapis/synthtool/commit/c2de32114ec484aa708d32012d1fa8d75232daf5
diff --git a/docs/dyn/datalabeling_v1beta1.projects.datasets.evaluations.exampleComparisons.html b/docs/dyn/datalabeling_v1beta1.projects.datasets.evaluations.exampleComparisons.html
index 9e32795..80265fb 100644
--- a/docs/dyn/datalabeling_v1beta1.projects.datasets.evaluations.exampleComparisons.html
+++ b/docs/dyn/datalabeling_v1beta1.projects.datasets.evaluations.exampleComparisons.html
@@ -99,8 +99,8 @@
The object takes the form of:
{ # Request message of SearchExampleComparisons.
- "pageSize": 42, # Optional. Requested page size. Server may return fewer results than requested. Default value is 100.
"pageToken": "A String", # Optional. A token identifying a page of results for the server to return. Typically obtained by the nextPageToken of the response to a previous search rquest. If you don't specify this field, the API call requests the first page of the search.
+ "pageSize": 42, # Optional. Requested page size. Server may return fewer results than requested. Default value is 100.
}
x__xgafv: string, V1 error format.
@@ -116,59 +116,48 @@
{ # Example comparisons comparing ground truth output and predictions for a specific input.
"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".
+ "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}
+ "textPayload": { # Container of information about a piece of text. # The text payload, a container of the text content.
+ "textContent": "A String", # Text content.
+ },
+ "imagePayload": { # Container of information about an image. # The image payload, a container of the image bytes/uri.
+ "imageThumbnail": "A String", # A byte string of a thumbnail image.
+ "mimeType": "A String", # Image format.
+ "imageUri": "A String", # Image uri from the user bucket.
+ "signedUri": "A String", # Signed uri of the image file in the service 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.
+ "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.
+ "comments": [ # Comments from contributors.
+ "A String",
+ ],
+ "totalVotes": 42, # The total number of contributors that answer this question.
+ "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.
+ },
+ },
"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}
"annotationSource": "A String", # Output only. The source of the annotation.
"annotationSentiment": "A String", # Output only. Sentiment for this 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.
- "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.
+ "videoEventAnnotation": { # Video event annotation. # Annotation value for video event 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 event in this annotation.
"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.
+ "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.
},
"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.
},
},
- "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.
- "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.
- },
- "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.
- },
- ],
- },
- "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.
- "x": 3.14, # X coordinate.
- "y": 3.14, # Y coordinate.
- },
- ],
- },
- },
"imageBoundingPolyAnnotation": { # Image bounding poly annotation. It represents a polygon including bounding box in the image. # Annotation value for image bounding box, oriented bounding box and polygon cases.
- "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.
- },
- ],
- },
"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.
- "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.
+ "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.
},
"normalizedBoundingPoly": { # Normalized bounding polygon.
"normalizedVertices": [ # The bounding polygon normalized vertices.
@@ -178,50 +167,26 @@
},
],
},
+ "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.
+ },
+ ],
+ },
},
- "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.
- "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.
+ "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.
"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.
- "imageBytes": "A String", # A byte string of a full image's color map.
- "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`.
- "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.
- },
- },
- "mimeType": "A String", # Image format.
- },
- "textEntityExtractionAnnotation": { # Text entity extraction annotation. # Annotation value for text entity extraction case.
- "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).
- },
- "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.
- },
- },
- "videoEventAnnotation": { # Video event annotation. # Annotation value for video event 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 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.
- "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 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.
},
},
"videoObjectTrackingAnnotation": { # Video object tracking annotation. # Annotation value for video object detection and tracking case.
"objectTrackingFrames": [ # The list of frames where this object track appears.
{ # Video frame level annotation for object detection and tracking.
+ "timeOffset": "A String", # The time offset of this frame relative to the beginning of the video.
"normalizedBoundingPoly": { # Normalized bounding polygon.
"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.
@@ -230,7 +195,6 @@
},
],
},
- "timeOffset": "A String", # The time offset of this frame relative to the beginning of the video.
"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.
@@ -246,38 +210,81 @@
"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 object tracked in this annotation.
- "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.
+ "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.
},
},
- "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.
- "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.
+ "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.
"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.
+ "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.
+ },
+ "sequentialSegment": { # Start and end position in a sequence (e.g. text segment). # Position of the entity.
+ "start": 42, # Start position (inclusive).
+ "end": 42, # End position (exclusive).
},
},
- },
- "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.
- "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.
- "comments": [ # Comments from contributors.
- "A String",
- ],
+ "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.
+ "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`.
+ "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.
+ "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.
+ },
+ },
+ },
+ "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.
+ "y": 42, # Y coordinate.
+ "x": 42, # 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.
+ "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.
+ "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.
+ },
+ "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.
+ "x": 3.14, # X coordinate.
+ "y": 3.14, # Y coordinate.
+ },
+ ],
+ },
+ },
+ "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.
+ "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.
+ "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.
+ },
+ },
+ "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.
+ "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.
+ "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.
+ },
},
},
},
],
- "textPayload": { # Container of information about a piece of text. # The text payload, a container of the text content.
- "textContent": "A String", # Text content.
- },
"videoPayload": { # Container of information of a video. # The video payload, a container of the video uri.
- "videoUri": "A String", # Video uri from the user bucket.
- "signedUri": "A String", # Signed uri of the video file in the service bucket.
"mimeType": "A String", # Video format.
+ "signedUri": "A String", # Signed uri of the video file in the service bucket.
+ "videoUri": "A String", # Video uri from the user bucket.
"videoThumbnails": [ # The list of video thumbnails.
{ # Container of information of a video thumbnail.
"thumbnail": "A String", # A byte string of the video frame.
@@ -286,69 +293,51 @@
],
"frameRate": 3.14, # FPS of the video.
},
- "imagePayload": { # Container of information about an image. # The image payload, a container of the image bytes/uri.
- "mimeType": "A String", # Image format.
- "imageUri": "A String", # Image uri from the user bucket.
- "imageThumbnail": "A String", # A byte string of a thumbnail image.
- "signedUri": "A String", # Signed uri of the image file in the service bucket.
- },
- "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}
},
],
"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.
+ "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}
+ "textPayload": { # Container of information about a piece of text. # The text payload, a container of the text content.
+ "textContent": "A String", # Text content.
+ },
+ "imagePayload": { # Container of information about an image. # The image payload, a container of the image bytes/uri.
+ "imageThumbnail": "A String", # A byte string of a thumbnail image.
+ "mimeType": "A String", # Image format.
+ "imageUri": "A String", # Image uri from the user bucket.
+ "signedUri": "A String", # Signed uri of the image file in the service 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.
+ "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.
+ "comments": [ # Comments from contributors.
+ "A String",
+ ],
+ "totalVotes": 42, # The total number of contributors that answer this question.
+ "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.
+ },
+ },
"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}
"annotationSource": "A String", # Output only. The source of the annotation.
"annotationSentiment": "A String", # Output only. Sentiment for this 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.
- "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.
+ "videoEventAnnotation": { # Video event annotation. # Annotation value for video event 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 event in this annotation.
"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.
+ "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.
},
"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.
},
},
- "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.
- "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.
- },
- "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.
- },
- ],
- },
- "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.
- "x": 3.14, # X coordinate.
- "y": 3.14, # Y coordinate.
- },
- ],
- },
- },
"imageBoundingPolyAnnotation": { # Image bounding poly annotation. It represents a polygon including bounding box in the image. # Annotation value for image bounding box, oriented bounding box and polygon cases.
- "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.
- },
- ],
- },
"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.
- "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.
+ "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.
},
"normalizedBoundingPoly": { # Normalized bounding polygon.
"normalizedVertices": [ # The bounding polygon normalized vertices.
@@ -358,50 +347,26 @@
},
],
},
+ "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.
+ },
+ ],
+ },
},
- "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.
- "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.
+ "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.
"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.
- "imageBytes": "A String", # A byte string of a full image's color map.
- "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`.
- "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.
- },
- },
- "mimeType": "A String", # Image format.
- },
- "textEntityExtractionAnnotation": { # Text entity extraction annotation. # Annotation value for text entity extraction case.
- "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).
- },
- "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.
- },
- },
- "videoEventAnnotation": { # Video event annotation. # Annotation value for video event 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 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.
- "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 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.
},
},
"videoObjectTrackingAnnotation": { # Video object tracking annotation. # Annotation value for video object detection and tracking case.
"objectTrackingFrames": [ # The list of frames where this object track appears.
{ # Video frame level annotation for object detection and tracking.
+ "timeOffset": "A String", # The time offset of this frame relative to the beginning of the video.
"normalizedBoundingPoly": { # Normalized bounding polygon.
"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.
@@ -410,7 +375,6 @@
},
],
},
- "timeOffset": "A String", # The time offset of this frame relative to the beginning of the video.
"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.
@@ -426,38 +390,81 @@
"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 object tracked in this annotation.
- "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.
+ "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.
},
},
- "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.
- "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.
+ "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.
"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.
+ "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.
+ },
+ "sequentialSegment": { # Start and end position in a sequence (e.g. text segment). # Position of the entity.
+ "start": 42, # Start position (inclusive).
+ "end": 42, # End position (exclusive).
},
},
- },
- "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.
- "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.
- "comments": [ # Comments from contributors.
- "A String",
- ],
+ "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.
+ "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`.
+ "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.
+ "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.
+ },
+ },
+ },
+ "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.
+ "y": 42, # Y coordinate.
+ "x": 42, # 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.
+ "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.
+ "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.
+ },
+ "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.
+ "x": 3.14, # X coordinate.
+ "y": 3.14, # Y coordinate.
+ },
+ ],
+ },
+ },
+ "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.
+ "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.
+ "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.
+ },
+ },
+ "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.
+ "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.
+ "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.
+ },
},
},
},
],
- "textPayload": { # Container of information about a piece of text. # The text payload, a container of the text content.
- "textContent": "A String", # Text content.
- },
"videoPayload": { # Container of information of a video. # The video payload, a container of the video uri.
- "videoUri": "A String", # Video uri from the user bucket.
- "signedUri": "A String", # Signed uri of the video file in the service bucket.
"mimeType": "A String", # Video format.
+ "signedUri": "A String", # Signed uri of the video file in the service bucket.
+ "videoUri": "A String", # Video uri from the user bucket.
"videoThumbnails": [ # The list of video thumbnails.
{ # Container of information of a video thumbnail.
"thumbnail": "A String", # A byte string of the video frame.
@@ -466,13 +473,6 @@
],
"frameRate": 3.14, # FPS of the video.
},
- "imagePayload": { # Container of information about an image. # The image payload, a container of the image bytes/uri.
- "mimeType": "A String", # Image format.
- "imageUri": "A String", # Image uri from the user bucket.
- "imageThumbnail": "A String", # A byte string of a thumbnail image.
- "signedUri": "A String", # Signed uri of the image file in the service bucket.
- },
- "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}
},
},
],