kscout/bot-api

chat-bot-api

管理用户与虚拟助手对话的API

目录

• 概述
• 核心功能
• 使用场景
• 开发配置
• 部署说明
• 对话示例

概述

HTTP RESTful API，请求除GET外通过JSON编码的请求体传递数据，GET请求通过URL和查询参数传递，响应始终返回JSON。该API使用IBM Watson API创建对话，结合自然语言理解和集成对话工具实现用户与serverless-registry-api之间的对话流程。

核心功能

1. 应用搜索：支持通过选项选择或直接查询获取Serverless应用列表
2. 应用部署：引导用户部署Serverless应用，适配有无集群访问权限的场景
3. 知识学习：回答Serverless相关问题并提供资源链接
4. 对话控制：支持“start over”重启对话或“quit”终止对话

使用场景

• 用户需要快速查找Serverless应用时
• 用户希望部署Serverless应用并获取执行命令时
• 用户想学习Serverless架构等相关知识时
• 用户需要重置或终止当前对话流程时

开发配置

数据库启动

启动本地MongoDB服务器：

bash
make db

Watson Assistant配置

1. 在IBM Cloud Catalog创建Watson Assistant实例
2. 导入技能文件：https://github.com/knative-scout/chat-bot-api/tree/master/training/data/skill-basic-dialogue.json

环境变量设置

需配置以下环境变量：

• BOTUSER_KEY：机器人API密钥
• WORKSPACE_ID：技能唯一ID
• APP_DB_HOST：数据库主机地址
• APP_DB_NAME：数据库名称
• APP_DB_USER：数据库用户
• APP_DB_PASSWORD：数据库用户密码

运行开发服务器

bash
pip install -r requirements.txt
python app.py

部署说明

配置准备

1. 复制deploy/values.secrets.example.yaml为deploy/values.secrets.ENV.yaml（ENV替换为部署环境）
2. 编辑文件填入自定义值，禁止提交该文件

部署步骤

1. 初始化子模块：

bash
git submodule update --init --recursive

2. 部署生产环境：

bash
make deploy-prod

3. 首次部署需执行：

bash
make rollout-prod

对话示例

搜索应用

通过选项选择：

>>用户: 嘿
>>scout: 你好！我是Scout。我可以帮你：
         - 搜索应用
         - 部署应用
         - 学习Serverless
>>用户: （选择搜索应用选项）
>>scout: 你想要什么类型的应用？
>>用户: Serverless应用
>>scout: （所有Serverless应用列表）

直接查询：

>>用户: 给我Serverless应用
>>scout: （所有Serverless应用列表）

部署应用

有集群访问权限：

>>用户: 部署Serverless应用
>>scout: （所有可部署的Serverless应用列表）
>>用户: （选择某应用）
>>scout: 我已记录你选择的应用。请确认你已在集群上安装Knative并拥有访问权限。
>>用户: 是的
>>scout: 你的应用ID是<App id>。
        <提供部署命令>

学习Serverless

直接提问：

>>用户: 什么是Serverless架构？
>>scout: （Serverless架构的解释及资源链接）

对话控制

重启对话：

>>用户: start over
>>scout: 你好！我是Scout。我可以帮你：
         - 搜索应用
         - 部署应用
         - 学习Serverless

终止对话：

>>用户: 算了
>>scout: 好的，操作已中止。