综合介绍
Base Chat 是一个多租户聊天机器人,使用 Ragie Connect 连接并与组织的知识库进行对话。该项目是 Ragie 多项功能的参考应用,基于 Next.js 构建,支持 Google 认证。Base Chat 旨在帮助用户通过聊天机器人与其组织的知识库进行互动,提供便捷的知识获取和管理方式。该项目仍在积极开发中,未来版本可能会有重大变化。
功能列表
- 多租户支持:允许多个组织使用同一个聊天机器人实例。
- Ragie Connect 集成:通过 Ragie Connect 连接组织的知识库。
- Google 认证:使用 Auth.js 提供的 Google 认证进行用户身份验证。
- 数据库管理:使用 PostgreSQL 数据库存储和管理数据。
- 环境变量配置:通过 .env 文件配置环境变量。
- 数据库迁移:使用 npm 脚本进行数据库迁移。
- 开发模式:支持开发模式下的快速启动和调试。
使用帮助
安装流程
- 克隆项目:从 GitHub 克隆 Base Chat 项目。
git clone https://github.com/ragieai/basechat.git
cd basechat
- 安装依赖:使用 npm 安装项目依赖。
npm install
- 创建数据库:创建名为
basechat
的 PostgreSQL 数据库。 - 配置环境变量:复制
env.example
文件为.env
,并根据需要设置环境变量。
cp env.example .env
- 数据库迁移:运行数据库迁移脚本。
npm run db:migrate
- 启动开发服务器:在开发模式下启动项目。
npm run dev
功能操作指南
- 用户认证:用户首次访问时需要通过 Google 账号进行认证,确保安全性和用户身份验证。
- 知识库连接:通过 Ragie Connect 连接组织的知识库,用户可以通过聊天机器人查询和获取知识库中的信息。
- 多租户管理:支持多个组织同时使用,管理员可以为不同组织配置独立的知识库和用户权限。
- 环境变量配置:在
.env
文件中配置必要的环境变量,如数据库连接信息、Google 认证信息等。 - 数据库管理:使用 PostgreSQL 数据库存储用户数据和聊天记录,确保数据的安全性和可管理性。
- 开发模式:在开发模式下,开发者可以快速启动和调试项目,进行功能测试和代码修改。