1 line
4.9 KiB
JSON
1 line
4.9 KiB
JSON
{"repo": "14790897/lazyllm-ancient-chinese", "files": {"readme.md": {"d6eacf1a8d21b8b516cab7d20e5b8cf60c3f4dfa": {"t": 1785768259.8288946, "n": 2664, "h": "9e765224a3cb513b", "c": "# 古文写作助手 (Ancient Writing Assistant)\n\n🖋️ 基于 LazyLLM 和商汤大模型的智能古文写作助手，能够创作各种体裁的古文作品，包括散文、骈文、诗词、赋、记、序等。\n\n## ✨ 特性\n\n- 🎨 **多种文体支持**: 散文、骈文、诗词、赋、记、序等经典文体\n- 🎭 **多种语言风格**: 典雅、豪放、婉约、庄重等不同风格\n- 📏 **灵活篇幅控制**: 简短、中等、详细三种篇幅选择\n- 🔍 **RAG 检索增强**: 基于文档库提供参考资料，提升创作质量\n- ⚙️ **易于配置**: 模块化配置，便于自定义提示词和参数\n- 💬 **交互式体验**: 友好的命令行交互界面\n\n## 🏗️ 项目结构\n\n```text\nlazyllm-test/\n├── ancient_writing_assistant.py # 主程序文件\n├── writing_config.py # 配置文件（提示词、设置等）\n├── simple_writer.py # 简化版本（不依赖RAG）\n├── docs/ # 文档资料库\n├── test.py # 基础测试文件\n├── rag.py # RAG版本实现\n└── readme.md # 项目说明\n```\n\n## 输出演示\n\n\n\n## 🚀 快速开始\n\n### 环境要求\n\n- Python 3.8+\n- LazyLLM 库\n- python-dotenv 库\n- 商汤 SenseNova API 密钥\n\n### 安装依赖\n\n```bash\npip install -r requirements.txt\n```\n\n### 配置 API 密钥\n\n1. 复制环境变量模板：\n\n ```bash\n cp .env.example .env\n ```\n\n2. 编辑 `.env` 文件，填入您的 API 密钥：\n\n ```env\n LAZYLLM_SENSENOVA_API_KEY=your-actual-api-key-here\n ```\n\n3. 或者运行配置工具：\n ```bash\n python setup_env.py\n ```\n\n### 运行程序\n\n```bash\npython ancient_writing_assistant.py\n```\n\n## 📖 使用方法\n\n### 基本使用\n\n1. 运行程序后，输入您的写作需求\n2. 选择文体类型（散文/骈文/诗词/赋/记/序）\n3. 选择语言风格（典雅/豪放/婉约/庄重）\n4. 选择篇幅长度（简短/中等/详细）\n5. 系统将基于您的需求创作古文作品\n\n### 支持的文体\n\n| 文体 | 特点 | 适用场景 |\n| -------- | ------------------ | ------------------ |\n| **散文** | 形散神聚，语言流畅 | 抒情、写景、议论 |\n| **骈文** | 对偶工整，辞藻华丽 | 正式场合、颂扬 |\n| **诗词** | 格律严谨，意境深远 | 抒发情感、咏物言志 |\n| **赋** | 铺陈渲染，气势恢宏 | 描写事物、表达志向 |\n| **记** | 记叙为主，寓意深刻 | 记事、游记、传记 |\n| **序** | 逻辑清晰，升华主题 | 序言、前言、引言 |\n\n### 示例\n\n#### 示例 1：山水散文\n\n```\n需求：描写春日山水之美，表达对自然的热爱\n```\n\n#### 示例 2：思乡诗词\n\n```\n需求：表达游子思念故乡的情感\n```\n\n#### 示例 3：友谊骈文\n\n```\n需求：赞颂真挚友谊的珍贵\n```\n\n## ⚙️ 配置定制\n\n### 调整模型设置\n\n在 `WritingSettings` 类中修改：\n\n- `MODEL_SOURCE`: 模型来源\n- `MODEL_NAME`: 模型名称\n- `RETRIEVAL_TOPK`: 检索返回数量\n- `DEFAULT_*`: 默认参数\n\n## 📚 文档资料库\n\n项目支持基于 RAG 的增强生成：\n\n1. 将参考文档放入 `docs/` 目录\n2. 系统会自动建立文档索引\n3. 创作时会检索相关内容作为参考\n4. 推荐放入经典古文作品，如：\n - 《前赤壁赋》\n - 《岳阳楼记》\n - 《桃花源记》\n - 《阿房宫赋》\n - 《滕王阁序》\n - 《兰亭集序》\n\n## 🛠️ 开发指南\n\n### 文件说明\n\n- `ancient_writing_assistant.py`: 完整功能的主程序\n\n### 自定义开发\n\n1. 继承 `AncientWritingAssistant` 类\n2. 重写 `set_prompt()` 方法自定义提示词\n3. 修改 `write()` 方法调整生成逻辑\n\n### 扩展功能\n\n- 添加新的文体类型\n- 集成更多大语言模型\n- 支持批量生成\n- 添加作品评分功能\n- 实现 Web 界面\n\n## ❓ 常见问题\n\n### Q: 如何提高生成质量？\n\nA:\n\n1. 丰富 `docs/` 目录中的参考资料\n2. 细化提示词描述\n3. 选择合适的文体和风格\n4. 提供更具体的创作需求\n\n### Q: 支持哪些大语言模型？\n\nA: 目前主要支持商汤 SenseNova 系列模型，可通过修改配置支持其他 LazyLLM 兼容模型\n\n## 🤝 贡献\n\n欢迎提交 Issue 和 Pull Request！\n\n## 📄 许可证\n\nMIT License\n\n## 🙏 致谢\n\n- [LazyLLM](https://github.com/LazyAGI/LazyLLM) - 优秀的 LLM 应用框架\n- 商汤科技 - 提供强大的大语言模型支持\n- 中华古典文学 - 为项目提供灵感源泉\n\n---\n\n_让 AI 帮助传承和创新中华古典文学之美_ ✨\n"}}}} |