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

Apresenta todos os Agents de um Assistant que foram criados pelo autor da chamada.

Pedido HTTP

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

O URL usa a sintaxe de transcodificação de gRPC.

Parâmetros de caminho

Parâmetros
parent

string

Obrigatório. O nome do recurso principal. Formato: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}

Parâmetros de consulta

Parâmetros
pageSize

integer

Opcional. Número máximo de Agents a devolver. Se não for especificado, a predefinição é 100. O valor máximo permitido é 1000. Qualquer valor acima deste é forçado a ser 1000.
pageToken

string

Opcional. Um token de página ListAgentsResponse.next_page_token, recebido de uma chamada AgentService.ListAgents anterior. Faculte este valor para obter a página seguinte.

Quando paginar, todos os outros parâmetros fornecidos a agents.list têm de corresponder à chamada que forneceu o token da página.
orderBy

string

Opcional. Uma lista separada por vírgulas de campos pelos quais ordenar, ordenada por ordem ascendente. Use "desc" após um nome de campo para ordem descendente. Campos suportados:

  • updateTime
  • isPinned

Exemplo:

  • "updateTime desc"
  • "isPinned desc,updateTime desc": lista os agentes por isPinned primeiro e, em seguida, por updateTime.

Corpo do pedido

O corpo do pedido tem de estar vazio.

Corpo da resposta

Se for bem-sucedido, o corpo da resposta contém uma instância de ListAgentsResponse.

Âmbitos de autorização

Requer um dos seguintes âmbitos do OAuth:

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

Para mais informações, consulte o Authentication Overview.

Autorizações de IAM

Requer a seguinte autorização de IAM no recurso parent:

  • discoveryengine.agents.list

Para mais informações, consulte a documentação do IAM.