アダプティブダイアログのアクション-リファレンスガイドActions in adaptive dialogs - reference guide

適用対象: SDK v4APPLIES TO: SDK v4

この記事では、Bot Framework SDK で定義されているアクションを、一般的な目的別にまとめて示します。This article lists the actions defined in the Bot Framework SDK, grouped by their general purpose.

  • このトピックの概要については、Composer のドキュメントの「 Actions (アクション )」を参照してください。For an introduction to this topic, see the Actions topic in the Composer documentation.

アクティビティActivities

実行するアクティビティActivity to accomplish アクション名Action Name このアクションで実行することWhat this action does
ユーザーへの応答などのアクティビティを送信します。Send any activity such as responding to a user. SendActivity ユーザーへの応答などのアクティビティを送信します。Sends an activity, such as a response to a user.
アクティビティを更新するUpdate an activity UpdateActivity 送信されたアクティビティを更新します。Updates an activity that was sent.
DeleteActivityDeleteActivity DeleteActivity 送信されたアクティビティを削除します。Deletes an activity that was sent.
アクティビティのメンバーを取得するGet activity members GetActivityMembers アクティビティメンバーの一覧を取得し、メモリ内のプロパティに保存します。Gets a list of activity members and saves it to a property in memory.

条件付きステートメントConditional statements

最初の 2 つのアクションは、作成した定義済みの条件に基づいて、ボットが決断を下すのに役立つように設計された条件付きステートメントです。The first two actions are conditional statements designed to help your bot make decisions based on any pre-defined condition that you have created. これらの条件は、true または false のブール値に評価されるブール式を使用する一連の条件付きステートメントによって指定します。These conditions are specified by a set of conditional statements having boolean expressions which are evaluated to a boolean value of true or false.

残りのアクションは、コレクション内のすべての要素に対してコード ブロックの実行を繰り返すことができるループ ステートメントに関連しています。The remaining actions relate to looping statements which enable you to repeat the execution of a block of code for every element in a collection.

実行するアクティビティActivity to accomplish アクション名Action Name このアクションで実行することWhat this action does
分岐: if/elseBranch: if/else IfCondition ブール式に基づいて一連のアクションを実行します。Runs a set of actions based on a Boolean expression.
分岐:Switch (複数のオプション)Branch: Switch (Multiple options) SwitchCondition パターン一致に基づいて一連のアクションを実行します。Runs a set of actions based on a pattern match.
ループ: 項目ごとLoop: for each item ForEach 配列に格納されている値のセットをループします。Loops through a set of values stored in an array.
ループ: ページごと (複数の項目)Loop: for each page (multiple items) ForEachPage 配列に格納されている大きな値のセットを、一度に1ページずつループします。Loops through a large set of values stored in an array, one page at a time.
ループを終了するExit a loop BreakLoop 外側のループを終了します。Exits the enclosing loop.
ループを続行するContinue a loop ContinueLoop 外側のループの次の反復処理を開始します。Starts the next iteration of the enclosing loop.
別のアクションに移動するGoto a different Action GotoAction アクションの ID で識別される、指定されたアクションに制御を転送します。Transfers control to the specified action, identified by the action's ID.

ダイアログ管理Dialog management

実行するアクティビティActivity to accomplish アクション名Action Name このアクションで実行することWhat this action does
新しいダイアログを開始するBegin a new dialog BeginDialog 別のダイアログの実行を開始します。Begins executing another dialog. そのダイアログが終了すると、現在のトリガーの実行が再開されます。When that dialog finishes, the execution of the current trigger will resume.
ダイアログを取り消すCancel a dialog CancelDialog アクティブなダイアログを取り消します。Cancels the active dialog. ダイアログをすぐに閉じるときに (それが処理中の停止を意味する場合でも) 使用します。Use when you want the dialog to close immediately, even if that means stopping mid-process.
すべてのダイアログを取り消すCancel all dialogs CancelAllDialogs アクティブな親ダイアログを含むすべてのアクティブなダイアログを取り消します。Cancels all active dialogs including any active parent dialogs. スタックからすべてのダイアログを取り出す場合にこれを使用し、ダイアログ コンテキストの cancel all dialogs メソッドを呼び出すことで、ダイアログ スタックをクリアできます。Use this if you want to pop all dialogs off the stack, you can clear the dialog stack by calling the dialog context's cancel all dialogs method. CancelAllDialogs イベントが生成されます。Emits the CancelAllDialogs event.
このダイアログを終了するEnd this dialog EndDialog アクティブなダイアログを終了します。Ends the active dialog. ダイアログを完了し、終了する前に結果を返す場合に使用します。Use when you want the dialog to complete and return results before ending. EndDialog イベントが生成されます。Emits the EndDialog event.
ダイアログのターンを終了するEnd dialog turn EndTurn ダイアログを終了せずに、会話の現在のターンを終了します。Ends the current turn of conversation without ending the dialog.
このダイアログを繰り返すRepeat this dialog RepeatDialog 親ダイアログを再起動するために使用します。Used to restart the parent dialog.
このダイアログを置換するReplace this dialog ReplaceDialog 現在のダイアログを新しいダイアログに置き換えます。Replaces the current dialog with a new dialog.
GetConversationMembersGetConversationMembers GetConversationMembers 会話のメンバーの一覧を取得し、それをメモリ内のプロパティに保存できます。Enables you to get a list of the conversation members and save it to a property in memory.
EditActionsEditActions EditActions ユーザー入力に基づいて、現在のアクション シーケンスをすぐに編集できます。Enables you to edit the current action sequence on the fly based on user input. 中断を処理する場合に特に便利です。Especially useful when handling interruptions.

プロパティの管理Manage properties

実行するアクティビティActivity to accomplish アクション名Action Name このアクションで実行することWhat this action does
配列を編集するEdit an array EditArray 配列に対して操作を実行します。Performs an operation on an array.
プロパティを削除するDelete a property DeleteProperty メモリからプロパティを削除します。Removes a property from memory.
プロパティを削除するDelete properties DeleteProperties 一度に複数のプロパティを削除します。Removes multiple properties at once.
プロパティを作成または更新するCreate or update a property SetProperty メモリ内のプロパティの値を設定します。Sets a property's value in memory.
プロパティを作成または更新するCreate or update properties SetProperties 複数のプロパティの値を一度に設定します。Sets the value of multiple properties at once.

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

実行するアクティビティActivity to accomplish アクション名Action Name このアクションで実行することWhat this action does
スキル ダイアログを開始するBegin a skill dialog BeginSkill スキルを開始し、スキルが終了するまでアクティビティをスキルに転送します。Begins a skill and forwards activities to the skill until the skill ends.
HTTP 要求を送信するSend an HTTP request HttpRequest エンドポイントに対して HTTP 要求を行います。Makes an HTTP request to an endpoint.
カスタム イベントを生成するEmit a custom event EmitEvent カスタム イベントを発生します。Raises a custom event. イベントに対応するカスタム トリガーをアダプティブ ダイアログに追加します。Add a custom trigger to the adaptive dialog to react to the event.
ユーザーのサインアウトSign out a user SignOutUser 現在サインインしているユーザーをサインアウトします。Signs out the currently signed in user.
カスタム コードを呼び出すCall custom code CodeAction カスタム コードを呼び出します。Calls custom code. カスタム コードは非同期で、ダイアログ コンテキストとオブジェクトをパラメーターとして受け取り、ダイアログ ターンの結果を返す必要があります。The custom code must be asynchronous, take a dialog context and an object as parameters, and return a dialog turn result.

デバッグ オプションDebugging options

実行するアクティビティActivity to accomplish アクション名Action Name このアクションで実行することWhat this action does
コンソールにログを記録するLog to console LogAction コンソールに書き込み、必要に応じて、メッセージをトレース アクティビティとして送信します。Writes to the console and optionally sends the message as a trace activity.
トレース イベントを生成するEmit a trace event TraceActivity 指定した任意のペイロードで、トレース アクティビティを送信します。Sends a trace activity with whatever payload you specify.

追加情報Additional Information