华为云用户手册

请求参数 表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、GIF、WEBP格式。 图片文件Base64编码字符串，单击这里查看详细获取方式。 url 否 String 与image二选一 图片的URL路径，目前支持： 公网http/https url OBS提供的url，使用OBS数据需要进行授权。包括对服务授权、临时授权、匿名公开授权，详情参见配置OBS访问权限。 说明： 接口响应时间依赖于图片的下载时间，如果图片下载时间过长，会返回接口调用失败。 请保证被检测图片所在的存储服务稳定可靠，推荐使用OBS服务存储图片数据。 template_id 否 String 该参数与classifier_id二选一。 模型id，如果传入，启用单模板识别模式。 classifier_id 否 String 该参数与template_id二选一。 分类器id，如果传入，启用多模板识别模式。 classifier_mode 否 Boolean 该参数与classifier_id参数配合使用，可选值如下所示： true：仅返回模板分类结果 false：正常返回多模板识别结果 说明： 如果未传入该参数时默认为false，即正常返回多模板识别结果。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 result Object 调用成功时表示调用结果。 调用失败时无此字段。 template_id String 调用成功时返回调用模板id。 调用失败时无此字段。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 调用失败时的错误码，具体请参见错误码。 调用成功时无此字段。 error_msg String 调用失败时的错误信息。 调用成功时无此字段。

约束与限制 只支持识别PNG、JPG、PNG、BMP、TIFF、GIF、WEBP格式图片。 图像各边的像素大小在100px到8000px之间。 图像中识别区域有效占比超过80%，保证整张表格及其边缘包含在图像内。 支持图像任意角度的水平旋转。 目前不支持复杂背景（如户外自然场景、防伪水印等）和表格线扭曲图像的 文字识别 。 支持中英文以及部分繁体字。 API支持识别的图片版式依赖于创建自定义OCR工作流时的类型。

URI POST /v2/{project_id}/ocr/custom-template 表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/pcr-test-record”，“project_id”为项目ID，获取方法请参见获取项目ID。 如何获取Token请参见认证鉴权。 传入核酸检测记录图片的base64编码进行文字识别 POST https://ocr.cn-north-4.myhuaweicloud.com/v2/{project_id}/ocr/pcr-test-record Request Header: Content-Type: application/json X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG... Request Body: { "image" : "/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAA..." }

约束与限制 支持全国不同地区健康码小程序中的核酸检测记录界面的识别。 支持识别PNG、JPG、JPEG、BMP、TIFF格式图片。 图像各边的像素大小在15px到8192px之间。 图像中核酸检测记录区域有效占比超过80%，保证整张核酸检测记录内容及其边缘包含在图像内。 推荐采用手机截图图像。 支持图像中核酸检测记录界面任意角度的水平旋转（需开启方向检测）。 能处理反光、暗光等干扰的图片但影响识别精度。 目前只支持识别单张核酸检测记录界面。

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

功能介绍 支持对全国各地不同版式的核酸检测记录中的4个关键字段进行结构化识别，包括姓名、核酸检测采样时间、检测检测结果更新时间、核酸检测结果（阳性、阴性、未知） 图1 核酸检测记录版式示例 防疫健康码识别已推出三码合一功能（健康码、核酸检测记录、行程卡）。相比于核酸检测记录识别API，您只需要调用1个接口，即可智能结构化识别健康码、核酸检测记录、行程卡等页面信息，包括防疫码类别、姓名、身份证号码、手机号码、省份、城市、健康码或行程卡的更新时间、健康码或行程卡颜色、疫苗接种情况、核酸检测结果、核酸检测机构、核酸检测结果更新时间、核酸检测采样时间、行程卡的途经地址等14个关键字段。

请求参数 表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 图片的Base64编码，图片尺寸不小于15×15像素，最长边不超过8192像素，支持JPG/PNG/BMP/TIFF格式。 图片Base64编码示例如/9j/4AAQSkZJRgABAg...，带有多余前缀会产生The image format is not supported报错。 url 否 String 与image二选一 图片的URL路径，目前仅支持华为云上OBS提供的匿名公开授权访问的URL以及公网URL。 detect_direction 否 Boolean 是否校正图片的倾斜角度，可选值如下： true：校正图片的倾斜角度 false：不校正图片的倾斜角度 支持任意角度的校正，未传入该参数时默认为“false”。 待识别图片如果存在倾斜，建议将此参数设置为“true”。

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

响应示例 状态码： 200 成功响应样例 { "result" : { "issue_date" : "20xx-07-10", "bill_status" : "背书待签收", "due_date" : "20xx-01-10", "bill_number" : "130212XXX", "issuer_account" : "811180XXX", "payee_account" : "793201XXX", "issuer_full_name" : "XX集团有限公司", "issuer_bank_name" : "XX银行股份有限公司XX支行", "issuer_bank_number" : "302121XXX", "payee_full_name" : "XX有限公司", "payee_bank_name" : "XX银行股份有限公司XX分行", "payee_bank_number" : "303124XXX", "amount_in_figures" : "￥XXX", "amount_in_words" : "XXX元整", "acceptor_bank_name" : "XX银行XX分行", "acceptor_full_name" : "XX银行XX分行", "acceptor_bank_number" : "302121XXX", "issuer_commitment" : "本汇票请予以承兑，到期无条件付款", "acceptor_commitment" : "本汇票已经承兑，到期无条件付款", "assignability" : "可再转让", "acceptance_date" : "20xx-07-10", "issuance_guarantor_name" : "xx", "issuance_guarantor_address" : "xx", "issuance_guarantor_account" : "xx", "issuance_guarantee_date" : "xx", "issuance_guarantor_bank_number" : "xx", "issuance_guarantor_bank_name" : "xx", "acceptor_account" : "xx", "contract_number" : "xx", "acceptance_guarantor_name" : "xx", "acceptance_guarantor_address" : "xx", "acceptance_guarantor_account" : "xx", "acceptance_guarantee_date" : "xx", "acceptance_guarantor_bank_number" : "xx", "acceptance_guarantor_bank_name" : "xx", "issuer_rating_entity" : "xx", "issuer_credit_rating" : "xx", "issuer_rating_due_date" : "xx", "acceptor_rating_entity" : "xx", "acceptor_credit_rating" : "xx", "acceptor_rating_due_date" : "xx", "remarks" : "xxx", "bill_package_number" : "xx", "confidence" : { "issue_date" : 0.9998, "bill_status" : 0.9997, "due_date" : 0.9999, "bill_number" : 1.0, "issuer_account" : 1.0, "payee_account" : 1.0, "issuer_full_name" : 1.0, "issuer_bank_name" : 0.9999, "issuer_bank_number" : 0.999, "payee_full_name" : 1.0, "payee_bank_name" : 0.9999, "payee_bank_number" : 0.9999, "amount_in_figures" : 0.9999, "amount_in_words" : 0.9998, "acceptor_account" : 0.0, "acceptor_bank_name" : 0.9997, "acceptor_full_name" : 0.9999, "acceptor_bank_number" : 0.9998, "issuer_commitment" : 0.9998, "acceptor_commitment" : 1.0, "assignability" : 1.0, "acceptance_date" : 1.0, "issuance_guarantor_name" : 0.0, "issuance_guarantor_address" : 0.0, "issuance_guarantor_account" : 0.0, "issuance_guarantee_date" : 0.0, "issuance_guarantor_bank_number" : 0.0, "issuance_guarantor_bank_name" : 0.0, "contract_number" : 0.0, "acceptance_guarantor_name" : 0.0, "acceptance_guarantor_address" : 0.0, "acceptance_guarantor_account" : 0.0, "acceptance_guarantee_date" : 0.0, "acceptance_guarantor_bank_number" : 0.0, "acceptance_guarantor_bank_name" : 0.0, "issuer_rating_entity" : 0.0, "issuer_credit_rating" : 0.0, "issuer_rating_due_date" : 0.0, "acceptor_rating_entity" : 0.0, "acceptor_credit_rating" : 0.0, "acceptor_rating_due_date" : 0.0, "remarks" : 0.0, "bill_package_number" : 0.0 } } } 状态码： 400 失败响应样例 { "error_code" : "AIS.0103", "error_msg" : "The image size does not meet the requirements." }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 result AcceptanceBillResult object 调用成功时表示调用结果。 调用失败时无此字段。 表5 AcceptanceBillResult 参数 参数类型 描述 issue_date String 出票日期。 due_date String 汇票到期日。 bill_status String 票据状态。 bill_number String 票据号码。 issuer_full_name String 出票人全称。 issuer_account String 出票人账号。 issuer_bank_name String 出票人开户银行。 issuer_bank_number String 出票人开户行号。 payee_full_name String 收款人全称。 payee_account String 收款人账号。 payee_bank_name String 收款人开户银行。 payee_bank_number String 收款人开户行号。 issuance_guarantor_name String 出票保证人名称。 issuance_guarantor_address String 出票保证人地址。 issuance_guarantor_account String 出票保证人账号。 issuance_guarantee_date String 出票保证日期。 issuance_guarantor_bank_number String 出票保证人开户行行号。 issuance_guarantor_bank_name String 出票保证人开户行名称。 amount_in_words String 大写票据金额。 amount_in_figures String 小写票据金额。 acceptor_full_name String 承兑人全称。 acceptor_account String 承兑人账号。 acceptor_bank_number String 承兑人开户行行号。 acceptor_bank_name String 承兑人开户行名称。 contract_number String 交易合同号。 assignability String 能否转让。 issuer_commitment String 出票人承诺。 acceptor_commitment String 承兑人承诺。 acceptance_date String 承兑日期。 acceptance_guarantor_name String 承兑保证人名称。 acceptance_guarantor_address String 承兑保证人地址。 acceptance_guarantor_account String 承兑保证人账号。 acceptance_guarantee_date String 承兑保证日期。 acceptance_guarantor_bank_number String 承兑保证人开户行行号。 acceptance_guarantor_bank_name String 承兑保证人开户行名称。 issuer_rating_entity String 出票人评级主体。 issuer_credit_rating String 出票人信用等级。 issuer_rating_due_date String 出票人评级到期日。 acceptor_rating_entity String 承兑人评级主体。 acceptor_credit_rating String 承兑人信用等级。 acceptor_rating_due_date String 承兑人评级到期日。 bill_package_number String 票据包号。 remarks String 备注。 confidence Object 各个字段的置信度。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 调用失败时的错误码。调用成功时无此字段。 error_msg String 调用失败时的错误信息。调用成功时无此字段。

URI POST /v2/{project_id}/ocr/acceptance-bill 表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。 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." }