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,254 @@
|
||||
{
|
||||
"apiVersion": "yingce.plugin/v2",
|
||||
"id": "ideogram-image",
|
||||
"name": "Ideogram Image",
|
||||
"version": "2.0.0",
|
||||
"author": "Ideogram / 影策",
|
||||
"description": "Ideogram Image 独立请求协议插件。",
|
||||
"documentation": "# Ideogram Image\n\n该目录是独立官方协议插件源码。后端从生成的 `ideogram-image.yingce-plugin` 包加载，不依赖系统内置 `host:` 适配器。\n\n完整接口见 [docs/interface.md](docs/interface.md)。\n\n---\n\n# Ideogram Image 接口字段\n\n## 协议身份\n\n- 插件 ID：`ideogram-image`。\n- Provider ID：`ideogram-image`。\n- 能力：`image`。\n- 默认 Base URL：`https://api.ideogram.ai`。\n- 鉴权驱动：`header`。\n- 创建：`POST 动态路径`。\n- 生命周期：同步响应。\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` | `\"dynamic\"` |\n| `create.contentType` | `\"multipart/form-data\"` |\n| `create.body.prompt` | `{\"$ref\":\"request.prompt\"}` |\n| `create.body.negative_prompt` | `{\"$omitEmpty\":{\"$ref\":\"request.providerOptions.ideogram-image.negative_prompt\"}}` |\n| `create.body.aspect_ratio` | `{\"$omitEmpty\":{\"$ref\":\"request.aspectRatio\"}}` |\n| `create.body.resolution` | `{\"$omitEmpty\":{\"$ref\":\"request.resolution\"}}` |\n| `create.body.num_images` | `{\"$coalesce\":[{\"$ref\":\"request.imageCount\"},1]}` |\n| `create.body.rendering_speed` | `{\"$omitEmpty\":{\"$ref\":\"request.providerOptions.ideogram-image.rendering_speed\"}}` |\n| `create.body.style_type` | `{\"$omitEmpty\":{\"$ref\":\"request.providerOptions.ideogram-image.style_type\"}}` |\n| `create.body.magic_prompt` | `{\"$omitEmpty\":{\"$ref\":\"request.providerOptions.ideogram-image.magic_prompt\"}}` |\n| `create.body.seed` | `{\"$omitEmpty\":{\"$ref\":\"request.providerOptions.ideogram-image.seed\"}}` |\n| `create.body.color_palette` | `{\"$omitEmpty\":{\"$ref\":\"request.providerOptions.ideogram-image.color_palette\"}}` |\n| `create.body.character_reference_images_mask` | `{\"$omitEmpty\":{\"$ref\":\"request.providerOptions.ideogram-image.character_reference_images_mask\"}}` |\n| `create.files[0].name` | `\"image\"` |\n| `create.files[0].source` | `{\"$first\":{\"$filter\":{\"from\":{\"$sortByOrder\":{\"$ref\":\"request.images\"}},\"as\":\"media\",\"where\":{\"$in\":[{\"$ref\":\"media.role\"},[\"edit_source\",\"reference_image\",\"subject_reference\",\"style_reference\",\"\"]]}}}}` |\n| `create.files[0].filename` | `\"reference.png\"` |\n| `create.files[1].name` | `\"mask\"` |\n| `create.files[1].source` | `{\"$first\":{\"$filter\":{\"from\":{\"$sortByOrder\":{\"$ref\":\"request.images\"}},\"as\":\"media\",\"where\":{\"$in\":[{\"$ref\":\"media.role\"},[\"mask\"]]}}}}` |\n| `create.files[1].filename` | `\"mask.png\"` |\n\n## Provider 扩展键\n\n- `providerOptions.ideogram-image.character_reference_images_mask`\n- `providerOptions.ideogram-image.color_palette`\n- `providerOptions.ideogram-image.endpoint`\n- `providerOptions.ideogram-image.magic_prompt`\n- `providerOptions.ideogram-image.negative_prompt`\n- `providerOptions.ideogram-image.rendering_speed`\n- `providerOptions.ideogram-image.seed`\n- `providerOptions.ideogram-image.style_type`\n\n动态模型或工作流允许使用文档声明的完整 `parameters/input/extra_body` 对象；该对象是协议本身的开放 schema，不会被宿主裁剪。\n\n## 响应映射逐字段清单\n\n| 映射位置 | 上游路径或转换表达式 |\n| --- | --- |\n| `response.status` | `\"succeeded\"` |\n| `response.images` | `{\"$coalesce\":[{\"$ref\":\"response.data\"},{\"$ref\":\"response.images\"}]}` |\n| `response.errorPaths[0]` | `\"error.code\"` |\n| `response.messagePaths[0]` | `\"error.message\"` |\n| `response.messagePaths[1]` | `\"message\"` |\n\n## 响应与错误\n\n插件把上游 task/status/text/media/usage 映射为统一结果。临时媒体 URL 标记为 ephemeral，由宿主立即下载持久化。HTTP 错误、业务 code 和 error object 保持失败语义，不包装成成功。\n\n## 兼容边界\n\n该包只代表上述线协议 profile；同一品牌的其他 endpointLine truncated
|
||||
"permissions": [
|
||||
"generation.run",
|
||||
"media.read"
|
||||
],
|
||||
"configuration": {
|
||||
"fields": [
|
||||
{
|
||||
"name": "apiKey",
|
||||
"type": "secret",
|
||||
"label": "API Key",
|
||||
"required": true
|
||||
}
|
||||
]
|
||||
},
|
||||
"contributes": {
|
||||
"providers": [
|
||||
{
|
||||
"id": "ideogram-image",
|
||||
"label": "Ideogram Image",
|
||||
"capabilities": [
|
||||
"image"
|
||||
],
|
||||
"scopes": [
|
||||
"admin.system-channel",
|
||||
"user.custom-channel",
|
||||
"canvas",
|
||||
"creation",
|
||||
"agent"
|
||||
],
|
||||
"baseUrl": "https://api.ideogram.ai",
|
||||
"requiresPublicMediaUrls": false,
|
||||
"auth": {
|
||||
"type": "header",
|
||||
"field": "apiKey",
|
||||
"header": "Api-Key"
|
||||
},
|
||||
"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",
|
||||
"pathTemplate": {
|
||||
"$coalesce": [
|
||||
{
|
||||
"$ref": "request.providerOptions.ideogram-image.endpoint"
|
||||
},
|
||||
"/v1/ideogram-v3/generate"
|
||||
]
|
||||
},
|
||||
"contentType": "multipart/form-data",
|
||||
"body": {
|
||||
"prompt": {
|
||||
"$ref": "request.prompt"
|
||||
},
|
||||
"negative_prompt": {
|
||||
"$omitEmpty": {
|
||||
"$ref": "request.providerOptions.ideogram-image.negative_prompt"
|
||||
}
|
||||
},
|
||||
"aspect_ratio": {
|
||||
"$omitEmpty": {
|
||||
"$ref": "request.aspectRatio"
|
||||
}
|
||||
},
|
||||
"resolution": {
|
||||
"$omitEmpty": {
|
||||
"$ref": "request.resolution"
|
||||
}
|
||||
},
|
||||
"num_images": {
|
||||
"$coalesce": [
|
||||
{
|
||||
"$ref": "request.imageCount"
|
||||
},
|
||||
1
|
||||
]
|
||||
},
|
||||
"rendering_speed": {
|
||||
"$omitEmpty": {
|
||||
"$ref": "request.providerOptions.ideogram-image.rendering_speed"
|
||||
}
|
||||
},
|
||||
"style_type": {
|
||||
"$omitEmpty": {
|
||||
"$ref": "request.providerOptions.ideogram-image.style_type"
|
||||
}
|
||||
},
|
||||
"magic_prompt": {
|
||||
"$omitEmpty": {
|
||||
"$ref": "request.providerOptions.ideogram-image.magic_prompt"
|
||||
}
|
||||
},
|
||||
"seed": {
|
||||
"$omitEmpty": {
|
||||
"$ref": "request.providerOptions.ideogram-image.seed"
|
||||
}
|
||||
},
|
||||
"color_palette": {
|
||||
"$omitEmpty": {
|
||||
"$ref": "request.providerOptions.ideogram-image.color_palette"
|
||||
}
|
||||
},
|
||||
"character_reference_images_mask": {
|
||||
"$omitEmpty": {
|
||||
"$ref": "request.providerOptions.ideogram-image.character_reference_images_mask"
|
||||
}
|
||||
}
|
||||
},
|
||||
"files": [
|
||||
{
|
||||
"name": "image",
|
||||
"source": {
|
||||
"$first": {
|
||||
"$filter": {
|
||||
"from": {
|
||||
"$sortByOrder": {
|
||||
"$ref": "request.images"
|
||||
}
|
||||
},
|
||||
"as": "media",
|
||||
"where": {
|
||||
"$in": [
|
||||
{
|
||||
"$ref": "media.role"
|
||||
},
|
||||
[
|
||||
"edit_source",
|
||||
"reference_image",
|
||||
"subject_reference",
|
||||
"style_reference",
|
||||
""
|
||||
]
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"filename": "reference.png"
|
||||
},
|
||||
{
|
||||
"name": "mask",
|
||||
"source": {
|
||||
"$first": {
|
||||
"$filter": {
|
||||
"from": {
|
||||
"$sortByOrder": {
|
||||
"$ref": "request.images"
|
||||
}
|
||||
},
|
||||
"as": "media",
|
||||
"where": {
|
||||
"$in": [
|
||||
{
|
||||
"$ref": "media.role"
|
||||
},
|
||||
[
|
||||
"mask"
|
||||
]
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"filename": "mask.png"
|
||||
}
|
||||
]
|
||||
},
|
||||
"response": {
|
||||
"status": "succeeded",
|
||||
"images": {
|
||||
"$coalesce": [
|
||||
{
|
||||
"$ref": "response.data"
|
||||
},
|
||||
{
|
||||
"$ref": "response.images"
|
||||
}
|
||||
]
|
||||
},
|
||||
"errorPaths": [
|
||||
"error.code"
|
||||
],
|
||||
"messagePaths": [
|
||||
"error.message",
|
||||
"message"
|
||||
]
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
Reference in new issue
Block a user