获取用户模型列表

更新时间：2024-12-26

注意：

为提升开发者使用体验，推荐使用模型管理V2版本接口，功能更全面、且接口更规范，详见模型管理API列表。
模型管理V1版本接口功能不再升级，本文档于2024年8月5日下线；由于V1版本接口后续可能下线停止服务，为避免影响使用，建议接入模型管理V2版本接口。

功能介绍

本接口用于查看用户训练产生的模型列表。

SDK调用

使用说明

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

调用示例

Python

import os
from qianfan.resources import Model

# 使用安全认证AK/SK鉴权，通过环境变量方式初始化；替换下列示例中参数，安全认证Access Key替换your_iam_ak，Secret Key替换your_iam_sk
os.environ["QIANFAN_ACCESS_KEY"] = "your_iam_ak"
os.environ["QIANFAN_SECRET_KEY"] = "your_iam_sk"

# 获取model_type为1或4的用户模型
user_list = Model.user_list(model_type=[1, 4]) 

print(user_list)
#print(user_list['body'])

返回示例

Python

QfResponse(
    code = 200, 
    headers = {...}, 
    body = {
        'log_id': '3109887584',
        'result': {
            'total': 4,
            'items': [{
                'modelName': 'testxyWST',
                'modelId': 12648,
                'modelIdStr': 'am-gmptxxxfci',
                'modelType': 1,
                'tags': None,
                'createTime': '2024-01-26T11:31:38+08:00',
                'versionCount': 1,
                'trainType': 'WENXIN-YIGE',
                'latestVersionInfo': {
                    'state': 'Ready',
                    'version': '1',
                    'sourceType': 'Train',
                    'sourceExtra': {
                        'trainSourceExtra': {
                            'taskId': 18252,
                            'taskName': 'testxy011105',
                            'iterationVersion': 1,
                            'runId': 100,
                            'devType': 1,
                            'modelType': 7xx,
                            'templateType': 70xx
                        },
                        'sourceType': 'Train'
                    },
                    'versionId': 15xx,
                    'versionIdStr': 'amv-prjg6zqe1bhb'
                }
            }, {
                'modelName': 'pokemon_lora_model',
                'modelId': 12xx,
                'modelIdStr': 'am-xwn7yfaw919h',
                'modelType': 1,
                'tags': None,
                'createTime': '2024-01-17T11:31:26+08:00',
                'versionCount': 1,
                'trainType': 'stablediffusion_VXL',
                'latestVersionInfo': {
                    'state': 'Ready',
                    'version': '1',
                    'sourceType': 'Train',
                    'sourceExtra': {
                        'trainSourceExtra': {
                            'taskId': 18xx,
                            'taskName': 'pokemon_lora',
                            'iterationVersion': 1,
                            'runId': 10xx,
                            'devType': 1,
                            'modelType': 70xx,
                            'templateType': 70xx
                        },
                        'sourceType': 'Train'
                    },
                    'versionId': 15xx,
                    'versionIdStr': 'amv-xy8bxxxxw7'
                }
            }, {
                'modelName': 'testxy0111yige',
                'modelId': 11xx,
                'modelIdStr': 'am-knbxxx5f',
                'modelType': 1,
                'tags': None,
                'createTime': '2024-01-12T10:38:32+08:00',
                'versionCount': 1,
                'trainType': 'WENXIN-YIGE',
                'latestVersionInfo': {
                    'state': 'Ready',
                    'version': '1',
                    'sourceType': 'Train',
                    'sourceExtra': {
                        'trainSourceExtra': {
                            'taskId': 18xx,
                            'taskName': 'testxy011105',
                            'iterationVersion': 1,
                            'runId': 10xx,
                            'devType': 1,
                            'modelType': 705,
                            'templateType': 70xx
                        },
                        'sourceType': 'Train'
                    },
                    'versionId': 14xx,
                    'versionIdStr': 'amv-xd05xxxb3zb'
                }
            }, {
                'modelName': 'yige_test',
                'modelId': 11xx,
                'modelIdStr': 'am-58d6xxxmw3',
                'modelType': 1,
                'tags': None,
                'createTime': '2024-01-12T10:38:07+08:00',
                'versionCount': 1,
                'trainType': 'WENXIN-YIGE',
                'latestVersionInfo': {
                    'state': 'Ready',
                    'version': '1',
                    'sourceType': 'Train',
                    'sourceExtra': {
                        'trainSourceExtra': {
                            'taskId': 18xx,
                            'taskName': 'testxy011105',
                            'iterationVersion': 1,
                            'runId': 10xx,
                            'devType': 1,
                            'modelType': 705,
                            'templateType': 70xx
                        },
                        'sourceType': 'Train'
                    },
                    'versionId': 14xx,
                    'versionIdStr': 'amv-m2uxxx8ahd'
                }
            }]
        }
})

请求参数

名称	类型	必填	描述
name_filter	string	否	名称过滤器
model_type	int[]	否	模型类型，可选值如下： · 0：大语言模型 · 1：文生图大模型 · 2：产业级搜索模型 · 3：文本表示模型 · 4：向量表示模型 · 5：图像理解模型
order_by	string	否	排序字段，目前仅支持create_time
order	string	否	次序，可选值如下： · asc：升序，从小到大 · desc：降序，从大到小
page_no	int	是	页码，最小值为1
page_size	int	是	每页大小，必须大于0

返回参数

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

result说明

名称	类型	描述
modelId	int	模型数字ID
modelIdStr	string	模型字符串ID
modelName	string	模型名称
modelType	integer	模型类型
tags	string[]	业务标签
createUsername	string	创建人
createUser	integer	创建人id
createTime	string	创建时间
versionCount	int	修改时间
trainType	string	基础模型，说明：（1）该字段值说明： · 当基础模型是ernieBotLite各版本模型，该字段返回ernieBotLite；例如基础模型是ernieBotLite-v201-8k，返回trainType值为ernieBotLite · 当基础模型是chatglm2-6b、chatglm2-6b-32k，该字段返回chatglm2-6b其他，该字段值是对应基础模型（2）在将训练任务发布为模型场景，使用该字段时，需注意以下，更多详情请参考训练任务发布为模型： · 该字段值需和模型调优-获取任务运行详情接口返回的trainType字段配合使用
latestVersionInfo	dict[]	模型版本列表

latestVersionInfo说明

名称	类型	描述
versionId	int	版本ID，int类型
versionIdStr	string	版本ID，string类型
state	string	状态，说明： · Ready：已就绪 · Creating：创建中 · Fail：创建失败
version	string	版本号
sourceType	string	模型版本来源类型，说明： · Train：大模型训练产生 · Acceleration：模型加速产生 · PlatformPreset：平台预置模型版本 · Import：外部导入模型
sourceExtra	string	模型版本来源详细信息

HTTP调用

鉴权说明

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

请求说明

基本信息

请求地址： https://qianfan.baidubce.com/wenxinworkshop/modelrepo/model/user/list

请求方式： POST

Header参数

名称	类型	必填	描述
Content-Type	string	是	固定值：application/json
x-bce-date	string	否	当前时间，遵循ISO8601规范，格式如2016-04-06T08:23:49Z
Authorization	string	是	用于验证请求合法性的认证信息，更多内容请参考鉴权认证机制，签名工具可参考IAM签名工具

Body参数

名称	类型	必填	描述
nameFilter	string	否	名称过滤器
modelType	int[]	否	模型类型，可选值如下： · 0：大语言模型 · 1：文生图大模型 · 2：产业级搜索模型 · 3：文本表示模型 · 4：向量表示模型 · 5：图像理解模型
orderBy	string	否	排序字段，目前仅支持create_time
order	string	否	次序，可选值如下： · asc：升序，从小到大 · desc：降序，从大到小
pageNo	int	是	页码，最小值为1
pageSize	int	是	每页大小，必须大于0

响应说明

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