14 KiB
14 KiB
DashScope Wanx Image 接口字段
协议身份
- 插件 ID：
dashscope-wanx-image。 - Provider ID：
dashscope-wanx-image。 - 能力：
image。 - 默认 Base URL：
https://dashscope.aliyuncs.com。 - 鉴权驱动：
bearer。 - 创建：
POST /api/v1/services/aigc/text2image/image-synthesis。 - 查询：
GET /api/v1/tasks/{{taskId}}。
配置字段
| 字段 | 类型 | 必填 | 含义 |
|---|---|---|---|
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/v1/services/aigc/text2image/image-synthesis" |
create.contentType |
"application/json" |
create.body.model |
{"$ref":"request.model"} |
create.body.input.prompt |
{"$ref":"request.prompt"} |
create.body.input.negative_prompt |
{"$omitEmpty":{"$ref":"request.providerOptions.dashscope-wanx-image.negative_prompt"}} |
create.body.input.ref_img |
{"$omitEmpty":{"$if":{"condition":{"$eq":[{"$len":{"$ref":"request.images"}},1]},"then":{"$first":{"$map":{"from":{"$filter":{"from":{"$sortByOrder":{"$ref":"request.images"}},"as":"media","where":{"$in":[{"$ref":"media.role"},["edit_source","reference_image","subject_reference","style_reference",""]]}}},"as":"media","in":{"$ref":"media.value"}}}},"else":null}}} |
create.body.input.ref_images |
{"$omitEmpty":{"$if":{"condition":{"$gt":[{"$len":{"$ref":"request.images"}},1]},"then":{"$map":{"from":{"$sortByOrder":{"$ref":"request.images"}},"as":"media","in":{"$ref":"media.value"}}},"else":null}}} |
create.body.parameters.size |
{"$omitEmpty":{"$ref":"request.aspectRatio"}} |
create.body.parameters.n |
{"$coalesce":[{"$ref":"request.imageCount"},1]} |
create.body.parameters.seed |
{"$omitEmpty":{"$ref":"request.providerOptions.dashscope-wanx-image.seed"}} |
create.body.parameters.style |
{"$omitEmpty":{"$ref":"request.providerOptions.dashscope-wanx-image.style"}} |
create.body.parameters.prompt_extend |
{"$omitEmpty":{"$ref":"request.providerOptions.dashscope-wanx-image.prompt_extend"}} |
create.body.parameters.watermark |
{"$ref":"request.watermark"} |
create.headers.X-DashScope-Async |
"enable" |
poll.method |
"GET" |
poll.path |
"/api/v1/tasks/{{taskId}}" |
poll.contentType |
"application/json" |
Provider 扩展键
providerOptions.dashscope-wanx-image.negative_promptproviderOptions.dashscope-wanx-image.prompt_extendproviderOptions.dashscope-wanx-image.seedproviderOptions.dashscope-wanx-image.style
动态模型或工作流允许使用文档声明的完整 parameters/input/extra_body 对象；该对象是协议本身的开放 schema，不会被宿主裁剪。
响应映射逐字段清单
| 映射位置 | 上游路径或转换表达式 |
|---|---|
response.taskId |
{"$coalesce":[{"$ref":"response.output.task_id"},{"$ref":"response.task_id"},{"$ref":"taskId"}]} |
response.status |
{"$coalesce":[{"$ref":"response.output.task_status"},{"$ref":"response.status"},"pending"]} |
response.message |
{"$coalesce":[{"$ref":"response.error.message"},{"$ref":"response.message"},{"$ref":"response.fail_reason"}]} |
response.images |
{"$coalesce":[{"$ref":"response.output.results"},{"$ref":"response.output.image_url"}]} |
response.errorPaths[0] |
"code" |
response.resultEphemeral |
true |
response.usage |
{"$ref":"response.usage"} |
response.messagePaths[0] |
"message" |
response.messagePaths[1] |
"output.message" |
响应与错误
插件把上游 task/status/text/media/usage 映射为统一结果。临时媒体 URL 标记为 ephemeral，由宿主立即下载持久化。HTTP 错误、业务 code 和 error object 保持失败语义，不包装成成功。
兼容边界
该包只代表上述线协议 profile；同一品牌的其他 endpoint、云区域或网关包装必须使用独立插件，不能根据模型名猜测。
Manifest 完整接口定义
以下 JSON 与插件包内实际 manifest.json 逐字段一致，覆盖插件身份、权限、配置、鉴权、参数、校验、创建、Agent、查询、取消、结果下载、响应和 Agent 响应映射。documentation 字段的值就是当前完整文档；为避免文档在自身内部无限递归，JSON 中仅用等义占位文本表示正文。
{
"apiVersion": "yingce.plugin/v2",
"id": "dashscope-wanx-image",
"name": "DashScope Wanx Image",
"version": "2.0.0",
"author": "Alibaba Cloud / 影策",
"description": "DashScope Wanx Image 独立请求协议插件。",
"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": "dashscope-wanx-image",
"label": "DashScope Wanx Image",
"capabilities": [
"image"
],
"scopes": [
"admin.system-channel",
"user.custom-channel",
"canvas",
"creation",
"agent"
],
"baseUrl": "https://dashscope.aliyuncs.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",
"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/v1/services/aigc/text2image/image-synthesis",
"contentType": "application/json",
"body": {
"model": {
"$ref": "request.model"
},
"input": {
"prompt": {
"$ref": "request.prompt"
},
"negative_prompt": {
"$omitEmpty": {
"$ref": "request.providerOptions.dashscope-wanx-image.negative_prompt"
}
},
"ref_img": {
"$omitEmpty": {
"$if": {
"condition": {
"$eq": [
{
"$len": {
"$ref": "request.images"
}
},
1
]
},
"then": {
"$first": {
"$map": {
"from": {
"$filter": {
"from": {
"$sortByOrder": {
"$ref": "request.images"
}
},
"as": "media",
"where": {
"$in": [
{
"$ref": "media.role"
},
[
"edit_source",
"reference_image",
"subject_reference",
"style_reference",
""
]
]
}
}
},
"as": "media",
"in": {
"$ref": "media.value"
}
}
}
},
"else": null
}
}
},
"ref_images": {
"$omitEmpty": {
"$if": {
"condition": {
"$gt": [
{
"$len": {
"$ref": "request.images"
}
},
1
]
},
"then": {
"$map": {
"from": {
"$sortByOrder": {
"$ref": "request.images"
}
},
"as": "media",
"in": {
"$ref": "media.value"
}
}
},
"else": null
}
}
}
},
"parameters": {
"size": {
"$omitEmpty": {
"$ref": "request.aspectRatio"
}
},
"n": {
"$coalesce": [
{
"$ref": "request.imageCount"
},
1
]
},
"seed": {
"$omitEmpty": {
"$ref": "request.providerOptions.dashscope-wanx-image.seed"
}
},
"style": {
"$omitEmpty": {
"$ref": "request.providerOptions.dashscope-wanx-image.style"
}
},
"prompt_extend": {
"$omitEmpty": {
"$ref": "request.providerOptions.dashscope-wanx-image.prompt_extend"
}
},
"watermark": {
"$ref": "request.watermark"
}
}
},
"headers": {
"X-DashScope-Async": "enable"
}
},
"poll": {
"method": "GET",
"path": "/api/v1/tasks/{{taskId}}"
},
"response": {
"taskId": {
"$coalesce": [
{
"$ref": "response.output.task_id"
},
{
"$ref": "response.task_id"
},
{
"$ref": "taskId"
}
]
},
"status": {
"$coalesce": [
{
"$ref": "response.output.task_status"
},
{
"$ref": "response.status"
},
"pending"
]
},
"message": {
"$coalesce": [
{
"$ref": "response.error.message"
},
{
"$ref": "response.message"
},
{
"$ref": "response.fail_reason"
}
]
},
"images": {
"$coalesce": [
{
"$ref": "response.output.results"
},
{
"$ref": "response.output.image_url"
}
]
},
"errorPaths": [
"code"
],
"resultEphemeral": true,
"usage": {
"$ref": "response.usage"
},
"messagePaths": [
"message",
"output.message"
]
}
}
]
}
}