1. 接口描述
接口请求域名： ocr.tencentcloudapi.com 。
本接口支持图像英文文字的检测和识别，返回文字框位置与文字内容。支持多场景、任意版面下的英文、字母、数字和常见字符的识别，同时覆盖英文印刷体和英文手写体识别。
默认接口请求频率限制：10次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：EnglishOCR。 |
| Version | 是 | String | 公共参数，本接口取值：2018-11-19。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表，本接口仅支持其中的: ap-beijing, ap-guangzhou, ap-hongkong, ap-shanghai 。 |
| ImageBase64 | 否 | String | 图片的 Base64 值。 支持的图片格式：PNG、JPG、JPEG，暂不支持 GIF 格式。 支持的图片大小：所下载图片经Base64编码后不超过 7M。图片下载时间不超过 3 秒。像素须介于20-10000px之间。 图片的 ImageUrl、ImageBase64 必须提供一个，如果都提供，只使用 ImageUrl。 |
| ImageUrl | 否 | String | 图片的 Url 地址。 支持的图片格式：PNG、JPG、JPEG，暂不支持 GIF 格式。 支持的图片大小：所下载图片经 Base64 编码后不超过 7M。图片下载时间不超过 3 秒。像素须介于20-10000px之间。 图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性，建议图片存储于腾讯云。 非腾讯云存储的 Url 速度和稳定性可能受一定影响。 示例值：https://xx/a.jpg |
| EnableCoordPoint | 否 | Boolean | 单词四点坐标开关，开启可返回图片中单词的四点坐标。 该参数默认值为false。 示例值：false |
| EnableCandWord | 否 | Boolean | 候选字开关，开启可返回识别时多个可能的候选字（每个候选字对应其置信度）。 该参数默认值为false。 示例值：false |
| Preprocess | 否 | Boolean | 预处理开关，功能是检测图片倾斜的角度，将原本倾斜的图片矫正。该参数默认值为true。 示例值：false |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TextDetections | Array of TextDetectionEn | 检测到的文本信息，具体内容请点击左侧链接。 |
| Angel | Float | 图片旋转角度（角度制），文本的水平方向为0°；顺时针为正，逆时针为负。点击查看如何纠正倾斜文本 示例值：0 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 英文识别示例代码
英文识别示例代码
输入示例
POST / HTTP/1.1
Host: ocr.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: EnglishOCR
<公共请求参数>
{
"ImageUrl": "https://xx/a.jpg"
}输出示例
{
"Response": {
"TextDetections": [
{
"DetectedText": "No matter how long the",
"Confidence": 99,
"Polygon": [
{
"X": 228,
"Y": 244
},
{
"X": 228,
"Y": 269
},
{
"X": 562,
"Y": 270
},
{
"X": 562,
"Y": 245
}
],
"AdvancedInfo": "{}",
"WordCoordPoint": [
{
"WordCoordinate": [
{
"X": 226,
"Y": 270
},
{
"X": 226,
"Y": 241
},
{
"X": 270,
"Y": 242
},
{
"X": 270,
"Y": 271
}
]
},
{
"WordCoordinate": [
{
"X": 278,
"Y": 271
},
{
"X": 279,
"Y": 242
},
{
"X": 368,
"Y": 242
},
{
"X": 368,
"Y": 271
}
]
},
{
"WordCoordinate": [
{
"X": 378,
"Y": 271
},
{
"X": 378,
"Y": 242
},
{
"X": 437,
"Y": 242
},
{
"X": 437,
"Y": 271
}
]
},
{
"WordCoordinate": [
{
"X": 446,
"Y": 271
},
{
"X": 446,
"Y": 242
},
{
"X": 502,
"Y": 242
},
{
"X": 502,
"Y": 271
}
]
},
{
"WordCoordinate": [
{
"X": 514,
"Y": 271
},
{
"X": 514,
"Y": 242
},
{
"X": 566,
"Y": 243
},
{
"X": 566,
"Y": 272
}
]
}
],
"CandWord": [
{
"CandWords": [
{
"Confidence": 99,
"Character": "N"
},
{
"Confidence": 0,
"Character": "㊥"
}
]
},
{
"CandWords": [
{
"Confidence": 99,
"Character": "o"
},
{
"Confidence": 0,
"Character": "㊥"
}
]
},
{
"CandWords": [
{
"Confidence": 99,
"Character": "nil"
},
{
"Confidence": 0,
"Character": "㊥"
}
]
},
{
"CandWords": [
{
"Confidence": 99,
"Character": "m"
},
{
"Confidence": 0,
"Character": "㊥"
}
]
},
{
"CandWords": [
{
"Confidence": 100,
"Character": "a"
},
{
"Confidence": 0,
"Character": "㊥"
}
]
},
{
"CandWords": [
{
"Confidence": 100,
"Character": "t"
},
{
"Confidence": 0,
"Character": "㊥"
}
]
},
{
"CandWords": [
{
"Confidence": 100,
"Character": "t"
},
{
"Confidence": 0,
"Character": "㊥"
}
]
},
{
"CandWords": [
{
"Confidence": 100,
"Character": "e"
},
{
"Confidence": 0,
"Character": "㊥"
}
]
},
{
"CandWords": [
{
"Confidence": 100,
"Character": "r"
},
{
"Confidence": 0,
"Character": "㊥"
}
]
},
{
"CandWords": [
{
"Confidence": 99,
"Character": "nil"
},
{
"Confidence": 0,
"Character": "㊥"
}
]
},
{
"CandWords": [
{
"Confidence": 99,
"Character": "h"
},
{
"Confidence": 0,
"Character": "㊥"
}
]
},
{
"CandWords": [
{
"Confidence": 100,
"Character": "o"
},
{
"Confidence": 0,
"Character": "㊥"
}
]
},
{
"CandWords": [
{
"Confidence": 99,
"Character": "w"
},
{
"Confidence": 0,
"Character": "㊥"
}
]
},
{
"CandWords": [
{
"Confidence": 99,
"Character": "nil"
},
{
"Confidence": 0,
"Character": "㊥"
}
]
},
{
"CandWords": [
{
"Confidence": 99,
"Character": "l"
},
{
"Confidence": 0,
"Character": "㊥"
}
]
},
{
"CandWords": [
{
"Confidence": 99,
"Character": "o"
},
{
"Confidence": 0,
"Character": "㊥"
}
]
},
{
"CandWords": [
{
"Confidence": 100,
"Character": "n"
},
{
"Confidence": 0,
"Character": "㊥"
}
]
},
{
"CandWords": [
{
"Confidence": 100,
"Character": "g"
},
{
"Confidence": 0,
"Character": "㊥"
}
]
},
{
"CandWords": [
{
"Confidence": 99,
"Character": "nil"
},
{
"Confidence": 0,
"Character": "㊥"
}
]
},
{
"CandWords": [
{
"Confidence": 99,
"Character": "t"
},
{
"Confidence": 0,
"Character": "㊥"
}
]
},
{
"CandWords": [
{
"Confidence": 100,
"Character": "h"
},
{
"Confidence": 0,
"Character": "㊥"
}
]
},
{
"CandWords": [
{
"Confidence": 100,
"Character": "e"
},
{
"Confidence": 0,
"Character": "㊥"
}
]
}
],
"Words": [
{
"Confidence": 99,
"Character": "No"
},
{
"Confidence": 99,
"Character": "matter"
},
{
"Confidence": 99,
"Character": "how"
},
{
"Confidence": 99,
"Character": "long"
},
{
"Confidence": 99,
"Character": "the"
}
]
},
{
"DetectedText": "night, the day will come.",
"Confidence": 99,
"Polygon": [
{
"X": 226,
"Y": 303
},
{
"X": 226,
"Y": 331
},
{
"X": 569,
"Y": 331
},
{
"X": 569,
"Y": 303
}
],
"AdvancedInfo": "{}",
"WordCoordPoint": [
{
"WordCoordinate": [
{
"X": 224,
"Y": 333
},
{
"X": 224,
"Y": 301
},
{
"X": 297,
"Y": 301
},
{
"X": 297,
"Y": 333
}
]
},
{
"WordCoordinate": [
{
"X": 298,
"Y": 333
},
{
"X": 298,
"Y": 301
},
{
"X": 305,
"Y": 301
},
{
"X": 305,
"Y": 333
}
]
},
{
"WordCoordinate": [
{
"X": 316,
"Y": 333
},
{
"X": 316,
"Y": 301
},
{
"X": 352,
"Y": 301
},
{
"X": 352,
"Y": 333
}
]
},
{
"WordCoordinate": [
{
"X": 365,
"Y": 333
},
{
"X": 365,
"Y": 301
},
{
"X": 423,
"Y": 300
},
{
"X": 423,
"Y": 333
}
]
},
{
"WordCoordinate": [
{
"X": 432,
"Y": 333
},
{
"X": 432,
"Y": 300
},
{
"X": 474,
"Y": 300
},
{
"X": 474,
"Y": 332
}
]
},
{
"WordCoordinate": [
{
"X": 483,
"Y": 332
},
{
"X": 483,
"Y": 300
},
{
"X": 565,
"Y": 300
},
{
"X": 565,
"Y": 332
}
]
},
{
"WordCoordinate": [
{
"X": 567,
"Y": 332
},
{
"X": 567,
"Y": 300
},
{
"X": 591,
"Y": 300
},
{
"X": 591,
"Y": 332
}
]
}
],
"CandWord": [
{
"CandWords": [
{
"Confidence": 99,
"Character": "n"
},
{
"Confidence": 0,
"Character": "㊥"
}
]
},
{
"CandWords": [
{
"Confidence": 100,
"Character": "i"
},
{
"Confidence": 0,
"Character": "㊥"
}
]
},
{
"CandWords": [
{
"Confidence": 100,
"Character": "g"
},
{
"Confidence": 0,
"Character": "㊥"
}
]
},
{
"CandWords": [
{
"Confidence": 100,
"Character": "h"
},
{
"Confidence": 0,
"Character": "㊥"
}
]
},
{
"CandWords": [
{
"Confidence": 100,
"Character": "t"
},
{
"Confidence": 0,
"Character": "㊥"
}
]
},
{
"CandWords": [
{
"Confidence": 99,
"Character": ","
},
{
"Confidence": 0,
"Character": "㊥"
}
]
},
{
"CandWords": [
{
"Confidence": 99,
"Character": "nil"
},
{
"Confidence": 0,
"Character": "㊥"
}
]
},
{
"CandWords": [
{
"Confidence": 99,
"Character": "t"
},
{
"Confidence": 0,
"Character": "㊥"
}
]
},
{
"CandWords": [
{
"Confidence": 100,
"Character": "h"
},
{
"Confidence": 0,
"Character": "㊥"
}
]
},
{
"CandWords": [
{
"Confidence": 100,
"Character": "e"
},
{
"Confidence": 0,
"Character": "㊥"
}
]
},
{
"CandWords": [
{
"Confidence": 99,
"Character": "nil"
},
{
"Confidence": 0,
"Character": "㊥"
}
]
},
{
"CandWords": [
{
"Confidence": 99,
"Character": "d"
},
{
"Confidence": 0,
"Character": "㊥"
}
]
},
{
"CandWords": [
{
"Confidence": 100,
"Character": "a"
},
{
"Confidence": 0,
"Character": "㊥"
}
]
},
{
"CandWords": [
{
"Confidence": 100,
"Character": "y"
},
{
"Confidence": 0,
"Character": "㊥"
}
]
},
{
"CandWords": [
{
"Confidence": 99,
"Character": "nil"
},
{
"Confidence": 0,
"Character": "㊥"
}
]
},
{
"CandWords": [
{
"Confidence": 99,
"Character": "w"
},
{
"Confidence": 0,
"Character": "㊥"
}
]
},
{
"CandWords": [
{
"Confidence": 100,
"Character": "i"
},
{
"Confidence": 0,
"Character": "㊥"
}
]
},
{
"CandWords": [
{
"Confidence": 100,
"Character": "l"
},
{
"Confidence": 0,
"Character": "㊥"
}
]
},
{
"CandWords": [
{
"Confidence": 99,
"Character": "l"
},
{
"Confidence": 0,
"Character": "㊥"
}
]
},
{
"CandWords": [
{
"Confidence": 99,
"Character": "nil"
},
{
"Confidence": 0,
"Character": "㊥"
}
]
},
{
"CandWords": [
{
"Confidence": 99,
"Character": "c"
},
{
"Confidence": 0,
"Character": "㊥"
}
]
},
{
"CandWords": [
{
"Confidence": 99,
"Character": "o"
},
{
"Confidence": 0,
"Character": "㊥"
}
]
},
{
"CandWords": [
{
"Confidence": 100,
"Character": "m"
},
{
"Confidence": 0,
"Character": "㊥"
}
]
},
{
"CandWords": [
{
"Confidence": 100,
"Character": "e"
},
{
"Confidence": 0,
"Character": "㊥"
}
]
},
{
"CandWords": [
{
"Confidence": 99,
"Character": "."
},
{
"Confidence": 0,
"Character": "㊥"
}
]
}
],
"Words": [
{
"Confidence": 99,
"Character": "night"
},
{
"Confidence": 99,
"Character": ","
},
{
"Confidence": 99,
"Character": "the"
},
{
"Confidence": 99,
"Character": "day"
},
{
"Confidence": 99,
"Character": "will"
},
{
"Confidence": 99,
"Character": "come"
},
{
"Confidence": 99,
"Character": "."
}
]
}
],
"Angel": 0,
"RequestId": "f2b87b6d-37c4-402f-b8b0-a74686f8f838"
}
}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.ImageDecodeFailed | 图片解码失败。 |
| FailedOperation.ImageNoText | 图片中未检测到文本。 |
| FailedOperation.LanguageNotSupport | 输入的Language不支持。 |
| FailedOperation.OcrFailed | OCR识别失败。 |
| FailedOperation.UnKnowError | 未知错误。 |
| FailedOperation.UnOpenError | 服务未开通。 |
| InvalidParameterValue.InvalidParameterValueLimit | 参数值错误。 |
| LimitExceeded.TooLargeFileError | 文件内容太大。 |
| ResourceUnavailable.InArrears | 账号已欠费。 |
| ResourceUnavailable.ResourcePackageRunOut | 账号资源包耗尽。 |
| ResourcesSoldOut.ChargeStatusException | 计费状态异常。 |
