botbuilder-calling package

クラス

AnswerAction	アクション ビルダー クラスは、回答アクションの構築を簡略化するように設計されています。
CallConnector	UniversalCallBot を Skype 通話サービスに接続します。
CallSession	ユーザーとのボットの会話を管理します。
Dialog	すべてのダイアログの基本クラス。 ダイアログは BotBuilder フレームワークのコア コンポーネントです。 ボットはダイアログを使用して、ユーザーとの任意の複雑な会話を管理します。
DialogAction	ダイアログ アクションには、一般的なアクションを実装するためのショートカットが用意されています。
HangupAction	ハングアップ アクションの構築を簡略化するように設計されたアクション ビルダー クラス。
Library	ルーティング目的で使用される関連ダイアログのライブラリ。 ライブラリを連結して、複雑なボットの開発を可能にすることができます。 UniversalCallBot クラス自体は、このチェーンのルートを形成するライブラリです。 再利用可能なパーツのライブラリは、ボットと同様に新しいライブラリ インスタンスを作成し、ダイアログを追加することで開発できます。 ライブラリには、ライブラリ Web サイトまたは NPM モジュール名に対応する一意の名前が必要です。 その後、UniversalCallBot.library()を使用して、パーツ ライブラリ インスタンス ボットに追加するだけで、ボットでライブラリを再利用できます。 ライブラリ自体が他のライブラリに依存している場合は、Library.library()を使用して、ライブラリに依存関係として追加する必要があります。 ライブラリ名にバージョン番号を追加することで、ライブラリの複数のバージョンを簡単に管理できます。 ライブラリ ボット内でダイアログを呼び出すには、session.beginDialog() を ':' の形式で完全修飾ダイアログ ID で呼び出す必要があります。 通常は、ダイアログを開始するモジュールから関数を公開することで、devloper からこれを非表示にします。 したがって、myLib.someDialog(session, { arg: '' }); のようなものを呼び出すと、内部で session.beginDialog('myLib:someDialog', args); を呼び出すことになります。 ダイアログは常に現在のダイアログ内で呼び出されるため、ライブラリからのダイアログ内で、すべての beginDialog() がライブラリ名で呼び出す前にプレフィックスを付ける必要はありません。 ライブラリ名プレフィックスを含める必要があるのは、あるライブラリ コンテキストから別のライブラリ コンテキストに交差する場合のみです。
MemoryBotStorage	ユーザー & セッション状態データを格納するためのメモリ ストレージ実装の既定値。
PlayPromptAction	playPrompt アクション構築を簡略化するように設計されたアクション ビルダー クラス。
Prompt	playPrompt アクションのプロンプトの作成を簡略化する Prompt Builder クラス。
Prompts	任意のダイアログから呼び出すことができる組み込みのプロンプトが組み込まれています。
RecognizeAction	アクションを認識 構築を簡略化するように設計されたアクション ビルダー クラス。
RecordAction	アクションを記録 簡単に作成できるように設計されたアクション ビルダー クラス。
RejectAction	アクションを拒否 構築を簡略化するように設計されたアクション ビルダー クラス。
SimpleDialog	単純なクロージャに基づくカスタム ダイアログを作成できます。 これは、動的な会話フローが必要な場合や、ウォーターフォールの使用にあまり適していない状況がある場合に便利です。 留意すべき点は次のとおりです。 ダイアログ クロージャは、テストが必要になる可能性がある 2 つの異なるコンテキストで呼び出すことができます。 ユーザーがダイアログにメッセージを送信すると、予期したとおりに呼び出されますが、クロージャから別のプロンプトまたはダイアログを呼び出すと、プロンプト/ダイアログの結果で 2 回目に呼び出されます。 通常、この 2 番目のケースをテストするには、args.resumed プロパティの存在を確認します。 簡単にできる無限ループに身を乗り出さないようにすることが重要です。 ウォーターフォールとは異なり、ダイアログは自動的に終了しません。 session.endDialog()を呼び出すまで、アクティブなダイアログ 残ります。
UniversalCallBot	複数のチャネルにわたるユーザーとのボットの会話を管理します。

インターフェイス

IAction	すべてのアクションの基本クラス。
IActionOutcome	すべてのアクション結果の基本クラス。
IAddress	メッセージのアドレス ルーティング情報。 アドレスは双方向です。つまり、受信メッセージと送信メッセージの両方にアドレスを指定するために使用できます。 また、コネクタ固有の意味で、コネクタ は自由に独自のフィールドを追加できます。
IAnswerAction	応答アクションを使用すると、ボットは Skype 通話を受け入れます。 応答アクションは、会話通知に応答する最初のアクションである必要があります。
IAnswerOutcome	応答アクションの結果。
IBotStorage	UniversalCallBot によって使用される再レース可能なストレージ システム。
IBotStorageContext	IBotStorage 呼び出しに渡されるコンテキスト オブジェクト。
IBotStorageData	IBotStorage に保持されるデータ値。
ICallConnector	UniversalCallBot のコネクタ プラグインによって実装されます。
ICallConnectorAddress	チャット コネクタ固有のアドレス。
ICallConnectorSettings	ChatConnector インスタンスの初期化に使用するオプション。
ICallSessionMiddleware	'botbuilder' イベントをフックするミドルウェアの一部の関数シグネチャ。
ICallSessionOptions	セッションのコンストラクターに渡されるオプション。
IChoiceOutcome	選択肢の認識が選択されたときに返されます。
ICollectDigits	桁コレクションのオプションを指定します。 たとえば、「5 桁の郵便番号を入力し、その後にポンド記号を入力します」とします。
ICollectDigitsOutcome	ディジット コレクションが選択されている場合に返されます。
IConfirmPromptOptions	"確認" プロンプトに渡されるオプション。
IConversation	IConversation は、ボットを呼び出すための Skype Bot Platform によって行われた新しい Skype 音声通話の最初の要求の JSON 本文です。 IConversation JSON 本文は、Bot Framework ポータルでボット開発者によって登録された初期 HTTPs エンドポイントに投稿されます。 IConversation 要求には、呼び出しの呼び出し元とターゲットに関する情報と、呼び出しの初期状態に関する追加情報が含まれます。
IConversationResult	IConversationResult は、Skype Bot Platform for Calling からボットに送信される最初の IConversation 通知に続く後続の要求の JSON 本文です。 IConversationResult は、前のワークフロー応答によって提供されたコールバック リンクにポストされます。 IConversationResult は、前のワークフロー応答からの最後に成功したアクションの結果を表します。
IDialogResult	session.endDialog() の呼び出しによって子ダイアログによって親に返される結果。
IDialogState	セッション ダイアログ スタック上のエントリ。
IDialogWaterfallStep	DialogAction.waterfall()を するためのステップとして渡される関数のシグネチャ。 ウォーターフォールを使用すると、一連の質問を使用してユーザーに情報の入力を求められます。 ウォーターフォールの各ステップでは、組み込みの プロンプトのいずれかを実行するか、session.beginDialog()を呼び出して新しいダイアログを開始するか、skip()を使用してウォーターフォールの次のステップに進むか、ウォーターフォールを終了します。 ダイアログまたは組み込みのプロンプトがウォーターフォール ステップから呼び出されると、そのダイアログまたはプロンプトの結果は、results パラメーターを介してウォーターフォールの次のステップに渡されます。 ユーザーは、組み込みのプロンプトを取り消すために "nevermind" のようなことを言うことができるので、少なくとも results.response を確認してから続行する必要があります。 ウォーターフォールが継続される理由のより詳細な説明は、の結果に対して返される コード 調べることによって決定できます。再開された。 渡された skip() 関数を使用して、ウォーターフォールの次のステップに手動で進めることができます。 skip({ response: "some text" }) を使用して を呼び出すと、組み込みのプロンプトからの結果をより正確に模倣でき、ウォーターフォール ロジック全体を簡略化できます。 ウォーターフォールは、skip() の呼び出しを使用してウォーターフォールのすべてのステップを通過するか、単に別のプロンプトまたはダイアログを開始しないことで、早期に終了できます。 注意: ウォーターフォールには非表示の最後のステップがあり、最後のステップからプロンプトまたはダイアログを呼び出すと、現在のダイアログが自動的に終了します。 これは、ダイアログの深いスタックがあり、スタックの最後の子から session.endDialog() を 呼び出してスタック全体を終了する場合に便利です。 最後の子が閉じると、すべての親がこの隠されたステップに移動し、スタックの上まで閉じるのが連鎖します。 これは通常は望ましい動作ですが、それを回避したり、途中で停止したりする場合は、ウォーターフォールの末尾にステップを追加する必要があります。ウォーターフォールの末尾には、何も行わないか、ウォーターフォールを進めない session.send() のようなものを呼び出す必要があります。
IDigitsPromptOptions	'digits' プロンプトに渡されるオプション。
IErrorEvent	エラー イベント ハンドラーの関数シグネチャ。
IEvent	ソースから受信またはソースに送信されるイベント。
IEventMiddleware	'receive' または 'send' イベントをフックするミドルウェアの一部の関数シグネチャ。
IFindMatchResult	EntityRecognizer.findBestMatch() または EntityRecognizer.findAllMatches() の呼び出しから返される結果。
IHangupAction	切断すると、ボットが継続的な呼び出しを終了できます。 ハングアップは、ワークフローの最後のアクションです。 ハングアップと拒否の違いにご注意ください。 拒否アクションを使用すると、ハングアップが進行中の呼び出しを終了している間、ボットは通話に応答する代わりに通話を終了できます。
IHangupOutcome	ハングアップの結果を返します。
IIdentity	ユーザー、ボット、または会話を表します。
IIsAction	アクションに変換できるクラスによって実装されます。
IIsEvent	イベントに変換できるクラスによって実装されます。
IIsPrompt	プロンプトに変換できるクラスによって実装されます。
ILocalizer	ボットによってユーザーに送信されたメッセージをローカライズするためのプラグイン。
IMiddlewareMap	UniversalCallBot.use()の呼び出しに登録できるミドルウェア フックのマップ。
IPlayPromptAction	PlayPrompt では、テキストTo-Speech オーディオまたはメディア ファイルを再生できます。
IPlayPromptOutcome	再生プロンプトの結果は、プロンプトを再生した結果を返します。
IPrompt	PlayPrompt アクションの一部として再生されたプロンプト。
IPromptActionResult	厳密に型指定されたアクション プロンプトの結果。
IPromptChoiceResult	厳密に型指定された選択肢プロンプトの結果。
IPromptConfirmResult	厳密に型指定された確認プロンプトの結果。
IPromptDigitsResult	厳密に型指定された数字プロンプトの結果。
IPromptOptions	組み込みのプロンプトに渡されるオプション。
IPromptRecordResult	厳密に型指定されたレコード プロンプトの結果。
IPromptResult	システム プロンプトによって返されるダイアログの結果。
IPromptsSettings	[プロンプト] ダイアログのグローバル構成オプション。
IRecognitionChoice	選択に基づく認識の音声 & DTMF オプションを指定します。 たとえば、"Sales" と言うか、営業部門の 1 を押します。
IRecognizeAction	Recognize アクションを使用すると、音声認識出力をキャプチャするか、Skype ユーザー ダイヤル パッドから数字を収集できます。
IRecognizeOutcome	結果を認識することは、認識アクションの結果です。 認識された数字または認識された音声が含まれます。
IRecognizerPromptOptions	認識エンジン ベースのプロンプトに渡されるオプション。
IRecordAction	レコード アクションは、Skype ユーザーのオーディオが記録される対話型アクションです。
IRecordOutcome	レコードの結果は、録音オーディオ アクションの結果を返します。 RecordOutcome はマルチパート コンテンツとして返され、マルチパートの最初の部分にはアクションの結果が含まれますが、2 番目の部分には録音されたオーディオを表すバイナリ ストリームが含まれます。 audo ストリームは、IConversationResult.recordedAudio プロパティを介して使用できます。
IRecordPromptOptions	"レコード" プロンプトに渡されるオプション。
IRecording	組み込みのレコード プロンプトから返される記録。
IRejectAction	拒否すると、通話への応答を拒否できます。 拒否アクションは、Answer ではなく最初のワークフローの最初のアクションとして使用できます。
IRejectOutcome	拒否アクションの結果。 ボットが通話に応答しないことをボットが判断した場合は、応答アクションの代わりに拒否を使用できます。
ISessionState	会話ダイアログ スタックを追跡するために使用される永続化されたセッション状態。
IUniversalCallBotSettings	UniversalCallBot インスタンスを初期化するために使用されるオプション。
IWorkflow	IWorkflow は、Skype Bot Platform for Calling からの IConversation または IConversationResult 要求に応答してボットによって送信される JSON 本文です。 IWorkflow には、最後に実行されたアクションの結果についてボットに通知を受け取りたい場合に、ボットが Skype Bot Platform for Calling on execute に代わって実行するよう指示する 1 つ以上のアクションの一覧と、コールバック HTTPs アドレスが含まれています。

列挙型

PromptType	呼び出されたプロンプトの種類。
ResumeReason	ダイアログが再開された理由コード。