chatbot samples
1.0.0
Chatopera 云服务 | 入门教程 | 文档中心
GitHub | Gitee
本源码库提供多个示例程序项目，基于这些项目，您可以：
有关 chatopera/chatbot-samples 的工单，提交到 -
https://github.com/chatopera/docs/issues?q=label%3ASamples
CLI 命令行工具是自动化的脚本命令，使用 CLI 命令行工具可快速的导入或导出机器人语料。使用 CLI 工具，需要先安装依赖：
CLI 同时依赖操作系统的命令行终端，如 PowerShell, CMD Prompt, Bash Shell, etc.
打开命令行中断，比如 PowerShell，执行 npm --version，确认可以看到类似的输出。
证明 nodejs 已经安装成功。然后，执行：
npm install -g @chatopera/sdk
进行安装 CLI，上述命令执行后，在命令行执行 ``，确认可以看到类似这样的输出。
git clone https://github.com/chatopera/chatbot-samples.git
cd chatbot-samples
pwd # 得到代码路径 ROOT_PATH
ls projects # projects 目录内存放多个示例项目
{{ROOT_PATH}} 是项目 https://github.com/chatopera/chatbot-samples 存放的路径, 比如 /c/Users/Administrator/chatbot-samples。
首先，安装 CLI 和克隆代码，然后执行下面的步骤。
将某个示例程序，导入到一个已有的聊天机器人。假设已经在 https://bot.chatopera.com/dashboard 创建了一个聊天机器人，并获得了 ClientID 和 Secret 信息。
接着按照顺序，执行下面的命令：
#cd {{ROOT_PATH}}/projects/{{PROJECT_NAME}} # 使用哪个示例项目，就进入哪个文件夹
cd {{ROOT_PATH}}/projects/GitHub工单机器人 # 比如，进入【GitHub工单机器人】
bot env # 自动生成 .env 文件，然后更新 .env 文件中的 BOT_CLIENT_ID 和 BOT_CLIENT_SECRET
bot dicts --action import -f bot.dicts.json # 导出词典
bot faq --action import -f bot.faqs.json # 导出知识库
bot intents --action import -f bot.intents.json # 导出意图识别
bot conversation --action import -f bot.conversations.c66 # 导出多轮对话
这样，就可以访问机器人了，比如从 H5 聊天控件，和机器人对话。
将目前 .env 文件中的机器人的语料导出为本地的语料文件。
cd {{ROOT_PATH}}/projects/GitHub工单机器人 # 使用哪个示例项目，就进入哪个文件夹
bot dicts --action export -f bot.dicts.json # 假设已经创建了 .env 文件，并设定 BOT_CLIENT_ID 和 BOT_CLIENT_SECRET
bot faq --action export -f bot.faqs.json
bot intents --action export -f bot.intents.json
bot conversation --action export -f bot.conversations.c66
这样，就完成了机器人对话技能的备份。
导入和导出中，文件格式是一样的。
查看示例程序目录。
每个示例程序按照如下的结构组织。
根目录
├── README.md # 该项目的使用说明，必读
├── bot.dicts.json # 词典导入文件，包括引用词典、词汇表词典和正则表达式词典
├── bot.faqs.json # 知识库导入文件，包括标准问、扩展问、分类等
├── bot.intents.json # 意图识别导入文件，包含意图、说法、槽位等
├── bot.conversations.c66 # 多轮对话导入文件，包含脚本、函数等
├── conversations # 多轮对话文件解压后的内容，.c66 文件是 zip 压缩包
├── flow.mdj # UML 对话流程文件，描述对话流程，可能有
└── flow.xlsx # Excel 话术文件，描述对话流程，可能有
了解导入导出语料，查看文档
在 shell profile 中设置如下命令, 比如 ~/.zshrc or ~/.bashrc。
export CHATBOT_SAMPLES={{ROOT_PATH}}
# export bot files into current work dir
alias botexport="$CHATBOT_SAMPLES/bin/export.sh"
# import bot files under current work dir
alias botimport="$CHATBOT_SAMPLES/bin/import.sh"
# package conversations folder as bot.conversations.c66
alias botconpac="$CHATBOT_SAMPLES/bin/conversation.package.sh"
现在，使用命令 botimport 和 botexport 完成导入 BOT 和导出 BOT 的操作，比如：
cd projects/GitHub工单机器人
botimport # 导入语料到聊天机器人
botexport # 导出聊天机器人到语料
Apache 2.0
