百炼模型导入 API 提供创建、查询、列举、删除导入任务的完整接口,支持将 OSS 中的调优模型文件导入百炼平台。
概述
模型导入 API 用于将您在 OSS 中存储的调优模型文件导入到百炼平台,导入完成后即可通过创建部署接口将模型部署为可调用服务。模型导入支持全参调优(full)和 LoRA 调优(lora)两种模型类型。
完整的模型导入流程如下:创建导入任务 → 查询导入任务详情(轮询任务状态)→ 任务成功后创建部署 → 不再需要的任务可列举后删除。
当前模型导入 API 仅在北京 Region 开放。如您使用其他 Region,请通过该 Region 的百炼控制台完成模型导入操作。
前提条件
- 已配置百炼的 API-KEY,请参考获取与配置 API Key。
- 已创建 OSS Bucket,并完成百炼平台的 OSS 授权。详见模型导入中的使用前提。
- 模型文件已上传至 OSS Bucket,并符合模型导入。
公共请求头
所有接口均需在 HTTP Header 中携带以下字段:
Header | 说明 |
|---|---|
Authorization |
|
Content-Type |
|
自定义模型对象
自定义模型对象描述了一个导入任务的完整信息。通过创建导入任务接口创建,可通过查询导入任务详情和列举导入任务接口获取。导入完成后可通过创建部署接口进行部署。以下为自定义模型对象包含的字段:
对象字段
参数 | 类型 | 说明 |
|---|---|---|
request_id | String | 请求 ID。 |
output.job_id | String | 导入任务 ID,用于查询任务状态或删除任务。 |
output.model_name | String | 系统生成的模型标识,格式为基础模型名称加时间戳后缀。 |
output.display_name | String | 导入模型的显示名称。 |
output.source | String | 导入来源,返回值为大写 |
output.weight_type | String | 调优类型。 |
output.storage_info | Object | 导入来源的存储信息,包含 |
output.status | String | 任务状态。参见任务状态说明。 |
output.gmt_create | String | 任务创建时间,ISO 8601 格式。示例: |
任务状态说明
导入任务在生命周期中可能处于以下状态:
状态 | 说明 |
|---|---|
PENDING | 任务已提交,等待处理。 |
RUNNING | 任务正在执行中,系统正在校验和导入模型文件。 |
SUCCESSED | 任务执行成功,模型已导入完成,可以通过创建部署接口进行部署。 |
FAILED | 任务执行失败。可通过查询任务详情获取 |
创建导入任务
提交一个模型导入任务。系统将对模型文件进行结构和安全校验,确保文件能够正常部署。
地址
请求示例
请求参数
参数 | 类型 | 传参方式 | 必选 | 说明 |
|---|---|---|---|---|
model_name | String | body | 是 | 基础模型的名称。对应控制台基础模型字段。当前支持的模型请参见模型导入。示例: |
display_name | String | body | 否 | 导入模型的显示名称,对应控制台模型名称字段。最多50个字符。不传时默认使用基础模型名称。 |
source | String | body | 是 | 导入来源。对应控制台导入来源字段。当前仅支持 |
weight_type | String | body | 是 | 调优类型。 |
storage_info | Object | body | 是 | 导入来源的存储信息。 |
storage_info.bucket_name | String | body | 是 | OSS Bucket 名称。对应控制台Bucket字段。 |
storage_info.object_key | String | body | 是 | 模型文件所在 OSS 路径前缀,需以 |
响应示例
响应参数
参数 | 类型 | 说明 |
|---|---|---|
request_id | String | 请求 ID。 |
output.job_id | String | |
output.model_name | String | 系统生成的模型标识,格式为基础模型名称加时间戳后缀。 |
output.display_name | String | 导入模型的显示名称。 |
output.source | String | 导入来源,返回值为大写 |
output.weight_type | String | 调优类型。 |
output.storage_info | Object | 导入来源的存储信息,包含 |
output.status | String | 任务状态。参见任务状态说明。 |
output.gmt_create | String | 任务创建时间,ISO 8601 格式。示例: |
查询导入任务详情
查询指定导入任务的当前状态及详情。
地址
请求示例
请求参数
参数 | 类型 | 传参方式 | 必选 | 说明 |
|---|---|---|---|---|
job_id | String | path | 是 |
响应示例
响应参数
响应参数与创建导入任务的响应参数基本一致,但不包含 weight_type 字段。当任务失败时,响应中将额外包含 error_code 字段,表示失败原因。
列举导入任务
分页查询当前工作空间下的导入任务列表。
地址
请求示例
请求参数
参数 | 类型 | 传参方式 | 必选 | 说明 |
|---|---|---|---|---|
page_no | Integer | query | 否 | 页码,默认值为1。 |
page_size | Integer | query | 否 | 每页条数,默认值为10,最大值为100。 |
status | String | query | 否 | 按任务状态过滤,参见任务状态说明。 |
model_name | String | query | 否 | 按模型名称过滤,需传入响应中返回的系统生成名称(精确匹配)。 |
响应示例
响应参数
参数 | 类型 | 说明 |
|---|---|---|
request_id | String | 请求 ID。 |
output.total | Integer | 满足查询条件的任务总数。 |
output.page_no | Integer | 当前页码。 |
output.page_size | Integer | 每页条数。 |
output.list | Array | 导入任务列表。每个元素的字段与创建导入任务的响应参数基本一致,但不包含 |
删除导入任务
删除指定的导入任务及其关联的模型文件。只有状态为 SUCCESSED 或 FAILED 的任务可以删除。删除成功后返回被删除任务的详情。
地址
请求示例
请求参数
参数 | 类型 | 传参方式 | 必选 | 说明 |
|---|---|---|---|---|
job_id | String | path | 是 |
响应示例
响应参数
参数 | 类型 | 说明 |
|---|---|---|
request_id | String | 请求 ID。 |
output | Object | 被删除的任务详情,字段与创建导入任务的响应参数基本一致,但不包含 |
异常响应
当请求发生错误时,接口将返回如下格式的错误响应:
错误码
错误码 | 说明 |
|---|---|
InvalidParameter | 请求参数无效。例如必填参数缺失、参数格式错误或参数值不合法。 |
NotFound | 指定的资源不存在。例如 job_id 不存在、无权访问或基础模型不支持导入。 |
OperationDenied | 操作被拒绝。例如对 RUNNING 状态的任务执行删除操作。 |
InvalidApiKey | API-KEY 无效或未提供。 |
InternalError | 系统内部错误,请稍后重试。 |