1. 接口描述
接口请求域名： ocr.tencentcloudapi.com 。
本接口支持图片内手写体文字的检测和识别，针对手写字体无规则、字迹潦草、模糊等特点进行了识别能力的增强。
默认接口请求频率限制：10次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：GeneralHandwritingOCR。 |
| Version | 是 | String | 公共参数，本接口取值：2018-11-19。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表，本接口仅支持其中的: ap-beijing, ap-guangzhou, ap-hongkong, ap-seoul, ap-shanghai 。 |
| ImageBase64 | 否 | String | 图片的 Base64 值。 支持的图片格式：PNG、JPG、JPEG，暂不支持 GIF 格式。 支持的图片大小：所下载图片经Base64编码后不超过 7M。图片下载时间不超过 3 秒。 图片的 ImageUrl、ImageBase64 必须提供一个，如果都提供，只使用 ImageUrl。 示例值：/9j/4AAQSkZJRg.....s97n//2Q== |
| ImageUrl | 否 | String | 图片的 Url 地址。 支持的图片格式：PNG、JPG、JPEG，暂不支持 GIF 格式。 支持的图片大小：所下载图片经 Base64 编码后不超过7M。图片下载时间不超过 3 秒。 图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性，建议图片存储于腾讯云。 非腾讯云存储的 Url 速度和稳定性可能受一定影响。 示例值：https://ocr-demo-1254418846.cos.ap-guangzhou.myqcloud.com/general/GeneralHandwritingOCR/GeneralHandwritingOCR1.jpg |
| Scene | 否 | String | 场景字段，默认不用填写。 可选值:only_hw 表示只输出手写体识别结果，过滤印刷体。 |
| EnableWordPolygon | 否 | Boolean | 是否开启单字的四点定位坐标输出，默认值为false。 示例值：false |
| EnableDetectText | 否 | Boolean | 文本检测开关，默认值为true。 设置为false表示直接进行单行识别，可适用于识别单行手写体签名场景。 示例值：false |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TextDetections | Array of TextGeneralHandwriting | 检测到的文本信息，具体内容请点击左侧链接。 |
| Angle | Float | 图片旋转角度（角度制），文本的水平方向为0°；顺时针为正，逆时针为负。点击查看如何纠正倾斜文本 示例值：0 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 传入场景only_hw
只输出手写体识别结果，过滤印刷体
输入示例
POST / HTTP/1.1
Host: ocr.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GeneralHandwritingOCR
<公共请求参数>
{
"ImageUrl": "https://ocr-demo-1254418846.cos.ap-guangzhou.myqcloud.com/***/fakeurl.jpg",
"Scene": "only_hw"
}输出示例
{
"Response": {
"TextDetections": [
{
"DetectedText": "六习作表达30分",
"Confidence": 99,
"Polygon": [
{
"X": 43,
"Y": 29
},
{
"X": 176,
"Y": 25
},
{
"X": 177,
"Y": 49
},
{
"X": 43,
"Y": 53
}
],
"AdvancedInfo": "{\"Parag\":{\"ParagNo\":1}}",
"WordPolygon": [
{
"LeftBottom": {
"X": 97,
"Y": 204
},
"LeftTop": {
"X": 97,
"Y": 156
},
"RightBottom": {
"X": 134,
"Y": 204
},
"RightTop": {
"X": 134,
"Y": 156
}
}
]
}
],
"Angel": 0,
"Angle": 0,
"RequestId": "b57e40af-a73c-4844-ae7e-344f06efb9e5"
}
}示例2 通用手写体识别示例代码
通用手写体识别示例
输入示例
POST / HTTP/1.1
Host: ocr.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GeneralHandwritingOCR
<公共请求参数>
{
"ImageUrl": "https://ocr-demo-1254418846.cos.ap-guangzhou.myqcloud.com/general/GeneralHandwritingOCR/GeneralHandwritingOCR1.jpg"
}输出示例
{
"Response": {
"TextDetections": [
{
"AdvancedInfo": "{\"Parag\":{\"ParagNo\":1}}",
"Confidence": 99,
"DetectedText": "飞机飞过天空天空之城",
"Polygon": [
{
"X": 99,
"Y": 154
},
{
"X": 490,
"Y": 154
},
{
"X": 490,
"Y": 207
},
{
"X": 99,
"Y": 207
}
],
"WordPolygon": []
},
{
"AdvancedInfo": "{\"Parag\":{\"ParagNo\":2}}",
"Confidence": 97,
"DetectedText": "落雨下的黄昏的我们",
"Polygon": [
{
"X": 170,
"Y": 216
},
{
"X": 471,
"Y": 227
},
{
"X": 469,
"Y": 286
},
{
"X": 168,
"Y": 275
}
],
"WordPolygon": []
},
{
"AdvancedInfo": "{\"Parag\":{\"ParagNo\":2}}",
"Confidence": 99,
"DetectedText": "此刻我在异乡的夜里",
"Polygon": [
{
"X": 130,
"Y": 289
},
{
"X": 455,
"Y": 292
},
{
"X": 455,
"Y": 351
},
{
"X": 130,
"Y": 348
}
],
"WordPolygon": []
},
{
"AdvancedInfo": "{\"Parag\":{\"ParagNo\":2}}",
"Confidence": 98,
"DetectedText": "感觉着你忽明忽暗",
"Polygon": [
{
"X": 143,
"Y": 357
},
{
"X": 454,
"Y": 349
},
{
"X": 456,
"Y": 418
},
{
"X": 145,
"Y": 425
}
],
"WordPolygon": []
}
],
"Angel": 0,
"Angle": 0,
"RequestId": "361e2ac6-ee7e-40d0-9463-5f05ecd4828e"
}
}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.ImageBlur | 图片模糊。 |
| FailedOperation.ImageDecodeFailed | 图片解码失败。 |
| FailedOperation.ImageNoText | 图片中未检测到文本。 |
| FailedOperation.ImageSizeTooLarge | 图片尺寸过大，请参考输入参数中关于图片大小限制的说明。 |
| FailedOperation.OcrFailed | OCR识别失败。 |
| FailedOperation.UnKnowError | 未知错误。 |
| FailedOperation.UnOpenError | 服务未开通。 |
| InvalidParameter.EngineImageDecodeFailed | 图片解码失败。 |
| InvalidParameterValue.InvalidParameterValueLimit | 参数值错误。 |
| LimitExceeded.TooLargeFileError | 文件内容太大。 |
| ResourceUnavailable.InArrears | 账号已欠费。 |
| ResourceUnavailable.ResourcePackageRunOut | 账号资源包耗尽。 |
| ResourcesSoldOut.ChargeStatusException | 计费状态异常。 |
