tt/ttstd-infinite-canvas
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
d7682963a4ae4ad71226b44d1ca6379adbb02085
ttstd-infinite-canvas/plugin-packages/stability-image/docs/interface.md

13 KiB
Raw Blame History

Stability AI Image 接口字段

协议身份

  • 插件 ID：stability-image。
  • Provider ID：stability-image。
  • 能力：image。
  • 默认 Base URL：https://api.stability.ai。
  • 鉴权驱动：bearer。
  • 创建：POST 动态路径。
  • 生命周期：同步响应。

配置字段

字段 类型 必填 含义
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 "dynamic"
create.contentType "multipart/form-data"
create.body.prompt {"$ref":"request.prompt"}
create.body.negative_prompt {"$omitEmpty":{"$ref":"request.providerOptions.stability-image.negative_prompt"}}
create.body.aspect_ratio {"$omitEmpty":{"$ref":"request.aspectRatio"}}
create.body.output_format {"$coalesce":[{"$ref":"request.output.format"},{"$ref":"request.providerOptions.stability-image.output_format"},"png"]}
create.body.seed {"$omitEmpty":{"$ref":"request.providerOptions.stability-image.seed"}}
create.body.style_preset {"$omitEmpty":{"$ref":"request.providerOptions.stability-image.style_preset"}}
create.body.strength {"$omitEmpty":{"$ref":"request.providerOptions.stability-image.strength"}}
create.body.cfg_scale {"$omitEmpty":{"$ref":"request.providerOptions.stability-image.cfg_scale"}}
create.body.grow_mask {"$omitEmpty":{"$ref":"request.providerOptions.stability-image.grow_mask"}}
create.body.creativity {"$omitEmpty":{"$ref":"request.providerOptions.stability-image.creativity"}}
create.headers.Accept "application/json"
create.files[0].name "image"
create.files[0].source {"$first":{"$filter":{"from":{"$sortByOrder":{"$ref":"request.images"}},"as":"media","where":{"$in":[{"$ref":"media.role"},["edit_source","reference_image",""]]}}}}
create.files[0].filename "image.png"
create.files[1].name "mask"
create.files[1].source {"$first":{"$filter":{"from":{"$sortByOrder":{"$ref":"request.images"}},"as":"media","where":{"$in":[{"$ref":"media.role"},["mask"]]}}}}
create.files[1].filename "mask.png"

Provider 扩展键

  • providerOptions.stability-image.cfg_scale
  • providerOptions.stability-image.creativity
  • providerOptions.stability-image.endpoint
  • providerOptions.stability-image.grow_mask
  • providerOptions.stability-image.negative_prompt
  • providerOptions.stability-image.output_format
  • providerOptions.stability-image.seed
  • providerOptions.stability-image.strength
  • providerOptions.stability-image.style_preset

动态模型或工作流允许使用文档声明的完整 parameters/input/extra_body 对象；该对象是协议本身的开放 schema，不会被宿主裁剪。

响应映射逐字段清单

映射位置 上游路径或转换表达式
response.status {"$if":{"condition":{"$ref":"response.errors"},"then":"failed","else":"succeeded"}}
response.message {"$coalesce":[{"$ref":"response.errors"},{"$ref":"response.message"}]}
response.images {"$if":{"condition":{"$ref":"response.image"},"then":[{"dataUrl":{"$concat":["data:",{"$coalesce":[{"$ref":"response.mime_type"},"image/png"]},";base64,",{"$ref":"response.image"}]}}],"else":null}}
response.errorPaths[0] "errors"

响应与错误

插件把上游 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": "stability-image",
  "name": "Stability AI Image",
  "version": "2.0.0",
  "author": "Stability AI / 影策",
  "description": "Stability AI 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": "stability-image",
        "label": "Stability AI Image",
        "capabilities": [
          "image"
        ],
        "scopes": [
          "admin.system-channel",
          "user.custom-channel",
          "canvas",
          "creation",
          "agent"
        ],
        "baseUrl": "https://api.stability.ai",
        "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",
          "pathTemplate": {
            "$coalesce": [
              {
                "$ref": "request.providerOptions.stability-image.endpoint"
              },
              "/v2beta/stable-image/generate/core"
            ]
          },
          "contentType": "multipart/form-data",
          "headers": {
            "Accept": "application/json"
          },
          "body": {
            "prompt": {
              "$ref": "request.prompt"
            },
            "negative_prompt": {
              "$omitEmpty": {
                "$ref": "request.providerOptions.stability-image.negative_prompt"
              }
            },
            "aspect_ratio": {
              "$omitEmpty": {
                "$ref": "request.aspectRatio"
              }
            },
            "output_format": {
              "$coalesce": [
                {
                  "$ref": "request.output.format"
                },
                {
                  "$ref": "request.providerOptions.stability-image.output_format"
                },
                "png"
              ]
            },
            "seed": {
              "$omitEmpty": {
                "$ref": "request.providerOptions.stability-image.seed"
              }
            },
            "style_preset": {
              "$omitEmpty": {
                "$ref": "request.providerOptions.stability-image.style_preset"
              }
            },
            "strength": {
              "$omitEmpty": {
                "$ref": "request.providerOptions.stability-image.strength"
              }
            },
            "cfg_scale": {
              "$omitEmpty": {
                "$ref": "request.providerOptions.stability-image.cfg_scale"
              }
            },
            "grow_mask": {
              "$omitEmpty": {
                "$ref": "request.providerOptions.stability-image.grow_mask"
              }
            },
            "creativity": {
              "$omitEmpty": {
                "$ref": "request.providerOptions.stability-image.creativity"
              }
            }
          },
          "files": [
            {
              "name": "image",
              "source": {
                "$first": {
                  "$filter": {
                    "from": {
                      "$sortByOrder": {
                        "$ref": "request.images"
                      }
                    },
                    "as": "media",
                    "where": {
                      "$in": [
                        {
                          "$ref": "media.role"
                        },
                        [
                          "edit_source",
                          "reference_image",
                          ""
                        ]
                      ]
                    }
                  }
                }
              },
              "filename": "image.png"
            },
            {
              "name": "mask",
              "source": {
                "$first": {
                  "$filter": {
                    "from": {
                      "$sortByOrder": {
                        "$ref": "request.images"
                      }
                    },
                    "as": "media",
                    "where": {
                      "$in": [
                        {
                          "$ref": "media.role"
                        },
                        [
                          "mask"
                        ]
                      ]
                    }
                  }
                }
              },
              "filename": "mask.png"
            }
          ]
        },
        "response": {
          "status": {
            "$if": {
              "condition": {
                "$ref": "response.errors"
              },
              "then": "failed",
              "else": "succeeded"
            }
          },
          "message": {
            "$coalesce": [
              {
                "$ref": "response.errors"
              },
              {
                "$ref": "response.message"
              }
            ]
          },
          "images": {
            "$if": {
              "condition": {
                "$ref": "response.image"
              },
              "then": [
                {
                  "dataUrl": {
                    "$concat": [
                      "data:",
                      {
                        "$coalesce": [
                          {
                            "$ref": "response.mime_type"
                          },
                          "image/png"
                        ]
                      },
                      ";base64,",
                      {
                        "$ref": "response.image"
                      }
                    ]
                  }
                }
              ],
              "else": null
            }
          },
          "errorPaths": [
            "errors"
          ]
        }
      }
    ]
  }
}
Reference in New Issue View Git Blame Copy Permalink