通用图片文字识别OCR

接口描述

对上传的任意图片进行OCR识别，返回图片上的信息（不要求图片符合具体的某种文本样式）。

【注】套餐暂时使用：身份核验服务-身份证OCR识别子产品

接口

/v2/identity/auth/api/ocr/generalcharacters

请求方式

POST

请求头

提供两种安全接入方式，对应参数如何获取，参考文档【请点击】。

方式一：请求签名鉴权（优先推荐）

参数名称	类型	必选	参数说明
X-Tsign-Open-App-Id	string	是	项目ID
Content-Type	string	是	application/json;charset=UTF-8
X-Tsign-Open-Ca-Timestamp	string	是	API 调用者传递时间戳，值为当前时间的毫秒数，也就是从1970年1月1日起至今的时间转换为毫秒，时间戳有效时间为15分钟，为了防重放攻击
Accept	string	是	建议统一填写 /
X-Tsign-Open-Ca-Signature	string	是	签名字符串
Content-MD5	string	否	当请求 Body 非 Form 表单时，可以计算 Body 的 MD5 值传递给云网关进行 Body MD5 校验。建议当请求 Body 非 Form 表单时，加上此请求头。
X-Tsign-Open-Auth-Mode	string	是	选择请求方式进行鉴权，固定值，Signature

方式二：OAuth2.0鉴权（不推荐使用）

当安全接入选择OAuth2.0鉴权方式，请点击查阅详情。

请求参数

参数名称

类型

必选

参数类型

参数说明

image

string

是

body

图片BASE64字符串

注意不要带图片BASE64前缀“data:image/jpeg;base64,”

图片类型支持：jpg，jpeg，png，bmp

图片建议分辨率600*800以上，图片大小控制在1M以内

requestId

string

否

body

请求id，标识一次客户的请求，允许为空，一般使用客户的业务id

响应参数

展开全部参数参数名称				类型	必选	参数说明
code				int	是	接口响应结果码
message				string	否	接口响应结果描述
data				object	否	接口响应结果数据
	angle			float	否	图片旋转角度（角度制），文本的水平方向为0.0度；顺时针为正，逆时针为负。
	textDetections			array	否	检测到的文本信息，包括文本内容、文本行宽高、文本行坐标等
	advancedInfo		string	否	标识识别文字段序号
	detectedText		string	否	识别出的文本行内容
	itemPolygon		string	否	文本行在旋转纠正之后，图像中的第一个文字左上角的像素坐标和当前文本行的宽、高注意：坐标值是以图片的左上角为原点，往右是X轴，往下Y轴
		x	Integer	否	左上角x坐标，单位：像素
y		Integer	否	左上角y坐标，单位：像素
width		Integer	否	文本行宽度，单位：像素
height		Integer	否	文本行宽度，单位：像素
polygon		array	否	文本行坐标，当前文本行的四个顶点坐标依次返回，依次为：左上角、右上角、右下角、左下角（此字段返回null，表示取不到有效值）注意：坐标值是以图片的左上角为原点，往右是X轴，往下Y轴
	x	Integer	否	顶点x坐标
	y	Integer	否	顶点y坐标

请求示例

{
    "requestId":"123456",
    "image": "/9j/4AAQSkZJRgABAQEAS......"
}

响应示例

{
    "code": 0,
    "message": "成功",
    "data": {
        "verifyId": "bfbaf02e-f63e-4b9d-8818-705bcc618d46",
        "angle": 0.0,
        "textDetections": [
            {
                "advancedInfo": "1",
                "detectedText": "通用图片文字识别0CR",
                "itemPolygon": {
                    "x": 37,
                    "y": 34,
                    "width": 368,
                    "height": 37
                },
                "polygon": [
                    {
                        "x": 37,
                        "y": 34
                    },
                    {
                        "x": 404,
                        "y": 34
                    },
                    {
                        "x": 404,
                        "y": 70
                    },
                    {
                        "x": 37,
                        "y": 70
                    }
                ]
            },
            {
                "advancedInfo": "2",
                "detectedText": "接口描述",
                "itemPolygon": {
                    "x": 37,
                    "y": 104,
                    "width": 80,
                    "height": 22
                },
                "polygon": [
                    {
                        "x": 37,
                        "y": 104
                    },
                    {
                        "x": 116,
                        "y": 104
                    },
                    {
                        "x": 116,
                        "y": 125
                    },
                    {
                        "x": 37,
                        "y": 125
                    }
                ]
            },
            {
                "advancedInfo": "3",
                "detectedText": "对上传的任意图片进行OCR识别，返回图片上的信息(不要求图片符合具体的某种文本样式)",
                "itemPolygon": {
                    "x": 36,
                    "y": 137,
                    "width": 614,
                    "height": 19
                },
                "polygon": [
                    {
                        "x": 36,
                        "y": 137
                    },
                    {
                        "x": 649,
                        "y": 137
                    },
                    {
                        "x": 649,
                        "y": 155
                    },
                    {
                        "x": 36,
                        "y": 155
                    }
                ]
            }
        ]
    }
}

错误码

错误码	错误描述	解决方案
30500100	缺少参数：image不能为空	image-图片BASE64字符串需要传入
30500101	参数错误：文件大小超出限制，最大1MB	请检查传入的图片大小，需要小于1MB