Files

481 lines
33 KiB
JSON
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
{
"apiVersion": "yingce.plugin/v2",
"id": "agnes-video-v20",
"name": "Agnes Video V2.0",
"version": "2.0.0",
"author": "Agnes AI / 影策",
"description": "Agnes Video V2.0 独立请求协议插件。",
"documentation": "# Agnes Video V2.0\n\n该目录是独立官方协议插件源码。后端从生成的 `agnes-video-v20.yingce-plugin` 包加载,不依赖系统内置 `host:` 适配器。\n\n完整接口见 [docs/interface.md](docs/interface.md)。\n\n---\n\n# Agnes Video V2.0 接口字段\n\n## 协议身份\n\n- 插件 ID:`agnes-video-v20`。\n- Provider ID:`agnes-video-v20`。\n- 能力:`video`。\n- 默认 Base URL:`https://apihub.agnes-ai.com/v1`。\n- 鉴权驱动:`bearer`。\n- 创建:`POST /videos`。\n- 查询:`GET /agnesapi`。\n\n## 配置字段\n\n| 字段 | 类型 | 必填 | 含义 |\n| --- | --- | --- | --- |\n| `apiKey` | secret | 是 | API Key |\n\n## 统一字段映射\n\n| 统一字段 | 类型 | 必填 | 上游映射 | 说明 |\n| --- | --- | --- | --- | --- |\n| `model` | string | 是 | `model` | 视频模型 ID。 |\n| `prompt` | string | 是 | `prompt/content/input` | 视频提示词。 |\n| `images` | media[] | 否 | `first/last/reference image` | 显式 role 图片输入。 |\n| `videos` | media[] | 否 | `reference video` | 参考视频。 |\n| `audios` | media[] | 否 | `reference audio/voice` | 参考音频或音色。 |\n| `duration` | integer | 否 | `duration/seconds` | 时长秒数。 |\n| `aspectRatio` | string | 否 | `ratio/aspect_ratio/size` | 画幅比例或尺寸。 |\n| `resolution` | string | 否 | `resolution` | 分辨率档位。 |\n| `generateAudio` | boolean | 否 | `generate_audio` | 是否生成音频。 |\n| `watermark` | boolean | 否 | `watermark` | 水印开关。 |\n| `providerOptions` | object | 否 | `provider-specific fields` | 插件命名空间内的厂商扩展字段。 |\n\n## 上游请求模板逐字段清单\n\n下表由插件请求模板生成,覆盖 body、query、headers 和 multipart 文件声明中的每个字段。\n\n| 上游位置 | 值或转换表达式 |\n| --- | --- |\n| `create.method` | `\"POST\"` |\n| `create.path` | `\"/videos\"` |\n| `create.contentType` | `\"application/json\"` |\n| `create.body.model` | `{\"$ref\":\"request.model\"}` |\n| `create.body.prompt` | `{\"$ref\":\"request.prompt\"}` |\n| `create.body.frame_rate` | `24` |\n| `create.body.num_frames` | `{\"$min\":[441,{\"$add\":[{\"$ceilStep\":[{\"$multiply\":[{\"$coalesce\":[{\"$ref\":\"request.duration\"},5]},24]},8]},1]}]}` |\n| `create.body.image` | `{\"$if\":{\"condition\":{\"$eq\":[{\"$len\":{\"$filter\":{\"from\":{\"$sortByOrder\":{\"$ref\":\"request.images\"}},\"as\":\"media\",\"where\":{\"$in\":[{\"$ref\":\"media.role\"},[\"first_frame\",\"last_frame\"]]}}}},1]},\"then\":{\"$first\":{\"$map\":{\"from\":{\"$filter\":{\"from\":{\"$sortByOrder\":{\"$ref\":\"request.images\"}},\"as\":\"media\",\"where\":{\"$in\":[{\"$ref\":\"media.role\"},[\"first_frame\",\"last_frame\"]]}}},\"as\":\"media\",\"in\":{\"$ref\":\"media.value\"}}}},\"else\":null}}` |\n| `create.body.extra_body` | `{\"$if\":{\"condition\":{\"$gt\":[{\"$len\":{\"$filter\":{\"from\":{\"$sortByOrder\":{\"$ref\":\"request.images\"}},\"as\":\"media\",\"where\":{\"$in\":[{\"$ref\":\"media.role\"},[\"first_frame\",\"last_frame\"]]}}}},1]},\"then\":{\"image\":{\"$map\":{\"from\":{\"$filter\":{\"from\":{\"$sortByOrder\":{\"$ref\":\"request.images\"}},\"as\":\"media\",\"where\":{\"$in\":[{\"$ref\":\"media.role\"},[\"first_frame\",\"last_frame\"]]}}},\"as\":\"media\",\"in\":{\"$ref\":\"media.value\"}}},\"mode\":\"keyframes\"},\"else\":null}}` |\n| `poll.method` | `\"GET\"` |\n| `poll.path` | `\"/agnesapi\"` |\n| `poll.contentType` | `\"application/json\"` |\n| `poll.query.video_id` | `{\"$ref\":\"taskId\"}` |\n| `poll.query.model_name` | `{\"$ref\":\"request.model\"}` |\n\n## Provider 扩展键\n\n- 无额外扩展键。\n\n动态模型或工作流允许使用文档声明的完整 `parameters/input/extra_body` 对象;该对象是协议本身的开放 schema,不会被宿主裁剪。\n\n## 响应映射逐字段清单\n\n| 映射位置 | 上游路径或转换表达式 |\n| --- | --- |\n| `response.taskId` | `{\"$coalesce\":[{\"$ref\":\"response.data.video_id\"},{\"$ref\":\"response.video_id\"},{\"$ref\":\"response.data.id\"},{\"$ref\":\"response.id\"},{\"$ref\":\"taskId\"}]}` |\n| `response.status` | `{\"$coalesce\":[{\"$ref\":\"response.data.status\"},{\"$ref\":\"response.status\"},\"pending\"]}` |\n| `response.message` | `{\"$coalesce\":[{\"$ref\":\"response.data.error.message\"},{\"$ref\":\"response.error.message\"},{\"$ref\":\"response.message\"},{\"$ref\":\"response.detail\"}]}` |\n| `response.videos` | `{\"$coalesce\":[{\"$ref\":\"response.data.metadata.url\"},{\"$ref\":\"response.metadata.url\"},{\"$ref\":\"response.data.url\"},{\"$ref\":\"response.url\"}]}` |\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该包只代表上述线协议 profile;同一品牌的其他 endpoint、云区域或网关包装必须使用独立插件,不能根据模型名猜测。\n\n<!-- YINGCE_MANIFEST_CONTRACT_START -->\n## Manifest 完整接口定义\n\n以下 JSON 与插件包内实际 `manifest.json` 逐字段一致,覆盖插件身份、权限、配置、鉴权、参数、校验、创建、Agent、查询、取消、结果下载、响应和 Agent 响应映射。`documentation` 字段的值就是当前完整文档;为避免文档在自身内部无限递归,JSON 中仅用等义占位文本表示正文。\n\n```json\n{\n \"apiVersion\": \"yingce.plugin/v2\",\n \"id\": \"agnes-video-v20\",\n \"name\": \"Agnes Video V2.0\",\n \"version\": \"2.0.0\",\n \"author\": \"Agnes AI / 影策\",\n \"description\": \"Agnes Video V2.0 独立请求协议插件。\",\n \"documentation\": \"<当前插件的完整 documentation,由 README.md 与 docs/interface.md 拼接而成;为避免 JSON 递归,此处不重复展开正文。>\",\n \"permissions\": [\n \"generation.run\",\n \"media.read\"\n ],\n \"configuration\": {\n \"fields\": [\n {\n \"name\": \"apiKey\",\n \"type\": \"secret\",\n \"label\": \"API Key\",\n \"required\": true\n }\n ]\n },\n \"contributes\": {\n \"providers\": [\n {\n \"id\": \"agnes-video-v20\",\n \"label\": \"Agnes Video V2.0\",\n \"capabilities\": [\n \"video\"\n ],\n \"scopes\": [\n \"admin.system-channel\",\n \"user.custom-channel\",\n \"canvas\",\n \"creation\",\n \"agent\"\n ],\n \"baseUrl\": \"https://apihub.agnes-ai.com/v1\",\n \"requiresPublicMediaUrls\": true,\n \"auth\": {\n \"type\": \"bearer\",\n \"field\": \"apiKey\"\n },\n \"parameters\": [\n {\n \"name\": \"model\",\n \"type\": \"string\",\n \"required\": true,\n \"mapping\": \"model\",\n \"description\": \"视频模型 ID。\"\n },\n {\n \"name\": \"prompt\",\n \"type\": \"string\",\n \"required\": true,\n \"mapping\": \"prompt/content/input\",\n \"description\": \"视频提示词。\"\n },\n {\n \"name\": \"images\",\n \"type\": \"media[]\",\n \"required\": false,\n \"mapping\": \"first/last/reference image\",\n \"description\": \"显式 role 图片输入。\"\n },\n {\n \"name\": \"videos\",\n \"type\": \"media[]\",\n \"required\": false,\n \"mapping\": \"reference video\",\n \"description\": \"参考视频。\"\n },\n {\n \"name\": \"audios\",\n \"type\": \"media[]\",\n \"required\": false,\n \"mapping\": \"reference audio/voice\",\n \"description\": \"参考音频或音色。\"\n },\n {\n \"name\": \"duration\",\n \"type\": \"integer\",\n \"required\": false,\n \"mapping\": \"duration/seconds\",\n \"description\": \"时长秒数。\"\n },\n {\n \"name\": \"aspectRatio\",\n \"type\": \"string\",\n \"required\": false,\n \"mapping\": \"ratio/aspect_ratio/size\",\n \"description\": \"画幅比例或尺寸。\"\n },\n {\n \"name\": \"resolution\",\n \"type\": \"string\",\n \"required\": false,\n \"mapping\": \"resolution\",\n \"description\": \"分辨率档位。\"\n },\n {\n \"name\": \"generateAudio\",\n \"type\": \"boolean\",\n \"required\": false,\n \"mapping\": \"generate_audio\",\n \"description\": \"是否生成音频。\"\n },\n {\n \"name\": \"watermark\",\n \"type\": \"boolean\",\n \"required\": false,\n \"mapping\": \"watermark\",\n \"description\": \"水印开关。\"\n },\n {\n \"name\": \"providerOptions\",\n \"type\": \"object\",\n \"required\": false,\n \"mapping\": \"provider-specific fields\",\n \"description\": \"插件命名空间内的厂商扩展字段。\"\n }\n ],\n \"validations\": [\n {\n \"assert\": {\n \"$eq\": [\n {\n \"$ref\": \"request.model\"\n },\n \"agnes-video-v2.0\"\n ]\n },\n \"message\": \"Agnes Video V2.0 插件仅支持 agnes-video-v2.0\"\n },\n {\n \"assert\": {\n \"$eq\": [\n {\n \"$len\": {\n \"$ref\": \"request.videos\"\n }\n },\n 0\n ]\n },\n \"message\": \"Agnes Video V2.0 不支持参考视频\"\n },\n {\n \"assert\": {\n \"$eq\": [\n {\n \"$len\": {\n \"$ref\": \"request.audios\"\n }\n },\n 0\n ]\n },\n \"message\": \"Agnes Video V2.0 不支持参考音频\"\n },\n {\n \"assert\": {\n \"$eq\": [\n {\n \"$len\": {\n \"$filter\": {\n \"from\": {\n \"$sortByOrder\": {\n \"$ref\": \"request.images\"\n }\n },\n \"as\": \"media\",\n \"where\": {\n \"$in\": [\n {\n \"$ref\": \"media.role\"\n },\n [\n \"reference_image\",\n \"subject_reference\",\n \"style_reference\"\n ]\n ]\n }\n }\n }\n },\n 0\n ]\n },\n \"message\": \"Agnes Video V2.0 不支持角色或风格参考图\"\n },\n {\n \"assert\": {\n \"$lte\": [\n {\n \"$len\": {\n \"$filter\": {\n \"from\": {\n \"$sortByOrder\": {\n \"$ref\": \"request.images\"\n }\n },\n \"as\": \"media\",\n \"where\": {\n \"$in\": [\n {\n \"$ref\": \"media.role\"\n },\n [\n \"first_frame\",\n \"last_frame\"\n ]\n ]\n }\n }\n }\n },\n 2\n ]\n },\n \"message\": \"Agnes Video V2.0 最多支持首帧和尾帧各一张\"\n }\n ],\n \"create\": {\n \"method\": \"POST\",\n \"path\": \"/videos\",\n \"contentType\": \"application/json\",\n \"body\": {\n \"model\": {\n \"$ref\": \"request.model\"\n },\n \"prompt\": {\n \"$ref\": \"request.prompt\"\n },\n \"frame_rate\": 24,\n \"num_frames\": {\n \"$min\": [\n 441,\n {\n \"$add\": [\n {\n \"$ceilStep\": [\n {\n \"$multiply\": [\n {\n \"$coalesce\": [\n {\n \"$ref\": \"request.duration\"\n },\n 5\n ]\n },\n 24\n ]\n },\n 8\n ]\n },\n 1\n ]\n }\n ]\n },\n \"image\": {\n \"$if\": {\n \"condition\": {\n \"$eq\": [\n {\n \"$len\": {\n \"$filter\": {\n \"from\": {\n \"$sortByOrder\": {\n \"$ref\": \"request.images\"\n }\n },\n \"as\": \"media\",\n \"where\": {\n \"$in\": [\n {\n \"$ref\": \"media.role\"\n },\n [\n \"first_frame\",\n \"last_frame\"\n ]\n ]\n }\n }\n }\n },\n 1\n ]\n },\n \"then\": {\n \"$first\": {\n \"$map\": {\n \"from\": {\n \"$filter\": {\n \"from\": {\n \"$sortByOrder\": {\n \"$ref\": \"request.images\"\n }\n },\n \"as\": \"media\",\n \"where\": {\n \"$in\": [\n {\n \"$ref\": \"media.role\"\n },\n [\n \"first_frame\",\n \"last_frame\"\n ]\n ]\n }\n }\n },\n \"as\": \"media\",\n \"in\": {\n \"$ref\": \"media.value\"\n }\n }\n }\n },\n \"else\": null\n }\n },\n \"extra_body\": {\n \"$if\": {\n \"condition\": {\n \"$gt\": [\n {\n \"$len\": {\n \"$filter\": {\n \"from\": {\n \"$sortByOrder\": {\n \"$ref\": \"request.images\"\n }\n },\n \"as\": \"media\",\n \"where\": {\n \"$in\": [\n {\n \"$ref\": \"media.role\"\n },\n [\n \"first_frame\",\n \"last_frame\"\n ]\n ]\n }\n }\n }\n },\n 1\n ]\n },\n \"then\": {\n \"image\": {\n \"$map\": {\n \"from\": {\n \"$filter\": {\n \"from\": {\n \"$sortByOrder\": {\n \"$ref\": \"request.images\"\n }\n },\n \"as\": \"media\",\n \"where\": {\n \"$in\": [\n {\n \"$ref\": \"media.role\"\n },\n [\n \"first_frame\",\n \"last_frame\"\n ]\n ]\n }\n }\n },\n \"as\": \"media\",\n \"in\": {\n \"$ref\": \"media.value\"\n }\n }\n },\n \"mode\": \"keyframes\"\n },\n \"else\": null\n }\n }\n }\n },\n \"poll\": {\n \"method\": \"GET\",\n \"path\": \"/agnesapi\",\n \"originPath\": true,\n \"query\": {\n \"video_id\": {\n \"$ref\": \"taskId\"\n },\n \"model_name\": {\n \"$ref\": \"request.model\"\n }\n }\n },\n \"response\": {\n \"taskId\": {\n \"$coalesce\": [\n {\n \"$ref\": \"response.data.video_id\"\n },\n {\n \"$ref\": \"response.video_id\"\n },\n {\n \"$ref\": \"response.data.id\"\n },\n {\n \"$ref\": \"response.id\"\n },\n {\n \"$ref\": \"taskId\"\n }\n ]\n },\n \"status\": {\n \"$coalesce\": [\n {\n \"$ref\": \"response.data.status\"\n },\n {\n \"$ref\": \"response.status\"\n },\n \"pending\"\n ]\n },\n \"message\": {\n \"$coalesce\": [\n {\n \"$ref\": \"response.data.error.message\"\n },\n {\n \"$ref\": \"response.error.message\"\n },\n {\n \"$ref\": \"response.message\"\n },\n {\n \"$ref\": \"response.detail\"\n }\n ]\n },\n \"videos\": {\n \"$coalesce\": [\n {\n \"$ref\": \"response.data.metadata.url\"\n },\n {\n \"$ref\": \"response.metadata.url\"\n },\n {\n \"$ref\": \"response.data.url\"\n },\n {\n \"$ref\": \"response.url\"\n }\n ]\n },\n \"errorPaths\": [\n \"error.code\"\n ],\n \"resultEphemeral\": true\n }\n }\n ]\n }\n}\n```\n<!-- YINGCE_MANIFEST_CONTRACT_END -->\n",
"permissions": [
"generation.run",
"media.read"
],
"configuration": {
"fields": [
{
"name": "apiKey",
"type": "secret",
"label": "API Key",
"required": true
}
]
},
"contributes": {
"providers": [
{
"id": "agnes-video-v20",
"label": "Agnes Video V2.0",
"capabilities": [
"video"
],
"scopes": [
"admin.system-channel",
"user.custom-channel",
"canvas",
"creation",
"agent"
],
"baseUrl": "https://apihub.agnes-ai.com/v1",
"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": "插件命名空间内的厂商扩展字段。"
}
],
"validations": [
{
"assert": {
"$eq": [
{
"$ref": "request.model"
},
"agnes-video-v2.0"
]
},
"message": "Agnes Video V2.0 插件仅支持 agnes-video-v2.0"
},
{
"assert": {
"$eq": [
{
"$len": {
"$ref": "request.videos"
}
},
0
]
},
"message": "Agnes Video V2.0 不支持参考视频"
},
{
"assert": {
"$eq": [
{
"$len": {
"$ref": "request.audios"
}
},
0
]
},
"message": "Agnes Video V2.0 不支持参考音频"
},
{
"assert": {
"$eq": [
{
"$len": {
"$filter": {
"from": {
"$sortByOrder": {
"$ref": "request.images"
}
},
"as": "media",
"where": {
"$in": [
{
"$ref": "media.role"
},
[
"reference_image",
"subject_reference",
"style_reference"
]
]
}
}
}
},
0
]
},
"message": "Agnes Video V2.0 不支持角色或风格参考图"
},
{
"assert": {
"$lte": [
{
"$len": {
"$filter": {
"from": {
"$sortByOrder": {
"$ref": "request.images"
}
},
"as": "media",
"where": {
"$in": [
{
"$ref": "media.role"
},
[
"first_frame",
"last_frame"
]
]
}
}
}
},
2
]
},
"message": "Agnes Video V2.0 最多支持首帧和尾帧各一张"
}
],
"create": {
"method": "POST",
"path": "/videos",
"contentType": "application/json",
"body": {
"model": {
"$ref": "request.model"
},
"prompt": {
"$ref": "request.prompt"
},
"frame_rate": 24,
"num_frames": {
"$min": [
441,
{
"$add": [
{
"$ceilStep": [
{
"$multiply": [
{
"$coalesce": [
{
"$ref": "request.duration"
},
5
]
},
24
]
},
8
]
},
1
]
}
]
},
"image": {
"$if": {
"condition": {
"$eq": [
{
"$len": {
"$filter": {
"from": {
"$sortByOrder": {
"$ref": "request.images"
}
},
"as": "media",
"where": {
"$in": [
{
"$ref": "media.role"
},
[
"first_frame",
"last_frame"
]
]
}
}
}
},
1
]
},
"then": {
"$first": {
"$map": {
"from": {
"$filter": {
"from": {
"$sortByOrder": {
"$ref": "request.images"
}
},
"as": "media",
"where": {
"$in": [
{
"$ref": "media.role"
},
[
"first_frame",
"last_frame"
]
]
}
}
},
"as": "media",
"in": {
"$ref": "media.value"
}
}
}
},
"else": null
}
},
"extra_body": {
"$if": {
"condition": {
"$gt": [
{
"$len": {
"$filter": {
"from": {
"$sortByOrder": {
"$ref": "request.images"
}
},
"as": "media",
"where": {
"$in": [
{
"$ref": "media.role"
},
[
"first_frame",
"last_frame"
]
]
}
}
}
},
1
]
},
"then": {
"image": {
"$map": {
"from": {
"$filter": {
"from": {
"$sortByOrder": {
"$ref": "request.images"
}
},
"as": "media",
"where": {
"$in": [
{
"$ref": "media.role"
},
[
"first_frame",
"last_frame"
]
]
}
}
},
"as": "media",
"in": {
"$ref": "media.value"
}
}
},
"mode": "keyframes"
},
"else": null
}
}
}
},
"poll": {
"method": "GET",
"path": "/agnesapi",
"originPath": true,
"query": {
"video_id": {
"$ref": "taskId"
},
"model_name": {
"$ref": "request.model"
}
}
},
"response": {
"taskId": {
"$coalesce": [
{
"$ref": "response.data.video_id"
},
{
"$ref": "response.video_id"
},
{
"$ref": "response.data.id"
},
{
"$ref": "response.id"
},
{
"$ref": "taskId"
}
]
},
"status": {
"$coalesce": [
{
"$ref": "response.data.status"
},
{
"$ref": "response.status"
},
"pending"
]
},
"message": {
"$coalesce": [
{
"$ref": "response.data.error.message"
},
{
"$ref": "response.error.message"
},
{
"$ref": "response.message"
},
{
"$ref": "response.detail"
}
]
},
"videos": {
"$coalesce": [
{
"$ref": "response.data.metadata.url"
},
{
"$ref": "response.metadata.url"
},
{
"$ref": "response.data.url"
},
{
"$ref": "response.url"
}
]
},
"errorPaths": [
"error.code"
],
"resultEphemeral": true
}
}
]
}
}