tt/ttstd-infinite-canvas
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

refactor(*): 平台架构 - 拆分后端领域模块并同步插件协议与模型能力

Browse Source
This commit is contained in:
ddCat
2026-09-11 14:02:49 +08:00
parent 0945115e53
commit 7ce967df0f
644 changed files with 62731 additions and 2320 deletions
Download Patch File Download Diff File Expand all files Collapse all files

406
plugin-packages/rolldek-wan-video/docs/interface.md Normal file
View File

@@ -0,0 +1,406 @@
# RollDek WAN 3.0 Video 接口字段
## 协议身份
- 插件 ID：`rolldek-wan-video`。
- Provider ID：`rolldek-wan-video`。
- 能力：`video`。
- 默认 Base URL：`https://rolldek.com`。
- 鉴权驱动：`bearer`。
- 创建：`POST /v1/videos`。
- 查询：`GET /v1/videos/{{taskId}}`。
## 配置字段
| 字段 | 类型 | 必填 | 含义 |
| --- | --- | --- | --- |
| `apiKey` | secret | 是 | API Key |
## 统一字段映射
| 统一字段 | 类型 | 必填 | 上游映射 | 说明 |
| --- | --- | --- | --- | --- |
| `model` | string | 是 | `model` | 视频模型 ID。 |
| `prompt` | string | 是 | `prompt/content/input` | 视频提示词。 |
| `images` | media[] | 否 | `first/last/reference image` | 显式 role 图片输入。 |
| `videos` | media[] | 否 | `reference video` | 参考视频。 |
| `audios` | media[] | 否 | `reference audio/voice` | 参考音频或音色。 |
| `duration` | integer | 否 | `duration/seconds` | 时长秒数。 |
| `aspectRatio` | string | 否 | `ratio/aspect_ratio/size` | 画幅比例或尺寸。 |
| `resolution` | string | 否 | `resolution` | 分辨率档位。 |
| `generateAudio` | boolean | 否 | `generate_audio` | 是否生成音频。 |
| `watermark` | boolean | 否 | `watermark` | 水印开关。 |
| `providerOptions` | object | 否 | `provider-specific fields` | 插件命名空间内的厂商扩展字段。 |
## 上游请求模板逐字段清单
下表由插件请求模板生成，覆盖 body、query、headers 和 multipart 文件声明中的每个字段。
| 上游位置 | 值或转换表达式 |
| --- | --- |
| `create.method` | `"POST"` |
| `create.path` | `"/v1/videos"` |
| `create.contentType` | `"application/json"` |
| `create.body.model` | `{"$ref":"request.model"}` |
| `create.body.prompt` | `{"$ref":"request.prompt"}` |
| `create.body.seconds` | `{"$toString":{"$ref":"request.duration"}}` |
| `create.body.size` | `{"$omitEmpty":{"$upper":{"$ref":"request.resolution"}}}` |
| `create.body.aspect_ratio` | `{"$omitEmpty":{"$ref":"request.aspectRatio"}}` |
| `create.body.reference_images` | `{"$omitEmpty":{"$map":{"from":{"$sortByOrder":{"$ref":"request.images"}},"as":"media","in":{"url":{"$ref":"media.value"},"role":{"$coalesce":[{"$ref":"media.role"},"reference_image"]}}}}}` |
| `create.body.reference_videos` | `{"$omitEmpty":{"$map":{"from":{"$sortByOrder":{"$ref":"request.videos"}},"as":"media","in":{"url":{"$ref":"media.value"},"duration":{"$omitEmpty":{"$multiply":[{"$ref":"media.metadata.durationMs"},0.001]}}}}}}` |
| `create.body.reference_audios` | `{"$omitEmpty":{"$map":{"from":{"$sortByOrder":{"$ref":"request.audios"}},"as":"media","in":{"url":{"$ref":"media.value"}}}}}` |
| `poll.method` | `"GET"` |
| `poll.path` | `"/v1/videos/{{taskId}}"` |
| `poll.contentType` | `"application/json"` |
| `result.method` | `"GET"` |
| `result.path` | `"/v1/videos/{{taskId}}/content"` |
| `result.contentType` | `"application/json"` |
| `result.headers.Accept` | `"video/mp4"` |
## Provider 扩展键
- 无额外扩展键。
动态模型或工作流允许使用文档声明的完整 `parameters/input/extra_body` 对象；该对象是协议本身的开放 schema，不会被宿主裁剪。
## 响应映射逐字段清单
| 映射位置 | 上游路径或转换表达式 |
| --- | --- |
| `response.taskId` | `{"$coalesce":[{"$ref":"response.id"},{"$ref":"response.task_id"},{"$ref":"response.taskId"},{"$ref":"response.data.id"},{"$ref":"taskId"}]}` |
| `response.status` | `{"$coalesce":[{"$ref":"response.status"},{"$ref":"response.state"},{"$ref":"response.data.status"},"pending"]}` |
| `response.message` | `{"$coalesce":[{"$ref":"response.error.message"},{"$ref":"response.message"},{"$ref":"response.fail_reason"}]}` |
| `response.videos` | `{"$coalesce":[{"$ref":"response.metadata.url"},{"$ref":"response.data.metadata.url"},{"$ref":"response.video_url"},{"$ref":"response.url"}]}` |
| `response.errorPaths[0]` | `"error.code"` |
| `response.errorPaths[1]` | `"code"` |
| `response.resultEphemeral` | `true` |
| `response.messagePaths[0]` | `"error.message"` |
| `response.messagePaths[1]` | `"message"` |
| `response.messagePaths[2]` | `"fail_reason"` |
## 响应与错误
插件把上游 task/status/text/media/usage 映射为统一结果。临时媒体 URL 标记为 ephemeral，由宿主立即下载持久化。HTTP 错误、业务 code 和 error object 保持失败语义，不包装成成功。
## 兼容边界
该协议严格对应 RollDek WAN 3.0 的 JSON /v1/videos 合同。RollDek 同时暴露的其他兼容创建入口不共享任务查询路径，不能与 NewAPI Video Generations Channel 2 混用。
<!-- YINGCE_MANIFEST_CONTRACT_START -->
## Manifest 完整接口定义
以下 JSON 与插件包内实际 `manifest.json` 逐字段一致，覆盖插件身份、权限、配置、鉴权、参数、校验、创建、Agent、查询、取消、结果下载、响应和 Agent 响应映射。`documentation` 字段的值就是当前完整文档；为避免文档在自身内部无限递归，JSON 中仅用等义占位文本表示正文。
```json
{
"apiVersion": "yingce.plugin/v2",
"id": "rolldek-wan-video",
"name": "RollDek WAN 3.0 Video",
"version": "2.0.0",
"author": "RollDek / 影策",
"description": "RollDek WAN 3.0 Video 独立请求协议插件。",
"documentation": "<当前插件的完整 documentation，由 README.md 与 docs/interface.md 拼接而成；为避免 JSON 递归，此处不重复展开正文。>",
"permissions": [
"generation.run",
"media.read"
],
"configuration": {
"fields": [
{
"name": "apiKey",
"type": "secret",
"label": "API Key",
"required": true
}
]
},
"contributes": {
"providers": [
{
"id": "rolldek-wan-video",
"label": "RollDek WAN 3.0 Video",
"capabilities": [
"video"
],
"scopes": [
"admin.system-channel",
"user.custom-channel",
"canvas",
"creation",
"agent"
],
"baseUrl": "https://rolldek.com",
"requiresPublicMediaUrls": true,
"auth": {
"type": "bearer",
"field": "apiKey"
},
"parameters": [
{
"name": "model",
"type": "string",
"required": true,
"mapping": "model",
"description": "视频模型 ID。"
},
{
"name": "prompt",
"type": "string",
"required": true,
"mapping": "prompt/content/input",
"description": "视频提示词。"
},
{
"name": "images",
"type": "media[]",
"required": false,
"mapping": "first/last/reference image",
"description": "显式 role 图片输入。"
},
{
"name": "videos",
"type": "media[]",
"required": false,
"mapping": "reference video",
"description": "参考视频。"
},
{
"name": "audios",
"type": "media[]",
"required": false,
"mapping": "reference audio/voice",
"description": "参考音频或音色。"
},
{
"name": "duration",
"type": "integer",
"required": false,
"mapping": "duration/seconds",
"description": "时长秒数。"
},
{
"name": "aspectRatio",
"type": "string",
"required": false,
"mapping": "ratio/aspect_ratio/size",
"description": "画幅比例或尺寸。"
},
{
"name": "resolution",
"type": "string",
"required": false,
"mapping": "resolution",
"description": "分辨率档位。"
},
{
"name": "generateAudio",
"type": "boolean",
"required": false,
"mapping": "generate_audio",
"description": "是否生成音频。"
},
{
"name": "watermark",
"type": "boolean",
"required": false,
"mapping": "watermark",
"description": "水印开关。"
},
{
"name": "providerOptions",
"type": "object",
"required": false,
"mapping": "provider-specific fields",
"description": "插件命名空间内的厂商扩展字段。"
}
],
"create": {
"method": "POST",
"path": "/v1/videos",
"contentType": "application/json",
"body": {
"model": {
"$ref": "request.model"
},
"prompt": {
"$ref": "request.prompt"
},
"seconds": {
"$toString": {
"$ref": "request.duration"
}
},
"size": {
"$omitEmpty": {
"$upper": {
"$ref": "request.resolution"
}
}
},
"aspect_ratio": {
"$omitEmpty": {
"$ref": "request.aspectRatio"
}
},
"reference_images": {
"$omitEmpty": {
"$map": {
"from": {
"$sortByOrder": {
"$ref": "request.images"
}
},
"as": "media",
"in": {
"url": {
"$ref": "media.value"
},
"role": {
"$coalesce": [
{
"$ref": "media.role"
},
"reference_image"
]
}
}
}
}
},
"reference_videos": {
"$omitEmpty": {
"$map": {
"from": {
"$sortByOrder": {
"$ref": "request.videos"
}
},
"as": "media",
"in": {
"url": {
"$ref": "media.value"
},
"duration": {
"$omitEmpty": {
"$multiply": [
{
"$ref": "media.metadata.durationMs"
},
0.001
]
}
}
}
}
}
},
"reference_audios": {
"$omitEmpty": {
"$map": {
"from": {
"$sortByOrder": {
"$ref": "request.audios"
}
},
"as": "media",
"in": {
"url": {
"$ref": "media.value"
}
}
}
}
}
}
},
"poll": {
"method": "GET",
"path": "/v1/videos/{{taskId}}"
},
"result": {
"method": "GET",
"path": "/v1/videos/{{taskId}}/content",
"headers": {
"Accept": "video/mp4"
}
},
"response": {
"taskId": {
"$coalesce": [
{
"$ref": "response.id"
},
{
"$ref": "response.task_id"
},
{
"$ref": "response.taskId"
},
{
"$ref": "response.data.id"
},
{
"$ref": "taskId"
}
]
},
"status": {
"$coalesce": [
{
"$ref": "response.status"
},
{
"$ref": "response.state"
},
{
"$ref": "response.data.status"
},
"pending"
]
},
"message": {
"$coalesce": [
{
"$ref": "response.error.message"
},
{
"$ref": "response.message"
},
{
"$ref": "response.fail_reason"
}
]
},
"videos": {
"$coalesce": [
{
"$ref": "response.metadata.url"
},
{
"$ref": "response.data.metadata.url"
},
{
"$ref": "response.video_url"
},
{
"$ref": "response.url"
}
]
},
"errorPaths": [
"error.code",
"code"
],
"resultEphemeral": true,
"messagePaths": [
"error.message",
"message",
"fail_reason"
]
}
}
]
}
}
```
<!-- YINGCE_MANIFEST_CONTRACT_END -->