Method: projects.locations.corpora.collections.list

Lists collections inside a corpus.

HTTP request

GET https://visionai.googleapis.com/v1alpha1/{parent=projects/*/locations/*/corpora/*}/collections

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The parent corpus. Format: projects/{project_number}/locations/{location}/corpora/{corpus}

Query parameters

Parameters
pageSize

integer

The maximum number of collections to return. The service may return fewer than this value. If unspecified, at most 50 collections will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken

string

A page token, received from a previous ListCollectionsRequest call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListCollectionsRequest must match the call that provided the page token.

Request body

The request body must be empty.

Response body

Response message for collections.list.

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

JSON representation 
{
  "collections": [
    {
      object (Collection)
    }
  ],
  "nextPageToken": string
}
Fields
collections[]

object (Collection)

The collections from the specified corpus.
nextPageToken

string

A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.