EventHandler

กำหนดเครื่องจัดการที่จะดำเนินการหลังจากเหตุการณ์ ตัวอย่างของเหตุการณ์ ได้แก่ เหตุการณ์ที่อิงตามความตั้งใจและเหตุการณ์ในฉาก

การแสดง YAML 
webhookHandler: string

# Union field prompt can be only one of the following:
staticPrompt: 
  object (StaticPrompt)
staticPromptName: string
# End of list of possible types for union field prompt.
ช่อง
webhookHandler

string

ชื่อของตัวแฮนเดิลเว็บฮุคที่จะเรียกใช้
ช่องการรวม prompt พรอมต์อาจเป็นแบบอินไลน์หรืออ้างอิงโดยใช้ชื่อก็ได้ prompt ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้
staticPrompt

object (StaticPrompt)

ข้อความแจ้งแบบคงที่ในบรรทัด อาจมีการอ้างอิงทรัพยากรสตริงในกลุ่มได้
staticPromptName

string

ชื่อของข้อความแจ้งแบบคงที่ที่จะเรียกใช้

StaticPrompt

แสดงรายชื่อพรอมต์ที่แนะนำ ซึ่งจะเลือก 1 รายการเป็นข้อความแจ้งที่จะแสดงในการตอบกลับผู้ใช้ ข้อความนี้แปลได้

การแสดง YAML 
candidates: 
  - object (StaticPromptCandidate)
ช่อง
candidates[]

object (StaticPromptCandidate)

รายการข้อความแจ้งของผู้สมัครที่จะส่งไปยังไคลเอ็นต์ ข้อความแจ้งแต่ละรายการจะมีตัวเลือกเพื่อระบุว่าจะใช้เมื่อใด ระบบจะส่งตัวเลือกแรกที่ตรงกับคำขอและจะไม่สนใจตัวเลือกที่เหลือ

StaticPromptCandidate

แสดงตัวเลือกพรอมต์แบบคงที่

การแสดง YAML 
selector: 
  object (Selector)
promptResponse: 
  object (StaticPromptResponse)
ช่อง
selector

object (Selector)

ไม่บังคับ เกณฑ์ว่าข้อความแจ้งนี้ตรงกับคำขอหรือไม่ หากตัวเลือกว่างเปล่า ระบบจะทริกเกอร์ข้อความแจ้งนี้เสมอ
promptResponse

object (StaticPromptResponse)

คำตอบพรอมต์ที่เชื่อมโยงกับตัวเลือก

ตัวเลือก

กำหนดเกณฑ์ว่าข้อความแจ้งตรงกับคำขอหรือไม่

การแสดง YAML 
surfaceCapabilities: 
  object (SurfaceCapabilities)
ช่อง
surfaceCapabilities

object (SurfaceCapabilities)

ชุดความสามารถของพื้นผิวที่จำเป็น

SurfaceCapabilities

แสดงแพลตฟอร์มที่ผู้ใช้ใช้เพื่อส่งคำขอไปยังการดำเนินการ

การแสดง YAML 
capabilities: 
  - enum (Capability)
ช่อง
capabilities[]

enum (Capability)

ต้องระบุ ความสามารถของแพลตฟอร์มในการส่งคำขอไปยังการดำเนินการ

StaticPromptResponse

แสดงคำตอบที่มีโครงสร้างที่จะส่งให้ผู้ใช้ เช่น ข้อความ คำพูด การ์ด ข้อมูล Canvas ชิปคำแนะนำ ฯลฯ

การแสดง YAML 
firstSimple: 
  object (StaticSimplePrompt)
content: 
  object (StaticContentPrompt)
lastSimple: 
  object (StaticSimplePrompt)
suggestions: 
  - object (Suggestion)
link: 
  object (StaticLinkPrompt)
override: boolean
canvas: 
  object (StaticCanvasPrompt)
ช่อง
firstSimple

object (StaticSimplePrompt)

ไม่บังคับ คำตอบแรกที่เป็นเสียงและข้อความเท่านั้น
content

object (StaticContentPrompt)

ไม่บังคับ เนื้อหา เช่น การ์ด รายการ หรือสื่อที่จะแสดงต่อผู้ใช้
lastSimple

object (StaticSimplePrompt)

ไม่บังคับ คำตอบแบบเสียงและข้อความสุดท้าย
suggestions[]

object (Suggestion)

ไม่บังคับ คำแนะนำที่แสดงต่อผู้ใช้ซึ่งจะปรากฏท้ายคำตอบเสมอ หากช่อง append ในข้อความแจ้งที่มีคือ true ระบบจะเพิ่มชื่อที่ระบุไว้ในช่องนี้ลงในชื่อที่กำหนดไว้ในพรอมต์คำแนะนำที่กำหนดไว้ก่อนหน้านี้และค่าที่ซ้ำกันจะถูกนำออก
override

boolean

ไม่บังคับ โหมดสำหรับวิธีผสานข้อความนี้กับข้อความที่กำหนดไว้ก่อนหน้า true จะล้างข้อความที่กำหนดไว้ก่อนหน้านี้ทั้งหมด (แบบง่ายและแบบแรกสุด ได้แก่ เนื้อหา ลิงก์คำแนะนำ และ Canvas) และเพิ่มข้อความที่กำหนดไว้ในพรอมต์นี้ false จะเพิ่มข้อความที่กำหนดไว้ในพรอมต์นี้ไปยังข้อความที่กำหนดไว้ในคำตอบก่อนหน้า การตั้งค่าช่องนี้เป็น false จะเป็นการเปิดใช้การต่อท้ายบางช่องภายในพรอมต์อย่างง่าย พรอมต์คำแนะนำ และข้อความแจ้งของ Canvas (เป็นส่วนหนึ่งของข้อความแจ้งเนื้อหา) ด้วย ข้อความ "เนื้อหา" และ "ลิงก์" จะถูกเขียนทับเสมอหากมีการกำหนดไว้ในข้อความแจ้ง ค่าเริ่มต้นคือ false
canvas

object (StaticCanvasPrompt)

คำตอบที่จะนำไปใช้สำหรับประสบการณ์ Canvas แบบอินเทอร์แอกทีฟ

StaticSimplePrompt

หมายถึงข้อความแจ้งง่ายๆ ที่จะส่งถึงผู้ใช้

การแสดง YAML 
variants: 
  - object (Variant)
ช่อง
variants[]

object (Variant)

รายการตัวแปรที่เป็นไปได้

ตัวแปร

แสดงตัวแปรที่เป็นส่วนหนึ่งของพรอมต์ง่ายๆ

การแสดง YAML 
speech: string
text: string
ช่อง
speech

string

ไม่บังคับ หมายถึงคำพูดที่ผู้ใช้พูด อาจเป็น SSML หรือการอ่านออกเสียงข้อความ โดยค่าเริ่มต้น เสียงพูดจะต่อท้ายเสียงพูดของพรอมต์ง่ายๆ ก่อนหน้า หากช่อง override ในพรอมต์ที่มีคือ true เสียงพูดที่กำหนดไว้ในช่องนี้จะลบล้างเสียงพูดของพรอมต์ง่ายๆ ก่อนหน้า
text

string

ไม่บังคับ ข้อความที่จะแสดงในบับเบิลแชท หากไม่ระบุ ระบบจะใช้การแสดงผลฟิลด์เสียงพูดด้านบน มีอักขระได้ไม่เกิน 640 ตัว โดยค่าเริ่มต้น ระบบจะต่อท้ายข้อความพรอมต์แบบง่ายก่อนหน้า หากช่อง override ในพรอมต์ที่มีคือ true ข้อความที่กำหนดไว้ในช่องนี้จะลบล้างข้อความของพรอมต์แบบง่ายก่อนหน้า

StaticContentPrompt

ตัวยึดตำแหน่งสำหรับส่วน Content ของ StaticPrompt

การแสดง YAML 
# 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)
collectionBrowse: 
  object (StaticCollectionBrowsePrompt)
# End of list of possible types for union field content.
ช่อง
ช่องการรวม content แสดงเนื้อหาได้เพียงประเภทเดียวในพรอมต์ content ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้
card

object (StaticCardPrompt)

บัตรพื้นฐาน
image

object (StaticImagePrompt)

รูปภาพ
table

object (StaticTablePrompt)

การ์ดตาราง
media

object (StaticMediaPrompt)

การตอบกลับที่ระบุชุดสื่อที่จะเล่น
list

object (StaticListPrompt)

การ์ดสำหรับแสดงรายการตัวเลือกที่มีให้เลือก
collection

object (StaticCollectionPrompt)

การ์ดแสดงรายการตัวเลือกที่มีให้เลือก
collectionBrowse

object (StaticCollectionBrowsePrompt)

การ์ดแสดงคอลเล็กชันหน้าเว็บที่จะเปิด

StaticCardPrompt

การ์ดพื้นฐานสำหรับแสดงข้อมูลบางอย่าง เช่น รูปภาพและ/หรือข้อความ

การแสดง YAML 
title: string
subtitle: string
text: string
image: 
  object (StaticImagePrompt)
imageFill: enum (ImageFill)
button: 
  object (StaticLinkPrompt)
ช่อง
title

string

ไม่บังคับ ชื่อโดยรวมของการ์ด
subtitle

string

ไม่บังคับ คำบรรยายของการ์ด
text

string

ต้องระบุ ข้อความเนื้อหาของการ์ดซึ่งจำเป็นต้องใช้ เว้นแต่จะมีรูปภาพอยู่ รองรับชุดไวยากรณ์มาร์กดาวน์สำหรับการจัดรูปแบบแบบจำกัด
image

object (StaticImagePrompt)

ไม่บังคับ รูปภาพหลักของการ์ด ความสูงกำหนดไว้ที่ 192dp
imageFill

enum (ImageFill)

ไม่บังคับ วิธีเติมพื้นหลังของรูปภาพ
button

object (StaticLinkPrompt)

ไม่บังคับ ปุ่มที่คลิกได้เพื่อแสดงในการ์ด

StaticImagePrompt

รูปภาพที่แสดงในการ์ด

การแสดง YAML 
url: string
alt: string
height: integer
width: integer
ช่อง
url

string

ต้องระบุ URL แหล่งที่มาของรูปภาพ รูปภาพสามารถใช้เป็น JPG, PNG และ GIF (ทั้งเป็นภาพเคลื่อนไหวและไม่เคลื่อนไหว) ตัวอย่างเช่นhttps://www.agentx.com/logo.png
alt

string

ต้องระบุ ข้อความอธิบายรูปภาพที่ใช้สำหรับการเข้าถึง เช่น โปรแกรมอ่านหน้าจอ
height

integer

ไม่บังคับ ความสูงของรูปภาพเป็นพิกเซล
width

integer

ไม่บังคับ ความกว้างของรูปภาพเป็นพิกเซล

StaticLinkPrompt

กำหนดลิงก์ซึ่งจะแสดงเป็นชิปคำแนะนำและผู้ใช้สามารถเปิดได้

การแสดง YAML 
name: string
open: 
  object (OpenUrl)
ช่อง
name

string

ชื่อของลิงก์
open

object (OpenUrl)

กำหนดลักษณะการทำงานเมื่อผู้ใช้เปิดลิงก์

OpenUrl

กำหนดลักษณะการทำงานเมื่อผู้ใช้เปิดลิงก์

การแสดง YAML 
url: string
hint: enum (UrlHint)
ช่อง
url

string

ฟิลด์ URL อาจเป็นรายการใดก็ได้ต่อไปนี้ - URL http/https สำหรับเปิดแอปที่ลิงก์กับแอปหรือหน้าเว็บ
hint

enum (UrlHint)

เป็นคำแนะนำสำหรับประเภท URL

StaticTablePrompt

การ์ดตารางสำหรับแสดงตารางข้อความ

การแสดง YAML 
title: string
subtitle: string
image: 
  object (StaticImagePrompt)
columns: 
  - object (TableColumn)
rows: 
  - object (TableRow)
button: 
  object (StaticLinkPrompt)
ช่อง
title

string

ไม่บังคับ ชื่อโดยรวมของตาราง ต้องตั้งค่าหากมีการตั้งค่าคำบรรยาย
subtitle

string

ไม่บังคับ ชื่อรองของตาราง
image

object (StaticImagePrompt)

ไม่บังคับ รูปภาพที่เชื่อมโยงกับตาราง
columns[]

object (TableColumn)

ไม่บังคับ ส่วนหัวและการจัดแนวคอลัมน์
rows[]

object (TableRow)

ไม่บังคับ ข้อมูลแถวของตาราง เรารับประกันว่าแถว 3 แถวแรกจะแสดงขึ้น แต่บางแถวอาจถูกตัดออกในบางแพลตฟอร์ม โปรดทดสอบกับเครื่องจำลองเพื่อดูว่าจะแสดงแถวใดสำหรับแพลตฟอร์มหนึ่งๆ ในแพลตฟอร์มที่รองรับความสามารถของ WEB_BROWSER คุณจะชี้ผู้ใช้ไปยังหน้าเว็บที่มีข้อมูลเพิ่มเติมได้
button

object (StaticLinkPrompt)

ไม่บังคับ ปุ่ม

TableColumn

อธิบายคอลัมน์ในตาราง

การแสดง YAML 
header: string
align: enum (HorizontalAlignment)
ช่อง
header

string

ข้อความส่วนหัวของคอลัมน์
align

enum (HorizontalAlignment)

การจัดแนวแนวนอนของเนื้อหาในคอลัมน์ หากไม่ระบุ เนื้อหาจะอยู่ในแนวเดียวกับขอบนำหน้า

TableRow

อธิบายแถวในตาราง

การแสดง YAML 
cells: 
  - object (TableCell)
divider: boolean
ช่อง
cells[]

object (TableCell)

เซลล์ในแถวนี้ ระบบรับประกันว่าจะแสดง 3 เซลล์แรก แต่เซลล์อื่นๆ อาจถูกตัดออกในบางพื้นผิว โปรดทดสอบด้วยเครื่องมือจำลองเพื่อดูว่าจะแสดงเซลล์ใดบนพื้นผิวที่กำหนด
divider

boolean

ระบุว่าควรมีตัวแบ่งหลังจากแต่ละแถวหรือไม่

TableCell

อธิบายเซลล์ในแถว

การแสดง YAML 
text: string
ช่อง
text

string

เนื้อหาข้อความของเซลล์

StaticMediaPrompt

มีข้อมูลเกี่ยวกับสื่อ เช่น ชื่อ คำอธิบาย URL ฯลฯ รหัสถัดไป: 11

การแสดง YAML 
mediaType: enum (MediaType)
startOffset: string
optionalMediaControls: 
  - enum (OptionalMediaControls)
mediaObjects: 
  - object (MediaObject)
repeatMode: enum (RepeatMode)
ช่อง
mediaType

enum (MediaType)

ประเภทสื่อของคำตอบนี้
startOffset

string (Duration format)

ออฟเซ็ตเริ่มต้นของออบเจ็กต์สื่อแรก

ระยะเวลาเป็นวินาทีโดยมีเลขเศษส่วนไม่เกิน 9 หลัก สิ้นสุดด้วย "s" ตัวอย่างเช่น "3.5s"
optionalMediaControls[]

enum (OptionalMediaControls)

ประเภทการควบคุมสื่อที่ไม่บังคับที่เซสชันการตอบสนองสื่อนี้รองรับได้ หากตั้งค่าไว้ จะมีการส่งคำขอไปยัง 3p เมื่อมีเหตุการณ์สื่อบางอย่างเกิดขึ้น หากไม่ได้ตั้งค่า 3p ยังคงต้องจัดการประเภทการควบคุมเริ่มต้น 2 ประเภท ได้แก่ FINISHED และ FAILED
mediaObjects[]

object (MediaObject)

รายการออบเจ็กต์สื่อ
repeatMode

enum (RepeatMode)

โหมดทำซ้ำสำหรับรายการออบเจ็กต์สื่อ

MediaObject

แสดงออบเจ็กต์สื่อรายการเดียว

การแสดง YAML 
name: string
description: string
url: string
image: 
  object (MediaImage)
ช่อง
name

string

ชื่อออบเจ็กต์สื่อนี้
description

string

คำอธิบายของออบเจ็กต์สื่อนี้
url

string

URL ที่ชี้ไปยังเนื้อหาสื่อ
image

object (MediaImage)

รูปภาพที่จะแสดงพร้อมการ์ดสื่อ

MediaImage

รูปภาพที่จะแสดงภายใน MediaPrompt

การแสดง YAML 
# 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.
ช่อง
ช่องการรวม image อนุญาตให้ใช้ MediaImage เพียงประเภทเดียวเท่านั้น image ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้
large

object (StaticImagePrompt)

รูปภาพขนาดใหญ่ เช่น ปกอัลบั้ม ฯลฯ
icon

object (StaticImagePrompt)

ไอคอนรูปภาพขนาดเล็กที่แสดงอยู่ด้านขวาจากชื่อ โดยปรับขนาดเป็น 36x36 dp

StaticListPrompt

การ์ดสำหรับแสดงรายการตัวเลือกที่มีให้เลือก

การแสดง YAML 
title: string
subtitle: string
items: 
  - object (ListItem)
ช่อง
title

string

ไม่บังคับ ชื่อรายการ
subtitle

string

ไม่บังคับ คำบรรยายของรายการ
items[]

object (ListItem)

ต้องระบุ รายการ

ListItem

รายการข้อมูลในรายการ

การแสดง YAML 
key: string
title: string
description: string
image: 
  object (StaticImagePrompt)
ช่อง
key

string

ต้องระบุ คีย์ NLU ที่ตรงกับชื่อคีย์รายการในประเภทที่เชื่อมโยง เมื่อแตะรายการ คีย์นี้จะโพสต์กลับไปที่พารามิเตอร์ตัวเลือก
title

string

ต้องระบุ ชื่อของสินค้า เมื่อแตะ ข้อความนี้จะโพสต์กลับไปที่การสนทนาแบบคำต่อคำราวกับว่าผู้ใช้ได้พิมพ์ลงไป แต่ละชื่อต้องไม่ซ้ำกันในชุดรายการ
description

string

ไม่บังคับ ข้อความเนื้อหาของรายการ
image

object (StaticImagePrompt)

ไม่บังคับ รูปภาพรายการ

StaticCollectionPrompt

การ์ดสำหรับนำเสนอชุดตัวเลือกให้เลือก

การแสดง YAML 
title: string
subtitle: string
items: 
  - object (CollectionItem)
imageFill: enum (ImageFill)
ช่อง
title

string

ไม่บังคับ ชื่อคอลเล็กชัน
subtitle

string

ไม่บังคับ คำบรรยายของคอลเล็กชัน
items[]

object (CollectionItem)

ต้องระบุ รายการในคอลเล็กชัน
imageFill

enum (ImageFill)

ไม่บังคับ ตัวเลือกประเภทการแสดงรูปภาพ

CollectionItem

รายการในคอลเล็กชัน

การแสดง YAML 
key: string
title: string
description: string
image: 
  object (StaticImagePrompt)
ช่อง
key

string

ต้องระบุ คีย์ NLU ที่ตรงกับชื่อคีย์รายการในประเภทที่เชื่อมโยง เมื่อแตะรายการ คีย์นี้จะโพสต์กลับไปที่พารามิเตอร์ตัวเลือก
title

string

ต้องระบุ ชื่อของสินค้า เมื่อแตะ ข้อความนี้จะโพสต์กลับไปที่การสนทนาแบบคำต่อคำราวกับว่าผู้ใช้ได้พิมพ์ลงไป แต่ละชื่อต้องไม่ซ้ำกันในชุดรายการ
description

string

ไม่บังคับ ข้อความเนื้อหาของรายการ
image

object (StaticImagePrompt)

ไม่บังคับ รูปภาพรายการ

StaticCollectionBrowsePrompt

นำเสนอชุดของเอกสารบนเว็บเป็นคอลเล็กชันของรายการขนาดใหญ่ ระบบอาจเลือกรายการเพื่อเปิดเอกสารบนเว็บที่เกี่ยวข้องในโปรแกรมดูเว็บ

การแสดง YAML 
items: 
  - object (CollectionBrowseItem)
imageFill: enum (ImageFill)
ช่อง
items[]

object (CollectionBrowseItem)

รายการในคอลเล็กชันการเรียกดู ขนาดรายการควรอยู่ในช่วง [2, 10]
imageFill

enum (ImageFill)

ตัวเลือกการแสดงรูปภาพในคอลเล็กชัน

CollectionBrowseItem

รายการในคอลเล็กชัน

การแสดง YAML 
title: string
description: string
footer: string
image: 
  object (StaticImagePrompt)
openUriAction: 
  object (OpenUrl)
ช่อง
title

string

ต้องระบุ ชื่อรายการคอลเล็กชัน
description

string

คำอธิบายรายการคอลเล็กชัน
footer

string

ข้อความส่วนท้ายสำหรับรายการคอลเล็กชัน แสดงอยู่ด้านล่างคำอธิบาย ข้อความบรรทัดเดียวที่ตัดให้สั้นลงด้วยจุดไข่ปลา
image

object (StaticImagePrompt)

รูปภาพสำหรับรายการคอลเล็กชัน
openUriAction

object (OpenUrl)

ต้องระบุ URI ที่จะเปิดหากรายการที่เลือก

คำแนะนำ

แสดงชิปคำแนะนำ ซึ่งเป็นองค์ประกอบ UI ที่แสดงต่อผู้ใช้เพื่อความสะดวก

การแสดง YAML 
title: string
ช่อง
title

string

ต้องระบุ ข้อความที่แสดงในชิปคำแนะนำ เมื่อแตะ ข้อความนี้จะโพสต์กลับไปที่การสนทนาแบบคำต่อคำราวกับว่าผู้ใช้ได้พิมพ์ลงไป ชื่อแต่ละรายการต้องไม่ซ้ำกันในชุดชิปคำแนะนำ สูงสุด 25 อักขระ

StaticCanvasPrompt

แสดงการตอบกลับ Interactive Canvas ที่จะส่งไปให้ผู้ใช้ ใช้ร่วมกับช่อง firstSimple ในพรอมต์ที่มีคำสั่งเพื่อพูดกับผู้ใช้ได้ด้วย นอกเหนือจากการแสดงการตอบกลับ Canvas แบบอินเทอร์แอกทีฟ

การแสดง YAML 
url: string
data: 
  - value
suppressMic: boolean
sendStateDataToCanvasApp: boolean
enableFullScreen: boolean
continueTtsDuringTouch: boolean
ช่อง
url

string

ต้องระบุ URL ของมุมมองเว็บที่จะโหลด
data[]

value (Value format)

ไม่บังคับ ข้อมูล JSON ที่จะส่งไปยังหน้าเว็บประสบการณ์แบบสมจริงเป็นเหตุการณ์ หากช่อง override ในพรอมต์ที่มีเป็นค่าข้อมูล false ค่าที่กำหนดไว้ในข้อความแจ้งของ Canvas นี้ ระบบจะเพิ่มค่าข้อมูลหลังจากค่าข้อมูลที่กําหนดไว้ในข้อความแจ้งก่อนหน้าของ Canvas
suppressMic

boolean

ไม่บังคับ ค่าจริงหมายความว่าไมโครโฟนจะไม่เปิดเพื่อจับอินพุตหลังจากแสดงการตอบสนองอย่างละเอียดนี้ต่อผู้ใช้
sendStateDataToCanvasApp

boolean

ไม่บังคับ หากเป็น true ระบบจะรวมข้อมูลเมตาที่เกี่ยวข้องกับการสนทนาและส่งไปยังแอปพลิเคชัน Canvas
enableFullScreen

boolean

ไม่บังคับ หากเป็น true แอปพลิเคชัน Canvas จะใช้พื้นที่เต็มหน้าจอและจะไม่มีส่วนหัวที่ด้านบน ข้อความโทสต์จะปรากฏในหน้าจอการโหลดด้วยชื่อที่แสดงของการดำเนินการ ชื่อนักพัฒนาซอฟต์แวร์ และคำแนะนำในการออกจากการดำเนินการ ค่าเริ่มต้น: false
continueTtsDuringTouch

boolean

ไม่บังคับ หากเป็น "จริง" การแตะหน้าจอจะไม่หยุด TTS สำหรับเซสชัน Canvas ทั้งเซสชัน ค่าเริ่มต้น: false