refactor(*): 平台架构 - 拆分后端领域模块并同步插件协议与模型能力
This commit is contained in:
ddCat committed
1 parent
916043fb5a
commit
6e5cbc8b05
644 files changed
+62731
-2320
No files matched your search
@@ -0,0 +1,252 @@
|
||||
{
|
||||
"apiVersion": "yingce.plugin/v2",
|
||||
"id": "fal-queue-image",
|
||||
"name": "fal.ai Queue Image",
|
||||
"version": "2.0.0",
|
||||
"author": "fal.ai / 影策",
|
||||
"description": "fal.ai Queue Image 独立请求协议插件。",
|
||||
"documentation": "# fal.ai Queue Image\n\n该目录是独立官方协议插件源码。后端从生成的 `fal-queue-image.yingce-plugin` 包加载，不依赖系统内置 `host:` 适配器。\n\n完整接口见 [docs/interface.md](docs/interface.md)。\n\n---\n\n# fal.ai Queue Image 接口字段\n\n## 协议身份\n\n- 插件 ID：`fal-queue-image`。\n- Provider ID：`fal-queue-image`。\n- 能力：`image`。\n- 默认 Base URL：`https://queue.fal.run`。\n- 鉴权驱动：`bearer`。\n- 创建：`POST /{{model}}`。\n- 查询：`GET /{{request.providerOptions.fal-queue-image.statusPath}}`。\n\n## 配置字段\n\n| 字段 | 类型 | 必填 | 含义 |\n| --- | --- | --- | --- |\n| `apiKey` | secret | 是 | API Key |\n\n## 统一字段映射\n\n| 统一字段 | 类型 | 必填 | 上游映射 | 说明 |\n| --- | --- | --- | --- | --- |\n| `model` | string | 是 | `model` | 图片模型 ID。 |\n| `prompt` | string | 是 | `prompt` | 图片提示词。 |\n| `images` | media[] | 否 | `provider image/reference fields` | 参考图或编辑源图，role 由业务层确定。 |\n| `imageCount` | integer | 否 | `n/sample_count` | 输出数量。 |\n| `aspectRatio` | string | 否 | `size/aspect_ratio` | 比例或尺寸，语义按协议说明。 |\n| `resolution` | string | 否 | `resolution/imageSize` | 分辨率档位。 |\n| `quality` | string | 否 | `quality` | 质量档位。 |\n| `providerOptions` | object | 否 | `provider-specific fields` | 插件命名空间内的厂商扩展字段。 |\n\n## 上游请求模板逐字段清单\n\n下表由插件请求模板生成，覆盖 body、query、headers 和 multipart 文件声明中的每个字段。\n\n| 上游位置 | 值或转换表达式 |\n| --- | --- |\n| `create.method` | `\"POST\"` |\n| `create.path` | `\"/{{model}}\"` |\n| `create.contentType` | `\"application/json\"` |\n| `create.body.version` | `{\"$omitEmpty\":{\"$ref\":\"request.providerOptions.fal-queue-image.version\"}}` |\n| `create.body.model` | `{\"$omitEmpty\":{\"$coalesce\":[{\"$ref\":\"request.providerOptions.fal-queue-image.model\"},{\"$ref\":\"request.model\"}]}}` |\n| `create.body.input` | `{\"$omitEmpty\":{\"$coalesce\":[{\"$ref\":\"request.providerOptions.fal-queue-image.input\"},{\"prompt\":{\"$ref\":\"request.prompt\"},\"images\":{\"$map\":{\"from\":{\"$ref\":\"request.images\"},\"as\":\"media\",\"in\":{\"$ref\":\"media.value\"}}},\"videos\":{\"$map\":{\"from\":{\"$ref\":\"request.videos\"},\"as\":\"media\",\"in\":{\"$ref\":\"media.value\"}}},\"audios\":{\"$map\":{\"from\":{\"$ref\":\"request.audios\"},\"as\":\"media\",\"in\":{\"$ref\":\"media.value\"}}}}]}}` |\n| `create.body.prompt` | `{\"$omitEmpty\":{\"$ref\":\"request.providerOptions.fal-queue-image.workflow\"}}` |\n| `create.body.client_id` | `{\"$omitEmpty\":{\"$ref\":\"request.providerOptions.fal-queue-image.client_id\"}}` |\n| `create.body.webhook` | `{\"$omitEmpty\":{\"$ref\":\"request.providerOptions.fal-queue-image.webhook\"}}` |\n| `create.body.webhook_events_filter` | `{\"$omitEmpty\":{\"$ref\":\"request.providerOptions.fal-queue-image.webhook_events_filter\"}}` |\n| `poll.method` | `\"GET\"` |\n| `poll.path` | `\"/{{request.providerOptions.fal-queue-image.statusPath}}\"` |\n| `poll.contentType` | `\"application/json\"` |\n\n## Provider 扩展键\n\n- `providerOptions.fal-queue-image.client_id`\n- `providerOptions.fal-queue-image.input`\n- `providerOptions.fal-queue-image.model`\n- `providerOptions.fal-queue-image.statusPath`\n- `providerOptions.fal-queue-image.version`\n- `providerOptions.fal-queue-image.webhook`\n- `providerOptions.fal-queue-image.webhook_events_filter`\n- `providerOptions.fal-queue-image.workflow`\n\n动态模型或工作流允许使用文档声明的完整 `parameters/input/extra_body` 对象；该对象是协议本身的开放 schema，不会被宿主裁剪。\n\n## 响应映射逐字段清单\n\n| 映射位置 | 上游路径或转换表达式 |\n| --- | --- |\n| `response.taskId` | `{\"$coalesce\":[{\"$ref\":\"response.id\"},{\"$ref\":\"response.request_id\"},{\"$ref\":\"response.prompt_id\"},{\"$ref\":\"taskId\"}]}` |\n| `response.status` | `{\"$coalesce\":[{\"$ref\":\"response.status\"},{\"$ref\":\"response.state\"},{\"$ref\":\"response.data.status\"},\"pending\"]}` |\n| `response.message` | `{\"$coalesce\":[{\"$ref\":\"response.error.message\"},{\"$ref\":\"response.message\"},{\"$ref\":\"response.fail_reason\"}]}` |\n| `response.images` | `{\"$ref\":\"response.images\"}` |\n| `response.errorPaths[0]` | `\"error.code\"` |\n| `response.resultEphemeral` | `true` |\n\n## 响应与错误\n\n插件把上游 task/status/text/media/usage 映射为统一结果。临时媒体 URL 标记为 ephemeral，由宿主立即下载持久化。HTTP 错误、业务 code 和 error object 保持失败语义，不包装成成功。\n\n## 兼容边界\n\n这是运行时/工作流协议，模型字段由 endpoint、version 或 workflow schema 决定。插件不伪造固定模型字段；providerOptions.input/workflowLine truncated
|
||||
"permissions": [
|
||||
"generation.run",
|
||||
"media.read"
|
||||
],
|
||||
"configuration": {
|
||||
"fields": [
|
||||
{
|
||||
"name": "apiKey",
|
||||
"type": "secret",
|
||||
"label": "API Key",
|
||||
"required": true
|
||||
}
|
||||
]
|
||||
},
|
||||
"contributes": {
|
||||
"providers": [
|
||||
{
|
||||
"id": "fal-queue-image",
|
||||
"label": "fal.ai Queue Image",
|
||||
"capabilities": [
|
||||
"image"
|
||||
],
|
||||
"scopes": [
|
||||
"admin.system-channel",
|
||||
"user.custom-channel",
|
||||
"canvas",
|
||||
"creation",
|
||||
"agent"
|
||||
],
|
||||
"baseUrl": "https://queue.fal.run",
|
||||
"requiresPublicMediaUrls": false,
|
||||
"auth": {
|
||||
"type": "bearer",
|
||||
"field": "apiKey"
|
||||
},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "model",
|
||||
"type": "string",
|
||||
"required": true,
|
||||
"mapping": "model",
|
||||
"description": "图片模型 ID。"
|
||||
},
|
||||
{
|
||||
"name": "prompt",
|
||||
"type": "string",
|
||||
"required": true,
|
||||
"mapping": "prompt",
|
||||
"description": "图片提示词。"
|
||||
},
|
||||
{
|
||||
"name": "images",
|
||||
"type": "media[]",
|
||||
"required": false,
|
||||
"mapping": "provider image/reference fields",
|
||||
"description": "参考图或编辑源图，role 由业务层确定。"
|
||||
},
|
||||
{
|
||||
"name": "imageCount",
|
||||
"type": "integer",
|
||||
"required": false,
|
||||
"mapping": "n/sample_count",
|
||||
"description": "输出数量。"
|
||||
},
|
||||
{
|
||||
"name": "aspectRatio",
|
||||
"type": "string",
|
||||
"required": false,
|
||||
"mapping": "size/aspect_ratio",
|
||||
"description": "比例或尺寸，语义按协议说明。"
|
||||
},
|
||||
{
|
||||
"name": "resolution",
|
||||
"type": "string",
|
||||
"required": false,
|
||||
"mapping": "resolution/imageSize",
|
||||
"description": "分辨率档位。"
|
||||
},
|
||||
{
|
||||
"name": "quality",
|
||||
"type": "string",
|
||||
"required": false,
|
||||
"mapping": "quality",
|
||||
"description": "质量档位。"
|
||||
},
|
||||
{
|
||||
"name": "providerOptions",
|
||||
"type": "object",
|
||||
"required": false,
|
||||
"mapping": "provider-specific fields",
|
||||
"description": "插件命名空间内的厂商扩展字段。"
|
||||
}
|
||||
],
|
||||
"create": {
|
||||
"method": "POST",
|
||||
"path": "/{{model}}",
|
||||
"contentType": "application/json",
|
||||
"body": {
|
||||
"version": {
|
||||
"$omitEmpty": {
|
||||
"$ref": "request.providerOptions.fal-queue-image.version"
|
||||
}
|
||||
},
|
||||
"model": {
|
||||
"$omitEmpty": {
|
||||
"$coalesce": [
|
||||
{
|
||||
"$ref": "request.providerOptions.fal-queue-image.model"
|
||||
},
|
||||
{
|
||||
"$ref": "request.model"
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"input": {
|
||||
"$omitEmpty": {
|
||||
"$coalesce": [
|
||||
{
|
||||
"$ref": "request.providerOptions.fal-queue-image.input"
|
||||
},
|
||||
{
|
||||
"prompt": {
|
||||
"$ref": "request.prompt"
|
||||
},
|
||||
"images": {
|
||||
"$map": {
|
||||
"from": {
|
||||
"$ref": "request.images"
|
||||
},
|
||||
"as": "media",
|
||||
"in": {
|
||||
"$ref": "media.value"
|
||||
}
|
||||
}
|
||||
},
|
||||
"videos": {
|
||||
"$map": {
|
||||
"from": {
|
||||
"$ref": "request.videos"
|
||||
},
|
||||
"as": "media",
|
||||
"in": {
|
||||
"$ref": "media.value"
|
||||
}
|
||||
}
|
||||
},
|
||||
"audios": {
|
||||
"$map": {
|
||||
"from": {
|
||||
"$ref": "request.audios"
|
||||
},
|
||||
"as": "media",
|
||||
"in": {
|
||||
"$ref": "media.value"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"prompt": {
|
||||
"$omitEmpty": {
|
||||
"$ref": "request.providerOptions.fal-queue-image.workflow"
|
||||
}
|
||||
},
|
||||
"client_id": {
|
||||
"$omitEmpty": {
|
||||
"$ref": "request.providerOptions.fal-queue-image.client_id"
|
||||
}
|
||||
},
|
||||
"webhook": {
|
||||
"$omitEmpty": {
|
||||
"$ref": "request.providerOptions.fal-queue-image.webhook"
|
||||
}
|
||||
},
|
||||
"webhook_events_filter": {
|
||||
"$omitEmpty": {
|
||||
"$ref": "request.providerOptions.fal-queue-image.webhook_events_filter"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"poll": {
|
||||
"method": "GET",
|
||||
"path": "/{{request.providerOptions.fal-queue-image.statusPath}}"
|
||||
},
|
||||
"response": {
|
||||
"taskId": {
|
||||
"$coalesce": [
|
||||
{
|
||||
"$ref": "response.id"
|
||||
},
|
||||
{
|
||||
"$ref": "response.request_id"
|
||||
},
|
||||
{
|
||||
"$ref": "response.prompt_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"
|
||||
}
|
||||
]
|
||||
},
|
||||
"images": {
|
||||
"$ref": "response.images"
|
||||
},
|
||||
"errorPaths": [
|
||||
"error.code"
|
||||
],
|
||||
"resultEphemeral": true
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
Reference in new issue
Block a user