- 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
プロンプト候補のリストを表します。この候補のうち 1 つが、ユーザーへのレスポンスで表示されるプロンプトとして選択されます。このメッセージはローカライズ可能です。
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 |
(省略可)関連するアプリまたはサイトにリンクできる追加の候補ワード。チップは「Open」というタイトルでレンダリングされます。 |
override |
(省略可)このメッセージを、以前に定義されたメッセージと統合する方法のモード。 |
canvas |
インタラクティブなキャンバス エクスペリエンスに使用されるレスポンス。 |
StaticSimplePrompt
ユーザーに送信するシンプルなプロンプトを表します。
YAML 表現 | |
---|---|
variants:
- object ( |
フィールド | |
---|---|
variants[] |
可能性のあるバリアントのリスト。 |
バリアント
単純なプロンプトの一部であるバリアントを表します。
YAML 表現 | |
---|---|
speech: string text: string |
フィールド | |
---|---|
speech |
(省略可)ユーザーに向けて読み上げられる音声を表します。SSML またはテキスト読み上げが可能です。デフォルトでは、音声は前のシンプルなプロンプトの音声に追加されます。含まれるプロンプトの |
text |
(省略可)チャットのふきだしに表示するテキスト。指定しない場合、上記の音声フィールドの表示レンダリングが使用されます。最大 640 文字です。デフォルトでは、テキストは前のシンプルなプロンプトのテキストに付加されます。含まれるプロンプトの |
StaticContentPrompt
StaticPrompt のコンテンツ部分のプレースホルダ。
YAML 表現 | |
---|---|
# Union field |
フィールド | ||
---|---|---|
共用体フィールド content 。プロンプトに含めることができるコンテンツは 1 種類のみです。content は次のいずれかになります。 |
||
card |
ベーシック カード。 |
|
image |
画像。 |
|
table |
テーブルカード。 |
|
media |
再生するメディアのセットを示すレスポンス。 |
|
list |
選択可能なオプションのリストを提示するカード。 |
|
collection |
選択可能なオプションのリストを示すカード。 |
|
collectionBrowse |
開くウェブページのコレクションを提示するカード。 |
StaticCardPrompt
画像やテキストなどの情報を表示するための基本的なカード。
YAML 表現 | |
---|---|
title: string subtitle: string text: string image: object ( |
フィールド | |
---|---|
title |
(省略可)カードの全体的なタイトル。 |
subtitle |
(省略可)カードのサブタイトル。 |
text |
必須。カードの本文。画像が存在しない場合に必要です。書式設定のために限定されたマークダウン構文をサポートします。 |
image |
(省略可)カードのヒーロー画像。高さは 192 dp に固定されています。 |
imageFill |
(省略可)画像の背景の塗りつぶし方法。 |
button |
(省略可)カードに表示されるクリック可能なボタン。 |
StaticImagePrompt
カードに表示される画像。
YAML 表現 | |
---|---|
url: string alt: string height: integer width: integer |
フィールド | |
---|---|
url |
必須。画像のソース URL。JPG、PNG、GIF(アニメーション GIF と非アニメーション GIF)を使用できます。例: |
alt |
必須。スクリーン リーダーなどのユーザー補助機能で使用する、画像の説明のテキスト。 |
height |
(省略可)画像の高さ(ピクセル単位)。 |
width |
(省略可)画像の幅(ピクセル単位)。 |
StaticLinkPrompt
候補ワードとして表示される、ユーザーが開くことができるリンクを定義します。
YAML 表現 | |
---|---|
name: string
open:
object ( |
フィールド | |
---|---|
name |
リンクの名前 |
open |
ユーザーがリンクを開いたときの動作を定義します。 |
OpenUrl
ユーザーがリンクを開いたときの動作を定義します。
YAML 表現 | |
---|---|
url: string
hint: enum ( |
フィールド | |
---|---|
url |
url フィールドでは、次のいずれかを指定できます。- アプリとリンクしたアプリまたはウェブページを開くための http または https の URL |
hint |
URL タイプのヒントを示します。 |
StaticTablePrompt
テキストの表を表示するためのカード。
YAML 表現 | |
---|---|
title: string subtitle: string image: object ( |
フィールド | |
---|---|
title |
(省略可)テーブルの全体的なタイトル。サブタイトルが設定されている場合に設定する必要があります。 |
subtitle |
(省略可)テーブルのサブタイトル。 |
image |
(省略可)テーブルに関連付けられている画像。 |
columns[] |
(省略可)ヘッダーと列の配置。 |
rows[] |
(省略可)テーブルの行データ。最初の 3 行は表示されることが保証されますが、その他の行はサーフェスによっては切り捨てられる場合があります。特定のサーフェスに対してどの行が表示されるかをシミュレータでテストしてください。 |
button |
(省略可)ボタン。 |
TableColumn
テーブル内の列を表します。
YAML 表現 | |
---|---|
header: string
align: enum ( |
フィールド | |
---|---|
header |
列のヘッダー テキスト。 |
align |
列に対するコンテンツの水平方向の配置。省略した場合、内容は前端に揃えられます。 |
TableRow
表の行を記述します。
YAML 表現 | |
---|---|
cells:
- object ( |
フィールド | |
---|---|
cells[] |
この行のセル。最初の 3 つのセルは表示されることが保証されますが、その他のセルはサーフェスによっては切り捨てられる場合があります。特定のサーフェスに対してどのセルが表示されるかをシミュレータでテストしてください。 |
divider |
各行の後に分割線を配置するかどうかを示します。 |
TableCell
行のセルを記述します。
YAML 表現 | |
---|---|
text: string |
フィールド | |
---|---|
text |
セルのテキスト コンテンツ。 |
StaticMediaPrompt
名前、説明、URL などのメディアに関する情報が含まれます。次の ID: 11
YAML 表現 | |
---|---|
mediaType: enum ( |
フィールド | |
---|---|
mediaType |
このレスポンスのメディアタイプ。 |
startOffset |
最初のメディア オブジェクトの開始オフセット。 小数点以下 9 桁まで、「 |
optionalMediaControls[] |
このメディア レスポンス セッションがサポートするオプションのメディア コントロール タイプ。設定すると、特定のメディア イベントが発生したときにサードパーティにリクエストが送信されます。設定しない場合、3p は引き続き 2 つのデフォルトのコントロール タイプ(FINISHED と FAILED)を処理する必要があります。 |
mediaObjects[] |
メディア オブジェクトのリスト。 |
repeatMode |
メディア オブジェクト リストの繰り返しモード。 |
MediaObject
単一のメディア オブジェクトを表します。
YAML 表現 | |
---|---|
name: string
description: string
url: string
image:
object ( |
フィールド | |
---|---|
name |
このメディア オブジェクトの名前。 |
description |
このメディア オブジェクトの説明。 |
url |
メディア コンテンツを指す URL。 |
image |
メディアカードとともに表示する画像。 |
MediaImage
MediaPrompt 内に表示される画像。
YAML 表現 | |
---|---|
# Union field |
フィールド | ||
---|---|---|
共用体フィールド image 。使用できる MediaImage は 1 種類のみです。image は次のいずれかになります。 |
||
large |
アルバムのカバーなど、大きな画像 |
|
icon |
タイトルの右側に表示される小さな画像アイコン。36×36 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 |
説明の下に表示されるコレクション アイテムのフッター テキスト。1 行のテキスト(省略記号で切り捨てられます)。 |
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 |
必須。読み込むウェブビューの URL。 |
data[] |
(省略可)没入型エクスペリエンスのウェブページにイベントとして渡される JSON データ。含まれているプロンプトの |
suppressMic |
(省略可)値を true に設定した場合、この没入感のある応答がユーザーに表示された後、入力をキャプチャするためにマイクが開かれません。 |
sendStateDataToCanvasApp |
(省略可) |
enableFullScreen |
(省略可) |
continueTtsDuringTouch |
(省略可)true の場合、画面をタップしてもキャンバス セッション全体で TTS は停止されません。デフォルト値: false |