- Requête HTTP
- Paramètres de chemin d'accès
- Corps de la requête
- Corps de la réponse
- Niveaux d'accès des autorisations
- Autorisations IAM
Annule le tour en cours de la session de l'assistant, le cas échéant : l'arrêt explicite de l'utilisateur pour un tour s'exécutant de manière détachée de tout flux. Une annulation qui arrive sur une tâche qui n'héberge pas le tour la préempte via l'epoch du tour de session, ce qui l'arrête dans un délai d'un renouvellement de bail.
Requête HTTP
POST https://ces.googleapis.com/v1beta/{name=projects/*/locations/*/apps/*/assistantSessions/*}:cancelAssistantTurn
L'URL utilise la syntaxe de transcodage gRPC.
Paramètres de chemin d'accès
| Paramètres | |
|---|---|
name |
Obligatoire. Session de l'assistant dont le tour en cours doit être annulé. |
Corps de la requête
Le corps de la requête contient des données présentant la structure suivante :
| Représentation JSON |
|---|
{ "turnId": string } |
| Champs | |
|---|---|
turnId |
Facultatif. Tour à annuler. Si ce champ est vide, le tour en cours est annulé. Une annulation nommant un tour qui n'est plus celui en cours d'exécution est sans effet. |
Corps de la réponse
Réponse pour assistantSessions.cancelAssistantTurn.
Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :
| Représentation JSON |
|---|
{ "cancelled": boolean } |
| Champs | |
|---|---|
cancelled |
Indique si un tour en cours a été trouvé et s'il a été demandé de l'arrêter (directement sur cette tâche ou via une préemption d'epoch pour un tour hébergé ailleurs). |
Niveaux d'accès des autorisations
Nécessite l'un des niveaux d'accès OAuth suivants :
https://www.googleapis.com/auth/cloud-platformhttps://www.googleapis.com/auth/ces
Pour plus d'informations, consultez la page Authentication Overview.
Autorisations IAM
Nécessite l'autorisation IAM suivante sur la ressource name :
ces.assistantSessions.get
Pour en savoir plus, consultez la documentation IAM.