GOgoogle
projects

GET /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:searchDataItems

Changed on

Searches DataItems in a Dataset.

Request

  • Base URL
    https://aiplatform.googleapis.com
  • Auth
    • OAuth 2 and OAuth 2
      Implicit: https://accounts.google.com/o/oauth2/auth
      Scopes: https://www.googleapis.com/auth/aiplatform
      Authorization code: https://accounts.google.com/o/oauth2/auth
      Token URL: https://accounts.google.com/o/oauth2/token scopes: https://www.googleapis.com/auth/aiplatform
    • or OAuth 2 and OAuth 2
      Implicit: https://accounts.google.com/o/oauth2/auth
      Scopes: https://www.googleapis.com/auth/cloud-platform
      Authorization code: https://accounts.google.com/o/oauth2/auth
      Token URL: https://accounts.google.com/o/oauth2/token scopes: https://www.googleapis.com/auth/cloud-platform

Path parameters

projectsIdstring required
locationsIdstring required
datasetsIdstring required

Query parameters

annotationFiltersstring[]

An expression that specifies what Annotations will be returned per DataItem. Annotations satisfied either of the conditions will be returned. * annotation_spec_id - for = or !=. Must specify saved_query_id= - saved query id that annotations should belong to.

annotationsFilterstring

An expression for filtering the Annotations that will be returned per DataItem. * annotation_spec_id - for = or !=.

annotationsLimitinteger

If set, only up to this many of Annotations will be returned per DataItemView. The maximum value is 1000. If not set, the maximum value will be used.

dataItemFilterstring

An expression for filtering the DataItem that will be returned. * data_item_id - for = or !=. * labeled - for = or !=. * has_annotation(ANNOTATION_SPEC_ID) - true only for DataItem that have at least one annotation with annotation_spec_id = ANNOTATION_SPEC_ID in the context of SavedQuery or DataLabelingJob. For example: * data_item=1 * has_annotation(5)

dataLabelingJobstring

The resource name of a DataLabelingJob. Format: projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job} If this field is set, all of the search will be done in the context of this DataLabelingJob.

fieldMaskstring google-fieldmask

Mask specifying which fields of DataItemView to read.

orderBystring

A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending.

orderByAnnotation.orderBystring

A comma-separated list of annotation fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Must also specify saved_query.

orderByAnnotation.savedQuerystring

Required. Saved query of the Annotation. Only Annotations belong to this saved query will be considered for ordering.

orderByDataItemstring

A comma-separated list of data item fields to order by, sorted in ascending order. Use "desc" after a field name for descending.

pageSizeinteger

Requested page size. Server may return fewer results than requested. Default and maximum page size is 100.

pageTokenstring

A token identifying a page of results for the server to return Typically obtained via SearchDataItemsResponse.next_page_token of the previous DatasetService.SearchDataItems call.

savedQuerystring

The resource name of a SavedQuery(annotation set in UI). Format: projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_query} All of the search will be done in the context of this SavedQuery.

Response

Successful response

nextPageTokenstring

A token to retrieve next page of results. Pass to SearchDataItemsRequest.page_token to obtain that page.

Changes

  • 3aca3b348f0cRevision changes
    • info

      the security scope https://www.googleapis.com/auth/aiplatform was added to the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/aiplatform was added to the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was removed from the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was removed from the endpoint's security scheme Oauth2c

  • 34fcc627b062Revision changes
    • info

      the security scope https://www.googleapis.com/auth/aiplatform was added to the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/aiplatform was added to the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was removed from the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was removed from the endpoint's security scheme Oauth2c