examples

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

Overview

Name	examples
Type	Resource
Id	google.datalabeling.examples

Fields

The following fields are returned by SELECT queries:

projects_datasets_annotated_datasets_examples_get

Successful response

Name	Datatype	Description
name	string	Output only. Name of the example, in format of: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}/examples/{example_id}
annotations	array	Output only. Annotations for the piece of data in Example. One piece of data can have multiple annotations.
imagePayload	object	The image payload, a container of the image bytes/uri. (id: GoogleCloudDatalabelingV1beta1ImagePayload)
textPayload	object	The text payload, a container of the text content. (id: GoogleCloudDatalabelingV1beta1TextPayload)
videoPayload	object	The video payload, a container of the video uri. (id: GoogleCloudDatalabelingV1beta1VideoPayload)

projects_datasets_annotated_datasets_examples_list

Successful response

Name	Datatype	Description
name	string	Output only. Name of the example, in format of: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}/examples/{example_id}
annotations	array	Output only. Annotations for the piece of data in Example. One piece of data can have multiple annotations.
imagePayload	object	The image payload, a container of the image bytes/uri. (id: GoogleCloudDatalabelingV1beta1ImagePayload)
textPayload	object	The text payload, a container of the 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_examples_get	select	projectsId, datasetsId, annotatedDatasetsId, examplesId	filter	Gets an example by resource name, including both data and annotation.
projects_datasets_annotated_datasets_examples_list	select	projectsId, datasetsId, annotatedDatasetsId	filter, pageSize, pageToken	Lists examples in an annotated 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
datasetsId	string
examplesId	string
projectsId	string
filter	string
pageSize	integer (int32)
pageToken	string

SELECT examples

projects_datasets_annotated_datasets_examples_get

Gets an example by resource name, including both data and annotation.

SELECT
name,
annotations,
imagePayload,
textPayload,
videoPayload
FROM google.datalabeling.examples
WHERE projectsId = '{{ projectsId }}' -- required
AND datasetsId = '{{ datasetsId }}' -- required
AND annotatedDatasetsId = '{{ annotatedDatasetsId }}' -- required
AND examplesId = '{{ examplesId }}' -- required
AND filter = '{{ filter }}';

projects_datasets_annotated_datasets_examples_list

Lists examples in an annotated dataset. Pagination is supported.

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