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

调用方式

最近更新时间：2023.04.06 16:18:52

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

我的收藏
接口简介

支持对PDF文件进行识别，输出结构化信息。同时支持doc/docx文件类型。

限制条件
名称内容
图片要求1. 文件格式：pdf/doc/docx。
2. 文件大小：
a.要求Base64编码和urlencode之后不超过 8 MB。
b.如果传PDF完整URL，URL对应文件大小建议不要超过8MB。
3. 输入文件过大时，返回的HttpCode如下：400/413/502。
请求说明

基本信息

名称内容
接口地址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接口名，取值：OCRPdf
Version必选String版本号，取值：2021-08-23

Body参数

参数可选/必选类型说明
image_base64与image_url二选一String文件的base64编码
注意: 只需要传文件的base64值
image_url与image_base64二选一String图片/PDF文件的URL链接
注意: 要求image_base64与image_url二选一，如果2个字段都有，优先解析image_base64。
file_type可选String文件类型:"pdf"/"doc", 默认为"pdf"
输出说明

通用输出参数

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

业务输出参数

data 字段说明

字段类型说明备注
page_infosArray of page_info页面信息字段说明见下方

page_info 字段说明

字段类型说明备注
polyArray of Points行矩形框信息(可能有倾斜矩形)四个点的坐标，[左上, 右上, 右下, 左下]
textArray of String识别结果文本识别结果

Point信息

字段类型说明备注
xfloat坐标点横坐标占尺寸的百分比
yfloat坐标点纵坐标占尺寸的百分比

输出示例

{
    "code":10000,
    "data":{
        "page_infos":[
            {
                "poly": [
                    [0.408198, 0.105675],
                    [0.589619, 0.105675],
                    [0.589619, 0.127048],
                    [0.408198, 0.127048]
                ]
                "text": [
                    "咨询服务合同"
                ]
            }
        ]
    },
    "message":"Success",
    "request_id":"021629427766315fdbddc01010500400000000000000068da22fd",
    "time_elapsed":"5.330714543s"
}
错误码

通用错误码

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

业务错误码

HttpCode错误码错误消息描述
20010000无请求成功
40150205"Image Size Exceeds Maximum Limit: please compress the image"文件大小超过上限
40050207"Image Decode Error: image format unsupported"文件解码错误，文件内容为空或格式错误
40150400"Access denied due to invalid authentication information"鉴权失败
40450402"Invalid Request URL"无效的请求路径
50050500"Internal Error: please contact with bytedance engineering team"内部错误，需要联系开发人员