1. 接口描述
接口请求域名: tiia.tencentcloudapi.com 。
本接口支持识别图片中包含的商品,能够输出商品的品类名称、类别,还可以输出商品在图片中的位置。支持一张图片多个商品的识别。
说明:
- 公共参数中的签名方式必须指定为V3版本,即配置SignatureMethod参数为TC3-HMAC-SHA256。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DetectProduct。 |
Version | 是 | String | 公共参数,本接口取值:2019-05-29。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
ImageUrl | 否 | String | 图片URL地址。 图片限制: • 图片格式:PNG、JPG、JPEG。 • 图片大小:所下载图片经Base64编码后不超过4M。图片下载时间不超过3秒。 建议: • 图片像素:大于50*50像素,否则影响识别效果; • 长宽比:长边:短边<5; 接口响应时间会受到图片下载时间的影响,建议使用更可靠的存储服务,推荐将图片存储在腾讯云COS。 示例值:xxxxx |
ImageBase64 | 否 | String | 图片经过base64编码的内容。最大不超过4M。与ImageUrl同时存在时优先使用ImageUrl字段。 注意:图片需要base64编码,并且要去掉编码头部。 示例值:xxxxx |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Products | Array of Product | 商品识别结果数组 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 商品识别检测请求成功
输入示例
POST / HTTP/1.1
Host: tiia.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DetectProduct
<公共请求参数>
{
"ImageUrl": "http://a.vpimg2.com/upload/merchandise/41498/CABBEEN-3030701301-1.jpg"
}
输出示例
{
"Response": {
"Products": [
{
"Name": "男士西服套装",
"Parents": "服饰内衣-男装",
"Confidence": 59,
"XMin": 336,
"YMin": 191,
"XMax": 799,
"YMax": 775
},
{
"Name": "休闲鞋",
"Parents": "鞋靴-时尚女鞋",
"Confidence": 40,
"XMin": 466,
"YMin": 1209,
"XMax": 695,
"YMax": 1377
}
],
"RequestId": "2bd4243f-4d26-4246-a5f4-0f2dbc730d62"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.BalanceInsufficient | 余额不足,开通失败,请充值后再开通。 |
FailedOperation.DownloadError | 文件下载错误。 |
FailedOperation.ImageDecodeFailed | 图片解码失败。 |
FailedOperation.ImageNotSupported | 不支持的图片文件。 |
FailedOperation.InvokeChargeError | 调用计费返回失败。 |
FailedOperation.RequestTimeout | 后端服务超时。 |
FailedOperation.RpcFail | RPC请求失败,一般为算法微服务故障。 |
FailedOperation.TooLargeFileError | 文件太大。 |
FailedOperation.UnKnowError | 内部错误。 |
FailedOperation.UnOpenError | 服务未开通。 |
InvalidParameter.InvalidParameter | 参数取值错误。 |
InvalidParameterValue.InvalidParameterValueLimit | 参数值错误。 |
LimitExceeded.TooLargeFileError | 文件太大。 |
ResourceUnavailable.InArrears | 账号已欠费。 |
ResourceUnavailable.NotExist | 计费状态未知,请确认是否已在控制台开通服务。 |
ResourcesSoldOut.ChargeStatusException | 计费状态异常。 |