Method: projects.locations.apps.assistantSessions.cancelAssistantTurn

Membatalkan giliran yang sedang berlangsung dalam sesi asisten, jika ada: penghentian eksplisit oleh pengguna untuk giliran yang berjalan terpisah dari streaming mana pun. Pembatalan yang mendarat pada tugas yang tidak menghosting giliran akan mendahuluinya melalui epoch giliran sesi, dan mengakhirinya dalam satu perpanjangan sewa.

Permintaan HTTP

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

URL menggunakan sintaks gRPC Transcoding.

Parameter jalur

Parameter
name

string

Wajib. Sesi asisten yang giliran dalam penerbangannya akan dibatalkan.

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON
{
  "turnId": string
}
Kolom
turnId

string

Opsional. Giliran yang akan dibatalkan; kosongkan untuk membatalkan giliran yang sedang berjalan. Pembatalan yang menyebutkan giliran yang tidak lagi berjalan tidak akan berpengaruh.

Isi respons

Respons untuk assistantSessions.cancelAssistantTurn.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON
{
  "cancelled": boolean
}
Kolom
cancelled

boolean

Apakah giliran dalam penerbangan ditemukan dan diminta untuk berhenti (langsung pada tugas ini, atau melalui preemption epoch untuk giliran yang dihosting di tempat lain).

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

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

Untuk mengetahui informasi selengkapnya, lihat Authentication Overview.

Izin IAM

Memerlukan izin IAM berikut pada resource name:

  • ces.assistantSessions.get

Untuk mengetahui informasi selengkapnya, baca dokumentasi IAM.