通过


botbuilder-calling package

AnswerAction

操作生成器类旨在简化生成 答案操作

CallConnector

将 UniversalCallBot 连接到 Skype 呼叫服务。

CallSession

管理与用户的机器人对话。

Dialog

所有对话的基类。 对话是 BotBuilder 框架的核心组件。 机器人使用对话来管理与用户任意复杂的对话。

DialogAction

对话操作提供了实现常见操作的快捷方式。

HangupAction

操作生成器类旨在简化生成 挂起操作

Library

用于路由目的的相关对话库。 库可以链接在一起,以便开发复杂的机器人。 UniversalCallBot 类本身是构成此链根的库。 可以通过创建新的库实例和向机器人添加对话来开发可重用部件库。 库应具有与库网站或 NPM 模块名称对应的唯一名称。 然后,机器人只需使用 UniversalCallBot.library()将部件库实例添加到机器人,即可重复使用库。 如果库本身依赖于其他库,则应使用 Library.library()将其作为依赖项添加到库中。 可以通过向库名称添加版本号轻松管理库的多个版本。

若要调用库机器人中的对话,需要调用 session.beginDialog(),其完全限定的对话 ID 格式为“:”。 通常,通过从其模块中公开一个启动对话框的函数来隐藏开发程序。 因此,像 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

跨多个通道管理与用户的机器人对话。

接口

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 机器人平台对机器人进行的新 Skype 语音呼叫的第一个请求的 JSON 正文。 IConversation JSON 正文在 Bot Framework 门户中由机器人开发人员注册的初始 HTTP 终结点上发布。 IConversation 请求包含有关调用方和目标的信息,以及有关呼叫初始状态的一些附加信息。

IConversationResult

IConversationResult 是任何后续请求的 JSON 正文,遵循从 Skype Bot Platform for Calling 发送到机器人的初始 IConversation 通知。 IConversationResult 发布到上一工作流响应提供的回调链接。 IConversationResult 表示上一工作流响应中上次成功操作的结果。

IDialogResult

子对话通过调用 session.endDialog()将其父对话返回的结果。

IDialogState

会话对话堆栈上的条目。

IDialogWaterfallStep

作为步骤传递的函数的签名 DialogAction.waterfall()。 瀑布图允许使用一系列问题提示用户获取信息。 瀑布的每个步骤都可以执行其中一个内置 提示,通过调用 session.beginDialog()启动新对话,使用 skip()手动转到瀑布图的下一步,或终止瀑布。

从瀑布步骤调用对话或内置提示时,该对话或提示的结果将通过 results 参数传递到瀑布的下一步。 用户可以说出诸如“永不谋”之类的内容来取消内置提示,因此在继续操作之前,应至少检查 results.response 来防范该提示。 通过查看返回 results 返回的 代码来确定瀑布继续的原因的更详细说明。恢复

可以使用传入的 skip() 函数手动转到瀑布的下一步。 使用 skip({ response: "some text" }) 调用 可以更准确地模拟内置提示的结果,并可以简化整个瀑布逻辑。

可以使用调用 skip() 或根本不启动另一个提示或对话,提前终止瀑布图。

注意: 瀑布图具有隐藏的最后一个步骤,如果从上一步调用提示或对话,将自动结束当前对话。 在具有深层对话堆栈,并且希望调用 session.endDialog() 堆栈上最后一个子级来结束整个堆栈,这非常有用。 最后一个子级的关闭将触发其所有父级移动到此隐藏步骤,这将级联在堆栈上一直级联。 这通常是一种所需的行为,但如果你想避免它或将其停止在中间的某个位置,则需要向瀑布末尾添加一个步骤,该步骤要么不执行任何操作,要么调用诸如 session.send() 之类的内容, 不会向前推进瀑布。

IDigitsPromptOptions

传递给“数字”提示的选项。

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 选项。 例如,“假设'销售'或按 1 表示销售部门。

IRecognizeAction

识别操作允许捕获语音识别输出或从 Skype 用户拨号盘收集数字。

IRecognizeOutcome

识别结果是识别操作的结果。 它包含已识别的数字或已识别的语音。

IRecognizerPromptOptions

传递给基于识别器提示的选项。

IRecordAction

录制操作是录制 Skype 用户音频的交互式操作。

IRecordOutcome

记录结果返回记录音频操作的结果。 RecordOutcome 可以作为多部分内容返回,其中多部分的第一部分包含操作结果,而第二部分包含表示录制的音频的二进制流。 audo 流将通过 IConversationResult.recordedAudio 属性提供。

IRecordPromptOptions

传递给“记录”提示的选项。

IRecording

从内置记录提示返回的记录。

IRejectAction

拒绝允许拒绝接听呼叫。 拒绝操作可用作第一个工作流的第一个操作,而不是 Answer。

IRejectOutcome

拒绝操作的结果。 如果机器人决定机器人不想接听呼叫,则可以使用拒绝,而不是应答操作。

ISessionState

用于跟踪对话对话堆栈的持久会话状态。

IUniversalCallBotSettings

用于初始化 UniversalCallBot 实例的选项。

IWorkflow

IWorkflow 是机器人发送的 JSON 正文,用于响应 Skype Bot Platform for Calling 的 IConversation 或 IConversationResult 请求。 IWorkflow 包含一个或多个操作的列表,如果机器人希望收到有关上次执行操作结果结果的通知,机器人会指示 Skype Bot Platform for Calling on 执行,以及回调 HTTP 地址。

枚举

PromptType

调用的提示类型。

ResumeReason

恢复对话框的原因代码。