获取预置模型列表
所有文档
menu

千帆大模型服务与开发平台ModelBuilder

获取预置模型列表

功能介绍

用于获取预置模型列表。

使用说明

本文API支持通过Python SDK、Go SDK、Java SDK 和 Node.js SDK调用,调用流程请参考SDK安装及使用流程

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    "DescribeSystemModelSets", 
14    # 请查看本文请求参数说明,根据实际使用选择参数;对应API调用文档-请求参数-Body参数
15    {
16        "marker":"am-j05zi5xxx"
17    }
18)
19
20print(resp.body)
1package main
2
3import (
4    "context"
5    "fmt"
6    "os"
7
8    "github.com/baidubce/bce-qianfan-sdk/go/qianfan"
9)
10
11func main() {
12     // 使用安全认证AK/SK鉴权,通过环境变量初始化;替换下列示例中参数,安全认证Access Key替换your_iam_ak,Secret Key替换your_iam_sk
13    os.Setenv("QIANFAN_ACCESS_KEY", "your_iam_ak")
14    os.Setenv("QIANFAN_SECRET_KEY", "your_iam_sk")
15    
16    ca := qianfan.NewConsoleAction()
17    
18    res, err := ca.Call(context.TODO(),
19    // 调用本文API,该参数值为固定值,无需修改;对应API调用文档-请求结构-请求地址的后缀
20    "/v2/model",
21    // 调用本文API,该参数值为固定值,无需修改;对应API调用文档-请求参数-Query参数的Action 
22    "DescribeSystemModelSets",
23    // 请查看本文请求参数说明,根据实际使用选择参数;对应API调用文档-请求参数-Body参数
24    map[string]interface{}{
25        "marker":"am-j05zi5xxx",
26    })
27    if err != nil {
28        panic(err)
29    }
30    fmt.Println(string(res.Body))
31    
32}
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("DescribeSystemModelSets")
17                // 需要传入参数的场景,可以自行封装请求类,或者使用Map.of()来构建请求Body
18                // Java 8可以使用SDK提供的CollUtils.mapOf()来替代Map.of()
19                // 请查看本文请求参数说明,根据实际使用选择参数;对应API调用文档-请求参数-Body参数
20                .body(CollUtils.mapOf(
21                   "marker","am-j05zi5xxx"
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: 'DescribeSystemModelSets', data: {
12        "marker":"am-j05zi5xxx"
13    }
14  });    
15    
16  console.log(res);
17}
18
19main();

返回示例

1{
2    "requestId":"1bef3f87-c5b2-4419-936b-50f9884f10d4",
3    "result": {
4        "systemModelSetList": [
5            {
6                "modelSetId": "am-j05zi5xxx",
7                "modelSetName": "bce-reranker-base",
8                "modelType": "",
9                "description": "由网易有道开发的跨语种语义表征算法模型,擅长优化语义搜索结果和语义相关顺序精排,支持中英日韩四门语言,覆盖常见业务领域,支持长package rerank(512~32k)。[了解更多\u003e](https://huggingface.co/maidalun1020/bce-reranker-base_v1)",
10                "modelCount": 1,
11                "modifyTime": "2024-03-22T17:13:33+08:00",
12                "modelIds":[
13                    "amv-4u0rw8juur1p"
14                ],
15                "modelNames": [
16                    "bce-reranker-base_v1"
17                ]
18            }
19        ],
20        "pageInfo":{
21            "marker":"am-n50985crhqq3",
22            "maxKeys":1,
23            "isTruncated":false
24        }
25    }
26}
1{
2    "requestId":"1bef3f87-c5b2-4419-936b-50f9884f10d4",
3    "result": {
4        "systemModelSetList": [
5            {
6                "modelSetId": "am-j05zi5ebfqf1",
7                "modelSetName": "bce-reranker-base",
8                "modelType": "",
9                "description": "由网易有道开发的跨语种语义表征算法模型,擅长优化语义搜索结果和语义相关顺序精排,支持中英日韩四门语言,覆盖常见业务领域,支持长package rerank(512~32k)。[了解更多\u003e](https://huggingface.co/maidalun1020/bce-reranker-base_v1)",
10                "modelCount": 1,
11                "modifyTime": "2024-03-22T17:13:33+08:00",
12                "modelIds":[
13                    "amv-4u0rw8juur1p"
14                ],
15                "modelNames": [
16                    "bce-reranker-base_v1"
17                ]
18            }
19        ],
20        "pageInfo":{
21            "marker":"am-n50985crhqq3",
22            "maxKeys":1,
23            "isTruncated":false
24        }
25    }
26}
1{
2    "requestId":"1bef3f87-c5b2-4419-936b-50f9884f10d4",
3    "result": {
4        "systemModelSetList": [
5            {
6                "modelSetId": "am-j05zi5ebfqf1",
7                "modelSetName": "bce-reranker-base",
8                "modelType": "",
9                "description": "由网易有道开发的跨语种语义表征算法模型,擅长优化语义搜索结果和语义相关顺序精排,支持中英日韩四门语言,覆盖常见业务领域,支持长package rerank(512~32k)。[了解更多\u003e](https://huggingface.co/maidalun1020/bce-reranker-base_v1)",
10                "modelCount": 1,
11                "modifyTime": "2024-03-22T17:13:33+08:00",
12                "modelIds":[
13                    "amv-4u0rw8juur1p"
14                ],
15                "modelNames": [
16                    "bce-reranker-base_v1"
17                ]
18            }
19        ],
20        "pageInfo":{
21            "marker":"am-n50985crhqq3",
22            "maxKeys":1,
23            "isTruncated":false
24        }
25    }
26}
1{
2    requestId:'1bef3f87-c5b2-4419-936b-50f9884f10d4',
3    result: {
4        systemModelSetList: [
5            {
6                modelSetId: 'am-j05zi5ebfqf1',
7                modelSetName: 'bce-reranker-base',
8                modelType: '',
9                description: '由网易有道开发的跨语种语义表征算法模型,擅长优化语义搜索结果和语义相关顺序精排,支持中英日韩四门语言,覆盖常见业务领域,支持长package rerank(512~32k)。[了解更多\u003e](https://huggingface.co/maidalun1020/bce-reranker-base_v1)‘
10                modelCount: 1,
11                modifyTime: '2024-03-22T17:13:33+08:00',
12                modelIds:[
13                    'amv-4u0rw8juur1p'
14                ],
15                modelNames: [
16                    'bce-reranker-base_v1'
17                ]
18            }
19        ],
20        pageInfo:{
21            marker:'am-n50985crhqq3',
22            maxKeys:1,
23            isTruncated:false
24        }
25    }
26}

请求参数

名称
类型
必填
描述
marker string 本次查询的起始位置,默认从第一条数据开始
maxKeys int 说明:
(1)默认值是10
(2)返回的列表长度最大为100,如果指定的值大于100,按100操作
pageReverse bool 是否倒序,默认为false

返回参数

名称
类型
描述
requestId string 请求ID
code string 错误码,接口报错时返回,HTTP状态码≥400
message string 错误信息,接口报错时返回,HTTP状态码≥400
result object 请求结果

result说明

名称
类型
描述
systemModelSetList List<object> 模型信息列表
pageInfo object 分页信息

systemModelSetList说明

名称
类型
描述
modelSetId string 模型ID
modelSetName string 模型名称
modelType string 模型类型
description string 模型描述
modelCount int 版本数量
modelIds List<string> 属于当前模型的模型版本id列表
modifyTime time 修改时间
modelNames List<string> 模型拥有的模型版本号列表

pageInfo说明

名称
类型
描述
marker string 本次查询的起始位置
maxKeys int 请求返回的最大数目
isTruncated bool 是否只返回了部分数据,说明:
· false:表示本次已经返回所有结果
· true:表示本次未返回所有结果
nextMarker string 当isTruncated为true时,才返回此项,作为下次查询marker的值
上一篇
获取模型版本打包导出任务
下一篇
获取预置模型详情