文档首页 > > API参考> API> 通用文字识别

通用文字识别

分享
更新时间: 2019/10/30 GMT+08:00

功能介绍

识别图片上的文字信息,返回识别的文字和坐标。支持扫描文件、电子文档、书籍、票据和表单等多种场景的文字识别。

URI

URI格式:

POST /v1.0/ocr/general-text

请求消息

通用文字识别请求参数说明请参见 表1
表1 请求参数说明

参数

是否必选

参数类型

说明

image

与url二选一

String

图像数据,base64编码,要求base64编码后大小不超过10M。图片最小边不小于15像素,最长边不超过4096像素。支持JPEG/JPG/PNG/BMP/TIFF格式。

url

与image二选一

String

图片的URL路径,目前仅支持华为云上OBS提供的匿名公开授权访问的URL以及公网URL。

detect_direction

Boolean

图片朝向检测开关,可选值包括:

  • true:检测图片朝向;
  • false:不检测图片朝向。

支持任意角度的图片朝向检测。未传入该参数时默认为false,即不检测图片朝向。

quick_mode

Boolean

快速模式开关,针对单行文字图片(要求图片只包含一行文字,且文字区域占比超过50%),打开时可以更快返回识别。可选值包括:

  • true:打开快速模式;
  • false:关闭快速模式。

未传入该参数时默认为false,即关闭快速模式。

响应消息

通用文字识别响应参数说明请参见 表2
表2 响应参数说明

参数

参数类型

说明

result

Object

调用成功时表示调用结果。

调用失败时无此字段。

direction

Integer

图片朝向,仅当detect_direction为true时,该字段有效。

返回图片逆时针旋转角度,值区间为[0, 359]。

当detect_direction为false时,该字段值为 -1。

words_block_count

Integer

识别文字块数目。

words_block_list

Array of objects

识别文字块列表,输出顺序从左到右,先上后下。

words

String

文字块识别结果。

location

Array of objects

文字块的区域位置信息,列表形式,包含文字区域四个顶点的二维坐标(x,y);坐标原点为图片左上角,x轴沿水平方向,y轴沿竖直方向。

error_code

String

调用失败时的错误码,具体请参见错误码

调用成功时无此字段。

error_msg

String

调用失败时的错误信息。

调用成功时无此字段。

示例

  • 请求示例(方式一:使用图片的BASE64编码)
    POST https://{endpoint}/v1.0/ocr/general-text 
        
     Request Header:   
     Content-Type: application/json   
     X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG...   
     Request Body:
     {   
        "image":"/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAA...",
        "detect_direction":false
      }
  • 请求示例(方式二:使用图片URL)
    POST https://{endpoint}/v1.0/ocr/general-text
        
     Request Header:   
     Content-Type: application/json   
     X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG...   
     Request Body:
     {
         "url":"https://BucketName.obs.myhuaweicloud.com/ObjectName",
         "detect_direction":false
      }

Endpoint即调用API的请求地址,不同服务不同区域的Endpoint不同,具体请参见终端节点

例如通用文字识别服务部署在“华北-北京四”区域的Endpoint为“ocr.cn-north-4.myhuaweicloud.com”,请求URL为“https://ocr.cn-north-4.myhuaweicloud.com/v1.0/ocr/general-text”。

  • 成功响应示例
    {
        "result": {
            "direction": -1,
            "words_block_count": 1,
            "words_block_list": [  
                 {
                     "words":"文字区域识别字母数字块1",
                     "location":[
                          [15,15],
                          [30,15],
                          [30,30],
                          [15,30]
                     ]
                 }
            ]
        }
    }
  • 失败响应示例
    {
        "error_code": "AIS.0103",
        "error_msg": "The image size does not meet the requirements."
    }

状态码

状态码请参见状态码

分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

跳转到云社区