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

プロンプト候補のリストを表します。この候補のうち 1 つが、ユーザーへのレスポンスで表示されるプロンプトとして選択されます。このメッセージはローカライズ可能です。

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 に設定すると、Simple プロンプト内の一部のフィールド、Suggestions プロンプト、Canvas プロンプト(Content プロンプトの一部)への追加も可能になります。コンテンツ メッセージとリンク メッセージは、プロンプトで定義されている場合は常に上書きされます。デフォルト値は false です。

canvas

object (StaticCanvasPrompt)

インタラクティブなキャンバス エクスペリエンスに使用されるレスポンス。

StaticSimplePrompt

ユーザーに送信するシンプルなプロンプトを表します。

YAML 表現
variants: 
  - object (Variant)
フィールド
variants[]

object (Variant)

可能性のあるバリアントのリスト。

バリアント

単純なプロンプトの一部であるバリアントを表します。

YAML 表現
speech: string
text: string
フィールド
speech

string

(省略可)ユーザーに向けて読み上げられる音声を表します。SSML またはテキスト読み上げが可能です。デフォルトでは、音声は前のシンプルなプロンプトの音声に追加されます。含まれるプロンプトの override フィールドが true の場合、このフィールドで定義された音声が、以前の Simple プロンプトの音声をオーバーライドします。

text

string

(省略可)チャットのふきだしに表示するテキスト。指定しない場合、上記の音声フィールドの表示レンダリングが使用されます。最大 640 文字です。デフォルトでは、テキストは前のシンプルなプロンプトのテキストに付加されます。含まれるプロンプトの override フィールドが true の場合、このフィールドで定義されたテキストが以前の Simple プロンプトのテキストをオーバーライドします。

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。プロンプトに含めることができるコンテンツは 1 種類のみです。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

必須。カードの本文。画像が存在しない場合に必要です。書式設定のために限定されたマークダウン構文をサポートします。

image

object (StaticImagePrompt)

(省略可)カードのヒーロー画像。高さは 192 dp に固定されています。

imageFill

enum (ImageFill)

(省略可)画像の背景の塗りつぶし方法。

button

object (StaticLinkPrompt)

(省略可)カードに表示されるクリック可能なボタン。

StaticImagePrompt

カードに表示される画像。

YAML 表現
url: string
alt: string
height: integer
width: integer
フィールド
url

string

必須。画像のソース URL。JPG、PNG、GIF(アニメーション GIF と非アニメーション 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

url フィールドでは、次のいずれかを指定できます。- アプリとリンクしたアプリまたはウェブページを開くための http または https の URL

hint

enum (UrlHint)

URL タイプのヒントを示します。

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

名前、説明、URL などのメディアに関する情報が含まれます。次の ID: 11

YAML 表現
mediaType: enum (MediaType)
startOffset: string
optionalMediaControls: 
  - enum (OptionalMediaControls)
mediaObjects: 
  - object (MediaObject)
repeatMode: enum (RepeatMode)
フィールド
mediaType

enum (MediaType)

このレスポンスのメディアタイプ。

startOffset

string (Duration format)

最初のメディア オブジェクトの開始オフセット。

小数点以下 9 桁まで、「s」で終わる秒単位の期間(例: "3.5s")。

optionalMediaControls[]

enum (OptionalMediaControls)

このメディア レスポンス セッションがサポートするオプションのメディア コントロール タイプ。設定すると、特定のメディア イベントが発生したときにサードパーティにリクエストが送信されます。設定しない場合、3p は引き続き 2 つのデフォルトのコントロール タイプ(FINISHED と FAILED)を処理する必要があります。

mediaObjects[]

object (MediaObject)

メディア オブジェクトのリスト。

repeatMode

enum (RepeatMode)

メディア オブジェクト リストの繰り返しモード。

MediaObject

単一のメディア オブジェクトを表します。

YAML 表現
name: string
description: string
url: string
image: 
  object (MediaImage)
フィールド
name

string

このメディア オブジェクトの名前。

description

string

このメディア オブジェクトの説明。

url

string

メディア コンテンツを指す URL。

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 は 1 種類のみです。image は次のいずれかになります。
large

object (StaticImagePrompt)

アルバムのカバーなど、大きな画像

icon

object (StaticImagePrompt)

タイトルの右側に表示される小さな画像アイコン。36×36 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

必須。関連するタイプのエントリキー名と一致する 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

説明の下に表示されるコレクション アイテムのフッター テキスト。1 行のテキスト(省略記号で切り捨てられます)。

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

必須。読み込むウェブビューの URL。

data[]

value (Value format)

(省略可)没入型エクスペリエンスのウェブページにイベントとして渡される JSON データ。含まれているプロンプトの override フィールドが false の場合、この Canvas プロンプトで定義されているデータ値は、以前の Canvas プロンプトで定義したデータ値の後に追加されます。

suppressMic

boolean

(省略可)値を true に設定した場合、この没入感のある応答がユーザーに表示された後、入力をキャプチャするためにマイクが開かれません。

sendStateDataToCanvasApp

boolean

(省略可)true の場合、会話関連のメタデータが含まれ、キャンバス アプリケーションに返されます。

enableFullScreen

boolean

(省略可)true の場合、キャンバス アプリケーションが全画面表示され、上部にヘッダーは表示されません。読み込み画面にトースト メッセージも表示され、アクションの表示名、デベロッパーの名前、アクションの終了手順などを確認できます。デフォルト値: false

continueTtsDuringTouch

boolean

(省略可)true の場合、画面をタップしてもキャンバス セッション全体で TTS は停止されません。デフォルト値: false