chatbot samples

Chatopera 雲端服務| 入門教學| 文件中心

Chatopera 範例程式

GitHub | Gitee

本源碼庫提供多個範例程式項目，基於這些項目，您可以：

• 快速掌握Chatopera 對話機器人開發，實現智慧問答，智慧客服等應用；
• 以對話模板為鷹架，學習最佳實踐，發展多輪對話；
• 快速掌握Chatopera 機器人的系統整合。

開始閱讀前

• 請完成入門教程，查看文檔
• 本文針對開發者撰寫，有命令列工具或程式語言經驗：Bash（或PowerShell）, Git, JavaScript

工單

有關chatopera/chatbot-samples 的工單，提交到-

https://github.com/chatopera/docs/issues?q=label%3ASamples

安裝CLI

CLI 命令列工具是自動化的腳本命令，使用CLI 命令列工具可快速的匯入或匯出機器人語料。使用CLI 工具，需要先安裝依賴：

• Git - Windows 安裝指南| macOS | Linux
• Node.js - 安裝指南

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 導入範例程式

首先，安裝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 # 导出聊天机器人到语料

LICENSE

Apache 2.0