You need to enable JavaScript to run this app.
文档中心
火山方舟

火山方舟

复制全文
下载 pdf
管理模型调优任务
GetModelCustomizationJob - 获取模型调优任务信息
复制全文
下载 pdf
GetModelCustomizationJob - 获取模型调优任务信息

获取模型训练任务信息

调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数

参数
类型
是否必填
示例值
描述
Action
String

GetModelCustomizationJob

要执行的操作,取值:GetModelCustomizationJob。

Version
String

2024-01-01

API的版本,取值:2024-01-01。

Id
String

mcj-test-id

模型调优任务的ID

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构

参数
类型
示例值
描述
CreateTime
String

2024-01-01T00:00:00Z

资源创建时间戳

CustomizationType
String

FinetuneLoRA

训练类型,取值范围: FinetuneSft, FinetuneLoRA, Pretrain, DPOLoRA, DPO

Data
Object

{
"TrainingSet":
{
"TosBucket": "ark-auto-created-required-2100000000-cn-beijing",
"TosPaths": [
"model-customization-job-upload-set/1712561985763/test.jsonl"
]
}
"EncryptionKeyringType": "ManagedKeyring",
"KMSTrn": "trn:kms:cn-beijing:2100000000:keyrings/datapipe_keyring/keys/datapipe_key_ml_maas"
}

模型微调使用的数据集

Id
String

mcj-20240101000000-a1b2c

模型精调任务资源 ID

Hyperparameters
Array of Object

[
{
"Name": "epoch",
"Value": "6"
},
{
"Name": "learning_rate",
"Value": "0.00001"
}]

微调配置的超参数

Description
String

这是一个测试任务

模型调优任务描述

ModelReference
Object

{
"FoundationModel":
{
"Name": "doubao-lite-4k",
"ModelVersion": "240328",
"ConfigurationId": "fmvc-20240101000000-a1b2c"
}
}

微调基于的模型

Outputs
Array of Object

[
{
"Index": 0,
"Name": "global_step_1",
"CreateTime": "2024-01-01T12:57:08Z",
"Status": "Available"
},
{
"Index": 1,
"CustomModelId": "cm-20240913210309-xc8rz",
"CustomModelCreateTime": "2024-09-13T13:03:09Z",
"Name": "global_step_2",
"CreateTime": "2024-01-01T12:57:28Z",
"Status": "Exported"
}]

模型精调产物列表

ProjectName
String

default

项目名

Name
String

测试任务

模型精调任务名称

PublishedOutputCount
Integer

1

已发布模型精调任务产物数量

Reason
String

InvalidData

任务失败原因,有 InvalidData,InternalError,UnknownError

SaveModelLimit
Integer

1

SaveModel 数量的最大限制

Status
Object

{
"Phase": "Completed",
"PhaseTime": "2024-01-01T00:00:00Z",
"RetryCount": 0,
"OutputExpiredTime": "2024-01-01T13:03:09Z",
"Resumable": false,
"RetryLimit": 3,
"TrainingTokensPerEpoch": 41422,
"BillableTokens": 414220
}

模型精调任务状态

Tags
Array of Object

[
{
"Key": "sys:ark:createdBy",
"Value": "IAMUser/23454321/test.user@bytedance.com"
}]

标签

TotalOutputCount
Integer

1

模型精调产物总数

UpdateTime
String

2024-01-01T00:00:00Z

资源更新时间戳

请求示例

POST /?Action=GetModelCustomizationJob&Version=2024-01-01 HTTP/1.1
Host: open.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20250115T035622Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20250115/cn-beijing/ark/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

{
  "Id": "mcj-20240101000000-a1b2cr"
}

返回示例

{
	"ResponseMetadata": {
		"RequestId": "2025011511564424916310121745440A",
		"Action": "GetModelCustomizationJob",
		"Version": "2024-01-01",
		"Service": "ark",
		"Region": "cn-beijing"
	},
	"Result": {
		"CreateTime": "2024-01-01T00:00:00Z",
		"CustomizationType": "FinetuneLoRA",
		"Data": {
			"TrainingSet": {
				"TosBucket": "ark-auto-2100466578-ap-southeast-1-default",
				"TosPaths": [
					"model-customization-job-training-set/1740646772293/train_5k.jsonl"
				]
			},
			"EncryptionKeyringType": "ManagedKeyring",
			"KMSTrn": "trn:kms:cn-beijing:2100466578:keyrings/managed_ark_keyring/keys/modelcustomization"
		},
		"Id": "mcj-20240101000000-a1b2c",
		"Hyperparameters": [{
			"Name": "epoch",
			"Value": "1"
		}],
		"Description": "这是一个测试任务",
		"ModelReference": {
			"FoundationModel": {
				"Name": "doubao-pro-32k",
				"ModelVersion": "240828"
			}
		},
		"Outputs": [{
			"Index": 1,
			"Name": "global_step_1",
			"Status": "Exported"
		}],
		"ProjectName": "default",
		"Name": "测试任务",
		"PublishedOutputCount": 1,
		"Reason": "",
		"SaveModelLimit": 1,
		"Status": {
			"Phase": "Completed",
			"PhaseTime": "2024-01-04T07:04:29Z",
			"RetryLimit": 1
		},
		"Tags": [{
			"Key": "sys:ark:createdBy",
			"Value": "IAMUser/123/zhangsan"
		}],
		"TotalOutputCount": 1,
		"UpdateTime": "2024-01-01T00:00:00Z"
	}
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码
错误码
错误信息
说明
400
MissingParameter.{{Parameter}}

The required parameter {{Parameter}} is missing.

缺少必要的请求参数。请确认请求参数后重试。

404
NotFound.{{Parameter}}

The specified {{ResourceType}} {{ResourceContent}} is not found.

指定资源找不到。请确认参数后重试。

500
InternalError

The request has failed due to an unknown error.

未知错误,请稍后重试。如果多次尝试仍失败,请提交工单。

最近更新时间:2025.06.20 20:04:26
这个页面对您有帮助吗?
有用
有用
无用
无用