Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 0d561ef2b7642e281eb69a81167e45d98d1621a4 / . / docs / dyn / datalabeling_v1beta1.projects.datasets.html
blob: 489aaa4a6018e640c5d9a0a1e410b436a5a966ba [file] [log] [blame]
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]1<html><body>
2<style>
3
4body, 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
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, 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></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="datalabeling_v1beta1.projects.datasets.annotatedDatasets.html">annotatedDatasets()</a></code>
79</p>
80<p class="firstline">Returns the annotatedDatasets Resource.</p>
81
82<p class="toc_element">
83 <code><a href="datalabeling_v1beta1.projects.datasets.dataItems.html">dataItems()</a></code>
84</p>
85<p class="firstline">Returns the dataItems Resource.</p>
86
87<p class="toc_element">
88 <code><a href="datalabeling_v1beta1.projects.datasets.evaluations.html">evaluations()</a></code>
89</p>
90<p class="firstline">Returns the evaluations Resource.</p>
91
92<p class="toc_element">
93 <code><a href="datalabeling_v1beta1.projects.datasets.image.html">image()</a></code>
94</p>
95<p class="firstline">Returns the image Resource.</p>
96
97<p class="toc_element">
98 <code><a href="datalabeling_v1beta1.projects.datasets.text.html">text()</a></code>
99</p>
100<p class="firstline">Returns the text Resource.</p>
101
102<p class="toc_element">
103 <code><a href="datalabeling_v1beta1.projects.datasets.video.html">video()</a></code>
104</p>
105<p class="firstline">Returns the video Resource.</p>
106
107<p class="toc_element">
108 <code><a href="#close">close()</a></code></p>
109<p class="firstline">Close httplib2 connections.</p>
110<p class="toc_element">
111 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
112<p class="firstline">Creates dataset. If success return a Dataset resource.</p>
113<p class="toc_element">
114 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
115<p class="firstline">Deletes a dataset by resource name.</p>
116<p class="toc_element">
117 <code><a href="#exportData">exportData(name, body=None, x__xgafv=None)</a></code></p>
118<p class="firstline">Exports data and annotations from dataset.</p>
119<p class="toc_element">
120 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
121<p class="firstline">Gets dataset by resource name.</p>
122<p class="toc_element">
123 <code><a href="#importData">importData(name, body=None, x__xgafv=None)</a></code></p>
124<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>
125<p class="toc_element">
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]126 <code><a href="#list">list(parent, pageToken=None, filter=None, pageSize=None, x__xgafv=None)</a></code></p>
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]127<p class="firstline">Lists datasets under a project. Pagination is supported.</p>
128<p class="toc_element">
129 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
130<p class="firstline">Retrieves the next page of results.</p>
131<h3>Method Details</h3>
132<div class="method">
133 <code class="details" id="close">close()</code>
134 <pre>Close httplib2 connections.</pre>
135</div>
136
137<div class="method">
138 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
139 <pre>Creates dataset. If success return a Dataset resource.
140
141Args:
142 parent: string, Required. Dataset resource parent, format: projects/{project_id} (required)
143 body: object, The request body.
144 The object takes the form of:
145
146{ # Request message for CreateDataset.
147 &quot;dataset&quot;: { # 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.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]148 &quot;blockingResources&quot;: [ # Output only. The names of any related resources that are blocking changes to the dataset.
149 &quot;A String&quot;,
150 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]151 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time the dataset is created.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]152 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the dataset. Maximum of 64 characters.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]153 &quot;inputConfigs&quot;: [ # 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.
154 { # The configuration of input data, including data type, location, etc.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]155 &quot;annotationType&quot;: &quot;A String&quot;, # 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.
156 &quot;textMetadata&quot;: { # Metadata for the text. # Required for text import, as language code must be specified.
157 &quot;languageCode&quot;: &quot;A String&quot;, # The language of this text, as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Default value is en-US.
158 },
159 &quot;dataType&quot;: &quot;A String&quot;, # Required. Data type must be specifed when user tries to import data.
160 &quot;classificationMetadata&quot;: { # 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.
161 &quot;isMultiLabel&quot;: True or False, # Whether the classification task is multi-label or not.
162 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]163 &quot;gcsSource&quot;: { # Source of the Cloud Storage file to be imported. # Source located in Cloud Storage.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]164 &quot;inputUri&quot;: &quot;A String&quot;, # Required. The input URI of source file. This must be a Cloud Storage path (`gs://...`).
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]165 &quot;mimeType&quot;: &quot;A String&quot;, # Required. The format of the source file. Only &quot;text/csv&quot; is supported.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]166 },
167 &quot;bigquerySource&quot;: { # 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.
168 &quot;inputUri&quot;: &quot;A String&quot;, # 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: &quot;bq://{your_project_id}/ {your_dataset_name}/{your_table_name}&quot; [Learn more](/ml-engine/docs/continuous-evaluation/create-job#table-schema).
169 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]170 },
171 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]172 &quot;dataItemCount&quot;: &quot;A String&quot;, # Output only. The number of data items in the dataset.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]173 &quot;description&quot;: &quot;A String&quot;, # Optional. User-provided description of the annotation specification set. The description can be up to 10000 characters long.
174 &quot;lastMigrateTime&quot;: &quot;A String&quot;, # 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.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]175 &quot;name&quot;: &quot;A String&quot;, # Output only. Dataset resource name, format is: projects/{project_id}/datasets/{dataset_id}
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]176 },
177 }
178
179 x__xgafv: string, V1 error format.
180 Allowed values
181 1 - v1 error format
182 2 - v2 error format
183
184Returns:
185 An object of the form:
186
187 { # Dataset is the resource to hold your data. You can request multiple labeling tasks for a dataset while each one will generate an AnnotatedDataset.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]188 &quot;blockingResources&quot;: [ # Output only. The names of any related resources that are blocking changes to the dataset.
189 &quot;A String&quot;,
190 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]191 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time the dataset is created.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]192 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the dataset. Maximum of 64 characters.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]193 &quot;inputConfigs&quot;: [ # 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.
194 { # The configuration of input data, including data type, location, etc.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]195 &quot;annotationType&quot;: &quot;A String&quot;, # 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.
196 &quot;textMetadata&quot;: { # Metadata for the text. # Required for text import, as language code must be specified.
197 &quot;languageCode&quot;: &quot;A String&quot;, # The language of this text, as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Default value is en-US.
198 },
199 &quot;dataType&quot;: &quot;A String&quot;, # Required. Data type must be specifed when user tries to import data.
200 &quot;classificationMetadata&quot;: { # 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.
201 &quot;isMultiLabel&quot;: True or False, # Whether the classification task is multi-label or not.
202 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]203 &quot;gcsSource&quot;: { # Source of the Cloud Storage file to be imported. # Source located in Cloud Storage.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]204 &quot;inputUri&quot;: &quot;A String&quot;, # Required. The input URI of source file. This must be a Cloud Storage path (`gs://...`).
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]205 &quot;mimeType&quot;: &quot;A String&quot;, # Required. The format of the source file. Only &quot;text/csv&quot; is supported.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]206 },
207 &quot;bigquerySource&quot;: { # 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.
208 &quot;inputUri&quot;: &quot;A String&quot;, # 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: &quot;bq://{your_project_id}/ {your_dataset_name}/{your_table_name}&quot; [Learn more](/ml-engine/docs/continuous-evaluation/create-job#table-schema).
209 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]210 },
211 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]212 &quot;dataItemCount&quot;: &quot;A String&quot;, # Output only. The number of data items in the dataset.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]213 &quot;description&quot;: &quot;A String&quot;, # Optional. User-provided description of the annotation specification set. The description can be up to 10000 characters long.
214 &quot;lastMigrateTime&quot;: &quot;A String&quot;, # 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.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]215 &quot;name&quot;: &quot;A String&quot;, # Output only. Dataset resource name, format is: projects/{project_id}/datasets/{dataset_id}
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]216 }</pre>
217</div>
218
219<div class="method">
220 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
221 <pre>Deletes a dataset by resource name.
222
223Args:
224 name: string, Required. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id} (required)
225 x__xgafv: string, V1 error format.
226 Allowed values
227 1 - v1 error format
228 2 - v2 error format
229
230Returns:
231 An object of the form:
232
233 { # 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); } The JSON representation for `Empty` is empty JSON object `{}`.
234 }</pre>
235</div>
236
237<div class="method">
238 <code class="details" id="exportData">exportData(name, body=None, x__xgafv=None)</code>
239 <pre>Exports data and annotations from dataset.
240
241Args:
242 name: string, Required. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id} (required)
243 body: object, The request body.
244 The object takes the form of:
245
246{ # Request message for ExportData API.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]247 &quot;filter&quot;: &quot;A String&quot;, # Optional. Filter is not supported at this moment.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]248 &quot;userEmailAddress&quot;: &quot;A String&quot;, # Email of the user who started the export task and should be notified by email. If empty no notification will be sent.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]249 &quot;outputConfig&quot;: { # The configuration of output data. # Required. Specify the output destination.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]250 &quot;gcsFolderDestination&quot;: { # 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.
251 &quot;outputFolderUri&quot;: &quot;A String&quot;, # Required. Cloud Storage directory to export data to.
252 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]253 &quot;gcsDestination&quot;: { # 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.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]254 &quot;mimeType&quot;: &quot;A String&quot;, # Required. The format of the gcs destination. Only &quot;text/csv&quot; and &quot;application/json&quot; are supported.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]255 &quot;outputUri&quot;: &quot;A String&quot;, # Required. The output uri of destination file.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]256 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]257 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]258 &quot;annotatedDataset&quot;: &quot;A String&quot;, # Required. Annotated dataset resource name. DataItem in Dataset and their annotations in specified annotated dataset will be exported. It&#x27;s in format of projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]259 }
260
261 x__xgafv: string, V1 error format.
262 Allowed values
263 1 - v1 error format
264 2 - v2 error format
265
266Returns:
267 An object of the form:
268
269 { # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]270 &quot;response&quot;: { # The normal response of the operation in case of success. 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`.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]271 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
272 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]273 &quot;name&quot;: &quot;A String&quot;, # 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}`.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]274 &quot;error&quot;: { # 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.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]275 &quot;message&quot;: &quot;A String&quot;, # 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.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]276 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
277 {
278 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
279 },
280 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]281 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
282 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]283 &quot;metadata&quot;: { # 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.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]284 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
285 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]286 &quot;done&quot;: 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.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]287 }</pre>
288</div>
289
290<div class="method">
291 <code class="details" id="get">get(name, x__xgafv=None)</code>
292 <pre>Gets dataset by resource name.
293
294Args:
295 name: string, Required. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id} (required)
296 x__xgafv: string, V1 error format.
297 Allowed values
298 1 - v1 error format
299 2 - v2 error format
300
301Returns:
302 An object of the form:
303
304 { # Dataset is the resource to hold your data. You can request multiple labeling tasks for a dataset while each one will generate an AnnotatedDataset.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]305 &quot;blockingResources&quot;: [ # Output only. The names of any related resources that are blocking changes to the dataset.
306 &quot;A String&quot;,
307 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]308 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time the dataset is created.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]309 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the dataset. Maximum of 64 characters.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]310 &quot;inputConfigs&quot;: [ # 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.
311 { # The configuration of input data, including data type, location, etc.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]312 &quot;annotationType&quot;: &quot;A String&quot;, # 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.
313 &quot;textMetadata&quot;: { # Metadata for the text. # Required for text import, as language code must be specified.
314 &quot;languageCode&quot;: &quot;A String&quot;, # The language of this text, as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Default value is en-US.
315 },
316 &quot;dataType&quot;: &quot;A String&quot;, # Required. Data type must be specifed when user tries to import data.
317 &quot;classificationMetadata&quot;: { # 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.
318 &quot;isMultiLabel&quot;: True or False, # Whether the classification task is multi-label or not.
319 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]320 &quot;gcsSource&quot;: { # Source of the Cloud Storage file to be imported. # Source located in Cloud Storage.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]321 &quot;inputUri&quot;: &quot;A String&quot;, # Required. The input URI of source file. This must be a Cloud Storage path (`gs://...`).
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]322 &quot;mimeType&quot;: &quot;A String&quot;, # Required. The format of the source file. Only &quot;text/csv&quot; is supported.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]323 },
324 &quot;bigquerySource&quot;: { # 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.
325 &quot;inputUri&quot;: &quot;A String&quot;, # 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: &quot;bq://{your_project_id}/ {your_dataset_name}/{your_table_name}&quot; [Learn more](/ml-engine/docs/continuous-evaluation/create-job#table-schema).
326 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]327 },
328 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]329 &quot;dataItemCount&quot;: &quot;A String&quot;, # Output only. The number of data items in the dataset.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]330 &quot;description&quot;: &quot;A String&quot;, # Optional. User-provided description of the annotation specification set. The description can be up to 10000 characters long.
331 &quot;lastMigrateTime&quot;: &quot;A String&quot;, # 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.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]332 &quot;name&quot;: &quot;A String&quot;, # Output only. Dataset resource name, format is: projects/{project_id}/datasets/{dataset_id}
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]333 }</pre>
334</div>
335
336<div class="method">
337 <code class="details" id="importData">importData(name, body=None, x__xgafv=None)</code>
338 <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.
339
340Args:
341 name: string, Required. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id} (required)
342 body: object, The request body.
343 The object takes the form of:
344
345{ # Request message for ImportData API.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]346 &quot;userEmailAddress&quot;: &quot;A String&quot;, # Email of the user who started the import task and should be notified by email. If empty no notification will be sent.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]347 &quot;inputConfig&quot;: { # The configuration of input data, including data type, location, etc. # Required. Specify the input source of the data.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]348 &quot;annotationType&quot;: &quot;A String&quot;, # 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.
349 &quot;textMetadata&quot;: { # Metadata for the text. # Required for text import, as language code must be specified.
350 &quot;languageCode&quot;: &quot;A String&quot;, # The language of this text, as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Default value is en-US.
351 },
352 &quot;dataType&quot;: &quot;A String&quot;, # Required. Data type must be specifed when user tries to import data.
353 &quot;classificationMetadata&quot;: { # 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.
354 &quot;isMultiLabel&quot;: True or False, # Whether the classification task is multi-label or not.
355 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]356 &quot;gcsSource&quot;: { # Source of the Cloud Storage file to be imported. # Source located in Cloud Storage.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]357 &quot;inputUri&quot;: &quot;A String&quot;, # Required. The input URI of source file. This must be a Cloud Storage path (`gs://...`).
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]358 &quot;mimeType&quot;: &quot;A String&quot;, # Required. The format of the source file. Only &quot;text/csv&quot; is supported.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]359 },
360 &quot;bigquerySource&quot;: { # 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.
361 &quot;inputUri&quot;: &quot;A String&quot;, # 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: &quot;bq://{your_project_id}/ {your_dataset_name}/{your_table_name}&quot; [Learn more](/ml-engine/docs/continuous-evaluation/create-job#table-schema).
362 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]363 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]364 }
365
366 x__xgafv: string, V1 error format.
367 Allowed values
368 1 - v1 error format
369 2 - v2 error format
370
371Returns:
372 An object of the form:
373
374 { # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]375 &quot;response&quot;: { # The normal response of the operation in case of success. 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`.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]376 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
377 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]378 &quot;name&quot;: &quot;A String&quot;, # 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}`.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]379 &quot;error&quot;: { # 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.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]380 &quot;message&quot;: &quot;A String&quot;, # 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.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]381 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
382 {
383 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
384 },
385 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]386 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
387 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]388 &quot;metadata&quot;: { # 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.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]389 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
390 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]391 &quot;done&quot;: 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.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]392 }</pre>
393</div>
394
395<div class="method">
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]396 <code class="details" id="list">list(parent, pageToken=None, filter=None, pageSize=None, x__xgafv=None)</code>
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]397 <pre>Lists datasets under a project. Pagination is supported.
398
399Args:
400 parent: string, Required. Dataset resource parent, format: projects/{project_id} (required)
401 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.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]402 filter: string, Optional. Filter on dataset is not supported at this moment.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]403 pageSize: integer, Optional. Requested page size. Server may return fewer results than requested. Default value is 100.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]404 x__xgafv: string, V1 error format.
405 Allowed values
406 1 - v1 error format
407 2 - v2 error format
408
409Returns:
410 An object of the form:
411
412 { # Results of listing datasets within a project.
413 &quot;nextPageToken&quot;: &quot;A String&quot;, # A token to retrieve next page of results.
414 &quot;datasets&quot;: [ # The list of datasets to return.
415 { # Dataset is the resource to hold your data. You can request multiple labeling tasks for a dataset while each one will generate an AnnotatedDataset.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]416 &quot;blockingResources&quot;: [ # Output only. The names of any related resources that are blocking changes to the dataset.
417 &quot;A String&quot;,
418 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]419 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time the dataset is created.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]420 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the dataset. Maximum of 64 characters.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]421 &quot;inputConfigs&quot;: [ # 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.
422 { # The configuration of input data, including data type, location, etc.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]423 &quot;annotationType&quot;: &quot;A String&quot;, # 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.
424 &quot;textMetadata&quot;: { # Metadata for the text. # Required for text import, as language code must be specified.
425 &quot;languageCode&quot;: &quot;A String&quot;, # The language of this text, as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Default value is en-US.
426 },
427 &quot;dataType&quot;: &quot;A String&quot;, # Required. Data type must be specifed when user tries to import data.
428 &quot;classificationMetadata&quot;: { # 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.
429 &quot;isMultiLabel&quot;: True or False, # Whether the classification task is multi-label or not.
430 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]431 &quot;gcsSource&quot;: { # Source of the Cloud Storage file to be imported. # Source located in Cloud Storage.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]432 &quot;inputUri&quot;: &quot;A String&quot;, # Required. The input URI of source file. This must be a Cloud Storage path (`gs://...`).
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]433 &quot;mimeType&quot;: &quot;A String&quot;, # Required. The format of the source file. Only &quot;text/csv&quot; is supported.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]434 },
435 &quot;bigquerySource&quot;: { # 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.
436 &quot;inputUri&quot;: &quot;A String&quot;, # 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: &quot;bq://{your_project_id}/ {your_dataset_name}/{your_table_name}&quot; [Learn more](/ml-engine/docs/continuous-evaluation/create-job#table-schema).
437 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]438 },
439 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]440 &quot;dataItemCount&quot;: &quot;A String&quot;, # Output only. The number of data items in the dataset.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]441 &quot;description&quot;: &quot;A String&quot;, # Optional. User-provided description of the annotation specification set. The description can be up to 10000 characters long.
442 &quot;lastMigrateTime&quot;: &quot;A String&quot;, # 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.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]443 &quot;name&quot;: &quot;A String&quot;, # Output only. Dataset resource name, format is: projects/{project_id}/datasets/{dataset_id}
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]444 },
445 ],
446 }</pre>
447</div>
448
449<div class="method">
450 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
451 <pre>Retrieves the next page of results.
452
453Args:
454 previous_request: The request for the previous page. (required)
455 previous_response: The response from the request for the previous page. (required)
456
457Returns:
458 A request object that you can call &#x27;execute()&#x27; on to request the next
459 page. Returns None if there are no more items in the collection.
460 </pre>
461</div>
462
463</body></html>