Method: projects.locations.collections.engines.assistants.list

Lists all Assistants under an Engine.

HTTP request

GET https://discoveryengine.googleapis.com/v1alpha/{parent=projects/*/locations/*/collections/*/engines/*}/assistants

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The parent resource name. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}

Query parameters

Parameters
pageSize

integer

Maximum number of Assistants to return. If unspecified, defaults to 100. The maximum allowed value is 1000; anything above that will be coerced down to 1000.
pageToken

string

A page token ListAssistantsResponse.next_page_token, received from a previous AssistantService.ListAssistants call. Provide this to retrieve the subsequent page.

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

Request body

The request body must be empty.

Response body

Response message for the AssistantService.ListAssistants method.

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

JSON representation 
{
  "assistants": [
    {
      object (Assistant)
    }
  ],
  "nextPageToken": string
}
Fields
assistants[]

object (Assistant)

All the customer's Assistants.
nextPageToken

string

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

Authorization scopes

Requires one of the following OAuth scopes:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • discoveryengine.assistants.list

For more information, see the IAM documentation.