新建我的模型版本

更新时间：2024-12-23

接口描述

本接口用于新建我的模型版本。

权限说明

调用本文API，需符合以下权限要求，权限介绍及分配，请查看角色与权限控制列表、账号创建与权限分配。需具有以下任一权限：

完全控制千帆大模型平台的权限：QianfanFullControlAccessPolicy
完全控制千帆大模型平台模型调优的权限：QianfanModelTuningFullControlAccessPolicy

鉴权说明

调用本文API，使用“基于安全认证AK/SK”进行签名计算鉴权，即使用安全认证中的Access Key ID 和 Secret Access Key进行鉴权，具体鉴权认证机制参考HTTP调用鉴权说明。

请求结构

Bash

POST /v2/model?Action=CreateCustomModel HTTP/1.1
Host: qianfan.baidubce.com
Authorization: authorization string
Content-Type: application/json

{
   "modelSetId": "am-ashdagwfy234",
    "sourceType": "Train",
    "trainMeta": {
        "taskId": "task-sdvsdfbhjsdfb",
        "step": 50
    }
}

请求头域

除公共头域外，无其它特殊头域。

请求参数

Query参数

名称	类型	必填	描述
Action	string	是	方法名称，固定值CreateCustomModel

Body参数

名称	类型	必填	描述
modelSetId	string	是	模型版本归属的模型ID，示例：am-gh0azfeb9adu，说明：通过以下任一方式获取该字段值： · 方式一：调用新建获取我的模型列表接口，返回的modelSetId字段获取 · 方式二：在控制台-我的模型查看，如下图所示
description	string	否	模型版本描述，长度为 [0, 300]
sourceType	string	是	版本来源，可选值如下： · Train：训练模型发布 · Import：外部导入模型发布
trainMeta	TrainSourceMeta	否	当sourceType=Train时，此字段必填
importMeta	ImportSourceMeta	否	当sourceType=Import时，此字段必填

TrainSourceMeta说明

名称	类型	必填	描述
taskId	string	是	训练任务ID
checkpointStep	int	否	选择step发布时填写此字段

ImportSourceMeta说明

名称	类型	必填	描述
bucket	string	是	bucket名称
objectPath	string	是	object路径
modelFormat	string	是	模型格式，可选值如下： · HuggingFace.Transformers：HF导入模型 · Safetensors：文生图模型
modelApplicationType	string	是	输入输出模式，可选值如下： · chat：对话模式 · completion：续写模式 · Text-to-Image：文生图模式
chatConf	ChatConf	否	对话模型平台预置对话模板，说明：（1）该字段仅导入HF模型有效（2）该字段与customSpec字段不能同时使用，只能选择其中一个
customSpec	CustomSpec	否	对话模型自定义对话模板，说明：（1）该字段仅导入HF模型有效（2）该字段与chatConf字段不能同时使用，只能选择其中一个
advanceConf	string	否	说明：（1）该字段仅导入HF模型有效（2）该字段值通过调用获取导入模型平台预置高级配置接口，返回的result获取
transformerVersion	string	是	说明：（1）该字段仅导入HF模型有效（2）transformer版本，目前支持4.34.0、4.36.2、4.39.3和4.40.2
vLLMVersion	string	否	说明：（1）该字段仅导入HF模型可填（2）vLLM版本，目前支持0.3.2、0.4.0
advancedSettings	object	是	量化压缩配置

ChatConf说明

名称	类型	必填	描述
historyQATemplate	string	是	历史对话模板，长度限制[1,200]
latestQuestionTemplate	string	是	最新对话模板, 长度限制[1,200]
promptTemplate	string	是	prompt模板，长度限制[0,300]

CustomSpec说明

名称	类型	必填	描述
displayName	string	是	自定义配置文件展示名称，长度限制[1,200]
fileName	string	是	自定义配置平台存储文件名称，该字段值通过调用上传自定义对话模板文件接口，返回result字段获取

modelCompConf说明

名称	类型	必填	描述
samplingStrategy	string	是	压缩时的采样策略，（1）当导入HF模型，且推理引擎为vLLM时，该字段有效（2）可选值： · 多项式采样：multinomialSampling · 束搜索：beamSearch · 贪心搜索 greedySearch
numSampling	int	否	返回序列数量，当导入HF模型可填，采样策略选择multinomialSampling且推理引擎为vLLM时可填，范围为1~15
numBeams	int	是	束数量，当导入HF模型，该字段有效，取值范围2-15

响应头域

除公共头域外，无其它特殊头域。

响应参数

名称	类型	描述
requestId	string	请求ID
result	object	请求结果

result说明

名称	类型	描述
modelSetId	string	模型ID
modelId	string	模型版本ID

请求示例

训练侧发布模型

Bash

# 替换下列示例中的Authorization值、x-bce-date值
curl -i --location 'https://qianfan.baidubce.com/v2/model?Action=CreateCustomModel' \
--header 'Authorization: bce-auth-v1/f0ee7axxxx/2023-09-19T13:42:13Z/180000/host;x-bce-date/9a8cfb8ee5xxxxe374525543' \ 
--header 'x-bce-date: 2023-09-19T13:37:10Z' \
--header 'Content-Type: application/json' \ 
--data '{
    "modelSetId": "am-ashdagwfy234",
    "sourceType": "Train",
    "trainMeta": {
        "taskId": "task-sdvsdfbhjsdfb",
        "step": 50
    }
}'

导入自定义HF模型

Bash

# 替换下列示例中的Authorization值、x-bce-date值
curl -i --location 'https://qianfan.baidubce.com/v2/model?Action=CreateCustomModel' \
--header 'Authorization: bce-auth-v1/f0ee7axxxx/2023-09-19T13:42:13Z/180000/host;x-bce-date/9a8cfb8ee5xxxxe374525543' \ 
--header 'x-bce-date: 2023-09-19T13:37:10Z' \
--header 'Content-Type: application/json' \ 
--data '{
    "modelSetId":"am-ih84wp37cizi",
    "sourceType":"Import",
    "importMeta":{
        "bucket":"test",
        "objectPath":"demoModel",
        "modelFormat":"HuggingFace.Transformers",
        "modelApplicationType":"chat",
        "transformerVersion":"4.36.2",
        "chatConf": {
            "historyQATemplate": "\\n\\nUser: {question} \\nAssistant: {answer}\\n",
            "latestQuestionTemplate": "\\n\\nUser: {question} \\nAssistant:",
            "promptTemplate": "你是一个对话机器人，根据下文输入完成回答\n### 输入:\n{input}\n### 回答: "
        }
    }
}
'

响应示例

JSON

{
    "requestId": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
    "result": {
        "modelSetId": "am-5sxpz4xn25uw",
        "modelId": "amv-21qxxr97z8fp"
    }
}

错误码

若请求错误，服务器将返回的JSON文本包含以下参数：

名称	描述
requestId	请求ID
code	错误码
message	错误描述信息，帮助理解和解决发生的错误

例如错误返回：

{
    "requestId":"6ba7b810-xxxxc04fd430c8",
    "code":"AccessDenied",
    "message":"Access denied."
}

更多其他错误码，也可以查看错误码说明。

删除我的模型

上传自定义对话模板文件