获取用户模型列表
更新时间:2024-02-23
功能介绍
本接口用于查看用户训练产生的模型列表。
注意事项
- 调用本文API,使用“安全认证/Access Key ”中的Access Key ID 和 Secret Access Key等进行鉴权,无法使用获取Access Token的方式鉴权,具体鉴权认证机制参考鉴权认证机制。
请求说明
基本信息
请求地址: 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 | 请求结果 |
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 | object[] | 模型版本列表 |
latestVersionInfo说明
名称 | 类型 | 描述 |
---|---|---|
versionId | int | 版本ID,int类型 |
versionIdStr | string | 版本ID,string类型 |
state | string | 状态,说明: · Ready:已就绪 · Creating:创建中 · Fail:创建失败 |
version | string | 版本号 |
sourceType | string | 模型版本来源类型,说明: · Train:大模型训练产生 · Acceleration:模型加速产生 · PlatformPreset:平台预置模型版本 · Import:外部导入模型 |
sourceExtra | string | 模型版本来源详细信息 |
示例
请求示例
# 替换下列示例中的Authorization、x-bce-date
curl 'https://qianfan.baidubce.com/wenxinworkshop/modelrepo/model/user/list' \
--header 'Authorization: bce-auth-v1/f0ee7axxxx/2023-09-19T13:42:13Z/180000/host;x-bce-date/9a8cfb8ee58a8f44a21a52640015de61bc55ca2e6d8cc23d080016e374525543' \
--header 'x-bce-date: 2023-09-19T13:37:10Z' \
--header 'Content-Type: application/json' \
--data '{
"nameFilter":"cl",
"pageNo": 1,
"pageSize": 2,
"modelType":[0]
}'
响应示例
{
"log_id": "2668243085",
"result": {
"total": 15,
"items": [
{
"modelName": "clc_test_1",
"modelId": 476,
"modelIdStr":"am-gn7tsua99zbf",
"modelType": 0,
"tags": null,
"createTime": "2023-12-29T14:30:32+08:00",
"versionCount": 1,
"trainType": "",
"latestVersionInfo": {
"state": "Ready",
"version": "1",
"sourceType": "Train",
"sourceExtra": {
"trainSourceExtra": {
"taskId": 500,
"taskName": "test_turbo_pro_sft",
"iterationVersion": 2,
"runId": 1676,
"devType": 1,
"modelType": 20,
"templateType": 2000
},
"sourceType": "Train"
},
"versionId": 663,
"versionIdStr": "amv-1h46ebugstv3"
}
},
{
"modelName": "clc_test",
"modelId": 475,
"modelType": 0,
"tags": null,
"createTime": "2023-12-29T14:28:33+08:00",
"versionCount": 1,
"trainType": "",
"latestVersionInfo": {
"state": "Ready",
"version": "1",
"sourceType": "Train",
"sourceExtra": {
"trainSourceExtra": {
"taskId": 500,
"taskName": "test_turbo_pro_sft",
"iterationVersion": 2,
"runId": 1676,
"devType": 1,
"modelType": 20,
"templateType": 2000
},
"sourceType": "Train"
},
"versionId": 662,
"versionIdStr": "amv-7q01a2teqtic"
}
}
]
}
}
错误码
若请求错误,服务器将返回的JSON文本包含以下参数:
名称 | 描述 |
---|---|
error_code | 错误码 |
error_msg | 错误描述信息,帮助理解和解决发生的错误 |
例如参数错误返回:
{
"error_code": 500001,
"error_msg": "param invalid"
}
更多千帆大模型平台其他错误码,也可以查看错误码说明。