华为云用户手册

请求参数 表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编码。 country_code 否 String 输入值为护照颁发国的国家码，根据国家码选择对应的护照识别服务。 若输入中未选此字段，服务会根据自己识别判断的护照类型匹配相应的护照识别服务。 若选择值为“GENERAL”，则选择护照机器码识别。 若选择值为“CHN”，则选择中国护照全字段识别。

约束与限制 支持中国大陆护照的全字段识别。 支持含有完整机读码的中国-港澳台地区及外国护照识别。 只支持识别PNG、JPG、JPEG、BMP、TIFF格式图片。 图像各边的像素大小在15px到8192px之间。 图像中护照首页区域有效占比超过25%，保证护照首页内容及其边缘包含在图像内。 支持图像中护照任意角度的水平旋转。 支持少量扭曲，扭曲后图像中的护照长宽比与实际护照相差不超过10%。 能处理反光、暗光等干扰的图片但影响识别精度。

响应示例 状态码： 200 成功响应示例 { "result" : { "front" : { "number" : "粤B0xxx2", "vehicle_type" : "小型轿车", "name" : "张三", "address" : "xx省xx市xx区xxx街道号", "engine_no" : "601xx99", "vin" : "LPAA3xxxxxxxxx709", "model" : "xx牌CAPxxxxxxC3", "register_date" : "2015-07-07", "issue_date" : "2015-07-08", "use_character" : "非营运" }, "back" : { "number" : "粤B8888", "file_no" : "44xxxxx57436", "approved_passengers" : "5人", "gross_mass" : "1960kg", "unladen_mass" : "1525kg", "approved_load" : "", "dimension" : "4553×1858×1588mm", "traction_mass" : "", "remarks" : "", "inspection_record" : "检验有效期至20xx年xx月粤B(12)汽油", "code_number" : "*44xxx24xxxx49*", "energy_type" : "汽油" } } } 状态码： 400 失败响应样例 { "result" : { "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/vehicle-license”，“project_id”为项目ID，获取方法请参见获取项目ID。 如何获取Token请参见认证鉴权。 传入行驶证主页图片的base64编码进行文字识别，并识别发证机关信息 POST https://{endpoint}/v2/{project_id}/ocr/vehicle-license Request Header: Content-Type: application/json X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG... Request Body: { "image":"/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAAg...", "side":"front", "return_issuing_authority":true } 传入行驶证副页图片的url进行文字识别 POST https://{endpoint}/v2/{project_id}/ocr/vehicle-license Request Header: Content-Type: application/json X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG... Request Body: { "url":"https://BucketName.obs.xxxx.com/ObjectName", "side":"back" }

响应参数 根据识别的结果，可能有不同的HTTP响应状态码（status code）。例如，200表示API调用成功，400表示调用失败，详细的状态码和响应参数说明如下。 状态码： 200 表4 响应Body参数 参数 参数类型 描述 result VehicleLicenseResult object 识别结果。 调用失败时不返回此字段。 表5 VehicleLicenseResult 参数 参数类型 描述 number String 号牌号码。 vehicle_type String 车辆类型。 name String 所有人。 address String 住址。 use_character String 使用性质。 model String 品牌型号。 engine_no String 发动机号码。 vin String 车辆识别代号。 register_date String 注册日期。 issue_date String 发证日期。 issuing_authority String 发证机关。 file_no String 档案编码。 approved_passengers String 核定载人数。 gross_mass String 总质量。 unladen_mass String 整备质量。 approved_load String 核定载质量。 dimension String 外廓尺寸。 traction_mass String 准牵引总质量。 remarks String 备注。 inspection_record String 检验记录。 code_number String 条码号。 text_location Object 对应所有在原图上识别到的字段位置信息，包含所有文字区域四个顶点的二维坐标（x,y）。采用图像坐标系，坐标原点为图片左上角，x轴沿水平方向，y轴沿竖直方向。 energy_type String 能源类型。 front 表6 object 行驶证主页。当请求参数"side"设置为"double_side"时才返回。 back 表7 object 行驶证副页。当请求参数"side"设置为"double_side"时才返回。 表6 VehicleLicenseFront 参数 参数类型 描述 number String 号牌号码。 vehicle_type String 车辆类型。 name String 所有人。 address String 住址。 use_character String 使用性质。 model String 品牌型号。 vin String 车辆识别代号。 engine_no String 发动机号码。 register_date String 注册日期。 issue_date String 发证日期。 issuing_authority String 发证机关。 text_location Object 文本框在原图位置。输出左上、右上、右下、左下四个点坐标。 当“return_text_location”设置为“true”时才返回。 表7 VehicleLicenseback 参数 参数类型 描述 number String 号牌号码。 file_no String 档案编码。 approved_passengers String 核定载人数。 gross_mass String 总质量。 unladen_mass String 整备质量。 approved_load String 核定载质量。 dimension String 外廓尺寸。 traction_mass String 准牵引总质量。 remarks String 备注。 inspection_record String 检验记录。 code_number String 条码号。 energy_type String 能源类型。 text_location Object 文本框在原图位置。输出左上、右上、右下、左下四个点坐标。 当“return_text_location”设置为“true”时才返回。 状态码： 400 表8 响应Body参数 参数 参数类型 说明 error_code String 调用失败时的错误码，具体请参见错误码。 当出现错误码“ModelArts.4204”时，请参考为什么调用API时提示“ModelArts.4204”？章节。 调用成功时不返回此字段。 error_msg String 调用失败时返回的错误信息。 调用成功时不返回此字段。

请求参数 表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。 图片最短边不小于100px，最长边不超过8000px。支持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编码。 side 否 String 检测行驶证的主页或副页。 front: 行驶证主页 back: 行驶证副页 double_side：行驶证双页信息 如果参数值为空或无该参数，系统默认识别主页，建议填写，准确率更高。 return_issuing_authority 否 Boolean 是否返回发证机关的开关，可选值包括： true：返回发证机关 false：不返回发证机关 如果无该参数，系统默认不返回发证机关。如果输入参数不是Boolean类型，则会报非法参数错误。 return_text_location 否 Boolean 识别到的文字块的区域位置信息。可选值包括： true：返回各个文字块区域 false：不返回各个文字块区域 如果无该参数，系统默认不返回文字块区域。如果输入参数不是Boolean类型，则会报非法参数错误。

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

约束与限制 只支持中国大陆行驶证的识别。 只支持识别PNG、JPG、JPEG、BMP、TIFF格式图片。 图像各边的像素大小在100px到8000px之间。 图像中行驶证区域有效占比超过5%，保证整张行驶证内容及其边缘包含在图像内。 支持图像中行驶证任意角度的水平旋转。 支持少量扭曲，扭曲后图像中的行驶证长宽比与实际行驶证相差不超过10%。 能处理反光、暗光、防伪标识等干扰的图片但影响识别精度。 目前只支持识别2008年版的行驶证。

请求示例 “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/transportation-license”，“project_id”为项目ID，获取方法请参见获取项目ID 如何获取Token请参见认证鉴权。 传入道路运输证图片的base64编码进行文字识别 POST https://{endpoint}/v2/{project_id}/ocr/transportation-license Request Header: Content-Type: application/json X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG... Request Body: { "image":"/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAA..." } 传入道路运输证图片的url进行文字识别 POST https://{endpoint}/v2/{project_id}/ocr/transportation-license Request Header: Content-Type: application/json X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG... Request Body: { "url":"https://BucketName.obs.xxxx.com/ObjectName" }

响应示例 状态码：200 成功响应示例 { "result": { "owner_name": "XXXX货运有限公司", "license_number": "XX交运管货字XXXXX号", "vehicle_number": "京XXXXXX（黄）", "vehicle_type": "重型半挂牵引车-解放牌XXXXXXXXXXXX", "maximum_capacity": "0吨", "vehicle_size": "6475*2000*3000毫米", "issuing_authority": "XXX县道路运输管理所", "issue_date": "2014-11-16", "confidence": { "owner_name": 0.9963, "license_number": 0.9988, "vehicle_number": 0.9999, "vehicle_type": 0.9797, "maximum_capacity": 0.9793, "vehicle_size": 0.9947, "issuing_authority": 0.9983, "issue_date": 0.9991 } } } 状态码：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 TransportationLicenseResult object 识别结果。 调用失败时不返回此字段。 Result中包含：6个主要字段和主字段外的其余可提取字段。 表5 TransportationLicenseResult 参数 参数类型 描述 owner_name String 业户名称。 license_number String 道路运输证号。 vehicle_number String 车辆号牌。 vehicle_type String 车辆类型。 maximum_capacity String 吨(座)位。 vehicle_size String 车辆尺寸。 issuing_authority String 核发机关（非必有，依赖对应运输证板式）。 issue_date String 签发日期（非必有，依赖对应运输证板式）。 owner_address String 业户地址（非必有，依赖对应运输证板式）。 economic_type String 经济类型（非必有，依赖对应运输证板式）。 business_certificate String 经营许可证号（非必有，依赖对应运输证板式）。 business_scope String 道路普通货物运输（非必有，依赖对应运输证板式）。 confidence Object 字段的置信度，取值范围0~1。 置信度越大，本次识别的字段的可靠性越高，在统计意义上，置信度越大，准确率越高。 置信度由算法给出，不直接等价于字段的准确率。 说明： 置信度中的相关字段均与返回值中的相关字段一一对应。 状态码： 400 表6 响应Body参数 参数 参数类型 说明 error_code String 调用失败时的错误码，具体请参见错误码。 当出现错误码“ModelArts.4204”时，请参考为什么调用API时提示“ModelArts.4204”？章节。 调用成功时不返回此字段。 error_msg String 调用失败时返回的错误信息。 调用成功时不返回此字段调用成功时不返回此字段。

URI POST /v2/{project_id}/ocr/transportation-license 表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编码。

URI POST /v2/{project_id}/ocr/general-text 表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/general-text”，“project_id”为项目ID，获取方法请参见获取项目ID。 如何获取Token请参见认证鉴权。 传入图片的base64编码进行文字识别，识别过程不校验图片倾斜角度，并关闭快速模式 POST https://{endpoint}/v2/{project_id}/ocr/general-text Request Header: Content-Type: application/json X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG... Request Body: { "image":"/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAA...", "detect_direction":false, "quick_mode":false } 传入图片的url进行文字识别，识别过程不校验图片倾斜角度，并关闭快速模式 POST https://{endpoint}/v2/{project_id}/ocr/general-text Request Header: Content-Type: application/json X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG... Request Body: { "url":"https://BucketName.obs.xxxx.com/ObjectName", "detect_direction":false, "quick_mode":false }

响应示例 状态码：200 成功响应示例 { "result" : { "direction" : 67.6506, "words_block_count" : 1, "words_block_list" : [ { "words" : "文字", "confidence" : 0.9999, "location" : [ [ 517, 447 ], [ 540, 504 ], [ 505, 518 ], [ 482, 461 ] ], "char_list" : [ { "char" : "文", "char_location" : [ [ 517, 447 ], [ 530, 479 ], [ 495, 493 ], [ 482, 461 ] ], "char_confidence" : 0.9999 }, { "char" : "字", "char_location" : [ [ 530, 479 ], [ 540, 504 ], [ 505, 518 ], [ 495, 493 ] ], "char_confidence" : 0.9999 } ] } ] } } 状态码：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、GIF、TIFF、WEBP、PCX、ICO、PSD格式。 图片Base64编码示例如/9j/4AAQSkZJRgABAg...，带有多余前缀会产生The image format is not supported报错。 url 否 String 该参数与image二选一。图片的url路径，目前支持： 公网http/https url例如https://support.huaweicloud.com/api-ocr/zh-cn_image_0288038182.png OBS提供的url，使用OBS数据需要进行授权。包括对服务授权、临时授权、匿名公开授权，详情参见配置OBS访问权限。 说明： 接口响应时间依赖于图片的下载时间，如果图片下载时间过长，会返回接口调用失败。 请保证被检测图片所在的存储服务稳定可靠，推荐使用OBS服务存储图片数据。 url中不能存在中文字符，若存在，中文需要进行utf8编码。 detect_direction 否 Boolean 是否校正图片的倾斜角度，可选值如下。 true：校正图片的倾斜角度 false：不校正图片的倾斜角度 支持任意角度的校正，未传入该参数时默认为“false”。 待识别图片如果存在倾斜，建议将此参数设置为“true”。 quick_mode 否 Boolean 快速模式开关，针对单行文字图片（要求图片只包含一行文字，且文字区域占比超过50%），打开时可以更快返回识别内容。可选值如下所示。 true：打开快速模式 false：关闭快速模式 未传入该参数时默认为false，即关闭快速模式。 character_mode 否 Boolean 单字符模式开关。可选值包括： true：打开单字符模式 false：关闭单字符模式 未传入该参数时默认为false，即不返回单个文本行的单字符信息。 language 否 String 语种选择，未传入该参数时默认为中英文识别模式。 auto：自动语种分类 ms：马来语 uk：乌克兰语 hi：印地语 ru：俄语 vi：越南语 id：印尼语 th：泰语 zh：中英文 ar：阿拉伯语 de：德语 la：拉丁语 fr：法语 it：意大利语 es：西班牙语 pt：葡萄牙语 ro：罗马尼亚语 pl：波兰语 am：阿姆哈拉语 ja：日语 ko：韩语 tr：土耳其语 no：挪威语 da：丹麦语 sv：瑞典语 km：柬埔寨语 single_orientation_mode 否 Boolean 单朝向模式开关。可选值包括： true：打开单朝向模式 false：关闭单朝向模式 未传入该参数时默认为false，既默认图片中的字段为多朝向。

约束与限制 只支持识别PNG、JPG、JPEG、BMP、GIF、TIFF、WEBP、PCX、ICO、PSD格式图片。 图像各边的像素大小在15px到8192px之间。 图像中识别区域有效占比超过80%，保证所有文字及其边缘包含在图像内。 支持图像任意角度的水平旋转。 目前不支持复杂背景（如户外自然场景、防伪水印等）和文字扭曲图像的文字识别。 支持中英文以及部分繁体字、马来语、乌克兰语、印地语、俄语、越南语、印尼语、泰语、阿拉伯语、德语、拉丁语、法语、意大利语、西班牙语、葡萄牙语、罗马尼亚语、波兰语、阿姆哈拉语、日语、韩语、土耳其语、挪威语、丹麦语、瑞典语、柬埔寨语识别。

响应示例 状态码： 200 成功响应示例 { "result" : { "seal_list" : [ { "words_block_list" : [ { "words" : "1100000256848", "words_confidence" : 0.9269 }, { "words" : "中国建材集团有限公司", "words_confidence" : 0.9999 } ], "confidence" : 0.9834, "location" : [ [ 262, 321 ], [ 447, 321 ], [ 447, 507 ], [ 262, 507 ] ], "type" : "circle", "seal_image" : "/9j/4AAQSkZJRgABAQAAAQABAAD..." } ], "erased_seal_image" : "/9j/4AAQSkZJRgABAQAAAQABAA36K..." } } 状态码： 400 失败响应样例 { "result" : { "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参数 参数 是否必选 参数类型 描述 data 否 String 该参数与url二选一。 图片的Base64编码，要求Base64编码后大小不超过10MB。 图片最短边不小于15px，最长边不超过8192px。支持JPEG、JPG、PNG、BMP、GIF、TIFF、WEBP、PCX、ICO、PSD、PDF格式。 图片Base64编码示例如/9j/4AAQSkZJRgABAg...，带有多余前缀会产生The image format is not supported报错。 url 否 String 该参数与data二选一。图片的url路径，目前支持： 公网http/https url例如https://support.huaweicloud.com/api-ocr/zh-cn_image_0000001079447456.png OBS提供的url，使用OBS数据需要进行授权。包括对服务授权、临时授权、匿名公开授权，详情参见配置OBS访问权限。 说明： 接口响应时间依赖于图片的下载时间，如果图片下载时间过长，会返回接口调用失败。 请保证被检测图片所在的存储服务稳定可靠，推荐使用OBS服务存储图片数据。 url中不能存在中文字符，若存在，中文需要进行utf8编码。 return_seal_image 否 Boolean 是否返回提取的印章base64编码图片，可选值如下所示： true：返回提取的印章图片base64编码 false：不返回提取的印章图片base64编码 如果无该参数，系统默认不返回印章擦除后的图片。如果输入参数不是Boolean类型，则会报非法参数错误。 return_erased_seal_image 否 Boolean 是否返回印章擦除后的base64编码图片，可选值包括： true：返回印章擦除后的图片base64编码 false：不返回印章擦除后的图片base64编码 如果无该参数，系统默认不返回印章擦除后的图片。如果输入参数不是Boolean类型，则会报非法参数错误。 pdf_page_number 否 Integer 指定PDF页码识别。传入该参数时，则识别指定页码的内容。如果不传该参数，则默认识别第1页。

请求示例 传入印章图片的base64编码进行文字识别 POST https://{endpoint}/v2/{project_id}/ocr/seal { "data" : "/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAA..." } 传入印章证图片的url进行文字识别 POST https://{endpoint}/v2/{project_id}/ocr/seal { "url" : "https://BucketName.obs.myhuaweicloud.com/ObjectName" }

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

请求示例 “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}/thailand-id-card”，“project_id”为项目ID，获取方法请参见获取项目ID 如何获取Token请参见构造请求。 请求示例（方式一：使用图片的Base64编码） POST https://{endpoint}/v2/{project_id}/ocr/thailand-id-card Request Header: Content-Type: application/json X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG... Request Body: { "image" : "/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAA...", "side" : "front", "return_portrait_image" : true, "return_portrait_location" : true, "return_idcard_type" : true } 请求示例（方式二：使用图片URL） POST https://{endpoint}/v2/{project_id}/ocr/thailand-id-card Request Header: Content-Type: application/json X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG... Request Body: { "url":"https://BucketName.obs.xxxx.com/ObjectName" }

响应示例 状态码：200 成功响应示例（正面） { "result" : { "side" : "front", "id_number" : "X XXXX XXXXX XX X", "name_th" : "XXX", "first_name_en" : "XX", "last_name_en" : "XX", "date_of_birth_th" : "5 ก.พ. 2493", "date_of_birth_en" : "5 Feb. 1950", "religion_th" : "XX", "address_th" : "XXXXX", "date_of_issue_th" : "XX", "date_of_issue_en" : "4 Mar. 2011", "date_of_expiry_th" : "22 ก.พ. 2561", "date_of_expiry_en" : "22 Feb. 2018", "serial_number" : "XXXX-XX-XXXXX", "confidence" : { "id_number" : 0.9999, "name_th" : 0.9994, "first_name_en" : 0.998, "last_name_en" : 0.9997, "date_of_birth_th" : 0.9996, "date_of_birth_en" : 0.9997, "religion_th" : 0.686, "address_th" : 0.624, "date_of_issue_th" : 1, "date_of_issue_en" : 1, "date_of_expiry_th" : 0.9969, "date_of_expiry_en" : 0.61, "serial_number" : 0.9887 }, "portrait_image" : "/9j/4AA... ", "portrait_location" : [ [ 576, 237 ], [ 741, 237 ], [ 739, 430 ], [ 574, 431 ] ], "idcard_type" : "normal" } } 成功响应示例（背面） { "result": { "side": "back", "card_number": "XXXX-XXX-XX", "laser_number": "XXXX-XXXXXXX-XX", "confidence": { "id_number": 0.9999, "laser_number": 0.9994 } } } 状态码：400 失败响应示例 { "error_code": "AIS.0103", "error_msg": "The image size does not meet the requirements." }

约束与限制 只支持泰国身份证的识别。 只支持识别PNG、JPG、JPEG、BMP、TIFF格式图片。 泰国身份证识别图像各边的像素大小在15px到8192px之间。 图像中身份证区域有效占比超过25%，保证整张身份证内容及其边缘包含在图像内。 支持图像中身份证任意角度的水平旋转。 支持少量扭曲，扭曲后图像中的身份证长宽比与实际身份证相差不超过10%。 能处理反光、暗光等干扰的图片但影响识别精度。 目前只支持识别单张身份证的正面或者反面。

URI POST /v2/{project_id}/ocr/thailand-id-card 表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，最长边不超过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服务存储图片数据。 side 否 String 标示身份证正面或背面。可选值如下： front：身份证正面 back：身份证背面 如果参数值为空或无该参数，系统自动识别，建议填写，准确率更高。 return_portrait_image 否 Boolean 是否返回身份证头像照片的 Base64 编码，可选值如下： true：返回身份证头像照片的 Base64 编码 false：不返回身份证头像照片的 Base64 编码 未传入该参数时默认为false，即不返回身份证头像照片的 Base64 编码。 return_portrait_location 否 Boolean 是否返回头像位置坐标，可选值如下： true ：返回身份证头像的位置坐标 false：不返回身份证头像的位置坐标 return_idcard_type 否 Boolean 是否返回身份证类型，可选值如下： true: 返回身份证类型，类型包括身份证原件和身份证复印件 false：不返回身份证类型 return_text_location 否 Boolean 识别到的文字块的区域位置信息。可选值包括： true：返回各个文字块区域 false：不返回各个文字块区域 如果无该参数，系统默认不返回文字块区域。如果输入参数不是Boolean类型，则会报非法参数错误。

概述 文字识别（Optical Character Recognition，简称OCR）是指将图片、扫描件或PDF、OFD文档中的打印字符进行检测识别成可编辑的文本格式，以JSON格式返回识别结果。 OCR以开放API（Application Programming Interface，应用程序编程接口）的方式提供给用户，用户通过实时访问和调用API获取推理结果，帮助用户自动采集关键数据，打造智能化业务系统，提升业务效率。调用API时，需要用户网络可以访问公网。 您可以使用本文档提供文字识别服务API的描述、语法、参数说明及样例等内容，进行相关操作，例如文字识别包含的通用类、证件类和票据类等具体接口使用说明。不同区域所部署的接口不同，详情请参见终端节点；接口所支持的全部操作请参见2 API概览。 在调用文字识别API之前，请确保已经充分了解文字识别相关概念。 OCR还提供多种编程语言的SDK供您使用，SDK使用方法请参考《SDK参考》。 父主题： 使用前必读

请求示例 “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/flight-itinerary”，“project_id”为项目ID，获取方法请参见获取项目ID 如何获取Token请参见认证鉴权。 传入飞机行程单图片的base64编码进行文字识别 POST https://{endpoint}/v2/{project_id}/ocr/flight-itinerary Request Header: Content-Type: application/json X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG... Request Body: { "image":"/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAA..." } 传入飞机行程单图片的url进行文字识别 POST https://{endpoint}/v2/{project_id}/ocr/flight-itinerary Request Header: Content-Type: application/json X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG... Request Body: { "url":"https://BucketName.obs.xxxx.com/ObjectName" }

响应示例 状态码：200 成功响应示例 { "result": { "serial_number": "12XXXXXXX22", "passenger_name": "WANG/SAN", "id_number": "GXXXXXX08", "endorsements_restrictions": "Q/不得签转/退改收费", "fare": "CNY 2340.00", "caac_development_fund": "CN 100.00", "fuel_surcharge": "XXXX", "other_taxes": "", "total": "CNY 2440.00", "e_ticket_number": "73XXXXXXXX008", "check_code": "3XXX", "reference_information": "白云机场起飞前45分停办值机", "insurance": "XXX", "agent_code": "SXXXXX 00XXXX66", "issue_organization": "XX航空股份有限公司", "issue_date": "2017-12-27", "tax" : "", "tax_rate" : "", "buyer_name" : "", "buyer_id" : "", "number" : "", "international_flag" : "", "issue_status" : "", "itinerary_list": [ { "departure_station": "T2上海虹桥", "destination_station": "广州", "carrier": "X航", "flight": "XXXXXX", "cabin_class": "B", "date": "2017-12-27", "time": "13:00", "fare_basis": "B", "effective_date": "", "expiry_date": "", "baggage_allowance": "20K" }, { "departure_station": "广州", "destination_station": "上海虹桥", "carrier": "XXXX", "flight": "XXXXXX", "cabin_class": "B", "date": "2017-12-29", "time": "16:30", "fare_basis": "B", "effective_date": "", "expiry_date": "", "baggage_allowance": "20K" } ], "confidence":{ "serial_number": 0.9993, "passenger_name": 0.9851, "id_number": 0.9836, "endorsements_restrictions": 0.998, "fare": 0.9882, "caac_development_fund": 0.993, "fuel_surcharge": 0.9968, "other_taxes": 0, "total": 0.9999, "e_ticket_number": 0.9631, "check_code": 0.9985, "reference_information": 0.9982, "insurance": 0.7749, "agent_code": 0.9913, "issue_organization": 0.7142, "issue_date": 0.9936, "tax" : "0,", "tax_rate" : "0,", "buyer_name" : "0,", "buyer_id" : "0,", "number" : "0,", "international_flag" : "0,", "issue_status" : "0,", "itinerary_list": [ { "departure_station": 0.9987, "destination_station": 0.9577, "carrier": 0.9677, "flight": 0.9957, "cabin_class": 0.8744, "date": 0.9993, "time": 0.9978, "fare_basis": 0.4006, "effective_date": 0, "expiry_date": 0, "baggage_allowance": 0.9897 }, { "departure_station": 0.9995, "destination_station": 0.9844, "carrier": 0.9763, "flight": 0.7453, "cabin_class": 0.4239, "date": 0.76, "time": 0.7311, "fare_basis": 0.4353, "effective_date": 0, "expiry_date": 0, "baggage_allowance": 0.5265 } ] } } } 状态码：400 失败响应示例 { "error_code": "AIS.0103", "error_msg": "The image size does not meet the requirements." }