116 lines
2.7 KiB
Markdown
116 lines
2.7 KiB
Markdown
# Creative Studio Backend
|
||
|
||
基于 FastAPI 的 AI 剧集创作平台后端服务。
|
||
|
||
## 快速开始
|
||
|
||
详细的快速启动指南请参考项目根目录的 [README.md](../README.md)。
|
||
|
||
### 安装依赖
|
||
|
||
```bash
|
||
pip install -r requirements.txt
|
||
```
|
||
|
||
### 配置环境变量
|
||
|
||
```bash
|
||
cp .env.example .env
|
||
# 编辑 .env 文件，填入 ZAI_API_KEY
|
||
```
|
||
|
||
### 启动服务
|
||
|
||
```bash
|
||
uvicorn app.main:app --reload
|
||
```
|
||
|
||
### 访问 API 文档
|
||
|
||
- Swagger UI: http://localhost:8000/docs
|
||
- ReDoc: http://localhost:8000/redoc
|
||
|
||
## 技术栈
|
||
|
||
- Python 3.11+
|
||
- FastAPI
|
||
- MongoDB
|
||
- Redis
|
||
- zai-sdk (智谱 AI SDK)
|
||
|
||
## 主要功能
|
||
|
||
- Skill 管理系统
|
||
- 项目管理
|
||
- 记忆系统
|
||
- 审核系统
|
||
- Agent 执行引擎
|
||
|
||
## 开发指南
|
||
|
||
完整的开发指南请参考 [DEVELOPMENT_GUIDE.md](../DEVELOPMENT_GUIDE.md)。
|
||
|
||
## 项目结构
|
||
|
||
```
|
||
backend/
|
||
├── app/
|
||
│ ├── main.py # 应用入口
|
||
│ ├── config.py # 配置管理
|
||
│ ├── api/v1/ # API 路由
|
||
│ ├── core/ # 核心业务逻辑
|
||
│ │ ├── llm/ # GLM 客户端
|
||
│ │ ├── skills/ # Skill 管理器
|
||
│ │ ├── agents/ # Agent 执行引擎
|
||
│ │ ├── memory/ # 记忆系统
|
||
│ │ └── review/ # 审核系统
|
||
│ ├── models/ # 数据模型
|
||
│ └── utils/ # 工具函数
|
||
│
|
||
├── skills_storage/ # Skill 文件存储
|
||
│ ├── builtin_skills/ # 内置 Skills
|
||
│ └── user_skills/ # 用户 Skills
|
||
│
|
||
└── requirements.txt
|
||
```
|
||
|
||
## API 端点
|
||
|
||
详细的 API 文档请参考 [docs/API.md](../docs/API.md)。
|
||
|
||
### Skill 管理
|
||
|
||
| 端点 | 方法 | 描述 |
|
||
|-----|------|------|
|
||
| `/api/v1/skills` | GET | 列出所有 Skills |
|
||
| `/api/v1/skills/{id}` | GET | 获取 Skill 详情 |
|
||
| `/api/v1/skills` | POST | 创建新 Skill |
|
||
| `/api/v1/skills/{id}/test` | POST | 测试 Skill |
|
||
| `/api/v1/skills/{id}` | PUT | 更新 Skill |
|
||
| `/api/v1/skills/{id}` | DELETE | 删除 Skill |
|
||
|
||
### 项目管理
|
||
|
||
| 端点 | 方法 | 描述 |
|
||
|-----|------|------|
|
||
| `/api/v1/projects` | GET | 列出项目 |
|
||
| `/api/v1/projects` | POST | 创建项目 |
|
||
| `/api/v1/projects/{id}` | GET | 获取项目详情 |
|
||
| `/api/v1/projects/{id}/execute` | POST | 执行剧集创作 |
|
||
|
||
## 常见问题
|
||
|
||
### 如何获取智谱 AI API Key？
|
||
|
||
访问 [智谱AI开放平台](https://open.bigmodel.cn/usercenter/apikeys) 创建 API Key。
|
||
|
||
### 支持哪些模型？
|
||
|
||
- `glm-4-flash` - 快速响应模型（推荐）
|
||
- `glm-4-plus` - 高质量模型
|
||
- `glm-4-0520` - 稳定版本
|
||
|
||
## 许可证
|
||
|
||
MIT License
|