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 に設定すると、シンプル プロンプト、候補のプロンプト、描画キャンバス プロンプト（コンテンツ プロンプトの一部）内の一部のフィールドへの追加も有効になります。メッセージとリンク メッセージがプロンプトで定義されている場合、常に上書きされます。デフォルト値は false です。
canvas

object (StaticCanvasPrompt)

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

StaticSimplePrompt

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

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

object (Variant)

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

パターン

シンプル プロンプトの一部であるバリアントを表します。

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

string

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

string

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

StaticContentPrompt

StaticPrompt の Content 部分のプレースホルダ。

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)

このメディア レスポンス セッションがサポートするオプションのメディア コントロール タイプ。設定すると、特定のメディア イベントが発生したときにサードパーティにリクエストが行われます。このポリシーを設定しない場合でも、サードパーティは 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

ユーザーに送信される Interactive Canvas のレスポンスを表します。キャンバスのインタラクティブなレスポンスを表示するだけでなく、含まれるプロンプトの 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