docs: 更新 README 与 API 文档,描述提示词优化链路

- README 新增提示词优化链路章节(流程图 + 特性 + API 说明)
- docs/api.md 新增提示词优化接口文档与调用链路
- 更新架构描述:PromptBuilder → PromptOptimizer
This commit is contained in:
2026-05-24 20:45:24 +08:00
parent 9ca1e65221
commit 36a6465f26
6 changed files with 244 additions and 41 deletions
+56 -5
View File
@@ -172,6 +172,57 @@ Token 过期或无效时返回:
|------|------|---------|
| 原密码错误 | 400 | 原密码不正确 |
## 提示词优化
将用户标签和原始描述送入 LLM,生成规范化三段式提示词。前端组件收集用户标签和原始提示词后,调用本接口获取优化结果,用于预览或直接发起素材生成。
| 状态 | 方法 | 路径 | 说明 |
|------|------|------|------|
| [x] | POST | `/api/v1/prompt/optimize` | 提示词优化 |
### POST /api/v1/prompt/optimize
```json
{
"tags": ["像素", "战士", "黑暗"],
"assetType": "sprite",
"prompt": "我要一个拿着大剑的战士角色,背景是黑暗地牢",
"userNote": "需要武器发光特效"
}
```
| 字段 | 类型 | 必填 | 说明 |
|------|------|------|------|
| `tags` | string[] | 是 | 用户选择的风格标签,至少 1 个 |
| `assetType` | string | 是 | 素材类型:`sprite` / `background` / `ui` / `animation` |
| `prompt` | string | 否 | 用户输入的原始提示词描述 |
| `userNote` | string | 否 | 额外补充说明 |
响应:
```json
{
"code": 0,
"message": "ok",
"data": {
"prompt": "【主题】一个融合像素、战士元素的游戏角色精灵图...\n【风格】色彩鲜明;细节丰富...\n【技术】输出格式: spritesheet...",
"rawText": "【主题】一个融合像素..."
}
}
```
**链路:**
```
POST /api/v1/prompt/optimize
→ handler.PromptOptimize 解析请求
→ service.RunPromptAgent 执行 Eino Chain
→ formatMetaPrompt: 构建元提示词(角色设定 + 标签 + 原始描述 + 素材类型)
→ llmRefine: 调用 OpenAI 兼容 Chat Completions API
└── 无 API key → 回退模板生成
→ 返回 PromptAgentOutput { prompt, rawText }
```
## 工程管理
需认证。以下接口均需通过 Cookie 携带 Token,工程归属于当前登录用户。
@@ -358,7 +409,7 @@ Token 过期或无效时返回:
| 字段 | 类型 | 必填 | 说明 |
|------|------|------|------|
| `projectId` | string | 是 | 工程 ID,用于获取工程风格 |
| `prompt` | string | 是 | 用户原始文本,后端 PromptBuilder 负责三段式重写 |
| `prompt` | string | 是 | 用户原始文本,后端 PromptOptimizer/PromptAgent 负责提示词优化 |
| `assetType` | string | 是 | 素材类型:`sprite` / `background` / `ui` / `animation` |
| `taskStyle` | object | 否 | 任务级别风格覆盖(同名键覆盖工程风格) |
| `params.resolution` | int | 否 | 分辨率,默认 64 |
@@ -466,7 +517,7 @@ Token 过期或无效时返回:
```typescript
interface PipelineProgress {
stage: 'prompt_builder' | 'asset_generator' | 'quality_supervisor' | 'format_adapter';
stage: 'prompt_optimizer' | 'asset_generator' | 'quality_supervisor' | 'format_adapter';
status: 'running' | 'completed' | 'failed';
progress: number; // 0-100
message?: string; // 阶段描述
@@ -482,8 +533,8 @@ interface PipelineProgress {
消息示例(正常流程):
```json
{"stage":"prompt_builder","status":"running","progress":0}
{"stage":"prompt_builder","status":"completed","progress":100}
{"stage":"prompt_optimizer","status":"running","progress":0}
{"stage":"prompt_optimizer","status":"completed","progress":100}
{"stage":"asset_generator","status":"running","progress":0}
{"stage":"asset_generator","status":"completed","progress":100}
{"stage":"quality_supervisor","status":"running","progress":0}
@@ -497,7 +548,7 @@ interface PipelineProgress {
```json
{"stage":"quality_supervisor","status":"running","progress":0}
{"stage":"quality_supervisor","status":"failed","progress":100,"retryCount":1,"rejectReason":"风格不一致"}
{"stage":"prompt_builder","status":"running","progress":0}
{"stage":"prompt_optimizer","status":"running","progress":0}
{"stage":"asset_generator","status":"running","progress":0}
{"stage":"quality_supervisor","status":"completed","progress":100}
{"stage":"format_adapter","status":"completed","progress":100,"result":{"assets":[...]}}