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

Lista todos os Agents em um Assistant que foram criados pelo caller.

Solicitação HTTP

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

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

Parâmetros de caminho

Parâmetros
parent

string

Obrigatório. O nome do recurso pai. 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 serem retornados. Se não for especificado, o padrão será 100. O valor máximo permitido é 1.000. Valores maiores serão convertidos para 1.000.
pageToken

string

Opcional. Um token de página ListAgentsResponse.next_page_token recebido de uma chamada AgentService.ListAgents anterior. Forneça isso para recuperar a página subsequente.

Ao paginar, todos os outros parâmetros fornecidos para agents.list precisam corresponder à chamada que forneceu o token da página.
orderBy

string

Opcional. Uma lista separada por vírgulas de campos para ordenar, classificados em ordem crescente. Use "desc" depois de um nome de campo para ordem decrescente. Campos compatíveis:

  • updateTime
  • isPinned

Exemplo:

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

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de ListAgentsResponse.

Escopos de autorização

Requer um dos seguintes escopos 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 Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso parent:

  • discoveryengine.agents.list

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