data_items

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

Overview

Name	data_items
Type	Resource
Id	google.datalabeling.data_items

Fields

The following fields are returned by SELECT queries:

projects_datasets_annotated_datasets_data_items_get

Successful response

Name	Datatype	Description
name	string	Output only. Name of the data item, in format of: projects/{project_id}/datasets/{dataset_id}/dataItems/{data_item_id}
imagePayload	object	The image payload, a container of the image bytes/uri. (id: GoogleCloudDatalabelingV1beta1ImagePayload)
textPayload	object	The text payload, a container of text content. (id: GoogleCloudDatalabelingV1beta1TextPayload)
videoPayload	object	The video payload, a container of the video uri. (id: GoogleCloudDatalabelingV1beta1VideoPayload)

projects_datasets_data_items_get

Successful response

Name	Datatype	Description
name	string	Output only. Name of the data item, in format of: projects/{project_id}/datasets/{dataset_id}/dataItems/{data_item_id}
imagePayload	object	The image payload, a container of the image bytes/uri. (id: GoogleCloudDatalabelingV1beta1ImagePayload)
textPayload	object	The text payload, a container of text content. (id: GoogleCloudDatalabelingV1beta1TextPayload)
videoPayload	object	The video payload, a container of the video uri. (id: GoogleCloudDatalabelingV1beta1VideoPayload)

projects_datasets_annotated_datasets_data_items_list

Successful response

Name	Datatype	Description
name	string	Output only. Name of the data item, in format of: projects/{project_id}/datasets/{dataset_id}/dataItems/{data_item_id}
imagePayload	object	The image payload, a container of the image bytes/uri. (id: GoogleCloudDatalabelingV1beta1ImagePayload)
textPayload	object	The text payload, a container of text content. (id: GoogleCloudDatalabelingV1beta1TextPayload)
videoPayload	object	The video payload, a container of the video uri. (id: GoogleCloudDatalabelingV1beta1VideoPayload)

projects_datasets_data_items_list

Successful response

Name	Datatype	Description
name	string	Output only. Name of the data item, in format of: projects/{project_id}/datasets/{dataset_id}/dataItems/{data_item_id}
imagePayload	object	The image payload, a container of the image bytes/uri. (id: GoogleCloudDatalabelingV1beta1ImagePayload)
textPayload	object	The text payload, a container of text content. (id: GoogleCloudDatalabelingV1beta1TextPayload)
videoPayload	object	The video payload, a container of the video uri. (id: GoogleCloudDatalabelingV1beta1VideoPayload)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_datasets_annotated_datasets_data_items_get	select	projectsId, datasetsId, annotatedDatasetsId, dataItemsId		Gets a data item in a dataset by resource name. This API can be called after data are imported into dataset.
projects_datasets_data_items_get	select	projectsId, datasetsId, dataItemsId		Gets a data item in a dataset by resource name. This API can be called after data are imported into dataset.
projects_datasets_annotated_datasets_data_items_list	select	projectsId, datasetsId, annotatedDatasetsId	filter, pageSize, pageToken	Lists data items in a dataset. This API can be called after data are imported into dataset. Pagination is supported.
projects_datasets_data_items_list	select	projectsId, datasetsId	filter, pageSize, pageToken	Lists data items in a dataset. This API can be called after data are imported into dataset. Pagination is supported.

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

SELECT examples

projects_datasets_annotated_datasets_data_items_get

Gets a data item in a dataset by resource name. This API can be called after data are imported into dataset.

SELECT
name,
imagePayload,
textPayload,
videoPayload
FROM google.datalabeling.data_items
WHERE projectsId = '{{ projectsId }}' -- required
AND datasetsId = '{{ datasetsId }}' -- required
AND annotatedDatasetsId = '{{ annotatedDatasetsId }}' -- required
AND dataItemsId = '{{ dataItemsId }}' -- required;

projects_datasets_data_items_get

Gets a data item in a dataset by resource name. This API can be called after data are imported into dataset.

SELECT
name,
imagePayload,
textPayload,
videoPayload
FROM google.datalabeling.data_items
WHERE projectsId = '{{ projectsId }}' -- required
AND datasetsId = '{{ datasetsId }}' -- required
AND dataItemsId = '{{ dataItemsId }}' -- required;

projects_datasets_annotated_datasets_data_items_list

Lists data items in a dataset. This API can be called after data are imported into dataset. Pagination is supported.

SELECT
name,
imagePayload,
textPayload,
videoPayload
FROM google.datalabeling.data_items
WHERE projectsId = '{{ projectsId }}' -- required
AND datasetsId = '{{ datasetsId }}' -- required
AND annotatedDatasetsId = '{{ annotatedDatasetsId }}' -- required
AND filter = '{{ filter }}'
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';

projects_datasets_data_items_list

Lists data items in a dataset. This API can be called after data are imported into dataset. Pagination is supported.

SELECT
name,
imagePayload,
textPayload,
videoPayload
FROM google.datalabeling.data_items
WHERE projectsId = '{{ projectsId }}' -- required
AND datasetsId = '{{ datasetsId }}' -- required
AND filter = '{{ filter }}'
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';