Method: tasks.list

Répertorie les tâches qui correspondent au filtre spécifié.

Requête HTTP

GET https://ces.googleapis.com/tasks

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de requête

Paramètres
tenant

string

Facultatif. Identifiant de routage opaque. Doit correspondre à la valeur tenant de l'AgentInterface sélectionné dans la fiche de l'agent lorsque ce champ est défini.

contextId

string

Filtrez les tâches par ID de contexte pour obtenir les tâches d'une conversation ou d'une session spécifique.

status

enum (TaskState)

Filtrer les tâches par état actuel

pageToken

string

Jeton de page reçu d'un appel tasks.list précédent. ListTasksResponse.next_page_token. Fournissez-le pour récupérer la page suivante.

statusTimestampAfter

string (Timestamp format)

Filtrez les tâches dont l'état a été mis à jour après le code temporel fourni au format ISO 8601 (par exemple, "2023-10-27T10:00:00Z"). Seules les tâches dont le code temporel de l'état est supérieur ou égal à cette valeur seront renvoyées.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

pageSize

integer

Nombre maximal de tâches à renvoyer. Le service peut renvoyer un nombre inférieur à cette valeur. Si aucune valeur n'est spécifiée, 50 tâches au maximum sont renvoyées. La valeur minimale est 1. La valeur maximale est de 100.

historyLength

integer

Nombre maximal de messages à inclure dans l'historique de chaque tâche.

includeArtifacts

boolean

Indique si les artefacts doivent être inclus dans les tâches renvoyées. La valeur par défaut est "false" pour réduire la taille de la charge utile.

Corps de la requête

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

Corps de la réponse

Objet de résultat pour la méthode tasks.list contenant un tableau de tâches et des informations de pagination.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON
{
  "tasks": [
    {
      object (Task)
    }
  ],
  "nextPageToken": string,
  "pageSize": integer,
  "totalSize": integer
}
Champs
tasks[]

object (Task)

Obligatoire. Tableau des tâches correspondant aux critères spécifiés.

nextPageToken

string

Obligatoire. Jeton permettant de récupérer la page suivante des résultats. La valeur est nulle si la liste ne contient plus de résultats.

pageSize

integer

Obligatoire. Taille de la page utilisée pour cette réponse.

totalSize

integer

Obligatoire. Nombre total de tâches disponibles (avant la pagination).

Niveaux d'accès des autorisations

Nécessite l'un des niveaux d'accès OAuth suivants :

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

Pour plus d'informations, consultez la Authentication Overview.