ChatIE 项目实战指南

一、核心功能模块解析

1.1 核心服务模块（Python实现）

该模块位于tools/back-end/目录，提供项目核心业务逻辑处理能力，包含API访问控制、数据处理等关键功能。主要文件包括：

• run.py：服务启动入口文件，负责初始化服务并监听请求
• access.py：API访问控制模块，管理请求鉴权与流量限制
• tokens.txt：API密钥存储文件，用于外部服务认证

1.2 前端交互模块（React实现）

位于tools/front-end/目录，提供用户友好的Web操作界面。核心组成：

• src/（前端源代码根目录）：包含React组件与业务逻辑
• public/（静态资源目录）：存放HTML模板、图片等静态文件
• package.json：项目依赖配置与脚本管理文件

1.3 文档与示例模块

包含项目说明文档与功能演示素材：

• docs/examples/（示例资源目录）：存储实体抽取(EE)、命名实体识别(NER)、关系抽取(RE)等功能的演示图片
• docs/prompts/（提示词模板目录）：包含各功能模块的提示词配置文件

图1：ChatIE在多语言数据集上的F1分数表现对比

二、环境准备清单

2.1 3分钟环境检查清单

[预计3分钟]

1. 确认Python环境：

python --version
# 预期输出：Python 3.8+版本号

2. 确认Node.js环境：

node --version && npm --version
# 预期输出：Node.js 14+及npm 6+版本号

3. 克隆项目仓库：

git clone https://gitcode.com/gh_mirrors/ch/ChatIE
cd ChatIE

2.2 依赖安装指南

[预计5分钟]

后端依赖安装

cd tools/back-end
pip install -r requirements.txt
# 验证安装：无错误提示且site-packages目录包含相关依赖

前端依赖安装

cd tools/front-end
npm install
# 验证安装：node_modules目录生成且无npm ERR错误

[!TIP] 如遇依赖安装失败，可尝试使用国内镜像源：

# Python镜像
pip install -i https://pypi.tuna.tsinghua.edu.cn/simple -r requirements.txt
# npm镜像
npm install --registry=https://registry.npm.taobao.org

三、操作流程详解

3.1 后端服务启动流程

[预计2分钟]

1. 进入后端目录并检查配置：

cd tools/back-end
ls -l config.py tokens.txt
# 确认配置文件存在

2. 启动服务：

python run.py
# 成功标志：看到"Server started on port XXXX"提示

3. 验证服务状态：

curl http://localhost:5000/health
# 预期响应：{"status": "healthy"}

3.2 前端应用启动流程

[预计3分钟]

1. 进入前端目录：

cd tools/front-end

2. 启动开发服务器：

npm run start
# 成功标志：浏览器自动打开或终端显示"Compiled successfully"

3. 访问应用： 打开浏览器访问 http://localhost:3000

[!TIP] 若后端服务端口非默认值，需修改src/Utils/ApiUtil.js中的API_BASE_URL配置

四、配置指南

4.1 后端核心配置说明

配置文件路径：tools/back-end/config.py

关键配置项：

• API_PORT (int, 默认: 5000)：后端服务监听端口
• MAX_REQUESTS_PER_MINUTE (int, 默认: 60)：每分钟最大请求限制
• LOG_LEVEL (str, 默认: "INFO")：日志输出级别，可选值：DEBUG/INFO/WARNING/ERROR

开发环境配置示例：

# 开发环境配置
API_PORT = 5000
MAX_REQUESTS_PER_MINUTE = 120  # 开发环境放宽限制
LOG_LEVEL = "DEBUG"  # 开发环境输出详细日志

[!WARNING] 生产环境下应将LOG_LEVEL设为"WARNING"或"ERROR"，避免敏感信息泄露

4.2 配置参数优先级规则

1. 命令行参数 > 环境变量 > 配置文件
2. 开发环境配置（config_dev.py）会覆盖默认配置（config.py）
3. 生产环境配置（config_prod.py）优先级最高

环境变量设置示例：

# 临时设置环境变量
export API_PORT=8080
python run.py  # 将使用8080端口而非配置文件中的5000

五、常见问题解决

5.1 服务启动失败排查

1. 端口占用问题：

# 查看端口占用情况
netstat -tuln | grep 5000
# 结束占用进程
kill -9 <进程ID>

2. 依赖缺失问题：

# 重新安装依赖并检查版本
pip install --upgrade -r requirements.txt

5.2 API密钥相关问题

当出现"Invalid API Key"错误时：

1. 检查tokens.txt文件格式是否正确
2. 确认密钥是否超过使用限额
3. 替换新密钥后需重启服务：

# 在后端目录执行
python run.py --restart

[!TIP] 定期备份tokens.txt文件，避免密钥丢失导致服务不可用