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

要呼叫的 Webhook 處理常式名稱。
聯集欄位 prompt。提示可以內嵌或參照名稱。prompt 只能是下列其中一項：
staticPrompt

object (StaticPrompt)

內嵌靜態提示。可包含套件中字串資源的參照。
staticPromptName

string

要叫用的靜態提示名稱。

StaticPrompt

代表提示候選清單，系統會選取其中一個做為提示，並在使用者回應中顯示。這是可本地化的訊息。

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

代表要傳送給使用者的結構化回應，例如文字、語音、資訊卡、畫布資料、建議方塊等。

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 會清除先前定義的所有訊息 (第一個和最後一個簡單訊息、內容、建議連結和畫布)，並新增這個提示中定義的訊息。false 會將這個提示中定義的訊息新增至先前的回應中定義的訊息。如果將這個欄位設為 false，也能在簡單提示、建議提示和畫布提示 (屬於內容提示) 中附加某些欄位。系統將一律覆寫「內容和連結」訊息 (如提示中已定義)。預設值為 false。
canvas

object (StaticCanvasPrompt)

用於互動式畫布體驗的回應。

StaticSimplePrompt

代表要傳送給使用者的簡單提示。

YAML 表示法 
variants: 
  - object (Variant)
欄位
variants[]

object (Variant)

可能變數的清單。

Variant

代表簡易提示中的變化版本。

YAML 表示法 
speech: string
text: string
欄位
speech

string

選用設定。代表要向使用者讀出的語音。可以是 SSML 或文字轉語音。根據預設，語音會附加在前一個簡單提示的語音中。如果所含提示中的 override 欄位為 true，這個欄位中定義的語音會覆寫先前的簡單提示語音。
text

string

選用設定。要在即時通訊泡泡中顯示的文字。如未指定，將顯示上方語音欄位的顯示內容。上限為 640 個半形字元。根據預設，文字會附加至先前的簡易提示文字。如果所含提示中的 override 欄位為 true，這個欄位中定義的文字會覆寫先前的簡易提示文字。

StaticContentPrompt

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

必要欄位。資訊卡內文 (除非有圖片)。支援一組 Markdown 語法，以便用於格式設定。
image

object (StaticImagePrompt)

選用設定。資訊卡的主頁橫幅。高度固定為 192dp。
imageFill

enum (ImageFill)

選用設定。圖片背景的填滿方式。
button

object (StaticLinkPrompt)

選用設定。要顯示在資訊卡中的可點擊按鈕。

StaticImagePrompt

資訊卡中顯示的圖片。

YAML 表示法 
url: string
alt: string
height: integer
width: integer
欄位
url

string

必要欄位。圖片的來源網址。圖片可以是 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

網址欄位，可能為下列任一值：- 用於開啟應用程式連結應用程式或網頁的 http/https 網址
hint

enum (UrlHint)

用於表示網址類型的提示。

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

包含名稱、說明、網址等媒體相關資訊。下一個 ID：11

YAML 表示法 
mediaType: enum (MediaType)
startOffset: string
optionalMediaControls: 
  - enum (OptionalMediaControls)
mediaObjects: 
  - object (MediaObject)
repeatMode: enum (RepeatMode)
欄位
mediaType

enum (MediaType)

此回應的媒體類型。
startOffset

string (Duration format)

第一個媒體物件的開始偏移。

期間以秒為單位，小數部分最多九位數，以「s」結尾。範例："3.5s"。
optionalMediaControls[]

enum (OptionalMediaControls)

這個媒體回應工作階段支援的選用媒體控制項類型。如果設定此值，當特定媒體事件發生時，要求就會傳送到 3p。如未設定，則第三方代碼仍必須處理「FINISHED」和「失敗」這兩種預設控制項類型。
mediaObjects[]

object (MediaObject)

媒體物件清單。
repeatMode

enum (RepeatMode)

媒體物件清單的重複模式。

MediaObject

代表單一媒體物件。

YAML 表示法 
name: string
description: string
url: string
image: 
  object (MediaImage)
欄位
name

string

此媒體物件的名稱。
description

string

此媒體物件的說明。
url

string

指向媒體內容的網址。
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

必要欄位。符合相關 Type 中項目索引鍵名稱的 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

代表要傳送給使用者的互動式畫布回應。這項功能可搭配包含提示中的 firstSimple 欄位使用，除了顯示互動式畫布回應外，還可向使用者發出語音。

YAML 表示法 
url: string
data: 
  - value
suppressMic: boolean
sendStateDataToCanvasApp: boolean
enableFullScreen: boolean
continueTtsDuringTouch: boolean
欄位
url

string

必要欄位。要載入的網頁檢視畫面網址。
data[]

value (Value format)

選用設定。要以事件的形式傳遞至沉浸式體驗網頁的 JSON 資料。如果內含提示中的 override 欄位是這份畫布提示中定義的 false 資料值，系統會按照先前的 Canvas 提示定義的資料值新增值。
suppressMic

boolean

選用設定。如果設為 true，使用者看到這類沉浸式回應後，就無法開啟麥克風來擷取輸入內容。
sendStateDataToCanvasApp

boolean

選用設定。如果設為 true，則會包含對話相關中繼資料，並傳回至畫布應用程式。
enableFullScreen

boolean

選用設定。如果 true 畫布應用程式佔用全螢幕空間，頂端就不會有標頭。載入畫面也會顯示浮動式訊息，其中包含動作顯示名稱、開發人員名稱及退出動作的操作說明。預設值為 false。
continueTtsDuringTouch

boolean

選用設定。如果設為 true，在整個畫布工作階段中輕觸螢幕不會停止文字轉語音功能。預設值為 false。