Method: projects.sendInteraction

Memutar percakapan dalam satu putaran.

Permintaan HTTP

POST https://actions.googleapis.com/v2/{project=projects/*}:sendInteraction

URL menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
project

string

Wajib. Project yang sedang diuji, ditunjukkan dengan Project ID. Format: projects/{project}

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON
{
  "input": {
    object (UserInput)
  },
  "deviceProperties": {
    object (DeviceProperties)
  },
  "conversationToken": string
}
Kolom
input

object (UserInput)

Wajib. Input yang diberikan oleh pengguna.

deviceProperties

object (DeviceProperties)

Wajib. Properti perangkat yang digunakan untuk berinteraksi dengan Action.

conversationToken

string

Token buram yang harus diteruskan seperti yang diterima dari SendInteractionResponse pada interaksi sebelumnya. Tindakan ini dapat dibatalkan penetapannya agar dapat memulai percakapan baru, baik sebagai interaksi pertama sesi pengujian atau untuk meninggalkan percakapan sebelumnya dan memulai percakapan baru.

Isi respons

Jika berhasil, isi respons memuat data dengan struktur berikut:

Respons untuk sekumpulan percakapan.

Representasi JSON
{
  "output": {
    object (Output)
  },
  "diagnostics": {
    object (Diagnostics)
  },
  "conversationToken": string
}
Kolom
output

object (Output)

Output yang diberikan kepada pengguna.

diagnostics

object (Diagnostics)

Informasi diagnostik yang menjelaskan cara penanganan permintaan.

conversationToken

string

Token buram akan ditetapkan di SendInteractionRequest pada panggilan RPC berikutnya untuk melanjutkan percakapan yang sama.

UserInput

Input pengguna yang diberikan selama sesi percakapan.

Representasi JSON
{
  "query": string,
  "type": enum (InputType)
}
Kolom
query

string

Konten input yang dikirim oleh pengguna.

type

enum (InputType)

Jenis input.

InputType

Menunjukkan sumber input, kueri yang diketik, atau kueri suara.

Enum
INPUT_TYPE_UNSPECIFIED Sumber input tidak ditentukan.
TOUCH Kueri dari interaksi GUI.
VOICE Kueri suara.
KEYBOARD Kueri yang diketik.
URL Tindakan dipicu oleh link URL.

DeviceProperties

Properti perangkat yang relevan dengan putaran percakapan.

Representasi JSON
{
  "surface": enum (Surface),
  "location": {
    object (Location)
  },
  "locale": string,
  "timeZone": string
}
Kolom
surface

enum (Surface)

Platform yang digunakan untuk berinteraksi dengan Action.

location

object (Location)

Lokasi perangkat seperti lintang, bujur, dan alamat berformat.

locale

string

Lokalitas yang disetel di perangkat. Formatnya harus mengikuti BCP 47: https://tools.ietf.org/html/bcp47 Contoh: en, en-US, es-419 (contoh lainnya di https://tools.ietf.org/html/bcp47#appendix-A).

timeZone

string

Zona waktu yang disetel di perangkat. Formatnya harus mengikuti Database Zona Waktu IANA, misalnya "America/New_York": https://www.iana.org/time-zones

Platform

Platform yang mungkin digunakan untuk berinteraksi dengan Action. Nilai tambahan dapat disertakan di masa mendatang.

Enum
SURFACE_UNSPECIFIED Nilai default. Nilai ini tidak digunakan.
SPEAKER Speaker (misalnya, Google Home).
PHONE Ponsel.
ALLO Chat Allo.
SMART_DISPLAY Perangkat Layar Smart.
KAI_OS KaiOS.

Lokasi

Penampung yang mewakili lokasi.

Representasi JSON
{
  "coordinates": {
    object (LatLng)
  },
  "formattedAddress": string,
  "zipCode": string,
  "city": string
}
Kolom
coordinates

object (LatLng)

Koordinat geografis. Memerlukan izin [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION].

formattedAddress

string

Alamat tampilan, misalnya, "1600 Amphitheatre Pkwy, Mountain View, CA 94043". Memerlukan izin [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION].

zipCode

string

Kode pos. Memerlukan izin [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION] atau [DEVICE_COARSE_LOCATION] [google.actions.v2.Permission.DEVICE_COARSE_LOCATION].

city

string

Kota. Memerlukan izin [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION] atau [DEVICE_COARSE_LOCATION] [google.actions.v2.Permission.DEVICE_COARSE_LOCATION].

LatLng

Objek yang merepresentasikan pasangan garis lintang/bujur. Objek ini dinyatakan sebagai pasangan double untuk mewakili derajat lintang dan derajat bujur. Kecuali ditentukan lain, objek ini harus sesuai dengan standar WGS84. Nilai harus berada dalam rentang yang dinormalisasi.

Representasi JSON
{
  "latitude": number,
  "longitude": number
}
Kolom
latitude

number

Lintang dalam derajat. Harus dalam rentang [-90.0, +90.0].

longitude

number

Bujur dalam derajat. Harus dalam rentang [-180.0, +180.0].

Output

Output yang terlihat oleh pengguna pada sesi percakapan.

Representasi JSON
{
  "text": string,
  "speech": [
    string
  ],
  "canvas": {
    object (Canvas)
  },
  "actionsBuilderPrompt": {
    object (Prompt)
  }
}
Kolom
text

string

Respons lisan yang dikirim ke pengguna sebagai string biasa.

speech[]

string

Konten ucapan yang dihasilkan oleh Action. Ini mungkin termasuk elemen markup seperti SSML.

canvas

object (Canvas)

Konten Canvas interaktif.

actionsBuilderPrompt

object (Prompt)

Status perintah di akhir sesi percakapan. Informasi selengkapnya tentang perintah: https://developers.google.com/assistant/conversational/prompts

Canvas

Mewakili respons Canvas Interaktif untuk dikirim ke pengguna. Ini dapat digunakan bersama dengan kolom "firstSimple" di perintah yang berisi untuk berbicara dengan pengguna selain menampilkan respons kanvas interaktif. Ukuran maksimum respons adalah 50 ribu byte.

Representasi JSON
{
  "url": string,
  "data": [
    value
  ],
  "suppressMic": boolean,
  "enableFullScreen": boolean
}
Kolom
url

string

URL aplikasi web kanvas interaktif yang akan dimuat. Jika tidak ditetapkan, URL dari kanvas aktif saat ini akan digunakan kembali.

data[]

value (Value format)

Opsional. Data JSON yang akan diteruskan ke halaman web pengalaman imersif sebagai peristiwa. Jika kolom "override" di perintah yang memuatnya adalah nilai data "salah" yang ditentukan dalam perintah Canvas ini akan ditambahkan setelah nilai data yang ditentukan dalam perintah Canvas sebelumnya.

suppressMic

boolean

Opsional. Nilai default: false.

enableFullScreen

boolean

Jika true, aplikasi kanvas akan menempati layar penuh dan tidak akan memiliki header di bagian atas. Pesan toast juga akan ditampilkan di layar pemuatan yang menyertakan nama tampilan Action, nama developer, dan petunjuk untuk keluar dari Action. Nilai default: false.

Prompt

Merepresentasikan respons kepada pengguna.

Representasi JSON
{
  "append": boolean,
  "override": boolean,
  "firstSimple": {
    object (Simple)
  },
  "content": {
    object (Content)
  },
  "lastSimple": {
    object (Simple)
  },
  "suggestions": [
    {
      object (Suggestion)
    }
  ],
  "link": {
    object (Link)
  },
  "canvas": {
    object (Canvas)
  }
}
Kolom
append
(deprecated)

boolean

Opsional. Mode penggabungan pesan ini dengan pesan yang telah ditentukan sebelumnya. "false" akan menghapus semua pesan yang ditentukan sebelumnya (pertama dan terakhir, konten, link saran, dan kanvas) serta menambahkan pesan yang ditentukan dalam perintah ini. "true" akan menambahkan pesan yang ditentukan dalam prompt ini ke pesan yang ditentukan dalam respons sebelumnya. Menyetel kolom ini ke "true" juga akan memungkinkan penambahan ke beberapa kolom di dalam prompt Simple, prompt Suggestion, dan prompt Canvas (bagian dari prompt Content). Pesan Content dan Link akan selalu ditimpa jika ditentukan dalam perintah. Nilai defaultnya adalah "false".

override

boolean

Opsional. Mode penggabungan pesan ini dengan pesan yang telah ditentukan sebelumnya. "true" menghapus semua pesan yang ditentukan sebelumnya (pertama dan terakhir, konten, link saran, dan kanvas) serta menambahkan pesan yang ditentukan dalam perintah ini. "false" menambahkan pesan yang ditentukan dalam permintaan ini ke pesan yang ditentukan dalam respons sebelumnya. Membiarkan kolom ini ke "false" juga memungkinkan penambahan ke beberapa kolom di dalam prompt Sederhana, prompt Saran, dan perintah Canvas (bagian dari perintah Konten). Pesan Content dan Link selalu ditimpa jika ditentukan dalam perintah. Nilai defaultnya adalah "false".

firstSimple

object (Simple)

Opsional. Respons pertama yang hanya berisi teks dan suara.

content

object (Content)

Opsional. Konten seperti kartu, daftar, atau media yang akan ditampilkan kepada pengguna.

lastSimple

object (Simple)

Opsional. Respons terakhir yang hanya berupa teks dan suara.

suggestions[]

object (Suggestion)

Opsional. Saran yang akan ditampilkan kepada pengguna yang akan selalu muncul di akhir respons. Jika kolom "ganti" di perintah yang memuatnya adalah "false", judul yang ditentukan di kolom ini akan ditambahkan ke judul yang ditentukan di perintah saran yang ditentukan sebelumnya dan nilai duplikat akan dihapus.

canvas

object (Canvas)

Opsional. Mewakili respons Canvas Interaktif untuk dikirim ke pengguna.

Simple

Menampilkan perintah sederhana yang akan dikirim ke pengguna.

Representasi JSON
{
  "speech": string,
  "text": string
}
Kolom
speech

string

Opsional. Merepresentasikan ucapan yang akan diucapkan kepada pengguna. Dapat berupa SSML atau text to speech. Jika kolom "ganti" di perintah yang memuatnya adalah "true", ucapan yang ditentukan dalam kolom ini akan menggantikan ucapan perintah Sederhana sebelumnya.

text

string

Teks opsional yang akan ditampilkan dalam balon chat. Jika tidak diberikan, rendering tampilan untuk kolom ucapan di atas akan digunakan. Dibatasi hingga 640 karakter. Jika kolom "override" di perintah yang memuatnya adalah "true", teks yang ditentukan dalam kolom ini akan menggantikan teks prompt Sederhana sebelumnya.

Konten

Konten yang akan ditampilkan.

Representasi JSON
{

  // Union field content can be only one of the following:
  "card": {
    object (Card)
  },
  "image": {
    object (Image)
  },
  "table": {
    object (Table)
  },
  "media": {
    object (Media)
  },
  "canvas": {
    object (Canvas)
  },
  "collection": {
    object (Collection)
  },
  "list": {
    object (List)
  }
  // End of list of possible types for union field content.
}
Kolom
Kolom union content. Konten. content hanya ada berupa salah satu diantara berikut:
card

object (Card)

Kartu dasar.

image

object (Image)

Gambar.

table

object (Table)

Kartu tabel.

media

object (Media)

Respons yang menunjukkan sekumpulan media yang akan diputar.

canvas
(deprecated)

object (Canvas)

Respons yang akan digunakan untuk pengalaman kanvas interaktif.

collection

object (Collection)

Kartu yang menampilkan kumpulan opsi untuk dipilih.

list

object (List)

Kartu yang menampilkan daftar opsi untuk dipilih.

Kartu

Kartu dasar untuk menampilkan beberapa informasi, misalnya gambar dan/atau teks.

Representasi JSON
{
  "title": string,
  "subtitle": string,
  "text": string,
  "image": {
    object (Image)
  },
  "imageFill": enum (ImageFill),
  "button": {
    object (Link)
  }
}
Kolom
title

string

Judul kartu secara keseluruhan. Opsional.

subtitle

string

Opsional.

text

string

Teks isi kartu. Mendukung serangkaian sintaksis markdown terbatas untuk pemformatan. Wajib, kecuali jika ada gambar.

image

object (Image)

Banner besar untuk kartu. Tingginya ditetapkan ke 192 dp. Opsional.

imageFill

enum (ImageFill)

Cara mengisi latar belakang gambar. Opsional.

button

object (Link)

Tombol. Opsional.

Gambar

Gambar yang ditampilkan di kartu.

Representasi JSON
{
  "url": string,
  "alt": string,
  "height": integer,
  "width": integer
}
Kolom
url

string

URL sumber gambar. Gambar dapat berupa JPG, PNG, dan GIF (animasi dan non-animasi). Misalnya,https://www.agentx.com/logo.png. Wajib.

alt

string

Deskripsi teks dari gambar yang akan digunakan untuk aksesibilitas, misalnya pembaca layar. Wajib.

height

integer

Tinggi gambar dalam piksel. Opsional.

width

integer

Lebar gambar dalam piksel. Opsional.

ImageFill

Kemungkinan opsi tampilan gambar untuk memengaruhi penyajian gambar. Ini harus digunakan saat rasio aspek gambar tidak cocok dengan rasio aspek penampung gambar.

Enum
UNSPECIFIED Isi gambar tidak ditentukan.
GRAY Isi celah antara gambar dan penampung gambar dengan batang abu-abu.
WHITE Isi celah antara gambar dan penampung gambar dengan batang putih.
CROPPED Gambar diskalakan sedemikian rupa sehingga lebar dan tinggi gambar sesuai atau melebihi dimensi penampung. Tindakan ini dapat memangkas bagian atas dan bawah gambar jika tinggi gambar yang diskalakan lebih besar dari tinggi penampung, atau memangkas bagian kiri dan kanan gambar jika lebar gambar yang diskalakan lebih besar dari lebar penampung. Ini mirip dengan "Mode Zoom" di TV layar lebar saat memutar video 4:3.

OpenUrl

Tindakan yang diambil saat pengguna membuka link.

Representasi JSON
{
  "url": string,
  "hint": enum (UrlHint)
}
Kolom
url

string

Kolom URL yang dapat berupa salah satu dari: - URL http/https untuk membuka Aplikasi atau halaman web yang ditautkan ke Aplikasi

hint

enum (UrlHint)

Menunjukkan petunjuk untuk jenis URL.

UrlHint

Berbagai jenis petunjuk URL.

Enum
AMP URL yang mengarah langsung ke konten AMP, atau ke URL kanonis yang merujuk ke konten AMP melalui .

Tabel

Kartu tabel untuk menampilkan tabel teks.

Representasi JSON
{
  "title": string,
  "subtitle": string,
  "image": {
    object (Image)
  },
  "columns": [
    {
      object (TableColumn)
    }
  ],
  "rows": [
    {
      object (TableRow)
    }
  ],
  "button": {
    object (Link)
  }
}
Kolom
title

string

Judul tabel secara keseluruhan. Opsional, tetapi harus disetel jika subtitel telah disetel.

subtitle

string

Subtitel untuk tabel. Opsional.

image

object (Image)

Gambar yang terkait dengan tabel. Opsional.

columns[]

object (TableColumn)

Header dan perataan kolom.

rows[]

object (TableRow)

Data baris dalam tabel. 3 baris pertama dijamin akan ditampilkan, tetapi baris lainnya mungkin terpotong pada permukaan tertentu. Uji dengan simulator untuk melihat baris mana yang akan ditampilkan untuk platform tertentu. Pada platform yang mendukung kemampuan WEB_BROWSER, Anda dapat mengarahkan pengguna ke laman web yang berisi lebih banyak data.

button

object (Link)

Tombol.

TableColumn

Menjelaskan kolom dalam tabel.

Representasi JSON
{
  "header": string,
  "align": enum (HorizontalAlignment)
}
Kolom
header

string

Teks header untuk kolom.

align

enum (HorizontalAlignment)

Perataan horizontal kolom konten. Jika tidak ditentukan, konten akan disejajarkan dengan tepi depan.

HorizontalAlignment

Perataan konten dalam sel.

Enum
UNSPECIFIED Perataan horizontal tidak ditentukan.
LEADING Tepi depan sel. Ini adalah defaultnya.
CENTER Konten sejajar dengan bagian tengah kolom.
TRAILING Konten disejajarkan dengan tepi akhir kolom.

TableRow

Menjelaskan baris dalam tabel.

Representasi JSON
{
  "cells": [
    {
      object (TableCell)
    }
  ],
  "divider": boolean
}
Kolom
cells[]

object (TableCell)

Sel dalam baris ini. 3 sel pertama dijamin akan ditampilkan, tetapi sel lainnya mungkin terpotong pada permukaan tertentu. Uji dengan simulator untuk melihat sel mana yang akan ditampilkan untuk permukaan tertentu.

divider

boolean

Menunjukkan apakah harus ada pemisah setelah setiap baris.

TableCell

Menjelaskan sel secara berurutan.

Representasi JSON
{
  "text": string
}
Kolom
text

string

Konten teks di sel.

Media

Mewakili satu objek media. Berisi informasi tentang media, seperti nama, deskripsi, URL, dll.

Representasi JSON
{
  "mediaType": enum (MediaType),
  "startOffset": string,
  "optionalMediaControls": [
    enum (OptionalMediaControls)
  ],
  "mediaObjects": [
    {
      object (MediaObject)
    }
  ]
}
Kolom
mediaType

enum (MediaType)

Jenis media.

startOffset

string (Duration format)

Offset awal objek media pertama.

Durasi dalam detik dengan maksimal sembilan digit pecahan, yang diakhiri dengan 's'. Contoh: "3.5s".

optionalMediaControls[]

enum (OptionalMediaControls)

Jenis kontrol media opsional yang dapat didukung sesi respons media ini. Jika ditetapkan, permintaan akan dibuat ke pihak ketiga saat peristiwa media tertentu terjadi. Jika tidak disetel, 3p masih harus menangani dua jenis kontrol default, FINISHED dan FAILED.

mediaObjects[]

object (MediaObject)

Daftar Objek Media

MediaType

Jenis media respons ini.

Enum
MEDIA_TYPE_UNSPECIFIED Jenis media belum ditentukan.
AUDIO File audio.
MEDIA_STATUS_ACK Respons untuk mengonfirmasi laporan status media.

OptionalMediaControls

Jenis kontrol media opsional yang dapat didukung respons media

Enum
OPTIONAL_MEDIA_CONTROLS_UNSPECIFIED Nilai belum ditetapkan
PAUSED Acara dijeda. Dipicu saat pengguna menjeda media.
STOPPED Acara yang dihentikan. Dipicu saat pengguna keluar dari sesi 3p selama pemutaran media.

MediaObject

Mewakili satu objek media

Representasi JSON
{
  "name": string,
  "description": string,
  "url": string,
  "image": {
    object (MediaImage)
  }
}
Kolom
name

string

Nama objek media ini.

description

string

Deskripsi objek media ini.

url

string

URL yang mengarah ke konten media.

image

object (MediaImage)

Gambar yang akan ditampilkan dengan kartu media.

MediaImage

Gambar yang akan ditampilkan dengan kartu media.

Representasi JSON
{

  // Union field image can be only one of the following:
  "large": {
    object (Image)
  },
  "icon": {
    object (Image)
  }
  // End of list of possible types for union field image.
}
Kolom
Kolom union image. Gambar. image hanya ada berupa salah satu diantara berikut:
large

object (Image)

Gambar besar, seperti sampul album, dll.

icon

object (Image)

Ikon gambar kecil ditampilkan di sebelah kanan dari judul. Ukurannya diubah menjadi 36x36 dp.

Collection

Kartu untuk menampilkan kumpulan opsi yang dapat dipilih.

Representasi JSON
{
  "title": string,
  "subtitle": string,
  "items": [
    {
      object (CollectionItem)
    }
  ],
  "imageFill": enum (ImageFill)
}
Kolom
title

string

Judul koleksi. Opsional.

subtitle

string

Subtitel koleksi. Opsional.

items[]

object (CollectionItem)

min: 2 maks: 10

imageFill

enum (ImageFill)

Cara mengisi latar belakang gambar item koleksi. Opsional.

CollectionItem

Item dalam koleksi

Representasi JSON
{
  "key": string
}
Kolom
key

string

Wajib. Kunci NLU yang cocok dengan nama kunci entri dalam Jenis terkait.

Daftar

Kartu untuk menampilkan daftar opsi yang dapat dipilih.

Representasi JSON
{
  "title": string,
  "subtitle": string,
  "items": [
    {
      object (ListItem)
    }
  ]
}
Kolom
title

string

Judul daftar. Opsional.

subtitle

string

Subtitel daftar. Opsional.

items[]

object (ListItem)

min: 2 maks: 30

ListItem

Item dalam daftar

Representasi JSON
{
  "key": string
}
Kolom
key

string

Wajib. Kunci NLU yang cocok dengan nama kunci entri dalam Jenis terkait.

Saran

Saran input untuk ditampilkan kepada pengguna.

Representasi JSON
{
  "title": string
}
Kolom
title

string

Wajib. Teks yang ditampilkan di chip saran. Saat diketuk, teks ini akan diposting kembali ke percakapan kata demi kata seolah-olah pengguna telah mengetiknya. Setiap judul harus unik di antara kumpulan chip saran. Maks 25 karakter

Diagnostik

Informasi diagnostik yang terkait dengan sesi percakapan.

Representasi JSON
{
  "actionsBuilderEvents": [
    {
      object (ExecutionEvent)
    }
  ]
}
Kolom
actionsBuilderEvents[]

object (ExecutionEvent)

Daftar peristiwa dengan detail tentang pemrosesan percakapan di seluruh tahapan model interaksi Action Builder. Diisi hanya untuk aplikasi Actions Builder & Actions SDK.

ExecutionEvent

Berisi informasi tentang peristiwa eksekusi yang terjadi selama memproses permintaan percakapan Action Builder. Untuk ringkasan tahap-tahap yang terlibat dalam permintaan percakapan, lihat https://developers.google.com/assistant/conversational/actions.

Representasi JSON
{
  "eventTime": string,
  "executionState": {
    object (ExecutionState)
  },
  "status": {
    object (Status)
  },
  "warningMessages": [
    string
  ],

  // Union field EventData can be only one of the following:
  "userInput": {
    object (UserConversationInput)
  },
  "intentMatch": {
    object (IntentMatch)
  },
  "conditionsEvaluated": {
    object (ConditionsEvaluated)
  },
  "onSceneEnter": {
    object (OnSceneEnter)
  },
  "webhookRequest": {
    object (WebhookRequest)
  },
  "webhookResponse": {
    object (WebhookResponse)
  },
  "webhookInitiatedTransition": {
    object (WebhookInitiatedTransition)
  },
  "slotMatch": {
    object (SlotMatch)
  },
  "slotRequested": {
    object (SlotRequested)
  },
  "slotValidated": {
    object (SlotValidated)
  },
  "formFilled": {
    object (FormFilled)
  },
  "waitingUserInput": {
    object (WaitingForUserInput)
  },
  "endConversation": {
    object (EndConversation)
  }
  // End of list of possible types for union field EventData.
}
Kolom
eventTime

string (Timestamp format)

Stempel waktu saat peristiwa terjadi.

Stempel waktu dalam format RFC3339 UTC "Zulu", dengan resolusi nanodetik dan hingga sembilan digit pecahan. Contoh: "2014-10-02T15:01:23Z" dan "2014-10-02T15:01:23.045123456Z".

executionState

object (ExecutionState)

Status eksekusi selama peristiwa ini.

status

object (Status)

Status hasil dari langkah eksekusi tertentu.

warningMessages[]

string

Daftar peringatan yang dihasilkan selama eksekusi Peristiwa ini. Peringatan adalah tips yang ditemukan developer selama permintaan percakapan. Hal ini biasanya tidak bersifat penting dan tidak menghentikan eksekusi permintaan. Misalnya, peringatan mungkin akan dihasilkan saat webhook mencoba mengganti Jenis kustom yang tidak ada. Error dilaporkan sebagai kode status gagal, tetapi peringatan dapat muncul meskipun statusnya Oke.

Kolom union EventData. Informasi terperinci khusus untuk berbagai acara yang mungkin terlibat dalam pemrosesan suatu percakapan. Kolom yang ditetapkan di sini menentukan jenis peristiwa ini. EventData hanya ada berupa salah satu diantara berikut:
userInput

object (UserConversationInput)

Peristiwa penanganan input pengguna.

intentMatch

object (IntentMatch)

Peristiwa pencocokan intent.

conditionsEvaluated

object (ConditionsEvaluated)

Peristiwa evaluasi kondisi.

onSceneEnter

object (OnSceneEnter)

Peristiwa eksekusi OnSceneEnter.

webhookRequest

object (WebhookRequest)

Peristiwa pengiriman permintaan webhook.

webhookResponse

object (WebhookResponse)

Peristiwa tanda terima respons webhook.

webhookInitiatedTransition

object (WebhookInitiatedTransition)

Peristiwa transisi yang dimulai webhook.

slotMatch

object (SlotMatch)

Peristiwa pencocokan slot.

slotRequested

object (SlotRequested)

Peristiwa permintaan slot.

slotValidated

object (SlotValidated)

Peristiwa validasi slot.

formFilled

object (FormFilled)

Peristiwa pengisian formulir.

waitingUserInput

object (WaitingForUserInput)

Menunggu peristiwa input pengguna.

endConversation

object (EndConversation)

Acara akhir percakapan.

ExecutionState

Status eksekusi saat ini.

Representasi JSON
{
  "currentSceneId": string,
  "sessionStorage": {
    object
  },
  "slots": {
    object (Slots)
  },
  "promptQueue": [
    {
      object (Prompt)
    }
  ],
  "userStorage": {
    object
  },
  "householdStorage": {
    object
  }
}
Kolom
currentSceneId

string

ID adegan yang saat ini aktif.

sessionStorage

object (Struct format)

Status penyimpanan sesi: https://developers.google.com/assistant/conversational/storage-session

slots

object (Slots)

Status pengisian slot, jika ada: https://developers.google.com/assistant/conversational/scenes#slot_filling

promptQueue[]

object (Prompt)

Antrean permintaan: https://developers.google.com/assistant/conversational/prompts

userStorage

object (Struct format)

Status penyimpanan pengguna: https://developers.google.com/assistant/conversational/storage-user

householdStorage

object (Struct format)

Status penyimpanan utama: https://developers.google.com/assistant/conversational/storage-home

Slot

Mewakili status slot adegan saat ini.

Representasi JSON
{
  "status": enum (SlotFillingStatus),
  "slots": {
    string: {
      object (Slot)
    },
    ...
  }
}
Kolom
status

enum (SlotFillingStatus)

Status pengisian slot saat ini.

slots

map (key: string, value: object (Slot))

Slot yang terkait dengan adegan saat ini.

Objek yang berisi daftar pasangan "key": value. Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

SlotFillingStatus

Menyatakan status pengisian slot saat ini.

Enum
UNSPECIFIED Nilai penggantian saat kolom penggunaan tidak diisi.
INITIALIZED Slot telah diinisialisasi tetapi pengisian slot belum dimulai.
COLLECTING Nilai slot sedang dikumpulkan.
FINAL Semua nilai slot bersifat final dan tidak dapat diubah.

Slot

Merepresentasikan slot.

Representasi JSON
{
  "mode": enum (SlotMode),
  "status": enum (SlotStatus),
  "value": value,
  "updated": boolean,
  "prompt": {
    object (Prompt)
  }
}
Kolom
mode

enum (SlotMode)

Mode slot (wajib atau opsional). Dapat disetel oleh developer.

status

enum (SlotStatus)

Status slot.

value

value (Value format)

Nilai slot. Mengubah nilai ini dalam respons akan mengubah nilai dalam pengisian slot.

updated

boolean

Menunjukkan apakah nilai slot dikumpulkan pada belokan terakhir. Kolom ini bersifat hanya baca.

prompt

object (Prompt)

Opsional. Permintaan ini dikirim ke pengguna saat diperlukan untuk mengisi slot yang diperlukan. Prompt ini akan menggantikan prompt yang ada yang ditentukan dalam console. Kolom ini tidak disertakan dalam permintaan webhook.

SlotMode

Mewakili mode slot, yaitu, apakah diperlukan atau tidak.

Enum
MODE_UNSPECIFIED Nilai penggantian saat kolom penggunaan tidak diisi.
OPTIONAL Menunjukkan bahwa slot tidak diwajibkan untuk menyelesaikan pengisian slot.
REQUIRED Menunjukkan bahwa slot diperlukan untuk menyelesaikan pengisian slot.

SlotStatus

Mewakili status slot.

Enum
SLOT_UNSPECIFIED Nilai penggantian saat kolom penggunaan tidak diisi.
EMPTY Menunjukkan bahwa slot tidak memiliki nilai apa pun. Status ini tidak dapat diubah melalui respons.
INVALID Menunjukkan bahwa nilai slot tidak valid. Status ini dapat ditetapkan melalui respons.
FILLED Menunjukkan bahwa slot memiliki nilai. Status ini tidak dapat diubah melalui respons.

Status

Jenis Status menentukan model error logis yang cocok untuk berbagai lingkungan pemrograman, meliputi REST API dan RPC API. Jenis error ini digunakan oleh gRPC. Setiap pesan Status berisi tiga bagian data: kode error, pesan error, dan detail error.

Anda dapat mencari tahu lebih lanjut tentang model error ini dan cara penanganannya di Panduan Desain API.

Representasi JSON
{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
Kolom
code

integer

Kode status, harus berupa nilai enum dari google.rpc.Code.

message

string

Pesan error yang ditampilkan ke developer dan seharusnya dalam bahasa Inggris. Setiap pesan error yang ditampilkan kepada pengguna harus dilokalkan dan dikirim di kolom google.rpc.Status.details, atau dilokalkan oleh klien.

details[]

object

Daftar pesan yang membawa detail error. Ada seperangkat jenis pesan umum untuk digunakan API.

Objek yang berisi kolom tipe arbitrer. Kolom tambahan "@type" berisi URI yang mengidentifikasi jenis. Contoh: { "id": 1234, "@type": "types.example.com/standard/id" }.

UserConversationInput

Informasi yang terkait dengan input pengguna.

Representasi JSON
{
  "type": string,
  "originalQuery": string
}
Kolom
type

string

Jenis input pengguna. Misalnya keyboard, suara, sentuh, dll.

originalQuery

string

Input teks asli dari pengguna.

IntentMatch

Informasi tentang pencocokan intent yang dipicu (global atau dalam scene): https://developers.google.com/assistant/conversational/intents

Representasi JSON
{
  "intentId": string,
  "intentParameters": {
    string: {
      object (IntentParameterValue)
    },
    ...
  },
  "handler": string,
  "nextSceneId": string
}
Kolom
intentId

string

ID intent yang memicu interaksi ini.

intentParameters

map (key: string, value: object (IntentParameterValue))

Parameter intent yang memicu interaksi ini.

Objek yang berisi daftar pasangan "key": value. Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

handler

string

Nama pengendali yang dilampirkan ke interaksi ini.

nextSceneId

string

Suasana yang menjadi tujuan interaksi ini.

ConditionsEvaluated

Hasil evaluasi kondisi: https://developers.google.com/assistant/conversational/scenes#conditions

Representasi JSON
{
  "failedConditions": [
    {
      object (Condition)
    }
  ],
  "successCondition": {
    object (Condition)
  }
}
Kolom
failedConditions[]

object (Condition)

Daftar kondisi yang dievaluasi ke 'false'.

successCondition

object (Condition)

Kondisi pertama yang dievaluasi ke 'true', jika ada.

Kondisi

Kondisi yang dievaluasi.

Representasi JSON
{
  "expression": string,
  "handler": string,
  "nextSceneId": string
}
Kolom
expression

string

Ekspresi yang ditentukan dalam kondisi ini.

handler

string

Nama pengendali yang ditentukan dalam kondisi yang dievaluasi.

nextSceneId

string

Scene tujuan ditentukan dalam kondisi yang dievaluasi.

OnSceneEnter

Informasi tentang eksekusi tahap onSceneEnter: https://developers.google.com/assistant/conversational/scenes#onEnter

Representasi JSON
{
  "handler": string
}
Kolom
handler

string

Nama pengendali yang ditentukan dalam peristiwa onSceneEnter.

WebhookRequest

Informasi tentang permintaan yang dikirimkan ke webhook Action: https://developers.google.com/assistant/conversational/webhooks#payloads

Representasi JSON
{
  "requestJson": string
}
Kolom
requestJson

string

Payload permintaan webhook.

WebhookResponse

Informasi tentang respons yang diterima dari webhook Action: https://developers.google.com/assistant/conversational/webhooks#payloads

Representasi JSON
{
  "responseJson": string
}
Kolom
responseJson

string

Payload respons webhook.

WebhookInitiatedTransition

Peristiwa yang dipicu oleh scene tujuan yang ditampilkan dari webhook: https://developers.google.com/assistant/conversational/webhooks#transition_scenes

Representasi JSON
{
  "nextSceneId": string
}
Kolom
nextSceneId

string

ID scene yang dituju oleh transisi.

SlotMatch

Informasi tentang slot yang cocok: https://developers.google.com/assistant/conversational/scenes#slot_filling

Representasi JSON
{
  "nluParameters": {
    string: {
      object (IntentParameterValue)
    },
    ...
  }
}
Kolom
nluParameters

map (key: string, value: object (IntentParameterValue))

Parameter diekstrak oleh NLU dari input pengguna.

Objek yang berisi daftar pasangan "key": value. Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

SlotRequested

Informasi tentang slot yang saat ini diminta: https://developers.google.com/assistant/conversational/scenes#slot_filling

Representasi JSON
{
  "slot": string,
  "prompt": {
    object (Prompt)
  }
}
Kolom
slot

string

Nama slot yang diminta.

prompt

object (Prompt)

Perintah slot.

SlotValidated

Peristiwa yang terjadi setelah validasi webhook selesai untuk slot: https://developers.google.com/assistant/conversational/scenes#slot_filling

FormFilled

Peristiwa yang terjadi saat formulir terisi penuh: https://developers.google.com/assistant/conversational/scenes#slot_filling

WaitingForUserInput

Peristiwa yang terjadi saat sistem memerlukan input pengguna: https://developers.google.com/assistant/conversational/scenes#input

EndConversation

Acara yang memberitahukan bahwa percakapan dengan agen telah berakhir.