| 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.dataItems.html">dataItems</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, x__xgafv=None)</a></code></p> |
| 82 | <p class="firstline">Gets a data item in a dataset by resource name. This API can be called after data are imported into dataset.</p> |
| 83 | <p class="toc_element"> |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 84 | <code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=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 data items in a dataset. This API can be called after data are imported into 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, x__xgafv=None)</code> |
| 97 | <pre>Gets a data item in a dataset by resource name. This API can be called after data are imported into dataset. |
| 98 | |
| 99 | Args: |
| 100 | name: string, Required. The name of the data item to get, format: projects/{project_id}/datasets/{dataset_id}/dataItems/{data_item_id} (required) |
| 101 | x__xgafv: string, V1 error format. |
| 102 | Allowed values |
| 103 | 1 - v1 error format |
| 104 | 2 - v2 error format |
| 105 | |
| 106 | Returns: |
| 107 | An object of the form: |
| 108 | |
| 109 | { # DataItem is a piece of data, without annotation. For example, an image. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 110 | "imagePayload": { # Container of information about an image. # The image payload, a container of the image bytes/uri. |
| 111 | "imageThumbnail": "A String", # A byte string of a thumbnail image. |
| 112 | "imageUri": "A String", # Image uri from the user bucket. |
| 113 | "mimeType": "A String", # Image format. |
| 114 | "signedUri": "A String", # Signed uri of the image file in the service bucket. |
| 115 | }, |
| 116 | "name": "A String", # Output only. Name of the data item, in format of: projects/{project_id}/datasets/{dataset_id}/dataItems/{data_item_id} |
| 117 | "textPayload": { # Container of information about a piece of text. # The text payload, a container of text content. |
| 118 | "textContent": "A String", # Text content. |
| 119 | }, |
| 120 | "videoPayload": { # Container of information of a video. # The video payload, a container of the video uri. |
| 121 | "frameRate": 3.14, # FPS of the video. |
| 122 | "mimeType": "A String", # Video format. |
| 123 | "signedUri": "A String", # Signed uri of the video file in the service bucket. |
| 124 | "videoThumbnails": [ # The list of video thumbnails. |
| 125 | { # Container of information of a video thumbnail. |
| 126 | "thumbnail": "A String", # A byte string of the video frame. |
| 127 | "timeOffset": "A String", # Time offset relative to the beginning of the video, corresponding to the video frame where the thumbnail has been extracted from. |
| 128 | }, |
| 129 | ], |
| 130 | "videoUri": "A String", # Video uri from the user bucket. |
| 131 | }, |
| 132 | }</pre> |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 133 | </div> |
| 134 | |
| 135 | <div class="method"> |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 136 | <code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code> |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 137 | <pre>Lists data items in a dataset. This API can be called after data are imported into dataset. Pagination is supported. |
| 138 | |
| 139 | Args: |
| 140 | parent: string, Required. Name of the dataset to list data items, format: projects/{project_id}/datasets/{dataset_id} (required) |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 141 | filter: string, Optional. Filter is not supported at this moment. |
| 142 | pageSize: integer, Optional. Requested page size. Server may return fewer results than requested. Default value is 100. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 143 | pageToken: string, Optional. A token identifying a page of results for the server to return. Typically obtained by ListDataItemsResponse.next_page_token of the previous [DataLabelingService.ListDataItems] call. Return first page if empty. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 144 | x__xgafv: string, V1 error format. |
| 145 | Allowed values |
| 146 | 1 - v1 error format |
| 147 | 2 - v2 error format |
| 148 | |
| 149 | Returns: |
| 150 | An object of the form: |
| 151 | |
| 152 | { # Results of listing data items in a dataset. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 153 | "dataItems": [ # The list of data items to return. |
| 154 | { # DataItem is a piece of data, without annotation. For example, an image. |
| 155 | "imagePayload": { # Container of information about an image. # The image payload, a container of the image bytes/uri. |
| 156 | "imageThumbnail": "A String", # A byte string of a thumbnail image. |
| 157 | "imageUri": "A String", # Image uri from the user bucket. |
| 158 | "mimeType": "A String", # Image format. |
| 159 | "signedUri": "A String", # Signed uri of the image file in the service bucket. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 160 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 161 | "name": "A String", # Output only. Name of the data item, in format of: projects/{project_id}/datasets/{dataset_id}/dataItems/{data_item_id} |
| 162 | "textPayload": { # Container of information about a piece of text. # The text payload, a container of text content. |
| 163 | "textContent": "A String", # Text content. |
| 164 | }, |
| 165 | "videoPayload": { # Container of information of a video. # The video payload, a container of the video uri. |
| 166 | "frameRate": 3.14, # FPS of the video. |
| 167 | "mimeType": "A String", # Video format. |
| 168 | "signedUri": "A String", # Signed uri of the video file in the service bucket. |
| 169 | "videoThumbnails": [ # The list of video thumbnails. |
| 170 | { # Container of information of a video thumbnail. |
| 171 | "thumbnail": "A String", # A byte string of the video frame. |
| 172 | "timeOffset": "A String", # Time offset relative to the beginning of the video, corresponding to the video frame where the thumbnail has been extracted from. |
| 173 | }, |
| 174 | ], |
| 175 | "videoUri": "A String", # Video uri from the user bucket. |
| 176 | }, |
| 177 | }, |
| 178 | ], |
| 179 | "nextPageToken": "A String", # A token to retrieve next page of results. |
| 180 | }</pre> |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 181 | </div> |
| 182 | |
| 183 | <div class="method"> |
| 184 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 185 | <pre>Retrieves the next page of results. |
| 186 | |
| 187 | Args: |
| 188 | previous_request: The request for the previous page. (required) |
| 189 | previous_response: The response from the request for the previous page. (required) |
| 190 | |
| 191 | Returns: |
| 192 | A request object that you can call 'execute()' on to request the next |
| 193 | page. Returns None if there are no more items in the collection. |
| 194 | </pre> |
| 195 | </div> |
| 196 | |
| 197 | </body></html> |