共用方式為


botbuilder-calling package

類別

AnswerAction

動作產生器類別,旨在簡化建置 回應動作

CallConnector

將 UniversalCallBot 連線到 Skype 通話服務。

CallSession

管理與使用者的 Bot 交談。

Dialog

所有對話框的基類。 對話框是 BotBuilder 架構的核心元件。 Bot 會使用對話框來管理與使用者任意複雜的交談。

DialogAction

對話框動作提供實作一般動作的快捷方式。

HangupAction

動作產生器類別,旨在簡化建置 掛斷動作

Library

用於路由之相關對話的連結庫。 連結庫可以鏈結在一起,以啟用複雜 Bot 的開發。 UniversalCallBot 類別本身是構成此鏈結根目錄的連結庫。 您可以藉由建立新的連結庫實例和新增對話框,來開發可重複使用元件的連結庫,就像您將一樣。 您的連結庫應該具有對應至連結庫網站或 NPM 模組名稱的唯一名稱。 接著,Bot 只要使用通用CallBot.library() UniversalCallBot.library()將元件庫實例新增至其 Bot,即可重複使用您的連結庫實例。 如果您的連結庫本身相依於其他連結庫,您應該使用 Library.library() 將連結庫新增至連結庫作為相依性,。 您可以將版本號碼新增至連結庫名稱,輕鬆地管理連結庫的多個版本。

若要在連結庫 Bot 中叫用對話,則必須呼叫 session.beginDialog(),其格式為 ':' 的完整對話標識符。 您通常會藉由從其模塊公開函式來啟動對話,以隱藏開發人員。 因此,呼叫類似 myLib.someDialog(session, { arg: '' }); 的東西最終會在幕後呼叫 session.beginDialog('myLib:someDialog', args);

值得注意的是,對話一律會在目前的對話框中叫用,因此一旦您從文檔庫的對話框內,您就不需要在每個 beginDialog() 前面加上您的連結庫名稱來呼叫 。 只有在從某個連結庫內容到另一個連結庫內容時,才需要包含連結庫名稱前置詞。

MemoryBotStorage

儲存使用者 & 工作階段狀態資料之內存記憶體實作中的預設值。

PlayPromptAction

動作產生器類別,旨在簡化建置 playPrompt 動作

Prompt

提示產生器類別,可簡化 playPrompt 動作的建置提示。

Prompts

內建的內建提示,可從任何對話框呼叫。

RecognizeAction

動作產生器類別,旨在簡化建置 辨識動作

RecordAction

動作產生器類別,旨在簡化建置 記錄動作

RejectAction

動作產生器類別,旨在簡化建置 拒絕動作

SimpleDialog

允許建立以簡單關閉為基礎的自定義對話。 這適用於您想要動態對話流程的情況,或您有一個狀況,但無法很好地對應至使用瀑布的情況。 要記住的事項:

  • 您的對話框關閉可以在兩個不同的內容中呼叫,您可能需要進行測試。 當使用者傳送對話時,系統將會如預期般呼叫,但如果您從關閉時呼叫另一個提示或對話框,則會在第二次呼叫提示/對話的結果。 您通常會藉由檢查 args.resumed 屬性是否存在,來測試此第二個案例。 請務必避免讓自己進入無限迴圈,這很容易做到。
  • 不同於瀑布式,您的對話不會自動結束。 在您呼叫 session.endDialog() 之前,它會保持作用中的對話方塊。
UniversalCallBot

管理 Bot 與跨多個通道的使用者交談。

介面

IAction

所有動作的基類。

IActionOutcome

所有動作結果的基類。

IAddress

訊息的位址路由資訊。 位址是雙向的,這表示它們可以用來處理傳入和傳出訊息。 它們也是連接器的特定意義,即 連接器 可以自由新增自己的欄位。

IAnswerAction

回應動作可讓 Bot 接受 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 平台針對 Bot 通話所發出之新 Skype 語音通話之第一個要求的 JSON 本文。 IConversation JSON 主體會張貼在 Bot Framework 入口網站中 Bot 開發人員所註冊的初始 HTTPs 端點上。 IConversation 要求包含呼叫端和目標的相關信息,以及有關呼叫初始狀態的一些其他資訊。

IConversationResult

IConversationResult 是在初始 IConversation 通知之後,從 Skype Bot Platform for Calling 傳送至 Bot 的任何後續要求的 JSON 主體。 IConversationResult 會張貼至先前工作流程回應所提供的回呼連結。 IConversationResult 代表上一個工作流程回應中上次成功動作的結果。

IDialogResult

子對話透過對 session.endDialog() 的呼叫,傳回給其父代的結果。

IDialogState

會話對話堆疊上的專案。

IDialogWaterfallStep

傳遞為步驟的函式簽章,DialogAction.waterfall()。 瀑布圖可讓您使用一連串的問題提示使用者提供資訊。 瀑布的每個步驟都可以執行其中一個內建 提示、呼叫 session.beginDialog()來啟動新的對話框,然後使用 skip()手動移至瀑布的下一個步驟,或終止瀑布。

從瀑布步驟呼叫對話或內建提示時,對話或提示的結果會透過 results 參數傳遞至瀑布的下一個步驟。 使用者可以說「永遠不會」之類的專案取消內建提示,因此您應該至少先檢查結果 回應,再繼續。 藉由查看傳回 results.resumed傳回的 程式代碼,可以更詳細地說明瀑布繼續的原因。

您可以使用傳入的 skip() 函式,手動前進到瀑布的下一個步驟。 使用 IDialogResult 呼叫 skip({ response: "some text" }) 可讓您更準確地模擬內建提示的結果,並簡化整體瀑布邏輯。

您可以使用呼叫 skip() 或直接不啟動另一個提示或對話,提早終止瀑布。

注意:如果您從最後一個步驟呼叫提示或對話框, 瀑布有隱藏的最後一個步驟,這會自動結束目前的對話框。 當您有深層對話堆疊,而且想要從堆疊上最後一個子系呼叫會話.endDialog() ,以結束整個堆棧,這非常有用。 最後一個子系的關閉會觸發其所有父系移至這個隱藏步驟,而這個隱藏步驟會串聯堆棧的關閉。 這通常是一種想要的行為,但如果您想要避免或阻止它位於中間的某個地方,您需要將步驟新增至瀑布的結尾,該瀑布不會執行任何動作,或呼叫類似 session.send() 之類的專案, 不會向前推進瀑布。

IDigitsPromptOptions

傳遞至「數位」提示的選項。

IErrorEvent

錯誤事件處理程式的函式簽章。

IEvent

從或傳送至來源的事件。

IEventMiddleware

連結 'receive' 或 'send' 事件的中間件片段函式簽章。

IFindMatchResult

從 EntityRecognizer.findBestMatch() 或 EntityRecognizer.findAllMatches() 呼叫傳回的結果。

IHangupAction

掛斷可讓 Bot 結束進行中的呼叫。 停止回應是工作流程中的最後一個動作。 請注意,Hangup 和 Reject 之間的差異。 拒絕動作可讓 Bot 結束通話,而不是在 Hangup 終止進行中的通話時接聽通話。

IHangupOutcome

傳回停止回應的結果。

IIdentity

代表使用者、Bot 或交談。

IIsAction

由可轉換成動作的類別實作。

IIsEvent

由可轉換成事件的類別實作。

IIsPrompt

由可轉換成提示的類別實作。

ILocalizer

外掛程式,用於將 Bot 傳送給使用者的訊息當地語系化。

IMiddlewareMap

可在呼叫 UniversalCallBot.use()中註冊的中間件勾點對應。

IPlayPromptAction

PlayPrompt 允許播放文字To-Speech 音訊或媒體檔案。

IPlayPromptOutcome

播放提示結果會傳回播放提示的結果。

IPrompt

提示播放為 PlayPrompt 動作的一部分。

IPromptActionResult

強型別動作提示結果。

IPromptChoiceResult

強類型選擇提示結果。

IPromptConfirmResult

強型別確認提示結果。

IPromptDigitsResult

強型別數位提示結果。

IPromptOptions

傳遞至內建提示的選項。

IPromptRecordResult

強型別的記錄提示結果。

IPromptResult

系統提示字元傳回的對話框結果。

IPromptsSettings

[提示] 對話框的全域組態選項。

IRecognitionChoice

指定選擇型辨識的語音 & DTMF 選項。 例如,「假設 『Sales』 或按 1 代表銷售部門」。

IRecognizeAction

辨識動作可讓您擷取語音辨識輸出,或從Skype使用者撥號鍵台收集數位。

IRecognizeOutcome

辨識結果是辨識動作的結果。 其中包含可辨識的數位或已辨識的語音。

IRecognizerPromptOptions

傳遞至辨識器提示的選項。

IRecordAction

錄製動作是錄製 Skype 使用者音訊的互動式動作。

IRecordOutcome

錄製結果會傳回錄製音訊動作的結果。 RecordOutcome 可以當做多部分內容傳回,其中多部分的第一部分包含動作的結果,而第二部分則包含代表錄製音訊的二進位數據流。 audo 數據流可透過 IConversationResult.recordedAudio 屬性取得。

IRecordPromptOptions

傳遞至「記錄」提示的選項。

IRecording

從內建記錄提示傳回的錄製。

IRejectAction

拒絕允許拒絕接聽電話。 拒絕動作可以做為第一個工作流程的第一個動作,而不是 Answer。

IRejectOutcome

拒絕動作的結果。 如果 Bot 決定 Bot 不想接聽通話,則可以使用拒絕,而不是響應動作。

ISessionState

用來追蹤交談對話堆疊的持續性會話狀態。

IUniversalCallBotSettings

用來初始化 UniversalCallBot 實例的選項。

IWorkflow

IWorkflow 是由 Bot 傳送的 JSON 主體,以回應來自 Skype Bot Platform for Calling 的 IConversation 或 IConversationResult 要求。 IWorkflow 包含一或多個動作清單,Bot 會指示 Skype Bot Platform 代表其執行,以及如果 Bot 想要收到上一次執行動作結果結果的通知,則傳回 HTTP 位址。

列舉

PromptType

叫用的提示類型。

ResumeReason

繼續對話的原因碼。