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

Liste tous les Agent sous un Assistant qui ont été créés par l'appelant.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
parent

string

Obligatoire. Nom de la ressource parente. Format : projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}

Paramètres de requête

Paramètres
pageSize

integer

Facultatif. Nombre maximal de Agent à renvoyer. Si aucune valeur n'est spécifiée, la valeur par défaut est 100. La valeur maximale autorisée est de 1 000. Toute valeur supérieure sera ramenée à 1 000.
pageToken

string

Facultatif. Jeton de page ListAgentsResponse.next_page_token reçu d'un appel AgentService.ListAgents précédent. Fournissez-le pour récupérer la page suivante.

Lors de la pagination, tous les autres paramètres fournis à agents.list doivent correspondre à l'appel ayant fourni le jeton de page.
orderBy

string

Facultatif. Liste de champs séparés par une virgule selon lesquels trier les résultats, dans l'ordre croissant. Utilisez "desc" après un nom de champ pour l'ordre décroissant. Champs acceptés :

  • updateTime
  • isPinned

Exemple :

  • "updateTime desc"
  • "isPinned desc,updateTime desc" : liste les agents par isPinned, puis par updateTime.

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient une instance de ListAgentsResponse.

Niveaux d'accès des autorisations

Nécessite l'un des champs d'application OAuth suivants :

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

Pour plus d'informations, consultez la Authentication Overview.

Autorisations IAM

Nécessite l'autorisation IAM suivante sur la ressource parent :

  • discoveryengine.agents.list

Pour en savoir plus, consultez la documentation IAM.