- HTTP 要求
- 路徑參數
- 要求主體
- 回應主體
- UserInput
- InputType
- DeviceProperties
- Surface
- Location
- LatLng
- 輸出內容
- 畫布
- 提示
- 簡單
- 內容
- 資訊卡
- 圖片
- ImageFill
- 連結
- OpenUrl
- UrlHint
- 表格
- TableColumn
- HorizontalAlignment
- TableRow
- TableCell
- 媒體
- MediaType
- OptionalMediaControls
- MediaObject
- MediaImage
- 集合
- CollectionItem
- 清單
- ListItem
- 建議
- 診斷
- ExecutionEvent
- ExecutionState
- 運算單元
- SlotFillingStatus
- 版位
- SlotMode
- SlotStatus
- Status
- UserConversationInput
- IntentMatch
- ConditionsEvaluated
- 條件
- OnSceneEnter
- WebhookRequest
- WebhookResponse
- WebhookInitiatedTransition
- SlotMatch
- SlotRequested
- SlotValidated
- FormFilled
- WaitingForUserInput
- EndConversation
播放一回合的對話。
HTTP 要求
POST https://actions.googleapis.com/v2/{project=projects/*}:sendInteraction
這個網址使用 gRPC 轉碼語法。
路徑參數
參數 | |
---|---|
project |
必要欄位。要測試的專案,以專案 ID 表示。格式:projects/{project} |
要求主體
要求主體的資料會採用以下結構:
JSON 表示法 | |
---|---|
{ "input": { object ( |
欄位 | |
---|---|
input |
必要欄位。使用者提供的輸入內容。 |
deviceProperties |
必要欄位。用於與動作互動的裝置屬性。 |
conversationToken |
必須在上一次互動時透過 SendInteractionResponse 接收的不透明權杖。如果不設定這個選項,可在測試工作階段的最初互動或放棄先前的對話後開始新對話,藉此發起新對話。 |
回應主體
如果成功,回應主體即會包含具有以下結構的資料:
回覆回合的會話群組。
JSON 表示法 | |
---|---|
{ "output": { object ( |
欄位 | |
---|---|
output |
提供給使用者的輸出內容。 |
diagnostics |
說明要求處理方式的診斷資訊。 |
conversationToken |
在下一個遠端程序呼叫 (RPC) 呼叫上設定的不透明權杖,以便繼續執行相同的對話。 |
UserInput
在對話回合中提供使用者輸入內容。
JSON 表示法 | |
---|---|
{
"query": string,
"type": enum ( |
欄位 | |
---|---|
query |
使用者傳送的輸入內容內容。 |
type |
輸入內容的類型。 |
InputType
指出輸入來源、輸入的查詢或語音查詢。
列舉 | |
---|---|
INPUT_TYPE_UNSPECIFIED |
未指定的輸入來源。 |
TOUCH |
透過 GUI 互動進行查詢。 |
VOICE |
語音查詢。 |
KEYBOARD |
輸入的查詢。 |
URL |
這個動作是由網址連結觸發。 |
DeviceProperties
與對話回合相關的裝置屬性。
JSON 表示法 | |
---|---|
{ "surface": enum ( |
欄位 | |
---|---|
surface |
用於與動作互動的介面。 |
location |
裝置所在位置,例如經緯度和格式化地址。 |
locale |
裝置上設定的語言代碼。格式應符合 BCP 47:https://tools.ietf.org/html/bcp47 範例:en、en-US、es-419 (如需更多範例,請前往 https://tools.ietf.org/html/bcp47#appendix-A)。 |
timeZone |
裝置上設定的時區。格式應符合 IANA 時區資料庫,例如「America/New_York」:https://www.iana.org/time-zones |
介面
用來與動作互動的途徑。日後可能會包含其他值。
列舉 | |
---|---|
SURFACE_UNSPECIFIED |
預設值。這個值未使用。 |
SPEAKER |
喇叭 (例如 Google Home)。 |
PHONE |
。 |
ALLO |
。 |
SMART_DISPLAY |
智慧螢幕裝置。 |
KAI_OS |
KaiOS。 |
位置
代表位置的容器。
JSON 表示法 | |
---|---|
{
"coordinates": {
object ( |
欄位 | |
---|---|
coordinates |
地理座標。需要以下權限:[DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION]。 |
formattedAddress |
顯示地址,例如「110 臺北市信義區信義路 5 段 7 號」需要以下權限:[DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION]。 |
zipCode |
郵遞區號。必須具備 [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION] 或 [DEVICE_COARSE_LOCATION] [google.actions.v2.Permission.DEVICE_COARSE_LOCATION] 權限。 |
city |
市區鄉鎮。必須具備 [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION] 或 [DEVICE_COARSE_LOCATION] [google.actions.v2.Permission.DEVICE_COARSE_LOCATION] 權限。 |
LatLng
代表經緯度組合的物件。以一對雙精準數表示經度度數和緯度度數。除非另有指定,否則這個物件必須符合 WGS84 標準。此外,值必須在正規化範圍內。
JSON 表示法 | |
---|---|
{ "latitude": number, "longitude": number } |
欄位 | |
---|---|
latitude |
緯度度數,必須介於 [-90.0, +90.0] 的範圍之間。 |
longitude |
經度度數,必須介於 [-180.0, +180.0] 的範圍之間。 |
輸出內容
使用者可以看到對話回合的輸出內容。
JSON 表示法 | |
---|---|
{ "text": string, "speech": [ string ], "canvas": { object ( |
欄位 | |
---|---|
text |
以純字串形式傳送給使用者的語音回應。 |
speech[] |
動作產生的語音內容。這可能包含 SSML 等標記元素。 |
canvas |
互動式畫布內容。 |
actionsBuilderPrompt |
對話結束時的提示狀態。如要進一步瞭解這項提示,請前往:https://developers.google.com/assistant/conversational/prompts |
Canvas
代表要傳送給使用者的互動式畫布回應。除了顯示互動式畫布回應外,這段標記也可與內含提示中的「firstSimple」欄位搭配使用,讓使用者發言。回應的大小上限為 50,000 個位元組。
JSON 表示法 | |
---|---|
{ "url": string, "data": [ value ], "suppressMic": boolean, "enableFullScreen": boolean } |
欄位 | |
---|---|
url |
要載入的互動式畫布網頁應用程式網址。如未設定,系統會重複使用目前使用中畫布的網址。 |
data[] |
選用設定。要以事件的形式傳遞至沉浸式體驗網頁的 JSON 資料。如果內含提示的「覆寫」欄位是這個 Canvas 提示中定義的資料值,則系統會將先前 Canvas 提示中定義的資料值加到後方。 |
suppressMic |
選用設定。預設值為 false。 |
enableFullScreen |
如果 |
Prompt
代表使用者的回應。
JSON 表示法 | |
---|---|
{ "append": boolean, "override": boolean, "firstSimple": { object ( |
欄位 | |
---|---|
append |
選用設定。這個模式用於將這則訊息與先前定義的訊息合併。「false」會清除先前定義的所有訊息 (第一個和最後一筆簡單內容、內容、建議連結和畫布),並新增這個提示中定義的訊息。「true」會將這個提示中定義的訊息新增至先前回應中定義的訊息。將這個欄位設為「true」後,系統也會在簡易提示、建議提示和 Canvas 提示 (屬於「內容」提示) 中的部分欄位附加這項功能。如果在提示中定義了內容和連結訊息,系統一律會覆寫內容和連結訊息。預設值為「false」。 |
override |
選用設定。這個模式用於將這則訊息與先前定義的訊息合併。如果設為「true」,系統會清除先前定義的所有訊息 (第一個和最後一則簡單的內容、內容、建議連結和畫布),並新增這個提示中定義的訊息。「false」會將這個提示中定義的訊息新增至先前回應中定義的訊息。如果將這個欄位設為「false」,也可以將這個欄位附加至簡易提示、建議提示和 Canvas 提示 (屬於「內容」提示) 中的某些欄位。如果在提示中定義了內容和連結訊息,系統一律會覆寫訊息和連結訊息。預設值為「false」。 |
firstSimple |
選用設定。第一個語音和純文字回應。 |
content |
選用設定。要向使用者顯示的資訊卡、清單或媒體等內容。 |
lastSimple |
選用設定。最後一個語音和純文字回應。 |
suggestions[] |
選用設定。向使用者顯示的建議,且一律會顯示在回應結尾。如果內含提示的「覆寫」欄位為「false」,這個欄位中定義的標題會加到任何先前定義的建議提示中所定義的標題,重複的值會遭到移除。 |
link |
選用設定。可連結至相關聯應用程式或網站的額外建議方塊。這個方塊會顯示為「開啟 |
canvas |
選用設定。代表要傳送給使用者的互動式畫布回應。 |
簡單易用
代表要傳送給使用者的簡單提示。
JSON 表示法 | |
---|---|
{ "speech": string, "text": string } |
欄位 | |
---|---|
speech |
選用設定。代表要向使用者顯示的語音。可以是 SSML 或文字轉語音。如果內含提示的「覆寫」欄位為「true」,則這個欄位中定義的語音會取代前一個簡單提示的語音。 |
text |
顯示在即時通訊泡泡中的選填文字。如未指定,系統會使用上述的語音欄位顯示內容。最長不得超過 640 個半形字元。如果內含提示中的「覆寫」欄位為「true」,這個欄位中定義的文字就會取代為先前簡單提示的文字。 |
內容
要顯示的內容。
JSON 表示法 | |
---|---|
{ // Union field |
欄位 | ||
---|---|---|
聯集欄位 content 。內容。content 只能是下列其中一項: |
||
card |
基本資訊卡。 |
|
image |
圖片。 |
|
table |
表格資訊卡。 |
|
media |
回應指出要播放的媒體組合。 |
|
canvas |
用於互動式畫布體驗的回應。 |
|
collection |
資訊卡顯示一系列選項。 |
|
list |
資訊卡:列出可供選擇的選項。 |
資訊卡
顯示部分資訊的基本資訊卡,例如圖片和/或文字。
JSON 表示法 | |
---|---|
{ "title": string, "subtitle": string, "text": string, "image": { object ( |
欄位 | |
---|---|
title |
資訊卡的總標題。選用。 |
subtitle |
選用。 |
text |
資訊卡的內文。支援有限的 Markdown 語法組合。除非有圖片,否則此為必要項目。 |
image |
資訊卡的主頁橫幅。高度固定為 192dp。選用。 |
imageFill |
圖片背景的填滿方式。選用。 |
button |
按鈕選用。 |
映像檔
資訊卡中顯示的圖片。
JSON 表示法 | |
---|---|
{ "url": string, "alt": string, "height": integer, "width": integer } |
欄位 | |
---|---|
url |
圖片的來源網址。圖片可以是 JPG、PNG 和 GIF (動畫和非動畫)。例如: |
alt |
圖片的文字說明,供無障礙功能使用,例如螢幕閱讀器。這是必填欄位。 |
height |
圖片的高度 (以像素為單位)。選用。 |
width |
圖片的寬度 (以像素為單位)。選用。 |
ImageFill
影響圖片呈現方式的可能圖片顯示選項。如果圖片的長寬比與圖片容器的長寬比不符,則應使用這個屬性。
列舉 | |
---|---|
UNSPECIFIED |
未指定的圖片填滿。 |
GRAY |
使用灰色長條填補圖片和圖片容器之間的間距。 |
WHITE |
使用白色長條填滿圖片和圖片容器之間的間距。 |
CROPPED |
圖片經過縮放,使圖片寬度和高度符合或超過容器尺寸。如果縮放後的圖片高度大於容器高度,這可能會裁剪圖片的頂端和底部;如果縮放後的圖片寬度大於容器寬度,則裁剪圖片的左側和右側。這與寬螢幕電視上播放 4:3 影片時的「縮放模式」類似。 |
連結
連結內容。
JSON 表示法 | |
---|---|
{
"name": string,
"open": {
object ( |
欄位 | |
---|---|
name |
連結名稱 |
open |
使用者開啟連結後會發生什麼事 |
OpenUrl
使用者開啟連結時採取的動作。
JSON 表示法 | |
---|---|
{
"url": string,
"hint": enum ( |
欄位 | |
---|---|
url |
網址欄位,可以是下列任一值:- 用來開啟應用程式連結應用程式或網頁的 http/https 網址 |
hint |
表示網址類型的提示。 |
UrlHint
不同類型的網址提示。
列舉 | |
---|---|
LINK_UNSPECIFIED |
未指定 |
AMP |
直接指向 AMP 內容的網址,或是透過 參照 AMP 內容的標準網址。 |
資料表
顯示文字表格的表格資訊卡。
JSON 表示法 | |
---|---|
{ "title": string, "subtitle": string, "image": { object ( |
欄位 | |
---|---|
title |
表格的整體標題。選用;如果設定字幕,則必須設定此項目。 |
subtitle |
資料表的副標題。選用。 |
image |
與表格相關聯的圖片。選用。 |
columns[] |
資料欄的標頭和對齊方式。 |
rows[] |
資料表的資料列資料。前 3 列一定會顯示,但其他內容可能會在特定介面上顯示。請使用模擬工具進行測試,瞭解特定介面會顯示哪些資料列。在支援 WEB_BROWSER 功能的介面上,您可以將使用者導向含有更多資料的網頁。 |
button |
按鈕。 |
TableColumn
說明資料表中的欄。
JSON 表示法 | |
---|---|
{
"header": string,
"align": enum ( |
欄位 | |
---|---|
header |
資料欄的標題文字。 |
align |
內容 w.r.t 欄的水平對齊。如未指定,內容則會與頂部邊緣對齊。 |
HorizontalAlignment
儲存格內內容的對齊方式。
列舉 | |
---|---|
UNSPECIFIED |
未指定水平對齊。 |
LEADING |
儲存格的前端邊緣。此為預設值。 |
CENTER |
內容會與欄中央對齊。 |
TRAILING |
內容與資料欄的結尾邊緣對齊。 |
TableRow
說明資料表中的資料列。
JSON 表示法 | |
---|---|
{
"cells": [
{
object ( |
欄位 | |
---|---|
cells[] |
此列的儲存格。我們保證顯示前 3 個儲存格,但其他儲存格可能會截斷。請使用模擬器進行測試,看看在特定表面會顯示哪些儲存格。 |
divider |
指出每一列後是否應有分隔線。 |
TableCell
說明資料列中的儲存格。
JSON 表示法 | |
---|---|
{ "text": string } |
欄位 | |
---|---|
text |
儲存格的文字內容。 |
媒體
代表一個媒體物件。包含媒體相關資訊,例如名稱、說明、網址等。
JSON 表示法 | |
---|---|
{ "mediaType": enum ( |
欄位 | |
---|---|
mediaType |
媒體類型。 |
startOffset |
第一個媒體物件的開始偏移。 時間長度以秒為單位,最多可有 9 個小數位數,並應以「 |
optionalMediaControls[] |
這個媒體回應工作階段可支援的選用媒體控制項類型。如果設定這個項目,系統會在特定媒體事件發生時向 3p 發出要求。如果未設定,3p 仍必須處理兩個預設控制項類型「FINISHED」和「FAILED」。 |
mediaObjects[] |
媒體物件清單 |
MediaType
此回應的媒體類型。
列舉 | |
---|---|
MEDIA_TYPE_UNSPECIFIED |
未指定的媒體類型。 |
AUDIO |
音訊檔案。 |
MEDIA_STATUS_ACK |
回覆確認媒體狀態報告的回應。 |
OptionalMediaControls
媒體回應支援的選用媒體控制項類型
列舉 | |
---|---|
OPTIONAL_MEDIA_CONTROLS_UNSPECIFIED |
未指定的值 |
PAUSED |
已暫停活動在使用者暫停媒體時觸發。 |
STOPPED |
已停止事件。使用者在媒體播放期間退出 3p 工作階段時觸發。 |
MediaObject
代表單一媒體物件
JSON 表示法 | |
---|---|
{
"name": string,
"description": string,
"url": string,
"image": {
object ( |
欄位 | |
---|---|
name |
此媒體物件的名稱。 |
description |
此媒體物件的說明。 |
url |
指向媒體內容的網址。 |
image |
與媒體資訊卡一起顯示的圖片。 |
MediaImage
與媒體資訊卡一起顯示的圖片。
JSON 表示法 | |
---|---|
{ // Union field |
欄位 | ||
---|---|---|
聯集欄位 image 。圖片。image 只能是下列其中一項: |
||
large |
大型圖片,例如相簿封面等。 |
|
icon |
顯示在標題右側的小型圖片圖示。大小已調整為 36x36 dp。 |
集合
顯示一系列選項的資訊卡。
JSON 表示法 | |
---|---|
{ "title": string, "subtitle": string, "items": [ { object ( |
欄位 | |
---|---|
title |
珍藏內容的名稱。選用。 |
subtitle |
「系列」的副標題。選用。 |
items[] |
下限:2,上限:10 |
imageFill |
如何填入集合項目的圖片背景。選用。 |
CollectionItem
集合中的一個項目
JSON 表示法 | |
---|---|
{ "key": string } |
欄位 | |
---|---|
key |
必要欄位。與相關類型中項目鍵名稱相符的 NLU 鍵。 |
清單
顯示選項清單的資訊卡。
JSON 表示法 | |
---|---|
{
"title": string,
"subtitle": string,
"items": [
{
object ( |
欄位 | |
---|---|
title |
清單的標題。選用。 |
subtitle |
清單子標題。選用。 |
items[] |
下限:2,上限:30 |
ListItem
清單中的項目
JSON 表示法 | |
---|---|
{ "key": string } |
欄位 | |
---|---|
key |
必要欄位。與相關類型中項目鍵名稱相符的 NLU 鍵。 |
建議
要向使用者顯示的輸入建議。
JSON 表示法 | |
---|---|
{ "title": string } |
欄位 | |
---|---|
title |
必要欄位。建議方塊中顯示的文字。使用者輕觸這段文字後,系統會將其內容張貼回對話,就像使用者輸入內容一樣。所有標題在一組建議方塊中都不得重複。最多 25 個字元 |
診斷
對話回合的相關診斷資訊。
JSON 表示法 | |
---|---|
{
"actionsBuilderEvents": [
{
object ( |
欄位 | |
---|---|
actionsBuilderEvents[] |
這個事件清單含有動作建構工具互動模型各階段的對話處理詳細資料。僅針對 Actions Builder 和 Actions SDK 應用程式填入值。 |
ExecutionEvent
包含處理 Actions Builder 對話要求期間發生的執行事件相關資訊。如需對話要求所涵蓋階段的總覽,請參閱 https://developers.google.com/assistant/conversational/actions。
JSON 表示法 | |
---|---|
{ "eventTime": string, "executionState": { object ( |
欄位 | ||
---|---|---|
eventTime |
事件發生時的時間戳記。 RFC3339 世界標準時間「Zulu」格式的時間戳記,採用奈秒解析度,且最多 9 個小數位數。範例: |
|
executionState |
這個事件期間的執行狀態。 |
|
status |
特定執行步驟的結果狀態。 |
|
warningMessages[] |
在執行這個事件時產生的警告清單。警告是開發人員在對話要求期間發現的提示。這些錯誤通常不是重大問題,而且不會停止執行要求。舉例來說,當 Webhook 嘗試覆寫不存在的自訂類型時,可能會產生警告。錯誤會回報為失敗的狀態碼,但即使狀態本身沒有問題,仍可能出現警告。 |
|
聯集欄位 EventData 。關於處理對話回合時的不同事件,相關詳細資訊。此處設定的欄位會定義此事件的類型。EventData 只能是下列其中一項: |
||
userInput |
使用者輸入處理事件。 |
|
intentMatch |
意圖比對事件。 |
|
conditionsEvaluated |
狀況評估事件。 |
|
onSceneEnter |
OnSceneEnter 執行事件。 |
|
webhookRequest |
Webhook 要求分派事件。 |
|
webhookResponse |
Webhook 回應收據事件。 |
|
webhookInitiatedTransition |
Webhook 啟動的轉換事件。 |
|
slotMatch |
運算單元比對事件。 |
|
slotRequested |
運算單元要求事件。 |
|
slotValidated |
運算單元驗證事件。 |
|
formFilled |
表單填寫活動。 |
|
waitingUserInput |
正在等待使用者輸入事件。 |
|
endConversation |
對話結束事件。 |
ExecutionState
執行作業目前的狀態。
JSON 表示法 | |
---|---|
{ "currentSceneId": string, "sessionStorage": { object }, "slots": { object ( |
欄位 | |
---|---|
currentSceneId |
目前使用中的場景 ID。 |
sessionStorage |
工作階段儲存空間狀態:https://developers.google.com/assistant/conversational/storage-session |
slots |
運算單元填充狀態 (如適用):https://developers.google.com/assistant/conversational/scenes#slot_filling |
promptQueue[] |
提示佇列:https://developers.google.com/assistant/conversational/prompts |
userStorage |
使用者儲存空間狀態:https://developers.google.com/assistant/conversational/storage-user |
householdStorage |
家用儲存空間狀態:https://developers.google.com/assistant/conversational/storage-home |
運算單元
代表場景版位的目前狀態。
JSON 表示法 | |
---|---|
{ "status": enum ( |
欄位 | |
---|---|
status |
目前的運算單元填充狀態。 |
slots |
與目前場景相關聯的版位。 這個物件中包含 |
SlotFillingStatus
代表運算單元填充目前的狀態。
列舉 | |
---|---|
UNSPECIFIED |
使用情況欄位未填入時的備用值。 |
INITIALIZED |
運算單元已初始化,但尚未開始運算單元填充。 |
COLLECTING |
正在收集運算單元值。 |
FINAL |
所有版位值皆為最終值且無法變更。 |
運算單元
代表版位。
JSON 表示法 | |
---|---|
{ "mode": enum ( |
欄位 | |
---|---|
mode |
運算單元的模式 (必要或選用)。可由開發人員設定。 |
status |
版位的狀態。 |
value |
運算單元的值。變更回應中的這個值將會修改運算單元填充中的值。 |
updated |
指出是否在上次轉彎時收集版位值。這是唯讀欄位。 |
prompt |
選用設定。需要填滿時段時,系統就會向使用者顯示這項提示。這項提示會覆寫控制台中定義的現有提示。這個欄位不包含在 Webhook 要求中。 |
SlotMode
代表版位的模式,即必要時或不需要。
列舉 | |
---|---|
MODE_UNSPECIFIED |
使用情況欄位未填入時的備用值。 |
OPTIONAL |
表示版位不需要完成運算單元填充。 |
REQUIRED |
表示版位需要完成運算單元填充。 |
SlotStatus
代表版位的狀態。
列舉 | |
---|---|
SLOT_UNSPECIFIED |
使用情況欄位未填入時的備用值。 |
EMPTY |
表示版位沒有任何值。這個狀態無法透過回應修改。 |
INVALID |
表示版位值無效。您可以透過回應設定這個狀態。 |
FILLED |
表示版位有值。這個狀態無法透過回應修改。 |
狀態
Status
類型會定義適用於不同程式設計環境 (包含 REST API 和遠端程序呼叫 (RPC) API) 的邏輯錯誤模型。gRPC 會使用這個模型。每個 Status
訊息包含三部分的資料:錯誤代碼、錯誤訊息和錯誤詳細資料。
如要進一步瞭解這個錯誤模型,以及如何使用這個錯誤模型,請參閱 API 設計指南。
JSON 表示法 | |
---|---|
{ "code": integer, "message": string, "details": [ { "@type": string, field1: ..., ... } ] } |
欄位 | |
---|---|
code |
狀態碼,應為 |
message |
向開發人員顯示的錯誤訊息,應以英文呈現。任何向使用者顯示的錯誤訊息都應進行本地化並透過 |
details[] |
包含錯誤詳細資料的訊息清單。這是供 API 使用的一組常用訊息類型。 包含任意類型欄位的物件。額外的 |
UserConversationInput
與使用者輸入內容相關的資訊。
JSON 表示法 | |
---|---|
{ "type": string, "originalQuery": string } |
欄位 | |
---|---|
type |
使用者輸入內容類型。例如鍵盤、語音、觸控等 |
originalQuery |
使用者提供的原始文字。 |
IntentMatch
觸發意圖比對 (全球或特定場景) 的相關資訊:https://developers.google.com/assistant/conversational/intents
JSON 表示法 | |
---|---|
{
"intentId": string,
"intentParameters": {
string: {
object ( |
欄位 | |
---|---|
intentId |
觸發這項互動的意圖 ID。 |
intentParameters |
觸發這項互動的意圖參數。 這個物件中包含 |
handler |
附加至此互動的處理常式名稱。 |
nextSceneId |
這次互動促成的場景。 |
ConditionsEvaluated
條件評估結果:https://developers.google.com/assistant/conversational/scenes#conditions
JSON 表示法 | |
---|---|
{ "failedConditions": [ { object ( |
欄位 | |
---|---|
failedConditions[] |
系統評估為「false」的條件清單。 |
successCondition |
第一個經評估為「true」的條件 (如果有的話)。 |
條件
評估條件。
JSON 表示法 | |
---|---|
{ "expression": string, "handler": string, "nextSceneId": string } |
欄位 | |
---|---|
expression |
這個條件指定的運算式。 |
handler |
在評估的條件中指定處理常式名稱。 |
nextSceneId |
在評估條件中指定目的地場景。 |
OnSceneEnter
執行 onSceneEnter 階段的相關資訊:https://developers.google.com/assistant/conversational/scenes#onEnter
JSON 表示法 | |
---|---|
{ "handler": string } |
欄位 | |
---|---|
handler |
onSceneEnter 事件中指定的處理常式名稱。 |
WebhookRequest
傳送至動作 Webhook 的要求相關資訊:https://developers.google.com/assistant/conversational/webhooks#payloads
JSON 表示法 | |
---|---|
{ "requestJson": string } |
欄位 | |
---|---|
requestJson |
Webhook 要求的酬載。 |
WebhookResponse
從動作 Webhook 接收的回應相關資訊:https://developers.google.com/assistant/conversational/webhooks#payloads
JSON 表示法 | |
---|---|
{ "responseJson": string } |
欄位 | |
---|---|
responseJson |
Webhook 回應的酬載。 |
WebhookInitiatedTransition
由 Webhook 傳回的目的地情境觸發的事件:https://developers.google.com/assistant/conversational/webhooks#transition_scenes
JSON 表示法 | |
---|---|
{ "nextSceneId": string } |
欄位 | |
---|---|
nextSceneId |
用於轉場效果的場景 ID。 |
SlotMatch
相符版位的相關資訊:https://developers.google.com/assistant/conversational/scenes#slot_filling
JSON 表示法 | |
---|---|
{
"nluParameters": {
string: {
object ( |
欄位 | |
---|---|
nluParameters |
由使用者輸入內容的 NLU 擷取的參數。 這個物件中包含 |
SlotRequested
目前要求的時段相關資訊:https://developers.google.com/assistant/conversational/scenes#slot_filling
JSON 表示法 | |
---|---|
{
"slot": string,
"prompt": {
object ( |
欄位 | |
---|---|
slot |
要求的運算單元名稱。 |
prompt |
運算單元提示。 |
SlotValidated
版位 Webhook 驗證完成後發生的事件:https://developers.google.com/assistant/conversational/scenes#slot_filling
FormFilled
表單填滿時會發生的事件:https://developers.google.com/assistant/conversational/scenes#slot_filling
WaitingForUserInput
系統需要使用者輸入內容時發生的事件:https://developers.google.com/assistant/conversational/scenes#input
EndConversation
表示與服務專員對話已結束的事件。