Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-132661,4471.5 MB
datasets

Creates a Dataset.

post/v1/datasets

Query parameters

parentstring

Required. The resource name of the Location to create the Dataset in. Format: projects/{project}/locations/{location}

Request body

dataItemCountstring int64

Output only. The number of DataItems in this Dataset. Only apply for non-structured Dataset.

createTimestring google-datetime

Output only. Timestamp when this Dataset was created.

modelReferencestring

Optional. Reference to the public base model last used by the dataset. Only set for prompt datasets.

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/.

{"stackTrail":"components:schemas:GoogleCloudAiplatformV1Dataset:properties:metadata","oasType":"schema","type":"unknown","description":"Required. Additional information about the Dataset."}
etagstring

Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

updateTimestring google-datetime

Output only. Timestamp when this Dataset was last updated.

labelsobject

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 metadata_schema's title.

metadataArtifactstring

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}.

namestring

Output only. Identifier. The resource name of the Dataset. Format: projects/{project}/locations/{location}/datasets/{dataset}

descriptionstring

The description of the 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.

satisfiesPziboolean

Output only. Reserved for future use.

satisfiesPzsboolean

Output only. Reserved for future use.

Response

Successful response