Skip to content

Commit 599e390

Browse files
committed
docs: 更新了 README 和用户手册内容。
1 parent e436009 commit 599e390

2 files changed

Lines changed: 26 additions & 17 deletions

File tree

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
1. **自助提数 (Self-Service)**: 运营人员无需懂 SQL,直接提问即可获取数据报表。
2525
2. **安全可控 (Enterprise Safe)**: 细粒度的 RBAC 权限、PII 敏感数据自动脱敏、SQL 注入防御与审计日志。
2626
3. **闭环进化 (Self-Evolving)**: 支持用户反馈 (Feedback) 与知识库 (Knowledge Base) 联动,AI 越用越聪明。
27-
4. **成本透明 (FinOps)**: 内置 AI 成本监控,实时追踪 Token 消耗与模型费用
27+
4. **团队协作 (Team Collaboration)**: 支持查询任务的私有化与公开分享,打破数据孤岛
2828

2929
---
3030

@@ -52,14 +52,14 @@
5252

5353
### 🛡 安全与治理
5454

55-
- **End-to-End Encryption**: 基于 `CryptoService` 实现敏感 API 负载的全链路加密,确保 API 密钥与敏感数据在传输过程中不可被破解。
56-
- **RBAC**: 基于角色的权限控制 (Admin, Developer, Operator),支持动态菜单与按钮级权限。
57-
- **Security Guardrails**:
58-
- 拦截 `DROP`, `TRUNCATE` 等高危指令。
59-
- 强制 WHERE 子句检查(防止全表更新)。
60-
- 生产环境 SQL 报错屏蔽。
55+
- **End-to-End Encryption**: 基于 `CryptoService` 实现敏感 API 负载的全链路加密,确保 API 密钥与敏感数据不可通过网络嗅探获取。
56+
- **Precision RBAC**: 基于角色的权限控制,严格实施最小权限呈现原则。Dashboard 支持系统级全量视图与个人专属版面的动态区隔。
57+
- **Enterprise-Grade Protection**:
58+
- **OOM Defense**: 查询引擎自带行数熔断 (LIMIT 1000兜底),阻止巨量数据拉垮服务器内存。
59+
- **RCE Prevention**: 核心沙箱阻隔 Shell 元字符注入,彻底杜绝命令执行逃逸。
60+
- **IDOR Proof**: 数据源探测和任务协同均具备行列级越权防御,普通员工无法窥探越权数据。
61+
- **安全过滤拦截**: 拦截 `DROP`, `TRUNCATE` 等高危动作,并对生成的查询进行强制验证。
6162
- **2FA**: 集成 Google Authenticator 双重认证。
62-
- **FinOps**: 完整的 Token 消耗监控看板,支持按用户、模型维度的成本拆分。
6363

6464
### ⚙️ 自动化与触达
6565

docs/user_manual.md

Lines changed: 18 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@
1616

1717
系统内主要有三种角色:
1818

19-
- **Admin (管理员)**: 负责系统配置、用户管理、FinOps 监控
20-
- **Developer (开发者/DBA)**: 负责配置数据源、管理知识库、预置复杂任务
21-
- **Operator (运营人员)**: 主要的数据消费者,使用 AI 查询数据、查看报表
19+
- **Admin (管理员)**: 负责系统全盘配置、超级权限下放、以及系统级数据大盘看守
20+
- **Developer (开发者/DBA)**: 负责配置数据源、管理知识库、预置复杂任务模板
21+
- **Operator (运营人员)**: 基础数据消费者,使用 AI 查询数据、查看报表并可建立个人的私人大盘与查询私库
2222

2323
---
2424

@@ -90,7 +90,10 @@ NexQuery 采用先进的 **Multi-Agent** 架构,系统会自动启动多个专
9090
1. 在查询页面调试好 SQL。如果您的 SQL 中包含占位符(如 `WHERE date > '{{date}}'`),系统会自动识别。
9191
2. 点击 **Save as Task**
9292
3. **Parameters (参数配置)**: 系统会自动提取 `{{variable}}` 形式的参数。您需要为每个参数提供 **Default Value** (测试用) 和 **Description** (给其他人看)。
93-
4. **Schedule**: 配置 Cron 表达式。
93+
4. **Visibility (共享可见性)**:
94+
- `Private`: 仅限创建者(及超管)可见与使用。
95+
- `Public`: 把有价值的指标模型发布至系统广场供全员共享执行。
96+
5. **Schedule**: 配置 Cron 表达式。
9497
- `0 9 * * 1` : 每周一早 9 点
9598
- `0 8 * * *` : 每天早 8 点
9699
- **One-off**: 仅执行一次(适合耗时的大数据量跑批)
@@ -125,12 +128,13 @@ NexQuery AI 提供配套微信小程序,方便随时随地看数。
125128
- **PII 自动发现**: 添加数据源后,系统会自动扫描敏感字段。请在 Settings 中复核这些标记,确保手机号、身份证等数据被正确脱敏 (Masking)。
126129
- **Schema Sync**: 建议定期点击 Sync 按钮,确保 AI 掌握最新的表结构。
127130

128-
### 5.2 FinOps 成本监控
131+
### 5.2 数据大盘与视图隔离 (Dashboard Isolation)
129132

130-
访问 **FinOps** 菜单,不仅可以看系统花了多少钱,还能看“谁”花得最多。
133+
系统的仪表盘具备智能防窥发机制:
131134

132-
- **Dashboard**: 查看 Token 消耗趋势。
133-
- **Top Consumers**: 揪出滥用 AI 资源的用户或异常的高频查询模型。
135+
- **上帝视角 (Admin View)**: 作为管理员,您可以俯瞰整个系统的吞吐量、资源载荷,以及 "Top Users" 最活跃用户排行榜。
136+
- **隐私视图 (Operator View)**: 对于非管理员权限的用户,看板会自动将数据面降级为“个人工作台”。只允许聚合和展示其个人产生的查询量及执行图表,自动隐藏全网敏感数据与榜单。
137+
- 您随时可以在右上角无缝切换 **7d / 30d / 90d / 全部** 的监控跨度。
134138

135139
### 5.3 AI 治理与闭环学习 (Feedback)
136140

@@ -173,9 +177,14 @@ NexQuery AI 致力于保障您的数据资产安全。
173177

174178
安全智能体 (Security Agent) 在执行查询结果返回前,会自动识别并屏蔽 PII (Personally Identifiable Information) 数据:
175179

176-
- **模式**: 支持掩码 (Masking)、哈希 (Hashing) 或完全拦截
180+
- **模式**: 支持掩码 (Masking) 等数据掩盖手法
177181
- **范围**: 包含手机号、身份证、邮箱、银行卡号等。
178182

183+
### 6.3 滴水不漏的基础防备 (Execution & Access Constraints)
184+
185+
- **OOM 防爆舱**: 后端对所有的开放查询均设下绝对数据获取上限限制 (LIMIT 1000),确保超巨大查询无法压垮 Node进程与内存。
186+
- **命令防火墙**: 在执行外部命令(如 CURL API 调试时),系统内置的黑名单正则表达式能绝对切断终端逃逸 (RCE) 字符的执行。
187+
179188
---
180189

181190
<div align="center">

0 commit comments

Comments
 (0)