アダプティブ ダイアログのアクション - リファレンス ガイド

  • [アーティクル]

適用対象: SDK v4

この記事では、Bot Framework SDK で定義されているアクションを、その汎用別にグループ化して一覧表示します。

  • このトピックの概要については、Composer のドキュメントの 「アクション」 トピックを参照してください。

回答と質問

アクション名 アクション のタイトル 説明
Ask 回答を送信して質問する ユーザーにプロンプトを表示する方法としてアクティビティを使用します。
AttachmentInput ファイルまたは添付ファイルの入力を求めるメッセージ ユーザーにファイルまたは画像を要求します。
ChoiceInput 複数選択でプロンプトを表示する ユーザーに選択肢の一覧から選択するように求めます。
ConfirmInput 確認を求めるメッセージ ユーザーに確認を求めます (はい-いいえの質問)。
DateTimeInput 日付または時刻の入力を求める 日付または時刻の値をユーザーに求めます。
NumberInput 数値の入力を求める ユーザーに数値の入力を求めます。
OAuthInput OAuth ログイン OAuth ID プロバイダーを使用してサインインするようにユーザーに求めます。
SendActivity 応答を送信する ユーザーへの応答などのアクティビティを送信します。
TextInput テキストのプロンプト ユーザーに応答の入力を求めます。

条件とループ

条件付きアクションは、作成した定義済みの条件に基づいてボットが意思決定を行えるように設計されています。 これらのアクションは、ブール式を持つ一連の条件ステートメントによって指定され、ブール値が true または false に評価されます。

残りのアクションは、コレクション内のすべての要素に対してコード ブロックの実行を繰り返すことができるループ ステートメントに関連しています。

アクション名 アクション のタイトル 説明
BreakLoop ループから抜け出す 外側のループを終了します。
ContinueLoop Continue ループ 外側のループの次の反復を開始します。
ForEach ループ: 項目ごとに コレクション内の各項目に対して一連のアクションを実行します。
ForEachPage ループ: ページごとに (複数の項目) コレクション内の各ページ (項目のサブセット) に対して一連のアクションを実行します。
IfCondition ブランチ: If/else ブール式に基づいて一連のアクションを実行します。
SwitchCondition 分岐: スイッチ (複数のオプション) プロパティの値に基づいて一連のアクションを実行します。

ダイアログ管理

アクション名 アクション のタイトル 説明
BeginDialog 新しいダイアログを開始する 新しいダイアログを開始し、スタックに追加します。 新しいダイアログの入力パラメーターを指定できます。 新しいダイアログが終了すると、コントロールはこのトリガーの次のステップに戻ります。
CancelAllDialogs すべてのアクティブなダイアログを取り消す アクティブなすべてのダイアログを取り消します。 必要に応じて、取り消しが反映されないようにキャッチできるカスタム イベントを送信します。
CancelDialog [キャンセル] ダイアログ アクティブなダイアログを取り消します。 必要に応じて、取り消しを防ぐためにキャッチできるカスタム イベントを送信します。
ContinueConversation 会話を続ける プロアクティブ メッセージを送信します。 ストレージ キューが構成されたボットが必要です。
ContinueConversationLater 後で会話を続ける 遅延後に送信されるプロアクティブ メッセージをキューに入れます。 ストレージ キューを構成するには、ボットが必要です。
EndDialog このダイアログを終了する 現在のダイアログを終了し、オプションの結果を返します。
EndTurn 終了ターン ダイアログを明示的に終了せずに、現在のターンを終了します。
GetConversationReference 会話参照を取得する 現在の会話参照をメモリに保存します。 会話の続行アクションで使用する場合。
GotoAction アクションに移動する 現在のトリガー内の別のアクションに移動します。
RepeatDialog このダイアログを繰り返す 現在のダイアログを再起動します。 ダイアログの入力パラメーターを指定できます。
ReplaceDialog このダイアログを置換する 現在のダイアログを新しいダイアログに置き換えます。 新しいダイアログの入力パラメーターを指定できます。

プロパティの管理

アクション名 アクション のタイトル 説明
DeleteActivity アクティビティを削除する 以前にユーザーに送信されたアクティビティを削除します。
DeleteProperties プロパティを削除する 複数のプロパティを一度に削除します。
DeleteProperty プロパティを削除する メモリからプロパティを削除します。
EditArray 配列プロパティを編集する 配列に対して操作を実行します。
GetActivityMembers アクティビティのメンバーを取得する アクティビティに参加しているメンバーを取得します。 BotFrameworkAdapter コネクタでのみサポートされます。
GetConversationMembers 会話のメンバーを取得する 会話に参加しているメンバーを取得します。 BotFrameworkAdapter コネクタでのみサポートされます。
SetProperties プロパティの設定 複数のプロパティの値を一度に設定します。
SetProperty プロパティを設定する メモリ内のプロパティの値を設定します。
UpdateActivity アクティビティを更新する 以前にユーザーに送信されたアクティビティを更新します。

外部リソースにアクセスする

注意

Azure AI QnA Maker は、2025 年 3 月 31 日に廃止される予定です。 2022 年 10 月 1 日から、新しい QnA Maker リソースやナレッジ ベースを作成することはできません。 Azure AI Language の一部として、新しいバージョンの質問と回答機能が利用できるようになりました。

Azure AI Language の機能であるカスタム質問応答は、QnA Maker サービスの更新バージョンです。 Bot Framework SDK での質問と回答のサポートの詳細については、「 自然言語の理解」を参照してください。

アクション名 アクション タイトル 説明
BeginSkill スキルへの接続 スキルを開始し、スキルが終了するまでアクティビティをスキルに転送します。
EmitEvent カスタム イベントを生成する カスタム イベントを発生させます。 ダイアログがイベントに反応できるようにするには、ダイアログにカスタム イベント トリガーを追加します。
HttpRequest HTTP 要求を送信する エンドポイントに対して HTTP 要求を行います。
OAuthInput OAuth ログイン OAuth ID プロバイダーを使用してサインインするようにユーザーに求めます。
QnAMakerDialog QnAMaker ダイアログ QnA Maker サポート情報を使用して、ユーザーの質問に回答します。
SendHandoffActivity ハンドオフ要求を送信する 非推奨になりました。 このアクションは使用しないでください。
SignOutUser ユーザーをサインアウトする OAuth ID プロバイダーからユーザーをサインアウトします。

デバッグ オプション

アクション名 アクション タイトル 説明
LogAction コンソールにログを記録する コンソールに書き込み、必要に応じて、メッセージをトレース アクティビティとして送信します。
TelemetryTrackEventAction テレメトリ - イベントの追跡 登録済みのテレメトリ クライアントを使用して、カスタム イベントを追跡します。
ThrowException 例外をスローする 例外をスローします。 ダイアログで例外をキャッチできるようにするには、エラーが発生したトリガーをダイアログに追加します。
TraceActivity トレース イベントを生成する トレース アクティビティを送信します。

追加情報