创建模型
功能介绍
创建模型。用户可通过该接口创建模型,支持传入名称、描述、版本名称、版本描述、基模型类型和模型所在的OBS路径,返回模型ID及其版本ID。此接口为异步接口,配套使用接口ListModels查询模型列表。存在同名校验,不支持创建重复名称的模型。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
POST https://localhost.com/v1/workspaces/{workspace_id}/models
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
workspace_id |
是 |
String |
|
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
否 |
String |
|
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
name |
是 |
String |
|
description |
否 |
String |
|
type |
是 |
String |
|
version |
是 |
ModelVersionInput object |
|
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
name |
是 |
String |
|
description |
否 |
String |
|
config |
否 |
ModelConfig object |
|
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
llm_model_config |
否 |
LlmModelConfig object |
|
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
|
version_id |
String |
|
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
|
error_msg |
String |
|
solution_msg |
String |
|
状态码:401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
|
error_msg |
String |
|
solution_msg |
String |
|
状态码:404
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
|
error_msg |
String |
|
solution_msg |
String |
|
状态码:408
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
|
error_msg |
String |
|
solution_msg |
String |
|
状态码:500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
|
error_msg |
String |
|
solution_msg |
String |
|
请求示例
创建模型接口。名称为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 |
错误码
请参见错误码。