获取模型版本详情
POST
https://qianfan.baidubce.com/wenxinworkshop/modelrepo/modelVersionDetail功能介绍
本接口用于根据模型版本id获取模型版本详情,如模型名称、版本号、模型版本来源类型等。
注意事项
- 调用本文API,使用“安全认证/Access Key ”中的Access Key ID 和 Secret Access Key等进行鉴权,无法使用获取Access Token的方式鉴权,具体鉴权认证机制参考鉴权认证机制。
请求参数
sourceExtra说明
名称 | 类型 | 描述 |
---|---|---|
sourceType | string | 版本来源类型,不同类型对应不同的数据结构,说明: Train:大模型训练产生 Acceleration:模型加速产生 Import:外部导入模型 |
trainSourceExtra | object | 大模型训练回溯信息 |
accelerationSourceExtra | object | 模型加速回溯信息 |
importModelVersionSourceExtra | object | 导入模型回溯信息 |
trainSourceExtra说明
名称 | 类型 | 描述 |
---|---|---|
taskId | integer | 训练ID |
taskName | string | 训练名称 |
iterationVersion | integer | 训练任务版本 |
runId | integer | 训练运行ID |
devType | integer | 说明: 1:大模型调优 2:RLHF-奖励模型 3:RLHF-强化学习 |
modelType | integer | 模型类型 |
accelerationSourceExtra说明
名称 | 类型 | 描述 |
---|---|---|
taskId | integer | 加速任务id |
taskName | string | 加速任务名称 |
sourceModelVersionId | integer | 源模型id |
importModelVersionSourceExtra说明
名称 | 类型 | 描述 |
---|---|---|
bucket | string | bos bucket |
object | string | bos object |
params说明
名称 | 类型 | 描述 |
---|---|---|
input | string | 入参,json字符串 |
output | integer | 出参,json字符串 |
错误码
若请求错误,服务器将返回的JSON文本包含以下参数:
名称 | 描述 |
---|---|
error_code | 错误码 |
error_msg | 错误描述信息,帮助理解和解决发生的错误 |
例如参数错误返回:
{
"error_code": 500001,
"error_msg": "param invalid"
}
错误码 | 错误信息 | 描述 |
---|---|---|
500000 | internal server error | 服务器内部错误 |
500001 | param invalid | 参数错误 |
500001 | param[%s] invalid | 参数错误 |
500002 | auth failed, no access | 无权访问 |
70002 | 查询错误[获取模型版本列表失败] | 查询模型版本列表失败 |
70102 | AI模型版本记录不存在 | 模型版本不存在 |
70105 | 获取模型参数失败 | 获取模型参数失败 |
请求参数
Header 参数
Content-Type
string
必需
固定值:application/json
x-bce-date
string
必需
当前时间,遵循ISO8601规范,格式如2016-04-06T08:23:49Z
Authorization
string
必需
用于验证请求合法性的认证信息,更多内容请参考鉴权认证机制,签名工具可参考IAM签名工具
Body 参数application/json
modelVersionId
integer
必需
模型版本id,通过页面url获取该字段值:在控制台-模型仓库列表-点击某模型详情-点击某版本详情,在版本详情页面url中查看
示例
{
"modelVersionId": 1
}
示例代码
返回响应
成功(200)
HTTP 状态码: 200
内容格式: JSONapplication/json
数据结构
result
object
请求结果
modelId
integer
模型id
modelName
string
模型名称
modelVersionId
integer
版本id
version
string
版本号
description
string
版本描述
sourceType
string
必需
模型版本来源类型,说明: Train:大模型训练产生 Acceleration:模型加速产生 PlatformPreset:平台预置模型版本 Import:外部导入模型
sourceExtra
object
版本来源回溯信息
framework
string
版本框架
algorithm
string
算法类型
modelNet
string
网络类型
state
string
必需
状态,说明: Ready:已就绪 Creating:创建中 Fail:创建失败
ioMode
string
必需
输入输出模式,说明: chat:对话模式 completion:续写模式
ioLength
string
必需
输入输出长度,示例:3K+1K
copyright
string
必需
版权信息,仅开源模型及其衍生模型返回该字段
property
object
必需
模型的额外属性信息,json字符串
createTime
string
版本创建时间戳
modifyTime
string
版本修改时间戳
deployResource
array[string]
必需
模型可部署的资源池类型,说明: Public:公共资源池 Private:私有资源池
supportOptions
array[string]
必需
模型支持的下游操作,说明: Deploy:部署 Acceleration:压缩 Evaluation:评估
params
object
出入参
log_id
string
请求ID
示例
{
"result": {
"modelId": 7,
"modelName": "ERNIE-Bot",
"modelVersionId": 39,
"version": "ERNIE-Bot",
"description": "百度⾃⾏研发的⼤语⾔模型,覆盖海量中⽂数据,具有更强的对话问答、内容创作⽣成等能⼒。",
"sourceType": "PlatformPreset",
"sourceExtra": {},
"framework": "paddle",
"algorithm": "Ernie_Bot_105B",
"modelNet": "paddlepaddle-ERNIE_EB-ERNIEBOT_105B-2.4.0-V1.25.3",
"state": "Ready",
"ioMode": "chat",
"ioLength": "",
"copyright": "",
"property": {},
"createTime": "2023-05-31T21:49:00+08:00",
"modifyTime": "2023-08-29T19:28:15+08:00",
"deployResource": [
"Private"
],
"supportOptions": [
"Deploy"
],
"params": {
"input": {
"type": "object",
"required": [
"messages"
],
"properties": {
"messages": {
"type": "array",
"items": {
"type": "object",
"required": [
"role",
"content"
],
"properties": {
"role": {
"name": "role",
"type": "string",
"default": "user",
"description": "当前支持以下两个role: "user": 用户 "assistant": 对话助手"
},
"content": {
"name": "content",
"type": "string",
"description": "对话内容,不能为空"
}
}
}
},
"stream": {
"name": "stream",
"type": "boolean",
"description": "是否以流式接口的形式返回数据; 默认false"
},
"user_id": {
"name": "user_id",
"type": "string",
"description": "表示最终用户的唯一标识符,可以监视和检测滥用行为,防止接口恶意调用。"
},
"temperature": {
"name": "temperature",
"type": "number",
"format": "float",
"description": "较高的数值会使输出更加随机,而较低的数值会使其更加集中和确定。 默认0.95,范围 (0, 1.0],不能为0 建议该参数和top_p只设置1个"
},
"top_p": {
"name": "top_p",
"type": "number",
"format": "float",
"description": "影响输出文本的多样性,取值越大,生成文本的多样性越强。 默认0.8,取值范围 [0, 1.0] 建议该参数和temperature只设置1个"
},
"penalty_score": {
"name": "penalty_score",
"type": "number",
"format": "float",
"description": "通过对已生成的token增加惩罚,减少重复生成的现象。值越大表示惩罚越大。 默认1.0,取值范围:[1.0, 2.0]"
}
}
},
"output": {
"type": "object",
"required": [],
"properties": {
"id": {
"name": "id",
"type": "string",
"description": "本轮对话的id"
},
"object": {
"name": "object",
"type": "string",
"description": "回包类型,“chat.completion”:多轮对话返回"
},
"created": {
"name": "created",
"type": "integer",
"format": "int32",
"description": "时间戳"
},
"sentence_id": {
"name": "sentence_id",
"type": "integer",
"format": "int32",
"description": "流式接口模式下会返回,表示当前子句的序号"
},
"is_end": {
"name": "is_end",
"type": "boolean",
"description": "流式接口模式下会返回,表示当前子句是否是最后一句"
},
"is_truncated": {
"name": "is_end",
"type": "boolean",
"description": "标识当前生成的结果是否被截断"
},
"result": {
"name": "result",
"type": "string",
"description": "对话返回结果, 当前对话返回结果限制在1000个token"
},
"need_clear_history": {
"name": "need_clear_history",
"type": "boolean",
"description": "值为true表示用户输入存在安全风险,建议关闭当前会话,清理历史会话信息"
},
"ban_round": {
"name": "ban_round",
"type": "integer",
"format": "int32",
"description": "当need_clear_history为true时,次字段会告知第几轮对话有敏感信息,如果是当前问题,ban_round = -1"
},
"usage": {
"type": "object",
"required": [],
"description": "token统计信息,token数 = 汉字数+单词数*1.3 (仅为估算逻辑)",
"properties": {
"prompt_tokens": {
"name": "prompt_tokens",
"type": "integer",
"format": "int32",
"description": "问题tokens数"
},
"completion_tokens": {
"name": "completion_tokens",
"type": "integer",
"format": "int32",
"description": "回答tokens数"
},
"total_tokens": {
"name": "total_tokens",
"type": "integer",
"format": "int32",
"description": "tokens总数"
}
}
}
}
}
}
},
"log_id": "2443391389"
}
最后修改时间: 1 年前