You need to enable JavaScript to run this app.
导航
文字识别
  • 文档首页
    • /
  • 文字识别

调用方式

最近更新时间：2023.08.07 16:47:08

首次发布时间：2022.07.21 17:01:20

我的收藏
接口简介

多语种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-Typeapplication/x-www-form-urlencoded
是否需要鉴权是

请求参数

header请求参数

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

名称类型是否必填描述
X-DateString是使用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-TokenString否指安全令牌服务（Security Token Service，STS） 颁发的临时安全凭证中的SessionToken，使用长期密钥时无需填写该参数。

Query请求参数

参数可选/必选类型说明
Action必选String接口名，取值：MultiLanguageOCR
Version必选String版本号，取值：2022-08-31

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_infosMultilangTextResult主页面信息字段说明见下方

MultilangTextResult 字段说明

字段类型说明备注
langLang语种字段说明见下方
textString每行文字的识别结果主页信息
rectPoint每行文字的位置, 4组(x,y)坐标, 分别为(左上,右上,右下,左下)主页信息
probFloat每行文字的识别概率主页信息

Lang 字段说明

缩写语种缩写语种缩写语种缩写语种
zh中文de德语pa旁遮普语kk哈萨克语
en英文it意大利语mr马拉地语el希腊语
ja日文es西班牙语az阿塞拜疆语ga爱尔兰语
ko韩语fr法语id印尼语be白俄罗斯语
vi越南语pl波兰语ms马来语km高棉语
th泰语pt葡萄牙语not_lang非语言-如纯数字等tl他加禄语
ar阿拉伯语ca加泰罗尼亚语hu匈牙利语ps普什图语
bn印度-孟加拉语ru俄语lb卢森堡语fa波斯语
gu印度-古吉拉特语bs波斯尼亚语lt立陶宛语tg塔吉克斯坦语
hi印度-印地语cs捷克语lv拉脱维亚语
kn印度-卡纳达语da丹麦语mt马耳他语
ml印度-马拉亚拉姆语et爱沙尼亚语nl荷兰语
ta印度-泰米尔语fi芬兰语no挪威语
te印度-泰卢固语hr克罗地亚语sk斯洛伐克语
sl斯洛文尼亚语sv瑞典语tr土耳其语

输出示例

{
   "code":10000,
   "data":{
      "ocr_infos":[
          {
              "lang": "en",
              "prob": "0.9840925931930542",
              "rect": [[186, 3], [290, 2], [290, 14], [187, 15]],
              "text": "Untitled 4 - Edited",
          },
          {
              "lang": "ja",
              "prob": "0.9873754382133484",
              "rect": [[22, 23], [450, 23], [450, 53], [22, 53]],
              "text": "で使われている膨大な用語から辞",
          },
          {
              "lang": "ja",
              "prob": 0.9925921559333801,
              "rect": [[3, 63], [460, 63], [460, 93], [3, 93]],
              "text": "書を作成しました。珍しい人名や地",
          },
          {
              "lang": "ja",
              "prob": 0.9882089495658875,
              "rect": [[1, 102], [462, 102], [462, 134], [1, 134]],
              "text": "名、難しい専門用語から、流行の顔",
          },
          {
              "lang": "ja",
              "prob": 0.9895573258399963,
              "rect": [[2, 143], [459, 143], [459, 173], [2, 173]],
              "text": "文字やお店の名前まで。辞書は定期",
          },
          {
              "lang": "ja",
              "prob": 0.9945052266120911,
              "rect": [[2, 182], [460, 182], [460, 212], [2, 212]],
              "text": "的に自動更新され、常に最新の語彙",
          },
          {
              "lang": "ja",
              "prob": 0.9901278614997864,
              "rect": [[5, 222], [216, 222], [216, 251], [5, 251]],
              "text": "を利用できます。",
          },
      
      ]
   },
   "message":"Success",
   "request_id":"68893249940530155591604045972",
   "status":10000,
   "time_elapsed":"193.547357ms"
}
错误码

通用错误码

请参考通用返回字段及错误码

业务错误码

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