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