调用方式--文字识别-火山引擎

文档中心

立即注册

导航

文字识别

调用方式

最近更新时间：2023.04.06 16:19:02首次发布时间：2022.07.21 17:01:20

接口简介

自动检测并识别出电子版、扫描版文档页面图片中的表格内容，并识别相关表格类型。

限制条件

名称	内容
输入要求	1. 文件格式：支持JPG、JPEG、PNG、BMP、PDF等常见格式，建议使用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-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请求参数

参数	可选/必选	类型	说明
Action	必选	String	接口名，取值：OCRTable
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 字段说明

字段	类型	说明	备注
table_infos	list of table_info	表格信息	字段说明见下方

table_info 字段说明

字段	类型	说明	备注
cell_infos	list of cell_info	单元格信息	字段说明见下方
table_bbox	int[8]	表格坐标	按左上、右上、右下、左下顺序排列四点坐标注意: 输入是PDF文件时，以相对坐标的形式返回，Array of Float
row_cnt	String	行数	主页信息
col_cnt	String	列数	主页信息
cell_cnt	String	单元格数	主页信息
excel_binary_base64	String	excel文件binary值的base64编码	主页信息
doc_binary_base64	String	doc文件binary值的base64编码	主页信息
html_string	String	html字符串	主页信息

cell_info 字段说明

字段	类型	说明	备注
cell_bbox	int[8]	单元格坐标	按左上、右上、右下、左下顺序排列四点坐标注意: 输入是PDF文件时，以相对坐标的形式返回，Array of Float
start_row	String	起始行	主页信息
end_row	String	终止行	主页信息
start_col	String	起始列	主页信息
end_row	String	终止列	主页信息
cell_text	String	单元格文字内容	主页信息

输出示例

{
	'code': 10000,
	'data': {
		'table_infos': [{
			'cell_cnt': 23,
			'cell_infos': [{
				'cell_bbox': [12, 17, 1071, 17, 1071, 96, 12, 96],
				'cell_text': '门诊检验报告单',
				'end_col': 4,
				'end_row': 1,
				'start_col': 1,
				'start_row': 1
			}, {
				'cell_bbox': [12, 99, 1071, 99, 1071, 171, 12, 171],
				'cell_text': '**血常规(5分类)',
				'end_col': 4,
				'end_row': 2,
				'start_col': 1,
				'start_row': 2
			}, {
				'cell_bbox': [12, 173, 1071, 173, 1071, 239, 12, 239],
				'cell_text': '标本状态:正常 临床诊断:1.慢性扁桃体炎',
				'end_col': 4,
				'end_row': 3,
				'start_col': 1,
				'start_row': 3
			}, {
				'cell_bbox': [12, 241, 618, 241, 618, 301, 12, 301],
				'cell_text': '检验项目',
				'end_col': 1,
				'end_row': 4,
				'start_col': 1,
				'start_row': 4
			}, {
				'cell_bbox': [620, 241, 730, 241, 730, 301, 620, 301],
				'cell_text': '结果',
				'end_col': 2,
				'end_row': 4,
				'start_col': 2,
				'start_row': 4
			}, {
				'cell_bbox': [732, 241, 947, 241, 947, 301, 732, 301],
				'cell_text': '参考范围',
				'end_col': 3,
				'end_row': 4,
				'start_col': 3,
				'start_row': 4
			}, {
				'cell_bbox': [949, 241, 1071, 241, 1071, 301, 949, 301],
				'cell_text': '单位',
				'end_col': 4,
				'end_row': 4,
				'start_col': 4,
				'start_row': 4
			}, {
				'cell_bbox': [12, 303, 618, 303, 618, 368, 12, 368],
				'cell_text': '中性细胞百分率(NEL%)',
				'end_col': 1,
				'end_row': 5,
				'start_col': 1,
				'start_row': 5
			}, {
				'cell_bbox': [620, 303, 730, 303, 730, 368, 620, 368],
				'cell_text': '77.1',
				'end_col': 2,
				'end_row': 5,
				'start_col': 2,
				'start_row': 5
			}, {
				'cell_bbox': [732, 303, 947, 303, 947, 368, 732, 368],
				'cell_text': '40-75',
				'end_col': 3,
				'end_row': 5,
				'start_col': 3,
				'start_row': 5
			}, {
				'cell_bbox': [949, 303, 1071, 303, 1071, 368, 949, 368],
				'cell_text': '%',
				'end_col': 4,
				'end_row': 5,
				'start_col': 4,
				'start_row': 5
			}, {
				'cell_bbox': [12, 371, 618, 371, 618, 437, 12, 437],
				'cell_text': '淋巴细胞百分率(LYM%)',
				'end_col': 1,
				'end_row': 6,
				'start_col': 1,
				'start_row': 6
			}, {
				'cell_bbox': [620, 371, 730, 371, 730, 437, 620, 437],
				'cell_text': '8.8',
				'end_col': 2,
				'end_row': 6,
				'start_col': 2,
				'start_row': 6
			}, {
				'cell_bbox': [732, 371, 947, 371, 947, 437, 732, 437],
				'cell_text': '20-50',
				'end_col': 3,
				'end_row': 6,
				'start_col': 3,
				'start_row': 6
			}, {
				'cell_bbox': [949, 371, 1071, 371, 1071, 437, 949, 437],
				'cell_text': '%',
				'end_col': 4,
				'end_row': 6,
				'start_col': 4,
				'start_row': 6
			}, {
				'cell_bbox': [12, 439, 618, 439, 618, 504, 12, 504],
				'cell_text': '单核细胞百分率(MONO%)',
				'end_col': 1,
				'end_row': 7,
				'start_col': 1,
				'start_row': 7
			}, {
				'cell_bbox': [620, 439, 730, 439, 730, 504, 620, 504],
				'cell_text': '7.1',
				'end_col': 2,
				'end_row': 7,
				'start_col': 2,
				'start_row': 7
			}, {
				'cell_bbox': [732, 439, 947, 439, 947, 504, 732, 504],
				'cell_text': '3.0-10.0',
				'end_col': 3,
				'end_row': 7,
				'start_col': 3,
				'start_row': 7
			}, {
				'cell_bbox': [949, 439, 1071, 439, 1071, 504, 949, 504],
				'cell_text': '%',
				'end_col': 4,
				'end_row': 7,
				'start_col': 4,
				'start_row': 7
			}, {
				'cell_bbox': [12, 507, 618, 507, 618, 571, 12, 571],
				'cell_text': '红细胞计数(RBC)',
				'end_col': 1,
				'end_row': 8,
				'start_col': 1,
				'start_row': 8
			}, {
				'cell_bbox': [620, 507, 730, 507, 730, 571, 620, 571],
				'cell_text': '6.66',
				'end_col': 2,
				'end_row': 8,
				'start_col': 2,
				'start_row': 8
			}, {
				'cell_bbox': [732, 507, 947, 507, 947, 571, 732, 571],
				'cell_text': '4.3-5.8',
				'end_col': 3,
				'end_row': 8,
				'start_col': 3,
				'start_row': 8
			}, {
				'cell_bbox': [949, 507, 1071, 507, 1071, 571, 949, 571],
				'cell_text': '%',
				'end_col': 4,
				'end_row': 8,
				'start_col': 4,
				'start_row': 8
			}],
			'col_cnt': 4,
			'doc_binary_base64': '',
			'excel_binary_base64': '',
			'html_string': '<html>\n <head>\n  <meta charset="utf-8"/>\n  <style>\n   table, th, td {border: 1px solid blue; font-size: 10px;} td {white-space: nowrap; text-align: center; width: 50px; height: 25px;}\n  </style>\n </head>\n <body>\n  <table frame="hsides" rules="groups" width="60%">\n   <tr>\n    <td colspan="4">\n     门诊检验报告单\n    </td>\n   </tr>\n   <tr>\n    <td colspan="4">\n     **血常规(5分类)\n    </td>\n   </tr>\n   <tr>\n    <td colspan="4">\n     标本状态:正常 临床诊断:1.慢性扁桃体炎\n    </td>\n   </tr>\n   <tr>\n    <td>\n     检验项目\n    </td>\n    <td>\n     结果\n    </td>\n    <td>\n     参考范围\n    </td>\n    <td>\n     单位\n    </td>\n   </tr>\n   <tr>\n    <td>\n     中性细胞百分率(NEL%)\n    </td>\n    <td>\n     77.1\n    </td>\n    <td>\n     40-75\n    </td>\n    <td>\n     %\n    </td>\n   </tr>\n   <tr>\n    <td>\n     淋巴细胞百分率(LYM%)\n    </td>\n    <td>\n     8.8\n    </td>\n    <td>\n     20-50\n    </td>\n    <td>\n     %\n    </td>\n   </tr>\n   <tr>\n    <td>\n     单核细胞百分率(MONO%)\n    </td>\n    <td>\n     7.1\n    </td>\n    <td>\n     3.0-10.0\n    </td>\n    <td>\n     %\n    </td>\n   </tr>\n   <tr>\n    <td>\n     红细胞计数(RBC)\n    </td>\n    <td>\n     6.66\n    </td>\n    <td>\n     4.3-5.8\n    </td>\n    <td>\n     %\n    </td>\n   </tr>\n  </table>\n </body>\n</html>',
			'row_cnt': 8,
			'table_bbox': [11, 16, 1074, 16, 1074, 573, 11, 573]
		}]
	},
	'message': 'Success',
	'request_id': '021641385077686fdbddc010012010500000000000001301d9be8',
	'status': 10000,
	'time_elapsed': '1.178839567s'
}

错误码

通用错误码

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

业务错误码

HttpCode	错误码	错误消息	描述
200	10000	无	请求成功
400	50205	"Image Size Exceeds Maximum Limit: please compress the image"	输入文件过大
400	50206	"Invalid Input Image: image is empty"	输入图片为空
400	50207	"Image Decode Error: image format unsupported"	图片解码错误
400	50217	"Process PDF File Error."	处理PDF文件错误
401	50400	"Access denied due to invalid authentication information"	鉴权失败
404	50402	"Invalid Request URL"	无效的请求路径
500	50500	"Internal Error: please contact with bytedance engineering team"	内部错误，需要联系开发人员

文字识别

基本信息

请求参数

header请求参数

Query请求参数

Body参数

通用输出参数

业务输出参数

data 字段说明

table_info 字段说明

cell_info 字段说明

输出示例

通用错误码

业务错误码