文档首页/数智融合计算服务 DataArts Fabric/API参考/API/模型定义/创建模型 - CreateModelDefinition
更新时间：2025-12-23 GMT+08:00
查看PDF
分享

创建模型 - CreateModelDefinition

功能介绍

创建模型。用户可通过该接口创建模型，支持传入名称、描述、版本名称、版本描述、基模型类型和模型所在的OBS路径，返回模型ID及其版本ID。此接口为异步接口，配套使用接口ListModels查询模型列表。存在同名校验，不支持创建重复名称的模型。

URI

POST /v1/workspaces/{workspace_id}/models

表1 路径参数

参数

是否必选

参数类型

描述

workspace_id

是

String

参数解释：工作空间ID。获取方法，请参见获取工作空间ID。

约束限制：不涉及。

取值范围：长度为[1,36]的英文字符、数字和中划线(-)的组合。

默认取值：不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

否

String

参数解释：租户Token。用于调用接口的认证。获取方法，请参见认证鉴权。

约束限制：不涉及。

取值范围：长度不超过65534个字符。

默认取值：不涉及。

表3 请求Body参数

参数

是否必选

参数类型

描述

name

是

String

参数解释：一个Model的名称。

约束限制：不涉及。

取值范围：长度为[1,64]的中文、字母、数字、下划线(_)、中划线(-)、半角句号（.）、空格的组合。

默认取值：不涉及。

description

否

String

参数解释：描述信息。

约束限制：不涉及。

取值范围：[0,1024]。

默认取值：不涉及。

type

是

String

参数解释：模型的类型。

约束限制：不涉及。

取值范围：LLM_MODEL：大语言模型。

默认取值：不涉及。

version

是

ModelVersionInput object

参数解释：模型每个版本的详细信息。

约束限制：不涉及。

表4 ModelVersionInput

参数

是否必选

参数类型

描述

name

是

String

参数解释：模型版本名称。

约束限制：不涉及。

取值范围：长度为[1,64]的中文、字母、数字、下划线(_)、中划线(-)、半角句号（.）、空格的组合。

默认取值：不涉及。

description

否

String

参数解释：描述信息。

约束限制：不涉及。

取值范围：不涉及。

默认取值：不涉及。

config

否

ModelConfig object

参数解释：模型配置。

约束限制：不涉及。

取值范围：不涉及。

默认取值：不涉及。

表5 ModelConfig

参数

是否必选

参数类型

描述

llm_model_config

否

LlmModelConfig object

参数解释：Llm模型配置。

约束限制：不涉及。

表6 LlmModelConfig

参数

是否必选

参数类型

描述

base_model_type

是

String

参数解释：基模型类型。

约束限制：不涉及。

取值范围：请从列举基模型接口响应中获取。

默认取值：不涉及。

model_path

否

String

参数解释：模型文件路径。

约束限制：合法OBS路径。

取值范围：不涉及。

默认取值：不涉及。

local_model_path

否

String

参数解释：本地模型文件路径。

约束限制：本地模型文件路径。

取值范围：不涉及。

默认取值：不涉及。

响应参数

状态码：200

表7 响应Body参数

参数

参数类型

描述

id

String

参数解释：模型ID。获取方法，请参见获取模型ID。

约束限制：不涉及。

取值范围：长度为[32,36]的英文字符、数字和中划线(-)的组合。

默认取值：不涉及。

version_id

String

参数解释：模型版本ID。

约束限制：系统自动生成无法修改，输入不生效。

取值范围：长度为[32,36]的英文字符、数字和中划线(-)的组合。

默认取值：不涉及。

状态码：400

表8 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：错误码。

约束限制：不涉及。

取值范围：长度为[8,36]个字符。

默认取值：不涉及。

error_msg

String

参数解释：错误描述。

约束限制：不涉及。

取值范围：长度为[2,512]个字符。

默认取值：不涉及。

solution_msg

String

参数解释：解决方案描述。

约束限制：不涉及。

取值范围：长度为[0,4096]个字符。

默认取值：不涉及。

状态码：401

表9 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：错误码。

约束限制：不涉及。

取值范围：长度为[8,36]个字符。

默认取值：不涉及。

error_msg

String

参数解释：错误描述。

约束限制：不涉及。

取值范围：长度为[2,512]个字符。

默认取值：不涉及。

solution_msg

String

参数解释：解决方案描述。

约束限制：不涉及。

取值范围：长度为[0,4096]个字符。

默认取值：不涉及。

状态码：404

表10 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：错误码。

约束限制：不涉及。

取值范围：长度为[8,36]个字符。

默认取值：不涉及。

error_msg

String

参数解释：错误描述。

约束限制：不涉及。

取值范围：长度为[2,512]个字符。

默认取值：不涉及。

solution_msg

String

参数解释：解决方案描述。

约束限制：不涉及。

取值范围：长度为[0,4096]个字符。

默认取值：不涉及。

状态码：408

表11 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：错误码。

约束限制：不涉及。

取值范围：长度为[8,36]个字符。

默认取值：不涉及。

error_msg

String

参数解释：错误描述。

约束限制：不涉及。

取值范围：长度为[2,512]个字符。

默认取值：不涉及。

solution_msg

String

参数解释：解决方案描述。

约束限制：不涉及。

取值范围：长度为[0,4096]个字符。

默认取值：不涉及。

状态码：500

表12 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：错误码。

约束限制：不涉及。

取值范围：长度为[8,36]个字符。

默认取值：不涉及。

error_msg

String

参数解释：错误描述。

约束限制：不涉及。

取值范围：长度为[2,512]个字符。

默认取值：不涉及。

solution_msg

String

参数解释：解决方案描述。

约束限制：不涉及。

取值范围：长度为[0,4096]个字符。

默认取值：不涉及。

请求示例

创建模型接口。名称为LLama3-8b，描述为description，类型为LLM_MODEL，版本具体信息如下请求样例所示。

POST https://{endpoint}/v1/workspaces/{workspace_id}/models

{
  "name" : "LLama3-8b",
  "description" : "description",
  "type" : "LLM_MODEL",
  "version" : {
    "name" : "name",
    "description" : "description",
    "config" : {
      "llm_model_config" : {
        "base_model_type" : "string",
        "model_path" : "obs://bucketname/objectdir/modelpath/"
      }
    }
  }
}

响应示例

状态码：200

创建Model的响应体。

{
  "id" : "ac8111bf-3601-4905-8ddd-b41d3e636a4e"
}

状态码：400

BadRequest

{
  "error_code" : "common.01000001",
  "error_msg" : "failed to read http request, please check your input, code: 400, reason: Type mismatch., cause: TypeMismatchException"
}

状态码：401

Unauthorized

{
  "error_code" : "APIG.1002",
  "error_msg" : "Incorrect token or token resolution failed"
}

状态码：403

Forbidden

{
  "error" : {
    "code" : "403",
    "message" : "X-Auth-Token is invalid in the request",
    "title" : "Forbidden"
  },
  "error_code" : 403,
  "error_msg" : "X-Auth-Token is invalid in the request",
  "title" : "Forbidden"
}

状态码：404

NotFound

{
  "error_code" : "common.01000001",
  "error_msg" : "response status exception, code: 404"
}

状态码：408

Request Time-out

{
  "error_code" : "common.00000408",
  "error_msg" : "timeout exception occurred"
}

状态码：500

InternalServerError

{
  "error_code" : "common.00000500",
  "error_msg" : "internal error"
}

状态码

状态码

描述

200

创建Model的响应体。

400

BadRequest

401

Unauthorized

403

Forbidden

404

NotFound

408

Request Time-out

500

InternalServerError

错误码

请参见错误码。

父主题：模型定义