模型同步

更新时间:

同步模型信息

如果您需要维护的模型数量不多,推荐直接在智作工坊控制台模型管理中上传维护模型。如果您已经在自有系统中维护过模型信息,可以参考本文档,以接口形式大规模同步模型信息。

模型核心领域模型

image

模型同步链路

模型同步包括同步异步两个部分。

同步链路用于模型元信息同步,当客户侧模型元信息需要变更时,由客户按照上述模型结构组装完整模型、版本、文件元信息结构,将模型元信息同步到智作工坊。

智作工坊接收到模型元信息后:

  • 如果模型文件已经上传到智作工坊,直接返回模型同步结果。

  • 如果模型文件未上传到智作工坊,返回模型同步结果,并触发异步链路。异步链路用于模型文件上传上架,上架后会触发模型上架结果事件。

image.png

模型同步

请求语法

POST /scc/spSdModelSync

请求参数

名称

类型

必填

描述

示例值

apiToken

string

Token

01j1w6cxqz****

roleId

string

Session绑定的角色ID

01j2bapbjd****

sessionMode

integer

会话模式:10; 推理模式:20,默认 10

10

expiredInSeconds

long

Session过期时间(秒), 会话模式默认1小时,推理模式默认24小时

3600

customResourceConfigId

string

资源配置ID,支持传递多个资源配置ID,以逗号分隔

入参信息

{
  "modelId": "xxxxx", // 模型 ID (客户系统的模型业务 ID),用于唯一标识一个模型,同步场景必填
  "name": "Demo", // 模型名称,必填
  "modelType": "checkpoint", // 模型类型: checkpoint/lora/textualinversion/vae,必填
  "modelDesc": "xxxx", // 模型描述,html 格式,可选
  "source": "https://xxxx", // 模型来源地址,可选
  "sourceType": "internal", // 模型来源类型: liblib/civitia/hugging_face/internal,其中 internal 为租户自有模型,必填
  "isOriginal": false, // 是否为原创模型
  "originalCreator": "ccc", // 原创作者
  "originalCreatorHomepage": "https://xxxx", // 原创作者链接
  "versions": [
    {
      "modelVersionId": "xxxx", // 模型版本 ID (客户系统的模型版本业务 ID),用于唯一标识一个模型版本,同步场景必填
      "name": "v1.2.2-EOL", // 模型版本名称,必填
      "baseModel": "v1.5", // 基础模型类型: v1.4/v1.5/v2.0/v2.1/vxl_0.9/vxl_1.0/vxl_distilled/v1.5_lcm/vxl_1.0_lcm/vxl_turbo,必填
      "versionDesc": "xxxx", // 模型版本描述,html 格式,可选
      "triggerWords": ["rev", "animated", "v1.2.2", "eol"], // 触发词,用于触发模型版本,可选
      "isAutoCollection": true, // 是否自动收藏,可选,开启后新建 token 会自动收藏该模型版本
      "covers": [
        {
          "cover": "https://xxx.jpeg", // 模型版本封面图,必填
          "coverFile": {
            // 封面图文件信息,必填
            "width": 1920, // 封面图宽度,必填
            "height": 1080, // 封面图高度,必填
            "format": "jpeg" // 封面图格式,可选
          }
        }
      ],

      "files": [
        {
          "name": "revAnimated_v122EOL.safetensors", // 模型文件名称,必填
          "aliasName": "revAnimated_v122EOL", // 模型文件别名,用于 Lora 模型的别名,必填
          "downloadUrl": "https://xxx", // 模型文件下载地址,必填
          "hash": "xxx", // 模型文件 hash,必填
          "sizeKb": 5376404.0390625, // 模型文件大小,单位 KB,必填
          "isPrimary": true, // 是否主要模型文件,一个版本下只能有一个主要模型文件
        }
      ]
    }
  ]
}

返回参数

名称

类型

描述

data

object

返回数据

data参数

名称

类型

描述

modelId

string

模型ID

modelVersionId

string

模型版本ID

modelFileId

string

模型文件ID

status

integer

模型同步状态,未上架:0;上架中:5;已上架:10;上架失败:-10。