Skip to main content

annotated_datasets

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

Overview

Nameannotated_datasets
TypeResource
Idgoogle.datalabeling.annotated_datasets

Fields

NameDatatypeDescription
namestringOutput only. AnnotatedDataset resource name in format of: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}
descriptionstringOutput only. The description of the AnnotatedDataset. It is specified in HumanAnnotationConfig when user starts a labeling task. Maximum of 10000 characters.
annotationSourcestringOutput only. Source of the annotation.
annotationTypestringOutput only. Type of the annotation. It is specified when starting labeling task.
blockingResourcesarrayOutput only. The names of any related resources that are blocking changes to the annotated dataset.
completedExampleCountstringOutput only. Number of examples that have annotation in the annotated dataset.
createTimestringOutput only. Time the AnnotatedDataset was created.
displayNamestringOutput only. The display name of the AnnotatedDataset. It is specified in HumanAnnotationConfig when user starts a labeling task. Maximum of 64 characters.
exampleCountstringOutput only. Number of examples in the annotated dataset.
labelStatsobjectStatistics about annotation specs.
metadataobjectMetadata on AnnotatedDataset.

Methods

NameAccessible byRequired ParamsDescription
projects_datasets_annotated_datasets_getSELECTannotatedDatasetsId, datasetsId, projectsIdGets an annotated dataset by resource name.
projects_datasets_annotated_datasets_listSELECTdatasetsId, projectsIdLists annotated datasets for a dataset. Pagination is supported.
projects_datasets_annotated_datasets_deleteDELETEannotatedDatasetsId, datasetsId, projectsIdDeletes an annotated dataset by resource name.

SELECT examples

Lists annotated datasets for a dataset. Pagination is supported.

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

DELETE example

Deletes the specified annotated_datasets resource.

/*+ delete */
DELETE FROM google.datalabeling.annotated_datasets
WHERE annotatedDatasetsId = '{{ annotatedDatasetsId }}'
AND datasetsId = '{{ datasetsId }}'
AND projectsId = '{{ projectsId }}';