Method: projects.locations.apps.runAssistant

Menjalankan agen asisten untuk sesi asisten yang ditentukan.

Permintaan HTTP

POST https://ces.googleapis.com/v1beta/{app=projects/*/locations/*/apps/*}:runAssistant

URL menggunakan sintaks gRPC Transcoding.

Parameter jalur

Parameter
app

string

Wajib. Aplikasi yang akan menjalankan asisten. Format: projects/{project}/locations/{location}/apps/{app}

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON 
{
  "assistantSession": string,
  "message": {
    object (AssistantMessage)
  },
  "interactionType": enum (RunAssistantRequest.InteractionType)
}
Kolom
assistantSession

string

Wajib. Sesi asisten yang akan digunakan untuk menjalankan asisten. Format: projects/{project}/locations/{location}/apps/{app}/assistantSessions/{assistantSession}
message

object (AssistantMessage)

Wajib. Pesan yang akan dikirim ke agen asisten.
interactionType

enum (RunAssistantRequest.InteractionType)

Opsional. Jenis interaksi yang berbeda untuk pesan asisten.

Isi respons

Pesan respons untuk AssistantService.RunAssistant.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "output": {
    object (AssistantOutput)
  },
  "state": enum (AssistantSessionState)
}
Kolom
output

object (AssistantOutput)

Wajib. Output dari agen asisten.
state

enum (AssistantSessionState)

Hanya output. Status sesi asisten.

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 app:

  • ces.apps.update

Untuk mengetahui informasi selengkapnya, baca dokumentasi IAM.

RunAssistantRequest.InteractionType

Jenis interaksi untuk pesan yang dikirim ke asisten.

Enum
INTERACTION_TYPE_UNSPECIFIED Nilai default. Nilai ini digunakan jika jenisnya tidak ditentukan.
NEW_MESSAGE Pesan tersebut adalah input pengguna. Input pengguna diberikan dalam daftar potongan.
POLL Pesan ini digunakan untuk melakukan polling status sesi asisten.
DISMISS Pesan ini untuk menutup sesi asisten yang menunggu peninjauan. Tindakan ini akan mengubah status sesi asisten menjadi tidak ada aktivitas.

AssistantOutput

Output dari agen asisten.

Representasi JSON 
{
  "message": {
    object (AssistantMessage)
  },
  "userResponseSuggestions": {
    object (UserResponseSuggestions)
  }
}
Kolom
message

object (AssistantMessage)

Wajib. Respons dari agen asisten.
userResponseSuggestions

object (UserResponseSuggestions)

Hanya output. Respons pengguna yang disarankan dari agen asisten.