dataset_versions

Creates, updates, deletes, gets or lists a dataset_versions resource.

Overview

Name	dataset_versions
Type	Resource
Id	google.aiplatform.dataset_versions

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Output only. Identifier. The resource name of the DatasetVersion. Format: projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}
bigQueryDatasetName	string	Output only. Name of the associated BigQuery dataset.
createTime	string (google-datetime)	Output only. Timestamp when this DatasetVersion was created.
displayName	string	The user-defined name of the DatasetVersion. The name can be up to 128 characters long and can consist of any UTF-8 characters.
etag	string	Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
metadata	any	Required. Output only. Additional information about the DatasetVersion.
modelReference	string	Output only. Reference to the public base model last used by the dataset version. Only set for prompt dataset versions.
satisfiesPzi	boolean	Output only. Reserved for future use.
satisfiesPzs	boolean	Output only. Reserved for future use.
updateTime	string (google-datetime)	Output only. Timestamp when this DatasetVersion was last updated.

list

Successful response

Name	Datatype	Description
name	string	Output only. Identifier. The resource name of the DatasetVersion. Format: projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}
bigQueryDatasetName	string	Output only. Name of the associated BigQuery dataset.
createTime	string (google-datetime)	Output only. Timestamp when this DatasetVersion was created.
displayName	string	The user-defined name of the DatasetVersion. The name can be up to 128 characters long and can consist of any UTF-8 characters.
etag	string	Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
metadata	any	Required. Output only. Additional information about the DatasetVersion.
modelReference	string	Output only. Reference to the public base model last used by the dataset version. Only set for prompt dataset versions.
satisfiesPzi	boolean	Output only. Reserved for future use.
satisfiesPzs	boolean	Output only. Reserved for future use.
updateTime	string (google-datetime)	Output only. Timestamp when this DatasetVersion was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, datasetsId, datasetVersionsId	readMask	Gets a Dataset version.
list	select	projectsId, locationsId, datasetsId	filter, pageSize, pageToken, readMask, orderBy	Lists DatasetVersions in a Dataset.
create	insert	projectsId, locationsId, datasetsId		Create a version from a Dataset.
patch	update	projectsId, locationsId, datasetsId, datasetVersionsId	updateMask	Updates a DatasetVersion.
delete	delete	projectsId, locationsId, datasetsId, datasetVersionsId		Deletes a Dataset version.
restore	exec	projectsId, locationsId, datasetsId, datasetVersionsId		Restores a dataset version.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
datasetVersionsId	string
datasetsId	string
locationsId	string
projectsId	string
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string
readMask	string (google-fieldmask)
updateMask	string (google-fieldmask)

SELECT examples

get

Gets a Dataset version.

SELECT
name,
bigQueryDatasetName,
createTime,
displayName,
etag,
metadata,
modelReference,
satisfiesPzi,
satisfiesPzs,
updateTime
FROM google.aiplatform.dataset_versions
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND datasetsId = '{{ datasetsId }}' -- required
AND datasetVersionsId = '{{ datasetVersionsId }}' -- required
AND readMask = '{{ readMask }}';

list

Lists DatasetVersions in a Dataset.

SELECT
name,
bigQueryDatasetName,
createTime,
displayName,
etag,
metadata,
modelReference,
satisfiesPzi,
satisfiesPzs,
updateTime
FROM google.aiplatform.dataset_versions
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND datasetsId = '{{ datasetsId }}' -- required
AND filter = '{{ filter }}'
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND readMask = '{{ readMask }}'
AND orderBy = '{{ orderBy }}';

INSERT examples

create

Create a version from a Dataset.

INSERT INTO google.aiplatform.dataset_versions (
data__etag,
data__displayName,
projectsId,
locationsId,
datasetsId
)
SELECT 
'{{ etag }}',
'{{ displayName }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ datasetsId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: dataset_versions
  props:
    - name: projectsId
      value: string
      description: Required parameter for the dataset_versions resource.
    - name: locationsId
      value: string
      description: Required parameter for the dataset_versions resource.
    - name: datasetsId
      value: string
      description: Required parameter for the dataset_versions resource.
    - name: etag
      value: string
      description: >
        Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
        
    - name: displayName
      value: string
      description: >
        The user-defined name of the DatasetVersion. The name can be up to 128 characters long and can consist of any UTF-8 characters.
        

UPDATE examples

patch

Updates a DatasetVersion.

UPDATE google.aiplatform.dataset_versions
SET 
data__etag = '{{ etag }}',
data__displayName = '{{ displayName }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND datasetsId = '{{ datasetsId }}' --required
AND datasetVersionsId = '{{ datasetVersionsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
bigQueryDatasetName,
createTime,
displayName,
etag,
metadata,
modelReference,
satisfiesPzi,
satisfiesPzs,
updateTime;

DELETE examples

delete

Deletes a Dataset version.

DELETE FROM google.aiplatform.dataset_versions
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND datasetsId = '{{ datasetsId }}' --required
AND datasetVersionsId = '{{ datasetVersionsId }}' --required;

Lifecycle Methods

restore

Restores a dataset version.

EXEC google.aiplatform.dataset_versions.restore 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@datasetsId='{{ datasetsId }}' --required, 
@datasetVersionsId='{{ datasetVersionsId }}' --required;