- Representasi JSON
- ConfigFiles
- ConfigFile
- Manifes
- Tindakan
- CustomAction
- Interaksi
- PushNotification
- DailyUpdate
- ActionLink
- AssistantLink
- Setelan
- Kategori
- SurfaceRequirements
- CapabilityRequirement
- SurfaceCapability
- LocalizedSettings
- ThemeCustomization
- ImageCornerStyle
- AccountLinking
- LinkingType
- AuthGrantType
- Webhook
- Pengendali
- HttpsEndpoint
- InlineCloudFunction
- Niat
- IntentParameter
- ClassReference
- EntitySetReferences
- EntitySetReference
- Jenis
- SynonymType
- MatchType
- Entity
- EntityDisplay
- RegularExpressionType
- Entity
- FreeTextType
- EntitySet
- Entity
- GlobalIntentEvent
- EventHandler
- StaticPrompt
- StaticPromptCandidate
- Pemilih
- SurfaceCapabilities
- Kemampuan
- StaticPromptResponse
- StaticSimplePrompt
- Varian
- StaticContentPrompt
- StaticCardPrompt
- StaticImagePrompt
- ImageFill
- StaticLinkPrompt
- OpenUrl
- UrlHint
- StaticTablePrompt
- TableColumn
- HorizontalAlignment
- TableRow
- TableCell
- StaticMediaPrompt
- MediaType
- OptionalMediaControls
- MediaObject
- MediaImage
- RepeatMode
- StaticListPrompt
- ListItem
- StaticCollectionPrompt
- CollectionItem
- StaticCollectionBrowsePrompt
- CollectionBrowseItem
- Saran
- StaticCanvasPrompt
- Adegan
- IntentEvent
- ConditionalEvent
- Slot
- PromptSettings
- CommitBehavior
- DefaultValue
- DataFiles
- DataFile
Wrapper untuk daftar file.
Representasi JSON | |
---|---|
{ // Union field |
Kolom | ||
---|---|---|
Kolom union file_type . Hanya satu jenis file yang dapat dikirim ke server dalam satu waktu, yaitu file konfigurasi atau file data. file_type hanya dapat berupa salah satu dari berikut: |
||
configFiles |
Daftar file konfigurasi. Data ini mencakup manifes, setelan, paket resource model interaksi, dan lainnya. |
|
dataFiles |
Daftar file data. Ini mencakup gambar, file audio, kode sumber cloud function. |
ConfigFiles
Wrapper untuk file konfigurasi berulang. Kolom berulang tidak boleh ada di salah satu dari keduanya.
Representasi JSON | |
---|---|
{
"configFiles": [
{
object ( |
Kolom | |
---|---|
configFiles[] |
Beberapa file konfigurasi. |
ConfigFile
Mewakili satu file yang berisi data terstruktur. Developer dapat menentukan sebagian besar project mereka menggunakan konfigurasi terstruktur termasuk Actions, Settings, Fulfillment.
Representasi JSON | |
---|---|
{ "filePath": string, // Union field |
Kolom | ||
---|---|---|
filePath |
Jalur relatif file konfigurasi dari root project dalam struktur file SDK. Setiap jenis file di bawah memiliki jalur file yang diizinkan. Misalnya: settings/settings.yaml |
|
Kolom union file . Setiap jenis file konfigurasi harus memiliki
bidang yang sesuai di salah satunya. file hanya dapat berupa salah satu dari berikut: |
||
manifest |
File manifes tunggal. Jalur file yang diizinkan: |
|
actions |
File tindakan tunggal dengan semua tindakan yang ditentukan. Jalur file yang diizinkan: |
|
settings |
Konfigurasi setelan tunggal yang menyertakan setelan dan setelan yang tidak dapat dilokalkan untuk lokalitas default project (jika ditentukan). Untuk file pengganti lokalitas, hanya kolom dilokalkanSettings yang akan diisi. Jalur file yang diizinkan: |
|
webhook |
Definisi webhook tunggal. Jalur file yang diizinkan: |
|
intent |
Definisi intent tunggal. Jalur file yang diizinkan: |
|
type |
Definisi jenis tunggal. Jalur file yang diizinkan: |
|
entitySet |
Definisi kumpulan entitas tunggal. Jalur file yang diizinkan: |
|
globalIntentEvent |
Definisi peristiwa intent global tunggal. Jalur file yang diizinkan: |
|
scene |
Definisi satu suasana. Jalur file yang diizinkan: |
|
staticPrompt |
Definisi perintah statis tunggal. Jalur file yang diizinkan: |
|
accountLinkingSecret |
Metadata yang sesuai dengan rahasia klien yang digunakan dalam penautan akun. Jalur file yang diizinkan: |
|
resourceBundle |
Paket resource tunggal, yang merupakan peta dari string ke string atau daftar string. Paket resource dapat digunakan untuk melokalkan string dalam perintah statis. Jalur file yang diizinkan: |
Manifes
Berisi informasi yang "dapat diangkut" yaitu tidak spesifik untuk project tertentu dan dapat dipindahkan antar-project.
Representasi JSON | |
---|---|
{ "version": string } |
Kolom | |
---|---|
version |
Versi format file. Versi format file saat ini adalah versi 1.0. Contoh: "1.0" |
Tindakan
Mewakili daftar Tindakan yang ditentukan dalam sebuah project.
Representasi JSON | |
---|---|
{
"custom": {
string: {
object ( |
Kolom | |
---|---|
custom |
Petakan dari intent ke Action kustom untuk mengonfigurasi pemanggilan untuk project. Intent pemanggilan dapat berupa intent sistem atau intent kustom yang ditentukan dalam atribut "custom/intents/" paket. Semua intent yang ditentukan di sini (intent sistem & intent kustom) harus memiliki file intent yang sesuai dalam kolom "custom/global/" paket. Objek yang berisi daftar pasangan |
CustomAction
Detail terkait tindakan kustom.
Representasi JSON | |
---|---|
{
"engagement": {
object ( |
Kolom | |
---|---|
engagement |
Mekanisme interaksi yang terkait dengan tindakan untuk membantu pengguna akhir berlangganan notifikasi push dan info terbaru harian. Perhatikan bahwa nama intent yang ditetapkan dalam konfigurasi slot notifikasi push/update harian harus cocok dengan intent yang berkaitan dengan tindakan ini agar pengguna akhir dapat berlangganan update ini. |
Engagement
Menentukan mekanisme interaksi yang terkait dengan tindakan ini. Hal ini memungkinkan pengguna akhir berlangganan notifikasi push dan info terbaru harian.
Representasi JSON | |
---|---|
{ "title": string, "pushNotification": { object ( |
Kolom | |
---|---|
title |
Judul interaksi yang akan dikirim ke pengguna akhir untuk meminta izin mereka untuk menerima info terbaru. Permintaan yang dikirim ke pengguna akhir untuk pembaruan harian akan terlihat seperti "Pukul berapa Anda ingin saya mengirimkan {title}" harian dan untuk notifikasi push akan terlihat seperti "Apakah boleh jika saya mengirim notifikasi push untuk {title}". Kolom ini dapat dilokalkan. |
pushNotification |
Setelan notifikasi push yang didukung interaksi ini. |
actionLink |
Konfigurasi link untuk tindakan yang menentukan apakah berbagi link diaktifkan untuk tindakan atau tidak dan, jika ya, berisi nama tampilan yang mudah digunakan untuk link tersebut. ActionLink tidak digunakan lagi. Sebagai gantinya, gunakan AssistantLink. |
assistantLink |
Konfigurasi link untuk tindakan yang menentukan apakah berbagi link diaktifkan untuk tindakan atau tidak dan, jika ya, berisi nama tampilan yang mudah digunakan untuk link tersebut. |
dailyUpdate |
Setelan update harian yang didukung engagement ini. |
PushNotification
Menentukan setelan notifikasi push yang didukung interaksi ini.
DailyUpdate
Menentukan setelan update harian yang didukung interaksi ini.
ActionLink
Menunjukkan apakah link berbagi diaktifkan untuk tindakan ini dan setelan terkait. Link tindakan digunakan untuk membuat deep link pengguna ke dalam tindakan tertentu. ActionLink tidak digunakan lagi. Sebagai gantinya, gunakan AssistantLink.
Representasi JSON | |
---|---|
{ "title": string } |
Kolom | |
---|---|
title |
Judul tampilan yang mudah digunakan untuk link. |
AssistantLink
Menunjukkan apakah link berbagi diaktifkan untuk tindakan ini dan setelan terkait. Link Asisten digunakan untuk membuat deep link pengguna ke tindakan tertentu.
Representasi JSON | |
---|---|
{ "title": string } |
Kolom | |
---|---|
title |
Judul tampilan yang mudah digunakan untuk link. |
Setelan
Mewakili setelan project Action yang tidak khusus lokalitas. Tag berikutnya: 22
Representasi JSON | |
---|---|
{ "projectId": string, "defaultLocale": string, "enabledRegions": [ string ], "disabledRegions": [ string ], "category": enum ( |
Kolom | |
---|---|
projectId |
ID project Actions. |
defaultLocale |
Lokalitas yang merupakan default untuk project. Untuk semua file kecuali pada bagian |
enabledRegions[] |
Mewakili wilayah tempat pengguna dapat memanggil Action Anda, yang didasarkan pada lokasi kehadiran pengguna. Tidak dapat disetel jika |
disabledRegions[] |
Mewakili wilayah tempat Action Anda diblokir, berdasarkan lokasi kehadiran pengguna. Tidak dapat disetel jika |
category |
Kategori untuk project Action ini. |
usesTransactionsApi |
Apakah Action dapat menggunakan transaksi (misalnya, melakukan reservasi, menerima pesanan, dll.). Jika false, upaya untuk menggunakan Transactions API akan gagal. |
usesDigitalPurchaseApi |
Apakah Actions dapat melakukan transaksi untuk barang digital. |
usesInteractiveCanvas |
Apakah Actions menggunakan Canvas Interaktif. |
usesHomeStorage |
Apakah Action menggunakan fitur penyimpanan rumah. |
designedForFamily |
Apakah konten Action didesain untuk keluarga (DFF). |
containsAlcoholOrTobaccoContent |
Apakah Action berisi konten terkait alkohol atau tembakau. |
keepsMicOpen |
Apakah Action boleh membiarkan mikrofon aktif tanpa perintah eksplisit selama percakapan. |
surfaceRequirements |
Persyaratan platform yang harus didukung platform klien untuk memanggil Action dalam project ini. |
testingInstructions |
Petunjuk pengujian bentuk bebas untuk Peninjau Action (misalnya, petunjuk penautan akun). |
localizedSettings |
Setelan yang dilokalkan untuk lokalitas default project. Setiap lokalitas tambahan harus memiliki file setelan sendiri di direktorinya sendiri. |
accountLinking |
Izinkan pengguna membuat atau menautkan akun melalui login dengan Google dan/atau layanan OAuth Anda sendiri. |
selectedAndroidApps[] |
Aplikasi Android yang dipilih untuk mengakses pembelian Google Play untuk transaksi. Ini adalah pilihan dari aplikasi Android yang terhubung ke project tindakan untuk memverifikasi kepemilikan merek dan mengaktifkan fitur tambahan. Lihat https://developers.google.com/assistant/console/brand-verification untuk mengetahui informasi selengkapnya. |
Kategori
Pilihan kategori untuk project Action.
Enum | |
---|---|
CATEGORY_UNSPECIFIED |
Tidak diketahui / Tidak ditentukan. |
BUSINESS_AND_FINANCE |
Kategori Bisnis dan Keuangan. |
EDUCATION_AND_REFERENCE |
Kategori Pendidikan dan Referensi. |
FOOD_AND_DRINK |
Kategori Makanan dan Minuman. |
GAMES_AND_TRIVIA |
Kategori game dan Trivia. |
HEALTH_AND_FITNESS |
Kategori Kesehatan dan Kebugaran. |
KIDS_AND_FAMILY |
Kategori Anak-Anak dan Keluarga. |
LIFESTYLE |
Kategori gaya hidup. |
LOCAL |
Kategori lokal. |
MOVIES_AND_TV |
Kategori film dan TV. |
MUSIC_AND_AUDIO |
Kategori Musik dan Audio. |
NEWS |
Kategori berita, |
NOVELTY_AND_HUMOR |
Kategori Baru dan Humor. |
PRODUCTIVITY |
Kategori produktivitas. |
SHOPPING |
Kategori belanja. |
SOCIAL |
Kategori sosial. |
SPORTS |
Kategori olahraga. |
TRAVEL_AND_TRANSPORTATION |
Kategori Perjalanan dan Transportasi. |
UTILITIES |
Kategori utilitas. |
WEATHER |
Kategori cuaca. |
HOME_CONTROL |
Kategori Kontrol Rumah. |
SurfaceRequirements
Berisi kumpulan persyaratan yang harus didukung platform klien untuk memanggil Action dalam project Anda.
Representasi JSON | |
---|---|
{
"minimumRequirements": [
{
object ( |
Kolom | |
---|---|
minimumRequirements[] |
Kumpulan kemampuan minimum yang diperlukan untuk memanggil Action dalam project Anda. Jika platform tidak memiliki salah satunya, Action tidak akan dipicu. |
CapabilityRequirement
Menampilkan persyaratan tentang ketersediaan kemampuan tertentu.
Representasi JSON | |
---|---|
{
"capability": enum ( |
Kolom | |
---|---|
capability |
Jenis kemampuan. |
SurfaceCapability
Sekumpulan kemampuan permukaan yang mungkin.
Enum | |
---|---|
SURFACE_CAPABILITY_UNSPECIFIED |
Tidak diketahui / Tidak ditentukan. |
AUDIO_OUTPUT |
Platform mendukung output audio. |
SCREEN_OUTPUT |
Permukaan mendukung output layar/visual. |
MEDIA_RESPONSE_AUDIO |
Permukaan mendukung audio respons media. |
WEB_BROWSER |
Surface mendukung browser web. |
ACCOUNT_LINKING |
Platform mendukung penautan akun. |
INTERACTIVE_CANVAS |
Platform mendukung Interactive Canvas. |
HOME_STORAGE |
Permukaan mendukung penyimpanan rumah. |
LocalizedSettings
Merepresentasikan setelan project Action yang spesifik untuk lokalitas pengguna. Dalam hal ini, pengguna berarti pengguna akhir yang memanggil Action Anda. Pesan ini dapat dilokalkan.
Representasi JSON | |
---|---|
{
"displayName": string,
"pronunciation": string,
"shortDescription": string,
"fullDescription": string,
"smallLogoImage": string,
"largeBannerImage": string,
"developerName": string,
"developerEmail": string,
"termsOfServiceUrl": string,
"voice": string,
"voiceLocale": string,
"privacyPolicyUrl": string,
"sampleInvocations": [
string
],
"themeCustomization": {
object ( |
Kolom | |
---|---|
displayName |
Wajib. Nama tampilan default untuk project Action ini (jika terjemahan tidak tersedia) |
pronunciation |
Wajib. Pengucapan nama tampilan untuk memanggilnya dalam konteks suara (lisan). |
shortDescription |
Wajib. Deskripsi singkat default untuk project Action (jika tidak ada terjemahan yang tersedia). Maksimal 80 karakter. |
fullDescription |
Wajib. Deskripsi panjang default untuk project Action (jika tidak ada terjemahan yang tersedia). Maksimal 4.000 karakter. |
smallLogoImage |
Wajib. Gambar persegi kecil, 192 x 192 piksel. Nilai ini harus ditentukan sebagai referensi untuk gambar yang sesuai di direktori |
largeBannerImage |
Opsional. Gambar lanskap besar, 1920 x 1080 piksel. Nilai ini harus ditentukan sebagai referensi untuk gambar yang sesuai di direktori |
developerName |
Wajib. Nama developer yang akan ditampilkan kepada pengguna. |
developerEmail |
Wajib. Alamat email kontak untuk developer. |
termsOfServiceUrl |
Opsional. URL persyaratan layanan. |
voice |
Wajib. Jenis suara Asisten Google yang didengar pengguna saat mereka berinteraksi dengan Action Anda. Nilai yang didukung adalah "male_1", "male_2", "perempuan_1", dan "perempuan_2". |
voiceLocale |
Opsional. Lokal untuk suara yang ditentukan. Jika tidak ditentukan, tindakan ini akan me-resolve ke lokalitas Asisten pengguna. Jika ditentukan, lokal suara harus memiliki bahasa root yang sama dengan lokalitas yang ditentukan dalam LocalizedSettings. |
privacyPolicyUrl |
Wajib. URL kebijakan privasi. |
sampleInvocations[] |
Opsional. Contoh frasa panggilan yang ditampilkan sebagai bagian dari deskripsi project Action Anda di direktori Asisten. Hal ini akan membantu pengguna mempelajari cara menggunakannya. |
themeCustomization |
Opsional. Penyesuaian tema untuk komponen visual Action Anda. |
ThemeCustomization
Gaya yang diterapkan pada kartu yang ditampilkan kepada pengguna
Representasi JSON | |
---|---|
{
"backgroundColor": string,
"primaryColor": string,
"fontFamily": string,
"imageCornerStyle": enum ( |
Kolom | |
---|---|
backgroundColor |
Warna latar belakang kartu. Berfungsi sebagai penggantian jika |
primaryColor |
Warna tema utama Action akan digunakan untuk menyetel warna teks judul, warna latar belakang item tindakan untuk kartu Actions on Google. Contoh penggunaan: #FAFAFA |
fontFamily |
Jenis font yang akan digunakan untuk judul kartu. Font yang didukung: - Sans Serif - Sans Serif Medium - Sans Serif Bold - Sans Serif Black - Sans Serif Condensed - Sans Serif Condensed Medium - Serif - Serif Bold - Monospace - Cursive - Sans Serif Smallcaps |
imageCornerStyle |
Gaya batas gambar latar depan kartu. Misalnya, dapat diterapkan pada gambar latar depan kartu dasar atau kartu carousel. |
landscapeBackgroundImage |
Mode lanskap (minimum 1920x1200 piksel). Nilai ini harus ditentukan sebagai referensi untuk gambar yang sesuai di direktori |
portraitBackgroundImage |
Mode potret (minimum 1200x1920 piksel). Nilai ini harus ditentukan sebagai referensi untuk gambar yang sesuai di direktori |
ImageCornerStyle
Menjelaskan bagaimana batas gambar harus dirender.
Enum | |
---|---|
IMAGE_CORNER_STYLE_UNSPECIFIED |
Tidak ditentukan / Tidak ditentukan. |
CURVED |
Sudut membulat untuk gambar. |
ANGLED |
Sudut persegi panjang untuk gambar. |
AccountLinking
AccountLinking memungkinkan Google memandu pengguna untuk login ke layanan web Aplikasi.
Untuk jenis penautan Login dengan Google dan OAuth + Login dengan Google, Google membuat client ID yang mengidentifikasi Aplikasi Anda ke Google ("Client ID yang dikeluarkan oleh Google untuk Actions Anda" di UI Konsol). Kolom ini bersifat hanya baca dan dapat diperiksa dengan membuka halaman Penautan Akun di UI Konsol. Lihat: https://developers.google.com/assistant/identity/google-sign-in
Catatan: Untuk semua jenis setelan penautan akun (kecuali Login dengan Google), Anda harus memberikan nama pengguna dan sandi untuk akun pengujian di Settings.testing_instructions agar tim peninjau dapat meninjau aplikasi (tidak akan dapat dilihat oleh pengguna).
Representasi JSON | |
---|---|
{ "enableAccountCreation": boolean, "linkingType": enum ( |
Kolom | |
---|---|
enableAccountCreation |
Wajib. Jika |
linkingType |
Wajib. Jenis penautan yang akan digunakan. Lihat https://developers.google.com/assistant/identity untuk mengetahui detail selengkapnya tentang jenis penautan. |
authGrantType |
Opsional. Menunjukkan jenis autentikasi untuk OAUTH linkingType. |
appClientId |
Opsional. Client ID yang dikeluarkan oleh Aplikasi Anda ke Google. Ini adalah Client ID OAuth2 yang mengidentifikasi Google ke layanan Anda. Hanya disetel saat menggunakan OAuth. |
authorizationUrl |
Opsional. Endpoint untuk halaman web login Anda yang mendukung kode OAuth2 atau alur implisit. URL harus menggunakan HTTPS. Hanya disetel saat menggunakan OAuth. |
tokenUrl |
Opsional. Endpoint OAuth2 untuk pertukaran token. URL harus menggunakan HTTPS. Opsi ini tidak ditetapkan jika hanya menggunakan OAuth dengan pemberian IMPLICIT sebagai jenis penautan. Hanya disetel saat menggunakan OAuth. |
scopes[] |
Opsional. Daftar izin yang harus disetujui pengguna untuk menggunakan layanan Anda. Hanya disetel saat menggunakan OAuth. Pastikan untuk menyediakan Persyaratan Layanan dalam informasi direktori di bagian LocalizedSettings.terms_of_service_url jika menentukan kolom ini. |
learnMoreUrl |
Opsional. Ini adalah halaman web di layanan Anda yang menjelaskan izin yang diberikan pengguna kepada Google. Hanya tetapkan jika menggunakan OAuth dan Login dengan Google. Pastikan untuk menyediakan Persyaratan Layanan dalam informasi direktori di bagian LocalizedSettings.terms_of_service_url jika menentukan kolom ini. |
useBasicAuthHeader |
Opsional. Jika true (benar), izinkan Google untuk mengirimkan client ID dan secret klien melalui header autentikasi dasar HTTP. Jika tidak, Google akan menggunakan client ID dan secret di dalam isi postingan. Hanya disetel saat menggunakan OAuth. Pastikan untuk menyediakan Persyaratan Layanan dalam informasi direktori di bagian LocalizedSettings.terms_of_service_url jika menentukan kolom ini. |
LinkingType
Jenis Penautan Akun yang akan dilakukan.
Enum | |
---|---|
LINKING_TYPE_UNSPECIFIED |
Tidak ditentukan. |
GOOGLE_SIGN_IN |
Jenis penautan Login dengan Google. Jika menggunakan jenis penautan ini, kolom terkait OAuth tidak perlu ditetapkan di bawah. |
OAUTH_AND_GOOGLE_SIGN_IN |
Jenis penautan Login dengan Google dan OAuth. |
OAUTH |
Jenis penautan OAuth. |
AuthGrantType
Jenis pemberian izin OAuth2 yang digunakan Google untuk memandu pengguna login ke layanan web Aplikasi Anda.
Enum | |
---|---|
AUTH_GRANT_TYPE_UNSPECIFIED |
Tidak ditentukan. |
AUTH_CODE |
Pemberian kode otorisasi. Mengharuskan Anda memberikan URL autentikasi dan URL token akses. |
IMPLICIT |
Pemberian kode implisit. Hanya mengharuskan Anda memberikan URL autentikasi. |
Webhook
Metadata untuk berbagai jenis webhook. Jika Anda menggunakan inlineCloudFunction
, kode sumber harus berada di direktori dengan nama yang sama dengan nilai untuk kunci executeFunction
. Misalnya, nilai my_webhook
untuk kunci executeFunction
akan memiliki struktur kode seperti ini: - /webhooks/my_webhook.yaml
- /webhooks/my_webhook/index.js
- /webhooks/my_webhook/package.json
Representasi JSON | |
---|---|
{ "handlers": [ { object ( |
Kolom | ||
---|---|---|
handlers[] |
Daftar pengendali untuk webhook ini. |
|
Kolom union webhook_type . Hanya satu jenis webhook yang didukung. webhook_type hanya dapat berupa salah satu dari berikut: |
||
httpsEndpoint |
Endpoint HTTPS webhook kustom. |
|
inlineCloudFunction |
Metadata untuk fungsi cloud yang di-deploy dari kode di folder webhook. |
Handler
Mendeklarasikan nama pengendali webhoook. Webhook dapat memiliki beberapa pengendali yang terdaftar. Pengendali ini dapat dipanggil dari beberapa tempat di project Action Anda.
Representasi JSON | |
---|---|
{ "name": string } |
Kolom | |
---|---|
name |
Wajib. Nama pengendali. Harus unik di semua pengendali project Actions. Anda dapat memeriksa nama pengendali ini untuk memanggil fungsi yang benar dalam kode sumber fulfillment Anda. |
HttpsEndpoint
Endpoint REST untuk memberi tahu jika Anda tidak menggunakan editor inline.
Representasi JSON | |
---|---|
{ "baseUrl": string, "httpHeaders": { string: string, ... }, "endpointApiVersion": integer } |
Kolom | |
---|---|
baseUrl |
URL dasar HTTPS untuk endpoint fulfillment Anda (HTTP tidak didukung). Nama pengendali ditambahkan ke jalur URL dasar setelah tanda titik dua (dengan mengikuti panduan gaya di https://cloud.google.com/apis/design/custom_methods). Misalnya, URL dasar 'https://gactions.service.com/api' akan menerima permintaan dengan URL 'https://gactions.service.com/api:{method}'. |
httpHeaders |
Peta parameter HTTP yang akan disertakan dalam permintaan POST. Objek yang berisi daftar pasangan |
endpointApiVersion |
Versi protokol yang digunakan oleh endpoint. Ini adalah protokol yang digunakan bersama oleh semua jenis fulfillment dan tidak spesifik untuk jenis fulfillment Google. |
InlineCloudFunction
Menyimpan metadata Cloud Function inline yang di-deploy dari folder webhook.
Representasi JSON | |
---|---|
{ "executeFunction": string } |
Kolom | |
---|---|
executeFunction |
Nama titik entri Cloud Function. Nilai kolom ini harus cocok dengan nama metode yang diekspor dari kode sumber. |
Intent
Intent memetakan input pengguna terbuka ke objek terstruktur. Frasa lisan dicocokkan dengan intent menggunakan Natural Language Understanding (NLU) Google. Pencocokan intent dapat memicu peristiwa dalam desain percakapan Anda untuk melanjutkan percakapan pengguna. Nama intent ditetapkan dalam nama file.
Representasi JSON | |
---|---|
{
"parameters": [
{
object ( |
Kolom | |
---|---|
parameters[] |
Daftar parameter dalam frasa pelatihan. Semua parameter harus ditentukan di sini agar dapat digunakan dalam frasa pelatihan. |
trainingPhrases[] |
Frasa pelatihan memungkinkan NLU Google mencocokkan intent dengan input pengguna secara otomatis. Semakin banyak frasa unik yang diberikan, semakin besar kemungkinan niat ini akan dicocokkan. Berikut adalah format bagian frasa pelatihan yang dianotasi. Perhatikan bahwa kolom |
IntentParameter
Definisi parameter yang dapat digunakan dalam frasa pelatihan.
Representasi JSON | |
---|---|
{ "name": string, // Union field |
Kolom | ||
---|---|---|
name |
Wajib. Nama unik parameter intent. Dapat digunakan dalam kondisi dan respons untuk mereferensikan parameter intent yang diekstrak oleh NLU dengan $intent.params.[name].resolved |
|
Kolom union parameter_type . Jenis parameter intent. parameter_type hanya dapat berupa salah satu dari berikut: |
||
type |
Opsional. Mendeklarasikan jenis data parameter ini. Intent ini tidak boleh disetel untuk intent bawaan. |
|
entitySetReferences |
Opsional. Rujukan ke kumpulan entity yang diizinkan untuk parameter intent ini. Hanya valid untuk parameter intent bawaan. Referensi ini mengarah ke kumpulan entity di 'custom/entitySets' saat ini. |
ClassReference
Referensi ke class yang digunakan untuk mendeklarasikan jenis kolom atau nilai yang ditampilkan. Enum juga merupakan jenis class yang dapat direferensikan menggunakan ClassReference.
Representasi JSON | |
---|---|
{ "name": string, "list": boolean } |
Kolom | |
---|---|
name |
Wajib. Nama jenis bawaan atau jenis kustom parameter. Contoh: |
list |
Opsional. Menunjukkan apakah tipe data mewakili daftar nilai. |
EntitySetReferences
Referensi kumpulan entitas untuk parameter intent.
Representasi JSON | |
---|---|
{
"entitySetReferences": [
{
object ( |
Kolom | |
---|---|
entitySetReferences[] |
Wajib. Referensi kumpulan entitas untuk parameter intent. |
EntitySetReference
Referensi ke kumpulan entity yang diizinkan untuk parameter intent ini.
Representasi JSON | |
---|---|
{ "entitySet": string } |
Kolom | |
---|---|
entitySet |
Wajib. Mengidentifikasi kumpulan entitas tertentu yang akan dipertimbangkan untuk parameter tertentu. Definisi kumpulan entitas yang sesuai harus ada di direktori custom/entitySets/. |
Jenis
Pernyataan jenis kustom, bukan jenis bawaan. Jenis dapat ditetapkan ke slot dalam scene atau parameter dari frasa pelatihan intent. Dalam praktiknya, Jenis dapat dianggap sebagai enum. Catatan, nama jenis ditentukan dalam nama file.
Representasi JSON | |
---|---|
{ "exclusions": [ string ], // Union field |
Kolom | ||
---|---|---|
exclusions[] |
Kumpulan kata/frasa unik yang tidak boleh dicocokkan menurut jenisnya. Catatan: Jika kata/frasa cocok dengan jenisnya namun dicantumkan sebagai pengecualian, kata/frasa tidak akan ditampilkan dalam hasil ekstraksi parameter. Kolom ini dapat dilokalkan. |
|
Kolom union sub_type . Pemilihan sub-jenis berdasarkan jenis pencocokan yang akan dilakukan. sub_type hanya dapat berupa salah satu dari berikut: |
||
synonym |
Jenis sinonim, yang pada dasarnya adalah enum. |
|
regularExpression |
Jenis ekspresi reguler, memungkinkan pencocokan ekspresi reguler. |
|
freeText |
Jenis FreeText. |
SynonymType
Ketik yang mencocokkan teks menurut kumpulan sinonim.
Representasi JSON | |
---|---|
{ "matchType": enum ( |
Kolom | |
---|---|
matchType |
Opsional. Jenis pencocokan untuk sinonim. |
acceptUnknownValues |
Opsional. Jika disetel ke benar (true), ini akan cocok dengan kata atau frasa yang tidak dikenal berdasarkan input dan data pelatihan intent di sekitarnya, seperti item yang mungkin ditambahkan ke daftar belanjaan. |
entities |
Wajib. Peta bernama entitas sinonim. Objek yang berisi daftar pasangan |
MatchType
Jenis pencocokan yang akan digunakan entri dalam jenis ini. Hal ini akan memastikan semua jenis menggunakan metode pencocokan yang sama dan memungkinkan variasi pencocokan untuk pencocokan sinonim (yaitu yang tidak jelas versus persis). Jika nilainya UNSPECIFIED
, nilai ini akan ditetapkan secara default ke EXACT_MATCH
.
Enum | |
---|---|
UNSPECIFIED |
Default-nya adalah EXACT_MATCH . |
EXACT_MATCH |
Mencari kecocokan persis antara sinonim atau nama. |
FUZZY_MATCH |
Lebih longgar dari EXACT_MATCH . Mencari kecocokan yang mirip dan juga kecocokan persis. |
Entitas
Mewakili kolom entity sinonim yang berisi detail satu entri di dalam jenis.
Representasi JSON | |
---|---|
{
"display": {
object ( |
Kolom | |
---|---|
display |
Opsional. Entity menampilkan detail. |
synonyms[] |
Opsional. Daftar sinonim entitas. Kolom ini dapat dilokalkan. |
EntityDisplay
Elemen yang akan ditampilkan di kanvas setelah entity jenis tertentu diekstrak dari kueri. Hanya relevan untuk aplikasi yang mendukung kanvas. Pesan ini dapat dilokalkan.
Representasi JSON | |
---|---|
{ "iconTitle": string, "iconUrl": string } |
Kolom | |
---|---|
iconTitle |
Opsional. Judul ikon. |
iconUrl |
Wajib. URL ikon. |
RegularExpressionType
Jenis yang cocok dengan teks menurut ekspresi reguler. Pesan ini dapat dilokalkan.
Representasi JSON | |
---|---|
{
"entities": {
string: {
object ( |
Kolom | |
---|---|
entities |
Wajib. Peta entitas bernama yang masing-masing berisi string Regex. Objek yang berisi daftar pasangan |
Entitas
Mewakili objek entity yang berisi ekspresi reguler yang digunakan untuk perbandingan.
Representasi JSON | |
---|---|
{
"display": {
object ( |
Kolom | |
---|---|
display |
Opsional. Elemen yang akan ditampilkan di kanvas setelah entity diekstrak dari kueri. Hanya relevan untuk aplikasi yang mendukung kanvas. |
regularExpressions[] |
Wajib. Menggunakan sintaksis ekspresi reguler RE2 (Lihat https://github.com/google/re2/wiki/Syntax untuk detail selengkapnya) |
FreeTextType
Jenis yang cocok dengan teks apa pun jika konteks kata di sekitarnya mendekati contoh pelatihan yang diberikan.
Representasi JSON | |
---|---|
{
"display": {
object ( |
Kolom | |
---|---|
display |
Opsional. Elemen yang akan ditampilkan di kanvas setelah entity diekstrak dari kueri. Hanya relevan untuk aplikasi yang mendukung kanvas. |
EntitySet
Kumpulan entity menjelaskan kumpulan entity yang telah ditentukan sebelumnya yang dapat menjadi sumber asal nilai parameter intent bawaan. Kumpulan entity dapat dirujuk dari entitySet dalam parameter intent bawaan.
Representasi JSON | |
---|---|
{
"entities": [
{
object ( |
Kolom | |
---|---|
entities[] |
Wajib. Daftar entitas yang didukung kumpulan entitas ini. |
Entitas
Entity yang dapat menghasilkan nilai parameter intent bawaan.
Representasi JSON | |
---|---|
{ "id": string } |
Kolom | |
---|---|
id |
Wajib. ID entitas. Untuk mengetahui daftar parameter intent bawaan dan entitas yang didukung, lihat https://developers.google.com/assistant/conversational/build/built-in-intents |
GlobalIntentEvent
Mendefinisikan pengendali intent global. Peristiwa intent global tercakup dalam seluruh project Action dan dapat diganti oleh pengendali intent dalam sebuah scene. Nama intent harus unik dalam project Action.
Intent global dapat dicocokkan kapan saja selama sesi, sehingga pengguna dapat mengakses alur umum seperti "dapatkan bantuan" atau "kembali ke beranda". Fungsi ini juga dapat digunakan untuk melakukan deep link pengguna ke dalam alur tertentu saat mereka memanggil Action.
Perhatikan, nama intent ditetapkan dalam nama file.
Representasi JSON | |
---|---|
{
"transitionToScene": string,
"handler": {
object ( |
Kolom | |
---|---|
transitionToScene |
Opsional. Adegan tujuan yang menjadi titik awal percakapan. Status scene saat ini dihapus pada transisi. |
handler |
Opsional. Pengendali peristiwa yang dipicu saat intent cocok. Harus dijalankan sebelum bertransisi ke scene tujuan. Berguna untuk membuat Prompt sebagai respons terhadap peristiwa. |
EventHandler
Menentukan pengendali yang akan dieksekusi setelah sebuah peristiwa. Contoh peristiwa adalah peristiwa berbasis intent dan kondisi dalam scene.
Representasi JSON | |
---|---|
{ "webhookHandler": string, // Union field |
Kolom | ||
---|---|---|
webhookHandler |
Nama pengendali webhook yang akan dipanggil. |
|
Kolom union prompt . Perintah dapat dibuat sebagai inline atau direferensikan oleh nama. prompt hanya dapat berupa salah satu dari berikut: |
||
staticPrompt |
Perintah statis inline. Dapat berisi referensi ke resource string dalam paket. |
|
staticPromptName |
Nama prompt statis yang akan dipanggil. |
StaticPrompt
Mewakili daftar kandidat prompt, salah satunya akan dipilih sebagai prompt yang akan ditampilkan sebagai respons terhadap pengguna. Pesan ini dapat dilokalkan.
Representasi JSON | |
---|---|
{
"candidates": [
{
object ( |
Kolom | |
---|---|
candidates[] |
Daftar perintah kandidat yang akan dikirim ke klien. Setiap prompt memiliki pemilih untuk menentukan kapan prompt tersebut dapat digunakan. Pemilih pertama yang cocok dengan permintaan akan dikirim dan sisanya akan diabaikan. |
StaticPromptCandidate
Mewakili kandidat prompt statis.
Representasi JSON | |
---|---|
{ "selector": { object ( |
Kolom | |
---|---|
selector |
Opsional. Kriteria apakah dialog ini cocok dengan permintaan. Jika pemilih kosong, dialog ini akan selalu dipicu. |
promptResponse |
Respons perintah yang terkait dengan pemilih. |
Pemilih
Menentukan kriteria apakah prompt cocok dengan permintaan.
Representasi JSON | |
---|---|
{
"surfaceCapabilities": {
object ( |
Kolom | |
---|---|
surfaceCapabilities |
Kumpulan kemampuan permukaan yang diperlukan. |
SurfaceCapabilities
Menampilkan permukaan yang digunakan pengguna untuk membuat permintaan ke Action.
Representasi JSON | |
---|---|
{
"capabilities": [
enum ( |
Kolom | |
---|---|
capabilities[] |
Wajib. Kemampuan platform yang membuat permintaan ke Action. |
Kemampuan
Kemampuan yang didukung platform perangkat pada saat permintaan.
Enum | |
---|---|
UNSPECIFIED |
Kemampuan platform tidak ditentukan. |
SPEECH |
Perangkat dapat berbicara dengan pengguna melalui text-to-speech atau SSML. |
RICH_RESPONSE |
Perangkat dapat menampilkan respons lengkap seperti kartu, daftar, dan tabel. |
LONG_FORM_AUDIO |
Perangkat dapat memutar media audio berdurasi panjang seperti musik dan podcast. |
INTERACTIVE_CANVAS |
Perangkat dapat menampilkan respons kanvas interaktif. |
WEB_LINK |
Perangkat dapat menggunakan link web dalam respons lengkap untuk membuka browser web. |
HOME_STORAGE |
Perangkat dapat mendukung penyimpanan dan pengambilan penyimpanan rumah. |
StaticPromptResponse
Mewakili respons terstruktur yang akan dikirim kepada pengguna, seperti teks, ucapan, kartu, data kanvas, chip saran, dll.
Representasi JSON | |
---|---|
{ "firstSimple": { object ( |
Kolom | |
---|---|
firstSimple |
Opsional. Respons suara dan teks saja pertama. |
content |
Opsional. Konten seperti kartu, daftar, atau media yang akan ditampilkan kepada pengguna. |
lastSimple |
Opsional. Suara terakhir dan respons hanya teks. |
suggestions[] |
Opsional. Saran untuk ditampilkan kepada pengguna, yang akan selalu muncul di akhir respons. Jika kolom |
link |
Opsional. Chip saran tambahan yang dapat ditautkan ke aplikasi atau situs terkait. Chip akan dirender dengan judul "Open |
override |
Opsional. Mode untuk menggabungkan pesan ini dengan pesan yang telah ditetapkan sebelumnya. |
canvas |
Respons yang akan digunakan untuk pengalaman kanvas interaktif. |
StaticSimplePrompt
Menampilkan prompt sederhana yang akan dikirim ke pengguna.
Representasi JSON | |
---|---|
{
"variants": [
{
object ( |
Kolom | |
---|---|
variants[] |
Daftar kemungkinan varian. |
Varian
Mewakili varian yang merupakan bagian dari perintah sederhana.
Representasi JSON | |
---|---|
{ "speech": string, "text": string } |
Kolom | |
---|---|
speech |
Opsional. Menunjukkan ucapan yang akan diucapkan kepada pengguna. Dapat berupa SSML atau text to speech. Secara default, ucapan akan ditambahkan ke ucapan perintah Sederhana sebelumnya. Jika kolom |
text |
Opsional. Teks yang akan ditampilkan dalam balon chat. Jika tidak diberikan, rendering tampilan untuk kolom ucapan di atas akan digunakan. Dibatasi hingga 640 karakter. Secara default, teks akan ditambahkan ke teks Dialog sederhana sebelumnya. Jika kolom |
StaticContentPrompt
Placeholder untuk bagian Konten pada StaticPrompt.
Representasi JSON | |
---|---|
{ // Union field |
Kolom | ||
---|---|---|
Kolom union content . Hanya satu jenis konten yang boleh ditampilkan di Prompt. content hanya dapat berupa salah satu dari berikut: |
||
card |
Kartu dasar. |
|
image |
Gambar. |
|
table |
Kartu tabel. |
|
media |
Respons yang menunjukkan kumpulan media yang akan diputar. |
|
list |
Kartu untuk menyajikan daftar opsi yang dapat dipilih. |
|
collection |
Kartu yang menampilkan daftar opsi yang dapat dipilih. |
|
collectionBrowse |
Kartu yang menampilkan kumpulan halaman web yang akan dibuka. |
StaticCardPrompt
Kartu dasar untuk menampilkan beberapa informasi, misalnya gambar dan/atau teks.
Representasi JSON | |
---|---|
{ "title": string, "subtitle": string, "text": string, "image": { object ( |
Kolom | |
---|---|
title |
Opsional. Keseluruhan judul kartu. |
subtitle |
Opsional. Subtitel kartu. |
text |
Wajib. Teks isi kartu yang diperlukan kecuali ada gambar. Mendukung serangkaian sintaksis markdown terbatas untuk pemformatan. |
image |
Opsional. Banner besar untuk kartu. Tinggi ditetapkan ke 192 dp. |
imageFill |
Opsional. Cara latar belakang gambar akan diisi. |
button |
Opsional. Tombol yang dapat diklik untuk ditampilkan di Kartu. |
StaticImagePrompt
Gambar yang ditampilkan di kartu.
Representasi JSON | |
---|---|
{ "url": string, "alt": string, "height": integer, "width": integer } |
Kolom | |
---|---|
url |
Wajib. URL sumber gambar. Gambar dapat berupa JPG, PNG, dan GIF (animasi dan non-animasi). Misalnya, |
alt |
Wajib. Deskripsi teks dari gambar yang akan digunakan untuk aksesibilitas, misalnya {i>screen reader <i}(pembaca layar). |
height |
Opsional. Tinggi gambar dalam piksel. |
width |
Opsional. Lebar gambar dalam piksel. |
ImageFill
Opsi tampilan gambar yang mungkin untuk memengaruhi penyajian gambar. Ini harus digunakan jika rasio aspek gambar tidak cocok dengan rasio aspek penampung gambar.
Enum | |
---|---|
UNSPECIFIED |
ImageFill belum ditetapkan. |
GRAY |
Isi celah antara gambar dan penampung gambar dengan kotak abu-abu. |
WHITE |
Isi celah antara gambar dan penampung gambar dengan kotak putih. |
CROPPED |
Gambar diskalakan sedemikian rupa sehingga lebar dan tinggi gambar sesuai atau melebihi dimensi container. 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 dengan rasio aspek 4:3. |
StaticLinkPrompt
Menentukan link yang akan ditampilkan sebagai chip saran dan dapat dibuka oleh pengguna.
Representasi JSON | |
---|---|
{
"name": string,
"open": {
object ( |
Kolom | |
---|---|
name |
Nama tautan |
open |
Menentukan perilaku saat pengguna membuka link. |
OpenUrl
Menentukan perilaku saat pengguna membuka link.
Representasi JSON | |
---|---|
{
"url": string,
"hint": enum ( |
Kolom | |
---|---|
url |
Kolom URL yang dapat berupa: - URL http/https untuk membuka Aplikasi yang Tertaut Aplikasi atau halaman web |
hint |
Menunjukkan petunjuk untuk jenis URL. |
UrlHint
Berbagai jenis petunjuk URL.
Enum | |
---|---|
HINT_UNSPECIFIED |
Tidak ditentukan |
AMP |
URL yang mengarah langsung ke konten AMP, atau URL kanonis yang merujuk ke konten AMP melalui <link rel="amphtml"> . |
StaticTablePrompt
Kartu tabel untuk menampilkan tabel teks.
Representasi JSON | |
---|---|
{ "title": string, "subtitle": string, "image": { object ( |
Kolom | |
---|---|
title |
Opsional. Judul tabel keseluruhan. Harus disetel jika subtitel disetel. |
subtitle |
Opsional. Subtitel untuk tabel. |
image |
Opsional. Gambar yang terkait dengan tabel. |
columns[] |
Opsional. Header dan perataan kolom. |
rows[] |
Opsional. Data baris pada tabel. Tiga baris pertama dijamin akan ditampilkan, tetapi baris lainnya mungkin dipotong di platform tertentu. Uji dengan simulator guna melihat baris yang akan ditampilkan untuk platform tertentu. Pada platform yang mendukung kemampuan |
button |
Opsional. Tombol. |
TableColumn
Menjelaskan kolom dalam tabel.
Representasi JSON | |
---|---|
{
"header": string,
"align": enum ( |
Kolom | |
---|---|
header |
Teks header untuk kolom. |
align |
Perataan horizontal kolom w.r.t konten. Jika tidak ditentukan, konten akan disejajarkan dengan bagian tepi utama. |
HorizontalAlignment
Perataan konten di dalam sel.
Enum | |
---|---|
UNSPECIFIED |
HorizontalAlignment belum ditentukan. |
LEADING |
Tepi depan sel. Ini adalah defaultnya. |
CENTER |
Konten sejajar dengan bagian tengah kolom. |
TRAILING |
Konten sejajar dengan tepi akhir kolom. |
TableRow
Mendeskripsikan baris dalam tabel.
Representasi JSON | |
---|---|
{
"cells": [
{
object ( |
Kolom | |
---|---|
cells[] |
Sel di baris ini. Tiga sel pertama dijamin akan ditampilkan, tetapi sel lainnya mungkin terpotong pada permukaan tertentu. Uji dengan simulator untuk mengetahui sel mana yang akan ditampilkan untuk permukaan tertentu. |
divider |
Menunjukkan apakah harus ada pemisah setelah setiap baris. |
TableCell
Menggambarkan sel dalam baris.
Representasi JSON | |
---|---|
{ "text": string } |
Kolom | |
---|---|
text |
Konten teks dalam sel. |
StaticMediaPrompt
Berisi informasi tentang media, seperti nama, deskripsi, URL, dll. ID berikutnya: 11
Representasi JSON | |
---|---|
{ "mediaType": enum ( |
Kolom | |
---|---|
mediaType |
Jenis media respons ini. |
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 disetel, permintaan akan dibuat ke pihak ketiga saat peristiwa media tertentu terjadi. Jika tidak ditetapkan, 3p tetap harus menangani dua jenis kontrol default, FINISHED dan FAILED. |
mediaObjects[] |
Daftar objek media. |
repeatMode |
Mode pengulangan untuk daftar Objek Media. |
MediaType
Jenis media respons ini.
Enum | |
---|---|
MEDIA_TYPE_UNSPECIFIED |
Nilai UNSPECIFIED |
AUDIO |
File audio. |
MEDIA_STATUS_ACK |
Respons untuk mengonfirmasi laporan status media. |
OptionalMediaControls
Jenis kontrol media yang dapat didukung respons media secara opsional
Enum | |
---|---|
OPTIONAL_MEDIA_CONTROLS_UNSPECIFIED |
Nilai belum ditetapkan |
PAUSED |
Acara dijeda. Dipicu saat pengguna menjeda media. |
STOPPED |
Peristiwa 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 di dalam MediaPrompt.
Representasi JSON | |
---|---|
{ // Union field |
Kolom | ||
---|---|---|
Kolom union image . Hanya satu jenis MediaImage yang diizinkan. image hanya dapat berupa salah satu dari berikut: |
||
large |
Gambar berukuran besar, seperti sampul album, dll. |
|
icon |
Ikon gambar kecil ditampilkan di sebelah kanan dari judul. Ukurannya diubah menjadi 36x36 dp. |
RepeatMode
Jenis mode pengulangan untuk daftar objek media.
Enum | |
---|---|
REPEAT_MODE_UNSPECIFIED |
Setara dengan MATI. |
OFF |
Akhiri sesi media di akhir objek media terakhir. |
ALL |
Memutar ke awal objek media pertama saat akhir objek media terakhir tercapai. |
StaticListPrompt
Kartu untuk menyajikan daftar opsi yang dapat dipilih.
Representasi JSON | |
---|---|
{
"title": string,
"subtitle": string,
"items": [
{
object ( |
Kolom | |
---|---|
title |
Opsional. Judul daftar. |
subtitle |
Opsional. Subtitel daftar. |
items[] |
Wajib. Item daftar. |
ListItem
Item dalam daftar.
Representasi JSON | |
---|---|
{
"key": string,
"title": string,
"description": string,
"image": {
object ( |
Kolom | |
---|---|
key |
Wajib. Kunci NLU yang cocok dengan nama kunci entri dalam jenis terkait. Saat item diketuk, kunci ini akan diposting kembali sebagai parameter opsi pilih. |
title |
Wajib. Judul item. Saat diketuk, teks ini akan diposting kembali ke percakapan kata demi kata seolah-olah pengguna telah mengetiknya. Setiap judul harus unik di antara kumpulan item. |
description |
Opsional. Teks isi item. |
image |
Opsional. Gambar item. |
StaticCollectionPrompt
Kartu untuk menyajikan kumpulan opsi yang dapat dipilih.
Representasi JSON | |
---|---|
{ "title": string, "subtitle": string, "items": [ { object ( |
Kolom | |
---|---|
title |
Opsional. Judul koleksi. |
subtitle |
Opsional. Subtitel koleksi. |
items[] |
Wajib. Item koleksi. |
imageFill |
Opsional. Jenis opsi tampilan gambar. |
CollectionItem
Item dalam koleksi.
Representasi JSON | |
---|---|
{
"key": string,
"title": string,
"description": string,
"image": {
object ( |
Kolom | |
---|---|
key |
Wajib. Kunci NLU yang cocok dengan nama kunci entri di Jenis yang terkait. Saat item diketuk, kunci ini akan diposting kembali sebagai parameter opsi pilih. |
title |
Wajib. Judul item. Saat diketuk, teks ini akan diposting kembali ke percakapan kata demi kata seolah-olah pengguna telah mengetiknya. Setiap judul harus unik di antara kumpulan item. |
description |
Opsional. Teks isi item. |
image |
Opsional. Gambar item. |
StaticCollectionBrowsePrompt
Menyajikan serangkaian dokumen web sebagai kumpulan item ubin besar. Item dapat dipilih untuk meluncurkan dokumen web terkait di penampil web.
Representasi JSON | |
---|---|
{ "items": [ { object ( |
Kolom | |
---|---|
items[] |
Item dalam koleksi penjelajahan. Ukuran daftar harus dalam rentang [2, 10]. |
imageFill |
Opsi tampilan gambar untuk gambar dalam koleksi. |
CollectionBrowseItem
Item dalam koleksi.
Representasi JSON | |
---|---|
{ "title": string, "description": string, "footer": string, "image": { object ( |
Kolom | |
---|---|
title |
Wajib. Judul item koleksi. |
description |
Deskripsi item koleksi. |
footer |
Teks footer untuk item koleksi, ditampilkan di bawah deskripsi. Satu baris teks, terpotong dengan elipsis. |
image |
Gambar untuk item koleksi. |
openUriAction |
Wajib. URI yang akan dibuka jika item dipilih. |
Saran
Mewakili chip saran, yaitu elemen UI yang ditampilkan kepada pengguna untuk memudahkan.
Representasi JSON | |
---|---|
{ "title": string } |
Kolom | |
---|---|
title |
Wajib. Teks yang ditampilkan dalam 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. Maksimal 25 karakter |
StaticCanvasPrompt
Merepresentasikan respons Canvas Interaktif yang akan dikirim ke pengguna. Ini dapat digunakan bersama dengan kolom firstSimple
dalam perintah yang berisi untuk berbicara dengan pengguna selain menampilkan respons kanvas interaktif.
Representasi JSON | |
---|---|
{ "url": string, "data": [ value ], "suppressMic": boolean, "sendStateDataToCanvasApp": boolean, "enableFullScreen": boolean } |
Kolom | |
---|---|
url |
Wajib. URL tampilan web yang akan dimuat. |
data[] |
Opsional. Data JSON akan diteruskan ke halaman web pengalaman imersif sebagai peristiwa. Jika kolom |
suppressMic |
Opsional. Nilai sebenarnya berarti bahwa mikrofon tidak akan dibuka untuk menangkap input setelah respons imersif ini ditampilkan kepada pengguna. |
sendStateDataToCanvasApp |
Opsional. Jika |
enableFullScreen |
Opsional. Jika |
Scene
Scene adalah unit dasar alur kontrol saat mendesain percakapan. Fragmen ini dapat digabungkan dengan scene lain, membuat prompt untuk pengguna akhir, dan menentukan slot. Nama suasana ditetapkan dalam nama file.
Representasi JSON | |
---|---|
{ "onEnter": { object ( |
Kolom | |
---|---|
onEnter |
Pengendali yang akan dipanggil saat bertransisi ke scene ini. |
intentEvents[] |
Daftar peristiwa yang dipicu berdasarkan intent. Peristiwa ini dapat dipicu kapan saja setelah Handler on_load dipanggil. Penting - peristiwa ini menentukan kumpulan intent yang dicakup dalam scene ini dan akan lebih diutamakan daripada peristiwa yang ditetapkan secara global yang memiliki intent yang sama atau frasa pemicunya. Nama intent harus unik dalam scene. |
conditionalEvents[] |
Daftar peristiwa yang akan dipicu berdasarkan pernyataan bersyarat. Ini dievaluasi setelah formulir diisi atau segera setelah on_load jika adegan ini tidak memiliki formulir (evaluasi hanya dilakukan sekali). Hanya peristiwa pencocokan pertama yang akan dipicu. |
slots[] |
Daftar slot yang diurutkan. Setiap slot menentukan jenis data yang akan diselesaikan dan dikonfigurasi untuk menyesuaikan pengalaman resolusi ini (misalnya perintah). |
onSlotUpdated |
Pengendali dipanggil saat ada perubahan status slot yang tidak disebabkan oleh pembaruan dalam Pengendali lain. Hal ini memungkinkan slot menjadi tidak valid, scene menjadi tidak valid, atau perubahan lain pada status scene. |
IntentEvent
Mendaftarkan Peristiwa yang terpicu sebagai hasil dari kecocokan intent.
Representasi JSON | |
---|---|
{
"intent": string,
"transitionToScene": string,
"handler": {
object ( |
Kolom | |
---|---|
intent |
Wajib. Intent yang memicu peristiwa. |
transitionToScene |
Opsional. Adegan tujuan yang menjadi titik awal percakapan. Status scene saat ini dihapus pada transisi. |
handler |
Opsional. Pengendali peristiwa yang dipicu saat intent cocok. Harus dieksekusi sebelum bertransisi ke scene tujuan. Berguna untuk membuat prompt sebagai respons terhadap peristiwa. |
ConditionalEvent
Mendaftarkan peristiwa yang terpicu sebagai hasil dari kondisi sebenarnya.
Representasi JSON | |
---|---|
{
"condition": string,
"transitionToScene": string,
"handler": {
object ( |
Kolom | |
---|---|
condition |
Wajib. Kondisi filter untuk memicu peristiwa ini. Jika kondisi dievaluasi ke benar (true), |
transitionToScene |
Opsional. Adegan tujuan tempat percakapan harus melompat saat kondisi terkait dievaluasi ke benar (true). Status scene saat ini dihapus pada transisi. |
handler |
Opsional. Pengendali peristiwa yang dipicu saat kondisi terkait dievaluasi ke |
Slot
Konfigurasi untuk slot. Slot adalah unit tunggal data yang dapat diisi melalui natural language (yaitu parameter intent), parameter sesi, dan sumber lainnya.
Representasi JSON | |
---|---|
{ "name": string, "type": { object ( |
Kolom | |
---|---|
name |
Wajib. Nama slot. |
type |
Wajib. Mendeklarasikan jenis data slot ini. |
required |
Opsional. Menunjukkan apakah slot harus diisi sebelum melanjutkan. Slot wajib yang tidak terisi akan memicu perintah yang dapat disesuaikan kepada pengguna. |
promptSettings |
Opsional. Mendaftarkan Perintah untuk berbagai tahap pengisian slot. |
commitBehavior |
Opsional. Perilaku commit yang terkait dengan slot. |
config |
Opsional. Konfigurasi tambahan yang terkait dengan slot yang digunakan untuk mengisi slot. Format konfigurasi bersifat khusus untuk jenis slot. Referensi resource untuk parameter pengguna atau sesi dapat ditambahkan ke konfigurasi ini. Konfigurasi ini diperlukan untuk mengisi slot yang terkait dengan transaksi dan engagement pengguna. Contoh: Untuk slot jenis actions.type.CompletePurchaseValue, konfigurasi berikut mengusulkan pesanan konten digital dengan referensi ke parameter sesi yang ditentukan klien { "@type": "type.googleapis.com/ google.actions.transactions.v3.CompletePurchaseValueSpec", "skuId": { "skuType": "SKU_TYPE_IN_APP", "id": "$session.params.userSelectedSkuId", "packageName": "com.example.company" } |
defaultValue |
Opsional. Konfigurasi untuk mengisi nilai default untuk slot ini. |
PromptSettings
Satu tempat yang ditentukan untuk perintah slot.
Representasi JSON | |
---|---|
{ "initialPrompt": { object ( |
Kolom | |
---|---|
initialPrompt |
Minta nilai slot itu sendiri. Contoh: "Ukuran apa yang Anda inginkan?" |
noMatchPrompt1 |
Prompt untuk memberikan jika input pengguna tidak cocok dengan jenis nilai yang diharapkan untuk slot untuk pertama kalinya. Contoh: "Maaf, saya tidak mengerti". |
noMatchPrompt2 |
Prompt untuk memberikan jika input pengguna tidak cocok dengan jenis nilai yang diharapkan untuk slot untuk kedua kalinya. Contoh: "Maaf, saya tidak mengerti". |
noMatchFinalPrompt |
Prompt untuk memberikan jika input pengguna tidak cocok dengan jenis nilai yang diharapkan untuk slot untuk terakhir kalinya. Contoh: "Maaf, saya tidak mengerti". |
noInputPrompt1 |
Prompt untuk memberikan jika pengguna tidak memberikan input untuk pertama kalinya. Contoh: "Maaf, saya tidak mengerti". |
noInputPrompt2 |
Prompt untuk memberikan ketika pengguna tidak memberikan input untuk kedua kalinya. Contoh: "Maaf, saya tidak mengerti". |
noInputFinalPrompt |
Prompt untuk memberikan jika pengguna tidak memberikan input untuk terakhir kalinya. Contoh: "Maaf, saya tidak mengerti". |
CommitBehavior
Pesan yang menjelaskan perilaku commit yang terkait dengan slot setelah berhasil diisi.
Representasi JSON | |
---|---|
{ "writeSessionParam": string } |
Kolom | |
---|---|
writeSessionParam |
Parameter sesi untuk menulis nilai slot setelah diisi. Perhatikan bahwa jalur bertingkat saat ini tidak didukung. "$$" digunakan untuk menulis nilai slot ke parameter sesi dengan nama yang sama dengan slot. Misalnya: writeSessionParam = "fruit" sesuai dengan "$session.params.fruit". writeSessionParam = "tiket" sesuai dengan "$session.params.ticket". |
DefaultValue
Konfigurasi untuk mengisi nilai default untuk slot ini.
Representasi JSON | |
---|---|
{ "sessionParam": string, "constant": value } |
Kolom | |
---|---|
sessionParam |
Opsional. Parameter sesi yang akan digunakan untuk melakukan inisialisasi nilai slot, jika memiliki nilai yang tidak kosong. Jenis nilai harus sesuai dengan jenis slot. Perhatikan bahwa jalur bertingkat saat ini tidak didukung. Misalnya: |
constant |
Opsional. Nilai default konstan untuk slot. Ini hanya akan digunakan jika nilai untuk slot ini tidak diisi melalui |
DataFiles
Wrapper untuk file data berulang. Kolom berulang tidak boleh ada di salah satu dari keduanya.
Representasi JSON | |
---|---|
{
"dataFiles": [
{
object ( |
Kolom | |
---|---|
dataFiles[] |
Beberapa file data. |
DataFile
Mewakili satu file yang berisi data tidak terstruktur. Contohnya mencakup file gambar, file audio, dan kode sumber cloud function.
Representasi JSON | |
---|---|
{ "filePath": string, "contentType": string, "payload": string } |
Kolom | |
---|---|
filePath |
Jalur relatif file data dari root project dalam struktur file SDK. Jalur file yang diizinkan: - Gambar: |
contentType |
Wajib. Jenis konten aset ini. Contoh: |
payload |
Konten file data. Contohnya dapat berupa byte mentah gambar, file audio, atau format zip cloud function. Ada batas ketat 10 MB untuk ukuran payload. String berenkode base64. |