Resource: Dataset
A collection of DataItems and Annotations on them.
name
string
Output only. Identifier. The resource name of the Dataset.
displayName
string
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
string
The description of the Dataset.
metadataSchemaUri
string
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/.
Required. Additional information about the Dataset.
Output only. The number of DataItems in this Dataset. Only apply for non-structured Dataset.
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: "2014-10-02T15:01:23Z"
and "2014-10-02T15:01:23.045123456Z"
.
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: "2014-10-02T15:01:23Z"
and "2014-10-02T15:01:23.045123456Z"
.
etag
string
Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
labels
map (key: string, value: string)
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:
- "aiplatform.googleapis.com/dataset_metadata_schema": output only, its value is the
metadataSchema's
title.
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 annotationSpecCount
. In datasets.create 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.
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
string
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/{metadataStore}/artifacts/{artifact}
.
modelReference
string
Optional. Reference to the public base model last used by the dataset. Only set for prompt datasets.
satisfiesPzs
boolean
Output only. reserved for future use.
satisfiesPzi
boolean
Output only. reserved for future use.
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 ( |
SavedQuery
A SavedQuery is a view of the dataset. It references a subset of annotations by problem type and filters.
name
string
Output only. Resource name of the SavedQuery.
displayName
string
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.
Some additional information about the SavedQuery.
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: "2014-10-02T15:01:23Z"
and "2014-10-02T15:01:23.045123456Z"
.
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: "2014-10-02T15:01:23Z"
and "2014-10-02T15:01:23.045123456Z"
.
annotationFilter
string
Output only. Filters on the Annotations in the dataset.
problemType
string
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
annotationSpecCount
integer
Output only. Number of AnnotationSpecs in the context of the SavedQuery.
etag
string
Used to perform a consistent read-modify-write update. If not set, a blind "overwrite" update happens.
supportAutomlTraining
boolean
Output only. If the Annotations belonging to the SavedQuery can be used for AutoML training.
JSON representation |
---|
{ "name": string, "displayName": string, "metadata": value, "createTime": string, "updateTime": string, "annotationFilter": string, "problemType": string, "annotationSpecCount": integer, "etag": string, "supportAutomlTraining": boolean } |
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. |