You need to enable JavaScript to run this app.
导航
调用方式
最近更新时间:2024.08.23 14:32:17首次发布时间:2022.07.21 17:01:20
接口简介

支持对同一张图片中出现的多张不同种类的票据的字段解析,包含增值税发票、增值税卷票、出租车票、定额发票、火车票、行程单、高速公路过路费发票、客运发票以及其他发票混贴业务场景,满足财会报销场景的多样化信息提取需求。

限制条件
名称内容
输入要求1. 文件格式:支持JPG、JPEG、PNG、BMP、PDF、OFD等常见格式,建议使用JPG格式。
2. 文件大小:
a.要求Base64编码和urlencode之后不超过 8 MB。
b.如果传图片及PDF完整URL,URL对应文件大小建议不要超过8MB。
3. 输入文件过大时,返回的HttpCode如下:400/413/502。
4. 输入多页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-typehost 为必选头部;
-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接口名,取值:OcrFinance
Version必选String版本号,取值:2021-08-23

Body参数

参数可选/必选类型说明
image_base64与image_url二选一String图片/PDF文件,base64编码
注意: 只需要传图片/PDF的base64值,类似data:image/png;base64的图片头不要传入
image_url与image_base64二选一String图片/PDF文件的URL链接
注意: 要求image_base64与image_url二选一,如果2个字段都有,优先解析image_base64。
输出说明

通用输出参数

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

业务输出参数

data 字段说明

字段类型说明备注
invoice_main[]item主页面信息字段说明见下方

item 字段说明

字段类型说明备注
image_nameString图片名称主页信息
cornerscorner票据位置坐标(以文字正向为参考,左上角为第0个点,顺时针依次为剩余3个点)主页信息
invoice_typeString票据类型主页信息
invoice_probfloat64票据种类预测概率主页信息
item_infos[]item_info票据字段信息主页信息
current_pageint票据当前页码主页信息
total_page_numberint票据总页码主页信息

corner 字段说明

字段类型说明备注
x0intx0坐标主页信息
y0inty0坐标主页信息
x1intx1坐标主页信息
y1inty1坐标主页信息
x2intx2坐标主页信息
y2inty2坐标主页信息
x3intx3坐标主页信息
y3inty3坐标主页信息

invoice_type 票据类型包含说明

票据类型说明备注
taxi出租车票支持票据分类和识别,具体识别字段信息与「出租车发票识别」接口文档一致,详见:接口文档
vat增值税发票支持票据分类和识别,具体识别字段信息与「增值税发票识别」接来源于出租车发票识别接口文档一致,详见:接口文档
roll增值税卷票支持票据分类和识别,具体识别字段信息与「增值税卷票识别」接口文档一致,详见:接口文档
ticket火车票支持票据分类和识别,具体识别字段信息与「火车票识别」接口文档一致,详见:接口文档
quota定额发票支持票据分类和识别,具体识别字段信息与「定额发票识别」接口文档一致,详见:接口文档
pass_invoice高速公路过路费发票支持票据分类和识别,具体识别字段信息与「高速公路过路费发票识别」接口文档一致,详见:接口文档
flight行程单支持票据分类和识别,具体识别字段信息与「行程单识别」接口文档一致,详见:接口文档
vehicle_invoice客运发票仅支持票据分类
medical_bill医疗发票仅支持票据分类
other_ele其他发票类型不属于以上分类的发票类别,仅支持票据分类
others其他不能识别的发票

item_info 字段说明

字段类型说明备注
item_keyString字段名称主页信息
item_valueString字段值主页信息

输出示例

主页面图片返回值示例

{
   "code":10000,
   "data":{
      "invoice_main":{
         "items":[
            {
               "image_name":"11",
               "conners":{
                  "x0":679,
                  "y0":424,
                  "x1":693,
                  "y1":820,
                  "x2":470,
                  "y2":839,
                  "x3":446,
                  "y3":433
               },
               "invoice_type":"ticket",
               "invoice_prob":0.9991505146026611
            },
            {
               "image_name":"11",
               "conners":{
                  "x0":442,
                  "y0":438,
                  "x1":450,
                  "y1":832,
                  "x2":202,
                  "y2":845,
                  "x3":191,
                  "y3":436
               },
               "invoice_type":"ticket",
               "invoice_prob":0.9999958276748657
            },
            {
               "image_name":"11",
               "conners":{
                  "x0":670,
                  "y0":241,
                  "x1":678,
                  "y1":431,
                  "x2":163,
                  "y2":436,
                  "x3":144,
                  "y3":222
               },
               "invoice_type":"taxi",
               "invoice_prob":0.9999946355819702
            }
         ]
      }
   },
   "message":"Success",
   "request_id":"68989479063430123651606286484",
   "status":10000,
   "time_elapsed":"2.81548946s"
}
错误码

通用错误码

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

业务错误码

HttpCode错误码错误消息描述
20010000请求成功
40050205"Image Size Exceeds Maximum Limit: please compress the image"输入文件过大
40050206"Invalid Input Image: image is empty"输入图片为空
40050207"Image Decode Error: image format unsupported"图片解码错误
40050217"Process PDF File Error."处理PDF文件错误
40060103"Missing Input Parameters: empty input image"输入图片为空
40060301"Invalid Input Image: get input image error"获取图片错误
40061301"Invalid Input Parameters: Input image can not be decoded"输入图片错误