1. 接口描述
接口请求域名: hai.tencentcloudapi.com 。
本接口(DescribeModels)用于查询模型
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeModels。 |
| Version | 是 | String | 公共参数,本接口取值:2023-08-12。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| ModelIds.N | 否 | Array of String | 模型id 示例值:["mdl-k8vm3q7f"] |
| Filters.N | 否 | Array of Filter | 过滤器。Name的可选值有scene-id |
| Offset | 否 | Integer | 偏移量,不得小于0,默认为0 示例值:0 |
| Limit | 否 | Integer | 返回量,不得大于100,默认为20 示例值:20 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 模型总数 示例值:20 |
| ModelSet | Array of ModelDetail | 分页返回的模型列表 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 DescribeModels
输入示例
POST / HTTP/1.1
Host: hai.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeModels
<公共请求参数>
{
"ModelIds": [
"mdl-x39pcr9u"
]
}
输出示例
{
"Response": {
"ModelSet": [
{
"CommunityUrl": "https://cloud.tencent.com/developer/article/2496039",
"ConfigEnvironment": "CentOS 5.4 64位; nvidia 535.216.01| cuda12.2 | LLM",
"Description": "模型进行了一个小版本升级,当前版本为 DeepSeek-R1-0528。在最新更新中,DeepSeek R1 通过利用更多的计算资源并在后训练过程中引入算法优化机制,显著提高了其推理和推断能力的深度。该模型在各种基准测试中表现出色,包括数学、编程和一般逻辑方面。其整体性能现已接近领先模型,如 O3 和 Gemini 2.5 Pro。",
"GuideUrl": "https://cloud.tencent.com/developer/article/2498480",
"ModelId": "mdl-x39pcr9u",
"ModelName": "deepseek R1",
"ModelState": "ONLINE",
"Tags": [
"大语言模型",
"文本生成",
"NVDIA",
"深度求索",
"600B以上"
]
}
],
"RequestId": "c6d968d0-9082-44c5-bf39-8726c900d6ea",
"TotalCount": 1
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter.AtMostOne | 两个指定的入参每次只能使用其中一个 |
| InvalidParameterValue.Duplicated | 列表入参中存在重复值 |
| InvalidParameterValue.InvalidModelIdMalformed | 指定的模型ID格式错误。请确保在请求中提供完整的模型ID,格式为mdl-xxxxxxxx。字母x代表小写字母或数字。 |