接口简介

多语种OCR服务，除了可以提供中英文字识别能力以外，还支持日语、法语、德语、俄语等50+语言的文字识别，可通过参数设置识别模式。

限制条件

名称

内容

输入要求

1. 文件格式：支持JPG、JPEG、PNG、BMP、PDF等常见格式，建议使用JPG格式。

2. 图片像素尺寸：最小 256 x 256 像素，最大 2048 x 2048 像素。为了保证文字识别效果，推荐图片最短边长不低于256像素。

3. 文件大小：

a.要求Base64编码和urlencode之后不超过 8 MB。文字主体尽量占据图片主要区域，不支持黑白图片。

b.如果传图片及PDF完整URL，URL对应文件大小建议不要超过8MB。

4. 输入文件过大时，返回的HttpCode如下：400/413/502。

5. 注意图片质量：保证图片足够清晰，不应该有因为压缩导致的噪声。

6. 图片需要有版权，有肖像权，没有法律或者政策风险的。相关风险请注意评估。

7. 输入多页PDF时，默认只识别第一页。

请求说明

基本信息

名称	内容
接口地址	https://visual.volcengineapi.com
请求方式	POST
Content-Type	application/x-www-form-urlencoded
是否需要鉴权	是

请求参数

以下请求参数列表仅列出了接口请求参数和必要公共参数，完整公共参数列表见公共参数。

名称	类型	是否必填	描述
X-Date	String	是	使用UTC时间，精确到秒。请使用格式：YYYYMMDD'T'HHMMSS'Z' ，例如：20201103T104027Z
Authorization	String	是	HMAC-SHA256：签名方法 -Credential为签名凭证，其中: -AccessKeyId为访问密钥ID，可在访问密钥（Access Key）获取； -ShortDate为请求的短时间，使用UTC时间，精确到日。请使用格式：YYYYMMDD，例如：20180201； -Region为请求地区，国内一般为cn-north-1； -Service为请求的服务，文字识别一般为cv； -SignedHeaders为参与签名计算的头部信息，content-type 和 host 为必选头部； -Signature为签名，可在签名方法获取。注：我们提供了SDK及签名示例供您实现服务快速接入，具体可参考快速接入例如：HMAC-SHA256 Credential={AccessKeyId}/{ShortDate}/{Region}/{Service}/request, SignedHeaders={SignedHeaders}, Signature={Signature}
X-Security-Token	String	否	指安全令牌服务（Security Token Service，STS）颁发的临时安全凭证中的SessionToken，使用长期密钥时无需填写该参数。

Query请求参数

Body参数

参数	可选/必选	类型	说明
image_base64	与image_url二选一	String	图片文件，base64编码注意: 只需要传图片的base64值，类似data:image/png;base64的图片头不要传入
image_url	与image_base64二选一	String	图片/PDF文件的URL链接注意: 要求image_base64与image_url二选一，如果2个字段都有，优先解析image_base64。
approximate_pixel	可选	String	文本行高度差距为approximate_pixel时近似为同一行,未选时默认为"0"
mode	可选	String	文字识别模式:"default"-默认模式、"text_block"-文本块模式
filter_thresh	可选	String	置信分数低于filter_thresh的文本行将被过滤掉, 默认为"80", 最大为"100"

输出说明

通用输出参数

业务输出参数

data 字段说明

字段	类型	说明	备注
ocr_infos	MultilangTextResult	主页面信息	字段说明见下方

MultilangTextResult 字段说明

Lang 字段说明

输出示例

错误码

通用错误码

业务错误码

HttpCode	错误码	错误消息	描述
200	10000	"Success"	请求成功
400	50204	"Parse Request Parameters Error"	请求参数缺失或错误
400	50205	"Image Size Exceeds Maximum Limit: please compress the image"	输入文件过大
400	50207	"Image Decode Error: image format unsupported"	图片解码错误
400	50217	"Process PDF File Error."	处理PDF文件错误
400	63001	"Call OCR Server Failed."	OCR服务处理该输入时出现错误, 建议先确认请求的图片数据是否正常，如图片数据无问题请联系工作人员并提交对应的request_id