npm 包 @broid/schemas 使用教程

阅读时长 7 分钟读完

本文将介绍 npm 包 @broid/schemas 的使用教程。@broid/schemas 是一种用于生成聊天机器人对话流程的 JSON schema,可用于快速创建具有复杂对话逻辑的聊天机器人应用程序。在本文中,我们将了解如何安装和使用 @broid/schemas,以及如何为聊天机器人创建对话流程。

安装

@broid/schemas 是一个 npm 包,因此可以通过 npm 直接安装:

使用指南

@broid/schemas 包含两个主要部分:schemasbuilder。Schemas 用于定义聊天机器人的对话流程,而生成器用于将这些 schema 编译为可用于不同聊天平台的代码。

Schemas

Schemas 是定义聊天机器人对话流程的 JSON 文件。它们有助于在不同的平台之间共享对话流程。要创建新的 schema,请创建一个 JSON 文件,并使用以下模板填充:

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

该模板演示了一个简单的对话流程,其中第一个问题是关于是否喜欢比萨饼,第二个问题是关于哪种配料的选择,并根据答案提供不同的响应。创建其他的节点来构建更复杂的对话流程。

Builder

使用 builder,我们可以将上面的 schema 编译为相应的代码。目前,支持的平台有:Facebook Messenger, Telegram, Microsoft Bot Framework, Slack, Kik, Line, Viber,Twilio。

在下面示例中,我们将演示如何使用 builder 将 @broid/schemas 的 schema 编译为 Facebook Messenger 的聊天机器人代码。

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

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

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

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

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

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

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

上面的示例代码首先声明了一个 builder 对象,然后将要编译的 schema 加载到内存中,然后将 bot 对象绑定到 express 应用程序的 POST /webhook 路由上,以便接收 Facebook Messenger webhook 请求。 运行上述代码后,在 Webhook 中配置 Facebook Messenger 应用程序的验证令牌,并使用 Facebook 的 page access 令牌开始测试聊天机器人。

总结

在本文中,我们了解了如何使用 npm 包 @broid/schemas 来生成聊天机器人的对话流程。我们探讨了 schema 的结构以及如何使用 builder 将 schema 编译为各种聊天平台上可用的代码。这些知识对于那些想要开发聊天机器人应用程序,但不想编写繁琐的代码的人非常有用。希望本文对你有所帮助!

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