1. 接口描述
接口请求域名: ocr.tencentcloudapi.com 。
图像切边矫正增强是面向文档类图片提供的图像增强处理能力,包括切边增强、图像矫正、阴影去除、摩尔纹去除等;可以有效优化文档类的图片质量,提升文字的清晰度,可以作为所有识别场景的图像预处理原子能力,从而提升识别效果。
默认接口请求频率限制:5次/秒。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:CropEnhanceImageOCR。 |
| Version | 是 | String | 公共参数,本接口取值:2018-11-19。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| ImageBase64 | 否 | String | 图片/PDF的 Base64 值。要求Base64不超过10M,分辨率建议600*800以上,支持PNG、JPG、JPEG、BMP、PDF格式。图片的 ImageUrl、ImageBase64 必须提供一个,如果都提供,只使用 ImageUrl。 示例值:/9j/4AAQSkZJRg.....s97n//2Q== |
| ImageUrl | 否 | String | 图片/PDF的 Url 地址。要求图片经Base64编码后不超过10M,分辨率建议600*800以上,支持PNG、JPG、JPEG、BMP、PDF格式。图片下载时间不超过 3 秒。图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议图片存储于腾讯云。非腾讯云存储的 Url 速度和稳定性可能受一定影响。 示例值:https://ocr-demo-1254418846.cos.ap-guangzhou.myqcloud.com/general/GeneralAccurateOCR/GeneralAccurateOCR1.jpg |
| PdfPageNumber | 否 | Integer | 需要识别的PDF页面的对应页码,仅支持PDF单页识别,默认值为1。 示例值:1 |
| Crop | 否 | Integer | 0表示关闭切边 示例值:1 |
| Deskew | 否 | Integer | 0表示关闭弯曲矫正 示例值:1 |
| OnlyPosition | 否 | Integer | 0表示返回处理后的图和坐标,默认为0 示例值:0 |
| EnhanceType | 否 | Integer | 默认-1
示例值:-1 |
| AdjustOrientation | 否 | Integer | 0表示不矫正图像方向,默认为0 1表示矫正图像方向 示例值:0 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| CroppedWidth | Integer | 处理后图的宽 示例值:100 |
| CroppedHeight | Integer | 处理后图的高 示例值:100 |
| CroppedImage | String | 图像处理后的jpg图片,base64格式 示例值:/9j/4AAQSkZJRg.....s97n//2Q== |
| Position | Array of Integer | 切图区域的4个角点坐标, 是个长度为8的数组 (0,1) 左上角坐标 示例值:[0,1,2,3,4,5,6,7] |
| Angle | Integer | 图像角度,AdjustOrientation =1时生效, 返回值如下 -1: 失败 0、90、180、270 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 图像增强
输入示例
POST / HTTP/1.1
Host: ocr.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CropEnhanceImageOCR
<公共请求参数>
{
"ImageBase64": "/9j/4AAQSkZJRg.....s97n//2Q=="
}
输出示例
{
"Response": {
"CroppedHeight": 1128,
"CroppedImage": "/9j/4AAQSkZJRg.....s97n//2Q==",
"CroppedWidth": 756,
"Position": [
75,
285,
644,
267,
791,
1135,
38,
1135
],
"RequestId": "6d9a9d4c-f3d1-49ce-a01a-41e2ec7c09bd"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.DownLoadError | 文件下载失败。 |
| FailedOperation.EngineRecognizeTimeout | 引擎识别超时。 |
| FailedOperation.ImageDecodeFailed | 图片解码失败。 |
| InternalError | 内部错误。 |
| InvalidParameterValue.InvalidParameterValueLimit | 参数值错误。 |
| LimitExceeded.TooLargeFileError | 文件内容太大。 |