From beb2872b0d1b9f7b9f50012ddb170ff554b70439 Mon Sep 17 00:00:00 2001 From: foxhui Date: Mon, 24 Nov 2025 19:34:20 +0800 Subject: [PATCH] docs: update README content --- README.md | 95 ++++++++++++++++++++++++++++++++++++++++++------------- 1 file changed, 73 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index b96c336..ec0cbd1 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# LMArenaImagenAutomator - 使用文档 +# LMArenaImagenAutomator ## 📝 项目简介 @@ -46,11 +46,12 @@ LMArenaImagenAutomator 是一个基于 Puppeteer 的自动化图像生成工具 ## ⚙️ 配置说明 -### config.yaml 配置文件 +配置文件位于项目根目录下的 `config.yaml`，首次运行时会自动生成默认配置。 -配置文件位于项目根目录下的 `config.yaml`，包含以下主要配置项： +
+📝 查看详细配置说明 -#### 服务器配置 +### 服务器配置 ```yaml server: # 运行模式: 'openai' (OpenAI 兼容) 或 'queue' (SSE 队列) @@ -61,7 +62,7 @@ server: auth: sk-change-me-to-your-secure-key ``` -#### 浏览器配置 +### 浏览器配置 ```yaml chrome: # Chrome 可执行文件路径 (留空使用 Puppeteer 内置版本) @@ -76,7 +77,7 @@ chrome: gpu: false ``` -#### 代理配置 +### 代理配置 ```yaml chrome: proxy: @@ -102,6 +103,9 @@ chrome: | `chrome.headless` | `false` / `true` | 建议保持非无头模式（true已映射为new模式） | | `chrome.gpu` | `false` / `true` | 无显卡环境强烈建议关闭 | +
+ + --- ## 📖 使用方法 @@ -140,7 +144,15 @@ server: auth: your-secret-key ``` -**API 请求示例** +**请求端点** +``` +POST http://127.0.0.1:3000/v1/chat/completions +``` + +
+📄 查看API请求示例 + +**请求示例** ```bash curl -X POST http://127.0.0.1:3000/v1/chat/completions \ -H "Content-Type: application/json" \ @@ -156,14 +168,6 @@ curl -X POST http://127.0.0.1:3000/v1/chat/completions \ }' ``` -> **关于 `model` 参数**： -> - **必填**：必须填写支持的模型名称，否则将使用 LMArena 网页默认模型 -> - **查看可用模型**： -> - 方式 1：访问 `/v1/models` 接口查询 -> - 方式 2：直接查看 `lib/models.js` 文件 -> - **示例模型**：`seedream-4-high-res-fal`、`gemini-3-pro-image-preview`、`dall-e-3` 等 - - **响应格式** ```json { @@ -181,6 +185,14 @@ curl -X POST http://127.0.0.1:3000/v1/chat/completions \ }] } ``` +
+ +> **关于 `model` 参数**： +> - **必填**：必须填写支持的模型名称，否则将使用 LMArena 网页默认模型 +> - **查看可用模型**： +> - 方式 1：访问 `/v1/models` 接口查询 +> - 方式 2：直接查看 `lib/models.js` 文件 +> - **示例模型**：`seedream-4-high-res-fal`、`gemini-3-pro-image-preview`、`dall-e-3` 等 #### 获取可用模型列表 @@ -189,6 +201,9 @@ curl -X POST http://127.0.0.1:3000/v1/chat/completions \ GET http://127.0.0.1:3000/v1/models ``` +
+📄 查看API请求示例 + **请求示例** ```bash curl -X GET http://127.0.0.1:3000/v1/models \ @@ -216,6 +231,8 @@ curl -X GET http://127.0.0.1:3000/v1/models \ } ``` +
+ > **说明**： > - 此接口在 **OpenAI 兼容模式** 和 **Queue 队列模式** 下均可用 > - `created` 字段为当前请求时的时间戳 @@ -245,7 +262,9 @@ POST http://127.0.0.1:3000/v1/queue/join | `heartbeat` | 时间戳 | 保持连接 | | `done` | `"[DONE]"` | 流结束 | -**Node.js 示例代码** +
+📄 查看 Node.js 示例代码 + ```javascript import http from 'http'; @@ -282,6 +301,9 @@ req.write(JSON.stringify({ req.end(); ``` +
+ + > **提示**：Queue 模式同样支持 `model` 参数，用法与 OpenAI 兼容模式一致。 #### 带图片的请求 @@ -290,6 +312,9 @@ req.end(); **最大数量**：5 张图片 **数据格式**：Base64 编码 +
+📄 查看API请求示例 + **请求示例** ```json { @@ -312,6 +337,8 @@ req.end(); } ``` +
+ ### 方式二：使用CLI客户端脚本 **启动CLI工具** @@ -324,6 +351,9 @@ npm test ## 📁 项目结构 +
+🗂️ 查看目录结构 + ``` lmarena/ ├── server.js # HTTP 服务器 (主入口) @@ -340,11 +370,14 @@ lmarena/ └── temp/ # 临时图片存储 ``` +
+ --- ## 🔧 常见问题 -### 浏览器启动失败 +
+❌ 浏览器启动失败 **问题**: `Error: Failed to launch the browser process` @@ -355,7 +388,10 @@ lmarena/ - 检查 `config.yaml` 中的 `chrome.path` 是否正确 - 尝试删除 `data/chromeUserData` 目录后重新运行 -### GPU 相关错误 +
+ +
+❌ GPU 相关错误 **问题**: 无显卡服务器运行时出现 GPU 错误 @@ -366,7 +402,10 @@ chrome: gpu: false # 禁用 GPU 加速 ``` -### 请求被拒绝 (429 Too Many Requests) +
+ +
+❌ 请求被拒绝 (429 Too Many Requests) **问题**: 并发请求过多 @@ -376,7 +415,10 @@ chrome: - 修改 `server.js` 中的 `MAX_CONCURRENT` 和 `MAX_QUEUE_SIZE` (不建议，应为大多数客户端HTTP请求是有超时时间的) - 等待当前任务完成后再提交新任务 -### reCAPTCHA 验证失败 +
+ +
+❌ reCAPTCHA 验证失败 **问题**: 返回 `recaptcha validation failed` @@ -387,7 +429,10 @@ chrome: - 首次使用时手动完成一次验证 (关闭 headless 模式) - 使用稳定和纯净的 IP 地址 (可使用 [ping0.cc](https://ping0.cc) 查询IP地址纯净度) -### 图像生成超时 +
+ +
+❌ 图像生成超时 **问题**: 任务超过 120 秒未完成 @@ -395,7 +440,10 @@ chrome: - 检查网络连接是否稳定 - 某些复杂提示词可能需要更长时间 -### Linux 环境下非无头模式运行 +
+ +
+🐧 Linux 环境下非无头模式运行 **问题**: 需要在 Linux 服务器上显示浏览器界面（如手动过验证码） @@ -425,6 +473,9 @@ chrome: ``` 随后使用 VNC 客户端连接 `127.0.0.1:5900` 即可。 +
+ + --- ## 📊 设备配置