GetCustomModel - 获取定制模型信息--火山方舟大模型服务平台-火山引擎

文档中心

导航

GetCustomModel - 获取定制模型信息

最近更新时间：2024.09.19 16:49:13首次发布时间：2024.05.15 01:48:35

获取定制模型信息

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	GetCustomModel	要执行的操作，取值：GetCustomModel。
Version	String	是	2024-01-01	API的版本，取值：2024-01-01。
Id	String	是	cm-id	定制模型的ID

返回参数

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

参数	类型	示例值	描述
Id	String	cm-20240101000000-abcde	资源Id
Name	String	模型名称	资源名称
Description	String	模型描述	资源描述
SourceType	String	Customization	来源类型
FoundationModel	Object	doubao-pro-32k	基础模型引用
ModelCustomizationJobId	String	mcj-20240101000000-abcde	模型自定义任务ID
CustomizationType	String	FinetuneLoRA	自定义类型
SourceModelAvailable	Boolean	true	如果当前模型是基于一个共享模型增量训练出来的模型，该字段用于表示共享来源模型是否仍然有效
LoraBaseModelAvailable	Boolean	true	如果当前模型是一个基于全量SFT模型增量精调出来的模型，该字段用于表示全量SFT模型是否仍然有效
Tags	Array of Object	["Key": "tag_key", "Value": "Tag Value"]	标签列表
ProjectName	String	default	项目名称
CreateTime	String	2024-01-01T00:00:00Z	创建时间
UpdateTime	String	2024-01-01T00:00:00Z	更新时间

请求示例

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

{
  "Id": "cm-id"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "2024051421034216322206625187C9AD",
    "Action": "GetCustomModel",
    "Version": "2024-01-01",
    "Service": "ark",
    "Region": "cn-beijing"
  },
  "Result": {
    "CustomModel": {
      "Id": "1GSH",
      "Name": "2dYgMKVBt",
      "Description": "d4Hkd5Fe3M",
      "SourceType": "GWVZA3",
      "ModelCustomizationJobId": "4Uxl",
      "CustomizationType": "Hoev2RymwBl",
      "Status": "Ready",
      "HyperParameters": [
        {
          "Name": "rFL44dtTT9",
          "Value": "RnF7Q"
        }
      ],
      "FoundationModel": {
        "Name": "YflRG",
        "ModelVersion": "FvVqyQtk"
      },
      "Tags": [
        {
          "Key": "QBb",
          "Value": "rwl1F860fK"
        }
      ],
      "ProjectName": "gQZXp",
      "CreateTime": "X",
      "UpdateTime": "quUkQIjh"
    }
  }
}

错误码

您可访问公共错误码，获取更多错误码信息。