文字识别 OCR-网络图片识别:请求参数

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

请求参数

表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)。

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

说明:

该功能仅支持开通在华北-北京四、华东-上海一区域的API。

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

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

参数

是否必选

参数类型

说明

image

String

该参数与url二选一。

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

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

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

detect_direction

Boolean

是否校正图片的倾斜角度,可选值如下。

  • true:校正图片的倾斜角度
  • false:不校正图片的倾斜角度

支持任意角度的校正,未传入该参数时默认为“false”

待识别图片如果存在倾斜,建议将此参数设置为“true”。

extract_type

Array of strings

结构化数据提取参数列表,目前只支持联系人信息、图像宽高,其入参值分别为“contact_info”“image_size”

若不填写该参数或删除该参数,默认不提取该参数值。

detect_font

Boolean

为Boolean类型,若不传该字段,默认不检测切片字体,为True时,将检测切片的字体类型,并返回最相似的5种字体名称。

detect_text_direction

Boolean

为Boolean类型,若不传该字段,默认为True,即检测每个字段的文字方向。为False时,则不检测文字方向。若图片中所有文字方向均是水平朝上时,建议将该值设为False,即不检测文字方向。

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