百鍊模型匯入 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 | 系統內部錯誤,請稍後重試。 |