1. 接口描述
接口请求域名: tiia.tencentcloudapi.com 。
图像标签利用深度学习技术,可以对图片进行智能分类、物体识别等。
目前支持八个大类、六十多个子类、数千个标签,涵盖各种日常场景、动植物、物品、美食等。
图像标签提供四个版本供选择:
• 摄像头版:针对搜索、手机摄像头照片进行优化,涵盖大量卡证、日常物品、二维码条形码。
• 相册版:针对手机相册、网盘进行优化,去除相册和网盘中不常见的标签,针对相册常见图片类型(人像、日常活动、日常物品等)识别效果更好。
• 网络版:针对网络图片进行优化,涵盖标签更多,满足长尾识别需求。
• 新闻版:针对新闻、资讯、广电等行业进行优化,增加定制识别,支持万级图像标签。
为了方便使用、减少图片传输次数,图像标签将不同版本包装成多合一接口,实际上是多个服务,分别计费。建议在接入初期,对四个版本进行对比评估后选择合适的版本使用。
说明:
- 图像标签已升级服务,建议使用新版接口通用图像标签。
- 图像标签摄像头版、相册版、网络版、新闻版分别按照各自的实际使用次数进行收费,例如一张图片同时使用相册版、摄像头版,则按照两次调用计费。建议测试对比后从中选择一个最合适的版本使用即可。
- 可前往 图像标签 产品文档中查看更多产品信息。
- 公共参数中的签名方式必须指定为V3版本,即配置SignatureMethod参数为TC3-HMAC-SHA256。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DetectLabel。 |
Version | 是 | String | 公共参数,本接口取值:2019-05-29。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
ImageBase64 | 否 | String | 图片 Base64 编码数据。 与ImageUrl同时存在时优先使用ImageUrl字段。 图片限制: • 图片格式:PNG、JPG、JPEG、BMP。 • 图片大小:经Base64编码后不超过4M。 注意:图片需要Base64编码,并且要去掉编码头部。 |
ImageUrl | 否 | String | 图片 URL 地址。 图片限制: • 图片格式:PNG、JPG、JPEG、BMP。 • 图片大小:所下载图片经Base64编码后不超过4M。图片下载时间不超过3秒。 建议: • 图片像素:大于50*50像素,否则影响识别效果; • 长宽比:长边:短边<5; • 接口响应时间会受到图片下载时间的影响,建议使用更可靠的存储服务,推荐将图片存储在腾讯云COS。 示例值:https://test.jpg |
Scenes.N | 否 | Array of String | 本次调用支持的识别场景,可选值如下: • WEB,针对网络图片优化; • CAMERA,针对手机摄像头拍摄图片优化; • ALBUM,针对手机相册、网盘产品优化; • NEWS,针对新闻、资讯、广电等行业优化; 如果不传此参数,则默认为WEB。 支持多场景(Scenes)一起检测。例如,使用 Scenes=["WEB", "CAMERA"],即对一张图片使用两个模型同时检测,输出两套识别结果。 示例值:["WEB","CAMERA","ALBUM"] |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Labels | Array of DetectLabelItem | Web网络版标签结果数组。如未选择WEB场景,则为空。 注意:此字段可能返回 null,表示取不到有效值。 |
CameraLabels | Array of DetectLabelItem | Camera摄像头版标签结果数组。如未选择CAMERA场景,则为空。 注意:此字段可能返回 null,表示取不到有效值。 |
AlbumLabels | Array of DetectLabelItem | Album相册版标签结果数组。如未选择ALBUM场景,则为空。 注意:此字段可能返回 null,表示取不到有效值。 |
NewsLabels | Array of DetectLabelItem | News新闻版标签结果数组。如未选择NEWS场景,则为空。 新闻版目前为测试阶段,暂不提供每个标签的一级、二级分类信息的输出。 注意:此字段可能返回 null,表示取不到有效值。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 图像标签检测请求失败
输入示例
POST / HTTP/1.1
Host: tiia.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DetectLabel
<公共请求参数>
{
"ImageUrl": "https://123.jpg"
}
输出示例
{
"Response": {
"Error": {
"Code": "FailedOperation.DownLoadError",
"Message": "下载失败"
},
"RequestId": "a169390a-6ff3-4c42-ad25-a7858c35e576"
}
}
示例2 图像标签检测请求成功
输入示例
POST / HTTP/1.1
Host: tiia.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DetectLabel
<公共请求参数>
{
"ImageUrl": "https://test.jpg",
"Scenes": [
"WEB",
"CAMERA",
"ALBUM"
]
}
输出示例
{
"Response": {
"NewsLabels": [
{
"Confidence": 80,
"Name": "塔楼",
"SecondCategory": "建筑",
"FirstCategory": "场景"
}
],
"Labels": [
{
"Name": "塔楼",
"FirstCategory": "场景",
"SecondCategory": "建筑",
"Confidence": 81
},
{
"Name": "夜晚",
"FirstCategory": "场景",
"SecondCategory": "自然风光",
"Confidence": 79
},
{
"Name": "天际线",
"FirstCategory": "场景",
"SecondCategory": "自然风光",
"Confidence": 77
},
{
"Name": "城市景观",
"FirstCategory": "场景",
"SecondCategory": "其他",
"Confidence": 77
},
{
"Name": "城市",
"FirstCategory": "场景",
"SecondCategory": "生活/娱乐场所",
"Confidence": 72
},
{
"Name": "都市",
"FirstCategory": "场景",
"SecondCategory": "其他",
"Confidence": 69
}
],
"CameraLabels": [
{
"Name": "夜景",
"FirstCategory": "场景",
"SecondCategory": "自然风光",
"Confidence": 92
},
{
"Name": "城市",
"FirstCategory": "场景",
"SecondCategory": "建筑",
"Confidence": 3
},
{
"Name": "游乐园",
"FirstCategory": "场景",
"SecondCategory": "生活/娱乐场所",
"Confidence": 2
},
{
"Name": "大厦",
"FirstCategory": "场景",
"SecondCategory": "建筑",
"Confidence": 1
},
{
"Name": "桥",
"FirstCategory": "场景",
"SecondCategory": "建筑",
"Confidence": 0
}
],
"AlbumLabels": [
{
"Name": "夜景",
"FirstCategory": "场景",
"SecondCategory": "自然风光",
"Confidence": 93
},
{
"Name": "塔",
"FirstCategory": "场景",
"SecondCategory": "建筑",
"Confidence": 82
},
{
"Name": "城市",
"FirstCategory": "场景",
"SecondCategory": "建筑",
"Confidence": 5
}
],
"RequestId": "e6d685b1-d898-4dc9-a545-cfeb3a988da8"
}
}
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: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AuthFailure.InvalidAuthorization | 认证失败。 |
FailedOperation.BalanceInsufficient | 余额不足,开通失败,请充值后再开通。 |
FailedOperation.DownloadError | 文件下载错误。 |
FailedOperation.ImageDecodeFailed | 图片解码失败。 |
FailedOperation.ImageDownloadError | 图片下载错误。 |
FailedOperation.ImageNotSupported | 不支持的图片文件。 |
FailedOperation.ImageUnQualified | 图片不满足检测要求。 |
FailedOperation.InvokeChargeError | 调用计费返回失败。 |
FailedOperation.RequestTimeout | 后端服务超时。 |
FailedOperation.RpcFail | RPC请求失败,一般为算法微服务故障。 |
FailedOperation.UnKnowError | 内部错误。 |
FailedOperation.Unknown | 未知错误。 |
InvalidParameterValue.InvalidParameterValueLimit | 参数值错误。 |
LimitExceeded.TooLargeFileError | 文件太大。 |
ResourceUnavailable.InArrears | 账号已欠费。 |
ResourceUnavailable.NotExist | 计费状态未知,请确认是否已在控制台开通服务。 |
ResourcesSoldOut.ChargeStatusException | 计费状态异常。 |