Stay organized with collectionsSave and categorize content based on your preferences.
Resource: Dataset
A collection of DataItems and Annotations on them.
Fields
namestring
Output only. Identifier. The resource name of the Dataset. Format:projects/{project}/locations/{location}/datasets/{dataset}
displayNamestring
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.
descriptionstring
The description of the Dataset.
metadataSchemaUristring
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/.
Output only. timestamp when this Dataset was created.
Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples:"2014-10-02T15:01:23Z","2014-10-02T15:01:23.045123456Z"or"2014-10-02T15:01:23+05:30".
Output only. timestamp when this Dataset was last updated.
Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples:"2014-10-02T15:01:23Z","2014-10-02T15:01:23.045123456Z"or"2014-10-02T15:01:23+05:30".
etagstring
Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
labelsmap (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).
Seehttps://goo.gl/xmQnxffor 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 themetadataSchema'stitle.
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 useannotationSpecCount. 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.
metadataArtifactstring
Output only. The resource name of the Artifact that was created in MetadataStore when creating the Dataset. The Artifact resource name pattern isprojects/{project}/locations/{location}/metadataStores/{metadataStore}/artifacts/{artifact}.
modelReferencestring
Optional. Reference to the public base model last used by the dataset. Only set for prompt datasets.
Output only. timestamp when this SavedQuery was created.
Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples:"2014-10-02T15:01:23Z","2014-10-02T15:01:23.045123456Z"or"2014-10-02T15:01:23+05:30".
Output only. timestamp when SavedQuery was last updated.
Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples:"2014-10-02T15:01:23Z","2014-10-02T15:01:23.045123456Z"or"2014-10-02T15:01:23+05:30".
annotationFilterstring
Output only. Filters on the Annotations in the dataset.
problemTypestring
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
annotationSpecCountinteger
Output only. Number of AnnotationSpecs in the context of the SavedQuery.
etagstring
Used to perform a consistent read-modify-write update. If not set, a blind "overwrite" update happens.
supportAutomlTrainingboolean
Output only. If the Annotations belonging to the SavedQuery can be used for AutoML training.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-06-27 UTC."],[],[],null,["# REST Resource: projects.locations.datasets\n\nResource: Dataset\n-----------------\n\nA collection of DataItems and Annotations on them.\nFields `name` `string` \nOutput only. Identifier. The resource name of the Dataset. Format: `projects/{project}/locations/{location}/datasets/{dataset}`\n`displayName` `string` \nRequired. The user-defined name of the Dataset. The name can be up to 128 characters long and can consist of any UTF-8 characters.\n`description` `string` \nThe description of the Dataset.\n`metadataSchemaUri` `string` \nRequired. 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/.\n`metadata` `value (`[Value](https://protobuf.dev/reference/protobuf/google.protobuf/#value)` format)` \nRequired. Additional information about the Dataset.\n`dataItemCount` `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` \nOutput only. The number of DataItems in this Dataset. Only apply for non-structured Dataset.\n`createTime` `string (`[Timestamp](https://protobuf.dev/reference/protobuf/google.protobuf/#timestamp)` format)` \nOutput only. timestamp when this Dataset was created.\n\nUses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than \"Z\" are also accepted. Examples: `\"2014-10-02T15:01:23Z\"`, `\"2014-10-02T15:01:23.045123456Z\"` or `\"2014-10-02T15:01:23+05:30\"`.\n`updateTime` `string (`[Timestamp](https://protobuf.dev/reference/protobuf/google.protobuf/#timestamp)` format)` \nOutput only. timestamp when this Dataset was last updated.\n\nUses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than \"Z\" are also accepted. Examples: `\"2014-10-02T15:01:23Z\"`, `\"2014-10-02T15:01:23.045123456Z\"` or `\"2014-10-02T15:01:23+05:30\"`.\n`etag` `string` \nUsed to perform consistent read-modify-write updates. If not set, a blind \"overwrite\" update happens.\n`labels` `map (key: string, value: string)` \nThe labels with user-defined metadata to organize your Datasets.\n\nlabel 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).\n\nSee \u003chttps://goo.gl/xmQnxf\u003e 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:\n\n- \"aiplatform.googleapis.com/dataset_metadata_schema\": output only, its value is the [metadataSchema's](/vertex-ai/docs/reference/rest/v1/projects.locations.datasets#Dataset.FIELDS.metadata_schema_uri) title.\n`savedQueries[]` `object (`[SavedQuery](/vertex-ai/docs/reference/rest/v1/projects.locations.datasets#SavedQuery)`)` \nAll 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](/vertex-ai/docs/reference/rest/v1/projects.locations.datasets#SavedQuery.FIELDS.annotation_spec_count). 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.\n`encryptionSpec` `object (`[EncryptionSpec](/vertex-ai/docs/reference/rest/v1/EncryptionSpec)`)` \nCustomer-managed encryption key spec for a Dataset. If set, this Dataset and all sub-resources of this Dataset will be secured by this key.\n`metadataArtifact` `string` \nOutput 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}`.\n`modelReference` `string` \nOptional. Reference to the public base model last used by the dataset. Only set for prompt datasets.\n`satisfiesPzs` `boolean` \nOutput only. reserved for future use.\n`satisfiesPzi` `boolean` \nOutput only. reserved for future use. \n\nSavedQuery\n----------\n\nA SavedQuery is a view of the dataset. It references a subset of annotations by problem type and filters.\nFields `name` `string` \nOutput only. Resource name of the SavedQuery.\n`displayName` `string` \nRequired. The user-defined name of the SavedQuery. The name can be up to 128 characters long and can consist of any UTF-8 characters.\n`metadata` `value (`[Value](https://protobuf.dev/reference/protobuf/google.protobuf/#value)` format)` \nSome additional information about the SavedQuery.\n`createTime` `string (`[Timestamp](https://protobuf.dev/reference/protobuf/google.protobuf/#timestamp)` format)` \nOutput only. timestamp when this SavedQuery was created.\n\nUses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than \"Z\" are also accepted. Examples: `\"2014-10-02T15:01:23Z\"`, `\"2014-10-02T15:01:23.045123456Z\"` or `\"2014-10-02T15:01:23+05:30\"`.\n`updateTime` `string (`[Timestamp](https://protobuf.dev/reference/protobuf/google.protobuf/#timestamp)` format)` \nOutput only. timestamp when SavedQuery was last updated.\n\nUses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than \"Z\" are also accepted. Examples: `\"2014-10-02T15:01:23Z\"`, `\"2014-10-02T15:01:23.045123456Z\"` or `\"2014-10-02T15:01:23+05:30\"`.\n`annotationFilter` `string` \nOutput only. Filters on the Annotations in the dataset.\n`problemType` `string` \nRequired. Problem type of the SavedQuery. Allowed values:\n\n- IMAGE_CLASSIFICATION_SINGLE_LABEL\n- IMAGE_CLASSIFICATION_MULTI_LABEL\n- IMAGE_BOUNDING_POLY\n- IMAGE_BOUNDING_BOX\n- TEXT_CLASSIFICATION_SINGLE_LABEL\n- TEXT_CLASSIFICATION_MULTI_LABEL\n- TEXT_EXTRACTION\n- TEXT_SENTIMENT\n- VIDEO_CLASSIFICATION\n- VIDEO_OBJECT_TRACKING\n`annotationSpecCount` `integer` \nOutput only. Number of AnnotationSpecs in the context of the SavedQuery.\n`etag` `string` \nUsed to perform a consistent read-modify-write update. If not set, a blind \"overwrite\" update happens.\n`supportAutomlTraining` `boolean` \nOutput only. If the Annotations belonging to the SavedQuery can be used for AutoML training."]]
