npm 包 mobido-bot-client 使用教程

阅读时长 5 分钟读完

mobido-bot-client 是一款与 mobido 平台对接的 Node.js 客户端,可用于快速构建聊天机器人应用。本文将详细介绍 mobido-bot-client 的使用方法,包括安装、配置、接口等方面,并提供示例代码。

安装

在安装 mobido-bot-client 之前,您需要确保安装了 Node.js 环境和 npm 包管理器。安装 mobido-bot-client 可以通过 npm 命令来完成:

配置

使用 mobido-bot-client 前,需要在 mobido 平台上注册并创建一个机器人账号。在获取相关的配置参数后,您需要在您的代码中进行配置。

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

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

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

其中,config 对象包含三个参数:

  • url:mobido 平台的 API 端点。
  • apiKey:mobido 平台提供的 API Key。
  • botId:mobido 平台中创建的机器人账号 ID。

接口

发送消息

使用 send() 方法可以向用户发送消息。该方法接受一个对象作为参数,该对象包含三个属性:

  • type:消息类型,目前支持 text 和 image 两种类型。
  • text:当 type 为 text 时,该属性为消息文本;当 type 为 image 时,该属性为图片地址。
  • userId:消息所属的用户 ID。

接收消息

使用 onMessage() 方法可以注册一个消息处理函数并接收用户发送的消息。该方法会在每次收到消息时被调用,它接收一个对象作为参数,该对象包含五个属性:

  • type:消息类型,目前支持 text 和 image 两种类型。
  • text:当 type 为 text 时,该属性为消息内容;当 type 为 image 时,该属性为图片地址。
  • userId:消息发送者的用户 ID。
  • tokens:消息文本中的分词数组。
  • createdAt:消息创建时间戳。

查询语料

使用 searchCorpus() 方法可以查询语料库中的文本。该方法接收一个文本字符串作为参数,并返回一个 Promise 对象。

设置语料

使用 setCorpus() 方法可以设置语料库中的文本。该方法接受一个对象作为参数,该对象包含两个属性:

  • query:查询文本。
  • reply:回复文本。

示例

下面是一个完整的示例代码,它会向用户发送一条消息,并在收到用户消息时回复一条消息。

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

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

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

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

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

结语

本文介绍了 npm 包 mobido-bot-client 的使用方法,包括安装、配置、接口等方面,并提供了示例代码。希望可以对开发聊天机器人应用的开发者们有所帮助。

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

纠错
反馈