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

通用文字识别

分享
更新时间: 2019/06/18 18:57

URI

URI格式

POST /v1.0/ocr/general-text

请求消息

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

名称

是否必选

类型

说明

image

与url二选一

String

图像数据,base64编码,要求base64编码后大小不超过10M。图像各边的像素大小在15到4096之间。支持JPG/PNG/BMP/TIFF格式。

url

与image二选一

String

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

detect_direction

Boolean

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

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

支持图片朝向逆时针旋转0/90/180/270度检测。默认值为false即不检测图片朝向,只支持正常角度的图片识别。

响应消息

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

名称

类型

说明

result

JSON

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

调用失败时无此字段。

direction

Integer

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

0:表示正向。

90:表示逆时针旋转90度。

180:表示逆时针旋转180度。

270:表示逆时针旋转270度。

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

words_block_count

Integer

识别文字块数目。

words_block_list

List

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

words

String

文字块识别结果。

location

List

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

error_code

String

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

调用成功时无此字段。

error_msg

String

调用失败时的错误信息。

调用成功时无此字段。

示例

  • 请求示例(方式一:使用图片的BASE64编码)
    POST https://ocr.cn-north-1.myhuaweicloud.com/v1.0/ocr/general-text 
        
     Request Header:   
     Content-Type: application/json   
     X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG...   
        
     Request Body:
     {   
    "image":"/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAAgABwESAAMAAAABAAEAAAEaAAUAAAABAAAAYgEbAAUAAAABAAAAagEoAAMAAAABAAIAAAExAAIAAAAcAAAAcgEyAAIAAAAUAAAAjodpAAQAAAABAAAApAAAANAACvyAAAAnEAAK/IAAACcQQWRvYmUgUGhvdG9zaG9wIENTMyBXaW5kb3dzADIwMTc6MTA6MjAgMTA6NDU6MzYAAAAAA6ABAAMAAAAB//8AAKACAAQAAAABAAALIKADAAQAAAABAAAGQAAAAAAAAAAGAQMAAwAAAAEABgAAARoABQAAAAEAAAEeARsABQAAAAEAAAEmASgAAwAAAAEAAgAAAgEABAAAAAEAAAEuAgIABAAAAAEAABAj...",
     "detect_direction":false
      }
  • 请求示例(方式二:使用图片URL)
    POST https://ocr.cn-north-1.myhuaweicloud.com/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
      }
  • 成功响应示例
    {
        "result": {
            "direction": -1,
            "words_block_count": 1,
            "words_block_list": [  
                 {
                     "words":"文字区域识别字母数字块1",
                     "location":[
                          [15,15],
                          [30,15],
                          [30,30],
                          [15,30]
                     ]
                 }
            ]
        }
    }
  • 失败响应示例
    {
        "error_code": "AIS.0105",
        "error_msg": "Recognize Failed"
    }

返回值

  • 正常

    200

  • 失败

    返回值

    说明

    400

    • 语义有误,当前请求无法被服务器解析。除非进行修改,否则客户端不应重复提交这个请求。
    • 请求参数有误。

    401

    当前请求需要用户验证。

    403

    没有操作权限。

    404

    请求失败,在服务器上未找到请求所希望得到的资源。

    500

    服务器遇到了一个未曾预料的状况,导致无法完成对请求的处理。

如果您喜欢这篇文档,您还可以:

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

提交成功!

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

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

*必选

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

字符长度不能超过200

提交反馈 取消

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

跳转到云社区