Files
aurak/README_ZH.md
Developer 0a9588abb7 feat: implement QuestionBank CRUD with pagination and template query
- Add pagination support to findAll (page, limit query params)
- Add findByTemplateId method to service
- Add GET /by-template/:templateId endpoint to controller
- Service already includes CRUD for QuestionBank and QuestionBankItem
2026-04-23 17:19:11 +08:00

120 lines
4.7 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# AuraK:企业级全栈智能 AI 知识平台
AuraK 是一个基于 **React 19****NestJS** 构建的现代化企业级 AI 知识库与人才评价系统。它不仅提供了高度可扩展的 RAG(检索增强生成)能力,还深度集成了多租户管理、交互式评价工作流及飞书办公生态。
---
## ✨ 核心特性
### 🔐 企业级多租户与权限
- **租户隔离**:严格的数据与资源租户级物理隔离,支持独立域名/子域名挂载。
- **RBAC 权限管理**:预置超级管理员、租户管理员、普通用户等多种角色。
- **成员管理**:支持租户内成员邀请、权限分配与配额限制。
### 📚 智能知识路由与管理
- **层级化分组**:支持知识库文件的文件夹式层级管理(Knowledge Groups),轻松应对海量文档。
- **双模式处理流水线**
- **快速模式 (Fast)**:基于 Apache Tika,极速提取海量纯文本。
- **高精度模式 (High-Precision)**:集成了 **Vision Pipeline**,利用多模态模型识别复杂 PDF/图片中的图文混合内容。
- **格式全支持**:原生支持 PDF, Word, PPT, Excel, TXT, Markdown 以及各类图片格式。
### 📊 交互式人才评价 (Assessment)
- **LangGraph 工作流**:基于图结构的 AI 对话逻辑,实现逻辑严密的自动化面试与素质评价。
- **落地式出题 (Grounded Q&A)**:基于 RAG 技术,从自有知识库中根据关键词精准提取素材生成专业题目。
- **加权智能评分**:支持 Standard (1.0), Advanced (1.5), Specialist (2.0) 三级难度权重的自动化综合评分。
- **多语言评价**:支持中、英、日三语同步测评。
### 🤖 深度飞书办公集成
- **免公网 WebSocket 机器人**:支持通过飞书长连接(WebSocket)直接接入企业内网,无需公网 IP 或域名映射。
- **互动消息卡片**:在飞书中实时展示 AI 思考过程、检索来源及测评进度。
- **移动端评价**:用户可直接在飞书聊天窗口完成完整的人才评价流程。
### 🚀 高级 RAG 性能优化
- **混合检索 (Hybrid Search)**:结合 Elasticsearch 的 BM25 关键词检索与高维度向量检索,大幅提升首选片段准确率。
- **智能重排序 (Rerank)**:内置 Rerank 模型二次校验,确保生成内容的真实性与相关性。
- **SSE 流式响应**:秒级首屏响应,实时展示知识检索状态与生成进度。
### 🛠️ 生产力增强工具
- **播客生成 (Podcasts)**:一键将长文档转化为播客形式的音频摘要。
- **智能笔记 (Notes)**:支持对知识库内容记录分类笔记。
- **搜索历史溯源**:完整的聊天历史记录与引用文档回溯。
---
## 🏗️ 技术架构
### 前端 (Web)
- **核心**React 19 + TypeScript + Vite
- **UI/样式**Tailwind CSS + Lucide React
- **交互**React Context + SSE Streaming + Framer Motion (微动画)
### 后端 (Server)
- **框架**NestJS (Node.js) + TypeScript
- **AI 引擎**LangChain + **LangGraph** (评价工作流)
- **存储**SQLite (元数据) + **Elasticsearch** (向量与全文检索)
- **处理层**Apache Tika + Vision Pipeline + LibreOffice (文档转换)
- **通信**Feishu WebSocket Manager + SSE
---
## 🏢 内网部署支持
AuraK 专为私有化部署设计:
- **资源本地化**:KaTeX、字体等静态资源完全本地化,无需访问 CDN。
- **私有模型接入**:支持接入各类 OpenAI 兼容格式的内网私有化模型服务。
- **容器化部署**:提供完整的 Docker Compose 一键启动方案,支持私有镜像仓库。
详细指南请参考 [内网部署手册](INTERNAL_DEPLOYMENT_GUIDE.md)。
---
## 🚀 快速开始
### 1. 准备工作
- Node.js 18+
- Yarn
- Docker & Docker Compose
### 2. 克隆与安装
```bash
git clone <repository-url>
cd auraAuraK
yarn install
```
### 3. 启动周边服务
```bash
docker-compose up -d elasticsearch tika libreoffice
```
### 4. 环境配置
分别修改 `server/.env``web/.env`
### 5. 启动项目
```bash
yarn dev
```
访问 `http://localhost:5173` 开始体验!
---
## 📁 项目目录
```
auraAuraK/
├── web/ # 前端 React 应用
├── server/ # 后端 NestJS 应用
│ ├── src/
│ │ ├── tenant/ # 多租户管理
│ │ ├── assessment/ # 合才评价 (LangGraph)
│ │ ├── feishu/ # 飞书集成
│ │ ├── knowledge-group/# 知识库分组
│ │ └── chat/ # RAG 核心逻辑
├── docs/ # 技术方案与 API 文档
└── docker-compose.yml # 全栈部署配置
```
---
## 📄 开源协议
本项目采用 MIT 协议。详见 [LICENSE](LICENSE) 文件。