跳转到主要内容
API Explorer|API Explorer
模型仓库/模型相关接口
POSTModel APIs起始版本 5.1.8同步需要认证

添加模型

添加模型

调试可用性

在线调试

使用当前认证信息和示例参数提交 Mock 请求。

请求参数

请求体字段

  • paramObject必填

    param 请求体结构

    • nameString必填

      资源名称

    • installPathString必填

      模型安装路径

    • descriptionString

      资源的详细描述

    • parametersString

      模型的详细参数

    • modelCenterUuidString必填

      模型中心的UUID

    • logoString

      可选。

    • vendorString

      可选。

    • introductionString

      可选。

    • sizeLong

      可选。

    • versionString

      可选。

    • tokenString

      可选。

    • resourceUuidString

      资源UUID

    • tagUuidsList

      标签UUID列表

    • modelServiceUuidsList

      可选。

    • recommendedGpuNumString

      可选。

    • gpuConstraintDescriptionString

      可选。

    • modelIdString

      可选。

    • shareModeString

      共享模式

    • defaultModelServiceUuidString

      默认模型服务UUID

  • systemTagsList

    系统标签

  • userTagsList

    用户标签

响应状态

200 OK

该 API 成功时返回以下响应结构。

  • successboolean必填

    操作是否成功。

  • errorErrorCode必填

    错误码，若不为null，则表示操作失败, 操作成功时该字段为null。 详情参考error

    • codeString必填

      错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段，默认为null

    • opaqueLinkedHashMap必填

      保留字段，默认为null

    • causeErrorCode必填

      根错误，引发当前错误的源错误，若无原错误，该字段为null

  • inventoryModelInventory必填

    详情参考inventory

    • uuidString必填

      资源的UUID，唯一标识该资源

    • nameString必填

      资源名称

    • descriptionString必填

      资源的详细描述

    • installPathString必填

      模型的安装路径

    • parametersString必填

      模型的详细参数

    • modelCenterUuidString必填

      模型中心UUID

    • logoString必填

      模型Logo

    • vendorString必填

      模型供应商

    • modelIdString必填

      模型ID

    • introductionString必填

      模型介绍

    • sizeLong必填

      模型大小

    • versionString必填

      模型版本

    • typeString必填

      模型类型

    • minGpuMemoryLong必填

      最低GPU显存

    • recommendedGpuMemoryLong必填

      推荐GPU显存

    • recommendedGpuNumList必填

      推荐GPU数量

    • gpuConstraintDescriptionString必填

      GPU约束说明

    • versionSemverString必填

      语义化版本

    • isLatestVersionBoolean必填

      是否为最新版本

    • artifactChecksumString必填

      制品校验和

    • artifactSizeBytesLong必填

      制品大小，单位为字节

    • architectureTypeString必填

      模型架构类型

    • frameworkVersionString必填

      框架版本

    • requiredAcceleratorString必填

      所需加速器

    • pipelineTagString必填

      流水线标签

    • modelServiceRefsList必填

      模型与模型服务的绑定关系

    • extraGpuMemRequestLong必填

      额外GPU显存需求

    • SAMPLE_SIZEInteger必填

      采样大小

    • createDateTimestamp必填

      创建时间

    • lastOpDateTimestamp必填

      最后一次修改时间

请求地址

POST/zstack/v1/ai/models

/zstack/v1/ai/models

操作 ID

AddModel

永久链接

请求示例

curl -X POST 'http://{host}/zstack/v1/ai/models' -H 'Authorization: OAuth {sessionUuid}' -H 'Content-Type: application/json;charset=UTF-8' -d '{"param":{"name":"<name>","installPath":"<installPath>","description":"<description>","parameters":"<parameters>","modelCenterUuid":"<modelCenterUuid>","logo":"<logo>","vendor":"<vendor>","introduction":"<introduction>","size":1,"version":"<version>","token":"<token>","resourceUuid":"<resourceUuid>","tagUuids":["<tagUuids>"],"modelServiceUuids":["<modelServiceUuids>"],"recommendedGpuNum":"<recommendedGpuNum>","gpuConstraintDescription":"<gpuConstraintDescription>","modelId":"<modelId>","shareMode":"<shareMode>","defaultModelServiceUuid":"<defaultModelServiceUuid>"},"systemTags":["<systemTags>"],"userTags":["<userTags>"]}'

响应示例

200
{ "inventory": { "description": "", "extraGpuMemRequest": 4294967296, "SAMPLE_SIZE": 1000 } }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史