1. 接口描述
接口请求域名: iss.tencentcloudapi.com 。
获取视觉理解模板列表
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:ListVLTemplates。 |
| Version | 是 | String | 公共参数,本接口取值:2023-05-17。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| Name | 否 | String | 模板名称,精确匹配 示例值:明厨亮灶识别模板 |
| AnalysisMode | 否 | String | 分析模式过滤,image / video 示例值:image |
| CaptureType | 否 | String | 截图类型过滤(仅 AnalysisMode=image 时生效):realtime / low 示例值:realtime |
| PageNumber | 否 | Integer | 页码,默认 1 示例值:1 |
| PageSize | 否 | Integer | 每页数量,默认 20,最大 200 示例值:20 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Data | Array of VLTemplateInfo | 模板列表 |
| TotalCount | Integer | 总数量 示例值:1 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 成功示例
输入示例
POST / HTTP/1.1
Host: iss.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ListVLTemplates
<公共请求参数>
{
"Name": "明厨亮灶识别模板",
"AnalysisMode": "image",
"CaptureType": "realtime",
"PageNumber": 1,
"PageSize": 20
}
输出示例
{
"Response": {
"Data": [
{
"AIModel": "IVC-G",
"AnalysisMode": "image",
"CreatedAt": "2026-07-27 15:14:28",
"Describe": "厨师帽和口罩识别",
"ImageConfig": {
"Interval": 10,
"MultiMode": null,
"Type": 1
},
"IsUsed": false,
"Name": "明厨亮灶识别模板",
"Prompt": "你是餐饮后厨着装规范检查模型,仅检查厨师帽、口罩两项。\n## 合规标准\n- 厨师帽:佩戴且完全覆盖头发(高筒帽/网帽/布帽均合规);未戴或发丝外露为不合规\n- 口罩:覆盖鼻梁至下颌(蓝/白医用口罩、透明面罩均合规);拉下巴/挂耳朵/仅遮嘴为不合规\n## 输出\n紧凑JSON,无markdown/换行/空格。\n- total_staff:int,后厨人员总数\n- hat:{\"compliant\":int,\"non_compliant\":int,\"not_wearing\":int},帽子合规/不规范/未戴人数\n- mask:{\"compliant\":int,\"non_compliant\":int,\"not_wearing\":int},口罩合规/不规范/未戴人数",
"Times": [
{
"BeginTime": "00:00:00",
"EndTime": "23:59:59",
"WeekDay": 1
}
],
"UpdatedAt": "2026-07-27 15:14:28",
"VLTemplateId": "VTa911*************************6c2"
}
],
"TotalCount": 1,
"RequestId": "75677860-9600-494e-b0d9-ba61cb74cf4d"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameterValue.InvalidCaptureType | 无效的截图类型过滤值,仅支持 realtime / low |
| InvalidParameterValue.InvalidMediaType | 无效的媒体类型 |
| InvalidParameterValue.InvalidPageNumber | 无效的PageNumber |
| InvalidParameterValue.InvalidPageSize | 无效的PageSize |