annotated_datasets

Creates, updates, deletes, gets or lists an annotated_datasets resource.

Overview

Name	annotated_datasets
Type	Resource
Id	google.datalabeling.annotated_datasets

Fields

The following fields are returned by SELECT queries:

projects_datasets_annotated_datasets_get

Successful response

Name	Datatype	Description
name	string	Output only. AnnotatedDataset resource name in format of: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}
annotationSource	string	Output only. Source of the annotation.
annotationType	string	Output only. Type of the annotation. It is specified when starting labeling task.
blockingResources	array	Output only. The names of any related resources that are blocking changes to the annotated dataset.
completedExampleCount	string (int64)	Output only. Number of examples that have annotation in the annotated dataset.
createTime	string (google-datetime)	Output only. Time the AnnotatedDataset was created.
description	string	Output only. The description of the AnnotatedDataset. It is specified in HumanAnnotationConfig when user starts a labeling task. Maximum of 10000 characters.
displayName	string	Output only. The display name of the AnnotatedDataset. It is specified in HumanAnnotationConfig when user starts a labeling task. Maximum of 64 characters.
exampleCount	string (int64)	Output only. Number of examples in the annotated dataset.
labelStats	object	Output only. Per label statistics. (id: GoogleCloudDatalabelingV1beta1LabelStats)
metadata	object	Output only. Additional information about AnnotatedDataset. (id: GoogleCloudDatalabelingV1beta1AnnotatedDatasetMetadata)

projects_datasets_annotated_datasets_list

Successful response

Name	Datatype	Description
name	string	Output only. AnnotatedDataset resource name in format of: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}
annotationSource	string	Output only. Source of the annotation.
annotationType	string	Output only. Type of the annotation. It is specified when starting labeling task.
blockingResources	array	Output only. The names of any related resources that are blocking changes to the annotated dataset.
completedExampleCount	string (int64)	Output only. Number of examples that have annotation in the annotated dataset.
createTime	string (google-datetime)	Output only. Time the AnnotatedDataset was created.
description	string	Output only. The description of the AnnotatedDataset. It is specified in HumanAnnotationConfig when user starts a labeling task. Maximum of 10000 characters.
displayName	string	Output only. The display name of the AnnotatedDataset. It is specified in HumanAnnotationConfig when user starts a labeling task. Maximum of 64 characters.
exampleCount	string (int64)	Output only. Number of examples in the annotated dataset.
labelStats	object	Output only. Per label statistics. (id: GoogleCloudDatalabelingV1beta1LabelStats)
metadata	object	Output only. Additional information about AnnotatedDataset. (id: GoogleCloudDatalabelingV1beta1AnnotatedDatasetMetadata)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_datasets_annotated_datasets_get	select	projectsId, datasetsId, annotatedDatasetsId		Gets an annotated dataset by resource name.
projects_datasets_annotated_datasets_list	select	projectsId, datasetsId	filter, pageSize, pageToken	Lists annotated datasets for a dataset. Pagination is supported.
projects_datasets_annotated_datasets_delete	delete	projectsId, datasetsId, annotatedDatasetsId		Deletes an annotated dataset by resource name.

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
annotatedDatasetsId	string
datasetsId	string
projectsId	string
filter	string
pageSize	integer (int32)
pageToken	string

SELECT examples

projects_datasets_annotated_datasets_get

Gets an annotated dataset by resource name.

SELECT
name,
annotationSource,
annotationType,
blockingResources,
completedExampleCount,
createTime,
description,
displayName,
exampleCount,
labelStats,
metadata
FROM google.datalabeling.annotated_datasets
WHERE projectsId = '{{ projectsId }}' -- required
AND datasetsId = '{{ datasetsId }}' -- required
AND annotatedDatasetsId = '{{ annotatedDatasetsId }}' -- required;

projects_datasets_annotated_datasets_list

Lists annotated datasets for a dataset. Pagination is supported.

SELECT
name,
annotationSource,
annotationType,
blockingResources,
completedExampleCount,
createTime,
description,
displayName,
exampleCount,
labelStats,
metadata
FROM google.datalabeling.annotated_datasets
WHERE projectsId = '{{ projectsId }}' -- required
AND datasetsId = '{{ datasetsId }}' -- required
AND filter = '{{ filter }}'
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';

DELETE examples

projects_datasets_annotated_datasets_delete

Deletes an annotated dataset by resource name.

DELETE FROM google.datalabeling.annotated_datasets
WHERE projectsId = '{{ projectsId }}' --required
AND datasetsId = '{{ datasetsId }}' --required
AND annotatedDatasetsId = '{{ annotatedDatasetsId }}' --required;