npm 包 botbuilder-dialogs 使用教程

阅读时长 9 分钟读完

前言

botbuilder-dialogs 是一个应用于构建聊天机器人的 Node.js 库,它采用了 dialog 范例,为开发者提供了一种基于明确场景划分的机器人设计方法,可以灵活适应对话流程,适用于对话管理的需求。

本文将介绍 botbuilder-dialogs 库的基础使用方法,并提供完整的示例代码。同时,还将深入探讨其中的一些细节问题,以及推荐一些入门学习的资料。

安装

botbuilder-dialogs 库可以通过 npm 包管理工具进行安装。在 Node.js 环境下,使用以下指令即可安装 botbuilder-dialogs:

基础使用

创建 dialog

在使用 botbuilder-dialogs 库前,首先需要了解 dialog 的概念。dialog 可以理解为在聊天机器人应用程序中表示一段会话交互的完整流程。它可以为用户提供多个交互选项,每个选项之间有条件的跳转,还可以根据用户输入的内容进行反馈和展示。

创建 dialog 相当于在程序中定义一个自定义的类,通过 botbuilder-dialogs 库来实例化对象,并对其进行配置,以达到自定义机器人交互的目的。

这里我们先通过一个简单的例子来了解一下创建 dialog 的方法。首先在项目中新建一个名为 “dialogs” 的文件夹,并在其中创建一个 JavaScript 文件,例如 “greetDialog.js”:

-- -------------------- ---- -------
----- - ---------------- ---------- - - ------------------------------

----- ----------------- - -----------

----- ----------- ------- --------------- -
    ------------- -
        ------------------------

        -- -------- 
        ------------------ ------ -- -
            ------ ----- -------------------------- ------- ---- -- ---- --------
        ---
        
        -- -----
        ------------------ ------ -- -
            ----- ---- - ----------- -- ---
            ----- ----------------------------- -- ---- -- ---- -- ---- -------
            ------ ----- -----------------
        ---
        
        -------------------- - ------------------

        -- ------ -------------
        ------------------ ---------------------------
    -
-

-------------------------- - ------------
-------------------------------- - ------------------

上述代码中,我们创建了一个 GreetDialog 的类,它继承自 WaterfallDialog,并实现了一段问候的交互流程。具体来说,它包括两个问答环节:

  1. 一个文本提问,询问用户的姓名。
  2. 根据用户的输入播放一段问候语,并结束 dialog 交互。

在实现问候流程的前提下,我们还需要为它定义一个名称 GREET_DIALOG_NAME,并在构造函数中完成初始化,用于后续调用。

使用 dialog

在创建了一个 dialog 之后,我们通常会将它作为一个子模块,通过 botbuilder 模块进行注册并启动机器人服务。

以下是一个简单的例子,我们注册了 “greeting” 这个 dialog,用于响应用户的 /greet 命令:

-- -------------------- ---- -------
----- - ---------------- ------------------ ------------- - - ----------------------
----- - ------------ ----------------- - - ---------------------------------

----- - ------------------- - - ----------------------

----- ------- - --- ---------------------
    ------ ---------------------------
    ------------ --------------------------------
---

----- ----------------- - --- --------------------- -----------------

------------------- - ----- --------- ------ -- -
    ----------------- -------------- -- ----- ----
    ----- ---------------------------- --------- ---- ---------
--

----- ------- - --- --------------

----- --- - --- ------------------

------------------- --------- ----- -- -
    ----- ---- - -------------------------------------------

    -- ----- --- --------- -
        ----- -------------------- -------------------------------------------------
    - ---- -
        ----- ------------------------- ---- --- ---- -----
    -

    ----- -------
---

---------------------------

------ -- -- -
    --- -
        ----- ------------------------- - ------------------------------------------------------

        ----- ------------------------
            -
                ------- -
                    ----- ---------
                --
                ------- ----------
                ------- --------
            --
            --------------------------
            ----- --------- -- -
                ----- -----------------
            -
        -
    - ----- ----- -
        -----------------
    -
-----

在上述代码中,我们创建了一个 BotFrameworkAdapter 内容对象,并通过它的 onMessage 方法监听了用户的消息。当用户发送了 "/greet" 命令时,我们将启动对应的 dialogs 处理程序,即 GreetDialog。如果用户输入的是其他文本,就将文本进行原样返回。

使用变量

在以上例子中,我们固定了一句问候语,无法从输入的文本中获取用户名称。为了实现更灵活的机器人交互,我们可以通过使用变量来替换固定的问候语,将其设定为与用户输入相关的内容。

下面是一个使用变量的更改后的代码:

-- -------------------- ---- -------
----- - ---------------- ---------- - - ------------------------------

----- ----------------- - -----------

----- ----------- ------- --------------- -
    ------------- -
        ------------------------

        ------------------ ------ -- -
            ------ ----- -------------------------- ------- ---- -- ---- --------
        ---
        
        ------------------ ------ -- -
            ----- ---- - ----------- -- ---
            ----- -------- - --- -- ---- ---
            ----- ----------------------------- -------- -- ---- -- ---- -------
            ------ ----- -----------------
        ---
        
        -------------------- - ------------------

        ------------------ ---------------------------
    -
-

-------------------------- - ------------
-------------------------------- - ------------------

上述代码中,我们通过 ${ name } 这种方式使用了变量,用用户输入的名称替换了原来固定的问候语。

测试运行结果

在完成代码编写并执行之后,我们可以通过以下方法来测试其运行结果:

  1. 在命令行,使用 npm start 指令启动应用程序。
  2. 使用 Bot Framework Emulator 工具访问并发送命令。

如果代码无误,执行命令后就可以看到机器人的应答。

学习资料

本文介绍的 botbuilder-dialogs 库是以独立模块方式存在的,它只是本系列中的一部分。如果您想在更深层次上学习聊天机器人设计和构造的内容,可以参考以下资料:

根据这些资料,您可以更全面地了解 botbuilder-dialogs 库的使用,探究它所提供的丰富的功能性,并自主设计聊天机器人系统。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/botbuilder-dialogs