[人工智能]Chatopera 命令行界面（CLI）增加自动化管理机器人、批量维护、提升开发和管理效率 | Chatopera

Chatopera 命令行界面（CLI）

Chatopera CLI 是连接 Chatopera 机器人平台，管理和维护资源的工具，包括一些常用的命令，辅助开发者实现和管理对话机器人。尤其是在有自动化或批量管理的需要时。CLI 完全基于 Chatopera Node.js SDK，开发者也可以参考 SDK 源码，进一步掌握对 SDK 的使用。

https://github.com/chatopera/chatopera-nodejs-sdk

安装

Chatopera CLI 依赖于 Node.js v10+ 环境，使用 npm 进行安装（npm 是 Nodejs 安装完成后得到的 CLI 工具）。

• Windows 上安装 Node.js 及配置环境变量参考文档

• Linux 上安装 Node.js 参考文档

有了 Node.js 环境，在命令行终端，执行如下命令：

npm install -g @chatopera/sdk

在 Windows 上，安装过程输出类似的日志：

 npm install -g @chatopera/sdk
C:\Users\Administrator\AppData\Roaming\npm\bot -> C:\Users\Administrator\AppData
\Roaming\npm\node_modules\@chatopera\sdk\bin\bot.js
+ @chatopera/sdk@2.7.1
added 147 packages from 104 contributors in 36.389s

检查安装是否正确，执行：

$ bot --version
2.7.1  # 得到类似输出，代表安装正确，2.7.1 为当时最新的 Chatopera CLI 版本

如果上述命令 bot --version 执行提示错误，检查环境变量 PATH 路径，比如 C:\Users\Administrator\AppData\Roaming\npm 是否在 PATH 内。

命令帮助

打印 CLI 可用命令。

bot --help

得到类似输出:

Usage: bot [options] [command]

Options:
  -V, --version           output the version number
  -h, --help              display help for command

Commands:
  details [options]       get a bot's detail info, such as name, primaryLanguage
  connect [options]       chat with bot via bot#conversation interface, https://dwz.chatopera.com/SHl7N5
  conversation [options]  import or export a bot's conversations data
  trace [options]         tail a bot's conversations logging info
  asr [options]           request Chatopera ASR API,
                          https://docs.chatopera.com/products/chatbot-platform/integration/chatbot/asr.html
  faq [options]           import or export a bot's faqs data
  dicts [options]         sync, import or export a bot's dicts data
  intents [options]       train, import or export a bot's intents data
  help [command]          display help for command

也可以针对一个命令，获得更多帮助提示，比如：

bot connect --help
bot trace --help
bot conversation --action export --help

获得类似输出：

Usage: bot connect [options]

Options:
  -c, --clientid [value]      ClientId of the bot
  -s, --clientsecret [value]  Client Secret of the bot, optional, default null
  -u, --username [value]      Username to chat with bot, default: commandline
  -p, --provider [value]      Chatopera Bot Service URL, optional, default
                              https://bot.chatopera.com
  -fb, --faq-best [value]     FAQ best reply threshold, optional, default 0.8
  -fs, --faq-sugg [value]     FAQ suggest reply threshold, optional, default
                              0.6
  -h, --help                  display help for command

配置参数

Chatopera CLI 命令行工具支持读取文件配置变量，比如 provider, clientid 等常用的变量。

参数设定优先级: 命令行参数 > .env 文件 > 环境变量

其中， .env 文件例子如：

BOT_CLIENT_ID=xxx
BOT_CLIENT_SECRET=xxx
BOT_PROVIDER=https://bot.chatopera.com
BOT_ACCESS_TOKEN=xxx

.env 文件存储的也是环境变量值。bot 命令会沿当前执行命令的路径(pwd)，寻找 .env 文件。

比如，在 /Users/chatopera/chatopera-nodejs-sdk下执行 bot 命令，那么，.env文件按照以下顺序进行查找，一旦查找到就加载为配置，并退出查找。

/Users/chatopera/chatopera-nodejs-sdk/.env
/Users/chatopera/.env
/Users/.env
/.env

为简化说明，以下各示例配置使用了 .env 文件，因为略去了从命令行传入的一些参数。

多轮对话

connect

连接聊天机器人，在命令行终端连接 BOT 并进行对话。

示例：

bot connect -c xxx -s xxx -u zhangsan

其中，clientid和clientsecret从每个机器人的设置页面获取，username代表用户名，是一个不含空格或特殊符号的字符串，每个用户的唯一标识，provider是Chatopera 机器人平台地址，默认为 Chatopera 云服务。

在对话中，可以使用快捷方式，快速输入。

export

导出多轮对话为 c66 文件。

示例：

bot conversation --action export --filepath /tmp/bot.conversations.c66

import

导入多轮对话脚本，在命令行终端发布脚本文件到多轮对话中。

示例：

bot conversation --action import --filepath /tmp/bot.conversations.c66

其中 filepath 为 xx.c66 文件或机器人的话题文件目录，支持相对路径和绝对路径。

机器人的话题文件目录

将 xx.c66 文件后缀调整为 .zip 并解压后的目录结构。

botarchive
├── index.json
├── plugin.js
└── zh_CN.greeting.ms

其中，index.json描述机器人多轮对话属性：

{
    "name": "大白",
    "primaryLanguage": "zh_CN",
    "version": "0.5.0",
    "conversations": [
        {
            "name": "greeting",
            "enabled": true
        }
    ],
    "config": // 环境变量Key-Value
    {
    }
}

plugin.js 是函数，参考说明文档。

快速开始参考示例程序：活动通知。

Chatopera CLI 支持直接使用 -b 参数指定机器人的话题文件目录的方式上传多轮对话。

trace

打印聊天机器人日志：方便调试多轮对话脚本，实时跟踪服务器端日志，排查问题。

示例：

bot trace --log-level DEBUG

Log level 可以是 [DEBUG|INFO|WARN|ERROR]。

词典

export

导出引用的系统词典、所有自定义词典（词汇表词典和正则表达式词典）。

举例：

bot dicts --action export --filepath /tmp/bot.dicts.json

import

导入引用的系统词典、所有自定义词典（词汇表词典和正则表达式词典）。

举例：

bot dicts --action import --filepath /tmp/bot.dicts.json

sync

触发同步命令，知识库、意图识别和多轮对话同步最新的近义词词典；此步骤将引起数据改写，生产环境宜业务低峰时间段进行。

bot dicts --action sync

知识库

export

导出知识库问答对、扩展问和分类信息等，目前 CLI 导入和导出只支持 JSON 格式，欲使用 Excel 从机器人平台浏览器管理界面完成。

举例：

bot faq --action export --filepath /tmp/bot.faqs.json

import

导入知识库问答对、扩展问和分类信息等。

举例：

bot faq --action import --filepath /tmp/bot.faqs.json

意图识别

export

导出意图识别说法、槽位等信息。

bot intents --action export --filepath /tmp/bot.intents.json

import

导入意图识别说法、槽位等信息。

bot intents --action import --filepath /tmp/bot.intents.json

导入命令也会自动执行训练意图调试分支，训练完成后，命令退出。

意图识别的导入和导出不会处理生产版本上线信息和操作，需要 Chatopera 机器人平台用户自行维护意图识别模块的生产分支。

train

训练意图识别的调试分支。

bot intents --action train

语音识别

asr

Usage: bot asr [options]

Options:
  -c, --clientid [value]      ClientId of the bot
  -u, --username [value]      Username to chat with bot
  -s, --clientsecret [value]  Client Secret of the bot, optional, default null
  -p, --provider [value]      Chatopera Bot Service URL, optional, default https://bot.chatopera.com
  -f, --file <value>          Target file to recognize, *required.
  -h, --help                  display help for command

示例：

bot asr -c xxx \
     -s xxxx \
     -u nodetest \
     -f ./test/fixtures/001.wav
{
 "rc": 0,
 "data": {
  "duration": 6250,
  "predicts": [
   {
    "confidence": 0.960783,
    "text": "上海 浦东机场 入境 房 输入 全 闭 环 管理"
   },
   {
    "confidence": 0.960767,
    "text": "上海 浦东机场 入境 防 输入 全 闭 环 管理"
   },
   {
    "confidence": 0.960736,
    "text": "上海 浦东机场 入境 坊 输入 全 闭 环 管理"
   }
  ]
 }
}

开源项目

Chatopera CLI 工具是开源的，更多使用示例参考：

https://github.com/chatopera/chatopera-nodejs-sdk/tree/master/scripts