获取预置模型列表

更新时间：2024-09-23

注意：

为提升开发者使用体验，推荐使用模型管理V2版本接口，功能更全面、且接口更规范，详见模型管理API列表。
模型管理V1版本接口功能不再升级，本文档于2024年8月5日下线；由于V1版本接口后续可能下线停止服务，为避免影响使用，建议接入模型管理V2版本接口。

功能介绍

本接口用于查看预置模型列表。

SDK调用

使用说明

调用本文API，需使用安全认证AK/SK鉴权，调用流程及鉴权介绍详见SDK安装及使用流程。

调用示例

Python

import os
from qianfan.resources import Model

# 使用安全认证AK/SK鉴权，通过环境变量方式初始化；替换下列示例中参数，安全认证Access Key替换your_iam_ak，Secret Key替换your_iam_sk
os.environ["QIANFAN_ACCESS_KEY"] = "your_iam_ak"
os.environ["QIANFAN_SECRET_KEY"] = "your_iam_sk"

# 获取model_type为1或4的预置模型
preset_list = Model.preset_list(model_type=[1, 4]) 
print(preset_list)
# print(preset_list['body'])

返回示例

Python

QfResponse(code=200,
           headers={...},
           body={
                'log_id': '2655149559',
                'result': {
                    'total': 6,
                    'items': [{
                        'modelId': 74xx,
                        'modelIdStr': 'am-yrerxxgqp',
                        'modelName': 'Stable-Diffusion-XL',
                        'modelType': 1,
                        'description': '业内知名的跨模态大模型，由Stability AI研发并开源，有着业内领先的图像生成能力。[了解更多>](https://huggingface.co/stabilityai/stable-diffusion-xl-base-1.0)',
                        'versionCount': 1,
                        'modifyTime': '2023-10-25T14:37:35+08:00',
                        'isStarModel': True,
                        'isNewest': False,
                        'modelAdvantage': None,
                        'versionSummaries': [{
                            'versionId': 91xx,
                            'versionIdStr': 'amv-2kzxxx2skv5',
                            'version': 'stable-diffusion-xl-base-1.0',
                            'algorithm': 'opensource-stablediffusion_VXL',
                            'framework': 'Pytorch',
                            'apiDocLink': 'https://cloud.baidu.com/doc/WENXINWORKSHOP/s/Klkqubb9w',
                            'presetService': 'Stable-Diffusion-XL',
                            'supportOptions': ['Deploy', 'APIDoc', 'OnlineTest', 'FineTuning']
                        }]
                    }, {
                        'modelId': 10xx,
                        'modelIdStr': 'am-h88xymzi1stn',
                        'modelName': 'Embedding-V1',
                        'modelType': 4,
                        'description': 'Embedding-V1是基于百度文心大模型技术的文本表示模型，将文本转化为用数值表示的向量形式，用于文本检索、信息推荐、知识挖掘等场景。',
                        'versionCount': 1,
                        'modifyTime': '2023-12-07T14:29:24+08:00',
                        'isStarModel': False,
                        'isNewest': False,
                        'modelAdvantage': None,
                        'versionSummaries': [{
                            'versionId': 12xx,
                            'versionIdStr': 'amv-j01xxxrcjk',
                            'version': 'Embedding-V1',
                            'algorithm': '',
                            'framework': '',
                            'apiDocLink': 'https://cloud.baidu.com/doc/WENXINWORKSHOP/s/alj562vvu',
                            'presetService': '',
                            'supportOptions': ['APIDoc']
                        }]
                    }, {
                        'modelId': 10xx,
                        'modelIdStr': 'am-wj0kfgnimhkd',
                        'modelName': 'bge-large-zh',
                        'modelType': 4,
                        'description': '由智源研究院研发的中文版文本表示模型，可将任意文本映射为低维稠密向量，以用于检索、分类、聚类或语义匹配等任务，并可支持为大模型调用外部知识。',
                        'versionCount': 1,
                        'modifyTime': '2023-12-07T14:29:24+08:00',
                        'isStarModel': False,
                        'isNewest': False,
                        'modelAdvantage': None,
                        'versionSummaries': [{
                            'versionId': 12xx,
                            'versionIdStr': 'amv-4m66kmsvm20c',
                            'version': 'bge-large-zh',
                            'algorithm': '',
                            'framework': '',
                            'apiDocLink': 'https://cloud.baidu.com/doc/WENXINWORKSHOP/s/dllz04sro',
                            'presetService': '',
                            'supportOptions': ['APIDoc']
                        }]
                    }, {
                        'modelId': 10xx,
                        'modelIdStr': 'am-fyasjmxz1ic1',
                        'modelName': 'bge-large-en',
                        'modelType': 4,
                        'description': '由智源研究院研发的英文版文本表示模型，可将任意文本映射为低维稠密向量，以用于检索、分类、聚类或语义匹配等任务，并可支持为大模型调用外部知识。',
                        'versionCount': 1,
                        'modifyTime': '2023-12-07T14:29:24+08:00',
                        'isStarModel': False,
                        'isNewest': False,
                        'modelAdvantage': None,
                        'versionSummaries': [{
                            'versionId': 12xx,
                            'versionIdStr': 'amv-4qa35hunckcy',
                            'version': 'bge-large-en',
                            'algorithm': '',
                            'framework': '',
                            'apiDocLink': 'https://cloud.baidu.com/doc/WENXINWORKSHOP/s/mllz05nzk',
                            'presetService': '',
                            'supportOptions': ['APIDoc']
                        }]
                    }, {
                        'modelId': 10xx,
                        'modelIdStr': 'am-w3s7hr5qrdyq',
                        'modelName': 'tao-8k',
                        'modelType': 4,
                        'description': 'tao-8k是由Huggingface开发者amu研发并开源的长文本向量表示模型，支持8k上下文长度，模型效果在C-MTEB上居前列，是当前最优的中文长文本embeddings模型之一。 [了解更多>](https://huggingface.co/amu/tao-8k)',
                        'versionCount': 1,
                        'modifyTime': '2023-12-21T17:24:07+08:00',
                        'isStarModel': False,
                        'isNewest': False,
                        'modelAdvantage': None,
                        'versionSummaries': [{
                            'versionId': 13xx,
                            'versionIdStr': 'amv-0zqept90hnyy',
                            'version': 'tao-8k',
                            'algorithm': 'Pytorch',
                            'framework': '',
                            'apiDocLink': 'https://cloud.baidu.com/doc/WENXINWORKSHOP/s/7lq0buxys',
                            'presetService': '',
                            'supportOptions': ['APIDoc']
                        }]
                    }, {
                        'modelId': 11xx,
                        'modelIdStr': 'am-3f69umkzjy9q',
                        'modelName': '文心一格',
                        'modelType': 1,
                        'description': '百度自主研发的跨模态图像生成大模型，创新知识增强的混合专家建模，是全球首个知识增强的AI作画大模型，在语义控制、图像细节、中文理解等方面优势显著，已作为基础模型应用在[文心一格](https://yige.baidu.com)等相关业务上。',
                        'versionCount': 1,
                        'modifyTime': '2024-01-11T11:25:38+08:00',
                        'isStarModel': True,
                        'isNewest': False,
                        'modelAdvantage': None,
                        'versionSummaries': [{
                            'versionId': 14xx,
                            'versionIdStr': 'amv-4z0i46ahky2g',
                            'version': '文心一格',
                            'algorithm': 'WENXIN-YIGE',
                            'framework': 'paddle',
                            'apiDocLink': 'https://cloud.baidu.com/doc/WENXINWORKSHOP/s/clqx8tbl0',
                            'presetService': '',
                            'supportOptions': ['APIDoc', 'FineTuning']
                        }]
                    }]
                }     
})

请求参数

名称	类型	必填	描述
name_filter	string	否	名称过滤器
model_type	int[]	否	模型类型，可选值如下： · 0：文本生成 · 1：图像生成 · 4：向量表示模型 · 5：图像理解模型 · 6：行业大模型
language_support	string[]	否	语言支持，可选值如下： · 中文 · 英文 · 小语种
model_version_vendor	string[]	否	模型版本厂商，通过以下方法获取该字段值：在控制台-模型广场页面，查看厂商，例如百度，如下图所示：
ctx_length	string[]	否	上下文长度，可选值如下： · <4k · 4k-16k · >16k
expansion	string[]	否	模型扩展能力，通过以下方法获取该字段值：在控制台-模型广场页面，查看模型扩展能力，例如人设增强，如下图所示：
order_by	string	否	排序，可选值： · modifyTime：按更新时间(新-旧) · modelName：按模型名称(A-Z) · default：综合排序
page_no	int	是	页码，最小值为1
page_size	int	是	每页大小，必须大于0

返回参数

名称	类型	描述
log_id	int	请求ID
result	dict	请求结果

result 说明

名称	类型	描述
total	int	数据条数
items	dict[]	分页数据

items 说明

名称	类型	描述
modelId	int	模型数字ID，注意：该字段后续可能废弃，如需使用模型ID，请使用modelIdStr
modelIdStr	string	模型字符串ID
modelName	string	模型名称
modelType	int	模型类型
description	string	描述
versionCount	int	版本数量
modifyTime	time	最后修改时间
isStarModel	bool	是否为星标模型
isNewest	bool	是否为最新的
versionSummaries	PresetAIModelVersionItem[]	模型版本列表

PresetAIModelVersionItem 说明

名称	类型	描述
versionId	int	版本ID，int类型
versionIdStr	string	版本ID，string类型
version	string	版本
algorithm	string	算法
framework	string	框架
apiDocLink	string	模型版本API文档链接
presetService	string	预置模型版本对应的预置服务名称
supportOptions	string[]	支持的操作选项，说明： · Deploy：部署 · Evaluation：评估 · Acceleration：加速 · APIDoc：文档跳转 · OnlineTest：在线测试 · Export：模型导出 · FineTuning：模型微调

HTTP调用

鉴权说明

调用本文API，使用“基于安全认证AK/SK”进行签名计算鉴权，即使用安全认证中的Access Key ID 和 Secret Access Key进行鉴权，具体鉴权认证机制参考HTTP调用鉴权说明。

请求说明

基本信息

请求地址： https://qianfan.baidubce.com/wenxinworkshop/modelrepo/model/preset/list

请求方式： POST

Header参数

名称	类型	必填	描述
Content-Type	string	是	固定值：application/json
x-bce-date	string	否	当前时间，遵循ISO8601规范，格式如2016-04-06T08:23:49Z
Authorization	string	是	用于验证请求合法性的认证信息，更多内容请参考鉴权认证机制，签名工具可参考IAM签名工具

Body参数

名称	类型	必填	描述
nameFilter	string	否	名称过滤器
modelType	int[]	否	模型类型，可选值如下： · 0：文本生成 · 1：图像生成 · 4：向量表示模型 · 5：图像理解模型 · 6：行业大模型
languageSupport	string[]	否	语言支持，可选值如下： · 中文 · 英文 · 小语种
modelVersionVendor	string[]	否	模型版本厂商，通过以下方法获取该字段值：在控制台-模型广场页面，查看厂商，例如百度，如下图所示：
ctxLength	string[]	否	上下文长度，可选值如下： · <4k · 4k-16k · >16k
expansion	string[]	否	模型扩展能力，通过以下方法获取该字段值：在控制台-模型广场页面，查看模型扩展能力，例如人设增强，如下图所示：
orderBy	string	否	排序，可选值： · modifyTime：按更新时间(新-旧) · modelName：按模型名称(A-Z) · default：综合排序
pageNo	int	是	页码，最小值为1
pageSize	int	是	每页大小，必须大于0

响应说明

名称	类型	描述
log_id	int	请求ID
result	object	请求结果