npm 包 botframework-streaming 使用教程

阅读时长 13 分钟读完

前言

当今互联网时代,人工智能技术的飞速发展让聊天机器人在人机交互领域扮演着重要的角色。Microsoft Bot Framework 是一个众所周知的完整机器人建造平台,该平台包含了 BotBuilder SDK、Bot Framework Portal、Bot Framework CLI 等工具,可以让开发人员轻松地构建和部署聊天机器人。

botframework-streaming 是 Microsoft Bot Framework 中新推出的一个 npm 包,它可以让开发人员更加方便地进行浏览器和服务器之间的实时双向通信。在本篇文章中,我们将介绍如何使用 botframework-streaming 进行聊天机器人的开发,并提供详细的指导和示例代码。

安装

我们可以通过命令行工具快速安装 botframework-streaming,命令如下:

使用

要使用 botframework-streaming,我们必须先创建一个 adapter 对象来处理连接和消息传递操作,代码实现如下:

在以上代码中,我们创建了一个名为 StreamingHttpClient 的类,并通过 sendActivities 方法来发送消息,并通过 response 变量来获取返回结果。

当 adapter 对象被创建后,我们需要启动它来监听客户端的请求,代码如下:

在以上代码中,我们通过 WebSocketServer 类创建了一个名为 server 的 websocket 服务器,通过 start 方法来启动它并监听客户端请求,最后在控制台输出“Listening...”表示服务器已成功启动。

示例

在本节中,我们将演示如何使用 botframework-streaming 实现简单的聊天机器人。在该机器人中,我们将使用 LUIS(Language Understanding Intelligent Service)作为 NLU(自然语言理解)引擎,通过对用户的输入进行分析来推断对应的意图和实体,并针对不同的意图提供不同的回复。

步骤一:创建 HTTP 服务器

首先,我们需要创建一个 HTTP 服务器,代码如下:

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

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

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

在该代码中,我们创建了一个名为 server 的 HTTP 服务器,并通过 listen 方法将其绑定到指定的端口号。当有请求到达服务器时,服务器将通过 createServer 方法创建一个请求处理器,返回一个响应内容“Hello World!”并发送到客户端。

步骤二:实现 WebSocket 服务器

然后,我们需要使用 WebSocket 服务器来处理实时的消息通信,在之前的代码基础上,我们增加以下代码:

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

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

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

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

在以上代码中,我们首先引入了 ws 模块,该模块用于创建基于 WebSocket 的双向通信。通过 WebSocketServer 类创建了一个名为 streamingServer 的 websocket 服务器,并通过 createConnection 方法来创建一个 websocket 连接,当建立连接后通过 connected 事件输出提示信息。

streamingServer 对象上,通过 on 方法监听 receive 事件,该事件用于在服务器接收客户端消息时进行触发。在该事件中,我们利用 context 上下文对象来获取客户端发送的消息,并返回消息内容“ You said: + context.activity.text ”,表示服务器已成功接收到客户端发送的消息。

步骤三:连接到 LUIS 并分析消息

接下来,我们需要连接到 LUIS 并分析客户端发送的消息,为此,我们需要安装 botbuilder-aibotbuilder-streaming-extensions 两个 npm 包,命令如下:

接着,我们需要通过 LuisRecognizer 类实现与 LUIS 的通信,代码如下:

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

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

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

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

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

在以上代码中,我们首先创建了一个名为 luisRecognizer 的 LUIS 分析器,通过 LUIS 的 API 将用户输入的文本转化为理解层输入(Cognitive Services LUIS 输出的数据)。

随后,我们通过 StreamManager 类创建了一个名为 stream 的流通道,将 LUIS 分析结果通过 stream 传送到客户端。其中 subscribe 方法将在上下文中注册一个 activity 处理程序,以对流式源信息进行处理。当对话结束时,此方法还将呈现一个最近的消息。

最后,在 streamingServer.on('receive') 中,我们使用 StreamingHttpClient 类创建 HTTP 客户端,并通过 send 方法将输入消息传递给 LUIS 分析器,如下所示:

其中,第一条命令类型为 invoke,用于在 LUIS 识别器中声明语言识别的服务。第二条命令类型为 activity,用于传输输入活动数据。

步骤四:集成 Bot Framework

最后,我们需要将以上所有的模块组合到一起并创建聊天机器人。对于这个机器人,我们需要做的是实现 onTurn 函数来处理对话,代码如下所示:

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

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

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

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

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

在以上代码中,我们继承了 ActivityHandler 类,并重写了 onTurn 方法,该方法将在每一个机器人的交互中被调用。当 context 中 activity 的类型为 'message' 时,我们将调用 LUIS 分析器来处理用户输入的消息和意图。

我们在服务器的 WebSocket 服务器代码中,使用了一个 pipe 方法来把消息流从 botBuilder 子协议管道映射到 botBuilder 适配器上,实现了更加完整的机器人聊天应用。

总结

本篇文章详细介绍了如何使用 botframework-streaming 包来构建聊天机器人,并提供了示例代码和详细的指导。当然,这只是 botframework-streaming 的一部分,还有更加完整的 API 可以使用,感兴趣的读者可以参考 Microsoft 官方文档进行深入的学习。

使用 botframework-streaming 可以让开发人员更加方便地进行聊天机器人的开发,同时也可以拿来进行其他基于 WebSocket 的通信应用,属于一个比较好用的工具包。希望读者学习本文后,能够更加熟练地掌握 botframework-streaming 的使用方法,并在实际开发中取得更好的效果。

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

纠错
反馈