feat(plugins): 方舟 Agent Plan - 合并 PR #527 图片视频插件并阻止图片误用 asset://
Co-authored-by: Cursor <cursoragent@cursor.com>
This commit is contained in:
@@ -374,27 +374,123 @@ const arkSeedreamRatioSizes = [
|
||||
["3:2", "2496x1664"], ["2:3", "1664x2496"], ["21:9", "3024x1296"]
|
||||
];
|
||||
|
||||
const arkSeedreamImageBody = (optionNamespace) => ({
|
||||
model: ref("request.model"), prompt: ref("request.prompt"),
|
||||
// Ark 的 size 只接受 WIDTHxHEIGHT 或 2k/3k/4k;统一层的比例值在这里换算成 2K 档像素尺寸,像素或档位值原样透传。
|
||||
size: omit({ $switch: { cases: arkSeedreamRatioSizes.map(([ratio, size]) => ({ when: eq(ref("request.aspectRatio"), ratio), then: size })), default: ref("request.aspectRatio") } }),
|
||||
image: omit(conditional(
|
||||
eq(len(ref("request.images")), 1),
|
||||
first(map(ref("request.images"), "media", ref("media.value"))),
|
||||
conditional(gt(len(ref("request.images")), 1), map(ref("request.images"), "media", ref("media.value")), null)
|
||||
)),
|
||||
sequential_image_generation: omit(ref(`request.providerOptions.${optionNamespace}.sequential_image_generation`)),
|
||||
sequential_image_generation_options: omit(ref(`request.providerOptions.${optionNamespace}.sequential_image_generation_options`)),
|
||||
watermark: coalesce(ref(`request.providerOptions.${optionNamespace}.watermark`), ref("request.watermark"), false),
|
||||
seed: omit(ref(`request.providerOptions.${optionNamespace}.seed`)),
|
||||
response_format: coalesce(ref(`request.providerOptions.${optionNamespace}.response_format`), "b64_json")
|
||||
});
|
||||
|
||||
add({
|
||||
id: "volcengine-ark-seedream", providerId: "volcengine-ark-image", name: "Volcengine Ark Seedream Images", vendor: "Volcengine", capability: "image",
|
||||
baseUrl: "https://ark.cn-beijing.volces.com", auth: bearer, params: imageParams,
|
||||
create: jsonCreate("/api/v3/images/generations", {
|
||||
model: ref("request.model"), prompt: ref("request.prompt"),
|
||||
// Ark 的 size 只接受 WIDTHxHEIGHT 或 2k/3k/4k;统一层的比例值在这里换算成 2K 档像素尺寸,像素或档位值原样透传。
|
||||
size: omit({ $switch: { cases: arkSeedreamRatioSizes.map(([ratio, size]) => ({ when: eq(ref("request.aspectRatio"), ratio), then: size })), default: ref("request.aspectRatio") } }),
|
||||
image: omit(conditional(
|
||||
eq(len(ref("request.images")), 1),
|
||||
first(map(ref("request.images"), "media", ref("media.value"))),
|
||||
conditional(gt(len(ref("request.images")), 1), map(ref("request.images"), "media", ref("media.value")), null)
|
||||
)),
|
||||
sequential_image_generation: omit(ref("request.providerOptions.volcengine-ark-image.sequential_image_generation")),
|
||||
sequential_image_generation_options: omit(ref("request.providerOptions.volcengine-ark-image.sequential_image_generation_options")),
|
||||
watermark: coalesce(ref("request.providerOptions.volcengine-ark-image.watermark"), ref("request.watermark"), false),
|
||||
seed: omit(ref("request.providerOptions.volcengine-ark-image.seed")),
|
||||
response_format: coalesce(ref("request.providerOptions.volcengine-ark-image.response_format"), "b64_json")
|
||||
}),
|
||||
notes: "官方 Ark 推理接入:Base URL 使用 /api/v3,API Key 来自方舟推理接入控制台,不可与 Agent Plan 专属 Key 混用。",
|
||||
create: jsonCreate("/api/v3/images/generations", arkSeedreamImageBody("volcengine-ark-image")),
|
||||
response: { status: "succeeded", images: ref("response.data"), usage: ref("response.usage"), errorPaths: ["error.code"], messagePaths: ["error.message"] }
|
||||
});
|
||||
|
||||
add({
|
||||
id: "volcengine-ark-agent-plan-seedream", providerId: "volcengine-ark-agent-plan-image", name: "Volcengine Ark Agent Plan Seedream Images", vendor: "Volcengine", capability: "image",
|
||||
baseUrl: "https://ark.cn-beijing.volces.com", auth: bearer, params: imageParams,
|
||||
notes: "Agent Plan 专属接入:请求路径为 /api/plan/v3/images/generations,必须使用 Agent Plan 控制台专属 API Key;请求体与官方 Seedream 协议一致,但凭证与额度按 AFP 套餐结算,不能与 /api/v3 官方 Key 混用。",
|
||||
create: jsonCreate("/api/plan/v3/images/generations", arkSeedreamImageBody("volcengine-ark-agent-plan-image")),
|
||||
response: { status: "succeeded", images: ref("response.data"), usage: ref("response.usage"), errorPaths: ["error.code"], messagePaths: ["error.message"] }
|
||||
});
|
||||
|
||||
const arkSeedanceValidations = [
|
||||
{ assert: { $lte: [len(ref("request.images")), 9] }, message: "Seedance 最多支持 9 张参考图片" },
|
||||
{ assert: { $lte: [len(ref("request.videos")), 3] }, message: "Seedance 最多支持 3 个参考视频" },
|
||||
{ assert: { $lte: [len(ref("request.audios")), 3] }, message: "Seedance 最多支持 3 个参考音频" },
|
||||
{ assert: { $or: [eq(len(ref("request.audios")), 0), gt({ $add: [len(ref("request.images")), len(ref("request.videos"))] }, 0)] }, message: "Seedance 不支持纯音频或文本+音频,请同时添加参考图片或参考视频" }
|
||||
];
|
||||
|
||||
const arkSeedanceParams = [
|
||||
["model", "string", true, "model", "Ark endpoint/model ID。"],
|
||||
["prompt", "string", true, "content[type=text].text", "视频提示词。"],
|
||||
["images", "media[]", false, "content[type=image_url]", "first_frame、last_frame、reference_image 等 role 原样映射。"],
|
||||
["videos", "media[]", false, "content[type=video_url]", "reference_video。"],
|
||||
["audios", "media[]", false, "content[type=audio_url]", "reference_audio/reference_voice。"],
|
||||
["aspectRatio", "string", false, "ratio", "输出画幅。"],
|
||||
["resolution", "string", false, "resolution", "输出分辨率档位。"],
|
||||
["duration", "integer", false, "duration", "输出时长秒数。"],
|
||||
["generateAudio", "boolean", false, "generate_audio", "是否生成音频。"],
|
||||
["watermark", "boolean", false, "watermark", "是否带水印。"],
|
||||
["seed", "integer", false, "seed", "providerOptions seed。"],
|
||||
["camera_fixed", "boolean", false, "camera_fixed", "providerOptions camera_fixed。"]
|
||||
];
|
||||
|
||||
const arkSeedanceBody = (optionNamespace) => ({
|
||||
model: ref("request.model"),
|
||||
content: {
|
||||
$concatArrays: [
|
||||
[{ type: "text", text: ref("request.prompt") }],
|
||||
map(sorted(ref("request.images")), "media", {
|
||||
type: "image_url",
|
||||
image_url: { url: ref("media.value") },
|
||||
role: coalesce(ref("media.role"), "reference_image")
|
||||
}),
|
||||
map(sorted(ref("request.videos")), "media", {
|
||||
type: "video_url",
|
||||
video_url: { url: ref("media.value") },
|
||||
role: coalesce(ref("media.role"), "reference_video")
|
||||
}),
|
||||
map(sorted(ref("request.audios")), "media", {
|
||||
type: "audio_url",
|
||||
audio_url: { url: ref("media.value") },
|
||||
role: coalesce(ref("media.role"), "reference_audio")
|
||||
})
|
||||
]
|
||||
},
|
||||
ratio: coalesce(ref("request.aspectRatio"), "16:9"),
|
||||
resolution: coalesce(ref("request.resolution"), "720p"),
|
||||
duration: conditional(gt(ref("request.duration"), 0), ref("request.duration"), 5),
|
||||
generate_audio: ref("request.generateAudio"),
|
||||
watermark: ref("request.watermark"),
|
||||
seed: omit(ref(`request.providerOptions.${optionNamespace}.seed`)),
|
||||
camera_fixed: omit(ref(`request.providerOptions.${optionNamespace}.camera_fixed`))
|
||||
});
|
||||
|
||||
const arkSeedanceResponse = {
|
||||
taskId: coalesce(ref("response.id"), ref("response.task_id"), ref("response.data.id"), ref("taskId")),
|
||||
status: coalesce(ref("response.status"), ref("response.data.status"), "pending"),
|
||||
message: coalesce(ref("response.error.message"), ref("response.message"), ref("response.fail_reason")),
|
||||
videos: coalesce(ref("response.content.video_url"), ref("response.video_url"), ref("response.output.video_url"), ref("response.data.video_url")),
|
||||
usage: ref("response.usage"),
|
||||
errorPaths: ["error.code"],
|
||||
resultEphemeral: true
|
||||
};
|
||||
|
||||
add({
|
||||
id: "volcengine-ark-seedance", providerId: "volcengine-ark-video", name: "Volcengine Ark Seedance", vendor: "Volcengine", capability: "video",
|
||||
baseUrl: "https://ark.cn-beijing.volces.com", auth: bearer, params: arkSeedanceParams, requiresPublicMediaUrls: true,
|
||||
validations: arkSeedanceValidations,
|
||||
notes: "官方 Ark 推理接入:创建/查询/取消走 /api/v3/contents/generations/tasks;插件不根据图片下标推断首尾帧,role 由业务层确定。API Key 来自方舟推理接入控制台。",
|
||||
create: jsonCreate("/api/v3/contents/generations/tasks", arkSeedanceBody("volcengine-ark-video")),
|
||||
poll: { method: "GET", path: "/api/v3/contents/generations/tasks/{{taskId}}" },
|
||||
cancel: { method: "DELETE", path: "/api/v3/contents/generations/tasks/{{taskId}}" },
|
||||
response: arkSeedanceResponse
|
||||
});
|
||||
|
||||
add({
|
||||
id: "volcengine-ark-agent-plan-seedance", providerId: "volcengine-ark-agent-plan-video", name: "Volcengine Ark Agent Plan Seedance", vendor: "Volcengine", capability: "video",
|
||||
baseUrl: "https://ark.cn-beijing.volces.com", auth: bearer, params: arkSeedanceParams, requiresPublicMediaUrls: true,
|
||||
validations: arkSeedanceValidations,
|
||||
notes: "Agent Plan 专属接入:创建/查询/取消走 /api/plan/v3/contents/generations/tasks;请求体与官方 Seedance 协议一致,但必须使用 Agent Plan 专属 API Key 与 AFP 额度,不能与 /api/v3 官方 Key 混用。",
|
||||
create: jsonCreate("/api/plan/v3/contents/generations/tasks", arkSeedanceBody("volcengine-ark-agent-plan-video")),
|
||||
poll: { method: "GET", path: "/api/plan/v3/contents/generations/tasks/{{taskId}}" },
|
||||
cancel: { method: "DELETE", path: "/api/plan/v3/contents/generations/tasks/{{taskId}}" },
|
||||
response: arkSeedanceResponse
|
||||
});
|
||||
|
||||
// Gemini imageConfig.imageSize 只接受 1K/2K/4K;画布统一层用 1k/2k/4k 或 low/medium/high。
|
||||
const geminiImageSize = omit({
|
||||
$coalesce: [
|
||||
|
||||
BIN
plugin-packages/volcengine-ark-agent-plan-seedance.yingce-plugin
Normal file
BIN
plugin-packages/volcengine-ark-agent-plan-seedance.yingce-plugin
Normal file
Binary file not shown.
@@ -0,0 +1,5 @@
|
||||
# Volcengine Ark Agent Plan Seedance
|
||||
|
||||
该目录是独立官方协议插件源码。后端从生成的 `volcengine-ark-agent-plan-seedance.yingce-plugin` 包加载,不依赖系统内置 `host:` 适配器。
|
||||
|
||||
完整接口见 [docs/interface.md](docs/interface.md)。
|
||||
@@ -0,0 +1,527 @@
|
||||
# Volcengine Ark Agent Plan Seedance 接口字段
|
||||
|
||||
## 协议身份
|
||||
|
||||
- 插件 ID:`volcengine-ark-agent-plan-seedance`。
|
||||
- Provider ID:`volcengine-ark-agent-plan-video`。
|
||||
- 能力:`video`。
|
||||
- 默认 Base URL:`https://ark.cn-beijing.volces.com`。
|
||||
- 鉴权驱动:`bearer`。
|
||||
- 创建:`POST /api/plan/v3/contents/generations/tasks`。
|
||||
- 查询:`GET /api/plan/v3/contents/generations/tasks/{{taskId}}`。
|
||||
- 取消:`DELETE /api/plan/v3/contents/generations/tasks/{{taskId}}`。
|
||||
|
||||
## 配置字段
|
||||
|
||||
| 字段 | 类型 | 必填 | 含义 |
|
||||
| --- | --- | --- | --- |
|
||||
| `apiKey` | secret | 是 | API Key |
|
||||
|
||||
## 统一字段映射
|
||||
|
||||
| 统一字段 | 类型 | 必填 | 上游映射 | 说明 |
|
||||
| --- | --- | --- | --- | --- |
|
||||
| `model` | string | 是 | `model` | Ark endpoint/model ID。 |
|
||||
| `prompt` | string | 是 | `content[type=text].text` | 视频提示词。 |
|
||||
| `images` | media[] | 否 | `content[type=image_url]` | first_frame、last_frame、reference_image 等 role 原样映射。 |
|
||||
| `videos` | media[] | 否 | `content[type=video_url]` | reference_video。 |
|
||||
| `audios` | media[] | 否 | `content[type=audio_url]` | reference_audio/reference_voice。 |
|
||||
| `aspectRatio` | string | 否 | `ratio` | 输出画幅。 |
|
||||
| `resolution` | string | 否 | `resolution` | 输出分辨率档位。 |
|
||||
| `duration` | integer | 否 | `duration` | 输出时长秒数。 |
|
||||
| `generateAudio` | boolean | 否 | `generate_audio` | 是否生成音频。 |
|
||||
| `watermark` | boolean | 否 | `watermark` | 是否带水印。 |
|
||||
| `seed` | integer | 否 | `seed` | providerOptions seed。 |
|
||||
| `camera_fixed` | boolean | 否 | `camera_fixed` | providerOptions camera_fixed。 |
|
||||
|
||||
## 上游请求模板逐字段清单
|
||||
|
||||
下表由插件请求模板生成,覆盖 body、query、headers 和 multipart 文件声明中的每个字段。
|
||||
|
||||
| 上游位置 | 值或转换表达式 |
|
||||
| --- | --- |
|
||||
| `create.method` | `"POST"` |
|
||||
| `create.path` | `"/api/plan/v3/contents/generations/tasks"` |
|
||||
| `create.contentType` | `"application/json"` |
|
||||
| `create.body.model` | `{"$ref":"request.model"}` |
|
||||
| `create.body.content` | `{"$concatArrays":[[{"type":"text","text":{"$ref":"request.prompt"}}],{"$map":{"from":{"$sortByOrder":{"$ref":"request.images"}},"as":"media","in":{"type":"image_url","image_url":{"url":{"$ref":"media.value"}},"role":{"$coalesce":[{"$ref":"media.role"},"reference_image"]}}}},{"$map":{"from":{"$sortByOrder":{"$ref":"request.videos"}},"as":"media","in":{"type":"video_url","video_url":{"url":{"$ref":"media.value"}},"role":{"$coalesce":[{"$ref":"media.role"},"reference_video"]}}}},{"$map":{"from":{"$sortByOrder":{"$ref":"request.audios"}},"as":"media","in":{"type":"audio_url","audio_url":{"url":{"$ref":"media.value"}},"role":{"$coalesce":[{"$ref":"media.role"},"reference_audio"]}}}}]}` |
|
||||
| `create.body.ratio` | `{"$coalesce":[{"$ref":"request.aspectRatio"},"16:9"]}` |
|
||||
| `create.body.resolution` | `{"$coalesce":[{"$ref":"request.resolution"},"720p"]}` |
|
||||
| `create.body.duration` | `{"$if":{"condition":{"$gt":[{"$ref":"request.duration"},0]},"then":{"$ref":"request.duration"},"else":5}}` |
|
||||
| `create.body.generate_audio` | `{"$ref":"request.generateAudio"}` |
|
||||
| `create.body.watermark` | `{"$ref":"request.watermark"}` |
|
||||
| `create.body.seed` | `{"$omitEmpty":{"$ref":"request.providerOptions.volcengine-ark-agent-plan-video.seed"}}` |
|
||||
| `create.body.camera_fixed` | `{"$omitEmpty":{"$ref":"request.providerOptions.volcengine-ark-agent-plan-video.camera_fixed"}}` |
|
||||
| `poll.method` | `"GET"` |
|
||||
| `poll.path` | `"/api/plan/v3/contents/generations/tasks/{{taskId}}"` |
|
||||
| `poll.contentType` | `"application/json"` |
|
||||
| `cancel.method` | `"DELETE"` |
|
||||
| `cancel.path` | `"/api/plan/v3/contents/generations/tasks/{{taskId}}"` |
|
||||
| `cancel.contentType` | `"application/json"` |
|
||||
|
||||
## Provider 扩展键
|
||||
|
||||
- `providerOptions.volcengine-ark-agent-plan-video.camera_fixed`
|
||||
- `providerOptions.volcengine-ark-agent-plan-video.seed`
|
||||
|
||||
动态模型或工作流允许使用文档声明的完整 `parameters/input/extra_body` 对象;该对象是协议本身的开放 schema,不会被宿主裁剪。
|
||||
|
||||
## 响应映射逐字段清单
|
||||
|
||||
| 映射位置 | 上游路径或转换表达式 |
|
||||
| --- | --- |
|
||||
| `response.taskId` | `{"$coalesce":[{"$ref":"response.id"},{"$ref":"response.task_id"},{"$ref":"response.data.id"},{"$ref":"taskId"}]}` |
|
||||
| `response.status` | `{"$coalesce":[{"$ref":"response.status"},{"$ref":"response.data.status"},"pending"]}` |
|
||||
| `response.message` | `{"$coalesce":[{"$ref":"response.error.message"},{"$ref":"response.message"},{"$ref":"response.fail_reason"}]}` |
|
||||
| `response.videos` | `{"$coalesce":[{"$ref":"response.content.video_url"},{"$ref":"response.video_url"},{"$ref":"response.output.video_url"},{"$ref":"response.data.video_url"}]}` |
|
||||
| `response.usage` | `{"$ref":"response.usage"}` |
|
||||
| `response.errorPaths[0]` | `"error.code"` |
|
||||
| `response.resultEphemeral` | `true` |
|
||||
|
||||
## 响应与错误
|
||||
|
||||
插件把上游 task/status/text/media/usage 映射为统一结果。临时媒体 URL 标记为 ephemeral,由宿主立即下载持久化。HTTP 错误、业务 code 和 error object 保持失败语义,不包装成成功。
|
||||
|
||||
## 兼容边界
|
||||
|
||||
Agent Plan 专属接入:创建/查询/取消走 /api/plan/v3/contents/generations/tasks;请求体与官方 Seedance 协议一致,但必须使用 Agent Plan 专属 API Key 与 AFP 额度,不能与 /api/v3 官方 Key 混用。
|
||||
|
||||
<!-- YINGCE_MANIFEST_CONTRACT_START -->
|
||||
## Manifest 完整接口定义
|
||||
|
||||
以下 JSON 与插件包内实际 `manifest.json` 逐字段一致,覆盖插件身份、权限、配置、鉴权、参数、校验、创建、Agent、查询、取消、结果下载、响应和 Agent 响应映射。`documentation` 字段的值就是当前完整文档;为避免文档在自身内部无限递归,JSON 中仅用等义占位文本表示正文。
|
||||
|
||||
```json
|
||||
{
|
||||
"apiVersion": "yingce.plugin/v2",
|
||||
"id": "volcengine-ark-agent-plan-seedance",
|
||||
"name": "Volcengine Ark Agent Plan Seedance",
|
||||
"version": "2.0.0",
|
||||
"author": "Volcengine / 影策",
|
||||
"description": "Volcengine Ark Agent Plan Seedance 独立请求协议插件。",
|
||||
"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": "volcengine-ark-agent-plan-video",
|
||||
"label": "Volcengine Ark Agent Plan Seedance",
|
||||
"capabilities": [
|
||||
"video"
|
||||
],
|
||||
"scopes": [
|
||||
"admin.system-channel",
|
||||
"user.custom-channel",
|
||||
"canvas",
|
||||
"creation",
|
||||
"agent"
|
||||
],
|
||||
"baseUrl": "https://ark.cn-beijing.volces.com",
|
||||
"requiresPublicMediaUrls": true,
|
||||
"auth": {
|
||||
"type": "bearer",
|
||||
"field": "apiKey"
|
||||
},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "model",
|
||||
"type": "string",
|
||||
"required": true,
|
||||
"mapping": "model",
|
||||
"description": "Ark endpoint/model ID。"
|
||||
},
|
||||
{
|
||||
"name": "prompt",
|
||||
"type": "string",
|
||||
"required": true,
|
||||
"mapping": "content[type=text].text",
|
||||
"description": "视频提示词。"
|
||||
},
|
||||
{
|
||||
"name": "images",
|
||||
"type": "media[]",
|
||||
"required": false,
|
||||
"mapping": "content[type=image_url]",
|
||||
"description": "first_frame、last_frame、reference_image 等 role 原样映射。"
|
||||
},
|
||||
{
|
||||
"name": "videos",
|
||||
"type": "media[]",
|
||||
"required": false,
|
||||
"mapping": "content[type=video_url]",
|
||||
"description": "reference_video。"
|
||||
},
|
||||
{
|
||||
"name": "audios",
|
||||
"type": "media[]",
|
||||
"required": false,
|
||||
"mapping": "content[type=audio_url]",
|
||||
"description": "reference_audio/reference_voice。"
|
||||
},
|
||||
{
|
||||
"name": "aspectRatio",
|
||||
"type": "string",
|
||||
"required": false,
|
||||
"mapping": "ratio",
|
||||
"description": "输出画幅。"
|
||||
},
|
||||
{
|
||||
"name": "resolution",
|
||||
"type": "string",
|
||||
"required": false,
|
||||
"mapping": "resolution",
|
||||
"description": "输出分辨率档位。"
|
||||
},
|
||||
{
|
||||
"name": "duration",
|
||||
"type": "integer",
|
||||
"required": false,
|
||||
"mapping": "duration",
|
||||
"description": "输出时长秒数。"
|
||||
},
|
||||
{
|
||||
"name": "generateAudio",
|
||||
"type": "boolean",
|
||||
"required": false,
|
||||
"mapping": "generate_audio",
|
||||
"description": "是否生成音频。"
|
||||
},
|
||||
{
|
||||
"name": "watermark",
|
||||
"type": "boolean",
|
||||
"required": false,
|
||||
"mapping": "watermark",
|
||||
"description": "是否带水印。"
|
||||
},
|
||||
{
|
||||
"name": "seed",
|
||||
"type": "integer",
|
||||
"required": false,
|
||||
"mapping": "seed",
|
||||
"description": "providerOptions seed。"
|
||||
},
|
||||
{
|
||||
"name": "camera_fixed",
|
||||
"type": "boolean",
|
||||
"required": false,
|
||||
"mapping": "camera_fixed",
|
||||
"description": "providerOptions camera_fixed。"
|
||||
}
|
||||
],
|
||||
"validations": [
|
||||
{
|
||||
"assert": {
|
||||
"$lte": [
|
||||
{
|
||||
"$len": {
|
||||
"$ref": "request.images"
|
||||
}
|
||||
},
|
||||
9
|
||||
]
|
||||
},
|
||||
"message": "Seedance 最多支持 9 张参考图片"
|
||||
},
|
||||
{
|
||||
"assert": {
|
||||
"$lte": [
|
||||
{
|
||||
"$len": {
|
||||
"$ref": "request.videos"
|
||||
}
|
||||
},
|
||||
3
|
||||
]
|
||||
},
|
||||
"message": "Seedance 最多支持 3 个参考视频"
|
||||
},
|
||||
{
|
||||
"assert": {
|
||||
"$lte": [
|
||||
{
|
||||
"$len": {
|
||||
"$ref": "request.audios"
|
||||
}
|
||||
},
|
||||
3
|
||||
]
|
||||
},
|
||||
"message": "Seedance 最多支持 3 个参考音频"
|
||||
},
|
||||
{
|
||||
"assert": {
|
||||
"$or": [
|
||||
{
|
||||
"$eq": [
|
||||
{
|
||||
"$len": {
|
||||
"$ref": "request.audios"
|
||||
}
|
||||
},
|
||||
0
|
||||
]
|
||||
},
|
||||
{
|
||||
"$gt": [
|
||||
{
|
||||
"$add": [
|
||||
{
|
||||
"$len": {
|
||||
"$ref": "request.images"
|
||||
}
|
||||
},
|
||||
{
|
||||
"$len": {
|
||||
"$ref": "request.videos"
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
0
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
"message": "Seedance 不支持纯音频或文本+音频,请同时添加参考图片或参考视频"
|
||||
}
|
||||
],
|
||||
"create": {
|
||||
"method": "POST",
|
||||
"path": "/api/plan/v3/contents/generations/tasks",
|
||||
"contentType": "application/json",
|
||||
"body": {
|
||||
"model": {
|
||||
"$ref": "request.model"
|
||||
},
|
||||
"content": {
|
||||
"$concatArrays": [
|
||||
[
|
||||
{
|
||||
"type": "text",
|
||||
"text": {
|
||||
"$ref": "request.prompt"
|
||||
}
|
||||
}
|
||||
],
|
||||
{
|
||||
"$map": {
|
||||
"from": {
|
||||
"$sortByOrder": {
|
||||
"$ref": "request.images"
|
||||
}
|
||||
},
|
||||
"as": "media",
|
||||
"in": {
|
||||
"type": "image_url",
|
||||
"image_url": {
|
||||
"url": {
|
||||
"$ref": "media.value"
|
||||
}
|
||||
},
|
||||
"role": {
|
||||
"$coalesce": [
|
||||
{
|
||||
"$ref": "media.role"
|
||||
},
|
||||
"reference_image"
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"$map": {
|
||||
"from": {
|
||||
"$sortByOrder": {
|
||||
"$ref": "request.videos"
|
||||
}
|
||||
},
|
||||
"as": "media",
|
||||
"in": {
|
||||
"type": "video_url",
|
||||
"video_url": {
|
||||
"url": {
|
||||
"$ref": "media.value"
|
||||
}
|
||||
},
|
||||
"role": {
|
||||
"$coalesce": [
|
||||
{
|
||||
"$ref": "media.role"
|
||||
},
|
||||
"reference_video"
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"$map": {
|
||||
"from": {
|
||||
"$sortByOrder": {
|
||||
"$ref": "request.audios"
|
||||
}
|
||||
},
|
||||
"as": "media",
|
||||
"in": {
|
||||
"type": "audio_url",
|
||||
"audio_url": {
|
||||
"url": {
|
||||
"$ref": "media.value"
|
||||
}
|
||||
},
|
||||
"role": {
|
||||
"$coalesce": [
|
||||
{
|
||||
"$ref": "media.role"
|
||||
},
|
||||
"reference_audio"
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"ratio": {
|
||||
"$coalesce": [
|
||||
{
|
||||
"$ref": "request.aspectRatio"
|
||||
},
|
||||
"16:9"
|
||||
]
|
||||
},
|
||||
"resolution": {
|
||||
"$coalesce": [
|
||||
{
|
||||
"$ref": "request.resolution"
|
||||
},
|
||||
"720p"
|
||||
]
|
||||
},
|
||||
"duration": {
|
||||
"$if": {
|
||||
"condition": {
|
||||
"$gt": [
|
||||
{
|
||||
"$ref": "request.duration"
|
||||
},
|
||||
0
|
||||
]
|
||||
},
|
||||
"then": {
|
||||
"$ref": "request.duration"
|
||||
},
|
||||
"else": 5
|
||||
}
|
||||
},
|
||||
"generate_audio": {
|
||||
"$ref": "request.generateAudio"
|
||||
},
|
||||
"watermark": {
|
||||
"$ref": "request.watermark"
|
||||
},
|
||||
"seed": {
|
||||
"$omitEmpty": {
|
||||
"$ref": "request.providerOptions.volcengine-ark-agent-plan-video.seed"
|
||||
}
|
||||
},
|
||||
"camera_fixed": {
|
||||
"$omitEmpty": {
|
||||
"$ref": "request.providerOptions.volcengine-ark-agent-plan-video.camera_fixed"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"poll": {
|
||||
"method": "GET",
|
||||
"path": "/api/plan/v3/contents/generations/tasks/{{taskId}}"
|
||||
},
|
||||
"cancel": {
|
||||
"method": "DELETE",
|
||||
"path": "/api/plan/v3/contents/generations/tasks/{{taskId}}"
|
||||
},
|
||||
"response": {
|
||||
"taskId": {
|
||||
"$coalesce": [
|
||||
{
|
||||
"$ref": "response.id"
|
||||
},
|
||||
{
|
||||
"$ref": "response.task_id"
|
||||
},
|
||||
{
|
||||
"$ref": "response.data.id"
|
||||
},
|
||||
{
|
||||
"$ref": "taskId"
|
||||
}
|
||||
]
|
||||
},
|
||||
"status": {
|
||||
"$coalesce": [
|
||||
{
|
||||
"$ref": "response.status"
|
||||
},
|
||||
{
|
||||
"$ref": "response.data.status"
|
||||
},
|
||||
"pending"
|
||||
]
|
||||
},
|
||||
"message": {
|
||||
"$coalesce": [
|
||||
{
|
||||
"$ref": "response.error.message"
|
||||
},
|
||||
{
|
||||
"$ref": "response.message"
|
||||
},
|
||||
{
|
||||
"$ref": "response.fail_reason"
|
||||
}
|
||||
]
|
||||
},
|
||||
"videos": {
|
||||
"$coalesce": [
|
||||
{
|
||||
"$ref": "response.content.video_url"
|
||||
},
|
||||
{
|
||||
"$ref": "response.video_url"
|
||||
},
|
||||
{
|
||||
"$ref": "response.output.video_url"
|
||||
},
|
||||
{
|
||||
"$ref": "response.data.video_url"
|
||||
}
|
||||
]
|
||||
},
|
||||
"usage": {
|
||||
"$ref": "response.usage"
|
||||
},
|
||||
"errorPaths": [
|
||||
"error.code"
|
||||
],
|
||||
"resultEphemeral": true
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
```
|
||||
<!-- YINGCE_MANIFEST_CONTRACT_END -->
|
||||
431
plugin-packages/volcengine-ark-agent-plan-seedance/manifest.json
Normal file
431
plugin-packages/volcengine-ark-agent-plan-seedance/manifest.json
Normal file
File diff suppressed because one or more lines are too long
BIN
plugin-packages/volcengine-ark-agent-plan-seedream.yingce-plugin
Normal file
BIN
plugin-packages/volcengine-ark-agent-plan-seedream.yingce-plugin
Normal file
Binary file not shown.
@@ -0,0 +1,5 @@
|
||||
# Volcengine Ark Agent Plan Seedream Images
|
||||
|
||||
该目录是独立官方协议插件源码。后端从生成的 `volcengine-ark-agent-plan-seedream.yingce-plugin` 包加载,不依赖系统内置 `host:` 适配器。
|
||||
|
||||
完整接口见 [docs/interface.md](docs/interface.md)。
|
||||
@@ -0,0 +1,418 @@
|
||||
# Volcengine Ark Agent Plan Seedream Images 接口字段
|
||||
|
||||
## 协议身份
|
||||
|
||||
- 插件 ID:`volcengine-ark-agent-plan-seedream`。
|
||||
- Provider ID:`volcengine-ark-agent-plan-image`。
|
||||
- 能力:`image`。
|
||||
- 默认 Base URL:`https://ark.cn-beijing.volces.com`。
|
||||
- 鉴权驱动:`bearer`。
|
||||
- 创建:`POST /api/plan/v3/images/generations`。
|
||||
- 生命周期:同步响应。
|
||||
|
||||
## 配置字段
|
||||
|
||||
| 字段 | 类型 | 必填 | 含义 |
|
||||
| --- | --- | --- | --- |
|
||||
| `apiKey` | secret | 是 | API Key |
|
||||
|
||||
## 统一字段映射
|
||||
|
||||
| 统一字段 | 类型 | 必填 | 上游映射 | 说明 |
|
||||
| --- | --- | --- | --- | --- |
|
||||
| `model` | string | 是 | `model` | 图片模型 ID。 |
|
||||
| `prompt` | string | 是 | `prompt` | 图片提示词。 |
|
||||
| `images` | media[] | 否 | `provider image/reference fields` | 参考图或编辑源图,role 由业务层确定。 |
|
||||
| `imageCount` | integer | 否 | `n/sample_count` | 输出数量。 |
|
||||
| `aspectRatio` | string | 否 | `size/aspect_ratio` | 比例或尺寸,语义按协议说明。 |
|
||||
| `resolution` | string | 否 | `resolution/imageSize` | 分辨率档位。 |
|
||||
| `quality` | string | 否 | `quality` | 质量档位。 |
|
||||
| `providerOptions` | object | 否 | `provider-specific fields` | 插件命名空间内的厂商扩展字段。 |
|
||||
|
||||
## 上游请求模板逐字段清单
|
||||
|
||||
下表由插件请求模板生成,覆盖 body、query、headers 和 multipart 文件声明中的每个字段。
|
||||
|
||||
| 上游位置 | 值或转换表达式 |
|
||||
| --- | --- |
|
||||
| `create.method` | `"POST"` |
|
||||
| `create.path` | `"/api/plan/v3/images/generations"` |
|
||||
| `create.contentType` | `"application/json"` |
|
||||
| `create.body.model` | `{"$ref":"request.model"}` |
|
||||
| `create.body.prompt` | `{"$ref":"request.prompt"}` |
|
||||
| `create.body.size` | `{"$omitEmpty":{"$switch":{"cases":[{"when":{"$eq":[{"$ref":"request.aspectRatio"},"auto"]},"then":"2k"},{"when":{"$eq":[{"$ref":"request.aspectRatio"},"1:1"]},"then":"2048x2048"},{"when":{"$eq":[{"$ref":"request.aspectRatio"},"4:3"]},"then":"2304x1728"},{"when":{"$eq":[{"$ref":"request.aspectRatio"},"3:4"]},"then":"1728x2304"},{"when":{"$eq":[{"$ref":"request.aspectRatio"},"16:9"]},"then":"2560x1440"},{"when":{"$eq":[{"$ref":"request.aspectRatio"},"9:16"]},"then":"1440x2560"},{"when":{"$eq":[{"$ref":"request.aspectRatio"},"3:2"]},"then":"2496x1664"},{"when":{"$eq":[{"$ref":"request.aspectRatio"},"2:3"]},"then":"1664x2496"},{"when":{"$eq":[{"$ref":"request.aspectRatio"},"21:9"]},"then":"3024x1296"}],"default":{"$ref":"request.aspectRatio"}}}}` |
|
||||
| `create.body.image` | `{"$omitEmpty":{"$if":{"condition":{"$eq":[{"$len":{"$ref":"request.images"}},1]},"then":{"$first":{"$map":{"from":{"$ref":"request.images"},"as":"media","in":{"$ref":"media.value"}}}},"else":{"$if":{"condition":{"$gt":[{"$len":{"$ref":"request.images"}},1]},"then":{"$map":{"from":{"$ref":"request.images"},"as":"media","in":{"$ref":"media.value"}}},"else":null}}}}}` |
|
||||
| `create.body.sequential_image_generation` | `{"$omitEmpty":{"$ref":"request.providerOptions.volcengine-ark-agent-plan-image.sequential_image_generation"}}` |
|
||||
| `create.body.sequential_image_generation_options` | `{"$omitEmpty":{"$ref":"request.providerOptions.volcengine-ark-agent-plan-image.sequential_image_generation_options"}}` |
|
||||
| `create.body.watermark` | `{"$coalesce":[{"$ref":"request.providerOptions.volcengine-ark-agent-plan-image.watermark"},{"$ref":"request.watermark"},false]}` |
|
||||
| `create.body.seed` | `{"$omitEmpty":{"$ref":"request.providerOptions.volcengine-ark-agent-plan-image.seed"}}` |
|
||||
| `create.body.response_format` | `{"$coalesce":[{"$ref":"request.providerOptions.volcengine-ark-agent-plan-image.response_format"},"b64_json"]}` |
|
||||
|
||||
## Provider 扩展键
|
||||
|
||||
- `providerOptions.volcengine-ark-agent-plan-image.response_format`
|
||||
- `providerOptions.volcengine-ark-agent-plan-image.seed`
|
||||
- `providerOptions.volcengine-ark-agent-plan-image.sequential_image_generation`
|
||||
- `providerOptions.volcengine-ark-agent-plan-image.sequential_image_generation_options`
|
||||
- `providerOptions.volcengine-ark-agent-plan-image.watermark`
|
||||
|
||||
动态模型或工作流允许使用文档声明的完整 `parameters/input/extra_body` 对象;该对象是协议本身的开放 schema,不会被宿主裁剪。
|
||||
|
||||
## 响应映射逐字段清单
|
||||
|
||||
| 映射位置 | 上游路径或转换表达式 |
|
||||
| --- | --- |
|
||||
| `response.status` | `"succeeded"` |
|
||||
| `response.images` | `{"$ref":"response.data"}` |
|
||||
| `response.usage` | `{"$ref":"response.usage"}` |
|
||||
| `response.errorPaths[0]` | `"error.code"` |
|
||||
| `response.messagePaths[0]` | `"error.message"` |
|
||||
|
||||
## 响应与错误
|
||||
|
||||
插件把上游 task/status/text/media/usage 映射为统一结果。临时媒体 URL 标记为 ephemeral,由宿主立即下载持久化。HTTP 错误、业务 code 和 error object 保持失败语义,不包装成成功。
|
||||
|
||||
## 兼容边界
|
||||
|
||||
Agent Plan 专属接入:请求路径为 /api/plan/v3/images/generations,必须使用 Agent Plan 控制台专属 API Key;请求体与官方 Seedream 协议一致,但凭证与额度按 AFP 套餐结算,不能与 /api/v3 官方 Key 混用。
|
||||
|
||||
<!-- YINGCE_MANIFEST_CONTRACT_START -->
|
||||
## Manifest 完整接口定义
|
||||
|
||||
以下 JSON 与插件包内实际 `manifest.json` 逐字段一致,覆盖插件身份、权限、配置、鉴权、参数、校验、创建、Agent、查询、取消、结果下载、响应和 Agent 响应映射。`documentation` 字段的值就是当前完整文档;为避免文档在自身内部无限递归,JSON 中仅用等义占位文本表示正文。
|
||||
|
||||
```json
|
||||
{
|
||||
"apiVersion": "yingce.plugin/v2",
|
||||
"id": "volcengine-ark-agent-plan-seedream",
|
||||
"name": "Volcengine Ark Agent Plan Seedream Images",
|
||||
"version": "2.0.0",
|
||||
"author": "Volcengine / 影策",
|
||||
"description": "Volcengine Ark Agent Plan Seedream Images 独立请求协议插件。",
|
||||
"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": "volcengine-ark-agent-plan-image",
|
||||
"label": "Volcengine Ark Agent Plan Seedream Images",
|
||||
"capabilities": [
|
||||
"image"
|
||||
],
|
||||
"scopes": [
|
||||
"admin.system-channel",
|
||||
"user.custom-channel",
|
||||
"canvas",
|
||||
"creation",
|
||||
"agent"
|
||||
],
|
||||
"baseUrl": "https://ark.cn-beijing.volces.com",
|
||||
"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": "/api/plan/v3/images/generations",
|
||||
"contentType": "application/json",
|
||||
"body": {
|
||||
"model": {
|
||||
"$ref": "request.model"
|
||||
},
|
||||
"prompt": {
|
||||
"$ref": "request.prompt"
|
||||
},
|
||||
"size": {
|
||||
"$omitEmpty": {
|
||||
"$switch": {
|
||||
"cases": [
|
||||
{
|
||||
"when": {
|
||||
"$eq": [
|
||||
{
|
||||
"$ref": "request.aspectRatio"
|
||||
},
|
||||
"auto"
|
||||
]
|
||||
},
|
||||
"then": "2k"
|
||||
},
|
||||
{
|
||||
"when": {
|
||||
"$eq": [
|
||||
{
|
||||
"$ref": "request.aspectRatio"
|
||||
},
|
||||
"1:1"
|
||||
]
|
||||
},
|
||||
"then": "2048x2048"
|
||||
},
|
||||
{
|
||||
"when": {
|
||||
"$eq": [
|
||||
{
|
||||
"$ref": "request.aspectRatio"
|
||||
},
|
||||
"4:3"
|
||||
]
|
||||
},
|
||||
"then": "2304x1728"
|
||||
},
|
||||
{
|
||||
"when": {
|
||||
"$eq": [
|
||||
{
|
||||
"$ref": "request.aspectRatio"
|
||||
},
|
||||
"3:4"
|
||||
]
|
||||
},
|
||||
"then": "1728x2304"
|
||||
},
|
||||
{
|
||||
"when": {
|
||||
"$eq": [
|
||||
{
|
||||
"$ref": "request.aspectRatio"
|
||||
},
|
||||
"16:9"
|
||||
]
|
||||
},
|
||||
"then": "2560x1440"
|
||||
},
|
||||
{
|
||||
"when": {
|
||||
"$eq": [
|
||||
{
|
||||
"$ref": "request.aspectRatio"
|
||||
},
|
||||
"9:16"
|
||||
]
|
||||
},
|
||||
"then": "1440x2560"
|
||||
},
|
||||
{
|
||||
"when": {
|
||||
"$eq": [
|
||||
{
|
||||
"$ref": "request.aspectRatio"
|
||||
},
|
||||
"3:2"
|
||||
]
|
||||
},
|
||||
"then": "2496x1664"
|
||||
},
|
||||
{
|
||||
"when": {
|
||||
"$eq": [
|
||||
{
|
||||
"$ref": "request.aspectRatio"
|
||||
},
|
||||
"2:3"
|
||||
]
|
||||
},
|
||||
"then": "1664x2496"
|
||||
},
|
||||
{
|
||||
"when": {
|
||||
"$eq": [
|
||||
{
|
||||
"$ref": "request.aspectRatio"
|
||||
},
|
||||
"21:9"
|
||||
]
|
||||
},
|
||||
"then": "3024x1296"
|
||||
}
|
||||
],
|
||||
"default": {
|
||||
"$ref": "request.aspectRatio"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"image": {
|
||||
"$omitEmpty": {
|
||||
"$if": {
|
||||
"condition": {
|
||||
"$eq": [
|
||||
{
|
||||
"$len": {
|
||||
"$ref": "request.images"
|
||||
}
|
||||
},
|
||||
1
|
||||
]
|
||||
},
|
||||
"then": {
|
||||
"$first": {
|
||||
"$map": {
|
||||
"from": {
|
||||
"$ref": "request.images"
|
||||
},
|
||||
"as": "media",
|
||||
"in": {
|
||||
"$ref": "media.value"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"else": {
|
||||
"$if": {
|
||||
"condition": {
|
||||
"$gt": [
|
||||
{
|
||||
"$len": {
|
||||
"$ref": "request.images"
|
||||
}
|
||||
},
|
||||
1
|
||||
]
|
||||
},
|
||||
"then": {
|
||||
"$map": {
|
||||
"from": {
|
||||
"$ref": "request.images"
|
||||
},
|
||||
"as": "media",
|
||||
"in": {
|
||||
"$ref": "media.value"
|
||||
}
|
||||
}
|
||||
},
|
||||
"else": null
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"sequential_image_generation": {
|
||||
"$omitEmpty": {
|
||||
"$ref": "request.providerOptions.volcengine-ark-agent-plan-image.sequential_image_generation"
|
||||
}
|
||||
},
|
||||
"sequential_image_generation_options": {
|
||||
"$omitEmpty": {
|
||||
"$ref": "request.providerOptions.volcengine-ark-agent-plan-image.sequential_image_generation_options"
|
||||
}
|
||||
},
|
||||
"watermark": {
|
||||
"$coalesce": [
|
||||
{
|
||||
"$ref": "request.providerOptions.volcengine-ark-agent-plan-image.watermark"
|
||||
},
|
||||
{
|
||||
"$ref": "request.watermark"
|
||||
},
|
||||
false
|
||||
]
|
||||
},
|
||||
"seed": {
|
||||
"$omitEmpty": {
|
||||
"$ref": "request.providerOptions.volcengine-ark-agent-plan-image.seed"
|
||||
}
|
||||
},
|
||||
"response_format": {
|
||||
"$coalesce": [
|
||||
{
|
||||
"$ref": "request.providerOptions.volcengine-ark-agent-plan-image.response_format"
|
||||
},
|
||||
"b64_json"
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"response": {
|
||||
"status": "succeeded",
|
||||
"images": {
|
||||
"$ref": "response.data"
|
||||
},
|
||||
"usage": {
|
||||
"$ref": "response.usage"
|
||||
},
|
||||
"errorPaths": [
|
||||
"error.code"
|
||||
],
|
||||
"messagePaths": [
|
||||
"error.message"
|
||||
]
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
```
|
||||
<!-- YINGCE_MANIFEST_CONTRACT_END -->
|
||||
332
plugin-packages/volcengine-ark-agent-plan-seedream/manifest.json
Normal file
332
plugin-packages/volcengine-ark-agent-plan-seedream/manifest.json
Normal file
File diff suppressed because one or more lines are too long
Binary file not shown.
5
plugin-packages/volcengine-ark-seedance/README.md
Normal file
5
plugin-packages/volcengine-ark-seedance/README.md
Normal file
@@ -0,0 +1,5 @@
|
||||
# Volcengine Ark Seedance
|
||||
|
||||
该目录是独立官方协议插件源码。后端从生成的 `volcengine-ark-seedance.yingce-plugin` 包加载,不依赖系统内置 `host:` 适配器。
|
||||
|
||||
完整接口见 [docs/interface.md](docs/interface.md)。
|
||||
527
plugin-packages/volcengine-ark-seedance/docs/interface.md
Normal file
527
plugin-packages/volcengine-ark-seedance/docs/interface.md
Normal file
@@ -0,0 +1,527 @@
|
||||
# Volcengine Ark Seedance 接口字段
|
||||
|
||||
## 协议身份
|
||||
|
||||
- 插件 ID:`volcengine-ark-seedance`。
|
||||
- Provider ID:`volcengine-ark-video`。
|
||||
- 能力:`video`。
|
||||
- 默认 Base URL:`https://ark.cn-beijing.volces.com`。
|
||||
- 鉴权驱动:`bearer`。
|
||||
- 创建:`POST /api/v3/contents/generations/tasks`。
|
||||
- 查询:`GET /api/v3/contents/generations/tasks/{{taskId}}`。
|
||||
- 取消:`DELETE /api/v3/contents/generations/tasks/{{taskId}}`。
|
||||
|
||||
## 配置字段
|
||||
|
||||
| 字段 | 类型 | 必填 | 含义 |
|
||||
| --- | --- | --- | --- |
|
||||
| `apiKey` | secret | 是 | API Key |
|
||||
|
||||
## 统一字段映射
|
||||
|
||||
| 统一字段 | 类型 | 必填 | 上游映射 | 说明 |
|
||||
| --- | --- | --- | --- | --- |
|
||||
| `model` | string | 是 | `model` | Ark endpoint/model ID。 |
|
||||
| `prompt` | string | 是 | `content[type=text].text` | 视频提示词。 |
|
||||
| `images` | media[] | 否 | `content[type=image_url]` | first_frame、last_frame、reference_image 等 role 原样映射。 |
|
||||
| `videos` | media[] | 否 | `content[type=video_url]` | reference_video。 |
|
||||
| `audios` | media[] | 否 | `content[type=audio_url]` | reference_audio/reference_voice。 |
|
||||
| `aspectRatio` | string | 否 | `ratio` | 输出画幅。 |
|
||||
| `resolution` | string | 否 | `resolution` | 输出分辨率档位。 |
|
||||
| `duration` | integer | 否 | `duration` | 输出时长秒数。 |
|
||||
| `generateAudio` | boolean | 否 | `generate_audio` | 是否生成音频。 |
|
||||
| `watermark` | boolean | 否 | `watermark` | 是否带水印。 |
|
||||
| `seed` | integer | 否 | `seed` | providerOptions seed。 |
|
||||
| `camera_fixed` | boolean | 否 | `camera_fixed` | providerOptions camera_fixed。 |
|
||||
|
||||
## 上游请求模板逐字段清单
|
||||
|
||||
下表由插件请求模板生成,覆盖 body、query、headers 和 multipart 文件声明中的每个字段。
|
||||
|
||||
| 上游位置 | 值或转换表达式 |
|
||||
| --- | --- |
|
||||
| `create.method` | `"POST"` |
|
||||
| `create.path` | `"/api/v3/contents/generations/tasks"` |
|
||||
| `create.contentType` | `"application/json"` |
|
||||
| `create.body.model` | `{"$ref":"request.model"}` |
|
||||
| `create.body.content` | `{"$concatArrays":[[{"type":"text","text":{"$ref":"request.prompt"}}],{"$map":{"from":{"$sortByOrder":{"$ref":"request.images"}},"as":"media","in":{"type":"image_url","image_url":{"url":{"$ref":"media.value"}},"role":{"$coalesce":[{"$ref":"media.role"},"reference_image"]}}}},{"$map":{"from":{"$sortByOrder":{"$ref":"request.videos"}},"as":"media","in":{"type":"video_url","video_url":{"url":{"$ref":"media.value"}},"role":{"$coalesce":[{"$ref":"media.role"},"reference_video"]}}}},{"$map":{"from":{"$sortByOrder":{"$ref":"request.audios"}},"as":"media","in":{"type":"audio_url","audio_url":{"url":{"$ref":"media.value"}},"role":{"$coalesce":[{"$ref":"media.role"},"reference_audio"]}}}}]}` |
|
||||
| `create.body.ratio` | `{"$coalesce":[{"$ref":"request.aspectRatio"},"16:9"]}` |
|
||||
| `create.body.resolution` | `{"$coalesce":[{"$ref":"request.resolution"},"720p"]}` |
|
||||
| `create.body.duration` | `{"$if":{"condition":{"$gt":[{"$ref":"request.duration"},0]},"then":{"$ref":"request.duration"},"else":5}}` |
|
||||
| `create.body.generate_audio` | `{"$ref":"request.generateAudio"}` |
|
||||
| `create.body.watermark` | `{"$ref":"request.watermark"}` |
|
||||
| `create.body.seed` | `{"$omitEmpty":{"$ref":"request.providerOptions.volcengine-ark-video.seed"}}` |
|
||||
| `create.body.camera_fixed` | `{"$omitEmpty":{"$ref":"request.providerOptions.volcengine-ark-video.camera_fixed"}}` |
|
||||
| `poll.method` | `"GET"` |
|
||||
| `poll.path` | `"/api/v3/contents/generations/tasks/{{taskId}}"` |
|
||||
| `poll.contentType` | `"application/json"` |
|
||||
| `cancel.method` | `"DELETE"` |
|
||||
| `cancel.path` | `"/api/v3/contents/generations/tasks/{{taskId}}"` |
|
||||
| `cancel.contentType` | `"application/json"` |
|
||||
|
||||
## Provider 扩展键
|
||||
|
||||
- `providerOptions.volcengine-ark-video.camera_fixed`
|
||||
- `providerOptions.volcengine-ark-video.seed`
|
||||
|
||||
动态模型或工作流允许使用文档声明的完整 `parameters/input/extra_body` 对象;该对象是协议本身的开放 schema,不会被宿主裁剪。
|
||||
|
||||
## 响应映射逐字段清单
|
||||
|
||||
| 映射位置 | 上游路径或转换表达式 |
|
||||
| --- | --- |
|
||||
| `response.taskId` | `{"$coalesce":[{"$ref":"response.id"},{"$ref":"response.task_id"},{"$ref":"response.data.id"},{"$ref":"taskId"}]}` |
|
||||
| `response.status` | `{"$coalesce":[{"$ref":"response.status"},{"$ref":"response.data.status"},"pending"]}` |
|
||||
| `response.message` | `{"$coalesce":[{"$ref":"response.error.message"},{"$ref":"response.message"},{"$ref":"response.fail_reason"}]}` |
|
||||
| `response.videos` | `{"$coalesce":[{"$ref":"response.content.video_url"},{"$ref":"response.video_url"},{"$ref":"response.output.video_url"},{"$ref":"response.data.video_url"}]}` |
|
||||
| `response.usage` | `{"$ref":"response.usage"}` |
|
||||
| `response.errorPaths[0]` | `"error.code"` |
|
||||
| `response.resultEphemeral` | `true` |
|
||||
|
||||
## 响应与错误
|
||||
|
||||
插件把上游 task/status/text/media/usage 映射为统一结果。临时媒体 URL 标记为 ephemeral,由宿主立即下载持久化。HTTP 错误、业务 code 和 error object 保持失败语义,不包装成成功。
|
||||
|
||||
## 兼容边界
|
||||
|
||||
官方 Ark 推理接入:创建/查询/取消走 /api/v3/contents/generations/tasks;插件不根据图片下标推断首尾帧,role 由业务层确定。API Key 来自方舟推理接入控制台。
|
||||
|
||||
<!-- YINGCE_MANIFEST_CONTRACT_START -->
|
||||
## Manifest 完整接口定义
|
||||
|
||||
以下 JSON 与插件包内实际 `manifest.json` 逐字段一致,覆盖插件身份、权限、配置、鉴权、参数、校验、创建、Agent、查询、取消、结果下载、响应和 Agent 响应映射。`documentation` 字段的值就是当前完整文档;为避免文档在自身内部无限递归,JSON 中仅用等义占位文本表示正文。
|
||||
|
||||
```json
|
||||
{
|
||||
"apiVersion": "yingce.plugin/v2",
|
||||
"id": "volcengine-ark-seedance",
|
||||
"name": "Volcengine Ark Seedance",
|
||||
"version": "2.0.0",
|
||||
"author": "Volcengine / 影策",
|
||||
"description": "Volcengine Ark Seedance 独立请求协议插件。",
|
||||
"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": "volcengine-ark-video",
|
||||
"label": "Volcengine Ark Seedance",
|
||||
"capabilities": [
|
||||
"video"
|
||||
],
|
||||
"scopes": [
|
||||
"admin.system-channel",
|
||||
"user.custom-channel",
|
||||
"canvas",
|
||||
"creation",
|
||||
"agent"
|
||||
],
|
||||
"baseUrl": "https://ark.cn-beijing.volces.com",
|
||||
"requiresPublicMediaUrls": true,
|
||||
"auth": {
|
||||
"type": "bearer",
|
||||
"field": "apiKey"
|
||||
},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "model",
|
||||
"type": "string",
|
||||
"required": true,
|
||||
"mapping": "model",
|
||||
"description": "Ark endpoint/model ID。"
|
||||
},
|
||||
{
|
||||
"name": "prompt",
|
||||
"type": "string",
|
||||
"required": true,
|
||||
"mapping": "content[type=text].text",
|
||||
"description": "视频提示词。"
|
||||
},
|
||||
{
|
||||
"name": "images",
|
||||
"type": "media[]",
|
||||
"required": false,
|
||||
"mapping": "content[type=image_url]",
|
||||
"description": "first_frame、last_frame、reference_image 等 role 原样映射。"
|
||||
},
|
||||
{
|
||||
"name": "videos",
|
||||
"type": "media[]",
|
||||
"required": false,
|
||||
"mapping": "content[type=video_url]",
|
||||
"description": "reference_video。"
|
||||
},
|
||||
{
|
||||
"name": "audios",
|
||||
"type": "media[]",
|
||||
"required": false,
|
||||
"mapping": "content[type=audio_url]",
|
||||
"description": "reference_audio/reference_voice。"
|
||||
},
|
||||
{
|
||||
"name": "aspectRatio",
|
||||
"type": "string",
|
||||
"required": false,
|
||||
"mapping": "ratio",
|
||||
"description": "输出画幅。"
|
||||
},
|
||||
{
|
||||
"name": "resolution",
|
||||
"type": "string",
|
||||
"required": false,
|
||||
"mapping": "resolution",
|
||||
"description": "输出分辨率档位。"
|
||||
},
|
||||
{
|
||||
"name": "duration",
|
||||
"type": "integer",
|
||||
"required": false,
|
||||
"mapping": "duration",
|
||||
"description": "输出时长秒数。"
|
||||
},
|
||||
{
|
||||
"name": "generateAudio",
|
||||
"type": "boolean",
|
||||
"required": false,
|
||||
"mapping": "generate_audio",
|
||||
"description": "是否生成音频。"
|
||||
},
|
||||
{
|
||||
"name": "watermark",
|
||||
"type": "boolean",
|
||||
"required": false,
|
||||
"mapping": "watermark",
|
||||
"description": "是否带水印。"
|
||||
},
|
||||
{
|
||||
"name": "seed",
|
||||
"type": "integer",
|
||||
"required": false,
|
||||
"mapping": "seed",
|
||||
"description": "providerOptions seed。"
|
||||
},
|
||||
{
|
||||
"name": "camera_fixed",
|
||||
"type": "boolean",
|
||||
"required": false,
|
||||
"mapping": "camera_fixed",
|
||||
"description": "providerOptions camera_fixed。"
|
||||
}
|
||||
],
|
||||
"validations": [
|
||||
{
|
||||
"assert": {
|
||||
"$lte": [
|
||||
{
|
||||
"$len": {
|
||||
"$ref": "request.images"
|
||||
}
|
||||
},
|
||||
9
|
||||
]
|
||||
},
|
||||
"message": "Seedance 最多支持 9 张参考图片"
|
||||
},
|
||||
{
|
||||
"assert": {
|
||||
"$lte": [
|
||||
{
|
||||
"$len": {
|
||||
"$ref": "request.videos"
|
||||
}
|
||||
},
|
||||
3
|
||||
]
|
||||
},
|
||||
"message": "Seedance 最多支持 3 个参考视频"
|
||||
},
|
||||
{
|
||||
"assert": {
|
||||
"$lte": [
|
||||
{
|
||||
"$len": {
|
||||
"$ref": "request.audios"
|
||||
}
|
||||
},
|
||||
3
|
||||
]
|
||||
},
|
||||
"message": "Seedance 最多支持 3 个参考音频"
|
||||
},
|
||||
{
|
||||
"assert": {
|
||||
"$or": [
|
||||
{
|
||||
"$eq": [
|
||||
{
|
||||
"$len": {
|
||||
"$ref": "request.audios"
|
||||
}
|
||||
},
|
||||
0
|
||||
]
|
||||
},
|
||||
{
|
||||
"$gt": [
|
||||
{
|
||||
"$add": [
|
||||
{
|
||||
"$len": {
|
||||
"$ref": "request.images"
|
||||
}
|
||||
},
|
||||
{
|
||||
"$len": {
|
||||
"$ref": "request.videos"
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
0
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
"message": "Seedance 不支持纯音频或文本+音频,请同时添加参考图片或参考视频"
|
||||
}
|
||||
],
|
||||
"create": {
|
||||
"method": "POST",
|
||||
"path": "/api/v3/contents/generations/tasks",
|
||||
"contentType": "application/json",
|
||||
"body": {
|
||||
"model": {
|
||||
"$ref": "request.model"
|
||||
},
|
||||
"content": {
|
||||
"$concatArrays": [
|
||||
[
|
||||
{
|
||||
"type": "text",
|
||||
"text": {
|
||||
"$ref": "request.prompt"
|
||||
}
|
||||
}
|
||||
],
|
||||
{
|
||||
"$map": {
|
||||
"from": {
|
||||
"$sortByOrder": {
|
||||
"$ref": "request.images"
|
||||
}
|
||||
},
|
||||
"as": "media",
|
||||
"in": {
|
||||
"type": "image_url",
|
||||
"image_url": {
|
||||
"url": {
|
||||
"$ref": "media.value"
|
||||
}
|
||||
},
|
||||
"role": {
|
||||
"$coalesce": [
|
||||
{
|
||||
"$ref": "media.role"
|
||||
},
|
||||
"reference_image"
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"$map": {
|
||||
"from": {
|
||||
"$sortByOrder": {
|
||||
"$ref": "request.videos"
|
||||
}
|
||||
},
|
||||
"as": "media",
|
||||
"in": {
|
||||
"type": "video_url",
|
||||
"video_url": {
|
||||
"url": {
|
||||
"$ref": "media.value"
|
||||
}
|
||||
},
|
||||
"role": {
|
||||
"$coalesce": [
|
||||
{
|
||||
"$ref": "media.role"
|
||||
},
|
||||
"reference_video"
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"$map": {
|
||||
"from": {
|
||||
"$sortByOrder": {
|
||||
"$ref": "request.audios"
|
||||
}
|
||||
},
|
||||
"as": "media",
|
||||
"in": {
|
||||
"type": "audio_url",
|
||||
"audio_url": {
|
||||
"url": {
|
||||
"$ref": "media.value"
|
||||
}
|
||||
},
|
||||
"role": {
|
||||
"$coalesce": [
|
||||
{
|
||||
"$ref": "media.role"
|
||||
},
|
||||
"reference_audio"
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"ratio": {
|
||||
"$coalesce": [
|
||||
{
|
||||
"$ref": "request.aspectRatio"
|
||||
},
|
||||
"16:9"
|
||||
]
|
||||
},
|
||||
"resolution": {
|
||||
"$coalesce": [
|
||||
{
|
||||
"$ref": "request.resolution"
|
||||
},
|
||||
"720p"
|
||||
]
|
||||
},
|
||||
"duration": {
|
||||
"$if": {
|
||||
"condition": {
|
||||
"$gt": [
|
||||
{
|
||||
"$ref": "request.duration"
|
||||
},
|
||||
0
|
||||
]
|
||||
},
|
||||
"then": {
|
||||
"$ref": "request.duration"
|
||||
},
|
||||
"else": 5
|
||||
}
|
||||
},
|
||||
"generate_audio": {
|
||||
"$ref": "request.generateAudio"
|
||||
},
|
||||
"watermark": {
|
||||
"$ref": "request.watermark"
|
||||
},
|
||||
"seed": {
|
||||
"$omitEmpty": {
|
||||
"$ref": "request.providerOptions.volcengine-ark-video.seed"
|
||||
}
|
||||
},
|
||||
"camera_fixed": {
|
||||
"$omitEmpty": {
|
||||
"$ref": "request.providerOptions.volcengine-ark-video.camera_fixed"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"poll": {
|
||||
"method": "GET",
|
||||
"path": "/api/v3/contents/generations/tasks/{{taskId}}"
|
||||
},
|
||||
"cancel": {
|
||||
"method": "DELETE",
|
||||
"path": "/api/v3/contents/generations/tasks/{{taskId}}"
|
||||
},
|
||||
"response": {
|
||||
"taskId": {
|
||||
"$coalesce": [
|
||||
{
|
||||
"$ref": "response.id"
|
||||
},
|
||||
{
|
||||
"$ref": "response.task_id"
|
||||
},
|
||||
{
|
||||
"$ref": "response.data.id"
|
||||
},
|
||||
{
|
||||
"$ref": "taskId"
|
||||
}
|
||||
]
|
||||
},
|
||||
"status": {
|
||||
"$coalesce": [
|
||||
{
|
||||
"$ref": "response.status"
|
||||
},
|
||||
{
|
||||
"$ref": "response.data.status"
|
||||
},
|
||||
"pending"
|
||||
]
|
||||
},
|
||||
"message": {
|
||||
"$coalesce": [
|
||||
{
|
||||
"$ref": "response.error.message"
|
||||
},
|
||||
{
|
||||
"$ref": "response.message"
|
||||
},
|
||||
{
|
||||
"$ref": "response.fail_reason"
|
||||
}
|
||||
]
|
||||
},
|
||||
"videos": {
|
||||
"$coalesce": [
|
||||
{
|
||||
"$ref": "response.content.video_url"
|
||||
},
|
||||
{
|
||||
"$ref": "response.video_url"
|
||||
},
|
||||
{
|
||||
"$ref": "response.output.video_url"
|
||||
},
|
||||
{
|
||||
"$ref": "response.data.video_url"
|
||||
}
|
||||
]
|
||||
},
|
||||
"usage": {
|
||||
"$ref": "response.usage"
|
||||
},
|
||||
"errorPaths": [
|
||||
"error.code"
|
||||
],
|
||||
"resultEphemeral": true
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
```
|
||||
<!-- YINGCE_MANIFEST_CONTRACT_END -->
|
||||
431
plugin-packages/volcengine-ark-seedance/manifest.json
Normal file
431
plugin-packages/volcengine-ark-seedance/manifest.json
Normal file
File diff suppressed because one or more lines are too long
Binary file not shown.
@@ -74,7 +74,7 @@
|
||||
|
||||
## 兼容边界
|
||||
|
||||
该包只代表上述线协议 profile;同一品牌的其他 endpoint、云区域或网关包装必须使用独立插件,不能根据模型名猜测。
|
||||
官方 Ark 推理接入:Base URL 使用 /api/v3,API Key 来自方舟推理接入控制台,不可与 Agent Plan 专属 Key 混用。
|
||||
|
||||
<!-- YINGCE_MANIFEST_CONTRACT_START -->
|
||||
## Manifest 完整接口定义
|
||||
|
||||
File diff suppressed because one or more lines are too long
Reference in New Issue
Block a user