my_meeting/README.md

123 lines
2.6 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters!

This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.

# meeting
一个用于生成会议纪要的简单项目,支持:
- 命令行处理会议转写文本
- Web 页面导入会议原文并生成纪要
- 使用模板控制纪要输出格式
- 输出结构化主题和 Markdown 纪要
## 功能说明
项目会基于会议原文完成两步处理:
1. 提取会议子主题,输出 `sub_topic.json`
2. 按模板生成会议纪要,输出 `meeting_summary.md`
## 安装依赖
建议使用 Python 3.10+
```bash
pip install -r requirements.txt
```
## 配置模型
Web 端会读取根目录下的 `config.json`,其中包含:
- `api_base_url`
- `api_key`
- `model_name`
- `max_tokens`
如果你使用自己的模型服务,先修改这个文件。
说明:命令行脚本当前通过 `agents/chat.py` 内的固定配置调用模型Web 端使用 `config.json`
## 命令行用法
按会议 ID 处理:
```bash
python meeting_summary.py --meeting-id 你的会议ID
```
按文件路径处理:
```bash
python meeting_summary.py --input examples/huiyi.txt
```
指定模板:
```bash
python meeting_summary.py --input examples/huiyi.txt --template template1.md
```
## 启动 Web
```bash
python -m uvicorn web.server:app --reload
```
启动后访问:
```text
http://127.0.0.1:8000
```
## 目录结构
```text
meeting/
├─ agents/ # 模型调用
├─ data/
│ ├─ meetings/ # 会议原文
│ └─ results/
│ ├─ json/ # 子主题结果
│ └─ md/ # 会议纪要结果
├─ examples/ # 示例输入输出
├─ frontend/ # 前端页面
├─ prompt/ # Prompt 配置
├─ template/ # 纪要模板
├─ template_guides/ # 模板说明
├─ web/ # FastAPI 服务
└─ meeting_summary.py # 命令行入口
```
## 输入与输出
输入支持:
- `txt`
- `md`
输出位置:
- 命令行传 `--meeting-id`
- `data/results/json/<meeting_id>/sub_topic.json`
- `data/results/md/<meeting_id>/meeting_summary.md`
- 命令行传 `--input`
- `examples/sub_topic.json`
- `examples/meeting_summary.md`
- Web 端处理:
- `data/results/json/<meeting_id>/sub_topic.json`
- `data/results/md/<meeting_id>/meeting_summary.md`
## 模板相关
- 模板文件放在 `template/`
- 模板说明放在 `template_guides/`
- Web 端支持导入模板、编辑模板、重新解析模板说明
## 示例
项目内提供了示例文件:
- `examples/huiyi.txt`
- `examples/sub_topic.json`
- `examples/meeting_summary.md`
适合先用它们验证流程是否正常。