1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<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></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="datalabeling_v1beta1.projects.datasets.annotatedDatasets.html">annotatedDatasets()</a></code>
</p>
<p class="firstline">Returns the annotatedDatasets Resource.</p>
<p class="toc_element">
<code><a href="datalabeling_v1beta1.projects.datasets.dataItems.html">dataItems()</a></code>
</p>
<p class="firstline">Returns the dataItems Resource.</p>
<p class="toc_element">
<code><a href="datalabeling_v1beta1.projects.datasets.evaluations.html">evaluations()</a></code>
</p>
<p class="firstline">Returns the evaluations Resource.</p>
<p class="toc_element">
<code><a href="datalabeling_v1beta1.projects.datasets.image.html">image()</a></code>
</p>
<p class="firstline">Returns the image Resource.</p>
<p class="toc_element">
<code><a href="datalabeling_v1beta1.projects.datasets.text.html">text()</a></code>
</p>
<p class="firstline">Returns the text Resource.</p>
<p class="toc_element">
<code><a href="datalabeling_v1beta1.projects.datasets.video.html">video()</a></code>
</p>
<p class="firstline">Returns the video Resource.</p>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline"> Creates dataset. If success return a Dataset resource.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a dataset by resource name.</p>
<p class="toc_element">
<code><a href="#exportData">exportData(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Exports data and annotations from dataset.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets dataset by resource name.</p>
<p class="toc_element">
<code><a href="#importData">importData(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Imports data into dataset based on source locations defined in request. It can be called multiple times for the same dataset. Each dataset can only have one long running operation running on it. For example, no labeling task (also long running operation) can be started while importing is still ongoing. Vice versa.</p>
<p class="toc_element">
<code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists datasets under a project. Pagination is supported.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
<pre> Creates dataset. If success return a Dataset resource.
Args:
parent: string, Required. Dataset resource parent, format: projects/{project_id} (required)
body: object, The request body.
The object takes the form of:
{ # Request message for CreateDataset.
"dataset": { # Dataset is the resource to hold your data. You can request multiple labeling tasks for a dataset while each one will generate an AnnotatedDataset. # Required. The dataset to be created.
"blockingResources": [ # Output only. The names of any related resources that are blocking changes to the dataset.
"A String",
],
"createTime": "A String", # Output only. Time the dataset is created.
"dataItemCount": "A String", # Output only. The number of data items in the dataset.
"description": "A String", # Optional. User-provided description of the annotation specification set. The description can be up to 10000 characters long.
"displayName": "A String", # Required. The display name of the dataset. Maximum of 64 characters.
"inputConfigs": [ # Output only. This is populated with the original input configs where ImportData is called. It is available only after the clients import data to this dataset.
{ # The configuration of input data, including data type, location, etc.
"annotationType": "A String", # Optional. The type of annotation to be performed on this data. You must specify this field if you are using this InputConfig in an EvaluationJob.
"bigquerySource": { # The BigQuery location for input data. If used in an EvaluationJob, this is where the service saves the prediction input and output sampled from the model version. # Source located in BigQuery. You must specify this field if you are using this InputConfig in an EvaluationJob.
"inputUri": "A String", # Required. BigQuery URI to a table, up to 2,000 characters long. If you specify the URI of a table that does not exist, Data Labeling Service creates a table at the URI with the correct schema when you create your EvaluationJob. If you specify the URI of a table that already exists, it must have the [correct schema](/ml-engine/docs/continuous-evaluation/create-job#table-schema). Provide the table URI in the following format: "bq://{your_project_id}/ {your_dataset_name}/{your_table_name}" [Learn more](/ml-engine/docs/continuous-evaluation/create-job#table-schema).
},
"classificationMetadata": { # Metadata for classification annotations. # Optional. Metadata about annotations for the input. You must specify this field if you are using this InputConfig in an EvaluationJob for a model version that performs classification.
"isMultiLabel": True or False, # Whether the classification task is multi-label or not.
},
"dataType": "A String", # Required. Data type must be specifed when user tries to import data.
"gcsSource": { # Source of the Cloud Storage file to be imported. # Source located in Cloud Storage.
"inputUri": "A String", # Required. The input URI of source file. This must be a Cloud Storage path (`gs://...`).
"mimeType": "A String", # Required. The format of the source file. Only "text/csv" is supported.
},
"textMetadata": { # Metadata for the text. # Required for text import, as language code must be specified.
"languageCode": "A String", # The language of this text, as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Default value is en-US.
},
},
],
"lastMigrateTime": "A String", # Last time that the Dataset is migrated to AI Platform V2. If any of the AnnotatedDataset is migrated, the last_migration_time in Dataset is also updated.
"name": "A String", # Output only. Dataset resource name, format is: projects/{project_id}/datasets/{dataset_id}
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Dataset is the resource to hold your data. You can request multiple labeling tasks for a dataset while each one will generate an AnnotatedDataset.
"blockingResources": [ # Output only. The names of any related resources that are blocking changes to the dataset.
"A String",
],
"createTime": "A String", # Output only. Time the dataset is created.
"dataItemCount": "A String", # Output only. The number of data items in the dataset.
"description": "A String", # Optional. User-provided description of the annotation specification set. The description can be up to 10000 characters long.
"displayName": "A String", # Required. The display name of the dataset. Maximum of 64 characters.
"inputConfigs": [ # Output only. This is populated with the original input configs where ImportData is called. It is available only after the clients import data to this dataset.
{ # The configuration of input data, including data type, location, etc.
"annotationType": "A String", # Optional. The type of annotation to be performed on this data. You must specify this field if you are using this InputConfig in an EvaluationJob.
"bigquerySource": { # The BigQuery location for input data. If used in an EvaluationJob, this is where the service saves the prediction input and output sampled from the model version. # Source located in BigQuery. You must specify this field if you are using this InputConfig in an EvaluationJob.
"inputUri": "A String", # Required. BigQuery URI to a table, up to 2,000 characters long. If you specify the URI of a table that does not exist, Data Labeling Service creates a table at the URI with the correct schema when you create your EvaluationJob. If you specify the URI of a table that already exists, it must have the [correct schema](/ml-engine/docs/continuous-evaluation/create-job#table-schema). Provide the table URI in the following format: "bq://{your_project_id}/ {your_dataset_name}/{your_table_name}" [Learn more](/ml-engine/docs/continuous-evaluation/create-job#table-schema).
},
"classificationMetadata": { # Metadata for classification annotations. # Optional. Metadata about annotations for the input. You must specify this field if you are using this InputConfig in an EvaluationJob for a model version that performs classification.
"isMultiLabel": True or False, # Whether the classification task is multi-label or not.
},
"dataType": "A String", # Required. Data type must be specifed when user tries to import data.
"gcsSource": { # Source of the Cloud Storage file to be imported. # Source located in Cloud Storage.
"inputUri": "A String", # Required. The input URI of source file. This must be a Cloud Storage path (`gs://...`).
"mimeType": "A String", # Required. The format of the source file. Only "text/csv" is supported.
},
"textMetadata": { # Metadata for the text. # Required for text import, as language code must be specified.
"languageCode": "A String", # The language of this text, as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Default value is en-US.
},
},
],
"lastMigrateTime": "A String", # Last time that the Dataset is migrated to AI Platform V2. If any of the AnnotatedDataset is migrated, the last_migration_time in Dataset is also updated.
"name": "A String", # Output only. Dataset resource name, format is: projects/{project_id}/datasets/{dataset_id}
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
<pre>Deletes a dataset by resource name.
Args:
name: string, Required. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id} (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}</pre>
</div>
<div class="method">
<code class="details" id="exportData">exportData(name, body=None, x__xgafv=None)</code>
<pre>Exports data and annotations from dataset.
Args:
name: string, Required. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id} (required)
body: object, The request body.
The object takes the form of:
{ # Request message for ExportData API.
"annotatedDataset": "A String", # Required. Annotated dataset resource name. DataItem in Dataset and their annotations in specified annotated dataset will be exported. It's in format of projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}
"filter": "A String", # Optional. Filter is not supported at this moment.
"outputConfig": { # The configuration of output data. # Required. Specify the output destination.
"gcsDestination": { # Export destination of the data.Only gcs path is allowed in output_uri. # Output to a file in Cloud Storage. Should be used for labeling output other than image segmentation.
"mimeType": "A String", # Required. The format of the gcs destination. Only "text/csv" and "application/json" are supported.
"outputUri": "A String", # Required. The output uri of destination file.
},
"gcsFolderDestination": { # Export folder destination of the data. # Output to a folder in Cloud Storage. Should be used for image segmentation or document de-identification labeling outputs.
"outputFolderUri": "A String", # Required. Cloud Storage directory to export data to.
},
},
"userEmailAddress": "A String", # Email of the user who started the export task and should be notified by email. If empty no notification will be sent.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Gets dataset by resource name.
Args:
name: string, Required. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id} (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Dataset is the resource to hold your data. You can request multiple labeling tasks for a dataset while each one will generate an AnnotatedDataset.
"blockingResources": [ # Output only. The names of any related resources that are blocking changes to the dataset.
"A String",
],
"createTime": "A String", # Output only. Time the dataset is created.
"dataItemCount": "A String", # Output only. The number of data items in the dataset.
"description": "A String", # Optional. User-provided description of the annotation specification set. The description can be up to 10000 characters long.
"displayName": "A String", # Required. The display name of the dataset. Maximum of 64 characters.
"inputConfigs": [ # Output only. This is populated with the original input configs where ImportData is called. It is available only after the clients import data to this dataset.
{ # The configuration of input data, including data type, location, etc.
"annotationType": "A String", # Optional. The type of annotation to be performed on this data. You must specify this field if you are using this InputConfig in an EvaluationJob.
"bigquerySource": { # The BigQuery location for input data. If used in an EvaluationJob, this is where the service saves the prediction input and output sampled from the model version. # Source located in BigQuery. You must specify this field if you are using this InputConfig in an EvaluationJob.
"inputUri": "A String", # Required. BigQuery URI to a table, up to 2,000 characters long. If you specify the URI of a table that does not exist, Data Labeling Service creates a table at the URI with the correct schema when you create your EvaluationJob. If you specify the URI of a table that already exists, it must have the [correct schema](/ml-engine/docs/continuous-evaluation/create-job#table-schema). Provide the table URI in the following format: "bq://{your_project_id}/ {your_dataset_name}/{your_table_name}" [Learn more](/ml-engine/docs/continuous-evaluation/create-job#table-schema).
},
"classificationMetadata": { # Metadata for classification annotations. # Optional. Metadata about annotations for the input. You must specify this field if you are using this InputConfig in an EvaluationJob for a model version that performs classification.
"isMultiLabel": True or False, # Whether the classification task is multi-label or not.
},
"dataType": "A String", # Required. Data type must be specifed when user tries to import data.
"gcsSource": { # Source of the Cloud Storage file to be imported. # Source located in Cloud Storage.
"inputUri": "A String", # Required. The input URI of source file. This must be a Cloud Storage path (`gs://...`).
"mimeType": "A String", # Required. The format of the source file. Only "text/csv" is supported.
},
"textMetadata": { # Metadata for the text. # Required for text import, as language code must be specified.
"languageCode": "A String", # The language of this text, as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Default value is en-US.
},
},
],
"lastMigrateTime": "A String", # Last time that the Dataset is migrated to AI Platform V2. If any of the AnnotatedDataset is migrated, the last_migration_time in Dataset is also updated.
"name": "A String", # Output only. Dataset resource name, format is: projects/{project_id}/datasets/{dataset_id}
}</pre>
</div>
<div class="method">
<code class="details" id="importData">importData(name, body=None, x__xgafv=None)</code>
<pre>Imports data into dataset based on source locations defined in request. It can be called multiple times for the same dataset. Each dataset can only have one long running operation running on it. For example, no labeling task (also long running operation) can be started while importing is still ongoing. Vice versa.
Args:
name: string, Required. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id} (required)
body: object, The request body.
The object takes the form of:
{ # Request message for ImportData API.
"inputConfig": { # The configuration of input data, including data type, location, etc. # Required. Specify the input source of the data.
"annotationType": "A String", # Optional. The type of annotation to be performed on this data. You must specify this field if you are using this InputConfig in an EvaluationJob.
"bigquerySource": { # The BigQuery location for input data. If used in an EvaluationJob, this is where the service saves the prediction input and output sampled from the model version. # Source located in BigQuery. You must specify this field if you are using this InputConfig in an EvaluationJob.
"inputUri": "A String", # Required. BigQuery URI to a table, up to 2,000 characters long. If you specify the URI of a table that does not exist, Data Labeling Service creates a table at the URI with the correct schema when you create your EvaluationJob. If you specify the URI of a table that already exists, it must have the [correct schema](/ml-engine/docs/continuous-evaluation/create-job#table-schema). Provide the table URI in the following format: "bq://{your_project_id}/ {your_dataset_name}/{your_table_name}" [Learn more](/ml-engine/docs/continuous-evaluation/create-job#table-schema).
},
"classificationMetadata": { # Metadata for classification annotations. # Optional. Metadata about annotations for the input. You must specify this field if you are using this InputConfig in an EvaluationJob for a model version that performs classification.
"isMultiLabel": True or False, # Whether the classification task is multi-label or not.
},
"dataType": "A String", # Required. Data type must be specifed when user tries to import data.
"gcsSource": { # Source of the Cloud Storage file to be imported. # Source located in Cloud Storage.
"inputUri": "A String", # Required. The input URI of source file. This must be a Cloud Storage path (`gs://...`).
"mimeType": "A String", # Required. The format of the source file. Only "text/csv" is supported.
},
"textMetadata": { # Metadata for the text. # Required for text import, as language code must be specified.
"languageCode": "A String", # The language of this text, as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Default value is en-US.
},
},
"userEmailAddress": "A String", # Email of the user who started the import task and should be notified by email. If empty no notification will be sent.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists datasets under a project. Pagination is supported.
Args:
parent: string, Required. Dataset resource parent, format: projects/{project_id} (required)
filter: string, Optional. Filter on dataset is not supported at this moment.
pageSize: integer, Optional. Requested page size. Server may return fewer results than requested. Default value is 100.
pageToken: string, Optional. A token identifying a page of results for the server to return. Typically obtained by ListDatasetsResponse.next_page_token of the previous [DataLabelingService.ListDatasets] call. Returns the first page if empty.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Results of listing datasets within a project.
"datasets": [ # The list of datasets to return.
{ # Dataset is the resource to hold your data. You can request multiple labeling tasks for a dataset while each one will generate an AnnotatedDataset.
"blockingResources": [ # Output only. The names of any related resources that are blocking changes to the dataset.
"A String",
],
"createTime": "A String", # Output only. Time the dataset is created.
"dataItemCount": "A String", # Output only. The number of data items in the dataset.
"description": "A String", # Optional. User-provided description of the annotation specification set. The description can be up to 10000 characters long.
"displayName": "A String", # Required. The display name of the dataset. Maximum of 64 characters.
"inputConfigs": [ # Output only. This is populated with the original input configs where ImportData is called. It is available only after the clients import data to this dataset.
{ # The configuration of input data, including data type, location, etc.
"annotationType": "A String", # Optional. The type of annotation to be performed on this data. You must specify this field if you are using this InputConfig in an EvaluationJob.
"bigquerySource": { # The BigQuery location for input data. If used in an EvaluationJob, this is where the service saves the prediction input and output sampled from the model version. # Source located in BigQuery. You must specify this field if you are using this InputConfig in an EvaluationJob.
"inputUri": "A String", # Required. BigQuery URI to a table, up to 2,000 characters long. If you specify the URI of a table that does not exist, Data Labeling Service creates a table at the URI with the correct schema when you create your EvaluationJob. If you specify the URI of a table that already exists, it must have the [correct schema](/ml-engine/docs/continuous-evaluation/create-job#table-schema). Provide the table URI in the following format: "bq://{your_project_id}/ {your_dataset_name}/{your_table_name}" [Learn more](/ml-engine/docs/continuous-evaluation/create-job#table-schema).
},
"classificationMetadata": { # Metadata for classification annotations. # Optional. Metadata about annotations for the input. You must specify this field if you are using this InputConfig in an EvaluationJob for a model version that performs classification.
"isMultiLabel": True or False, # Whether the classification task is multi-label or not.
},
"dataType": "A String", # Required. Data type must be specifed when user tries to import data.
"gcsSource": { # Source of the Cloud Storage file to be imported. # Source located in Cloud Storage.
"inputUri": "A String", # Required. The input URI of source file. This must be a Cloud Storage path (`gs://...`).
"mimeType": "A String", # Required. The format of the source file. Only "text/csv" is supported.
},
"textMetadata": { # Metadata for the text. # Required for text import, as language code must be specified.
"languageCode": "A String", # The language of this text, as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Default value is en-US.
},
},
],
"lastMigrateTime": "A String", # Last time that the Dataset is migrated to AI Platform V2. If any of the AnnotatedDataset is migrated, the last_migration_time in Dataset is also updated.
"name": "A String", # Output only. Dataset resource name, format is: projects/{project_id}/datasets/{dataset_id}
},
],
"nextPageToken": "A String", # A token to retrieve next page of results.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>
|
