Resource: Dataset
A collection of DataItems and Annotations on them.
JSON representation |
---|
{ "name": string, "displayName": string, "description": string, "metadataSchemaUri": string, "metadata": value, "dataItemCount": string, "createTime": string, "updateTime": string, "etag": string, "labels": { string: string, ... }, "savedQueries": [ { object ( |
Fields | |
---|---|
name |
Output only. Identifier. The resource name of the Dataset. |
displayName |
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. |
description |
The description of the Dataset. |
metadataSchemaUri |
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/. |
metadata |
Required. Additional information about the Dataset. |
dataItemCount |
Output only. The number of DataItems in this Dataset. Only apply for non-structured Dataset. |
createTime |
Output only. timestamp when this Dataset was created. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
updateTime |
Output only. timestamp when this Dataset was last updated. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
etag |
Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. |
labels |
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 "aiplatform.googleapis.com/" and are immutable. Following system labels exist for each Dataset:
|
savedQueries[] |
All SavedQueries belong to the Dataset will be returned in List/Get Dataset response. The annotationSpecs field will not be populated except for UI cases which will only use |
encryptionSpec |
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. |
metadataArtifact |
Output only. The resource name of the Artifact that was created in MetadataStore when creating the Dataset. The Artifact resource name pattern is |
modelReference |
Optional. Reference to the public base model last used by the dataset. Only set for prompt datasets. |
SavedQuery
A SavedQuery is a view of the dataset. It references a subset of annotations by problem type and filters.
JSON representation |
---|
{ "name": string, "displayName": string, "metadata": value, "createTime": string, "updateTime": string, "annotationFilter": string, "problemType": string, "annotationSpecCount": integer, "etag": string, "supportAutomlTraining": boolean } |
Fields | |
---|---|
name |
Output only. Resource name of the SavedQuery. |
displayName |
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. |
metadata |
Some additional information about the SavedQuery. |
createTime |
Output only. timestamp when this SavedQuery was created. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
updateTime |
Output only. timestamp when SavedQuery was last updated. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
annotationFilter |
Output only. Filters on the Annotations in the dataset. |
problemType |
Required. Problem type of the SavedQuery. Allowed values:
|
annotationSpecCount |
Output only. Number of AnnotationSpecs in the context of the SavedQuery. |
etag |
Used to perform a consistent read-modify-write update. If not set, a blind "overwrite" update happens. |
supportAutomlTraining |
Output only. If the Annotations belonging to the SavedQuery can be used for AutoML training. |
Methods |
|
---|---|
|
Creates a Dataset. |
|
Deletes a Dataset. |
|
Exports data from a Dataset. |
|
Gets a Dataset. |
|
Imports data into a Dataset. |
|
Lists Datasets in a Location. |
|
Updates a Dataset. |
|
Searches DataItems in a Dataset. |