Method: projects.datasets.annotatedDatasets.examples.list

Lists examples in an annotated dataset. Pagination is supported.

HTTP request

GET https://datalabeling.googleapis.com/v1beta1/{parent=projects/*/datasets/*/annotatedDatasets/*}/examples

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. Example resource parent.

Authorization requires the following Google IAM permission on the specified resource parent:

  • datalabeling.examples.list

Query parameters

Parameters
filter

string

Optional. An expression for filtering Examples. For annotated datasets that have annotation spec set, filter by annotationSpec.display_name is supported. Format "annotationSpec.display_name = {displayName}"

pageSize

number

Optional. Requested page size. Server may return fewer results than requested. Default value is 100.

pageToken

string

Optional. A token identifying a page of results for the server to return. Typically obtained by ListExamplesResponse.next_page_token of the previous [DataLabelingService.ListExamples] call. Return first page if empty.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

Results of listing Examples in and annotated dataset.

JSON representation 
{
  "examples": [
    {
      object (Example)
    }
  ],
  "nextPageToken": string
}
Fields
examples[]

object (Example)

The list of examples to return.

nextPageToken

string

A token to retrieve next page of results.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.