- StaticPromptCandidate
- ตัวเลือก
- SurfaceCapabilities
- StaticPromptResponse
- StaticSimplePrompt
- ผลิตภัณฑ์ย่อย
- StaticContentPrompt
- StaticCardPrompt
- StaticImagePrompt
- StaticLinkPrompt
- OpenUrl
- StaticTablePrompt
- TableColumn
- TableRow
- TableCell
- StaticMediaPrompt
- MediaObject
- MediaImage
- StaticListPrompt
- ListItem
- StaticCollectionPrompt
- CollectionItem
- คำแนะนำ
- StaticCanvasPrompt
แสดงรายชื่อพรอมต์ที่แนะนำ ซึ่งจะเลือก 1 รายการเป็นข้อความแจ้งที่จะแสดงในการตอบกลับผู้ใช้ ข้อความนี้แปลได้
การแสดง JSON | |
---|---|
{
"candidates": [
{
object ( |
ช่อง | |
---|---|
candidates[] |
รายการข้อความแจ้งของผู้สมัครที่จะส่งไปยังไคลเอ็นต์ ข้อความแจ้งแต่ละรายการจะมีตัวเลือกเพื่อระบุว่าจะใช้เมื่อใด ระบบจะส่งตัวเลือกแรกที่ตรงกับคำขอและจะไม่สนใจตัวเลือกที่เหลือ |
StaticPromptCandidate
แสดงตัวเลือกพรอมต์แบบคงที่
การแสดง JSON | |
---|---|
{ "selector": { object ( |
ช่อง | |
---|---|
selector |
ไม่บังคับ เกณฑ์ว่าข้อความแจ้งนี้ตรงกับคำขอหรือไม่ หากตัวเลือกว่างเปล่า ระบบจะทริกเกอร์ข้อความแจ้งนี้เสมอ |
promptResponse |
คำตอบพรอมต์ที่เชื่อมโยงกับตัวเลือก |
ตัวเลือก
กำหนดเกณฑ์ว่าข้อความแจ้งตรงกับคำขอหรือไม่
การแสดง JSON | |
---|---|
{
"surfaceCapabilities": {
object ( |
ช่อง | |
---|---|
surfaceCapabilities |
ชุดความสามารถของพื้นผิวที่จำเป็น |
SurfaceCapabilities
แสดงแพลตฟอร์มที่ผู้ใช้ใช้เพื่อส่งคำขอไปยังการดำเนินการ
การแสดง JSON | |
---|---|
{
"capabilities": [
enum ( |
ช่อง | |
---|---|
capabilities[] |
ต้องระบุ ความสามารถของแพลตฟอร์มในการส่งคำขอไปยังการดำเนินการ |
StaticPromptResponse
แสดงคำตอบที่มีโครงสร้างที่จะส่งให้ผู้ใช้ เช่น ข้อความ คำพูด การ์ด ข้อมูล Canvas ชิปคำแนะนำ ฯลฯ
การแสดง JSON | |
---|---|
{ "firstSimple": { object ( |
ช่อง | |
---|---|
firstSimple |
ไม่บังคับ คำตอบแรกที่เป็นเสียงและข้อความเท่านั้น |
content |
ไม่บังคับ เนื้อหา เช่น การ์ด รายการ หรือสื่อที่จะแสดงต่อผู้ใช้ |
lastSimple |
ไม่บังคับ คำตอบแบบเสียงและข้อความสุดท้าย |
suggestions[] |
ไม่บังคับ คำแนะนำที่แสดงต่อผู้ใช้ซึ่งจะปรากฏท้ายคำตอบเสมอ หากช่อง "ต่อท้าย" ในช่องของข้อความแจ้งที่มีค่าเป็น "true" ระบบจะเพิ่มชื่อที่กำหนดในช่องนี้ลงในชื่อที่กำหนดไว้ในข้อความแจ้งคำแนะนำที่กำหนดไว้ก่อนหน้านี้และค่าที่ซ้ำกันจะถูกนำออก |
link |
ไม่บังคับ ชิปคำแนะนำเพิ่มเติมที่สามารถลิงก์ไปยังแอปหรือเว็บไซต์ที่เกี่ยวข้องได้ ระบบจะแสดงผลชิปโดยใช้ชื่อ "เปิด |
override |
ไม่บังคับ โหมดสำหรับวิธีผสานข้อความนี้กับข้อความที่กำหนดไว้ก่อนหน้า "จริง" จะล้างข้อความที่กำหนดไว้ก่อนหน้านี้ทั้งหมด (แบบง่ายและสุดท้ายคือ เนื้อหา ลิงก์คำแนะนำ และ Canvas) และเพิ่มข้อความที่กำหนดไว้ในพรอมต์นี้ "เท็จ" จะเพิ่มข้อความที่กำหนดไว้ในพรอมต์นี้ไปยังข้อความที่กำหนดไว้ในคำตอบก่อนหน้า การตั้งค่าฟิลด์นี้เป็น "เท็จ" จะเปิดใช้การต่อท้ายบางช่องภายในพรอมต์แบบง่าย พรอมต์คำแนะนำ และข้อความแจ้งของ Canvas (ส่วนหนึ่งของพรอมต์เนื้อหา) ด้วย ข้อความ "เนื้อหา" และ "ลิงก์" จะถูกเขียนทับเสมอหากมีการกำหนดไว้ในข้อความแจ้ง ค่าเริ่มต้นคือ "false" |
canvas |
คำตอบที่จะนำไปใช้สำหรับประสบการณ์ Canvas แบบอินเทอร์แอกทีฟ |
StaticSimplePrompt
หมายถึงข้อความแจ้งง่ายๆ ที่จะส่งถึงผู้ใช้
การแสดง JSON | |
---|---|
{
"variants": [
{
object ( |
ช่อง | |
---|---|
variants[] |
รายการตัวแปรที่เป็นไปได้ |
ตัวแปร
แสดงตัวแปรที่เป็นส่วนหนึ่งของพรอมต์ง่ายๆ
การแสดง JSON | |
---|---|
{ "speech": string, "text": string } |
ช่อง | |
---|---|
speech |
ไม่บังคับ หมายถึงคำพูดที่ผู้ใช้พูด อาจเป็น SSML หรือการอ่านออกเสียงข้อความ หากช่อง "ต่อท้าย" ในช่องของข้อความแจ้งที่มีค่าเป็น "true" เสียงพูดที่กำหนดไว้ในฟิลด์นี้จะต่อท้ายเสียงพูดของพรอมต์ง่ายๆ ก่อนหน้า |
text |
ไม่บังคับ ข้อความที่จะแสดงในบับเบิลแชท หากไม่ระบุ ระบบจะใช้การแสดงผลฟิลด์เสียงพูดด้านบน มีอักขระได้ไม่เกิน 640 ตัว หากช่อง "ต่อท้าย" ในช่องของข้อความแจ้งที่มีค่าเป็น "true" ข้อความที่กำหนดในช่องนี้จะเพิ่มต่อท้ายข้อความของพรอมต์อย่างง่ายก่อนหน้า |
StaticContentPrompt
ตัวยึดตำแหน่งสำหรับส่วน Content ของ StaticPrompt
การแสดง JSON | |
---|---|
{ // Union field |
ช่อง | ||
---|---|---|
ช่องการรวม content แสดงเนื้อหาได้เพียงประเภทเดียวในพรอมต์ content ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้ |
||
card |
บัตรพื้นฐาน |
|
image |
รูปภาพ |
|
table |
การ์ดตาราง |
|
media |
การตอบกลับที่ระบุชุดสื่อที่จะเล่น |
|
list |
การ์ดสำหรับแสดงรายการตัวเลือกที่มีให้เลือก |
|
collection |
การ์ดแสดงรายการตัวเลือกที่มีให้เลือก |
StaticCardPrompt
การ์ดพื้นฐานสำหรับแสดงข้อมูลบางอย่าง เช่น รูปภาพและ/หรือข้อความ
การแสดง JSON | |
---|---|
{ "title": string, "subtitle": string, "text": string, "image": { object ( |
ช่อง | |
---|---|
title |
ไม่บังคับ ชื่อโดยรวมของการ์ด |
subtitle |
ไม่บังคับ คำบรรยายของการ์ด |
text |
ต้องระบุ ข้อความเนื้อหาของการ์ดซึ่งจำเป็นต้องใช้ เว้นแต่จะมีรูปภาพอยู่ รองรับชุดไวยากรณ์มาร์กดาวน์สำหรับการจัดรูปแบบแบบจำกัด |
image |
ไม่บังคับ รูปภาพหลักของการ์ด ความสูงกำหนดไว้ที่ 192dp |
imageFill |
ไม่บังคับ วิธีเติมพื้นหลังของรูปภาพ |
button |
ไม่บังคับ ปุ่มที่คลิกได้เพื่อแสดงในการ์ด |
StaticImagePrompt
รูปภาพที่แสดงในการ์ด
การแสดง JSON | |
---|---|
{ "url": string, "alt": string, "height": integer, "width": integer } |
ช่อง | |
---|---|
url |
ต้องระบุ URL แหล่งที่มาของรูปภาพ รูปภาพสามารถใช้เป็น JPG, PNG และ GIF (ทั้งเป็นภาพเคลื่อนไหวและไม่เคลื่อนไหว) ตัวอย่างเช่น |
alt |
ต้องระบุ ข้อความอธิบายรูปภาพที่ใช้สำหรับการเข้าถึง เช่น โปรแกรมอ่านหน้าจอ |
height |
ไม่บังคับ ความสูงของรูปภาพเป็นพิกเซล |
width |
ไม่บังคับ ความกว้างของรูปภาพเป็นพิกเซล |
StaticLinkPrompt
กำหนดลิงก์ซึ่งจะแสดงเป็นชิปคำแนะนำและผู้ใช้สามารถเปิดได้
การแสดง JSON | |
---|---|
{
"name": string,
"open": {
object ( |
ช่อง | |
---|---|
name |
ชื่อของลิงก์ |
open |
กำหนดลักษณะการทำงานเมื่อผู้ใช้เปิดลิงก์ |
OpenUrl
กำหนดลักษณะการทำงานเมื่อผู้ใช้เปิดลิงก์
การแสดง JSON | |
---|---|
{
"url": string,
"hint": enum ( |
ช่อง | |
---|---|
url |
ฟิลด์ URL อาจเป็นรายการใดก็ได้ต่อไปนี้ - URL http/https สำหรับเปิดแอปที่ลิงก์กับแอปหรือหน้าเว็บ |
hint |
เป็นคำแนะนำสำหรับประเภท URL |
StaticTablePrompt
การ์ดตารางสำหรับแสดงตารางข้อความ
การแสดง JSON | |
---|---|
{ "title": string, "subtitle": string, "image": { object ( |
ช่อง | |
---|---|
title |
ไม่บังคับ ชื่อโดยรวมของตาราง ต้องตั้งค่าหากมีการตั้งค่าคำบรรยาย |
subtitle |
ไม่บังคับ ชื่อรองของตาราง |
image |
ไม่บังคับ รูปภาพที่เชื่อมโยงกับตาราง |
columns[] |
ไม่บังคับ ส่วนหัวและการจัดแนวคอลัมน์ |
rows[] |
ไม่บังคับ ข้อมูลแถวของตาราง เรารับประกันว่าแถว 3 แถวแรกจะแสดงขึ้น แต่บางแถวอาจถูกตัดออกในบางแพลตฟอร์ม โปรดทดสอบกับเครื่องจำลองเพื่อดูว่าจะแสดงแถวใดสำหรับแพลตฟอร์มหนึ่งๆ ในแพลตฟอร์มที่รองรับความสามารถ WEB_BROWSER คุณสามารถชี้ผู้ใช้ไปยังหน้าเว็บที่มีข้อมูลเพิ่มเติมได้ |
button |
ไม่บังคับ ปุ่ม |
TableColumn
อธิบายคอลัมน์ในตาราง
การแสดง JSON | |
---|---|
{
"header": string,
"align": enum ( |
ช่อง | |
---|---|
header |
ข้อความส่วนหัวของคอลัมน์ |
align |
การจัดแนวแนวนอนของเนื้อหาในคอลัมน์ หากไม่ระบุ เนื้อหาจะอยู่ในแนวเดียวกับขอบนำหน้า |
TableRow
อธิบายแถวในตาราง
การแสดง JSON | |
---|---|
{
"cells": [
{
object ( |
ช่อง | |
---|---|
cells[] |
เซลล์ในแถวนี้ ระบบรับประกันว่าจะแสดง 3 เซลล์แรก แต่เซลล์อื่นๆ อาจถูกตัดออกในบางพื้นผิว โปรดทดสอบด้วยเครื่องมือจำลองเพื่อดูว่าจะแสดงเซลล์ใดบนพื้นผิวที่กำหนด |
divider |
ระบุว่าควรมีตัวแบ่งหลังจากแต่ละแถวหรือไม่ |
TableCell
อธิบายเซลล์ในแถว
การแสดง JSON | |
---|---|
{ "text": string } |
ช่อง | |
---|---|
text |
เนื้อหาข้อความของเซลล์ |
StaticMediaPrompt
มีข้อมูลเกี่ยวกับสื่อ เช่น ชื่อ คำอธิบาย URL ฯลฯ รหัสถัดไป: 9
การแสดง JSON | |
---|---|
{ "mediaType": enum ( |
ช่อง | |
---|---|
mediaType |
ประเภทสื่อของคำตอบนี้ |
startOffset |
ออฟเซ็ตเริ่มต้นของออบเจ็กต์สื่อแรก ระยะเวลาเป็นวินาทีโดยมีเลขเศษส่วนไม่เกิน 9 หลัก สิ้นสุดด้วย " |
optionalMediaControls[] |
ประเภทการควบคุมสื่อที่ไม่บังคับที่เซสชันการตอบสนองสื่อนี้รองรับได้ หากตั้งค่าไว้ จะมีการส่งคำขอไปยัง 3p เมื่อมีเหตุการณ์สื่อบางอย่างเกิดขึ้น หากไม่ได้ตั้งค่า 3p ยังคงต้องจัดการประเภทการควบคุมเริ่มต้น 2 ประเภท ได้แก่ FINISHED และ FAILED |
mediaObjects[] |
รายการออบเจ็กต์สื่อ |
MediaObject
แสดงออบเจ็กต์สื่อรายการเดียว
การแสดง JSON | |
---|---|
{
"name": string,
"description": string,
"url": string,
"image": {
object ( |
ช่อง | |
---|---|
name |
ชื่อออบเจ็กต์สื่อนี้ |
description |
คำอธิบายของออบเจ็กต์สื่อนี้ |
url |
URL ที่ชี้ไปยังเนื้อหาสื่อ |
image |
รูปภาพที่จะแสดงพร้อมการ์ดสื่อ |
MediaImage
รูปภาพที่จะแสดงภายใน MediaPrompt
การแสดง JSON | |
---|---|
{ // Union field |
ช่อง | ||
---|---|---|
ช่องการรวม image อนุญาตให้ใช้ MediaImage เพียงประเภทเดียวเท่านั้น image ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้ |
||
large |
รูปภาพขนาดใหญ่ เช่น ปกอัลบั้ม ฯลฯ |
|
icon |
ไอคอนรูปภาพขนาดเล็กที่แสดงอยู่ด้านขวาจากชื่อ โดยปรับขนาดเป็น 36x36 dp |
StaticListPrompt
การ์ดสำหรับแสดงรายการตัวเลือกที่มีให้เลือก
การแสดง JSON | |
---|---|
{
"title": string,
"subtitle": string,
"items": [
{
object ( |
ช่อง | |
---|---|
title |
ไม่บังคับ ชื่อรายการ |
subtitle |
ไม่บังคับ คำบรรยายของรายการ |
items[] |
ต้องระบุ รายการ |
ListItem
รายการข้อมูลในรายการ
การแสดง JSON | |
---|---|
{
"key": string,
"title": string,
"description": string,
"image": {
object ( |
ช่อง | |
---|---|
key |
ต้องระบุ คีย์ NLU ที่ตรงกับชื่อคีย์รายการในประเภทที่เชื่อมโยง เมื่อแตะรายการ คีย์นี้จะโพสต์กลับไปที่พารามิเตอร์ตัวเลือก |
title |
ต้องระบุ ชื่อของสินค้า เมื่อแตะ ข้อความนี้จะโพสต์กลับไปที่การสนทนาแบบคำต่อคำราวกับว่าผู้ใช้ได้พิมพ์ลงไป แต่ละชื่อต้องไม่ซ้ำกันในชุดรายการ |
description |
ไม่บังคับ ข้อความเนื้อหาของรายการ |
image |
ไม่บังคับ รูปภาพรายการ |
StaticCollectionPrompt
การ์ดสำหรับนำเสนอชุดตัวเลือกให้เลือก
การแสดง JSON | |
---|---|
{ "title": string, "subtitle": string, "items": [ { object ( |
ช่อง | |
---|---|
title |
ไม่บังคับ ชื่อคอลเล็กชัน |
subtitle |
ไม่บังคับ คำบรรยายของคอลเล็กชัน |
items[] |
ต้องระบุ รายการในคอลเล็กชัน |
imageFill |
ไม่บังคับ ตัวเลือกประเภทการแสดงรูปภาพ |
CollectionItem
รายการในคอลเล็กชัน
การแสดง JSON | |
---|---|
{
"key": string,
"title": string,
"description": string,
"image": {
object ( |
ช่อง | |
---|---|
key |
ต้องระบุ คีย์ NLU ที่ตรงกับชื่อคีย์รายการในประเภทที่เชื่อมโยง เมื่อแตะรายการ คีย์นี้จะโพสต์กลับไปที่พารามิเตอร์ตัวเลือก |
title |
ต้องระบุ ชื่อของสินค้า เมื่อแตะ ข้อความนี้จะโพสต์กลับไปที่การสนทนาแบบคำต่อคำราวกับว่าผู้ใช้ได้พิมพ์ลงไป แต่ละชื่อต้องไม่ซ้ำกันในชุดรายการ |
description |
ไม่บังคับ ข้อความเนื้อหาของรายการ |
image |
ไม่บังคับ รูปภาพรายการ |
คำแนะนำ
แสดงชิปคำแนะนำ ซึ่งเป็นองค์ประกอบ UI ที่แสดงต่อผู้ใช้เพื่อความสะดวก
การแสดง JSON | |
---|---|
{ "title": string } |
ช่อง | |
---|---|
title |
ต้องระบุ ข้อความที่แสดงในชิปคำแนะนำ เมื่อแตะ ข้อความนี้จะโพสต์กลับไปที่การสนทนาแบบคำต่อคำราวกับว่าผู้ใช้ได้พิมพ์ลงไป ชื่อแต่ละรายการต้องไม่ซ้ำกันในชุดชิปคำแนะนำ สูงสุด 25 อักขระ |
StaticCanvasPrompt
แสดงการตอบกลับ Interactive Canvas ที่จะส่งไปให้ผู้ใช้ ค่านี้สามารถใช้ร่วมกับ "firstSimple" ในข้อความแจ้งที่มีคำสั่งให้พูดกับผู้ใช้นอกเหนือจากการแสดงการตอบกลับ Canvas แบบอินเทอร์แอกทีฟ
การแสดง JSON | |
---|---|
{ "url": string, "data": [ value ], "suppressMic": boolean } |
ช่อง | |
---|---|
url |
ต้องระบุ URL ของมุมมองเว็บที่จะโหลด |
data[] |
ไม่บังคับ ข้อมูล JSON ที่จะส่งไปยังหน้าเว็บประสบการณ์แบบสมจริงเป็นเหตุการณ์ หากปุ่ม "ลบล้าง" ในช่องพรอมต์ที่มีอยู่มีค่าเป็น "เท็จ" ระบบจะเพิ่มค่าข้อมูลที่กําหนดไว้ในข้อความแจ้งของ Canvas นี้หลังจากค่าข้อมูลที่กําหนดไว้ในข้อความแจ้งก่อนหน้าของ Canvas |
suppressMic |
ไม่บังคับ ค่าจริงหมายความว่าไมโครโฟนจะไม่เปิดเพื่อจับอินพุตหลังจากแสดงการตอบสนองอย่างละเอียดนี้ต่อผู้ใช้ |