获取模型详情
更新时间:2024-06-18
功能介绍
本接口用于获取模型详情,如模型名称、模型类型、模型来源、创建时间等。
HTTP调用
鉴权说明
调用本文API,使用“安全认证/Access Key ”中的Access Key ID 和 Secret Access Key等进行鉴权,无法使用获取Access Token的方式鉴权,具体鉴权认证机制参考鉴权认证机制。
请求说明
- 基本信息
请求地址: 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 | 是 | 方法名称,固定值DescribeModelSet |
- Body参数
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
modelSetName | string | 否 | 模型名称,该字段与modelSetId不能同时使用,至少选择其中一个 |
modelSetId | string | 否 | 模型ID,示例:am-gh0azfeb9adu,说明: (1)该字段与modelSetName不能同时使用,至少选择其中一个 (2)通过以下任一方式获取该字段值: · 方式一:调用获取我的模型列表接口,返回的result字段获取 · 方式二:在千帆控制台-我的模型查看,如下图所示 ![]() |
响应说明
名称 | 类型 | 描述 |
---|---|---|
requestId | string | 请求ID |
result | string | 请求结果 |
result说明
名称 | 类型 | 描述 |
---|---|---|
modelSetId | string | 模型id |
modelSetName | string | 模型名称 |
modelType | string | 模型类型 |
source | string | 模型来源,说明: · 用户模型:Custom · 预置模型:System |
labels | list[string] | 业务标签 |
createTime | string | 创建时间 |
modifyTime | string | 修改时间,只有预置模型返回该字段 |
description | string | 模型描述,只有预置模型返回该字段 |
modelIds | list[string] | 模型拥有的模型版本ID列表 |
请求示例
# 替换下列示例中的Authorization值、x-bce-date值
curl -i --location 'https://qianfan.baidubce.com/v2/model?Action=DescribeModelSet' \
--header 'Authorization: bce-auth-v1/f0ee7axxxx/2023-09-19T13:42:13Z/180000/host;x-bce-date/9a8f44a21axxxxxxx6d8cc23' \
--header 'x-bce-date: 2023-09-19T13:37:10Z' \
--header 'Content-Type: application/json' \
--data '{
"modelSetName":"cl_test_hf1"
}'
响应示例
{
"requestId": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
"result": {
"modelSetId": "am-upqiuctdx15t",
"modelSetName": "cl_test_hf1",
"source": "Custom",
"modelType": "文本生成",
"trainType": "",
"createTime": "2024-04-10T17:16:22+08:00",
"description": "",
"modifyTime": "0001-01-01T00:00:00Z"
}
}
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_model_set(model_set_name="ad111")
print(resp.body)
返回示例
{
'requestId': 'fe0268a7-0d07-46ac-b195-36ca5be2d761',
'result': {
'modelSetId': 'am-m0t1zde3x111',
'modelSetName': 'ad111',
'source': 'UserCreate',
'modelType': 'Text2Text',
'createTime': '2024-06-04T18:38:59+08:00',
'modifyTime': '2024-06-04T18:38:59+08:00',
'modelIds': ['amv-34qkndzjf111']
}
}
请求参数
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
model_set_name | string | 否 | 模型名称,该字段与model_set_id不能同时使用,至少选择其中一个 |
model_set_id | string | 否 | 模型ID,示例:am-gh0azfeb9adu,说明: (1)该字段与model_set_name不能同时使用,至少选择其中一个 (2)通过以下任一方式获取该字段值: · 方式一:调用获取我的模型列表接口,返回的result字段获取 · 方式二:在千帆控制台-我的模型查看,如下图所示 ![]() |
返回参数
名称 | 类型 | 描述 |
---|---|---|
requestId | string | 请求ID |
result | dict | 请求结果 |
result说明
名称 | 类型 | 描述 |
---|---|---|
modelSetId | string | 模型id |
modelSetName | string | 模型名称 |
modelType | string | 模型类型 |
source | string | 模型来源,说明: · 用户模型:Custom · 预置模型:System |
labels | list[string] | 业务标签 |
createTime | string | 创建时间 |
modifyTime | string | 修改时间,只有预置模型返回该字段 |
description | string | 模型描述,只有预置模型返回该字段 |
modelIds | list[string] | 模型拥有的模型版本ID列表 |
错误码
若请求错误,服务器将返回的JSON文本包含以下参数:
名称 | 描述 |
---|---|
code | 错误码 |
message | 错误描述信息,帮助理解和解决发生的错误 |
例如错误返回:
{
"requestId":"6ba7b810-9dad-11d1-80b4-00c04fd430c8",
"code":"AccessDenied",
"message":"Access denied."
}
更多千帆大模型平台其他错误码,也可以查看错误码说明。