华为云用户手册

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 用于获取操作API的权限。获取Token接口响应消息头中X-Subject-Token的值即为Token。 Enterprise-Project-Id 否 String 企业项目ID。OCR支持通过企业项目管理（EPS）对不同用户组和用户的资源使用，进行分账。 获取方法：进入“企业项目管理”页面，单击企业项目名称，在企业项目详情页获取Enterprise-Project-Id（企业项目ID）。 企业项目创建步骤请参见用户指南。 说明： 创建企业项目后，在传参时，有以下三类场景。 携带正确的ID，正常使用OCR服务，账单归到企业ID对应的企业项目中。 携带错误的ID，正常使用OCR服务，账单的企业项目会被分类为“未归集”。 不携带ID，正常使用OCR服务，账单的企业项目会被分类为“未归集”。 表3 请求Body参数 参数 是否必选 参数类型 描述 image 否 String 与url二选一。 图像数据，base64编码，要求base64编码后大小不超过10M。 图片最小边不小于15像素，最长边不超过8192像素。支持JPG/PNG/BMP/TIFF格式。 图片Base64编码示例如/9j/4AAQSkZJRgABAg...，带有多余前缀会产生The image format is not supported报错。 url 否 String 与image二选一。 图片的URL路径，目前仅支持华为云上OBS提供的匿名公开授权访问的URL以及公网URL。 说明： 接口响应时间依赖于图片的下载时间，如果图片下载时间过长，会返回接口调用失败。 请保证被检测图片所在的存储服务稳定可靠，推荐使用OBS服务存储图片数据。

约束与限制 只支持中英文。 只支持识别PNG、JPG、JPEG、BMP、GIF、TIFF、WEBP、PCX、ICO、PSD格式的图片。 图像各边的像素大小在15px到8192px之间。 图像中识别区域有效占比超过80%，保证所有文字及其边缘包含在图像内。 不支持角度旋转的图片识别。 支持电子承兑汇票，对于拍照场景、复杂背景支持欠佳。 文字识别服务属于公有云服务，线上用户资源共享，如果需要多并发请求，请提前联系我们。

响应示例 状态码：200 成功响应示例 { "result" : [ { "plate_number" : "กง XXX4", "province" : "มหาสารคาม", "confidence" : 0.9225, "plate_location" : [ [ 370, 881 ], [ 2591, 881 ], [ 2591, 2281 ], [ 370, 2281 ] ] } ] } 状态码：400 失败响应示例 { "error_code": "AIS.0103", "error_msg": "The image size does not meet the requirements." }

请求示例 “endpoint”即调用API的请求地址，不同服务不同区域的“endpoint”不同，具体请参见终端节点。 例如，泰国车牌识别服务部署在“亚太-曼谷”区域的“endpoint”为“ocr.ap-southeast-2.myhuaweicloud.com”或“ocr.ap-southeast-2.myhuaweicloud.cn”，请求URL为“https://ocr.ap-southeast-2.myhuaweicloud.com/v2/{project_id}/ocr/thailand-license-plate”，“project_id”为项目ID，获取方法请参见获取项目ID 如何获取Token请参见构造请求。 请求样例（方式一：使用图片的Base64编码） POST https://{endpoint}/v2/{project_id}/ocr/thailand-license-plate Request Header: Content-Type: application/json X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG... Request Body: { "image":"/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAA..." } 请求样例（方式二：使用图片URL） POST https://{endpoint}/v2/{project_id}/ocr/thailand-license-plate Request Header: Content-Type: application/json X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG... Request Body: { "url":"https://BucketName.obs.xxxx.com/ObjectName" } Python3语言请求代码示例（其他语言参照下列示例编写或使用OCR SDK） # encoding:utf-8 import requests import base64 url = "https://{endpoint}/v2/{project_id}/ocr/thailand-license-plate" token = "用户获取得到的实际token值" headers = {'Content-Type': 'application/json', 'X-Auth-Token': token} imagepath = r'./data/thailand-license-plate-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} response = requests.post(url, headers=headers, json=payload) print(response.text)

URI POST /v2/{project_id}/ocr/thailand-license-plate 表1 路径参数 参数 是否必选 说明 endpoint 是 终端节点，即调用API的请求地址。 不同服务不同区域的endpoint不同，您可以从终端节点中获取。 例如，OCR服务在“华北-北京四”区域的“endpoint”为“ocr.cn-north-4.myhuaweicloud.com”。 project_id 是 项目ID，您可以从获取项目ID中获取。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 用于获取操作API的权限。获取Token接口响应消息头中X-Subject-Token的值即为Token。 Content-Type 是 String 发送的实体的MIME类型，参数值为“application/json”。 Enterprise-Project-Id 否 String 企业项目ID。OCR支持通过企业项目管理（EPS）对不同用户组和用户的资源使用，进行分账。 获取方法：进入“企业项目管理”页面，单击企业项目名称，在企业项目详情页获取Enterprise-Project-Id（企业项目ID）。 企业项目创建步骤请参见用户指南。 说明： 创建企业项目后，在传参时，有以下三类场景。 携带正确的ID，正常使用OCR服务，账单归到企业ID对应的企业项目中。 携带错误的ID，正常使用OCR服务，账单的企业项目会被分类为“未归集”。 不携带ID，正常使用OCR服务，账单的企业项目会被分类为“未归集”。 表3 请求Body参数 参数 是否必选 参数类型 说明 image 否 String 与url二选一。 图片的Base64编码，要求Base64编码后大小不超过10M。图片尺寸不小于15×15像素，最长边不超过8192像素，支持JPG/PNG/BMP/TIFF/JPEG格式。 图片Base64编码示例如/9j/4AAQSkZJRgABAg...，带有多余前缀会产生The image format is not supported报错。 url 否 String 与image二选一。 图片的url路径，目前支持： 公网http/https url OBS提供的url，使用OBS数据需要进行授权。包括对服务授权、临时授权、匿名公开授权，详情参见配置OBS访问权限。 说明： 接口响应时间依赖于图片的下载时间，如果图片下载时间过长，会返回接口调用失败。 请保证被检测图片所在的存储服务稳定可靠，推荐使用OBS服务存储图片数据。

响应示例 状态码：200 成功响应示例 { "result": [ { "plate_number": "京XXXXX", "plate_color": "blue", "confidence": 0.9225, "plate_location": [ [370,881], [2591,881], [2591,2281], [370,2281] ] } ] } 状态码：400 失败响应示例 { "error_code": "AIS.0103", "error_msg": "The image size does not meet the requirements." }

请求示例 “endpoint”即调用API的请求地址，不同服务不同区域的“endpoint”不同，具体请参见终端节点。 例如，车牌识别服务部署在“华北-北京四”区域的“endpoint”为“ocr.cn-north-4.myhuaweicloud.com”或“ocr.cn-north-4.myhuaweicloud.cn”，请求URL为“https://ocr.cn-north-4.myhuaweicloud.com/v2/{project_id}/ocr/license-plate”，“project_id”为项目ID，获取方法请参见获取项目ID 如何获取Token请参见认证鉴权。 传入车牌图片的base64编码进行文字识别 POST https://{endpoint}/v2/{project_id}/ocr/license-plate Request Header: Content-Type: application/json X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG... Request Body: { "image":"/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAA..."} 传入车牌图片的url进行文字识别 POST https://{endpoint}/v2/{project_id}/ocr/license-plate Request Header: Content-Type: application/json X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG... Request Body: { "url":"https://BucketName.obs.xxxx.com/ObjectName"}

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 用于获取操作API的权限。获取Token接口响应消息头中X-Subject-Token的值即为Token。 Content-Type 是 String 发送的实体的MIME类型，参数值为“application/json”。 Enterprise-Project-Id 否 String 企业项目ID。OCR支持通过企业项目管理（EPS）对不同用户组和用户的资源使用，进行分账。 获取方法：进入“企业项目管理”页面，单击企业项目名称，在企业项目详情页获取Enterprise-Project-Id（企业项目ID）。 企业项目创建步骤请参见用户指南。 说明： 创建企业项目后，在传参时，有以下三类场景。 携带正确的ID，正常使用OCR服务，账单归到企业ID对应的企业项目中。 携带错误的ID，正常使用OCR服务，账单的企业项目会被分类为“未归集”。 不携带ID，正常使用OCR服务，账单的企业项目会被分类为“未归集”。 表3 请求Body参数 参数 是否必选 参数类型 说明 image 否 String 该参数与url二选一。 图片的Base64编码，要求Base64编码后大小不超过10MB。 图片最短边不小于15px，最长边不超过4096px，支持JPEG、JPG、PNG、BMP、TIFF格式。 图片Base64编码示例如/9j/4AAQSkZJRgABAg...，带有多余前缀会产生The image format is not supported报错。 url 否 String 该参数与image二选一。图片的url路径，目前支持： 公网http/https url OBS提供的url，使用OBS数据需要进行授权。包括对服务授权、临时授权、匿名公开授权，详情参见配置OBS访问权限。 说明： 接口响应时间依赖于图片的下载时间，如果图片下载时间过长，会返回接口调用失败。 请保证被检测图片所在的存储服务稳定可靠，推荐使用OBS服务存储图片数据。 url中不能存在中文字符，若存在，中文需要进行utf8编码。

响应参数 根据识别的结果，可能有不同的HTTP响应状态码（status code）。例如，200表示API调用成功，400表示调用失败，详细的状态码和响应参数说明如下。 状态码： 200 表4 响应Body参数 参数 参数类型 描述 result Array of LicensePlateResult objects 识别结果。 调用失败时不返回此字段。 表5 LicensePlateResult 参数 参数类型 描述 plate_number String 车牌内容。 plate_color String 当前版本支持的车牌底色类型： blue：蓝色 green：绿色（小型新能源车牌） black：黑色 white：白色 yellow：黄色 yellow_green: 黄绿（大型新能源车牌） plate_location Array of integers 车牌的区域位置信息，列表形式，包含文字区域四个顶点的二维坐标（x,y）；采用图像坐标系，坐标原点为图片左上角，x轴沿水平方向，y轴沿竖直方向。 confidence Float 字段的置信度，取值范围0~1。 置信度越大，本次识别的字段的可靠性越高，在统计意义上，置信度越大，准确率越高。 置信度由算法给出，不直接等价于字段的准确率。 状态码： 400 表6 响应Body参数 参数 参数类型 说明 error_code String 调用失败时的错误码，具体请参见错误码。 当出现错误码“ModelArts.4204”时，请参考为什么调用API时提示“ModelArts.4204”？章节。 调用成功时不返回此字段。 error_msg String 调用失败时返回的错误信息。 调用成功时不返回此字段。

URI POST /v2/{project_id}/ocr/license-plate 表1 路径参数 参数 是否必选 说明 endpoint 是 终端节点，即调用API的请求地址。 不同服务不同区域的endpoint不同，您可以从终端节点中获取。 例如，OCR服务在“华北-北京四”区域的“endpoint”为“ocr.cn-north-4.myhuaweicloud.com”。 project_id 是 项目ID，您可以从获取项目ID中获取。

请求示例 “endpoint”即调用API的请求地址，不同服务不同区域的“endpoint”不同，具体请参见终端节点。 例如，火车票识别服务部署在“华北-北京四”区域的“endpoint”为“ocr.cn-north-4.myhuaweicloud.com”或“ocr.cn-north-4.myhuaweicloud.cn”，请求URL为“https://ocr.cn-north-4.myhuaweicloud.com/v2/{project_id}/ocr/train-ticket”，“project_id”为项目ID，获取方法请参见获取项目ID 如何获取Token请参见认证鉴权。 传入火车票图片的base64编码进行文字识别 POST https://{endpoint}/v2/{project_id}/ocr/train-ticket Request Header: Content-Type: application/json X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG... Request Body: { "image":"/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAA..." } 传入火车票图片的url进行文字识别 POST https://{endpoint}/v2/{project_id}/ocr/train-ticket Request Header: Content-Type: application/json X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG... Request Body: { "url":"https://BucketName.obs.xxxx.com/ObjectName" }

响应示例 状态码：200 成功响应示例 { "result" : { "ticket_id" : "K090841", "check_port" : "B6", "train_number" : "G1138", "departure_station" : "长沙南站", "destination_station" : "武汉站", "departure_station_en" : "Changshanan", "destination_station_en" : "Wuhan", "departure_time" : "2017年12月12日20:39", "seat_number" : "03车03C号", "ticket_price" : "164.5元", "sale_method" : "网", "seat_category" : "二等座", "ticket_changing" : "No", "id_number" : "1402271998****0012", "name" : "xxx", "log_id" : "65818301991213K090841", "sale_location" : "长沙南售", "invoice_style" : "paper", "issue_date" : "", "discount_mark" : "", "serial_number" : "", "tax_amount" : "", "tax_rate" : "", "air_conditioning" : "", "original_invoice_number" : "", "unified_social_credit_code" : "", "buyer_name" : "", "total_amount_excluding_tax" : "", "invoice_number" : "", "seal_mark" : false, "title" : "", "area" : "", "receipt_number" : "", "amount_in_figures" : "", "amount_in_words" : "", "confidence" : { "ticket_id" : 0.9992, "check_port" : 0.9165, "train_number" : 0.9968, "starting_station" : 0.9982, "destination_station" : 0.9998, "starting_station_en" : 0.9254, "destination_station_en" : 0.9848, "starting_time" : 0.5141, "seat_number" : 0.9985, "ticket_rates" : 0.9977, "sale_method" : 0.9836, "seat_category" : 0.9958, "ticket_changing" : 0.9, "id_number" : 0.9986, "name" : 0.996, "log_id" : 0.9968, "ticket_office" : 0.9984, "issue_date" : 0, "discount_mark" : 0, "serial_number" : 0, "tax_amount" : 0, "tax_rate" : 0, "air_conditioning" : 0, "original_invoice_number" : 0, "unified_social_credit_code" : 0, "buyer_name" : 0, "total_amount_excluding_tax" : 0, "invoice_number" : 0, "seal_mark" : false, "title" : 0, "area" : 0, "receipt_number" : 0, "amount_in_figures" : 0, "amount_in_words" : 0 } } } 状态码：400 失败响应示例 { "error_code": "AIS.0103", "error_msg": "The image size does not meet the requirements." }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 用于获取操作API的权限。获取Token接口响应消息头中X-Subject-Token的值即为Token。 Content-Type 是 String 发送的实体的MIME类型，参数值为“application/json”。 Enterprise-Project-Id 否 String 企业项目ID。OCR支持通过企业项目管理（EPS）对不同用户组和用户的资源使用，进行分账。 获取方法：进入“企业项目管理”页面，单击企业项目名称，在企业项目详情页获取Enterprise-Project-Id（企业项目ID）。 企业项目创建步骤请参见用户指南。 说明： 创建企业项目后，在传参时，有以下三类场景。 携带正确的ID，正常使用OCR服务，账单归到企业ID对应的企业项目中。 携带错误的ID，正常使用OCR服务，账单的企业项目会被分类为“未归集”。 不携带ID，正常使用OCR服务，账单的企业项目会被分类为“未归集”。 表3 请求Body参数 参数 是否必选 参数类型 说明 image 否 String 该参数与url二选一。 图片的Base64编码，要求Base64编码后大小不超过10MB。 图片最短边不小于15px，最长边不超过8192px，支持JPEG、JPG、PNG、BMP、TIFF格式。 图片Base64编码示例如/9j/4AAQSkZJRgABAg...，带有多余前缀会产生The image format is not supported报错。 url 否 String 该参数与image二选一。图片的url路径，目前支持： 公网http/https url OBS提供的url，使用OBS数据需要进行授权。包括对服务授权、临时授权、匿名公开授权，详情参见配置OBS访问权限。 说明： 接口响应时间依赖于图片的下载时间，如果图片下载时间过长，会返回接口调用失败。 请保证被检测图片所在的存储服务稳定可靠，推荐使用OBS服务存储图片数据。 url中不能存在中文字符，若存在，中文需要进行utf8编码。 return_text_location 否 Boolean 识别到的文字块的区域位置信息。可选值包括： true：返回各个文字块区域 false：不返回各个文字块区域 如果无该参数，系统默认不返回文字块区域。如果输入参数不是Boolean类型，则会报非法参数错误。

响应参数 根据识别的结果，可能有不同的HTTP响应状态码（status code）。例如，200表示API调用成功，400表示调用失败，详细的状态码和响应参数说明如下。 状态码： 200 表4 响应Body参数 参数 参数类型 描述 result TrainTicketResult object 识别结果。 调用失败时不返回此字段。 表5 TrainTicketResult 参数 参数类型 描述 归属 ticket_id String 火车票左上角的车票ID。 纸质火车票/新版退票 check_port String 检票口信息。 纸质火车票/新版退票 train_number String 车次。 纸质火车票/新版退票/电子发票 departure_station String 始发站。 纸质火车票/新版退票/电子发票 destination_station String 终点站。 纸质火车票/新版退票/电子发票 departure_station_en String 始发站拼音。 纸质火车票/新版退票/电子发票 destination_station_en String 终点站拼音。 纸质火车票/新版退票/电子发票 departure_time String 开车时间。 纸质火车票/新版退票/电子发票 seat_number String 座位号。 纸质火车票/新版退票/电子发票 ticket_price String 票价。 纸质火车票/新版退票/电子发票 sale_method String 售票方式。 纸质火车票/新版退票 seat_category String 座位类别。 纸质火车票/新版退票/电子发票 ticket_changing String 改签信息。 纸质火车票/新版退票 id_number String 车票持有人的身份证号。 纸质火车票/新版退票/电子发票 name String 车票持有人姓名。 纸质火车票/新版退票/电子发票 log_id String 车票最下方的售票码。 纸质火车票/新版退票 sale_location String 车票售票地点。 纸质火车票/新版退票 invoice_style String 类型。包含以下几种类型： paper：纸质火车票 electronic：电子发票 refund_old：旧版退票凭证 refund_new：新版退票凭证 共享字段 issue_date String 开票时间。 电子发票 discount_mark String 打折标识。 电子发票 serial_number String 电子客票号。 电子发票 tax_amount String 税金价格。 电子发票 tax_rate String 税率。 电子发票 air_conditioning String 是否是空调车厢。 电子发票 original_invoice_number String 原发票号码。 电子发票 unified_social_credit_code String 统一社会信用号码。 电子发票 buyer_name String 购买方名称。 电子发票 total_amount_excluding_tax String 不含税价格 电子发票 invoice_number String 发票号码。 电子发票 seal_mark Boolean 是否有印章，True表示有印章，False表示不含印章，字段默认为False。 旧版退票 title String 标题。 旧版退票 area String 地区。 旧版退票 receipt_number String 收据编码。 旧版退票 amount_in_figures String 小写票据金额。 旧版退票 amount_in_words String 大写票据金额。 旧版退票 confidence Object 字段的置信度，取值范围0~1。 置信度越大，本次识别的字段的可靠性越高，在统计意义上，置信度越大，准确率越高。 置信度由算法给出，不直接等价于字段的准确率。 共享字段 text_location Object 对应所有在原图上识别到的字段位置信息，包含所有文字区域四个顶点的二维坐标（x,y）。采用图像坐标系，坐标原点为图片左上角，x轴沿水平方向，y轴沿竖直方向。 共享字段 状态码： 400 表6 响应Body参数 参数 参数类型 说明 error_code String 调用失败时的错误码，具体请参见错误码。 当出现错误码“ModelArts.4204”时，请参考为什么调用API时提示“ModelArts.4204”？章节。 调用成功时不返回此字段。 error_msg String 调用失败时返回的错误信息。 调用成功时不返回此字段。

URI POST /v2/{project_id}/ocr/train-ticket 表1 路径参数 参数 是否必选 说明 endpoint 是 终端节点，即调用API的请求地址。 不同服务不同区域的endpoint不同，您可以从终端节点中获取。 例如，OCR服务在“华北-北京四”区域的“endpoint”为“ocr.cn-north-4.myhuaweicloud.com”。 project_id 是 项目ID，您可以从获取项目ID中获取。

响应示例 状态码：200 成功响应示例 { "result": { "code": "11XXXXXXXX88", "number": "56XXXXX08", "entry": "吴各庄南线出京", "exit": "顺义城站", "cashier": "213", "vehicle_type": "A", "date": "2017-12-04", "time": "18:45:10", "amount": "15", "confidence": { "code": 0.9957, "number": 0.9497, "exit": 0.9662, "cashier": 0.987, "vehicle_type": 0.9639, "entry": 0.9985, "date": 0.9974, "time": 0.9984, "amount": 0.9943 } } } 状态码：400 失败响应示例 { "error_code": "AIS.0103", "error_msg": "The image size does not meet the requirements." }

响应参数 根据识别的结果，可能有不同的HTTP响应状态码（status code）。例如，200表示API调用成功，400表示调用失败，详细的状态码和响应参数说明如下。 状态码： 200 表4 响应Body参数 参数 参数类型 描述 result TollInvoiceResult object 识别结果。 调用失败时不返回此字段。 表5 TollInvoiceResult 参数 参数类型 描述 code String 发票代码。 number String 发票号码。 entry String 入口。 exit String 出口。 amount String 收费金额。 cashier String 收费员。 vehicle_type String 车辆类型。 date String 日期。 time String 时间。 confidence Object 字段的置信度，取值范围0~1。 置信度越大，本次识别的字段的可靠性越高，在统计意义上，置信度越大，准确率越高。 置信度由算法给出，不直接等价于字段的准确率。 text_location Object 对应所有在原图上识别到的字段位置信息，包含所有文字区域四个顶点的二维坐标（x,y）。采用图像坐标系，坐标原点为图片左上角，x轴沿水平方向，y轴沿竖直方向。 状态码： 400 表6 响应Body参数 参数 参数类型 说明 error_code String 调用失败时的错误码，具体请参见错误码。 当出现错误码“ModelArts.4204”时，请参考为什么调用API时提示“ModelArts.4204”？章节。 调用成功时不返回此字段。 error_msg String 调用失败时返回的错误信息。 调用成功时不返回此字段。

请求示例 “endpoint”即调用API的请求地址，不同服务不同区域的“endpoint”不同，具体请参见终端节点。 例如，车辆通行费发票识别服务部署在“华北-北京四”区域的“endpoint”为“ocr.cn-north-4.myhuaweicloud.com”或“ocr.cn-north-4.myhuaweicloud.cn”，请求URL为“https://ocr.cn-north-4.myhuaweicloud.com/v2/{project_id}/ocr/toll-invoice”，“project_id”为项目ID，获取方法请参见获取项目ID 如何获取Token请参见认证鉴权。 传入车辆通行费发票图片的base64编码进行文字识别 POST https://{endpoint}/v2/{project_id}/ocr/toll-invoice Request Header: Content-Type: application/json X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG... Request Body: { "image":"/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAAgAB..." } 传入车辆通行费发票图片的url进行文字识别 POST https://{endpoint}/v2/{project_id}/ocr/toll-invoice Request Header: Content-Type: application/json X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG... Request Body: { "url":"https://BucketName.obs.xxxx.com/ObjectName" }

URI POST /v2/{project_id}/ocr/toll-invoice 表1 路径参数 参数 是否必选 说明 endpoint 是 终端节点，即调用API的请求地址。 不同服务不同区域的endpoint不同，您可以从终端节点中获取。 例如，OCR服务在“华北-北京四”区域的“endpoint”为“ocr.cn-north-4.myhuaweicloud.com”。 project_id 是 项目ID，您可以从获取项目ID中获取。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 用于获取操作API的权限。获取Token接口响应消息头中X-Subject-Token的值即为Token。 Content-Type 是 String 发送的实体的MIME类型，参数值为“application/json”。 Enterprise-Project-Id 否 String 企业项目ID。OCR支持通过企业项目管理（EPS）对不同用户组和用户的资源使用，进行分账。 获取方法：进入“企业项目管理”页面，单击企业项目名称，在企业项目详情页获取Enterprise-Project-Id（企业项目ID）。 企业项目创建步骤请参见用户指南。 说明： 创建企业项目后，在传参时，有以下三类场景。 携带正确的ID，正常使用OCR服务，账单归到企业ID对应的企业项目中。 携带错误的ID，正常使用OCR服务，账单的企业项目会被分类为“未归集”。 不携带ID，正常使用OCR服务，账单的企业项目会被分类为“未归集”。 表3 请求Body参数 参数 是否必选 参数类型 说明 image 否 String 该参数与url二选一。 图片的Base64编码，要求Base64编码后大小不超过10MB。 图片最短边不小于15px，最长边不超过4096px，支持JPEG、JPG、PNG、BMP、TIFF格式。 图片Base64编码示例如/9j/4AAQSkZJRgABAg...，带有多余前缀会产生The image format is not supported报错。 url 否 String 该参数与image二选一。图片的url路径，目前支持： 公网http/https url OBS提供的url，使用OBS数据需要进行授权。包括对服务授权、临时授权、匿名公开授权，详情参见配置OBS访问权限。 说明： 接口响应时间依赖于图片的下载时间，如果图片下载时间过长，会返回接口调用失败。 请保证被检测图片所在的存储服务稳定可靠，推荐使用OBS服务存储图片数据。 url中不能存在中文字符，若存在，中文需要进行utf8编码。 return_text_location 否 Boolean 识别到的文字块的区域位置信息。可选值包括： true：返回各个文字块区域 false：不返回各个文字块区域 如果无该参数,系统默认不返回文字块区域。如果输入参数不是Boolean类型,则会报非法参数错误。

修订记录 发布日期 修改说明 2023-09 支持不动产证识别、承兑汇票识别、车辆合格证识别。 2023-08 支持智能文档解析。 2023-07 中国站账号支持开通泰文身份证识别API。 2023-06 车牌识别API支持识别大型新能源车型。 2023-05 智能分类识别支持全电发票。 2023-05 支持用户自定义模板，对于版式固定的各种票据和卡证，通过可视化界面、API进行识别。 2023-04 财务报表识别API支持通过透视变换矩阵计算文字在原图的坐标。 2023-03 通用文字识别API支持阿拉伯语识别功能。 2023-01 营业执照识别API支持使用PDF进行识别。 2023-01 通用表格识别API支持通过透视变换矩阵计算文字在原图的坐标。 2023-01 通用文字识别API支持马来语、乌克兰语、印地语…识别功能。 2022-11 发票验真API，支持查验全电发票。 2022-11 北京一、北京四、上海一区域部署的API支持企业项目管理，可按不同企业项目分别进行财务统计。 2022-10 OCR上海一Region新增：增值税发票识别、通用文字识别、营业执照识别、车牌识别、道路运输从业资格证识别。 2022-09 防疫健康码识别正式推出三码合一功能，只需要调用1个接口，即可智能结构化识别健康码、核酸检测记录、行程卡等页面信息。 2022-08 OCR上海一Region新增：保险单识别、机动车销售发票识别、道路运输证识别。 2022-08 身份证识别新增翻拍告警功能。 2022-08 网络图片识别支持字体类型检测、支持竖行文本识别、支持多朝向文本识别。 2022-08 OCR支持企业项目管理，支持不同企业项目分别进行财务统计，当前支持北京四区域部署的API。 2022-07 增值税发票识别服务升级，type字段新增"special_electronic"返回类型。 2022-05 新增 核酸检测记录识别 2022-05 新增 防疫健康码识别 2022-03 增值税发票识别API支持识别pdf、ofd、tiff等文件。 2022-02 驾驶证识别API支持电子驾驶证识别。 2021-12 新增 道路运输从业资格证识别 2021-10 新增 保险单识别 财务报表识别 2021-09 新增 发票验真 2021-08 身份证识别功能优化。 2021-02 车牌识别功能优化。 2020-12 请求URI由v1.0接口统一切换成v2接口。 飞机行程单识别功能优化。 2020-10 增加服务部署区域。 2020-08 银行卡识别功能优化。 2020-07 行驶证、驾驶证功能优化。 通用表格识别功能优化。 2020-06 新增 名片识别 VIN码识别 2019-09-12 新增 智能分类识别 2019-07-23 新增 车辆通行费发票识别 飞机行程单识别 定额发票识别 火车票识别 银行卡识别 营业执照识别 护照识别 道路运输证识别 网络图片识别 出租车发票识别 2019-07-01 优化错误码章节。 2019-05-29 优化 使用前必读 如何调用API 2019-02-02 将文字识别对应“endpoint”修改为“ocr.cn-north-1.myhuaweicloud.com”。 2019-01-02 修改 增值税发票识别，修改请求参数图片像素。 2018-09-12 新增 使用前必读，介绍文档的阅读流程。 API概览，介绍服务提供的接口信息。 2018-08-03 修改 机动车销售发票识别，增加了机打和大写合计信息。 2018-07-30 修改 删除银行卡识别、一维码识别和二维码识别相关内容。 2018-03-27 新增 通用文字识别 2018-03-15 新增 车牌识别 机动车销售发票识别 2018-02-27 新增 银行卡识别 2018-02-01 修改 增值税发票识别 2017-12-21 新增 通用表格识别 手写文字识别 驾驶证识别 行驶证识别 2017-12-14 新增 身份证识别 2017-11-30 第一次正式发布。

请求示例 Endpoint即调用API的请求地址，不同服务不同区域的Endpoint不同，具体请参见终端节点。 例如，财务报表识别服务部署在“华东-上海一”区域的“endpoint”为“ocr.cn-east-3.myhuaweicloud.com”或“ocr.cn-north-4.myhuaweicloud.cn”，请求URL为“https://ocr.cn-east-3.myhuaweicloud.com/v2/{project_id}/ocr/insurance-policy”，“project_id”为项目ID，获取方法请参见获取项目ID。 如何获取Token请参见认证鉴权。 传入财务报表图片的base64编码进行文字识别 POST https://{endpoint}/v2/{project_id}/ocr/financial-statement Request Header: Content-Type: application/json X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG... Request Body: { "image" : "/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAA..." } 传入财务报表图片的url进行文字识别 POST https://{endpoint}/v2/{project_id}/ocr/financial-statement Request Header: Content-Type: application/json X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG... Request Body: { "url" : "/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAA..." }

响应示例 状态码： 200 成功响应样例 { "result" : { "words_region_count" : 2, "words_region_list" : [ { "type" : "text", "words_block_count" : 1, "words_block_list" : [ { "words" : "文字区域识别文字块1", "confidence" : 0.999 } ] }, { "type" : "table", "table_location" : [ [ 120, 106 ], [ 200, 106 ], [ 200, 351 ], [ 120, 351 ] ], "words_block_count" : 2, "words_block_list" : [ { "words" : "负债和所有者权益（或股东权益）", "confidence" : 0.9963, "rows" : [ 0 ], "columns" : [ 0 ] }, { "words" : "行次", "confidence" : 0.9999, "rows" : [ 0 ], "columns" : [ 1 ] } ] } ], "excel" : "AQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKg…", "image_size" : { "height" : 2501, "width" : 1701 } } } 状态码： 400 失败响应样例 { "error_code" : "AIS.0103", "error_msg" : "The image size does not meet the requirements." }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 用于获取操作API的权限。获取Token接口响应消息头中X-Subject-Token的值即为Token。 Content-Type 是 String 发送的实体的MIME类型，参数值为“application/json”。 表3 请求Body参数 参数 是否必选 参数类型 描述 image 否 String 与url二选一。 图片的Base64编码，要求Base64编码后大小不超过10MB。 图片最短边不小于15px，最长边不超过8192px，支持JPEG、JPG、PNG、BMP、TIFF格式。 图片Base64编码示例如/9j/4AAQSkZJRgABAg...，带有多余前缀会产生The image format is not supported报错。 url 否 String 与image二选一。 图片的URL路径，目前支持： 公网http/https url OBS提供的url，使用OBS数据需要进行授权。包括对服务授权、临时授权、匿名公开授权，详情参见配置OBS访问权限。 说明： 接口响应时间依赖于图片的下载时间，如果图片下载时间过长，会返回接口调用失败。 请保证被检测图片所在的存储服务稳定可靠，推荐使用OBS服务存储图片数据。 url中不能存在中文字符，若存在，中文需要进行utf8编码。 return_text_location 否 Boolean 返回文本块坐标及单元格坐标信息，可选值包括： true：返回文本块和单元格坐标; false：不返回。 未传入该参数时默认为false，即不返回。 return_confidence 否 Boolean 返回字段识别置信度，小数点后四位。可选值包括： true：返回字段置信度; false：不返回。 未传入该参数时默认为false，即不返回字段置信度。 return_excel 否 Boolean 是否返回表格转换Microsoft Excel的Base64编码字段。可选值包括： true：返回’excel’字段，表示xlsx格式的表格识别结果的Base64编码; false：不返回。 对返回的Excel编码，可用Python函数 base64.b64decode解码后保存为xlsx文件。 return_table_location 否 Boolean 返回表格坐标，可选值包括： true：返回表格坐标; false：不返回。 未传入该参数时默认为false，即不返回。 return_image_size 否 Boolean 返回矫正后的图像大小，可选值包括： true：返回矫正图像大小; false：不返回。 未传入该参数时默认为false，即不返回。 return_rectification_matrix 否 Boolean 透视变换矩阵，可选值包括： true：返回透视变换矩阵; false：不返回。 说明： 说明：未传入该参数时默认为false，即不返回透视变换矩阵。

URI POST /v2/{project_id}/ocr/financial-statement 表1 路径参数 参数 是否必选 说明 endpoint 是 终端节点，即调用API的请求地址。 不同服务不同区域的endpoint不同，您可以从终端节点中获取。 例如，OCR服务在“华北-北京四”区域的“endpoint”为“ocr.cn-north-4.myhuaweicloud.com”。 project_id 是 项目ID，您可以从获取项目ID中获取。

终端节点 终端节点即调用API的请求地址，不同服务不同区域的终端节点不同，您可以从地区和终端节点中查询所有服务的终端节点。 文字识别的终端节点如表1所示，请您根据业务需要选择对应区域的终端节点。 业务的服务器部署区域与OCR服务区域不一致，只要服务器可以访问公网，即可使用OCR服务。一般情况下，建议就近选择靠近您或者您的目标用户的区域，这样可以减少网络时延，提高访问速度。 表1 文字识别的终端节点 区域名称 区域 终端节点（Endpoint） 部署服务 华北-北京一 cn-north-1 ocr.cn-north-1.myhuaweicloud.com ocr.cn-north-1.myhuaweicloud.cn 身份证识别、驾驶证识别、行驶证识别、增值税发票识别、通用表格识别、通用文字识别、手写文字识别、机动车销售发票识别、银行卡识别、护照识别、车辆通行费发票识别、飞机行程单识别、定额发票识别、火车票识别、营业执照识别、道路运输证识别、出租车发票识别、自定义模板OCR 华北-北京四 cn-north-4 ocr.cn-north-4.myhuaweicloud.com ocr.cn-north-4.myhuaweicloud.cn 身份证识别、驾驶证识别、行驶证识别、增值税发票识别、机动车销售发票识别、通用表格识别、通用文字识别、手写文字识别、车辆通行费发票识别、飞机行程单识别、定额发票识别、出租车发票识别、火车票识别、营业执照识别、银行卡识别、护照识别、道路运输证识别、智能分类识别、车牌识别、名片识别、VIN码识别、网络图片识别、发票验真、保险单识别、防疫健康码识别、核酸检测记录识别、自定义模板OCR、智能文档解析、不动产证识别、承兑汇票识别、车辆合格证识别、印章识别 华南-广州 cn-south-1 ocr.cn-south-1.myhuaweicloud.com ocr.cn-south-1.myhuaweicloud.cn 网络图片识别、不动产证识别、承兑汇票识别 华东-上海一 cn-east-3 ocr.cn-east-3.myhuaweicloud.com ocr.cn-east-3.myhuaweicloud.cn 网络图片识别、身份证识别、驾驶证识别、行驶证识别、银行卡识别、通用表格识别、发票验真、财务报表识别、电子面单识别、保险单识别、机动车销售发票识别、道路运输证识别、增值税发票识别、通用文字识别、营业执照识别、车牌识别、道路运输从业资格证识别、自定义模板OCR 亚太-曼谷 ap-southeast-2 ocr.ap-southeast-2.myhuaweicloud.com ocr.ap-southeast-2.myhuaweicloud.cn 泰文身份证识别、泰国车牌识别 拉美-圣地亚哥 la-south-2 ocr.la-south-2.myhuaweicloud.com ocr.la-south-2.myhuaweicloud.cn 哥伦比亚身份证识别 拉美-墨西哥城二 la-north-2 ocr.la-north-2.myhuaweicloud.com 哥伦比亚身份证识别 父主题： 使用前必读

请求示例 “endpoint”即调用API的请求地址，不同服务不同区域的“endpoint”不同，具体请参见终端节点。 例如，护照识别服务部署在“华北-北京四”区域的“endpoint”为“ocr.cn-north-4.myhuaweicloud.com或ocr.cn-north-4.myhuaweicloud.cn”，请求URL为“https://ocr.cn-north-4.myhuaweicloud.com/v2/{project_id}/ocr/passport”，“project_id”为项目ID，获取方法请参见获取项目ID 如何获取Token请参见认证鉴权。 读取护照图片的base64编码进行文字识别 POST https://{endpoint}/v2/{project_id}/ocr/passport Request Header: Content-Type: application/json X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG... Request Body: { "image":"/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAA...", "country_code": "GENERAL" } 读取护照图片的url进行文字识别 POST https://{endpoint}/v2/{project_id}/ocr/passport Request Header: Content-Type: application/json X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG... Request Body: { "url":"https://BucketName.obs.xxxx.com/ObjectName", "country_code": "GENERAL" }

响应参数 根据识别的结果，可能有不同的HTTP响应状态码（status code）。例如，200表示API调用成功，400表示调用失败，详细的状态码和响应参数说明如下。 状态码： 200 表4 响应Body参数 参数 参数类型 描述 result PassportResult object 识别结果。 调用失败时不返回此字段。 该结果中包含：13个主要字段，由英文表达；extra_info由本地官方语言表达；主要字段的置信度。置信度越大，字段的值越准确。 表5 PassportResult 参数 参数类型 描述 passport_type String 护照类型。 P:普通因私护照 W:外交护照 G:公务护照 说明： 该字段仅限中国大陆护照。 country_code String 护照签发国的国家码。 passport_number String 护照号码。 nationality String 护照持有人国籍。 说明： 该字段仅限中国大陆护照。 surname String 姓。 given_name String 名字。 sex String 性别。 date_of_birth String 出生日期。返回值例如，1990-12-12。 date_of_expiry String 护照有效期。返回值例如，2020-07-08。 date_of_issue String 护照签发日期。返回值例如，2010-07-09。 说明： 该字段仅限中国大陆护照。 place_of_birth String 出生地。 说明： 该字段仅限中国大陆护照。 place_of_issue String 签发地。 说明： 该字段仅限中国大陆护照。 issuing_authority String 签发机关。 因为各个领事馆签发机关简写未统一，所以服务统一对中国的英文简写处理为“P.R.China”。例如：有的签发机关是“P.R.C”，识别结果均显示“P.R.China”。 说明： 该字段仅限中国大陆护照。 confidence Object 字段的置信度，取值范围0~1。 置信度越大，表示识别的字段的可靠性越高，在统计意义上，置信度越大，准确率越高。 置信度由算法给出，不直接等价于字段的准确率。 extra_info Object 参数值默认为空。对于中国护照，“extra_info”的值会包含护照上由汉字描述的字段信息，如姓名、出生地等信息。 说明： 该字段仅限中国大陆护照。 状态码： 400 表6 响应Body参数 参数 参数类型 说明 error_code String 调用失败时的错误码，具体请参见错误码。 当出现错误码“ModelArts.4204”时，请参考为什么调用API时提示“ModelArts.4204”？章节。 调用成功时不返回此字段。 error_msg String 调用失败时返回的错误信息。 调用成功时不返回此字段。

URI POST /v2/{project_id}/ocr/passport 表1 路径参数 参数 是否必选 说明 endpoint 是 终端节点，即调用API的请求地址。 不同服务不同区域的endpoint不同，您可以从终端节点中获取。 例如，OCR服务在“华北-北京四”区域的“endpoint”为“ocr.cn-north-4.myhuaweicloud.com”。 project_id 是 项目ID，您可以从获取项目ID中获取。