- StaticPromptCandidate
- セレクタ
- SurfaceCapabilities
- StaticPromptResponse
- StaticSimplePrompt
- バリアント
- StaticContentPrompt
- StaticCardPrompt
- StaticImagePrompt
- StaticLinkPrompt
- OpenUrl
- StaticTablePrompt
- TableColumn
- TableRow
- TableCell
- StaticMediaPrompt
- MediaObject
- MediaImage
- StaticListPrompt
- ListItem
- StaticCollectionPrompt
- CollectionItem
- 候補
- StaticCanvasPrompt
プロンプト候補のリストを表します。この候補のうち 1 つが、ユーザーへのレスポンスで表示されるプロンプトとして選択されます。このメッセージはローカライズ可能です。
JSON 表現 | |
---|---|
{
"candidates": [
{
object ( |
フィールド | |
---|---|
candidates[] |
クライアントに送信されるプロンプト候補のリスト。各プロンプトには、いつ使用できるかを決定するセレクタがあります。リクエストに一致した最初のセレクタが送信され、残りは無視されます。 |
StaticPromptCandidate
静的プロンプト候補を表します。
JSON 表現 | |
---|---|
{ "selector": { object ( |
フィールド | |
---|---|
selector |
(省略可)このプロンプトがリクエストと一致するかどうかの基準。セレクタが空の場合、このプロンプトは常にトリガーされます。 |
promptResponse |
セレクタに関連付けられているプロンプト レスポンス。 |
セレクタ
プロンプトがリクエストに一致するかどうかの基準を定義します。
JSON 表現 | |
---|---|
{
"surfaceCapabilities": {
object ( |
フィールド | |
---|---|
surfaceCapabilities |
必要なサーフェス機能のセット。 |
SurfaceCapabilities
ユーザーがアクションにリクエストを行うために使用しているサーフェスを表します。
JSON 表現 | |
---|---|
{
"capabilities": [
enum ( |
フィールド | |
---|---|
capabilities[] |
必須。アクションにリクエストを行うサーフェスの機能。 |
StaticPromptResponse
テキスト、音声、カード、キャンバス データ、候補ワードなど、ユーザーに送信する構造化されたレスポンスを表します。
JSON 表現 | |
---|---|
{ "firstSimple": { object ( |
フィールド | |
---|---|
firstSimple |
(省略可)最初の音声とテキストのみのレスポンス。 |
content |
(省略可)ユーザーに表示するカード、リスト、メディアなどのコンテンツ。 |
lastSimple |
(省略可)最後の音声とテキストのみのレスポンス。 |
suggestions[] |
(省略可)ユーザーに表示される候補。レスポンスの最後に常に表示されます。含まれるプロンプトの「append」フィールドが「true」の場合、このフィールドで定義されているタイトルは、以前に定義された候補プロンプトで定義されているタイトルに追加され、重複する値が削除されます。 |
link |
(省略可)関連するアプリまたはサイトにリンクできる追加の候補ワード。チップは「Open」というタイトルでレンダリングされます。 |
override |
(省略可)このメッセージを、以前に定義されたメッセージと統合する方法のモード。「true」は、以前に定義したすべてのメッセージ(最初と最後のシンプル、コンテンツ、候補のリンク、キャンバス)を消去し、このプロンプトで定義されたメッセージを追加します。「false」を指定すると、このプロンプトで定義されているメッセージが、以前のレスポンスで定義されているメッセージに追加されます。このフィールドを「false」に設定すると、Simple プロンプト内の一部のフィールド、Suggestions プロンプト、Canvas プロンプト(Content プロンプトの一部)への追加も可能になります。コンテンツ メッセージとリンク メッセージは、プロンプトで定義されている場合は常に上書きされます。デフォルト値は「false」です。 |
canvas |
インタラクティブなキャンバス エクスペリエンスに使用されるレスポンス。 |
StaticSimplePrompt
ユーザーに送信するシンプルなプロンプトを表します。
JSON 表現 | |
---|---|
{
"variants": [
{
object ( |
フィールド | |
---|---|
variants[] |
可能性のあるバリアントのリスト。 |
バリアント
単純なプロンプトの一部であるバリアントを表します。
JSON 表現 | |
---|---|
{ "speech": string, "text": string } |
フィールド | |
---|---|
speech |
(省略可)ユーザーに向けて読み上げられる音声を表します。SSML またはテキスト読み上げが可能です。含まれるプロンプトの「append」フィールドが「true」の場合、このフィールドで定義されている音声は、前の Simple プロンプトの音声に追加されます。 |
text |
(省略可)チャットのふきだしに表示するテキスト。指定しない場合、上記の音声フィールドの表示レンダリングが使用されます。最大 640 文字です。含まれるプロンプトの「append」フィールドが「true」であれば、このフィールドで定義されているテキストが、前の Simple プロンプトのテキストに付加されます。 |
StaticContentPrompt
StaticPrompt のコンテンツ部分のプレースホルダ。
JSON 表現 | |
---|---|
{ // Union field |
フィールド | ||
---|---|---|
共用体フィールド content 。プロンプトに含めることができるコンテンツは 1 種類のみです。content は次のいずれかになります。 |
||
card |
ベーシック カード。 |
|
image |
画像。 |
|
table |
テーブルカード。 |
|
media |
再生するメディアのセットを示すレスポンス。 |
|
list |
選択可能なオプションのリストを提示するカード。 |
|
collection |
選択可能なオプションのリストを示すカード。 |
StaticCardPrompt
画像やテキストなどの情報を表示するための基本的なカード。
JSON 表現 | |
---|---|
{ "title": string, "subtitle": string, "text": string, "image": { object ( |
フィールド | |
---|---|
title |
(省略可)カードの全体的なタイトル。 |
subtitle |
(省略可)カードのサブタイトル。 |
text |
必須。カードの本文。画像が存在しない場合に必要です。書式設定のために限定されたマークダウン構文をサポートします。 |
image |
(省略可)カードのヒーロー画像。高さは 192 dp に固定されています。 |
imageFill |
(省略可)画像の背景の塗りつぶし方法。 |
button |
(省略可)カードに表示されるクリック可能なボタン。 |
StaticImagePrompt
カードに表示される画像。
JSON 表現 | |
---|---|
{ "url": string, "alt": string, "height": integer, "width": integer } |
フィールド | |
---|---|
url |
必須。画像のソース URL。JPG、PNG、GIF(アニメーション GIF と非アニメーション GIF)を使用できます。例: |
alt |
必須。スクリーン リーダーなどのユーザー補助機能で使用する、画像の説明のテキスト。 |
height |
(省略可)画像の高さ(ピクセル単位)。 |
width |
(省略可)画像の幅(ピクセル単位)。 |
StaticLinkPrompt
候補ワードとして表示される、ユーザーが開くことができるリンクを定義します。
JSON 表現 | |
---|---|
{
"name": string,
"open": {
object ( |
フィールド | |
---|---|
name |
リンクの名前 |
open |
ユーザーがリンクを開いたときの動作を定義します。 |
OpenUrl
ユーザーがリンクを開いたときの動作を定義します。
JSON 表現 | |
---|---|
{
"url": string,
"hint": enum ( |
フィールド | |
---|---|
url |
url フィールドでは、次のいずれかを指定できます。- アプリとリンクしたアプリまたはウェブページを開くための http または https の URL |
hint |
URL タイプのヒントを示します。 |
StaticTablePrompt
テキストの表を表示するためのカード。
JSON 表現 | |
---|---|
{ "title": string, "subtitle": string, "image": { object ( |
フィールド | |
---|---|
title |
(省略可)テーブルの全体的なタイトル。サブタイトルが設定されている場合に設定する必要があります。 |
subtitle |
(省略可)テーブルのサブタイトル。 |
image |
(省略可)テーブルに関連付けられている画像。 |
columns[] |
(省略可)ヘッダーと列の配置。 |
rows[] |
(省略可)テーブルの行データ。最初の 3 行は表示されることが保証されますが、その他の行はサーフェスによっては切り捨てられる場合があります。特定のサーフェスに対してどの行が表示されるかをシミュレータでテストしてください。WEB_BROWSER 機能をサポートするサーフェスでは、詳細なデータを示すウェブページを開くことができます。 |
button |
(省略可)ボタン。 |
TableColumn
テーブル内の列を表します。
JSON 表現 | |
---|---|
{
"header": string,
"align": enum ( |
フィールド | |
---|---|
header |
列のヘッダー テキスト。 |
align |
列に対するコンテンツの水平方向の配置。省略した場合、内容は前端に揃えられます。 |
TableRow
表の行を記述します。
JSON 表現 | |
---|---|
{
"cells": [
{
object ( |
フィールド | |
---|---|
cells[] |
この行のセル。最初の 3 つのセルは表示されることが保証されますが、その他のセルはサーフェスによっては切り捨てられる場合があります。特定のサーフェスに対してどのセルが表示されるかをシミュレータでテストしてください。 |
divider |
各行の後に分割線を配置するかどうかを示します。 |
TableCell
行のセルを記述します。
JSON 表現 | |
---|---|
{ "text": string } |
フィールド | |
---|---|
text |
セルのテキスト コンテンツ。 |
StaticMediaPrompt
名前、説明、URL など、メディアに関する情報が含まれます。次の ID: 9
JSON 表現 | |
---|---|
{ "mediaType": enum ( |
フィールド | |
---|---|
mediaType |
このレスポンスのメディアタイプ。 |
startOffset |
最初のメディア オブジェクトの開始オフセット。 小数点以下 9 桁まで、「 |
optionalMediaControls[] |
このメディア レスポンス セッションがサポートするオプションのメディア コントロール タイプ。設定すると、特定のメディア イベントが発生したときにサードパーティにリクエストが送信されます。設定しない場合、3p は引き続き 2 つのデフォルトのコントロール タイプ(FINISHED と FAILED)を処理する必要があります。 |
mediaObjects[] |
メディア オブジェクトのリスト。 |
MediaObject
単一のメディア オブジェクトを表します。
JSON 表現 | |
---|---|
{
"name": string,
"description": string,
"url": string,
"image": {
object ( |
フィールド | |
---|---|
name |
このメディア オブジェクトの名前。 |
description |
このメディア オブジェクトの説明。 |
url |
メディア コンテンツを指す URL。 |
image |
メディアカードとともに表示する画像。 |
MediaImage
MediaPrompt 内に表示される画像。
JSON 表現 | |
---|---|
{ // Union field |
フィールド | ||
---|---|---|
共用体フィールド image 。使用できる MediaImage は 1 種類のみです。image は次のいずれかになります。 |
||
large |
アルバムのカバーなど、大きな画像 |
|
icon |
タイトルの右側に表示される小さな画像アイコン。36×36 dp にサイズ変更されます。 |
StaticListPrompt
選択可能なオプションのリストを提示するカード。
JSON 表現 | |
---|---|
{
"title": string,
"subtitle": string,
"items": [
{
object ( |
フィールド | |
---|---|
title |
(省略可)リストのタイトル。 |
subtitle |
(省略可)リストのサブタイトル。 |
items[] |
必須。リストアイテム。 |
ListItem
リスト内の項目。
JSON 表現 | |
---|---|
{
"key": string,
"title": string,
"description": string,
"image": {
object ( |
フィールド | |
---|---|
key |
必須。関連するタイプのエントリキー名と一致する NLU キー。アイテムがタップされると、このキーが選択オプション パラメータとしてポストバックされます。 |
title |
必須。商品アイテムのタイトル。タップすると、あたかもユーザーがこのテキストをキーボードから入力したかのように、このテキストが会話にそのままポストバックされます。各タイトルはアイテムのセットの中で一意である必要があります。 |
description |
(省略可)商品アイテムの本文。 |
image |
(省略可)項目の画像。 |
StaticCollectionPrompt
選択可能なオプションのコレクションを提示するカード。
JSON 表現 | |
---|---|
{ "title": string, "subtitle": string, "items": [ { object ( |
フィールド | |
---|---|
title |
(省略可)コレクションのタイトル。 |
subtitle |
(省略可)コレクションのサブタイトル。 |
items[] |
必須。コレクション アイテム。 |
imageFill |
(省略可)画像表示オプションのタイプ。 |
CollectionItem
コレクション内のアイテム。
JSON 表現 | |
---|---|
{
"key": string,
"title": string,
"description": string,
"image": {
object ( |
フィールド | |
---|---|
key |
必須。関連するタイプのエントリキー名と一致する NLU キー。アイテムがタップされると、このキーが選択オプション パラメータとしてポストバックされます。 |
title |
必須。商品アイテムのタイトル。タップすると、あたかもユーザーがこのテキストをキーボードから入力したかのように、このテキストが会話にそのままポストバックされます。各タイトルはアイテムのセットの中で一意である必要があります。 |
description |
(省略可)商品アイテムの本文。 |
image |
(省略可)項目の画像。 |
アドバイス
サジェスチョン チップ(利便性のためにユーザーに表示される UI 要素)を表します。
JSON 表現 | |
---|---|
{ "title": string } |
フィールド | |
---|---|
title |
必須。候補ワードに表示されるテキスト。タップすると、あたかもユーザーがこのテキストをキーボードから入力したかのように、このテキストが会話にそのままポストバックされます。一連の候補ワードの間でタイトルが重複していてはなりません。最大 25 文字 |
StaticCanvasPrompt
ユーザーに送信するインタラクティブ キャンバスのレスポンスを表します。これは、インタラクティブなキャンバス レスポンスを表示するだけでなく、ユーザーに音声で伝えるプロンプトで「firstSimple」フィールドと組み合わせて使用することもできます。
JSON 表現 | |
---|---|
{ "url": string, "data": [ value ], "suppressMic": boolean } |
フィールド | |
---|---|
url |
必須。読み込むウェブビューの URL。 |
data[] |
(省略可)没入型エクスペリエンスのウェブページにイベントとして渡される JSON データ。含まれているプロンプトの「override」フィールドが「false」であれば、この Canvas プロンプトで定義されているデータ値は、以前の Canvas プロンプトで定義したデータ値の後に追加されます。 |
suppressMic |
(省略可)値を true に設定した場合、この没入感のある応答がユーザーに表示された後、入力をキャプチャするためにマイクが開かれません。 |