Debian Codegraph @

docs/dyn/aiplatform_v1.datasets.html

raw
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="aiplatform_v1.html">Agent Platform API</a> . <a href="aiplatform_v1.datasets.html">datasets</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="aiplatform_v1.datasets.annotationSpecs.html">annotationSpecs()</a></code>
79 </p>
80 <p class="firstline">Returns the annotationSpecs Resource.</p>
81
82 <p class="toc_element">
83 <code><a href="aiplatform_v1.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="aiplatform_v1.datasets.datasetVersions.html">datasetVersions()</a></code>
89 </p>
90 <p class="firstline">Returns the datasetVersions Resource.</p>
91
92 <p class="toc_element">
93 <code><a href="aiplatform_v1.datasets.operations.html">operations()</a></code>
94 </p>
95 <p class="firstline">Returns the operations Resource.</p>
96
97 <p class="toc_element">
98 <code><a href="aiplatform_v1.datasets.savedQueries.html">savedQueries()</a></code>
99 </p>
100 <p class="firstline">Returns the savedQueries Resource.</p>
101
102 <p class="toc_element">
103 <code><a href="#close">close()</a></code></p>
104 <p class="firstline">Close httplib2 connections.</p>
105 <p class="toc_element">
106 <code><a href="#create">create(body=None, parent=None, x__xgafv=None)</a></code></p>
107 <p class="firstline">Creates a Dataset.</p>
108 <p class="toc_element">
109 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
110 <p class="firstline">Deletes a Dataset.</p>
111 <p class="toc_element">
112 <code><a href="#get">get(name, readMask=None, x__xgafv=None)</a></code></p>
113 <p class="firstline">Gets a Dataset.</p>
114 <p class="toc_element">
115 <code><a href="#list">list(filter=None, orderBy=None, pageSize=None, pageToken=None, parent=None, readMask=None, x__xgafv=None)</a></code></p>
116 <p class="firstline">Lists Datasets in a Location.</p>
117 <p class="toc_element">
118 <code><a href="#list_next">list_next()</a></code></p>
119 <p class="firstline">Retrieves the next page of results.</p>
120 <p class="toc_element">
121 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
122 <p class="firstline">Updates a Dataset.</p>
123 <h3>Method Details</h3>
124 <div class="method">
125 <code class="details" id="close">close()</code>
126 <pre>Close httplib2 connections.</pre>
127 </div>
128
129 <div class="method">
130 <code class="details" id="create">create(body=None, parent=None, x__xgafv=None)</code>
131 <pre>Creates a Dataset.
132
133 Args:
134 body: object, The request body.
135 The object takes the form of:
136
137 { # A collection of DataItems and Annotations on them.
138 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this Dataset was created.
139 &quot;dataItemCount&quot;: &quot;A String&quot;, # Output only. The number of DataItems in this Dataset. Only apply for non-structured Dataset.
140 &quot;description&quot;: &quot;A String&quot;, # The description of the Dataset.
141 &quot;displayName&quot;: &quot;A String&quot;, # Required. The user-defined name of the Dataset. The name can be up to 128 characters long and can consist of any UTF-8 characters.
142 &quot;encryptionSpec&quot;: { # Represents a customer-managed encryption key specification that can be applied to a Vertex AI resource. # Customer-managed encryption key spec for a Dataset. If set, this Dataset and all sub-resources of this Dataset will be secured by this key.
143 &quot;kmsKeyName&quot;: &quot;A String&quot;, # Required. Resource name of the Cloud KMS key used to protect the resource. The Cloud KMS key must be in the same region as the resource. It must have the format `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.
144 },
145 &quot;etag&quot;: &quot;A String&quot;, # Used to perform consistent read-modify-write updates. If not set, a blind &quot;overwrite&quot; update happens.
146 &quot;labels&quot;: { # The labels with user-defined metadata to organize your Datasets. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Dataset (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with &quot;aiplatform.googleapis.com/&quot; and are immutable. Following system labels exist for each Dataset: * &quot;aiplatform.googleapis.com/dataset_metadata_schema&quot;: output only, its value is the metadata_schema&#x27;s title.
147 &quot;a_key&quot;: &quot;A String&quot;,
148 },
149 &quot;metadata&quot;: &quot;&quot;, # Required. Additional information about the Dataset.
150 &quot;metadataArtifact&quot;: &quot;A String&quot;, # Output only. The resource name of the Artifact that was created in MetadataStore when creating the Dataset. The Artifact resource name pattern is `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`.
151 &quot;metadataSchemaUri&quot;: &quot;A String&quot;, # Required. Points to a YAML file stored on Google Cloud Storage describing additional information about the Dataset. The schema is defined as an OpenAPI 3.0.2 Schema Object. The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/metadata/.
152 &quot;modelReference&quot;: &quot;A String&quot;, # Optional. Reference to the public base model last used by the dataset. Only set for prompt datasets.
153 &quot;name&quot;: &quot;A String&quot;, # Output only. Identifier. The resource name of the Dataset. Format: `projects/{project}/locations/{location}/datasets/{dataset}`
154 &quot;satisfiesPzi&quot;: True or False, # Output only. Reserved for future use.
155 &quot;satisfiesPzs&quot;: True or False, # Output only. Reserved for future use.
156 &quot;savedQueries&quot;: [ # All SavedQueries belong to the Dataset will be returned in List/Get Dataset response. The annotation_specs field will not be populated except for UI cases which will only use annotation_spec_count. In CreateDataset request, a SavedQuery is created together if this field is set, up to one SavedQuery can be set in CreateDatasetRequest. The SavedQuery should not contain any AnnotationSpec.
157 { # A SavedQuery is a view of the dataset. It references a subset of annotations by problem type and filters.
158 &quot;annotationFilter&quot;: &quot;A String&quot;, # Output only. Filters on the Annotations in the dataset.
159 &quot;annotationSpecCount&quot;: 42, # Output only. Number of AnnotationSpecs in the context of the SavedQuery.
160 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this SavedQuery was created.
161 &quot;displayName&quot;: &quot;A String&quot;, # Required. The user-defined name of the SavedQuery. The name can be up to 128 characters long and can consist of any UTF-8 characters.
162 &quot;etag&quot;: &quot;A String&quot;, # Used to perform a consistent read-modify-write update. If not set, a blind &quot;overwrite&quot; update happens.
163 &quot;metadata&quot;: &quot;&quot;, # Some additional information about the SavedQuery.
164 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of the SavedQuery.
165 &quot;problemType&quot;: &quot;A String&quot;, # Required. Problem type of the SavedQuery. Allowed values: * IMAGE_CLASSIFICATION_SINGLE_LABEL * IMAGE_CLASSIFICATION_MULTI_LABEL * IMAGE_BOUNDING_POLY * IMAGE_BOUNDING_BOX * TEXT_CLASSIFICATION_SINGLE_LABEL * TEXT_CLASSIFICATION_MULTI_LABEL * TEXT_EXTRACTION * TEXT_SENTIMENT * VIDEO_CLASSIFICATION * VIDEO_OBJECT_TRACKING
166 &quot;supportAutomlTraining&quot;: True or False, # Output only. If the Annotations belonging to the SavedQuery can be used for AutoML training.
167 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Timestamp when SavedQuery was last updated.
168 },
169 ],
170 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this Dataset was last updated.
171 }
172
173 parent: string, Required. The resource name of the Location to create the Dataset in. Format: `projects/{project}/locations/{location}`
174 x__xgafv: string, V1 error format.
175 Allowed values
176 1 - v1 error format
177 2 - v2 error format
178
179 Returns:
180 An object of the form:
181
182 { # This resource represents a long-running operation that is the result of a network API call.
183 &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.
184 &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.
185 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
186 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
187 {
188 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
189 },
190 ],
191 &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.
192 },
193 &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.
194 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
195 },
196 &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}`.
197 &quot;response&quot;: { # 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`.
198 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
199 },
200 }</pre>
201 </div>
202
203 <div class="method">
204 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
205 <pre>Deletes a Dataset.
206
207 Args:
208 name: string, Required. The resource name of the Dataset to delete. Format: `projects/{project}/locations/{location}/datasets/{dataset}` (required)
209 x__xgafv: string, V1 error format.
210 Allowed values
211 1 - v1 error format
212 2 - v2 error format
213
214 Returns:
215 An object of the form:
216
217 { # This resource represents a long-running operation that is the result of a network API call.
218 &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.
219 &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.
220 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
221 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
222 {
223 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
224 },
225 ],
226 &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.
227 },
228 &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.
229 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
230 },
231 &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}`.
232 &quot;response&quot;: { # 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`.
233 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
234 },
235 }</pre>
236 </div>
237
238 <div class="method">
239 <code class="details" id="get">get(name, readMask=None, x__xgafv=None)</code>
240 <pre>Gets a Dataset.
241
242 Args:
243 name: string, Required. The name of the Dataset resource. (required)
244 readMask: string, Mask specifying which fields to read.
245 x__xgafv: string, V1 error format.
246 Allowed values
247 1 - v1 error format
248 2 - v2 error format
249
250 Returns:
251 An object of the form:
252
253 { # A collection of DataItems and Annotations on them.
254 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this Dataset was created.
255 &quot;dataItemCount&quot;: &quot;A String&quot;, # Output only. The number of DataItems in this Dataset. Only apply for non-structured Dataset.
256 &quot;description&quot;: &quot;A String&quot;, # The description of the Dataset.
257 &quot;displayName&quot;: &quot;A String&quot;, # Required. The user-defined name of the Dataset. The name can be up to 128 characters long and can consist of any UTF-8 characters.
258 &quot;encryptionSpec&quot;: { # Represents a customer-managed encryption key specification that can be applied to a Vertex AI resource. # Customer-managed encryption key spec for a Dataset. If set, this Dataset and all sub-resources of this Dataset will be secured by this key.
259 &quot;kmsKeyName&quot;: &quot;A String&quot;, # Required. Resource name of the Cloud KMS key used to protect the resource. The Cloud KMS key must be in the same region as the resource. It must have the format `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.
260 },
261 &quot;etag&quot;: &quot;A String&quot;, # Used to perform consistent read-modify-write updates. If not set, a blind &quot;overwrite&quot; update happens.
262 &quot;labels&quot;: { # The labels with user-defined metadata to organize your Datasets. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Dataset (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with &quot;aiplatform.googleapis.com/&quot; and are immutable. Following system labels exist for each Dataset: * &quot;aiplatform.googleapis.com/dataset_metadata_schema&quot;: output only, its value is the metadata_schema&#x27;s title.
263 &quot;a_key&quot;: &quot;A String&quot;,
264 },
265 &quot;metadata&quot;: &quot;&quot;, # Required. Additional information about the Dataset.
266 &quot;metadataArtifact&quot;: &quot;A String&quot;, # Output only. The resource name of the Artifact that was created in MetadataStore when creating the Dataset. The Artifact resource name pattern is `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`.
267 &quot;metadataSchemaUri&quot;: &quot;A String&quot;, # Required. Points to a YAML file stored on Google Cloud Storage describing additional information about the Dataset. The schema is defined as an OpenAPI 3.0.2 Schema Object. The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/metadata/.
268 &quot;modelReference&quot;: &quot;A String&quot;, # Optional. Reference to the public base model last used by the dataset. Only set for prompt datasets.
269 &quot;name&quot;: &quot;A String&quot;, # Output only. Identifier. The resource name of the Dataset. Format: `projects/{project}/locations/{location}/datasets/{dataset}`
270 &quot;satisfiesPzi&quot;: True or False, # Output only. Reserved for future use.
271 &quot;satisfiesPzs&quot;: True or False, # Output only. Reserved for future use.
272 &quot;savedQueries&quot;: [ # All SavedQueries belong to the Dataset will be returned in List/Get Dataset response. The annotation_specs field will not be populated except for UI cases which will only use annotation_spec_count. In CreateDataset request, a SavedQuery is created together if this field is set, up to one SavedQuery can be set in CreateDatasetRequest. The SavedQuery should not contain any AnnotationSpec.
273 { # A SavedQuery is a view of the dataset. It references a subset of annotations by problem type and filters.
274 &quot;annotationFilter&quot;: &quot;A String&quot;, # Output only. Filters on the Annotations in the dataset.
275 &quot;annotationSpecCount&quot;: 42, # Output only. Number of AnnotationSpecs in the context of the SavedQuery.
276 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this SavedQuery was created.
277 &quot;displayName&quot;: &quot;A String&quot;, # Required. The user-defined name of the SavedQuery. The name can be up to 128 characters long and can consist of any UTF-8 characters.
278 &quot;etag&quot;: &quot;A String&quot;, # Used to perform a consistent read-modify-write update. If not set, a blind &quot;overwrite&quot; update happens.
279 &quot;metadata&quot;: &quot;&quot;, # Some additional information about the SavedQuery.
280 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of the SavedQuery.
281 &quot;problemType&quot;: &quot;A String&quot;, # Required. Problem type of the SavedQuery. Allowed values: * IMAGE_CLASSIFICATION_SINGLE_LABEL * IMAGE_CLASSIFICATION_MULTI_LABEL * IMAGE_BOUNDING_POLY * IMAGE_BOUNDING_BOX * TEXT_CLASSIFICATION_SINGLE_LABEL * TEXT_CLASSIFICATION_MULTI_LABEL * TEXT_EXTRACTION * TEXT_SENTIMENT * VIDEO_CLASSIFICATION * VIDEO_OBJECT_TRACKING
282 &quot;supportAutomlTraining&quot;: True or False, # Output only. If the Annotations belonging to the SavedQuery can be used for AutoML training.
283 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Timestamp when SavedQuery was last updated.
284 },
285 ],
286 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this Dataset was last updated.
287 }</pre>
288 </div>
289
290 <div class="method">
291 <code class="details" id="list">list(filter=None, orderBy=None, pageSize=None, pageToken=None, parent=None, readMask=None, x__xgafv=None)</code>
292 <pre>Lists Datasets in a Location.
293
294 Args:
295 filter: string, An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `display_name`: supports = and != * `metadata_schema_uri`: supports = and != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels.&quot;a key&quot;`. Some examples: * `displayName=&quot;myDisplayName&quot;` * `labels.myKey=&quot;myValue&quot;`
296 orderBy: string, A comma-separated list of fields to order by, sorted in ascending order. Use &quot;desc&quot; after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time`
297 pageSize: integer, The standard list page size.
298 pageToken: string, The standard list page token.
299 parent: string, Required. The name of the Dataset&#x27;s parent resource. Format: `projects/{project}/locations/{location}`
300 readMask: string, Mask specifying which fields to read.
301 x__xgafv: string, V1 error format.
302 Allowed values
303 1 - v1 error format
304 2 - v2 error format
305
306 Returns:
307 An object of the form:
308
309 { # Response message for DatasetService.ListDatasets.
310 &quot;datasets&quot;: [ # A list of Datasets that matches the specified filter in the request.
311 { # A collection of DataItems and Annotations on them.
312 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this Dataset was created.
313 &quot;dataItemCount&quot;: &quot;A String&quot;, # Output only. The number of DataItems in this Dataset. Only apply for non-structured Dataset.
314 &quot;description&quot;: &quot;A String&quot;, # The description of the Dataset.
315 &quot;displayName&quot;: &quot;A String&quot;, # Required. The user-defined name of the Dataset. The name can be up to 128 characters long and can consist of any UTF-8 characters.
316 &quot;encryptionSpec&quot;: { # Represents a customer-managed encryption key specification that can be applied to a Vertex AI resource. # Customer-managed encryption key spec for a Dataset. If set, this Dataset and all sub-resources of this Dataset will be secured by this key.
317 &quot;kmsKeyName&quot;: &quot;A String&quot;, # Required. Resource name of the Cloud KMS key used to protect the resource. The Cloud KMS key must be in the same region as the resource. It must have the format `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.
318 },
319 &quot;etag&quot;: &quot;A String&quot;, # Used to perform consistent read-modify-write updates. If not set, a blind &quot;overwrite&quot; update happens.
320 &quot;labels&quot;: { # The labels with user-defined metadata to organize your Datasets. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Dataset (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with &quot;aiplatform.googleapis.com/&quot; and are immutable. Following system labels exist for each Dataset: * &quot;aiplatform.googleapis.com/dataset_metadata_schema&quot;: output only, its value is the metadata_schema&#x27;s title.
321 &quot;a_key&quot;: &quot;A String&quot;,
322 },
323 &quot;metadata&quot;: &quot;&quot;, # Required. Additional information about the Dataset.
324 &quot;metadataArtifact&quot;: &quot;A String&quot;, # Output only. The resource name of the Artifact that was created in MetadataStore when creating the Dataset. The Artifact resource name pattern is `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`.
325 &quot;metadataSchemaUri&quot;: &quot;A String&quot;, # Required. Points to a YAML file stored on Google Cloud Storage describing additional information about the Dataset. The schema is defined as an OpenAPI 3.0.2 Schema Object. The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/metadata/.
326 &quot;modelReference&quot;: &quot;A String&quot;, # Optional. Reference to the public base model last used by the dataset. Only set for prompt datasets.
327 &quot;name&quot;: &quot;A String&quot;, # Output only. Identifier. The resource name of the Dataset. Format: `projects/{project}/locations/{location}/datasets/{dataset}`
328 &quot;satisfiesPzi&quot;: True or False, # Output only. Reserved for future use.
329 &quot;satisfiesPzs&quot;: True or False, # Output only. Reserved for future use.
330 &quot;savedQueries&quot;: [ # All SavedQueries belong to the Dataset will be returned in List/Get Dataset response. The annotation_specs field will not be populated except for UI cases which will only use annotation_spec_count. In CreateDataset request, a SavedQuery is created together if this field is set, up to one SavedQuery can be set in CreateDatasetRequest. The SavedQuery should not contain any AnnotationSpec.
331 { # A SavedQuery is a view of the dataset. It references a subset of annotations by problem type and filters.
332 &quot;annotationFilter&quot;: &quot;A String&quot;, # Output only. Filters on the Annotations in the dataset.
333 &quot;annotationSpecCount&quot;: 42, # Output only. Number of AnnotationSpecs in the context of the SavedQuery.
334 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this SavedQuery was created.
335 &quot;displayName&quot;: &quot;A String&quot;, # Required. The user-defined name of the SavedQuery. The name can be up to 128 characters long and can consist of any UTF-8 characters.
336 &quot;etag&quot;: &quot;A String&quot;, # Used to perform a consistent read-modify-write update. If not set, a blind &quot;overwrite&quot; update happens.
337 &quot;metadata&quot;: &quot;&quot;, # Some additional information about the SavedQuery.
338 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of the SavedQuery.
339 &quot;problemType&quot;: &quot;A String&quot;, # Required. Problem type of the SavedQuery. Allowed values: * IMAGE_CLASSIFICATION_SINGLE_LABEL * IMAGE_CLASSIFICATION_MULTI_LABEL * IMAGE_BOUNDING_POLY * IMAGE_BOUNDING_BOX * TEXT_CLASSIFICATION_SINGLE_LABEL * TEXT_CLASSIFICATION_MULTI_LABEL * TEXT_EXTRACTION * TEXT_SENTIMENT * VIDEO_CLASSIFICATION * VIDEO_OBJECT_TRACKING
340 &quot;supportAutomlTraining&quot;: True or False, # Output only. If the Annotations belonging to the SavedQuery can be used for AutoML training.
341 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Timestamp when SavedQuery was last updated.
342 },
343 ],
344 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this Dataset was last updated.
345 },
346 ],
347 &quot;nextPageToken&quot;: &quot;A String&quot;, # The standard List next-page token.
348 }</pre>
349 </div>
350
351 <div class="method">
352 <code class="details" id="list_next">list_next()</code>
353 <pre>Retrieves the next page of results.
354
355 Args:
356 previous_request: The request for the previous page. (required)
357 previous_response: The response from the request for the previous page. (required)
358
359 Returns:
360 A request object that you can call &#x27;execute()&#x27; on to request the next
361 page. Returns None if there are no more items in the collection.
362 </pre>
363 </div>
364
365 <div class="method">
366 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
367 <pre>Updates a Dataset.
368
369 Args:
370 name: string, Output only. Identifier. The resource name of the Dataset. Format: `projects/{project}/locations/{location}/datasets/{dataset}` (required)
371 body: object, The request body.
372 The object takes the form of:
373
374 { # A collection of DataItems and Annotations on them.
375 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this Dataset was created.
376 &quot;dataItemCount&quot;: &quot;A String&quot;, # Output only. The number of DataItems in this Dataset. Only apply for non-structured Dataset.
377 &quot;description&quot;: &quot;A String&quot;, # The description of the Dataset.
378 &quot;displayName&quot;: &quot;A String&quot;, # Required. The user-defined name of the Dataset. The name can be up to 128 characters long and can consist of any UTF-8 characters.
379 &quot;encryptionSpec&quot;: { # Represents a customer-managed encryption key specification that can be applied to a Vertex AI resource. # Customer-managed encryption key spec for a Dataset. If set, this Dataset and all sub-resources of this Dataset will be secured by this key.
380 &quot;kmsKeyName&quot;: &quot;A String&quot;, # Required. Resource name of the Cloud KMS key used to protect the resource. The Cloud KMS key must be in the same region as the resource. It must have the format `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.
381 },
382 &quot;etag&quot;: &quot;A String&quot;, # Used to perform consistent read-modify-write updates. If not set, a blind &quot;overwrite&quot; update happens.
383 &quot;labels&quot;: { # The labels with user-defined metadata to organize your Datasets. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Dataset (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with &quot;aiplatform.googleapis.com/&quot; and are immutable. Following system labels exist for each Dataset: * &quot;aiplatform.googleapis.com/dataset_metadata_schema&quot;: output only, its value is the metadata_schema&#x27;s title.
384 &quot;a_key&quot;: &quot;A String&quot;,
385 },
386 &quot;metadata&quot;: &quot;&quot;, # Required. Additional information about the Dataset.
387 &quot;metadataArtifact&quot;: &quot;A String&quot;, # Output only. The resource name of the Artifact that was created in MetadataStore when creating the Dataset. The Artifact resource name pattern is `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`.
388 &quot;metadataSchemaUri&quot;: &quot;A String&quot;, # Required. Points to a YAML file stored on Google Cloud Storage describing additional information about the Dataset. The schema is defined as an OpenAPI 3.0.2 Schema Object. The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/metadata/.
389 &quot;modelReference&quot;: &quot;A String&quot;, # Optional. Reference to the public base model last used by the dataset. Only set for prompt datasets.
390 &quot;name&quot;: &quot;A String&quot;, # Output only. Identifier. The resource name of the Dataset. Format: `projects/{project}/locations/{location}/datasets/{dataset}`
391 &quot;satisfiesPzi&quot;: True or False, # Output only. Reserved for future use.
392 &quot;satisfiesPzs&quot;: True or False, # Output only. Reserved for future use.
393 &quot;savedQueries&quot;: [ # All SavedQueries belong to the Dataset will be returned in List/Get Dataset response. The annotation_specs field will not be populated except for UI cases which will only use annotation_spec_count. In CreateDataset request, a SavedQuery is created together if this field is set, up to one SavedQuery can be set in CreateDatasetRequest. The SavedQuery should not contain any AnnotationSpec.
394 { # A SavedQuery is a view of the dataset. It references a subset of annotations by problem type and filters.
395 &quot;annotationFilter&quot;: &quot;A String&quot;, # Output only. Filters on the Annotations in the dataset.
396 &quot;annotationSpecCount&quot;: 42, # Output only. Number of AnnotationSpecs in the context of the SavedQuery.
397 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this SavedQuery was created.
398 &quot;displayName&quot;: &quot;A String&quot;, # Required. The user-defined name of the SavedQuery. The name can be up to 128 characters long and can consist of any UTF-8 characters.
399 &quot;etag&quot;: &quot;A String&quot;, # Used to perform a consistent read-modify-write update. If not set, a blind &quot;overwrite&quot; update happens.
400 &quot;metadata&quot;: &quot;&quot;, # Some additional information about the SavedQuery.
401 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of the SavedQuery.
402 &quot;problemType&quot;: &quot;A String&quot;, # Required. Problem type of the SavedQuery. Allowed values: * IMAGE_CLASSIFICATION_SINGLE_LABEL * IMAGE_CLASSIFICATION_MULTI_LABEL * IMAGE_BOUNDING_POLY * IMAGE_BOUNDING_BOX * TEXT_CLASSIFICATION_SINGLE_LABEL * TEXT_CLASSIFICATION_MULTI_LABEL * TEXT_EXTRACTION * TEXT_SENTIMENT * VIDEO_CLASSIFICATION * VIDEO_OBJECT_TRACKING
403 &quot;supportAutomlTraining&quot;: True or False, # Output only. If the Annotations belonging to the SavedQuery can be used for AutoML training.
404 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Timestamp when SavedQuery was last updated.
405 },
406 ],
407 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this Dataset was last updated.
408 }
409
410 updateMask: string, Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. Updatable fields: * `display_name` * `description` * `labels`
411 x__xgafv: string, V1 error format.
412 Allowed values
413 1 - v1 error format
414 2 - v2 error format
415
416 Returns:
417 An object of the form:
418
419 { # A collection of DataItems and Annotations on them.
420 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this Dataset was created.
421 &quot;dataItemCount&quot;: &quot;A String&quot;, # Output only. The number of DataItems in this Dataset. Only apply for non-structured Dataset.
422 &quot;description&quot;: &quot;A String&quot;, # The description of the Dataset.
423 &quot;displayName&quot;: &quot;A String&quot;, # Required. The user-defined name of the Dataset. The name can be up to 128 characters long and can consist of any UTF-8 characters.
424 &quot;encryptionSpec&quot;: { # Represents a customer-managed encryption key specification that can be applied to a Vertex AI resource. # Customer-managed encryption key spec for a Dataset. If set, this Dataset and all sub-resources of this Dataset will be secured by this key.
425 &quot;kmsKeyName&quot;: &quot;A String&quot;, # Required. Resource name of the Cloud KMS key used to protect the resource. The Cloud KMS key must be in the same region as the resource. It must have the format `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.
426 },
427 &quot;etag&quot;: &quot;A String&quot;, # Used to perform consistent read-modify-write updates. If not set, a blind &quot;overwrite&quot; update happens.
428 &quot;labels&quot;: { # The labels with user-defined metadata to organize your Datasets. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Dataset (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with &quot;aiplatform.googleapis.com/&quot; and are immutable. Following system labels exist for each Dataset: * &quot;aiplatform.googleapis.com/dataset_metadata_schema&quot;: output only, its value is the metadata_schema&#x27;s title.
429 &quot;a_key&quot;: &quot;A String&quot;,
430 },
431 &quot;metadata&quot;: &quot;&quot;, # Required. Additional information about the Dataset.
432 &quot;metadataArtifact&quot;: &quot;A String&quot;, # Output only. The resource name of the Artifact that was created in MetadataStore when creating the Dataset. The Artifact resource name pattern is `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`.
433 &quot;metadataSchemaUri&quot;: &quot;A String&quot;, # Required. Points to a YAML file stored on Google Cloud Storage describing additional information about the Dataset. The schema is defined as an OpenAPI 3.0.2 Schema Object. The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/metadata/.
434 &quot;modelReference&quot;: &quot;A String&quot;, # Optional. Reference to the public base model last used by the dataset. Only set for prompt datasets.
435 &quot;name&quot;: &quot;A String&quot;, # Output only. Identifier. The resource name of the Dataset. Format: `projects/{project}/locations/{location}/datasets/{dataset}`
436 &quot;satisfiesPzi&quot;: True or False, # Output only. Reserved for future use.
437 &quot;satisfiesPzs&quot;: True or False, # Output only. Reserved for future use.
438 &quot;savedQueries&quot;: [ # All SavedQueries belong to the Dataset will be returned in List/Get Dataset response. The annotation_specs field will not be populated except for UI cases which will only use annotation_spec_count. In CreateDataset request, a SavedQuery is created together if this field is set, up to one SavedQuery can be set in CreateDatasetRequest. The SavedQuery should not contain any AnnotationSpec.
439 { # A SavedQuery is a view of the dataset. It references a subset of annotations by problem type and filters.
440 &quot;annotationFilter&quot;: &quot;A String&quot;, # Output only. Filters on the Annotations in the dataset.
441 &quot;annotationSpecCount&quot;: 42, # Output only. Number of AnnotationSpecs in the context of the SavedQuery.
442 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this SavedQuery was created.
443 &quot;displayName&quot;: &quot;A String&quot;, # Required. The user-defined name of the SavedQuery. The name can be up to 128 characters long and can consist of any UTF-8 characters.
444 &quot;etag&quot;: &quot;A String&quot;, # Used to perform a consistent read-modify-write update. If not set, a blind &quot;overwrite&quot; update happens.
445 &quot;metadata&quot;: &quot;&quot;, # Some additional information about the SavedQuery.
446 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of the SavedQuery.
447 &quot;problemType&quot;: &quot;A String&quot;, # Required. Problem type of the SavedQuery. Allowed values: * IMAGE_CLASSIFICATION_SINGLE_LABEL * IMAGE_CLASSIFICATION_MULTI_LABEL * IMAGE_BOUNDING_POLY * IMAGE_BOUNDING_BOX * TEXT_CLASSIFICATION_SINGLE_LABEL * TEXT_CLASSIFICATION_MULTI_LABEL * TEXT_EXTRACTION * TEXT_SENTIMENT * VIDEO_CLASSIFICATION * VIDEO_OBJECT_TRACKING
448 &quot;supportAutomlTraining&quot;: True or False, # Output only. If the Annotations belonging to the SavedQuery can be used for AutoML training.
449 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Timestamp when SavedQuery was last updated.
450 },
451 ],
452 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this Dataset was last updated.
453 }</pre>
454 </div>
455
456 </body></html>