获取模型版本详情

功能介绍

根据模型版本id，获取某个模型版本的具体信息，如模型名称、版本号、模型版本来源类型等。

注意事项

调用本文API，需使用安全认证AK/SK鉴权，调用流程及鉴权介绍详见SDK安装及使用流程。

调用示例

• Python

from qianfan import resources

model = resources.Model.detail(model_version_id = 5659)
print(model)

返回示例

• Python

QfResponse(code = 200, headers = {
            ...
        },
        body = {
            'log_id': '2255112739',
            'result': {
                'modelId': 4631,
                'modelName': 'hf_baichuan',
                'modelVersionId': 5659,
                'version': '1',
                'description': '',
                'sourceType': 'Import',
                'sourceExtra': {
                    'importModelVersionSourceExtra': {
                        'bucket': 'aipe-dragonboat',
                        'object': 'qianfan_modelrepo_preset_model/baichuan-13b-chat/1/'
                    },
                    'sourceType': 'Import'
                },
                'framework': '',
                'algorithm': 'HF-user-defined-model',
                'modelNet': 'HF-user-defined-model',
                'state': 'Ready',
                'ioMode': 'chat',
                'ioLength': '',
                'copyright': '',
                'property': {
                    'importModelProperty': {
                        'modelFormat': 'HuggingFace.Transformers',
                        'chatConf': {
                            'historyQATemplate': '\\n\\nUser: {question} \\nAssistant: {answer}\\n',
                            'latestQuestionTemplate': '\\n\\nUser: {question} \\nAssistant:',
                            'promptTemplate': '你是一个对话机器人，根据下文输入完成回答\n### 输入:\n{input}\n### 回答: '
                        }
                    }
                },
                'createTime': '2023-09-03T16:30:30+08:00',
                'modifyTime': '2023-09-03T16:35:44+08:00',
                'deployResource': ['Private'],
                'supportOptions': ['Deploy'],
                'params': {
                    'input': {
                        'type': 'object',
                        'required': ['messages'],
                        'properties': {
                            'messages': {
                                'type': 'array',
                                'items': {
                                    'type': 'object',
                                    'required': ['role', 'content'],
                                    ....
                                })

参数说明

请求参数

名称	类型	必填	描述
model_version_id	int	是	模型版本id，可以通过以下任一方式获取该字段值： 方式一，通过页面url获取该字段值：在控制台-模型仓库列表-点击某模型详情-点击某版本详情，在版本详情页面url中查看 方式二，通过调用获取模型详情接口获取

返回参数

名称	类型	描述
log_id	int	请求ID
result	dict	请求结果

result说明

名称	类型	描述
modelName	string	模型名称
modelId	int	模型id
modelVersionId	int	版本id
state	string	状态，说明： Ready：已就绪 Creating：创建中 Fail：创建失败
version	string	版本号
sourceType	string	模型版本来源类型，说明： Train：大模型训练产生 Acceleration：模型加速产生 PlatformPreset：平台预置模型版本 Import：外部导入模型
sourceExtra	dict	版本来源回溯信息
modelNet	string	网络类型
framework	string	版本框架
algorithm	string	算法类型
description	string	版本描述
createTime	int	版本创建时间戳
modifyTime	string	版本修改时间戳
ioMode	string	输入输出模式，说明： chat：对话模式 completion：续写模式
ioLength	string	输入输出长度，示例：3K+1K
params	dict	出入参
copyright	string	版权信息，仅开源模型及其衍生模型返回该字段
license	string	开源协议，仅预置开源模型返回该字段
property	string	模型的额外属性信息，json字符串
deployResource	list[string]	模型可部署的资源池类型，说明： Public：公共资源池 Private：私有资源池
supportOptions	list[string]	模型支持的下游操作，说明： Deploy：部署 Acceleration：压缩 Evaluation：评估

sourceExtra说明

名称	类型	描述
sourceType	string	版本来源类型，不同类型对应不同的数据结构，说明： Train：大模型训练产生 Acceleration：模型加速产生 Import：外部导入模型
trainSourceExtra	dict	大模型训练回溯信息
accelerationSourceExtra	dict	模型加速回溯信息
importModelVersionSourceExtra	dict	导入模型回溯信息

trainSourceExtra说明

名称	类型	描述
taskId	int	训练ID
taskName	string	训练名称
iterationVersion	int	训练任务版本
runId	int	训练运行ID
devType	int	说明： 1：大模型调优 2：RLHF-奖励模型 3：RLHF-强化学习
modelType	int	模型类型

accelerationSourceExtra说明

名称	类型	描述
taskId	int	加速任务id
taskName	string	加速任务名称
sourceModelVersionId	int	源模型id

importModelVersionSourceExtra说明

名称	类型	描述
bucket	string	bos bucket
object	string	bos object

params说明

名称	类型	描述
input	string	入参，json字符串
output	int	出参，json字符串