获取预置模型列表
更新时间：2024-11-08
功能介绍
本接口用于获取预置模型列表。
HTTP调用
鉴权说明
调用本文API，使用“基于安全认证AK/SK”进行签名计算鉴权，即使用安全认证中的Access Key ID 和 Secret Access Key进行鉴权，具体鉴权认证机制参考HTTP调用鉴权说明。
请求说明
- 基本信息
请求地址：https://qianfan.baidubce.com/v2/model
请求方式：POST
- Header参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Content-Type | string | 是 | 固定值：application/json |
| x-bce-date | string | 否 | 当前时间，遵循ISO8601规范，格式如2016-04-06T08:23:49Z |
| Authorization | string | 是 | 用于验证请求合法性的认证信息，更多内容请参考鉴权认证机制，签名工具可参考IAM签名工具 |
- Query参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Action | string | 是 | 方法名称，固定值DescribeSystemModelSets |
- Body参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| 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 | 修改时间 |
pageInfo说明
| 名称 | 类型 | 描述 |
|---|---|---|
| marker | string | 本次查询的起始位置 |
| maxKeys | int | 请求返回的最大数目 |
| isTruncated | bool | 是否只返回了部分数据，说明： · false：表示本次已经返回所有结果 · true：表示本次未返回所有结果 |
| nextMarker | string | 当isTruncated为true时，才返回此项，作为下次查询marker的值 |
请求示例
curl -i --location 'https://qianfan.baidubce.com/v2/model?Action=DescribeSystemModelSets' \
--header 'Authorization: bce-auth-v1/f0ee7axxxx/2023-09-19T13:42:13Z/180000/host;x-bce-date/9a8cfb8ee58a8f44xxxxxxxxxxx6d8c543' \
--header 'x-bce-date: 2023-09-19T13:37:10Z' \
--header 'Content-Type: application/json' \
--data '{
"marker":"am-n50985crhqq3"
}'响应示例
{
"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"
]
}
],
"pageInfo":{
"marker":"am-n50985crhqq3",
"maxKeys":1,
"isTruncated":false
}
}
}SDK调用
平台支持通过Python SDK、Go SDK、Java SDK 和 Node.js SDK调用本文API，SDK调用说明文档请参考获取预置模型列表。
错误码
若请求错误，服务器将返回的JSON文本包含以下参数：
| 名称 | 描述 |
|---|---|
| requestId | 请求ID |
| code | 错误码 |
| message | 错误描述信息，帮助理解和解决发生的错误 |
例如错误返回：
{
"requestId":"1bef3f87-xxxx9884f10d4",
"code":"AccessDenied",
"message":"Access denied."
}更多其他错误码，也可以查看错误码说明。