1. 接口说明

通用文字识别(General words Recognition)基于深度神经网络模型的端到端文字识别系统，将图片（来源如扫描仪或数码相机）中的文字转化为计算机可编码的文字

2. 接口地址

POST http[s]://webapi.xfyun.cn/v1/service/v1/ocr/general HTTP/1.1
Content-Type:application/x-www-form-urlencoded; charset=utf-8

3. 请求参数

在 Http Request Header 中配置授权认证参数，见【接口描述-授权认证】。其中 X-Param 为各配置参数组成的JSON串经BASE64编码之后的字符串，原始JSON串各字段说明如下：

参数	类型	必须	说明	示例
language	string	是	语言，可选值：en（英文），cn\|en（中文或中英混合）	en
location	string	否	是否返回文本位置信息，可选值：false（否），true（是），默认为false	true

X-Param生成示例：

原始JSON串：
{
    "language": "en",
    "location": "false"
}
BASE64编码（即X-Param）：
eyJsYW5ndWFnZSI6ImVuIiwibG9jYXRpb24iOiJmYWxzZSJ9

在 Http Request Body 中配置以下参数：

参数	类型	必须	说明	示例
image	string	是	图像数据，base64编码后进行urlencode，要求base64编码和urlencode后大小不超过4M，最短边至少15px，最长边最大4096px,支持jpg/png/bmp格式	exSI6ICJlbiIsCgkgICAgInBvc2l0aW9uIjogImZhbHNlIgoJf…

_注：_base64编码后大小会增加约1/3

4. 返回值

返回值为json串，各字段如下：

参数	类型	说明
code	string	结果码(具体见错误码)
data	json	详见data说明
desc	string	描述
sid	string	会话ID

其中sid字段主要用于追查问题，如果出现问题，可以提供sid给讯飞技术人员帮助确认问题。

data各字段说明如下：

参数	类型	说明
block	对象数组	区域块信息
type	string	区域块类型（text-文本，image-图片）
line	对象数组	行信息
word	对象数组	字（中文），单词（英文）
content	string	内容
confidence	float	后验概率
location	对象	位置信息
top_left	对象	左上角位置信息
right_bottom	对象	右下角位置信息
x	int	对应点的横坐标（像素）
y	int	对应点的纵坐标（像素）

示例如下：

失败：

{
    "code": "10106",
    "desc": "invalid parameter|invalid X-Appid",
    "data": "",
    "sid": "wcr0000bb3f@ch3d5c059d83b3477200"
}

成功

含位置信息

{
    "code": "0",
    "data": {
        "block": [
            {
                "line": [
                    {
                        "confidence": 1,
                        "word": [
                            {
                                "content": "I'm",
                                "location": {
                                    "right_bottom": {
                                        "y": 28,
                                        "x": 18
                                    },
                                    "top_left": {
                                        "y": 0,
                                        "x": 0
                                    }
                                }
                            }
                        ],
                        "location": {
                            "right_bottom": {
                                "y": 28,
                                "x": 478
                            },
                            "top_left": {
                                "y": 0,
                                "x": 0
                            }
                        }
                    }
                ],
                "type": "text"
            }
        ]
    },
    "sid": "wcr00000009@ch0fc40d9e4cdf000100",
    "desc": "success"
}

不含位置信息

{
    "code":"0",
    "data":{
        "block":[
            {
                "line":[
                    {
                        "confidence":1,
                        "word":[
                            {
                                "content":"I'm"
                            }
                        ]
                    }
                ],
                "type":"text"
            }
        ]
    },
    "sid":"wcr00000008@ch0fc40d9e4c73000100",
    "desc":"success"
}

5. 调用示例