- Permintaan HTTP
- Parameter lokasi
- Isi permintaan
- Isi respons
- UserInput
- InputType
- DeviceProperties
- Permukaan
- Lokasi
- LatLng
- Output
- Kanvas
- Perintah
- Simpel
- Konten
- Kartu
- Gambar
- ImageFill
- Link
- OpenUrl
- UrlHint
- Tabel
- TableColumn
- HorizontalAlignment
- TableRow
- TableCell
- Media
- MediaType
- OptionalMediaControls
- MediaObject
- MediaImage
- Koleksi
- CollectionItem
- Daftar
- ListItem
- Saran
- Diagnostik
- ExecutionEvent
- ExecutionState
- Slot
- SlotFillingStatus
- Slot
- SlotMode
- SlotStatus
- Status
- UserConversationInput
- IntentMatch
- ConditionsEvaluated
- Kondisi
- OnSceneEnter
- WebhookRequest
- WebhookResponse
- WebhookInitiatedTransition
- SlotMatch
- SlotRequested
- SlotValidated
- FormFilled
- WaitingForUserInput
- EndConversation
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 |
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 ( |
Kolom | |
---|---|
input |
Wajib. Input yang diberikan oleh pengguna. |
deviceProperties |
Wajib. Properti perangkat yang digunakan untuk berinteraksi dengan Action. |
conversationToken |
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 ( |
Kolom | |
---|---|
output |
Output yang diberikan kepada pengguna. |
diagnostics |
Informasi diagnostik yang menjelaskan cara penanganan permintaan. |
conversationToken |
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 ( |
Kolom | |
---|---|
query |
Konten input yang dikirim oleh pengguna. |
type |
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 ( |
Kolom | |
---|---|
surface |
Platform yang digunakan untuk berinteraksi dengan Action. |
location |
Lokasi perangkat seperti lintang, bujur, dan alamat berformat. |
locale |
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 |
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 ( |
Kolom | |
---|---|
coordinates |
Koordinat geografis. Memerlukan izin [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION]. |
formattedAddress |
Alamat tampilan, misalnya, "1600 Amphitheatre Pkwy, Mountain View, CA 94043". Memerlukan izin [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION]. |
zipCode |
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 |
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 |
Lintang dalam derajat. Harus dalam rentang [-90.0, +90.0]. |
longitude |
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 ( |
Kolom | |
---|---|
text |
Respons lisan yang dikirim ke pengguna sebagai string biasa. |
speech[] |
Konten ucapan yang dihasilkan oleh Action. Ini mungkin termasuk elemen markup seperti SSML. |
canvas |
Konten Canvas interaktif. |
actionsBuilderPrompt |
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 |
URL aplikasi web kanvas interaktif yang akan dimuat. Jika tidak ditetapkan, URL dari kanvas aktif saat ini akan digunakan kembali. |
data[] |
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 |
Opsional. Nilai default: false. |
enableFullScreen |
Jika |
Prompt
Merepresentasikan respons kepada pengguna.
Representasi JSON | |
---|---|
{ "append": boolean, "override": boolean, "firstSimple": { object ( |
Kolom | |
---|---|
append |
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 |
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 |
Opsional. Respons pertama yang hanya berisi teks dan suara. |
content |
Opsional. Konten seperti kartu, daftar, atau media yang akan ditampilkan kepada pengguna. |
lastSimple |
Opsional. Respons terakhir yang hanya berupa teks dan suara. |
suggestions[] |
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. |
link |
Opsional. Chip saran tambahan yang dapat menautkan ke aplikasi atau situs terkait. Chip akan dirender dengan judul "Buka |
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 |
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 |
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 |
Kolom | ||
---|---|---|
Kolom union content . Konten. content hanya ada berupa salah satu diantara berikut: |
||
card |
Kartu dasar. |
|
image |
Gambar. |
|
table |
Kartu tabel. |
|
media |
Respons yang menunjukkan sekumpulan media yang akan diputar. |
|
canvas |
Respons yang akan digunakan untuk pengalaman kanvas interaktif. |
|
collection |
Kartu yang menampilkan kumpulan opsi untuk dipilih. |
|
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 ( |
Kolom | |
---|---|
title |
Judul kartu secara keseluruhan. Opsional. |
subtitle |
Opsional. |
text |
Teks isi kartu. Mendukung serangkaian sintaksis markdown terbatas untuk pemformatan. Wajib, kecuali jika ada gambar. |
image |
Banner besar untuk kartu. Tingginya ditetapkan ke 192 dp. Opsional. |
imageFill |
Cara mengisi latar belakang gambar. Opsional. |
button |
Tombol. Opsional. |
Gambar
Gambar yang ditampilkan di kartu.
Representasi JSON | |
---|---|
{ "url": string, "alt": string, "height": integer, "width": integer } |
Kolom | |
---|---|
url |
URL sumber gambar. Gambar dapat berupa JPG, PNG, dan GIF (animasi dan non-animasi). Misalnya, |
alt |
Deskripsi teks dari gambar yang akan digunakan untuk aksesibilitas, misalnya pembaca layar. Wajib. |
height |
Tinggi gambar dalam piksel. Opsional. |
width |
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. |
Tautkan
Tautkan konten.
Representasi JSON | |
---|---|
{
"name": string,
"open": {
object ( |
Kolom | |
---|---|
name |
Nama link |
open |
Yang terjadi jika pengguna membuka link |
OpenUrl
Tindakan yang diambil saat pengguna membuka link.
Representasi JSON | |
---|---|
{
"url": string,
"hint": enum ( |
Kolom | |
---|---|
url |
Kolom URL yang dapat berupa salah satu dari: - URL http/https untuk membuka Aplikasi atau halaman web yang ditautkan ke Aplikasi |
hint |
Menunjukkan petunjuk untuk jenis URL. |
UrlHint
Berbagai jenis petunjuk URL.
Enum | |
---|---|
LINK_UNSPECIFIED |
Belum ditetapkan |
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 ( |
Kolom | |
---|---|
title |
Judul tabel secara keseluruhan. Opsional, tetapi harus disetel jika subtitel telah disetel. |
subtitle |
Subtitel untuk tabel. Opsional. |
image |
Gambar yang terkait dengan tabel. Opsional. |
columns[] |
Header dan perataan kolom. |
rows[] |
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 |
Tombol. |
TableColumn
Menjelaskan kolom dalam tabel.
Representasi JSON | |
---|---|
{
"header": string,
"align": enum ( |
Kolom | |
---|---|
header |
Teks header untuk kolom. |
align |
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 ( |
Kolom | |
---|---|
cells[] |
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 |
Menunjukkan apakah harus ada pemisah setelah setiap baris. |
TableCell
Menjelaskan sel secara berurutan.
Representasi JSON | |
---|---|
{ "text": string } |
Kolom | |
---|---|
text |
Konten teks di sel. |
Media
Mewakili satu objek media. Berisi informasi tentang media, seperti nama, deskripsi, URL, dll.
Representasi JSON | |
---|---|
{ "mediaType": enum ( |
Kolom | |
---|---|
mediaType |
Jenis media. |
startOffset |
Offset awal objek media pertama. Durasi dalam detik dengan maksimal sembilan digit pecahan, yang diakhiri dengan ' |
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[] |
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 ( |
Kolom | |
---|---|
name |
Nama objek media ini. |
description |
Deskripsi objek media ini. |
url |
URL yang mengarah ke konten media. |
image |
Gambar yang akan ditampilkan dengan kartu media. |
MediaImage
Gambar yang akan ditampilkan dengan kartu media.
Representasi JSON | |
---|---|
{ // Union field |
Kolom | ||
---|---|---|
Kolom union image . Gambar. image hanya ada berupa salah satu diantara berikut: |
||
large |
Gambar besar, seperti sampul album, dll. |
|
icon |
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 ( |
Kolom | |
---|---|
title |
Judul koleksi. Opsional. |
subtitle |
Subtitel koleksi. Opsional. |
items[] |
min: 2 maks: 10 |
imageFill |
Cara mengisi latar belakang gambar item koleksi. Opsional. |
CollectionItem
Item dalam koleksi
Representasi JSON | |
---|---|
{ "key": string } |
Kolom | |
---|---|
key |
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 ( |
Kolom | |
---|---|
title |
Judul daftar. Opsional. |
subtitle |
Subtitel daftar. Opsional. |
items[] |
min: 2 maks: 30 |
ListItem
Item dalam daftar
Representasi JSON | |
---|---|
{ "key": string } |
Kolom | |
---|---|
key |
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 |
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 ( |
Kolom | |
---|---|
actionsBuilderEvents[] |
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 ( |
Kolom | ||
---|---|---|
eventTime |
Stempel waktu saat peristiwa terjadi. Stempel waktu dalam format RFC3339 UTC "Zulu", dengan resolusi nanodetik dan hingga sembilan digit pecahan. Contoh: |
|
executionState |
Status eksekusi selama peristiwa ini. |
|
status |
Status hasil dari langkah eksekusi tertentu. |
|
warningMessages[] |
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 |
Peristiwa penanganan input pengguna. |
|
intentMatch |
Peristiwa pencocokan intent. |
|
conditionsEvaluated |
Peristiwa evaluasi kondisi. |
|
onSceneEnter |
Peristiwa eksekusi OnSceneEnter. |
|
webhookRequest |
Peristiwa pengiriman permintaan webhook. |
|
webhookResponse |
Peristiwa tanda terima respons webhook. |
|
webhookInitiatedTransition |
Peristiwa transisi yang dimulai webhook. |
|
slotMatch |
Peristiwa pencocokan slot. |
|
slotRequested |
Peristiwa permintaan slot. |
|
slotValidated |
Peristiwa validasi slot. |
|
formFilled |
Peristiwa pengisian formulir. |
|
waitingUserInput |
Menunggu peristiwa input pengguna. |
|
endConversation |
Acara akhir percakapan. |
ExecutionState
Status eksekusi saat ini.
Representasi JSON | |
---|---|
{ "currentSceneId": string, "sessionStorage": { object }, "slots": { object ( |
Kolom | |
---|---|
currentSceneId |
ID adegan yang saat ini aktif. |
sessionStorage |
Status penyimpanan sesi: https://developers.google.com/assistant/conversational/storage-session |
slots |
Status pengisian slot, jika ada: https://developers.google.com/assistant/conversational/scenes#slot_filling |
promptQueue[] |
Antrean permintaan: https://developers.google.com/assistant/conversational/prompts |
userStorage |
Status penyimpanan pengguna: https://developers.google.com/assistant/conversational/storage-user |
householdStorage |
Status penyimpanan utama: https://developers.google.com/assistant/conversational/storage-home |
Slot
Mewakili status slot adegan saat ini.
Representasi JSON | |
---|---|
{ "status": enum ( |
Kolom | |
---|---|
status |
Status pengisian slot saat ini. |
slots |
Slot yang terkait dengan adegan saat ini. Objek yang berisi daftar pasangan |
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 ( |
Kolom | |
---|---|
mode |
Mode slot (wajib atau opsional). Dapat disetel oleh developer. |
status |
Status slot. |
value |
Nilai slot. Mengubah nilai ini dalam respons akan mengubah nilai dalam pengisian slot. |
updated |
Menunjukkan apakah nilai slot dikumpulkan pada belokan terakhir. Kolom ini bersifat hanya baca. |
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 |
Kode status, harus berupa nilai enum dari |
message |
Pesan error yang ditampilkan ke developer dan seharusnya dalam bahasa Inggris. Setiap pesan error yang ditampilkan kepada pengguna harus dilokalkan dan dikirim di kolom |
details[] |
Daftar pesan yang membawa detail error. Ada seperangkat jenis pesan umum untuk digunakan API. Objek yang berisi kolom tipe arbitrer. Kolom tambahan |
UserConversationInput
Informasi yang terkait dengan input pengguna.
Representasi JSON | |
---|---|
{ "type": string, "originalQuery": string } |
Kolom | |
---|---|
type |
Jenis input pengguna. Misalnya keyboard, suara, sentuh, dll. |
originalQuery |
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 ( |
Kolom | |
---|---|
intentId |
ID intent yang memicu interaksi ini. |
intentParameters |
Parameter intent yang memicu interaksi ini. Objek yang berisi daftar pasangan |
handler |
Nama pengendali yang dilampirkan ke interaksi ini. |
nextSceneId |
Suasana yang menjadi tujuan interaksi ini. |
ConditionsEvaluated
Hasil evaluasi kondisi: https://developers.google.com/assistant/conversational/scenes#conditions
Representasi JSON | |
---|---|
{ "failedConditions": [ { object ( |
Kolom | |
---|---|
failedConditions[] |
Daftar kondisi yang dievaluasi ke 'false'. |
successCondition |
Kondisi pertama yang dievaluasi ke 'true', jika ada. |
Kondisi
Kondisi yang dievaluasi.
Representasi JSON | |
---|---|
{ "expression": string, "handler": string, "nextSceneId": string } |
Kolom | |
---|---|
expression |
Ekspresi yang ditentukan dalam kondisi ini. |
handler |
Nama pengendali yang ditentukan dalam kondisi yang dievaluasi. |
nextSceneId |
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 |
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 |
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 |
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 |
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 ( |
Kolom | |
---|---|
nluParameters |
Parameter diekstrak oleh NLU dari input pengguna. Objek yang berisi daftar pasangan |
SlotRequested
Informasi tentang slot yang saat ini diminta: https://developers.google.com/assistant/conversational/scenes#slot_filling
Representasi JSON | |
---|---|
{
"slot": string,
"prompt": {
object ( |
Kolom | |
---|---|
slot |
Nama slot yang diminta. |
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.