文字识别 OCR-通用表格识别:请求参数

时间:2024-04-15 09:41:20

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

用于获取操作API的权限。获取Token接口响应消息头中X-Subject-Token的值即为Token。

Content-Type

String

发送的实体的MIME类型,参数值为“application/json”。

Enterprise-Project-Id

String

企业项目ID。OCR支持通过企业项目管理(EPS)对不同用户组和用户的资源使用,进行分账。

获取方法:进入“企业项目管理”页面,单击企业项目名称,在企业项目详情页获取Enterprise-Project-Id(企业项目ID)。

企业项目创建步骤请参见用户指南。

说明:

创建企业项目后,在传参时,有以下三类场景。

  • 携带正确的ID,正常使用OCR服务,账单归到企业ID对应的企业项目中。
  • 携带错误的ID,正常使用OCR服务,账单的企业项目会被分类为“未归集”。
  • 不携带ID,正常使用OCR服务,账单的企业项目会被分类为“未归集”。
表3 请求Body参数

参数

是否必选

类型

说明

image

String

该参数与url二选一。

图片的Base64编码,要求Base64编码后大小不超过10MB。

图片最短边不小于15px,最长边不超过8192px,支持JPEG、JPG、PNG、BMP、TIFF格式。

图片Base64编码示例如/9j/4AAQSkZJRgABAg...,带有多余前缀会产生The image format is not supported报错。

url

String

该参数与image二选一。图片的url路径,目前支持:

  • 公网http/https url例如https://support.huaweicloud.com/api-ocr/zh-cn_image_0282767866.png
  • OBS提供的url,使用OBS数据需要进行授权。包括对服务授权、临时授权、匿名公开授权,详情参见配置OBS访问权限
说明:
  • 接口响应时间依赖于图片的下载时间,如果图片下载时间过长,会返回接口调用失败。
  • 请保证被检测图片所在的存储服务稳定可靠,推荐使用OBS服务存储图片数据。
  • url中不能存在中文字符,若存在,中文需要进行utf8编码。

return_text_location

Boolean

返回文本块坐标及单元格坐标信息,可选值如下所示。

  • true:返回文本块和单元格坐标
  • false:不返回

如果未传入该参数时默认为false,即不返回。

return_char_location

Boolean

返回单字符的坐标信息,可选值包括:

  • true:返回单字符的坐标
  • false:不返回

未传入该参数时默认为false,即不返回。如果此参数为true时,return_text_location必须为true

return_confidence

Boolean

是否返回置信度的开关,可选值如下所示。

  • true:返回置信度
  • false:不返回置信度

如果未传入该参数,系统默认为“false”,即不返回置信度。

return_excel

Boolean

是否返回表格转换Microsoft Excel的Base64编码字段。可选值包括:

  • true: 返回'excel'字段,表示xlsx格式的表格识别结果的Base64编码
  • false: 不返回。默认为false

对返回的Excel编码,可用Python函数 base64.b64decode解码后保存为.xlsx文件。

return_rectification_matrix

Boolean

可选值包括:

  • true:返回透视变换矩阵
  • false:不返回

未传入该参数时默认为false,即不返回透视变换矩阵。

with_borders

Boolean

可选值包括:

  • true:输入图像仅包含有线表格,仅进行有线表格识别。
  • false: 输入图像可能包含无线表格,同时进行有线表格与无线表格识别。

未传入该参数时默认为false,即同时进行有线表格与无线表格识别。当确认输入仅包含有线表格时,该参数设为true可达到更优识别效果。

support.huaweicloud.com/api-ocr/ocr_03_0031.html