StaticPrompt

Mewakili daftar kandidat perintah, salah satunya akan dipilih sebagai perintah yang akan ditampilkan dalam respons kepada pengguna. Pesan ini dapat dilokalkan.

Representasi JSON
{
  "candidates": [
    {
      object (StaticPromptCandidate)
    }
  ]
}
Kolom
candidates[]

object (StaticPromptCandidate)

Daftar perintah kandidat yang akan dikirim ke klien. Setiap dialog memiliki pemilih untuk menentukan kapan dapat digunakan. Pemilih pertama yang cocok dengan permintaan akan dikirim dan pemilih lainnya akan diabaikan.

StaticPromptCandidate

Mewakili kandidat perintah statis.

Representasi JSON
{
  "selector": {
    object (Selector)
  },
  "promptResponse": {
    object (StaticPromptResponse)
  }
}
Kolom
selector

object (Selector)

Opsional. Kriteria apakah dialog ini cocok dengan permintaan. Jika pemilih kosong, permintaan ini akan selalu dipicu.

promptResponse

object (StaticPromptResponse)

Respons cepat yang terkait dengan pemilih.

Pemilih

Menentukan kriteria apakah dialog cocok dengan permintaan.

Representasi JSON
{
  "surfaceCapabilities": {
    object (SurfaceCapabilities)
  }
}
Kolom
surfaceCapabilities

object (SurfaceCapabilities)

Kumpulan kemampuan platform yang diperlukan.

SurfaceCapabilities

Menampilkan platform yang digunakan pengguna untuk membuat permintaan ke Action.

Representasi JSON
{
  "capabilities": [
    enum (Capability)
  ]
}
Kolom
capabilities[]

enum (Capability)

Wajib. Kemampuan platform yang membuat permintaan ke Action.

StaticPromptResponse

Menampilkan respons terstruktur untuk dikirim kepada pengguna, seperti teks, ucapan, kartu, data kanvas, chip saran, dll.

Representasi JSON
{
  "firstSimple": {
    object (StaticSimplePrompt)
  },
  "content": {
    object (StaticContentPrompt)
  },
  "lastSimple": {
    object (StaticSimplePrompt)
  },
  "suggestions": [
    {
      object (Suggestion)
    }
  ],
  "link": {
    object (StaticLinkPrompt)
  },
  "override": boolean,
  "canvas": {
    object (StaticCanvasPrompt)
  }
}
Kolom
firstSimple

object (StaticSimplePrompt)

Opsional. Respons pertama yang hanya berisi teks dan suara.

content

object (StaticContentPrompt)

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

lastSimple

object (StaticSimplePrompt)

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 "tambahkan" di dialog yang memuatnya bernilai "benar", judul yang ditentukan dalam kolom ini akan ditambahkan ke judul yang ditentukan dalam perintah saran yang ditentukan sebelumnya dan nilai duplikat akan dihapus.

override

boolean

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

canvas

object (StaticCanvasPrompt)

Respons yang akan digunakan untuk pengalaman kanvas interaktif.

StaticSimplePrompt

Menampilkan perintah sederhana yang akan dikirim ke pengguna.

Representasi JSON
{
  "variants": [
    {
      object (Variant)
    }
  ]
}
Kolom
variants[]

object (Variant)

Daftar kemungkinan varian.

Varian

Menampilkan varian yang merupakan bagian dari prompt sederhana.

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 "append" di prompt yang memuatnya adalah "true", ucapan yang ditentukan dalam kolom ini akan ditambahkan ke ucapan prompt Sederhana sebelumnya.

text

string

Opsional. Teks yang akan ditampilkan dalam balon chat. Jika tidak diberikan, rendering tampilan untuk kolom ucapan di atas akan digunakan. Dibatasi hingga 640 karakter. Jika kolom "append" di prompt yang memuatnya bernilai "true", teks yang ditentukan dalam kolom ini akan ditambahkan ke teks prompt Sederhana sebelumnya.

StaticContentPrompt

Placeholder untuk bagian Content pada StaticPrompt.

Representasi JSON
{

  // Union field content can be only one of the following:
  "card": {
    object (StaticCardPrompt)
  },
  "image": {
    object (StaticImagePrompt)
  },
  "table": {
    object (StaticTablePrompt)
  },
  "media": {
    object (StaticMediaPrompt)
  },
  "list": {
    object (StaticListPrompt)
  },
  "collection": {
    object (StaticCollectionPrompt)
  }
  // End of list of possible types for union field content.
}
Kolom
Kolom union content. Hanya satu jenis konten yang boleh ada di Perintah. content hanya ada berupa salah satu diantara berikut:
card

object (StaticCardPrompt)

Kartu dasar.

image

object (StaticImagePrompt)

Gambar.

table

object (StaticTablePrompt)

Kartu tabel.

media

object (StaticMediaPrompt)

Respons yang menunjukkan sekumpulan media yang akan diputar.

list

object (StaticListPrompt)

Kartu untuk menampilkan daftar opsi yang dapat dipilih.

collection

object (StaticCollectionPrompt)

Kartu yang menampilkan daftar opsi untuk dipilih.

StaticCardPrompt

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

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

string

Opsional. Judul kartu secara keseluruhan.

subtitle

string

Opsional. Subtitel kartu.

text

string

Wajib. Teks isi kartu yang diperlukan kecuali ada gambar. Mendukung serangkaian sintaksis markdown terbatas untuk pemformatan.

image

object (StaticImagePrompt)

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

imageFill

enum (ImageFill)

Opsional. Cara mengisi latar belakang gambar.

button

object (StaticLinkPrompt)

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

string

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

alt

string

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

height

integer

Opsional. Tinggi gambar dalam piksel.

width

integer

Opsional. Lebar gambar dalam piksel.

StaticLinkPrompt

Menentukan link yang akan ditampilkan sebagai chip saran dan dapat dibuka oleh pengguna.

Representasi JSON
{
  "name": string,
  "open": {
    object (OpenUrl)
  }
}
Kolom
name

string

Nama link

open

object (OpenUrl)

Menentukan perilaku saat pengguna membuka link.

OpenUrl

Menentukan perilaku 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.

StaticTablePrompt

Kartu tabel untuk menampilkan tabel teks.

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

string

Opsional. Judul tabel secara keseluruhan. Harus disetel jika subtitel sudah disetel.

subtitle

string

Opsional. Subtitel untuk tabel.

image

object (StaticImagePrompt)

Opsional. Gambar yang terkait dengan tabel.

columns[]

object (TableColumn)

Opsional. Header dan perataan kolom.

rows[]

object (TableRow)

Opsional. 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 (StaticLinkPrompt)

Opsional. 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.

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.

StaticMediaPrompt

Berisi informasi tentang media, seperti nama, deskripsi, URL, dll. ID berikutnya: 9

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

enum (MediaType)

Jenis media respons ini.

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.

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 di dalam MediaPrompt.

Representasi JSON
{

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

object (StaticImagePrompt)

Gambar besar, seperti sampul album, dll.

icon

object (StaticImagePrompt)

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

StaticListPrompt

Kartu untuk menampilkan daftar opsi yang dapat dipilih.

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

string

Opsional. Judul daftar.

subtitle

string

Opsional. Subtitel daftar.

items[]

object (ListItem)

Wajib. Daftar item.

ListItem

Item dalam daftar.

Representasi JSON
{
  "key": string,
  "title": string,
  "description": string,
  "image": {
    object (StaticImagePrompt)
  }
}
Kolom
key

string

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

string

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

string

Opsional. Teks isi item.

image

object (StaticImagePrompt)

Opsional. Gambar item.

StaticCollectionPrompt

Kartu untuk menampilkan kumpulan opsi yang dapat dipilih.

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

string

Opsional. Judul koleksi.

subtitle

string

Opsional. Subtitel koleksi.

items[]

object (CollectionItem)

Wajib. Item koleksi.

imageFill

enum (ImageFill)

Opsional. Jenis opsi tampilan gambar.

CollectionItem

Item dalam koleksi.

Representasi JSON
{
  "key": string,
  "title": string,
  "description": string,
  "image": {
    object (StaticImagePrompt)
  }
}
Kolom
key

string

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

string

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

string

Opsional. Teks isi item.

image

object (StaticImagePrompt)

Opsional. Gambar item.

Saran

Mewakili chip saran, elemen UI yang ditampilkan kepada pengguna untuk kenyamanan.

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

StaticCanvasPrompt

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.

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

string

Wajib. URL tampilan web yang akan dimuat.

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 sebenarnya berarti mikrofon tidak akan dibuka untuk menangkap input setelah respons imersif ini ditampilkan kepada pengguna.