1. 接口描述
接口请求域名： ocr.tencentcloudapi.com 。
本接口支持广告商品图片内文字的检测和识别，返回文本框位置与文字内容。
产品优势：针对广告商品图片普遍存在较多繁体字、艺术字的特点，进行了识别能力的增强。支持中英文、横排、竖排以及倾斜场景文字识别。文字识别的召回率和准确率能达到96%以上。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：AdvertiseOCR。 |
| Version | 是 | String | 公共参数，本接口取值：2018-11-19。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表，本接口仅支持其中的: ap-beijing, ap-guangzhou, ap-hongkong, ap-shanghai, na-toronto 。 |
| ImageBase64 | 否 | String | 图片的 Base64 值。 要求图片经Base64编码后不超过 7M，分辨率建议600*800以上，支持PNG、JPG、JPEG、BMP格式。 图片的 ImageUrl、ImageBase64 必须提供一个，如果都提供，只使用 ImageUrl。 |
| ImageUrl | 否 | String | 图片的 Url 地址。 要求图片经Base64编码后不超过 7M，分辨率建议600*800以上，支持PNG、JPG、JPEG、BMP格式。 图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性，建议图片存储于腾讯云。非腾讯云存储的 Url 速度和稳定性可能受一定影响。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TextDetections | Array of AdvertiseTextDetection | 检测到的文本信息，包括文本行内容、置信度、文本行坐标以及文本行旋转纠正后的坐标，具体内容请点击左侧链接。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 通用印刷体识别示例代码 前往调试工具
输入示例
https://ocr.tencentcloudapi.com/?Action=AdvertiseOCR
&ImageUrl=https://xx/a.jpg
&<公共请求参数>输出示例
{
"Response": {
"TextDetections": [
{
"DetectedText": "Confetteria",
"Confidence": 99,
"Polygon": [
{
"X": 450,
"Y": 211
},
{
"X": 560,
"Y": 223
},
{
"X": 558,
"Y": 244
},
{
"X": 448,
"Y": 232
}
],
"AdvancedInfo": "{\"Parag\":{\"ParagNo\":1}}"
},
{
"DetectedText": "Raffaello",
"Confidence": 99,
"Polygon": [
{
"X": 370,
"Y": 233
},
{
"X": 649,
"Y": 265
},
{
"X": 642,
"Y": 331
},
{
"X": 362,
"Y": 299
}
],
"AdvancedInfo": "{\"Parag\":{\"ParagNo\":2}}"
},
{
"DetectedText": "费列罗臻点坊",
"Confidence": 99,
"Polygon": [
{
"X": 402,
"Y": 318
},
{
"X": 587,
"Y": 339
},
{
"X": 584,
"Y": 370
},
{
"X": 398,
"Y": 349
}
],
"AdvancedInfo": "{\"Parag\":{\"ParagNo\":3}}"
},
{
"DetectedText": "拉斐尔脆雪柔",
"Confidence": 99,
"Polygon": [
{
"X": 386,
"Y": 366
},
{
"X": 591,
"Y": 390
},
{
"X": 587,
"Y": 423
},
{
"X": 382,
"Y": 399
}
],
"AdvancedInfo": "{\"Parag\":{\"ParagNo\":3}}"
}
],
"RequestId": "03e66873-5209-4d26-abee-c4acd66fab91"
}
}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.DownLoadError | 文件下载失败。 |
| FailedOperation.EmptyImageError | 图片内容为空。 |
| FailedOperation.EngineRecognizeTimeout | 引擎识别超时。 |
| FailedOperation.ImageDecodeFailed | 图片解码失败。 |
| FailedOperation.ImageNoText | 图片中未检测到文本。 |
| FailedOperation.LanguageNotSupport | 输入的Language不支持。 |
| FailedOperation.OcrFailed | OCR识别失败。 |
| FailedOperation.UnKnowError | 未知错误。 |
| FailedOperation.UnOpenError | 服务未开通。 |
| InvalidParameterValue.InvalidParameterValueLimit | 参数值错误。 |
| LimitExceeded.TooLargeFileError | 文件内容太大。 |
| ResourceUnavailable.InArrears | 帐号已欠费。 |
| ResourceUnavailable.ResourcePackageRunOut | 账号资源包耗尽。 |
| ResourcesSoldOut.ChargeStatusException | 计费状态异常。 |