| .env.example | ||
| .gitignore | ||
| .python-version | ||
| app.py | ||
| main.py | ||
| Project_Design.md | ||
| pyproject.toml | ||
| README.md | ||
| uv.lock | ||
SmartNotes (智能笔记助手)
一句话描述: 一个利用 AI 将碎片化笔记转化为结构化知识并在生成测验的智能助手。
核心功能
- 智能整理: 自动将杂乱的文本整理为清晰的层级结构(标题、要点)。
- 自动摘要: 提炼核心观点,生成简洁摘要。
- 互动测验: 基于笔记内容生成选择题,帮助巩固记忆。
🛠️ 拉取与运行指南 (Installation & Run)
1. 克隆项目 (Clone)
首先将项目代码拉取到本地:
git clone http://hblu.top:3000/Python2025-CourseDesign/zhangjiansunhe.git
cd zhangjiansunhe
2. 安装依赖 (Install Dependencies)
本项目推荐使用 uv 进行快速包管理:
# 如果未安装 uv
curl -LsSf https://astral.sh/uv/install.sh | sh
# 同步依赖
uv sync
3. 启动应用 (Run App)
uv run streamlit run app.py
📖 操作指南
1. 配置设置 (Configuration)
在左侧侧边栏进行基础设置:
- 服务提供商: 根据你拥有的 API Key 选择
OpenAI或DeepSeek。 - API Key: 输入你的 API 密钥(输入框会自动隐藏内容以保护隐私)。
- Base URL:
- 选择提供商后会自动填充默认地址。
- 如果使用中转服务(如 AIHubMix),请手动修改为中转商提供的 Base URL。
- 模型选择:
- OpenAI: 推荐
gpt-4o(效果最好) 或gpt-4o-mini(性价比高)。 - DeepSeek: 推荐
deepseek-chat(通用) 或deepseek-reasoner(推理增强)。
- OpenAI: 推荐
2. 核心功能使用
A. 📝 智能整理与摘要
- 在主界面的文本框中粘贴你的原始笔记(支持杂乱的会议记录、课堂速记等)。
- 在下方单选框中选择 "整理 & 摘要"。
- 点击 "🚀 开始处理" 按钮。
- 结果: 右侧栏将显示:
- 核心摘要: 3-5句话提炼的内容精华。
- 结构化笔记:这是修复语病并重新排版后的 Markdown 笔记。
B. 🧠 生成测验
- 同样粘贴笔记内容。
- 选择 "生成测验" 选项。
- 点击开始处理。
- 结果: AI 将生成 3 道单项选择题,每道题都包含:
- 题目描述
- 4 个选项
- 折叠的答案与解析(点击可展开查看,方便自测)。
3.常见问题
- 报错 "Invalid API Key": 请检查 Key 是否复制完整,或是否选对了提供商。
- 响应慢: AI 思考需要时间,特别是 DeepSeek-R1 (Reasoner) 模型,请耐心等待。
团队成员与贡献
| 姓名 | 学号 | 主要贡献 (具体分工) |
|---|---|---|
| 程俊 | 2411020113 | (组长) 核心逻辑开发、Prompt 编写 |
| 张健 | 2411020104 | 前端界面设计 |
| 孙赫 | 2411020105 | 文档撰写、测试与 Bug 修复 |