获取我的模型列表
更新时间:2024-07-18
功能介绍
本接口用于获取我的模型列表。
SDK调用
使用说明
调用本文API,需使用安全认证AK/SK鉴权,调用流程及鉴权介绍详见SDK安装及使用流程。
调用示例
import os
from qianfan import resources
# 使用安全认证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"
resp = resources.Model.V2.describe_custom_model_sets(max_keys=1)
print(resp.body)
返回示例
{
"requestId": "b0ee1c27-51e1-4851-91a2-97287ae1e257",
"result": {
"customModelSetList": [
{
"modelSetName": "shien-t1",
"modelSetId": "am-v8vg3w7isjr9",
"modelType": "Text2Text",
"labels": None,
"createTime": "2023-06-15T15:21:38+08:00",
"modifyTime": "2024-01-11T15:32:30+08:00",
"modelCount": 1,
},
{
"modelSetName": "cmc_test_误删",
"modelSetId": "am-bjniekf03yg9",
"modelType": "Text2Text",
"labels": None,
"createTime": "2023-06-15T16:43:41+08:00",
"modifyTime": "2024-01-11T15:32:37+08:00",
"modelCount": 2,
},
],
"pageInfo": {
"marker": "",
"maxKeys": 1,
"isTruncated": True,
"nextMarker": "am-bjniekf03yg9",
},
},
}
请求参数
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
marker | string | 否 | 本次查询的起始位置,默认从第一条数据开始 |
max_keys | int | 否 | 说明: (1)默认值是10 (2)返回的列表长度最大为100,如果指定值大于100,按100操作 |
page_reverse | bool | 否 | 是否倒序,默认为False |
返回参数
名称 | 类型 | 描述 |
---|---|---|
customModelSetList | list[CustomModelSetItem] | 模型信息列表 |
pageInfo | dict | 分页信息 |
CustomModelItem说明
名称 | 类型 | 描述 |
---|---|---|
modelSetId | string | 模型ID |
modelSetName | string | 模型名称 |
modelType | string | 模型类型 |
labels | list[string] | 业务标签 |
createTime | string | 创建时间 |
modifyTime | string | 修改时间 |
modelCount | int | 模型版本数量 |
pageInfo说明
名称 | 类型 | 描述 |
---|---|---|
marker | string | 本次查询的起始位置 |
maxKeys | int | 请求返回的最大数目 |
isTruncated | bool | 指明是否只返回了部分数据,说明: · False:表示本次已经返回所有结果 · True:表示本次还没有返回所有结果 |
nextMarker | string | 当isTruncated为True时,才返回此项,作为下次查询marker的值 |
HTTP调用
鉴权说明
调用本文API,使用“基于安全认证AK/SK”进行签名计算鉴权,即使用安全认证中的Access Key ID 和 Secret Access Key进行鉴权,具体鉴权认证机制参考HTTP调用鉴权说明。
请求说明
- 基本信息
请求地址: https://qianfan.baidubce.com/v2/model
请求方式: POST
- Header参数
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
Content-Type | string | 是 | 固定值:application/json |
x-bce-date | string | 否 | 当前时间,遵循ISO8601规范,格式如2016-04-06T08:23:49Z |
Authorization | string | 是 | 用于验证请求合法性的认证信息,更多内容请参考鉴权认证机制,签名工具可参考IAM签名工具 |
- Query参数
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
Action | string | 是 | 方法名称,固定值DescribeCustomModelSets |
- Body参数
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
marker | string | 否 | 本次查询的起始位置,默认从第一条数据开始 |
maxKeys | int | 否 | 说明: (1)默认值是10 (2)返回的列表长度最大为100,如果指定值大于100,按100操作 |
pageReverse | bool | 否 | 是否倒序,默认为false |
响应说明
名称 | 类型 | 描述 |
---|---|---|
requestId | string | 请求ID |
result | object | 请求结果 |
result说明
名称 | 类型 | 描述 |
---|---|---|
customModelSetList | list[object(CustomModelSetItem)] | 模型信息列表 |
pageInfo | object | 分页信息 |
CustomModelSetItem说明
名称 | 类型 | 描述 |
---|---|---|
modelSetId | string | 模型ID |
modelSetName | string | 模型名称 |
modelType | string | 模型类型 |
labels | list[string] | 业务标签 |
createTime | string | 创建时间 |
modifyTime | string | 修改时间 |
modelCount | int | 模型版本数量 |
pageInfo说明
名称 | 类型 | 描述 |
---|---|---|
marker | string | 本次查询的起始位置 |
maxKeys | int | 请求返回的最大数目 |
isTruncated | bool | 指明是否只返回了部分数据,说明: · false:表示本次已经返回所有结果, · true:表示本次还没有返回所有结果 |
nextMarker | string | 当isTruncated为true时,才返回此项,作为下次查询marker的值 |
请求示例
curl -i --location 'https://qianfan.baidubce.com/v2/model?Action=DescribeCustomModelSets' \
--header 'Authorization: bce-auth-v1/f0ee7axxxx/2023-09-19T13:42:13Z/180000/host;x-bce-date/9a8cfb8ee58a8f44a21a526xxxxxxxxxa2e6d843' \
--header 'x-bce-date: 2023-09-19T13:37:10Z' \
--header 'Content-Type: application/json' \
--data '{
"marker":"am-n50985crhqq3"
}'
响应示例
{
"requestId":"1bef3f87-c5b2-4419-936b-50f9884f10d4",
"result": {
"customModelSetList": [
{
"modelSetName": "clc_test_1",
"modelSetId":"am-gn7tsua99zbf",
"modelType": "大语言模型",
"labels": null,
"createTime": "2023-12-29T14:30:32+08:00",
"modelCount": 1,
},
{
"modelSetName": "clc_test",
"modelSetId": "am-gn7tssfg9zbf",
"modelType": "大语言模型",
"labels": null,
"createTime": "2023-12-29T14:28:33+08:00",
"modifyTime": "xxxx",
"modelCount": 1,
}
],
"pageInfo":{
"marker":"am-n50985crhqq3",
"maxKeys":1,
"isTruncated":false
}
}
}
错误码
若请求错误,服务器将返回的JSON文本包含以下参数:
名称 | 描述 |
---|---|
code | 错误码 |
message | 错误描述信息,帮助理解和解决发生的错误 |
例如错误返回:
{
"requestId":"1bef3f87-c5b2-4419-936b-50f9884f10d4",
"code":"AccessDenied",
"message":"Access denied."
}
更多千帆大模型平台其他错误码,也可以查看错误码说明。