mirror of
https://github.com/foxhui/WebAI2API.git
synced 2026-06-16 21:03:59 +08:00
docs: 更新文档
This commit is contained in:
@@ -33,6 +33,7 @@ http://localhost:3000
|
||||
- 登录模式重启
|
||||
- 指定 Worker 登录
|
||||
- 停止服务
|
||||
- 适配器设置 (适配器描述,模型管理,功能开关)
|
||||
|
||||
- **缓存管理**
|
||||
- 查看临时文件
|
||||
|
||||
@@ -24,18 +24,6 @@ Content-Type: application/json
|
||||
| GET | `/v1/models` | 获取模型列表 |
|
||||
| GET | `/v1/cookies` | 获取 Cookie |
|
||||
|
||||
### 管理接口
|
||||
|
||||
| 方法 | 端点 | 说明 |
|
||||
| --- | --- | --- |
|
||||
| GET | `/admin/status` | 服务状态 |
|
||||
| GET | `/admin/stats` | 统计信息 |
|
||||
| GET | `/admin/queue` | 队列状态 |
|
||||
| POST | `/admin/restart` | 重启服务 |
|
||||
| POST | `/admin/stop` | 停止服务 |
|
||||
| GET | `/admin/vnc/status` | VNC 状态 |
|
||||
| POST | `/admin/cache/clear` | 清理缓存 |
|
||||
|
||||
## 错误响应
|
||||
|
||||
所有 API 错误返回统一格式:
|
||||
|
||||
@@ -74,6 +74,51 @@ backend:
|
||||
| `nanobananafree_ai` | Nano Banana Free |
|
||||
| `merge` | 聚合模式(单标签多后端) |
|
||||
|
||||
## 模型过滤器 (Model Filter)
|
||||
|
||||
每个适配器都可以配置专属的模型黑白名单,用于控制该适配器可以使用的模型列表。
|
||||
|
||||
### 配置方式
|
||||
|
||||
模型过滤器配置在 `backend.adapter.<适配器ID>` 下:
|
||||
|
||||
```yaml
|
||||
backend:
|
||||
adapter:
|
||||
lmarena:
|
||||
returnUrl: false
|
||||
modelFilter:
|
||||
mode: whitelist # 白名单whitelist 黑名单blacklist
|
||||
list: # 仅启用和仅禁用的模型列表
|
||||
- gemini-3-pro-image-preview
|
||||
- gemini-3-pro-image-preview-2k
|
||||
- gemini-2.5-flash-image-preview
|
||||
```
|
||||
|
||||
### 配置项说明
|
||||
|
||||
| 配置项 | 类型 | 必填 | 说明 |
|
||||
| --- | --- | --- | --- |
|
||||
| `mode` | string | ✅ | 过滤模式:`whitelist` 或 `blacklist` |
|
||||
| `list` | array | ✅ | 模型ID列表 |
|
||||
|
||||
### 过滤模式
|
||||
|
||||
- **whitelist (白名单模式)**:仅允许列表中指定的模型,其他模型将被过滤掉
|
||||
- **blacklist (黑名单模式)**:禁用列表中指定的模型,其他模型可正常使用
|
||||
|
||||
### 使用建议
|
||||
|
||||
::: tip 推荐使用 WebUI 配置
|
||||
推荐使用 WebUI 的适配器设置界面进行模型过滤器配置,可视化操作更加便捷。
|
||||
:::
|
||||
|
||||
::: warning 注意事项
|
||||
- 模型 ID 必须与适配器实际支持的模型 ID 完全匹配
|
||||
- 白名单模式下,如果列表为空或没有匹配的模型,将无法使用该适配器
|
||||
- 每个适配器的模型过滤器配置相互独立
|
||||
:::
|
||||
|
||||
## 聚合模式 (Merge)
|
||||
|
||||
聚合模式允许在单个标签页中支持多个后端,实现故障转移:
|
||||
|
||||
@@ -84,6 +84,36 @@ browser:
|
||||
| `headless` | boolean | `false` | 是否启用无头模式 |
|
||||
| `proxy` | object | - | 全局代理配置 |
|
||||
|
||||
### 适配器配置 (backend.adapter)
|
||||
|
||||
每个适配器都可以配置专属的模型黑白名单,用于控制该适配器可以使用的模型列表。
|
||||
|
||||
| 配置项 | 类型 | 默认值 | 说明 |
|
||||
| --- | --- | --- | --- |
|
||||
| `modelFilter.mode` | string | - | 过滤模式:`whitelist` (白名单) 或 `blacklist` (黑名单) |
|
||||
| `modelFilter.list` | array | - | 模型列表(根据 mode 决定是启用列表还是禁用列表) |
|
||||
|
||||
::: tip 模型过滤说明
|
||||
- **whitelist (白名单模式)**:仅允许列表中的模型
|
||||
- **blacklist (黑名单模式)**:禁用列表中的模型,其他模型可用
|
||||
- 推荐使用 WebUI 进行配置
|
||||
:::
|
||||
|
||||
配置示例:
|
||||
|
||||
```yaml
|
||||
backend:
|
||||
adapter:
|
||||
lmarena:
|
||||
returnUrl: false
|
||||
modelFilter:
|
||||
mode: whitelist # 白名单模式
|
||||
list: # 仅启用以下模型
|
||||
- gemini-3-pro-image-preview
|
||||
- gemini-3-pro-image-preview-2k
|
||||
- gemini-2.5-flash-image-preview
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [实例配置](/config/instances) - 浏览器实例和 Worker 详细配置
|
||||
|
||||
@@ -43,7 +43,7 @@ http://localhost:3000
|
||||
- Windows: 直接在弹出的浏览器窗口中操作
|
||||
|
||||
2. **完成账号登录**:
|
||||
- 手动登录所需的 AI 网站账号
|
||||
- 手动登录所需的 AI 网站账号 (账号要求可进入 WebUI 的适配器管理中查看)
|
||||
- 在输入框发送任意消息, 触发并完成人机验证 (如需要)
|
||||
- 同意服务条款或者新手指引 (如需要)
|
||||
- 确保不再有初次使用相关内容的阻拦
|
||||
|
||||
Reference in New Issue
Block a user