"content": {}
} ] }
状态码：400 失败响应示例
{ "error_code": "AIS.0103",
"error_msg": "The image size does not meet the requirements."
}
状态码
状态码 描述
200 成功响应。
400 失败响应。
状态码请参见状态码。
错误码
错误码请参见错误码。
4.5 手写文字识别
功能介绍
识别文档中的手写文字、印刷文字信息，并将识别的结构化结果以json格式返回给用 户。该接口的使用限制请参见约束与限制，详细使用指导请参见OCR服务使用简介章 节。
图4-5 手写文字识别示例图
调试
您可以在API Explorer中调试该接口。
前提条件
在使用手写文字识别之前，需要您完成服务申请和认证鉴权，具体操作流程请参见开
通服务和认证鉴权章节。
说明
用户首次使用需要先申请开通。服务只需要开通一次即可，后面使用时无需再次申请。如未开通 服务，调用服务时会提示ModelArts.4204报错，请在调用服务前先进入控制台开通服务，并注 意开通服务区域与调用服务的区域保持一致。
URI
POST https://{endpoint}/v2/{project_id}/ocr/handwriting 表4-32 路径参数
参数 是否必选 说明
endpoint 是 指定承载REST服务端点的服务器域名或IP，不同 服务不同区域的endpoint不同，您可以从终端节
点中获取。
例如，OCR服务在“华北-北京四”区域的
“endpoint”为“ocr.cn-north-4.myhuaweicloud.com”。
project_id 是 项目ID，您可以从获取项目ID中获取。
请求参数
表4-33 请求 Header 参数
参数 是否必选 参数类型 描述
X-Auth-Token 是 String 用户Token。
用于获取操作API的权限。获取 Token接口响应消息头中X-Subject-Token的值即为Token。
Content-Type 是 String 发送的实体的MIME类型，参数 值为“application/json”。
表4-34 请求 Body 参数
参数 是否必选 参数类
型
说明
image 否 String 该参数与url二选一。图像数据，base64编 码，要求base64编码后大小不超过10MB。
图片最小边不小于8px，最长边不超过 8192px，支持JPEG、JPG、PNG、BMP、
TIFF格式。
参数 是否必选 参数类 型
说明
url 否 String 该参数与image二选一。图片的url路径，目 前支持：
● 公网http/https url
● OBS提供的url，使用OBS数据需要进行授 权。包括对服务授权、临时授权、匿名公 开授权，详情参见配置OBS访问权限。
说明
● 接口响应时间依赖于图片的下载时间，如果图 片下载时间过长，会返回接口调用失败。
● 请保证被检测图片所在的存储服务稳定可靠，
推荐使用OBS服务存储图片数据。
quick_mod
e 否 Boolean 快速模式开关，针对单行文字图片（要求图
片只包含一行文字，且文字区域占比超过 50%），打开时可以更快返回识别内容。可 选值如下所示。
● true：打开快速模式
● false：关闭快速模式
未传入该参数时默认为false，即关闭快速模 式。
char_set 否 String 字符集设置，用户可以根据实际需要限定输 出字符集范围。可选值如下所示。
● digit：数字模式
● letter：大小写字母模式
● digit_letter：数字+字母模式
● general：数字+字母+中文模式
未传入该参数时，默认为“general”模式。
detect_dir
ection 否 Boolean 校正图片的倾斜角度开关，可选值如下所 示。
● true：校正图片的倾斜角度
● false：不校正图片的倾斜角度
支持任意角度的校正，未传入该参数时默认 为“false”。
响应参数
说明
根据识别的结果，可能有不同的HTTP响应状态码（status code）。例如，200表示API调用成 功，400表示调用失败，详细的状态码和响应参数说明如下。
状态码： 200
表4-35 响应 Body 参数
参数 参数类型 描述
result Handwriti ngResult object
调用成功时表示调用结果。
调用失败时无此字段。
表4-36 HandwritingResult
参数 参数类型 描述
words_block_cou
nt Integer 代表检测识别出来的文字块数目。
words_block_list Array of Handwriti ngItemsRe sponse objects
识别文字块列表，输出顺序从左到右，从上到 下。
表4-37 HandwritingItemsResponse
参数 参数类型 描述
words String 文字块识别结果。
type String 说明该识别结果所属类型，返回值为“text”。
confidence Float 相关字段的置信度信息，取值范围0~1。
置信度越大，表示本次识别的对应字段的可靠性 越高，在统计意义上，置信度越大，准确率越 高。
置信度由算法给出，不直接等价于对应字段的准 确率。
location Array of
integers 文字块“words”的区域位置信息，列表形式，
分别表示文字块顶点的（x,y）坐标；采用图像坐 标系，坐标原点为图片左上角，x轴沿水平方 向，y轴沿竖直方向。
状态码： 400
表4-38 响应 Body 参数
参数 参数类型 说明
error_code String 调用失败时的错误码，具体请参见错误码。
当出现错误码“ModelArts.4204”时，请参考为
什么调用API时提示“ModelArts.4204”？章
节。调用成功时无此字段。
error_msg String 调用失败时的错误信息。
调用成功时无此字段。
POST https://{endpoint}/v2/{project_id}/ocr/handwriting Request Header:
Content-Type: application/json X-Auth-Token:
MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG...
Request Body:
{ "image": "/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAA...", "quick_mode": false,
"char_set": "general", "detect_direction": false }
● 请求示例（方式二：使用图片URL）
POST https://{endpoint}/v2/{project_id}/ocr/handwriting Request Header:
Content-Type: application/json X-Auth-Token:
MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG...
Request Body:
{ "url":"https://BucketName.obs.xxxx.com/ObjectName", "quick_mode ":false,
"char_set": "general", "detect_direction": false }
● Python3语言请求代码示例（其他语言参照下列示例编写或使用OCR SDK）
# encoding:utf-8 import requests import base64
url = "https://{endpoint}/v2/{project_id}/ocr/handwriting"
token = "用户获取得到的实际token值"
headers = {'Content-Type': 'application/json', 'X-Auth-Token': token}
imagepath = r'./data/handwriting-demo.png' with open(imagepath, "rb") as bin_data:
image_data = bin_data.read()
image_base64 = base64.b64encode(image_data).decode("utf-8") # 使用图片的base64编码 payload = {"image": image_base64} # url与image参数二选一
response = requests.post(url, headers=headers, json=payload) print(response.text)
{ "error_code": "AIS.0103",
"error_msg": "The image size does not meet the requirements."
}
状态码
状态码 描述
200 成功响应。
400 失败响应。
状态码请参见状态码。
错误码
错误码请参见错误码。