- YAML 表示法
- StaticPrompt
- StaticPromptCandidate
- 選取器
- SurfaceCapabilities
- StaticPromptResponse
- StaticSimplePrompt
- 子類
- StaticContentPrompt
- StaticCardPrompt
- StaticImagePrompt
- StaticLinkPrompt
- OpenUrl
- StaticTablePrompt
- TableColumn
- TableRow
- TableCell
- StaticMediaPrompt
- MediaObject
- MediaImage
- StaticListPrompt
- ListItem
- StaticCollectionPrompt
- CollectionItem
- StaticCollectionBrowsePrompt
- CollectionBrowseItem
- 建議
- StaticCanvasPrompt
定義要在事件後執行的處理常式。例如場景中的意圖和條件式事件。
YAML 表示法 | |
---|---|
webhookHandler: string # Union field |
欄位 | ||
---|---|---|
webhookHandler |
要呼叫的 Webhook 處理常式名稱。 |
|
聯集欄位 prompt 。您可以將提示內嵌或依名稱參照。prompt 只能是下列其中一項: |
||
staticPrompt |
內嵌靜態提示。套裝組合中可包含字串資源的參照。 |
|
staticPromptName |
要叫用的靜態提示名稱。 |
StaticPrompt
代表候選提示清單,其中會選為要向使用者顯示的提示。這則訊息可以本地化。
YAML 表示法 | |
---|---|
candidates:
- object ( |
欄位 | |
---|---|
candidates[] |
要傳送至用戶端的候選提示清單。每個提示都有決定使用時機的選取器。系統會傳送第一個與請求相符的選取器,並忽略其餘的選取器。 |
StaticPromptCandidate
代表靜態提示候選項目。
YAML 表示法 | |
---|---|
selector: object ( |
欄位 | |
---|---|
selector |
選用設定。此提示是否與要求相符的條件。如果選取器沒有內容,一律會觸發提示。 |
promptResponse |
與選取器相關聯的提示回應。 |
選取器
定義提示是否與要求比對的條件。
YAML 表示法 | |
---|---|
surfaceCapabilities:
object ( |
欄位 | |
---|---|
surfaceCapabilities |
一組必要的表面功能。 |
SurfaceCapabilities
代表使用者用來要求動作的途徑。
YAML 表示法 | |
---|---|
capabilities:
- enum ( |
欄位 | |
---|---|
capabilities[] |
必要欄位。途徑向動作發出要求的功能。 |
StaticPromptResponse
代表要傳送給使用者的結構化回應,例如文字、語音、資訊卡、畫布資料、建議方塊等。
YAML 表示法 | |
---|---|
firstSimple: object ( |
欄位 | |
---|---|
firstSimple |
選用設定。第一個語音和純文字回應。 |
content |
選用設定。要向使用者顯示的資訊卡、清單或媒體等內容。 |
lastSimple |
選用設定。最後一個語音和純文字回應。 |
suggestions[] |
選用設定。向使用者顯示的建議,且一律會顯示在回應結尾。如果內含提示中的 |
link |
選用設定。可連結至相關聯應用程式或網站的額外建議方塊。這個方塊會顯示為「開啟 |
override |
選用設定。這個模式用於將這則訊息與先前定義的訊息合併。 |
canvas |
用於互動式畫布體驗的回應。 |
StaticSimplePrompt
代表要傳送給使用者的簡單提示。
YAML 表示法 | |
---|---|
variants:
- object ( |
欄位 | |
---|---|
variants[] |
可能的變化版本清單。 |
Variant
代表簡易提示中的變化版本。
YAML 表示法 | |
---|---|
speech: string text: string |
欄位 | |
---|---|
speech |
選用設定。代表要向使用者顯示的語音。可以是 SSML 或文字轉語音。根據預設,語音將附加至前一個簡單提示的語音。如果內含提示中的 |
text |
選用設定。要在即時通訊泡泡中顯示的文字。如未指定,系統會使用上述的語音欄位顯示內容。最長不得超過 640 個半形字元。根據預設,文字會附加至前一個簡單提示的文字。如果內含提示中的 |
StaticContentPrompt
StaticPrompt 的「內容」部分預留位置。
YAML 表示法 | |
---|---|
# Union field |
欄位 | ||
---|---|---|
聯集欄位 content 。提示只能顯示一種類型的內容。content 只能是下列其中一項: |
||
card |
基本資訊卡。 |
|
image |
圖片。 |
|
table |
表格資訊卡。 |
|
media |
回應指出要播放的媒體組合。 |
|
list |
顯示選項清單的資訊卡。 |
|
collection |
資訊卡:列出可供選擇的選項。 |
|
collectionBrowse |
資訊卡顯示一系列要開啟的網頁。 |
StaticCardPrompt
顯示部分資訊的基本資訊卡,例如圖片和/或文字。
YAML 表示法 | |
---|---|
title: string subtitle: string text: string image: object ( |
欄位 | |
---|---|
title |
選用設定。資訊卡的總標題。 |
subtitle |
選用設定。資訊卡的副標題。 |
text |
必要欄位。必須提供資訊卡的內文 (除非有圖片)。支援有限的 Markdown 語法組合。 |
image |
選用設定。資訊卡的主頁橫幅。高度固定為 192dp。 |
imageFill |
選用設定。圖片背景的填滿方式。 |
button |
選用設定。顯示在資訊卡中的可點擊按鈕。 |
StaticImagePrompt
資訊卡中顯示的圖片。
YAML 表示法 | |
---|---|
url: string alt: string height: integer width: integer |
欄位 | |
---|---|
url |
必要欄位。圖片的來源網址。圖片可以是 JPG、PNG 和 GIF (動畫和非動畫)。例如: |
alt |
必要欄位。圖片的文字說明,供無障礙功能使用,例如螢幕閱讀器。 |
height |
選用設定。圖片的高度 (以像素為單位)。 |
width |
選用設定。圖片的寬度 (以像素為單位)。 |
StaticLinkPrompt
定義連結,該連結會以建議方塊的形式顯示,並允許使用者開啟。
YAML 表示法 | |
---|---|
name: string
open:
object ( |
欄位 | |
---|---|
name |
連結名稱 |
open |
定義使用者開啟連結時的行為。 |
OpenUrl
定義使用者開啟連結時的行為。
YAML 表示法 | |
---|---|
url: string
hint: enum ( |
欄位 | |
---|---|
url |
網址欄位,可以是下列任一值:- 用來開啟應用程式連結應用程式或網頁的 http/https 網址 |
hint |
表示網址類型的提示。 |
StaticTablePrompt
顯示文字表格的表格資訊卡。
YAML 表示法 | |
---|---|
title: string subtitle: string image: object ( |
欄位 | |
---|---|
title |
選用設定。表格的整體標題。如果設定了字幕,則必須設定。 |
subtitle |
選用設定。資料表的副標題。 |
image |
選用設定。與表格相關聯的圖片。 |
columns[] |
選用設定。資料欄的標頭和對齊方式。 |
rows[] |
選用設定。資料表的資料列資料。前 3 列一定會顯示,但其他內容可能會在特定介面上顯示。請使用模擬工具進行測試,瞭解特定介面會顯示哪些資料列。在支援 |
button |
選用設定。按鈕。 |
TableColumn
說明資料表中的資料欄。
YAML 表示法 | |
---|---|
header: string
align: enum ( |
欄位 | |
---|---|
header |
資料欄的標題文字。 |
align |
內容 w.r.t 欄的水平對齊。如未指定,內容則會與頂部邊緣對齊。 |
TableRow
說明資料表中的資料列。
YAML 表示法 | |
---|---|
cells:
- object ( |
欄位 | |
---|---|
cells[] |
此列的儲存格。我們保證顯示前 3 個儲存格,但其他儲存格可能會截斷。請使用模擬器進行測試,看看在特定表面會顯示哪些儲存格。 |
divider |
指出每一列後是否應有分隔線。 |
TableCell
說明資料列中的儲存格。
YAML 表示法 | |
---|---|
text: string |
欄位 | |
---|---|
text |
儲存格的文字內容。 |
StaticMediaPrompt
包含媒體相關資訊,例如名稱、說明、網址等。下一個 ID:11
YAML 表示法 | |
---|---|
mediaType: enum ( |
欄位 | |
---|---|
mediaType |
此回應的媒體類型。 |
startOffset |
第一個媒體物件的開始偏移。 時間長度以秒為單位,最多可有 9 個小數位數,並應以「 |
optionalMediaControls[] |
這個媒體回應工作階段可支援的選用媒體控制項類型。如果設定這個項目,系統會在特定媒體事件發生時向 3p 發出要求。如果未設定,3p 仍必須處理兩個預設控制項類型「FINISHED」和「FAILED」。 |
mediaObjects[] |
媒體物件清單。 |
repeatMode |
針對媒體物件清單重複模式。 |
MediaObject
代表單一媒體物件。
YAML 表示法 | |
---|---|
name: string
description: string
url: string
image:
object ( |
欄位 | |
---|---|
name |
此媒體物件的名稱。 |
description |
此媒體物件的說明。 |
url |
指向媒體內容的網址。 |
image |
與媒體資訊卡一起顯示的圖片。 |
MediaImage
顯示在 MediaPrompt 中的圖片。
YAML 表示法 | |
---|---|
# Union field |
欄位 | ||
---|---|---|
聯集欄位 image 。只能使用一種 MediaImage。image 只能是下列其中一項: |
||
large |
大型圖片,例如相簿封面等。 |
|
icon |
顯示在標題右側的小型圖片圖示。大小已調整為 36x36 dp。 |
StaticListPrompt
顯示選項清單的資訊卡。
YAML 表示法 | |
---|---|
title: string
subtitle: string
items:
- object ( |
欄位 | |
---|---|
title |
選用設定。清單的標題。 |
subtitle |
選用設定。清單子標題。 |
items[] |
必要欄位。清單項目。 |
ListItem
清單中的項目。
YAML 表示法 | |
---|---|
key: string
title: string
description: string
image:
object ( |
欄位 | |
---|---|
key |
必要欄位。與相關聯類型中的項目鍵名稱相符的 NLU 鍵。輕觸項目後,這個鍵會發布為選取選項參數。 |
title |
必要欄位。商品的名稱。使用者輕觸這段文字後,系統會將其內容張貼回對話,就像使用者輸入內容一樣。各項項目的名稱不得重複。 |
description |
選用設定。商品的內文。 |
image |
選用設定。項目圖片。 |
StaticCollectionPrompt
顯示一系列選項的資訊卡。
YAML 表示法 | |
---|---|
title: string subtitle: string items: - object ( |
欄位 | |
---|---|
title |
選用設定。珍藏內容的名稱。 |
subtitle |
選用設定。「系列」的副標題。 |
items[] |
必要欄位。集合項目。 |
imageFill |
選用設定。圖片顯示選項類型。 |
CollectionItem
集合中的項目。
YAML 表示法 | |
---|---|
key: string
title: string
description: string
image:
object ( |
欄位 | |
---|---|
key |
必要欄位。與相關類型中項目鍵名稱相符的 NLU 鍵。輕觸項目後,這個鍵會發布為選取選項參數。 |
title |
必要欄位。商品的名稱。使用者輕觸這段文字後,系統會將其內容張貼回對話,就像使用者輸入內容一樣。各項項目的名稱不得重複。 |
description |
選用設定。商品的內文。 |
image |
選用設定。項目圖片。 |
StaticCollectionBrowsePrompt
將一組網頁文件呈現為一系列大型圖塊項目。可選取項目,以便在網頁檢視器中開啟其相關聯的網路文件。
YAML 表示法 | |
---|---|
items: - object ( |
欄位 | |
---|---|
items[] |
瀏覽集合中的項目。名單人數在 [2, 10] 的範圍內。 |
imageFill |
集合中圖片的圖片顯示選項。 |
CollectionBrowseItem
集合中的項目。
YAML 表示法 | |
---|---|
title: string description: string footer: string image: object ( |
欄位 | |
---|---|
title |
必要欄位。系列作品的名稱。 |
description |
集合項目的說明。 |
footer |
產品素材資源集合項目的頁尾文字,顯示在說明下方。單行文字,以刪節號截斷。 |
image |
產品素材資源集合項目的圖片。 |
openUriAction |
必要欄位。選取項目時要開啟的 URI。 |
建議
代表建議方塊,這是向使用者顯示的 UI 元素。
YAML 表示法 | |
---|---|
title: string |
欄位 | |
---|---|
title |
必要欄位。建議方塊中顯示的文字。使用者輕觸這段文字後,系統會將其內容張貼回對話,就像使用者輸入內容一樣。所有標題在一組建議方塊中都不得重複。最多 25 個字元 |
StaticCanvasPrompt
代表要傳送給使用者的互動式畫布回應。如果除了顯示互動式畫布回應外,這項政策可以與包含提示中的 firstSimple
欄位搭配使用,向使用者說話。
YAML 表示法 | |
---|---|
url: string data: - value suppressMic: boolean sendStateDataToCanvasApp: boolean enableFullScreen: boolean continueTtsDuringTouch: boolean |
欄位 | |
---|---|
url |
必要欄位。要載入的網頁資料檢視網址。 |
data[] |
選用設定。要以事件的形式傳遞至沉浸式體驗網頁的 JSON 資料。如果內含提示中的 |
suppressMic |
選用設定。true 值表示使用者看到這項沉浸式回應後,不會開啟麥克風來擷取輸入內容。 |
sendStateDataToCanvasApp |
選用設定。如為 |
enableFullScreen |
選用設定。如果 |
continueTtsDuringTouch |
選用設定。如果為 True,整個畫布工作階段不會因輕觸畫面而停止 TTS。預設值為 false。 |