| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, h1, h2, h3, div, span, p, pre, a { |
| 5 | margin: 0; |
| 6 | padding: 0; |
| 7 | border: 0; |
| 8 | font-weight: inherit; |
| 9 | font-style: inherit; |
| 10 | font-size: 100%; |
| 11 | font-family: inherit; |
| 12 | vertical-align: baseline; |
| 13 | } |
| 14 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, h2, h3 { |
| 50 | border-bottom: solid #CCC 1px; |
| 51 | } |
| 52 | |
| 53 | .toc_element { |
| 54 | margin-top: 0.5em; |
| 55 | } |
| 56 | |
| 57 | .firstline { |
| 58 | margin-left: 2 em; |
| 59 | } |
| 60 | |
| 61 | .method { |
| 62 | margin-top: 1em; |
| 63 | border: solid 1px #CCC; |
| 64 | padding: 1em; |
| 65 | background: #EEE; |
| 66 | } |
| 67 | |
| 68 | .details { |
| 69 | font-weight: bold; |
| 70 | font-size: 14px; |
| 71 | } |
| 72 | |
| 73 | </style> |
| 74 | |
| 75 | <h1><a href="datalabeling_v1beta1.html">Data Labeling API</a> . <a href="datalabeling_v1beta1.projects.html">projects</a> . <a href="datalabeling_v1beta1.projects.datasets.html">datasets</a> . <a href="datalabeling_v1beta1.projects.datasets.annotatedDatasets.html">annotatedDatasets</a> . <a href="datalabeling_v1beta1.projects.datasets.annotatedDatasets.examples.html">examples</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="#close">close()</a></code></p> |
| 79 | <p class="firstline">Close httplib2 connections.</p> |
| 80 | <p class="toc_element"> |
| 81 | <code><a href="#get">get(name, filter=None, x__xgafv=None)</a></code></p> |
| 82 | <p class="firstline">Gets an example by resource name, including both data and annotation.</p> |
| 83 | <p class="toc_element"> |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 84 | <code><a href="#list">list(parent, pageToken=None, filter=None, pageSize=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 85 | <p class="firstline">Lists examples in an annotated dataset. Pagination is supported.</p> |
| 86 | <p class="toc_element"> |
| 87 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 88 | <p class="firstline">Retrieves the next page of results.</p> |
| 89 | <h3>Method Details</h3> |
| 90 | <div class="method"> |
| 91 | <code class="details" id="close">close()</code> |
| 92 | <pre>Close httplib2 connections.</pre> |
| 93 | </div> |
| 94 | |
| 95 | <div class="method"> |
| 96 | <code class="details" id="get">get(name, filter=None, x__xgafv=None)</code> |
| 97 | <pre>Gets an example by resource name, including both data and annotation. |
| 98 | |
| 99 | Args: |
| 100 | name: string, Required. Name of example, format: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}/examples/{example_id} (required) |
| 101 | filter: string, Optional. An expression for filtering Examples. Filter by annotation_spec.display_name is supported. Format "annotation_spec.display_name = {display_name}" |
| 102 | x__xgafv: string, V1 error format. |
| 103 | Allowed values |
| 104 | 1 - v1 error format |
| 105 | 2 - v2 error format |
| 106 | |
| 107 | Returns: |
| 108 | An object of the form: |
| 109 | |
| 110 | { # An Example is a piece of data and its annotation. For example, an image with label "house". |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 111 | "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} |
| 112 | "textPayload": { # Container of information about a piece of text. # The text payload, a container of the text content. |
| 113 | "textContent": "A String", # Text content. |
| 114 | }, |
| 115 | "imagePayload": { # Container of information about an image. # The image payload, a container of the image bytes/uri. |
| 116 | "imageThumbnail": "A String", # A byte string of a thumbnail image. |
| 117 | "mimeType": "A String", # Image format. |
| 118 | "imageUri": "A String", # Image uri from the user bucket. |
| 119 | "signedUri": "A String", # Signed uri of the image file in the service bucket. |
| 120 | }, |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 121 | "annotations": [ # Output only. Annotations for the piece of data in Example. One piece of data can have multiple annotations. |
| 122 | { # 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. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 123 | "annotationMetadata": { # Additional information associated with the annotation. # Output only. Annotation metadata, including information like votes for labels. |
| 124 | "operatorMetadata": { # General information useful for labels coming from contributors. # Metadata related to human labeling. |
| 125 | "comments": [ # Comments from contributors. |
| 126 | "A String", |
| 127 | ], |
| 128 | "totalVotes": 42, # The total number of contributors that answer this question. |
| 129 | "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). |
| 130 | "labelVotes": 42, # The total number of contributors that choose this label. |
| 131 | }, |
| 132 | }, |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 133 | "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} |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 134 | "annotationSource": "A String", # Output only. The source of the annotation. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 135 | "annotationSentiment": "A String", # Output only. Sentiment for this annotation. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 136 | "annotationValue": { # Annotation value for an example. # Output only. This is the actual annotation value, e.g classification, bounding box values are stored here. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 137 | "videoEventAnnotation": { # Video event annotation. # Annotation value for video event case. |
| 138 | "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. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 139 | "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. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 140 | "displayName": "A String", # Required. The display name of the AnnotationSpec. Maximum of 64 characters. |
| 141 | "description": "A String", # Optional. User-provided description of the annotation specification. The description can be up to 10,000 characters long. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 142 | }, |
| 143 | "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. |
| 144 | "endTimeOffset": "A String", # End of the time segment (exclusive), represented as the duration since the example start. |
| 145 | "startTimeOffset": "A String", # Start of the time segment (inclusive), represented as the duration since the example start. |
| 146 | }, |
| 147 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 148 | "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. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 149 | "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. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 150 | "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. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 151 | "displayName": "A String", # Required. The display name of the AnnotationSpec. Maximum of 64 characters. |
| 152 | "description": "A String", # Optional. User-provided description of the annotation specification. The description can be up to 10,000 characters long. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 153 | }, |
| 154 | "normalizedBoundingPoly": { # Normalized bounding polygon. |
| 155 | "normalizedVertices": [ # The bounding polygon normalized vertices. |
| 156 | { # 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. |
| 157 | "x": 3.14, # X coordinate. |
| 158 | "y": 3.14, # Y coordinate. |
| 159 | }, |
| 160 | ], |
| 161 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 162 | "boundingPoly": { # A bounding polygon in the image. |
| 163 | "vertices": [ # The bounding polygon vertices. |
| 164 | { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image. |
| 165 | "y": 42, # Y coordinate. |
| 166 | "x": 42, # X coordinate. |
| 167 | }, |
| 168 | ], |
| 169 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 170 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 171 | "textClassificationAnnotation": { # Text classification annotation. # Annotation value for text classification case. |
| 172 | "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. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 173 | "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. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 174 | "displayName": "A String", # Required. The display name of the AnnotationSpec. Maximum of 64 characters. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 175 | "description": "A String", # Optional. User-provided description of the annotation specification. The description can be up to 10,000 characters long. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 176 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 177 | }, |
| 178 | "videoObjectTrackingAnnotation": { # Video object tracking annotation. # Annotation value for video object detection and tracking case. |
| 179 | "objectTrackingFrames": [ # The list of frames where this object track appears. |
| 180 | { # Video frame level annotation for object detection and tracking. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 181 | "timeOffset": "A String", # The time offset of this frame relative to the beginning of the video. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 182 | "normalizedBoundingPoly": { # Normalized bounding polygon. |
| 183 | "normalizedVertices": [ # The bounding polygon normalized vertices. |
| 184 | { # 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. |
| 185 | "x": 3.14, # X coordinate. |
| 186 | "y": 3.14, # Y coordinate. |
| 187 | }, |
| 188 | ], |
| 189 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 190 | "boundingPoly": { # A bounding polygon in the image. |
| 191 | "vertices": [ # The bounding polygon vertices. |
| 192 | { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image. |
| 193 | "y": 42, # Y coordinate. |
| 194 | "x": 42, # X coordinate. |
| 195 | }, |
| 196 | ], |
| 197 | }, |
| 198 | }, |
| 199 | ], |
| 200 | "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. |
| 201 | "endTimeOffset": "A String", # End of the time segment (exclusive), represented as the duration since the example start. |
| 202 | "startTimeOffset": "A String", # Start of the time segment (inclusive), represented as the duration since the example start. |
| 203 | }, |
| 204 | "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. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 205 | "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. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 206 | "displayName": "A String", # Required. The display name of the AnnotationSpec. Maximum of 64 characters. |
| 207 | "description": "A String", # Optional. User-provided description of the annotation specification. The description can be up to 10,000 characters long. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 208 | }, |
| 209 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 210 | "textEntityExtractionAnnotation": { # Text entity extraction annotation. # Annotation value for text entity extraction case. |
| 211 | "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. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 212 | "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. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 213 | "displayName": "A String", # Required. The display name of the AnnotationSpec. Maximum of 64 characters. |
| 214 | "description": "A String", # Optional. User-provided description of the annotation specification. The description can be up to 10,000 characters long. |
| 215 | }, |
| 216 | "sequentialSegment": { # Start and end position in a sequence (e.g. text segment). # Position of the entity. |
| 217 | "start": 42, # Start position (inclusive). |
| 218 | "end": 42, # End position (exclusive). |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 219 | }, |
| 220 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 221 | "imageSegmentationAnnotation": { # Image segmentation annotation. # Annotation value for image segmentation. |
| 222 | "mimeType": "A String", # Image format. |
| 223 | "imageBytes": "A String", # A byte string of a full image's color map. |
| 224 | "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. |
| 225 | "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`. |
| 226 | "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 | "displayName": "A String", # Required. The display name of the AnnotationSpec. Maximum of 64 characters. |
| 228 | "description": "A String", # Optional. User-provided description of the annotation specification. The description can be up to 10,000 characters long. |
| 229 | }, |
| 230 | }, |
| 231 | }, |
| 232 | "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. |
| 233 | "polyline": { # A line with multiple line segments. |
| 234 | "vertices": [ # The polyline vertices. |
| 235 | { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image. |
| 236 | "y": 42, # Y coordinate. |
| 237 | "x": 42, # X coordinate. |
| 238 | }, |
| 239 | ], |
| 240 | }, |
| 241 | "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. |
| 242 | "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. |
| 243 | "displayName": "A String", # Required. The display name of the AnnotationSpec. Maximum of 64 characters. |
| 244 | "description": "A String", # Optional. User-provided description of the annotation specification. The description can be up to 10,000 characters long. |
| 245 | }, |
| 246 | "normalizedPolyline": { # Normalized polyline. |
| 247 | "normalizedVertices": [ # The normalized polyline vertices. |
| 248 | { # 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. |
| 249 | "x": 3.14, # X coordinate. |
| 250 | "y": 3.14, # Y coordinate. |
| 251 | }, |
| 252 | ], |
| 253 | }, |
| 254 | }, |
| 255 | "imageClassificationAnnotation": { # Image classification annotation definition. # Annotation value for image classification case. |
| 256 | "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. |
| 257 | "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. |
| 258 | "displayName": "A String", # Required. The display name of the AnnotationSpec. Maximum of 64 characters. |
| 259 | "description": "A String", # Optional. User-provided description of the annotation specification. The description can be up to 10,000 characters long. |
| 260 | }, |
| 261 | }, |
| 262 | "videoClassificationAnnotation": { # Video classification annotation. # Annotation value for video classification case. |
| 263 | "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. |
| 264 | "endTimeOffset": "A String", # End of the time segment (exclusive), represented as the duration since the example start. |
| 265 | "startTimeOffset": "A String", # Start of the time segment (inclusive), represented as the duration since the example start. |
| 266 | }, |
| 267 | "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. |
| 268 | "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. |
| 269 | "displayName": "A String", # Required. The display name of the AnnotationSpec. Maximum of 64 characters. |
| 270 | "description": "A String", # Optional. User-provided description of the annotation specification. The description can be up to 10,000 characters long. |
| 271 | }, |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 272 | }, |
| 273 | }, |
| 274 | }, |
| 275 | ], |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 276 | "videoPayload": { # Container of information of a video. # The video payload, a container of the video uri. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 277 | "mimeType": "A String", # Video format. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 278 | "signedUri": "A String", # Signed uri of the video file in the service bucket. |
| 279 | "videoUri": "A String", # Video uri from the user bucket. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 280 | "videoThumbnails": [ # The list of video thumbnails. |
| 281 | { # Container of information of a video thumbnail. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 282 | "thumbnail": "A String", # A byte string of the video frame. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 283 | "timeOffset": "A String", # Time offset relative to the beginning of the video, corresponding to the video frame where the thumbnail has been extracted from. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 284 | }, |
| 285 | ], |
| 286 | "frameRate": 3.14, # FPS of the video. |
| 287 | }, |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 288 | }</pre> |
| 289 | </div> |
| 290 | |
| 291 | <div class="method"> |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 292 | <code class="details" id="list">list(parent, pageToken=None, filter=None, pageSize=None, x__xgafv=None)</code> |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 293 | <pre>Lists examples in an annotated dataset. Pagination is supported. |
| 294 | |
| 295 | Args: |
| 296 | parent: string, Required. Example resource parent. (required) |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 297 | pageToken: string, Optional. A token identifying a page of results for the server to return. Typically obtained by ListExamplesResponse.next_page_token of the previous [DataLabelingService.ListExamples] call. Return first page if empty. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 298 | filter: string, Optional. An expression for filtering Examples. For annotated datasets that have annotation spec set, filter by annotation_spec.display_name is supported. Format "annotation_spec.display_name = {display_name}" |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 299 | pageSize: integer, Optional. Requested page size. Server may return fewer results than requested. Default value is 100. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 300 | x__xgafv: string, V1 error format. |
| 301 | Allowed values |
| 302 | 1 - v1 error format |
| 303 | 2 - v2 error format |
| 304 | |
| 305 | Returns: |
| 306 | An object of the form: |
| 307 | |
| 308 | { # Results of listing Examples in and annotated dataset. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 309 | "examples": [ # The list of examples to return. |
| 310 | { # An Example is a piece of data and its annotation. For example, an image with label "house". |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 311 | "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} |
| 312 | "textPayload": { # Container of information about a piece of text. # The text payload, a container of the text content. |
| 313 | "textContent": "A String", # Text content. |
| 314 | }, |
| 315 | "imagePayload": { # Container of information about an image. # The image payload, a container of the image bytes/uri. |
| 316 | "imageThumbnail": "A String", # A byte string of a thumbnail image. |
| 317 | "mimeType": "A String", # Image format. |
| 318 | "imageUri": "A String", # Image uri from the user bucket. |
| 319 | "signedUri": "A String", # Signed uri of the image file in the service bucket. |
| 320 | }, |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 321 | "annotations": [ # Output only. Annotations for the piece of data in Example. One piece of data can have multiple annotations. |
| 322 | { # 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. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 323 | "annotationMetadata": { # Additional information associated with the annotation. # Output only. Annotation metadata, including information like votes for labels. |
| 324 | "operatorMetadata": { # General information useful for labels coming from contributors. # Metadata related to human labeling. |
| 325 | "comments": [ # Comments from contributors. |
| 326 | "A String", |
| 327 | ], |
| 328 | "totalVotes": 42, # The total number of contributors that answer this question. |
| 329 | "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). |
| 330 | "labelVotes": 42, # The total number of contributors that choose this label. |
| 331 | }, |
| 332 | }, |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 333 | "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} |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 334 | "annotationSource": "A String", # Output only. The source of the annotation. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 335 | "annotationSentiment": "A String", # Output only. Sentiment for this annotation. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 336 | "annotationValue": { # Annotation value for an example. # Output only. This is the actual annotation value, e.g classification, bounding box values are stored here. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 337 | "videoEventAnnotation": { # Video event annotation. # Annotation value for video event case. |
| 338 | "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. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 339 | "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. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 340 | "displayName": "A String", # Required. The display name of the AnnotationSpec. Maximum of 64 characters. |
| 341 | "description": "A String", # Optional. User-provided description of the annotation specification. The description can be up to 10,000 characters long. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 342 | }, |
| 343 | "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. |
| 344 | "endTimeOffset": "A String", # End of the time segment (exclusive), represented as the duration since the example start. |
| 345 | "startTimeOffset": "A String", # Start of the time segment (inclusive), represented as the duration since the example start. |
| 346 | }, |
| 347 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 348 | "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. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 349 | "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. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 350 | "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. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 351 | "displayName": "A String", # Required. The display name of the AnnotationSpec. Maximum of 64 characters. |
| 352 | "description": "A String", # Optional. User-provided description of the annotation specification. The description can be up to 10,000 characters long. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 353 | }, |
| 354 | "normalizedBoundingPoly": { # Normalized bounding polygon. |
| 355 | "normalizedVertices": [ # The bounding polygon normalized vertices. |
| 356 | { # 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. |
| 357 | "x": 3.14, # X coordinate. |
| 358 | "y": 3.14, # Y coordinate. |
| 359 | }, |
| 360 | ], |
| 361 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 362 | "boundingPoly": { # A bounding polygon in the image. |
| 363 | "vertices": [ # The bounding polygon vertices. |
| 364 | { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image. |
| 365 | "y": 42, # Y coordinate. |
| 366 | "x": 42, # X coordinate. |
| 367 | }, |
| 368 | ], |
| 369 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 370 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 371 | "textClassificationAnnotation": { # Text classification annotation. # Annotation value for text classification case. |
| 372 | "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. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 373 | "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. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 374 | "displayName": "A String", # Required. The display name of the AnnotationSpec. Maximum of 64 characters. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 375 | "description": "A String", # Optional. User-provided description of the annotation specification. The description can be up to 10,000 characters long. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 376 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 377 | }, |
| 378 | "videoObjectTrackingAnnotation": { # Video object tracking annotation. # Annotation value for video object detection and tracking case. |
| 379 | "objectTrackingFrames": [ # The list of frames where this object track appears. |
| 380 | { # Video frame level annotation for object detection and tracking. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 381 | "timeOffset": "A String", # The time offset of this frame relative to the beginning of the video. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 382 | "normalizedBoundingPoly": { # Normalized bounding polygon. |
| 383 | "normalizedVertices": [ # The bounding polygon normalized vertices. |
| 384 | { # 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. |
| 385 | "x": 3.14, # X coordinate. |
| 386 | "y": 3.14, # Y coordinate. |
| 387 | }, |
| 388 | ], |
| 389 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 390 | "boundingPoly": { # A bounding polygon in the image. |
| 391 | "vertices": [ # The bounding polygon vertices. |
| 392 | { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image. |
| 393 | "y": 42, # Y coordinate. |
| 394 | "x": 42, # X coordinate. |
| 395 | }, |
| 396 | ], |
| 397 | }, |
| 398 | }, |
| 399 | ], |
| 400 | "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. |
| 401 | "endTimeOffset": "A String", # End of the time segment (exclusive), represented as the duration since the example start. |
| 402 | "startTimeOffset": "A String", # Start of the time segment (inclusive), represented as the duration since the example start. |
| 403 | }, |
| 404 | "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. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 405 | "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. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 406 | "displayName": "A String", # Required. The display name of the AnnotationSpec. Maximum of 64 characters. |
| 407 | "description": "A String", # Optional. User-provided description of the annotation specification. The description can be up to 10,000 characters long. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 408 | }, |
| 409 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 410 | "textEntityExtractionAnnotation": { # Text entity extraction annotation. # Annotation value for text entity extraction case. |
| 411 | "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. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 412 | "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. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 413 | "displayName": "A String", # Required. The display name of the AnnotationSpec. Maximum of 64 characters. |
| 414 | "description": "A String", # Optional. User-provided description of the annotation specification. The description can be up to 10,000 characters long. |
| 415 | }, |
| 416 | "sequentialSegment": { # Start and end position in a sequence (e.g. text segment). # Position of the entity. |
| 417 | "start": 42, # Start position (inclusive). |
| 418 | "end": 42, # End position (exclusive). |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 419 | }, |
| 420 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 421 | "imageSegmentationAnnotation": { # Image segmentation annotation. # Annotation value for image segmentation. |
| 422 | "mimeType": "A String", # Image format. |
| 423 | "imageBytes": "A String", # A byte string of a full image's color map. |
| 424 | "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. |
| 425 | "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`. |
| 426 | "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. |
| 427 | "displayName": "A String", # Required. The display name of the AnnotationSpec. Maximum of 64 characters. |
| 428 | "description": "A String", # Optional. User-provided description of the annotation specification. The description can be up to 10,000 characters long. |
| 429 | }, |
| 430 | }, |
| 431 | }, |
| 432 | "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. |
| 433 | "polyline": { # A line with multiple line segments. |
| 434 | "vertices": [ # The polyline vertices. |
| 435 | { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image. |
| 436 | "y": 42, # Y coordinate. |
| 437 | "x": 42, # X coordinate. |
| 438 | }, |
| 439 | ], |
| 440 | }, |
| 441 | "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. |
| 442 | "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. |
| 443 | "displayName": "A String", # Required. The display name of the AnnotationSpec. Maximum of 64 characters. |
| 444 | "description": "A String", # Optional. User-provided description of the annotation specification. The description can be up to 10,000 characters long. |
| 445 | }, |
| 446 | "normalizedPolyline": { # Normalized polyline. |
| 447 | "normalizedVertices": [ # The normalized polyline vertices. |
| 448 | { # 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. |
| 449 | "x": 3.14, # X coordinate. |
| 450 | "y": 3.14, # Y coordinate. |
| 451 | }, |
| 452 | ], |
| 453 | }, |
| 454 | }, |
| 455 | "imageClassificationAnnotation": { # Image classification annotation definition. # Annotation value for image classification case. |
| 456 | "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. |
| 457 | "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. |
| 458 | "displayName": "A String", # Required. The display name of the AnnotationSpec. Maximum of 64 characters. |
| 459 | "description": "A String", # Optional. User-provided description of the annotation specification. The description can be up to 10,000 characters long. |
| 460 | }, |
| 461 | }, |
| 462 | "videoClassificationAnnotation": { # Video classification annotation. # Annotation value for video classification case. |
| 463 | "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. |
| 464 | "endTimeOffset": "A String", # End of the time segment (exclusive), represented as the duration since the example start. |
| 465 | "startTimeOffset": "A String", # Start of the time segment (inclusive), represented as the duration since the example start. |
| 466 | }, |
| 467 | "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. |
| 468 | "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. |
| 469 | "displayName": "A String", # Required. The display name of the AnnotationSpec. Maximum of 64 characters. |
| 470 | "description": "A String", # Optional. User-provided description of the annotation specification. The description can be up to 10,000 characters long. |
| 471 | }, |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 472 | }, |
| 473 | }, |
| 474 | }, |
| 475 | ], |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 476 | "videoPayload": { # Container of information of a video. # The video payload, a container of the video uri. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 477 | "mimeType": "A String", # Video format. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 478 | "signedUri": "A String", # Signed uri of the video file in the service bucket. |
| 479 | "videoUri": "A String", # Video uri from the user bucket. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 480 | "videoThumbnails": [ # The list of video thumbnails. |
| 481 | { # Container of information of a video thumbnail. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 482 | "thumbnail": "A String", # A byte string of the video frame. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 483 | "timeOffset": "A String", # Time offset relative to the beginning of the video, corresponding to the video frame where the thumbnail has been extracted from. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 484 | }, |
| 485 | ], |
| 486 | "frameRate": 3.14, # FPS of the video. |
| 487 | }, |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 488 | }, |
| 489 | ], |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 490 | "nextPageToken": "A String", # A token to retrieve next page of results. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 491 | }</pre> |
| 492 | </div> |
| 493 | |
| 494 | <div class="method"> |
| 495 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 496 | <pre>Retrieves the next page of results. |
| 497 | |
| 498 | Args: |
| 499 | previous_request: The request for the previous page. (required) |
| 500 | previous_response: The response from the request for the previous page. (required) |
| 501 | |
| 502 | Returns: |
| 503 | A request object that you can call 'execute()' on to request the next |
| 504 | page. Returns None if there are no more items in the collection. |
| 505 | </pre> |
| 506 | </div> |
| 507 | |
| 508 | </body></html> |