获取模型详情
更新时间:2025-05-16
功能介绍
用于获取模型详情,如模型名称、模型类型、模型来源、创建时间等。
使用说明
本文API支持通过Python SDK、Go SDK、Java SDK 和 Node.js SDK调用,调用流程请参考SDK安装及使用流程。
权限说明
调用本文API,需符合以下权限要求,权限介绍及分配,请查看角色与权限控制列表、账号创建与权限分配。需具有以下任一权限:
- 完全控制千帆大模型平台的权限:QianfanFullControlAccessPolicy
- 只读访问千帆大模型平台的权限:QianfanReadAccessPolicy
- 完全控制千帆大模型平台模型调优的权限:QianfanModelTuningFullControlAccessPolicy
- 只读访问千帆大模型平台模型调优的权限:QianfanModelTuningReadAccessPolicy
SDK调用
调用示例
1import os
2from qianfan import resources
3
4# 通过环境变量初始化认证信息
5# 使用安全认证AK/SK调用,替换下列示例中参数,安全认证Access Key替换your_iam_ak,Secret Key替换your_iam_sk,如何获取请查看https://cloud.baidu.com/doc/Reference/s/9jwvz2egb
6os.environ["QIANFAN_ACCESS_KEY"] = "your_iam_ak"
7os.environ["QIANFAN_SECRET_KEY"] = "your_iam_sk"
8
9resp = resources.console.utils.call_action(
10 # 调用本文API,该参数值为固定值,无需修改;对应API调用文档-请求结构-请求地址的后缀
11 "/v2/model",
12 # 调用本文API,该参数值为固定值,无需修改;对应API调用文档-请求参数-Query参数的Action
13 "DescribeModelSet",
14 # 请查看本文请求参数说明,根据实际使用选择参数;对应API调用文档-请求参数-Body参数
15 {
16 "modelSetName":"cl_test_hf1"
17 }
18)
19
20print(resp.body)
1package main
2import (
3 "context"
4 "fmt"
5 "os"
6 "github.com/baidubce/bce-qianfan-sdk/go/qianfan"
7)
8func main() {
9 // 使用安全认证AK/SK鉴权,通过环境变量初始化;替换下列示例中参数,安全认证Access Key替换your_iam_ak,Secret Key替换your_iam_sk
10 os.Setenv("QIANFAN_ACCESS_KEY", "your_iam_ak")
11 os.Setenv("QIANFAN_SECRET_KEY", "your_iam_sk")
12
13 ca := qianfan.NewConsoleAction()
14
15 res, err := ca.Call(context.TODO(),
16 // 调用本文API,该参数值为固定值,无需修改;对应API调用文档-请求结构-请求地址的后缀
17 "/v2/model",
18 // 调用本文API,该参数值为固定值,无需修改;对应API调用文档-请求参数-Query参数的Action
19 "DescribeModelSet",
20 // 请查看本文请求参数说明,根据实际使用选择参数;对应API调用文档-请求参数-Body参数
21 map[string]interface{}{
22 "modelSetName":"cl_test_hf1",
23 })
24 if err != nil {
25 panic(err)
26 }
27 fmt.Println(string(res.Body))
28
29}
1import com.baidubce.qianfan.Qianfan;
2import com.baidubce.qianfan.model.console.ConsoleResponse;
3import com.baidubce.qianfan.util.CollUtils;
4import com.baidubce.qianfan.util.Json;
5import java.util.Map;
6
7public class Dome {
8 public static void main(String args[]){
9 // 使用安全认证AK/SK鉴权,替换下列示例中参数,安全认证Access Key替换your_iam_ak,Secret Key替换your_iam_sk
10 Qianfan qianfan = new Qianfan("your_iam_ak", "your_iam_sk");
11
12 ConsoleResponse<Map<String, Object>> response = qianfan.console()
13 // 调用本文API,该参数值为固定值,无需修改;对应API调用文档-请求结构-请求地址的后缀
14 .route("/v2/model")
15 // 调用本文API,该参数值为固定值,无需修改;对应API调用文档-请求参数-Query参数的Action
16 .action("DescribeModelSet")
17 // 需要传入参数的场景,可以自行封装请求类,或者使用Map.of()来构建请求Body
18 // Java 8可以使用SDK提供的CollUtils.mapOf()来替代Map.of()
19 // 请查看本文请求参数说明,根据实际使用选择参数;对应API调用文档-请求参数-Body参数
20 .body(CollUtils.mapOf(
21 "modelSetName","cl_test_hf1"
22 ))
23 .execute();
24
25 System.out.println(Json.serialize(response));
26 }
27}
1import {consoleAction, setEnvVariable} from "@baiducloud/qianfan";
2
3// 使用安全认证AK/SK鉴权,通过环境变量初始化;替换下列示例中参数,安全认证Access Key替换your_iam_ak,Secret Key替换your_iam_sk
4setEnvVariable('QIANFAN_ACCESS_KEY','your_iam_ak');
5setEnvVariable('QIANFAN_SECRET_KEY','your_iam_sk');
6
7async function main() {
8 //base_api_route:调用本文API,该参数值为固定值,无需修改;对应API调用文档-请求结构-请求地址的后缀
9 //action:调用本文API,该参数值为固定值,无需修改;对应API调用文档-请求参数-Query参数的Action
10 //data:请查看本文请求参数说明,根据实际使用选择参数;对应API调用文档-请求参数-Body参数
11 const res = await consoleAction({base_api_route: '/v2/model', action: 'DescribeModelSet', data: {
12 "modelSetName":"cl_test_hf1"
13 }
14 });
15
16 console.log(res);
17}
18
19main();
返回示例
1{
2 "requestId": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
3 "result": {
4 "modelSetId": "am-upqiuctdx15t",
5 "modelSetName": "cl_test_hf1",
6 "source": "UserCreate",
7 "modelType": "Text2Text",
8 "description": "",
9 "createTime": "2024-04-10T17:16:22+08:00",
10 "modifyTime": "2024-09-15T18:10:53+08:00",
11 "modelIds": [
12 "amv-cbm3kwsw053v"
13 ],
14 "modelNames": [
15 "V1"
16 ]
17 }
18}
1{
2 "requestId": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
3 "result": {
4 "modelSetId": "am-upqiuctdx15t",
5 "modelSetName": "cl_test_hf1",
6 "source": "UserCreate",
7 "modelType": "Text2Text",
8 "description": "",
9 "createTime": "2024-04-10T17:16:22+08:00",
10 "modifyTime": "2024-09-15T18:10:53+08:00",
11 "modelIds": [
12 "amv-cbm3kwsw053v"
13 ],
14 "modelNames": [
15 "V1"
16 ]
17 }
18}
1{
2 "requestId": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
3 "result": {
4 "modelSetId": "am-upqiuctdx15t",
5 "modelSetName": "cl_test_hf1",
6 "source": "UserCreate",
7 "modelType": "Text2Text",
8 "description": "",
9 "createTime": "2024-04-10T17:16:22+08:00",
10 "modifyTime": "2024-09-15T18:10:53+08:00",
11 "modelIds": [
12 "amv-cbm3kwsw053v"
13 ],
14 "modelNames": [
15 "V1"
16 ]
17 }
18}
1{
2 "requestId": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
3 "result": {
4 "modelSetId": "am-upqiuctdx15t",
5 "modelSetName": "cl_test_hf1",
6 "source": "UserCreate",
7 "modelType": "Text2Text",
8 "description": "",
9 "createTime": "2024-04-10T17:16:22+08:00",
10 "modifyTime": "2024-09-15T18:10:53+08:00",
11 "modelIds": [
12 "amv-cbm3kwsw053v"
13 ],
14 "modelNames": [
15 "V1"
16 ]
17 }
18}
请求参数
注意:不同语言SDK的请求参数不同,请根据实际调用选择对应参数。
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
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列表 |
modelNames | List<string> | 模型拥有的模型版本号列表 |