mirror of
https://github.com/hellodigua/ChatLab.git
synced 2026-05-24 07:30:52 +08:00
docs: 新增官网文档并支持自动化同步和构建
This commit is contained in:
digua
@@ -0,0 +1,23 @@
|
||||
---
|
||||
outline: deep
|
||||
---
|
||||
|
||||
# 常见问题
|
||||
|
||||
这里汇总 ChatLab 使用中高频出现的问题与处理思路。
|
||||
|
||||
## 导出问题
|
||||
|
||||
待补充。
|
||||
|
||||
## 导入问题
|
||||
|
||||
待补充。
|
||||
|
||||
## AI相关问题
|
||||
|
||||
待补充。
|
||||
|
||||
## 软件异常报错问题
|
||||
|
||||
待补充。
|
||||
@@ -0,0 +1,31 @@
|
||||
---
|
||||
outline: deep
|
||||
---
|
||||
|
||||
# 如何配置 AI 模型
|
||||
|
||||
## 在线 AI 模型
|
||||
|
||||
这里以 deepseek 为例，其他的模型请自行搜索配置方法：
|
||||
|
||||
1. 访问 [Deepseek 官网](https://www.deepseek.com/)，选择 API 开放平台，注册并登录
|
||||
|
||||
|
||||
|
||||
2. 选择左侧充值，充值你所需要的金额（建议先充 10 块钱，足够用很久了）
|
||||
|
||||
|
||||
|
||||
3. 选择左侧 API Keys，点击创建 API key，随便填写一个标题，然后复制 API Key
|
||||
|
||||
|
||||
|
||||
4. 打开 ChatLab，右下角点击设置，然后「模型配置」>「添加新配置」
|
||||
|
||||
把刚才复制的 API Key 填写到 API Keys 中，点击验证确认没问题后，点击右下角添加后，即可开始使用 AI 相关功能
|
||||
|
||||
|
||||
|
||||
5. 在左侧的用量信息中，你可以查看你充值和消费的额度
|
||||
|
||||
|
||||
@@ -0,0 +1,5 @@
|
||||
---
|
||||
outline: deep
|
||||
---
|
||||
|
||||
<HowToExportCNDoc />
|
||||
@@ -0,0 +1,18 @@
|
||||
---
|
||||
outline: deep
|
||||
---
|
||||
|
||||
# 导入聊天记录指南
|
||||
|
||||
完成导出后，您只需在 ChatLab 的首页：
|
||||
|
||||
1. 将导出的**数据文件**直接拖入上传区域。
|
||||
2. 等待 ChatLab 解析完成即可。
|
||||
|
||||
## BUG 排查
|
||||
|
||||
如果导入失败，可以通过日志快速排查问题：
|
||||
|
||||
软件左下角「设置」 > 「基础设置」 > 「日志文件」，打开该目录，该目录下有个「import」目录，就是所有导入的日志记录了。
|
||||
|
||||
如果您看不懂，可以通过 Github issue 提交问题。
|
||||
@@ -0,0 +1,5 @@
|
||||
---
|
||||
outline: deep
|
||||
---
|
||||
|
||||
# USAGE
|
||||
@@ -0,0 +1,50 @@
|
||||
# Q&A
|
||||
|
||||
## 未来会支持音频、图片导入吗？
|
||||
|
||||
不确定，目前的文本分析功能仍然有非常多的 TODO 需要实现，计划文本分析的功能完善之后再考虑音频和图片的分析。
|
||||
|
||||
## 如何直接访问本地数据库
|
||||
|
||||
ChatLab 使用 SQLite 存储聊天记录，你可以用任何 SQLite 客户端工具直接查看数据。
|
||||
|
||||
### 数据库位置
|
||||
|
||||
你可直接通过软件的 设置 > 存储管理 > 聊天记录数据库 > 打开，打开数据库所在文件夹。
|
||||
|
||||
| 平台 | 路径 |
|
||||
| ------- | ------------------------------------------------------- |
|
||||
| macOS | `~/Library/Application Support/ChatLab/data/databases/` |
|
||||
| Windows | `%APPDATA%/ChatLab/data/databases/` |
|
||||
| Linux | `~/.config/ChatLab/data/databases/` |
|
||||
|
||||
每个聊天记录是一个独立的 `.db` 文件。
|
||||
|
||||
### 推荐工具
|
||||
|
||||
- [DB Browser for SQLite](https://sqlitebrowser.org/) - 免费开源，新手友好
|
||||
- [TablePlus](https://tableplus.com/) - 界面美观
|
||||
- [DBeaver](https://dbeaver.io/) - 功能强大
|
||||
|
||||
### 命令行访问
|
||||
|
||||
```bash
|
||||
# macOS/Linux
|
||||
sqlite3 ~/Library/Application\ Support/ChatLab/data/databases/你的数据库.db
|
||||
|
||||
# 常用命令
|
||||
.tables # 查看所有表
|
||||
.schema message # 查看 message 表结构
|
||||
SELECT * FROM message LIMIT 10; # 查询消息
|
||||
```
|
||||
|
||||
### 表结构
|
||||
|
||||
- `meta` - 聊天记录元信息
|
||||
- `member` - 成员信息
|
||||
- `message` - 消息内容
|
||||
- `member_name_history` - 成员改名历史
|
||||
|
||||
### 注意事项
|
||||
|
||||
⚠️ 建议在 ChatLab **关闭时**访问数据库，避免锁冲突。
|
||||
@@ -0,0 +1,81 @@
|
||||
---
|
||||
outline: deep
|
||||
---
|
||||
|
||||
# 故障排查指南
|
||||
|
||||
本文档帮助用户和开发者排查 ChatLab 使用中遇到的问题。
|
||||
|
||||
## 日志文件
|
||||
|
||||
**获取日志文件**：软件左下角的 **「设置」 > 「存储管理」 > 「日志文件」 > 打开目录**
|
||||
|
||||
日志存储在 `文档/ChatLab/logs/` 目录下：
|
||||
|
||||
```
|
||||
ChatLab/logs/
|
||||
├── app.log # 主程序日志
|
||||
├── ai/ # AI 相关日志
|
||||
│ └── ai_YYYY-MM-DD_HH-mm.log
|
||||
└── import/ # 导入日志
|
||||
└── import_{sessionId}_{timestamp}.log
|
||||
```
|
||||
|
||||
### 日志文件说明
|
||||
|
||||
| 目录/文件 | 内容 |
|
||||
| -------------- | ------------------------------------------------ |
|
||||
| `app.log` | 主程序日志，包含文件解析、数据库操作、IPC 通信等 |
|
||||
| `ai/*.log` | AI 日志，包含 LLM 调用、Agent 执行、工具调用等 |
|
||||
| `import/*.log` | 导入性能日志，包含导入速度、内存使用、各阶段耗时 |
|
||||
|
||||
## 常见问题
|
||||
|
||||
### 1. 导入失败
|
||||
|
||||
**症状**：拖入文件后提示解析失败
|
||||
|
||||
**排查步骤**：
|
||||
|
||||
1. 确认文件格式是否支持（.json / .jsonl / .txt）
|
||||
2. 检查文件是否损坏（用文本编辑器打开查看）
|
||||
3. 查看日志文件中的 `[Parser]` 相关错误
|
||||
|
||||
### 2. AI 功能无响应
|
||||
|
||||
**症状**：AI 实验室发送消息后无回复
|
||||
|
||||
**排查步骤**：
|
||||
|
||||
1. 检查是否已配置 API Key（设置 > AI 设置）
|
||||
2. 点击「验证」，确认 API 连接正常
|
||||
3. 查看日志文件中的 `[LLM]` 或 `[Agent]` 相关错误
|
||||
|
||||
**常见原因**：
|
||||
|
||||
- API Key 无效或余额不足
|
||||
- API 服务商限流
|
||||
|
||||
### 3. 数据库错误
|
||||
|
||||
**症状**：打开会话时提示错误
|
||||
|
||||
**排查步骤**：
|
||||
|
||||
1. 查看日志文件中的 `[Database]` 相关错误
|
||||
2. 检查数据库文件是否存在
|
||||
|
||||
## 反馈问题
|
||||
|
||||
如果以上方法无法解决问题，请：
|
||||
|
||||
1. 收集日志文件
|
||||
2. 描述问题复现步骤
|
||||
3. 提交 Issue 到 GitHub
|
||||
|
||||
**提交 Issue 时请包含**：
|
||||
|
||||
- 操作系统及版本
|
||||
- ChatLab 版本
|
||||
- 问题描述及复现步骤
|
||||
- 相关日志片段（注意脱敏）
|
||||
Reference in New Issue
Block a user