获取模型详情
更新时间:2024-12-23
接口描述
本接口用于获取模型详情,如模型名称、模型类型、模型来源、创建时间等。
权限说明
调用本文API,需符合以下权限要求,权限介绍及分配,请查看角色与权限控制列表、账号创建与权限分配。需具有以下任一权限:
- 完全控制千帆大模型平台的权限:QianfanFullControlAccessPolicy
- 只读访问千帆大模型平台的权限:QianfanReadAccessPolicy
- 完全控制千帆大模型平台模型调优的权限:QianfanModelTuningFullControlAccessPolicy
- 只读访问千帆大模型平台模型调优的权限:QianfanModelTuningReadAccessPolicy
鉴权说明
调用本文API,使用“基于安全认证AK/SK”进行签名计算鉴权,即使用安全认证中的Access Key ID 和 Secret Access Key进行鉴权,具体鉴权认证机制参考HTTP调用鉴权说明。
请求结构
POST /v2/model?Action=DescribeModelSet HTTP/1.1
Host: qianfan.baidubce.com
Authorization: authorization string
Content-Type: application/json
{
"modelSetName":"cl_test_hf1"
}
请求头域
除公共头域外,无其它特殊头域。
请求参数
- 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 | 模型来源,说明: · 用户模型:UserCreate · 预置模型: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": "UserCreate",
"modelType": "Text2Text",
"createTime": "2023-12-15T16:30:06+08:00",
"modifyTime": "2024-01-04T16:10:45+08:00",
"description": "",
"modelIds": [
"amv-cbm3kwsw053v"
]
}
}
错误码
若请求错误,服务器将返回的JSON文本包含以下参数:
名称 | 描述 |
---|---|
requestId | 请求ID |
code | 错误码 |
message | 错误描述信息,帮助理解和解决发生的错误 |
例如错误返回:
{
"requestId":"6ba7b810-xxxxc04fd430c8",
"code":"AccessDenied",
"message":"Access denied."
}
更多其他错误码,也可以查看错误码说明。