获取预置模型列表

更新时间：2025-01-20

功能介绍

用于获取预置模型列表。

使用说明

本文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，该参数值为固定值，无需修改；对应API调用文档-请求结构-请求地址的后缀
    "/v2/model", 
    # 调用本文API，该参数值为固定值，无需修改；对应API调用文档-请求参数-Query参数的Action 
    "DescribeSystemModelSets", 
    # 请查看本文请求参数说明，根据实际使用选择参数；对应API调用文档-请求参数-Body参数
    {
        "marker":"am-j05zi5xxx"
    }
)

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，该参数值为固定值，无需修改；对应API调用文档-请求结构-请求地址的后缀
    "/v2/model",
    // 调用本文API，该参数值为固定值，无需修改；对应API调用文档-请求参数-Query参数的Action 
    "DescribeSystemModelSets",
    // 请查看本文请求参数说明，根据实际使用选择参数；对应API调用文档-请求参数-Body参数
    map[string]interface{}{
        "marker":"am-j05zi5xxx",
    })
    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，该参数值为固定值，无需修改；对应API调用文档-请求结构-请求地址的后缀
                .route("/v2/model")
                // 调用本文API，该参数值为固定值，无需修改；对应API调用文档-请求参数-Query参数的Action 
                .action("DescribeSystemModelSets")
                // 需要传入参数的场景，可以自行封装请求类，或者使用Map.of()来构建请求Body
                // Java 8可以使用SDK提供的CollUtils.mapOf()来替代Map.of()
                // 请查看本文请求参数说明，根据实际使用选择参数；对应API调用文档-请求参数-Body参数
                .body(CollUtils.mapOf(
                   "marker","am-j05zi5xxx"
                ))
                .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，该参数值为固定值，无需修改；对应API调用文档-请求结构-请求地址的后缀
  //action:调用本文API，该参数值为固定值，无需修改；对应API调用文档-请求参数-Query参数的Action 
  //data:请查看本文请求参数说明，根据实际使用选择参数；对应API调用文档-请求参数-Body参数
  const res = await consoleAction({base_api_route: '/v2/model', action: 'DescribeSystemModelSets', data: {
        "marker":"am-j05zi5xxx"
    }
  });    
    
  console.log(res);
}

main();

返回示例

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

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

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

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

请求参数

名称	类型	必填	描述
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(systemModelSetItem)]	模型信息列表
pageInfo	object	分页信息

systemModelSetItem说明

名称	类型	描述
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的值

获取模型版本打包导出任务

获取预置模型详情