- 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[] |
ไม่บังคับ คำแนะนำที่จะแสดงแก่ผู้ใช้ ซึ่งจะปรากฏที่ตอนท้ายของคำตอบเสมอ หากช่อง "ต่อท้าย" ในข้อความแจ้งที่เป็น "จริง" เป็น "จริง" ระบบจะเพิ่มชื่อที่กำหนดในช่องนี้ไปยังชื่อที่กำหนดไว้ในพรอมต์คำแนะนำที่กำหนดไว้ก่อนหน้า และนำค่าที่ซ้ำออก |
link |
ไม่บังคับ ชิปคำแนะนำเพิ่มเติมที่ลิงก์ออกไปยังแอปหรือเว็บไซต์ที่เกี่ยวข้องได้ ชิปจะแสดงผลในชื่อ "เปิด |
override |
ไม่บังคับ โหมดสำหรับวิธีการรวมข้อความนี้กับข้อความที่กำหนดไว้ก่อนหน้า "true" จะล้างข้อความที่กำหนดไว้ก่อนหน้าทั้งหมด (ข้อความแรกและที่เรียบง่ายสุดท้าย เนื้อหา ลิงก์คำแนะนำ และ Canvas) แล้วเพิ่มข้อความที่กำหนดไว้ในพรอมต์นี้ "false" จะเพิ่มข้อความที่กำหนดไว้ในพรอมต์นี้ไปยังข้อความที่กำหนดไว้ในคำตอบก่อนหน้า การตั้งค่าช่องนี้เป็น "เท็จ" จะเปิดใช้การต่อท้ายบางช่องใน "พรอมต์แบบง่าย" ข้อความแจ้งคำแนะนำ และพรอมต์ของ Canvas (ซึ่งเป็นส่วนหนึ่งของพรอมต์เนื้อหา) ด้วย ข้อความเนื้อหาและลิงก์จะถูกเขียนทับเสมอหากกำหนดไว้ในพรอมต์ ค่าเริ่มต้นคือ "false" |
canvas |
คำตอบที่จะใช้สำหรับประสบการณ์การใช้งาน Canvas แบบอินเทอร์แอกทีฟ |
StaticSimplePrompt
หมายถึงข้อความแจ้งง่ายๆ ที่จะส่งไปยังผู้ใช้
การแสดง JSON | |
---|---|
{
"variants": [
{
object ( |
ช่อง | |
---|---|
variants[] |
รายการตัวแปรที่เป็นไปได้ |
รูปแบบ
แสดงตัวแปรที่เป็นส่วนหนึ่งของพรอมต์แบบง่าย
การแสดง JSON | |
---|---|
{ "speech": string, "text": string } |
ช่อง | |
---|---|
speech |
ไม่บังคับ แสดงคำพูดที่จะพูดกับผู้ใช้ โดยอาจเป็น SSML หรือการอ่านออกเสียงข้อความ หากช่อง "ต่อท้าย" ในพรอมต์ที่เป็นคำว่า "จริง" เป็น "จริง" เสียงพูดที่กำหนดไว้ในช่องนี้จะเพิ่มต่อท้ายเสียงพูดของข้อความแจ้งแบบธรรมดาที่ใช้ก่อนหน้า |
text |
ไม่บังคับ ข้อความที่จะแสดงในลูกโป่งแชท ไม่เช่นนั้นจะใช้การแสดงผลของช่องคำพูดด้านบน จำกัดอักขระไม่เกิน 640 ตัว หากช่อง "ต่อท้าย" ในพรอมต์ที่มีเป็น "จริง" ข้อความที่กำหนดไว้ในช่องนี้จะเพิ่มต่อท้ายข้อความในพรอมต์แบบง่ายก่อนหน้า |
StaticContentPrompt
ตัวยึดตำแหน่งสำหรับส่วนเนื้อหาของ 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 ซึ่งอาจเป็นรายการใดรายการหนึ่งต่อไปนี้: - http/https urls สำหรับการเปิดแอปหรือหน้าเว็บที่ลิงก์ไปยังแอป |
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 ที่ตรงกับชื่อคีย์เข้าถึงใน Type ที่เกี่ยวข้อง เมื่อแตะรายการแล้ว คีย์นี้จะถูกโพสต์กลับไปเป็นพารามิเตอร์ตัวเลือกตัวเลือก |
title |
ต้องระบุ ชื่อของสินค้า เมื่อแตะ ข้อความนี้จะถูกโพสต์กลับไปยังการสนทนาแบบคำต่อคำเหมือนกับว่าผู้ใช้ได้พิมพ์ข้อความลงไป แต่ละชื่อต้องไม่ซ้ำกันในชุดรายการ |
description |
ไม่บังคับ ข้อความส่วนเนื้อหาของสินค้า |
image |
ไม่บังคับ รูปภาพสินค้า |
คำแนะนำ
แสดงชิปคำแนะนำ ซึ่งเป็นองค์ประกอบ UI ที่แสดงต่อผู้ใช้เพื่อความสะดวก
การแสดง JSON | |
---|---|
{ "title": string } |
ช่อง | |
---|---|
title |
ต้องระบุ ข้อความที่แสดงในชิปคำแนะนำ เมื่อแตะ ข้อความนี้จะถูกโพสต์กลับไปยังการสนทนาแบบคำต่อคำเหมือนกับว่าผู้ใช้ได้พิมพ์ข้อความลงไป ชื่อแต่ละชื่อต้องไม่ซ้ำกันในชุดชิปคำแนะนำ สูงสุด 25 อักขระ |
StaticCanvasPrompt
แสดงการตอบกลับ Canvas แบบอินเทอร์แอกทีฟที่จะส่งถึงผู้ใช้ ซึ่งสามารถใช้ร่วมกับช่อง "firstSimple" ในพรอมต์ที่มีเพื่อสื่อสารกับผู้ใช้นอกเหนือจากการแสดงคำตอบ Canvas แบบอินเทอร์แอกทีฟ
การแสดง JSON | |
---|---|
{ "url": string, "data": [ value ], "suppressMic": boolean } |
ช่อง | |
---|---|
url |
ต้องระบุ URL ของมุมมองเว็บที่จะโหลด |
data[] |
ไม่บังคับ ข้อมูล JSON ที่จะส่งไปยังหน้าเว็บประสบการณ์ที่สมจริงในรูปแบบเหตุการณ์ หากช่อง "ลบล้าง" ในพรอมต์ที่มีคือ "เท็จ" ค่าข้อมูลที่กำหนดไว้ในข้อความแจ้งของ Canvas นี้จะเพิ่มเข้ามาหลังค่าข้อมูลที่กำหนดไว้ในข้อความแจ้งของ Canvas ก่อนหน้านี้ |
suppressMic |
ไม่บังคับ ค่าจริงหมายความว่าระบบจะไม่เปิดไมโครโฟนเพื่อจับอินพุตหลังจากที่แสดงคำตอบที่สมจริงนี้ต่อผู้ใช้ |