Method: projects.locations.apps.assistantSessions.cancelAssistantTurn

Bricht die laufende Interaktion der Assistant-Sitzung ab, falls vorhanden: der explizite Nutzerstopp für eine Interaktion, die unabhängig von einem Stream ausgeführt wird. Wenn ein Abbruch auf einer Aufgabe landet, die nicht den Turn hostet, wird er stattdessen über die Session-Turn-Epoche vorzeitig beendet, sodass er innerhalb einer Lease-Verlängerung beendet wird.

HTTP-Anfrage

POST https://ces.googleapis.com/v1beta/{name=projects/*/locations/*/apps/*/assistantSessions/*}:cancelAssistantTurn

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
name

string

Erforderlich. Die Assistant-Sitzung, deren laufender Schritt abgebrochen werden soll.

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung 
{
  "turnId": string
}
Felder
turnId

string

Optional. Der abzubrechende Zug. Wenn leer, wird der gerade ausgeführte Zug abgebrochen. Ein Abbruch, bei dem ein Zug benannt wird, der nicht mehr ausgeführt wird, ist ein No-Op.

Antworttext

Antwort für assistantSessions.cancelAssistantTurn.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung 
{
  "cancelled": boolean
}
Felder
cancelled

boolean

Ob ein laufender Turn gefunden und zum Beenden aufgefordert wurde (direkt bei dieser Aufgabe oder durch eine Epochen-Preemption für einen Turn, der an anderer Stelle gehostet wird).

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

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

Weitere Informationen finden Sie unter Authentication Overview.

IAM-Berechtigungen

Erfordert die folgende IAM-Berechtigung für die Ressource name:

  • ces.assistantSessions.get

Weitere Informationen finden Sie in der IAM-Dokumentation.