华为云用户手册

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

错误码说明 由于OCR服务部署在ModelArts平台，使用API网关（API Gateway）系统，因此OCR服务错误码会出现“ModelArts”、“APIGW”、“APIG”开头的错误码。 当您调用API时，如果遇到“APIGW”开头的错误码，请参见API网关错误码进行处理。遇到“APIG”开头的错误码，请参考本文档进行处理。 模块 错误码 错误信息 说明 建议解决方法 文字识别 AIS.0101 The input parameter is invalid. 输入参数不符合规范。 请检查输入参数是否正确。出现此报错可能原因如下： image、url参数为二选一，请勿同时填写。填写时注意格式规范。 功能开关true、false拼写错误。 传参时中英文字符错误。 具体参数格式参见各API的请求参数说明。 AIS.0102 The image format is not supported. 图片格式不支持，或image参数值不是base64编码字符串。 请检查图片格式，各服务支持图片格式请参考使用限制。 AIS.0103 The image size does not meet the requirements. 图片尺寸不满足要求。 请检查图片尺寸，各服务支持图片尺寸请参考使用限制。 AIS.0104 The image is not supported or the image quality is poor. 非支持的图片类型或图片质量差。 请检查图片类型与图片质量。 请检查调用的接口是否正确。 AIS.0105 Recognition failed. 算法计算失败。 请联系华为云支持人员。 AIS.0117 Input ID does not exist. 输入ID不存在。 请检查入参中的classifier_id或template_id是否存在。 AIS.0118 Service request error or the tax authority’s interface was malfunctioning. 税局机关接口超时未响应，导致服务请求错误。 请等待税局机关接口恢复(建议2小时后重试)。 AIS.0119 Template match failed, template_id={xxx}. 输入图片与模板匹配失败。 请检查模板中的参照字段是否与输入图片匹配。 AIS.0120 Classification failed. 输入图片分类失败。 请检查分类器中模板是否与输入图片匹配。 AIS.0121 The recognition area of template is not configured, template_id={xxx} 模板未配置识别区。 请检查模板是否配置了识别区。 AIS.0122 The image contains two or more ID cards with the same side. 存在两张及以上同面身份证。 请检查输入图片是否存在两张及以上同面身份证。身份证服务参数side为double_side时，图片中不能存在两张及以上同面身份证。 平台 ModelArts.0203 Invalid token. 非法Token。 请检查Token是否正确。 ModelArts.4101 Token header cannot be empty. Token为空。 发送的HTTP请求header中没有带x-auth-token的token请求认证信息，请检查发送的请求。 ModelArts.4102 Parse Token error. 解析Token失败。 发送的HTTP请求header中x-auth-token的token请求认证信息错误，请检查发送的请求和token。 ModelArts.4103 Invalid Token header. Token不合法。 发送的HTTP请求header中x-auth-token的token请求认证信息错误，请检查发送的请求和token。 ModelArts.4104 Invalid Request Content Length. 请求body体长度不合法。 请检查请求body体长度。要求Base64编码后大小不超过10MB。 ModelArts.4105 The JSON format of the input data is incorrect. 请求body体JSON格式不对。 请检查请求body体是否符合JSON格式。 Failed to obtain the temporary AK/SK 获取用户临时AK，SK失败 请联系技术支持人员（如果有使用OBS，请先检查授权）。 ModelArts.4106 Invalid authorization request. 用户账号受限。 请检查用户资源状态。账号受限原因请参考帐号中心相关描述。 ModelArts.4107 Get user temp ak sk error. 获取用户临时AK，SK异常。 请联系华为云支持人员。 ModelArts.4201 Request url need service id. 请求url中需要包含服务ID。 请检查请求url中的服务ID。 ModelArts.4202 Request url format invalid. 请求url格式不合法。 请检查请求url格式。 ModelArts.4203 Access denied! You do not have permission. 没有权限访问。 请检查访问权限。 ModelArts.4204 Request api error! The API XXX is not subscribed. 请求服务失败，服务未开通。 请前往文字识别控制台开通需要调用的API，注意API的开通区域。 如已开通服务，请检查开通服务的区域（或账号）与调用服务的区域（或账号）是否一致；若一致请检查API的URL是否拼写正确。 ModelArts.4301 Have error when get ai-service admin token. 获取服务admin Token失败。 请联系华为云支持人员。 ModelArts.4302 Gateway forwarding error. 访问服务失败。 请联系华为云支持人员。 ModelArts.4401 Max concurrency error. 最大并发错误，请求并发过大，超过限额。 请联系华为云支持人员。 ModelArts.4402 Backend service timeout error. 服务处理超时。 请联系华为云支持人员。 ModelArts.4403 Backend service unavailable error. 服务无法正常响应，或者失败率过高，不可用。 请联系华为云支持人员。 ModelArts.4502 Backend service response error. 服务响应失败。 请联系华为云支持人员。 ModelArts.4503 Backend service found error. 服务不存在。 请联系华为云支持人员。 ModelArts.4504 Backend service api not found. 访问的API不存在。 请联系华为云支持人员。 ModelArts.4505 Backend service internal error. 服务内部错误。 请联系华为云支持人员。 ModelArts.4506 SubService service found error. 该API对应的子服务不存在。 请联系华为云支持人员。 ModelArts.4508 Service not start. 服务不存在或者服务停止。 请联系华为云支持人员。 ModelArts.4601 The URL is not allowed. 外网下载地址不合法。 请检查输入的url下载地址参数格式。 ModelArts.4603 Obtaining the file from the URL failed. 下载外网URL文件失败。 请检查网络与URL。 ModelArts.4702 Query Obs agency failed. 查询OBS委托失败。 请检查是否已开通服务的OBS委托。 ModelArts.4703 The Obs URL is invalid. OBS地址不合法。 请检查OBS地址。 ModelArts.4704 Obtaining the file from the OBS failed. 获取OBS文件失败。 请检查OBS文件。 ModelArts.4705 The file stored on the OBS is oversized. OBS文件大小超限。 请检查OBS文件大小，请使用符合服务大小限制的文件作为输入。 ModelArts.4706 The Obs file is not exist. OBS文件不存在。 请检查对应的文件是否存在。 APIG APIG.0101 The API does not exist or has not been published in the environment. 访问的API不存在或尚未在环境中发布。 请检查API的URL是否拼写正确，例如，URL中是否缺少project_id。 检查URI中的区域信息是否和调用服务配置的终端节点是否对应。 HTTP请求方法（POST，GET等）是否正确。 具体的URI信息请在各接口的API页面查看。 APIG.0201 Backend timeout. 请求超时。 请检查原调用请求是否过于频繁，如果是并发过大，可以通过重试机制解决，在代码里检查返回值，碰到这个并发错误可以延时一小段时间（如2-5s）重试请求；也可以后端检查上一个请求结果，上一个请求返回之后再发送下一个请求，避免请求过于频繁。 请检查图片是否过大，或网络延时过长，如果图片过大，在保证图片清晰度前提下可以对图片进行等比例压缩；如果网络延时较长，可以适当提升网络传输速度。 APIG.0301 Incorrect IAM authentication information. IAM身份验证信息不正确： decrypt token fail：token解析失败。 token expires：token过期。 verify aksk signature fail：AK/SK认证失败。 x-auth-token not found：未找到x-auth-token参数。 token解析失败，请检查获取token的方法，请求体信息是否填写正确，token是否正确；检查获取token的环境与调用的环境是否一致。 token超时（token expires） ，请重新获取token，使用不过期的token。 请检查AK/SK是否正确（AK对应的SK错误，不匹配；AK/SK中多填了空格）。 AK/SK频繁出现鉴权出错，连续错误5次以上，被锁定5分钟（5分钟内，则一直认为其是异常的鉴权请求），5分钟后解锁重新认证。 检查账号权限，是否欠费，被冻结等。 检查请求header参数X-Auth-Token是否拼写正确。 APIG.0308 The throttling threshold has been reached: policy user over ratelimit,limit:XX,time:1 minute. 发送请求超过了服务的默认配置限流。 请参考调用API时提示"APIG.0308"方案进行解决。 其他 如若出现其他无法解决的错误码，请联系华为云支持人员。

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

响应示例 状态码： 200 成功响应示例 { "result" : { "certificate_number" : "WAS1xxxx2399503", "issue_date" : "2022年10月23日", "manufacture_name" : "xxxx汽车有限公司", "vehicle_brand" : "xxx牌/xxx", "vehicle_name" : "轿车", "vehicle_model" : "TV7xxxxx", "vin" : "LFMAYxxxxxxx92063", "vehicle_color" : "白", "chassis_model" : "x", "chassis_id" : "x", "chassis_certificate_number" : "x", "engine_model" : "9NR", "engine_number" : "A2853xx", "fuel_type" : "汽油", "displacement" : "x197", "power" : "xx", "emission_standard" : "GBXXXXX-XXXX", "fuel_consumption" : "xx", "overall_dimension_length" : "xx35", "overall_dimension_width" : "17xx", "overall_dimension_height" : "14xx", "container_dimension_length" : "x", "container_dimension_width" : "x", "container_dimension_height" : "x", "spring_quantity" : "xx", "tire_quantity" : "x", "tire_size" : "XXXXX.X", "front_wheel_track" : "xx27", "rear_wheel_track" : "xx26", "wheelbase" : "27xx", "axle_load" : "xxx/830", "axle_quantity" : "x", "steering_form" : "方向盘", "total_weight" : "xx70", "equipment_weight" : "xx40", "maximum_laden_mass" : "x", "mass_utilization_coefficient" : "x", "traction_weight" : "x", "maximum_load_mass" : "x", "cab_passenger_capacity" : "x", "passenger_capacity" : "x", "max_design_speed" : "xxx", "manufacture_date" : "2022年10月xxx日", "confidence" : { "certificate_number" : 0.9856, "issue_date" : 0.9931, "manufacture_name" : 0.9485, "vehicle_brand" : 0.9612, "vehicle_name" : 0.9562, "vehicle_model" : 0.9741, "vin" : 0.9963, "vehicle_color" : 0.9645, "chassis_model" : 0, "chassis_id" : 0, "chassis_certificate_number" : 0, "engine_model" : 0.9745, "engine_number" : 0.9384, "fuel_type" : 0.9845, "displacement" : 0.9954, "power" : 0.9861, "emission_standard" : 0.9864, "fuel_consumption" : 0.9952, "overall_dimension_length" : 0.9995, "overall_dimension_width" : 0.9996, "overall_dimension_height" : 0.9982, "container_dimension_length" : 0, "container_dimension_width" : 0, "container_dimension_height" : 0, "spring_quantity" : 0, "tire_quantity" : 0.9984, "tire_size" : 0.9631, "front_wheel_track" : 0.9815, "rear_wheel_track" : 0.9951, "wheelbase" : 0.9762, "axle_load" : 0.9978, "axle_quantity" : 0.9982, "steering_form" : 0.9946, "total_weight" : 0.9863, "equipment_weight" : 0.9975, "maximum_laden_mass" : 0, "mass_utilization_coefficient" : 0, "traction_weight" : 0, "maximum_load_mass" : 0, "cab_passenger_capacity" : 0, "passenger_capacity" : 0.9992, "max_design_speed" : 0.9999, "manufacture_date" : 0.9856 } } } 状态码： 400 失败响应样例 { "error_code" : "AIS.0103", "error_msg" : "The image size does not meet the requirements." }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 result VehicleCertificateResult object 调用成功时表示调用结果。 调用失败时无此字段。 表5 VehicleCertificateResult 参数 参数类型 描述 certificate_number String 合格证编号。 issue_date String 发证日期。 manufacture_name String 车辆制造企业名称。 vehicle_brand String 车辆品牌。 vehicle_name String 车辆名称。 vehicle_model String 车辆型号。 vin String 车架号。 vehicle_color String 车身颜色。 chassis_model String 底盘型号。 chassis_id String 底盘ID。 chassis_certificate_number String 底盘合格证编号。 engine_model String 发动机型号。 engine_number String 发动机号。 fuel_type String 燃料种类。 displacement String 排量。 power String 功率。 emission_standard String 排放标准。 fuel_consumption String 油耗。 overall_dimension_length String 外廓尺寸-长。 overall_dimension_width String 外廓尺寸-宽。 overall_dimension_height String 外廓尺寸-高。 container_dimension_length String 货厢内部尺寸-长。 container_dimension_width String 货厢内部尺寸-宽。 container_dimension_height String 货厢内部尺寸-高。 spring_quantity String 钢板弹簧片数。 tire_quantity String 轮胎数。 tire_size String 轮胎规格。 front_wheel_track String 轮距-前。 rear_wheel_track String 轮距-后。 wheelbase String 轴距。 axle_load String 轴荷。 axle_quantity String 轴数。 steering_form String 转向形式。 total_weight String 总质量。 equipment_weight String 整备质量。 maximum_laden_mass String 额定载质量。 mass_utilization_coefficient String 载质量利用系数。 traction_weight String 准牵引总质量。 maximum_load_mass String 半挂车鞍座最大允许总质量。 cab_passenger_capacity String 驾驶室准乘人数。 passenger_capacity String 额定载客。 max_design_speed String 最高设计车速。 manufacture_date String 车辆制造日期。 confidence Object 字段的置信度，取值范围0~1。 置信度越大，本次识别的字段的可靠性越高，在统计意义上，置信度越大，准确率越高。 置信度由算法给出，不直接等价于字段的准确率。 text_location Object 对应所有在原图上识别到的字段位置信息，包含所有文字区域四个顶点的二维坐标（x,y）。采用图像坐标系，坐标原点为图片左上角，x轴沿水平方向，y轴沿竖直方向。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 调用失败时的错误码。 调用成功时无此字段。 error_msg String 调用失败时的错误信息。 调用成功时无此字段。

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

约束与限制 只支持中国大陆车辆合格证的识别。 只支持识别PNG、JPG、JPEG、BMP、TIFF格式的图片。 图像各边的像素大小在15到8192px之间。 图像中识别区域有效占比超过80%，保证整张车辆合格证内容及其边缘包含在图像内。 支持图像中车辆合格证任意角度的水平旋转。 支持少量扭曲，扭曲后图像中的车辆合格证长宽比与实际驾驶证相差不超过10%。 能处理暗光等干扰的图片但影响识别精度。 文字识别服务属于公有云服务，线上用户资源共享，如果需要多并发请求，请提前联系我们。

请求参数 表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服务存储图片数据。 return_text_location 否 Boolean 识别到的文字块的区域位置信息。可选值包括： true：返回各个文字块区域 false：不返回各个文字块区域 如果无该参数，系统默认不返回文字块区域。如果输入参数不是Boolean类型，则会报非法参数错误。

响应消息体 响应消息体通常以结构化格式返回，与响应消息头中Content-type对应，传递除响应消息头之外的内容。 对于网络图片识别接口，返回如下消息体。 { "result": { "words_block_count": 2, "words_block_list": [ { "words": "文字块1", "confidence": 0.9950, "location": [ [13, 476], [91, 332], [125, 351], [48, 494] ] }, { "words": "文字块2", "confidence": 0.9910, "location": [ [13, 476], [91, 332], [125, 351], [48, 494] ] } ], "extracted_data": {} } } 当接口调用出错时，会返回错误码及错误信息说明，错误响应的Body体格式如下所示。 { "error_code": "AIS.0103", "error_msg": "The image size does not meet the requirements." } 其中，error_code表示错误码，error_msg表示错误描述信息。

状态码 HTTP 状态码为三位数，分成五个类别：1xx：相关信息；2xx：操作成功；3xx：重定向；4xx：客户端错误；5xx：服务器错误。 状态码如下所示。 状态码 编码 状态说明 100 Continue 继续请求。 这个临时响应用来通知客户端，它的部分请求已经被服务器接收，且仍未被拒绝。 101 Switching Protocols 切换协议。只能切换到更高级的协议。 例如，切换到HTTPS的新版本协议。 200 OK 服务器已成功处理了请求。 201 Created 创建类的请求完全成功。 202 Accepted 已经接受请求，但未处理完成。 203 Non-Authoritative Information 非授权信息，请求成功。 204 No Content 请求完全成功，同时HTTP响应不包含响应体。 在响应OPTIONS方法的HTTP请求时返回此状态码。 205 Reset Content 重置内容，服务器处理成功。 206 Partial Content 服务器成功处理了部分GET请求。 300 Multiple Choices 多种选择。请求的资源可包括多个位置，相应可返回一个资源特征与地址的列表用于用户终端（例如：浏览器）选择。 301 Moved Permanently 永久移动，请求的资源已被永久的移动到新的URI，返回信息会包括新的URI。 302 Found 资源被临时移动。 303 See Other 查看其它地址，使用GET和POST请求查看。 304 Not Modified 所请求的资源未修改，服务器返回此状态码时，不会返回任何资源。 305 Use Proxy 所请求的资源必须通过代理访问。 306 Unused 已经被废弃的HTTP状态码。 400 Bad Request 非法请求。 建议直接修改该请求，不要重试该请求。 401 Unauthorized 在客户端提供认证信息后，返回该状态码，表明服务端指出客户端所提供的认证信息不正确或非法。 402 Payment Required 保留请求。 403 Forbidden 请求被拒绝访问。 返回该状态码，表明请求能够到达服务端，且服务端能够理解用户请求，但是拒绝做更多的事情，因为该请求被设置为拒绝访问，建议直接修改该请求，不要重试该请求。 404 Not Found 所请求的资源不存在。 建议直接修改该请求，不要重试该请求。 405 Method Not Allowed 请求中带有该资源不支持的方法。 建议直接修改该请求，不要重试该请求。 406 Not Acceptable 服务器无法根据客户端请求的内容特性完成请求。 407 Proxy Authentication Required 请求要求代理的身份认证，与401类似，但请求者应当使用代理进行授权。 408 Request Timeout 服务器等候请求时发生超时。 客户端可以随时再次提交该请求而无需进行任何更改。 409 Conflict 服务器在完成请求时发生冲突。 返回该状态码，表明客户端尝试创建的资源已经存在，或者由于冲突请求的更新操作不能被完成。 410 Gone 客户端请求的资源已经不存在。 返回该状态码，表明请求的资源已被永久删除。 411 Length Required 服务器无法处理客户端发送的不带Content-Length的请求信息。 412 Precondition Failed 未满足前提条件，服务器未满足请求者在请求中设置的其中一个前提条件。 413 Request Entity Too Large 由于请求的实体过大，服务器无法处理，因此拒绝请求。为防止客户端的连续请求，服务器可能会关闭连接。如果只是服务器暂时无法处理，则会包含一个Retry-After的响应信息。 414 Request URI Too Long 请求的URI过长（URI通常为网址），服务器无法处理。 415 Unsupported Media Type 服务器无法处理请求附带的媒体格式。 416 Requested Range Not Satisfiable 客户端请求的范围无效。 417 Expectation Failed 服务器无法满足Expect的请求头信息。 422 Unprocessable Entity 请求格式正确，但是由于含有语义错误，无法响应。 429 Too Many Requests 表明请求超出了客户端访问频率的限制或者服务端接收到多于它能处理的请求。建议客户端读取相应的Retry-After首部，然后等待该首部指出的时间后再重试。 500 Internal Server Error 表明服务端能被请求访问到，但是不能理解用户的请求。 501 Not Implemented 服务器不支持请求的功能，无法完成请求。 502 Bad Gateway 充当网关或代理的服务器，从远端服务器接收到了一个无效的请求。 503 Service Unavailable 被请求的服务无效。 建议直接修改该请求，不要重试该请求。 504 Gateway Timeout 请求在给定的时间内无法完成。客户端仅在为请求指定超时（Timeout）参数时会得到该响应。 505 HTTP Version Not Supported 服务器不支持请求的HTTPS协议的版本，无法完成处理。

响应示例 状态码： 200 成功响应示例 { "result" : { "estate_holder" : "xx", "ownership_certificate_no" : "黔 （2019） 白云区 不动产权第xxx号", "obligee" : "抵押预告登记", "ownership" : "xxx", "estate_location" : "xxx银行股份有限公司xxx分行", "right_type" : "x", "right_nature" : "x", "usage" : "x", "intended_usage" : "x", "area" : "白云区云峰大xx号B、C栋（B）x单元x层x号", "total_floors" : "x", "floor" : "x", "issuer" : "xxx规划和国土资源管理委员会", "issue_date" : "2019-06-2x", "real_estate_certificate_no" : "xx201016xxx", "mortgage_seals" : 0, "canceled_mortgage_seals" : 0, "year_built" : "x", "structure" : "x", "revenue_stamps" : 0, "property_unit_no" : "x", "confidence" : { "estate_holder" : 0, "ownership_certificate_no" : 0.8931, "obligee" : 0.8879, "ownership" : 0.2806, "estate_location" : 0.8145, "right_type" : 0, "right_nature" : 0, "usage" : 0, "intended_usage" : 0, "area" : 0.6588, "total_floors" : 0, "floor" : 0, "issuer" : 0.974, "issue_date" : 0.9198, "real_estate_certificate_no" : 0.9475, "mortgage_seals" : 0, "canceled_mortgage_seals" : 0, "year_built" : 0, "structure" : 0, "revenue_stamps" : 0, "property_unit_no" : 0 } } } 状态码： 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”，请求URL为“https://ocr.cn-north-4.myhuaweicloud.com/v2/{project_id}/ocr/real-estate-certificate”，“project_id”为项目ID，获取方法请参见获取项目ID。 如何获取Token请参见认证鉴权。 传入不动产证图片的base64编码进行文字识别 POST https://{endpoint}/v2/{project_id}/ocr/real-estate-certificate { "image" : "/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAA..." } 传入不动产证图片的url进行文字识别 POST https://{endpoint}/v2/{project_id}/ocr/real-estate-certificate { "url" : "https://BucketName.obs.myhuaweicloud.com/ObjectName" }

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

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 result RealEstateCertificateResult object 调用成功时表示调用结果。 调用失败时无此字段。 表5 RealEstateCertificateResult 参数 参数类型 描述 issuer String 填发单位。 issue_date String 填发日期。 real_estate_certificate_no String 不动产证编号。 mortgage_seals Integer 抵押印章个数。 canceled_mortgage_seals Integer 注销的抵押印章个数。 estate_location String 房屋坐落。 total_floors String 总楼层数。 floor String 所在层。 year_built String 建成年份。 structure String 结构。 area String 建筑面积。 revenue_stamps Integer 印花税票个数。 ownership_certificate_no String 产权证号。 estate_holder String 房屋所有权人。 obligee String 权利人。 ownership String 共有情况。 property_unit_no String 不动产单元号。 right_type String 权利类型。 right_nature String 权利性质。 usage String 使用用途。 intended_usage String 设计、规划用途。 confidence Object 各个字段的置信度。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 调用失败时的错误码。 调用成功时无此字段。 error_msg String 调用失败时的错误信息。 调用成功时无此字段。

请求参数 表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服务存储图片数据。

响应示例 状态码：200 成功响应示例（增值税普通发票） { "result": { "type": "vat_normal", "code": "03xxxxx00204", "number": "12528000", "issue_date": "20200809", "machine_number": "661xxxxx1000", "check_code": "79xxxxx8040xxxx00000", "status": "valid", "subtotal_amount": "1400.00", "subtotal_tax": "0.00", "total": "1400.00", "total_in_words": "壹仟肆佰元整", "remarks": "3091", "receiver": "", "issuer": "", "reviewer": "", "buyer_name": "xxx公司", "buyer_id": "91xxxxx0192xxxx00", "buyer_address": "", "buyer_bank": "", "seller_name": "xxx投资发展有限公司", "seller_id": "913101177858977000", "seller_address": "xx市xx区xx镇xx路xx号 021-xxxx1000", "seller_bank": "xx银行xx支行310xxxxxxxxx00000000", "deductible_toll": "N", "items": [ { "name": "", "specification": "", "unit": "1", "quantity": "1", "unit_price": "1400.00", "amount": "1400.00", "tax_rate": "免税", "tax": "***", "license_plate_number": "", "vehicle_type": "", "start_date": "", "end_date": "" } ], "result_code": "1000", "result_message": "The invoice verification information is consistent with the tax authority’s information." } } 成功响应示例（机动车销售统一发票） { "result": { "type": "motor_vehicle_sales", "code": "14xxxxx20000", "number": "00xxxx94", "issue_date": "20171128", "machine_number": "49xxxxx10000", "status": "valid", "subtotal_amount": "68376.07", "total": "80000.00", "total_in_words": "捌万元整", "issuer": "", "buyer_name": "xx", "buyer_organization_number": "", "buyer_id": "", "seller_name": "xx汽车销售服务有限公司", "seller_id": "91xxxxx059xxxx0000", "seller_phone": "0898-xxxxxx00", "seller_account": "265xxxxxx000", "seller_address": "xx省xx市xx大道176号", "seller_bank": "中国银行xx支行", "tax_rate": "0.17", "tax": "11623.93", "tax_authority": "xx区局二分局户籍二组", "tax_authority_code": "146xxxxxx00", "tax_payment_receipt": "", "tonnage": "-", "seating_capacity": "5", "vehicle_type": "轿车", "brand_model": "北京牌BJxxxxxx000", "manufacturing_location": "北京", "quality_certificate": "YJxxxxxx270000", "import_certificate": "-", "inspection_number": "-", "engine_number": "BAxxxxx000", "vehicle_identification_number": "LNBSCxxxxx0000", "result_code": "1000", "result_message": "The invoice verification information is consistent with the tax authority’s information." } } 成功响应示例（二手车销售统一发票） { "result": { "type": "used_vehicle_sales", "code": "03xxxxxx0000", "number": "00xxx000", "issue_date": "20191202", "machine_number": "661xxxxxx000", "status": "valid", "total": "20000.00", "total_in_words": "贰万元整", "remarks": "卖方纳税人识别号:33xxxxx900xxxxx00 买方纳税人识别号:37xxxxxx561xxxxx00 初次登记：2014-07-24 免征税款", "issuer": "", "buyer_name": "xxx", "buyer_organization_number": "37xxxxxx561xxxxx00", "buyer_address": "xx省xx市xx路街道办事处xx庄居委会xx号", "buyer_phone": ".", "seller_name": "xxx", "seller_organization_number": "339xxxxxx009xxxx00", "seller_address": "xx省xx市xx市xx路xx号", "seller_phone": ".", "vehicle_license_plate_number": "苏Kxxxx0", "registration_certificate_number": "32xxxxxx0000", "vehicle_type": "小型轿车", "vehicle_identification_number": "LBxxxxxxZ3xxxxxx000", "brand_model": "xx牌HQxxxx000", "transfer_motor_vehicle_department_name": "xx车辆管理所", "auction_unit_name": "", "auction_unit_address": "", "auction_unit_tax_number": "", "auction_unit_bank_and_account": "", "auction_unit_phone": "", "used_vehicle_market_name": "xx旧机动车交易市场", "used_vehicle_market_tax_number": "91xxxxx2MAxxxxx000", "used_vehicle_market_address": "xx市xx区xx路xxx号", "used_vehicle_market_bank_and_account": "xxxx银行股份有限公司xxxx物流园分理处10xxxxx040xxxx00", "used_vehicle_market_phone": "13xxxxx0000", "result_code": "1000", "result_message": "The invoice verification information is consistent with the tax authority’s information." } } 状态码：400 失败响应示例 { "error_code": "AIS.0118", "error_msg": "Service request error." }

请求示例 “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/invoice-verification”，“project_id”为项目ID，获取方法请参见获取项目ID 如何获取Token请参见认证鉴权。 传入发票的代码、号码、发票日期、校验码后六位进行发票真伪核验 POST https://{endpoint}/v2/{project_id}/ocr/invoice-verification Request Header: Content-Type: application/json X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG... Request Body: { "code": "031001900000", "number": "12528000", "issue_date": "2020-08-09", "check_code": "000000" }

响应参数 根据识别的结果，可能有不同的HTTP响应状态码（status code）。例如，200表示API调用成功，400表示调用失败，详细的状态码和响应参数说明如下。 状态码： 200 表4 响应Body参数 参数 参数类型 描述 result Object 识别结果。 调用失败时不返回此字段。 依据发票类型不同，返回参数不同。 增值税发票 含增值税专用发票、增值税普通发票、增值税普通发票（卷式）、增值税电子专用发票、增值税电子普通发票、增值税电子普通发票（通行费）、区块链电子发票。 机动车销售统一发票 二手车销售统一发票 表5 InvoiceVerificationResult 增值税发票 参数 参数类型 描述 result Object 调用成功时返回的识别结果。 type String 发票类型，取值范围： 增值税专用发票：vat_special 增值税普通发票：vat_normal 增值税普通发票（卷式）：vat_normal_roll 增值税电子专用发票：vat_special_electronic 增值税电子普通发票：vat_normal_electronic 增值税电子普通发票（通行费）：vat_normal_electronic_toll 区块链电子发票：blockchain_electronic 全电专用发票：fully_digitalized_special_electronic 全电普通发票：fully_digitalized_normal_electronic code String 发票代码。 number String 发票号码。 issue_date String 开票日期。 machine_number String 机器编号。 check_code String 校验码。 status String 发票状态，取值范围： 正常：valid 已作废：invalidated 已红冲：reversed subtotal_amount String 合计金额(不含税）。 subtotal_tax String 合计税额。 total String 价税合计（小写）。 total_in_words String 价税合计（大写）。 remarks String 备注。 receiver String 收款人。 issuer String 开票人。 reviewer String 复核人。 buyer_name String 购买方名称。 buyer_id String 购买方纳税人识别号。 buyer_address String 购买方地址、电话。 buyer_bank String 购买方开户行及账号。 seller_name String 销售方名称。 seller_id String 销售方纳税人识别号。 seller_address String 销售方地址、电话。 seller_bank String 销售方开户行及账号。 deductible_toll String 通行费发票返回信息： Y：可抵扣通行费 N：不可抵扣通行费 result_code String 取值范围见表8。 result_message String 取值范围见表8。 items object 发票中包含的消费信息。 name String 货物或应税劳务、服务名称、项目名称（通行费）。 specification String 规格型号。 unit String 单位。 quantity String 数量。 unit_price String 单价。 amount String 金额。 tax_rate String 税率。 tax String 税额。 license_plate_number String 车牌号。 vehicle_type String 类型。 start_date String 通行日期起。 end_date String 通行日期止。 表6 InvoiceVerificationResult 机动车销售统一发票 参数 参数类型 描述 result object 调用成功时返回的识别结果。 type String 发票类型，取值范围： 机动车销售统一发票：motor_vehicle_sales。 code String 发票代码。 number String 发票号码。 issue_date String 开票日期。 machine_number String 机器编号。 status String 发票状态，取值范围： 正常：valid 已作废：invalidated 已红冲：reversed subtotal_amount String 不含税价（小写）。 total String 价税合计（小写）。 total_in_words String 价税合计（大写）。 issuer String 开票人。 buyer_name String 购方名称。 buyer_organization_number String 购买方身份证号码/组织机构代码。 buyer_id String 购买方纳税人识别号。 seller_name String 销货单位名称。 seller_id String 销售方纳税人识别号。 seller_phone String 销售方电话。 seller_account String 销售方账号。 seller_address String 销售方地址。 seller_bank String 销售方开户银行。 tax_rate String 税率。 tax String 税额。 tax_authority String 主管税务机关名称。 tax_authority_code String 主管税务机关代码。 tax_payment_receipt String 完税凭证号码。 tonnage String 吨位。 seating_capacity String 限乘人数。 vehicle_type String 车辆类型。 brand_model String 厂牌型号。 manufacturing_location String 产地。 quality_certificate String 合格证号。 import_certificate String 进口证明书号。 inspection_number String 商检单号。 engine_number String 发动机号码。 vehicle_identification_number String 车辆识别代号/车架号码。 result_code String 取值范围见表8。 result_message String 取值范围见表8。 表7 InvoiceVerificationResult 二手车销售统一发票 参数 参数类型 描述 result object 调用成功时返回的识别结果。 type String 发票类型，取值范围： 二手车销售统一发票：used_vehicle_sales。 code String 发票代码。 number String 发票号码。 issue_date String 开票日期。 machine_number String 机器编号。 status String 发票状态，取值范围： 正常：valid 已作废：invalidated 已红冲：reversed total String 车价合计（小写）。 total_in_words String 车价合计（大写）。 remarks String 备注。 issuer String 开票人。 buyer_name String 买方单位/个人。 buyer_organization_number String 买单位代码/身份证号码。 buyer_address String 买方单位/个人住址。 buyer_phone String 买方电话。 seller_name String 卖方单位/个人。 seller_organization_number String 卖方单位代码/身份证号码。 seller_address String 卖方单位 /个人住址。 seller_phone String 卖方电话。 vehicle_license_plate_number String 车牌照号。 registration_certificate_number String 登记证号。 vehicle_type String 车辆类型。 vehicle_identification_number String 车辆识别代号/车架号码。 brand_model String 厂牌型号。 transfer_motor_vehicle_department_name String 转入地车辆车管所名称。 auction_unit_name String 经营，拍卖单位。 auction_unit_address String 经营，拍卖单位地址。 auction_unit_tax_number String 经营，拍卖单位纳税人识别号。 auction_unit_bank_and_account String 开户银行及账号。 auction_unit_phone String 经营，拍卖单位电话。 used_vehicle_market_name String 二手车市场。 used_vehicle_market_tax_number String 二手车市场纳税人识别号。 used_vehicle_market_address String 二手车市场地址。 used_vehicle_market_bank_and_account String 二手车市场开户银行及账号。 used_vehicle_market_phone String 二手车市场电话。 result_code String 取值范围见表8。 result_message String 取值范围见表8。 表8 业务状态码 业务状态码（result_code） 描述信息（result_message） 处理方法 1000 The invoice verification information is consistent with the tax authority’s information. 无需处理，发票验证信息与税务机关信息一致。 1001 One invoice can be verified for only five times per day. 超过当天查验次数，请第二天再查验。 1002 The invoice verification information cannot be found in the tax authority’s information. 被查验发票信息有误，请核对发票信息是否填写正确。 1003 The invoice verification information is inconsistent with the tax authority’s information. 被查验发票信息有误，请核对发票信息是否填写正确。 1004 Only invoices issued within the last five years can be verified. 超过5年的发票不能查验。 1005 Unsupported invoice type. 被查验发票信息有误，请核对发票信息是否填写正确。 1006 The invoice verification information is abnormal in the tax authority’s information. 税局机关接口异常，请等候税局机关恢复后再重试(建议2小时后重试)。 1007 This batch of invoices is being verified. 该批次发票正在核验中，请第二天再查验。 1008 The request to the invoice verification service provided by the State Taxation Administration of China timed out. （税局机关）发票查询服务请求超时，请等候税局机关恢复后再重试(建议2小时后重试)。 1009 Verification request rejected. Online invoice verification is currently not supported in this region. （税局机关）查验请求被拒绝，此区域暂未开通线上查验通道。 1010 Parameter error. 参数错误，请检查请求参数是否填写正确。 状态码： 400 表9 响应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参数 参数 是否必选 参数类型 说明 code 是 String 发票代码。 发票种类为全电发票时，该参数须为空字符串。 number 是 String 发票号码。 issue_date 是 String 发票日期格式YYYY-MM-DD。 check_code 否 String 校验码后六位。 以下种类发票，check_code参数为必选。 增值税普通发票、增值税电子普通发票、增值税普通发票（卷式）、增值税电子普通发票（通行费）、区块链电子发票。 区块链电子发票需要填写5位校验码。 subtotal_amount 否 String 合计金额。和票据上的金额的有效数字保持一致，例如票据上的金额为88.00，则需要输入字符串为“88.00”，否则可能验真不成功。如果输入“88”或“88.0”可能会产生"result_code": "1010", " Parameter error."报错。 发票种类为全电发票时，该参数须为价税合计金额，其他票种使用不含税合计金额。 以下种类发票，参数不可为空。 增值税专用发票、增值税电子专用发票、机动车销售统一发票、二手车销售统一发票、区块链电子发票、全电发票。 填写发票合计金额（不含税） 增值税专用发票、增值税电子专用发票、机动车销售统一发票、区块链电子发票。 二手车发票需要填写发票车价合计金额。

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

约束与限制 支持增值税专用发票、增值税普通发票、增值税普通发票（卷式）、增值税电子专用发票、增值税电子普通发票、增值税电子普通发票（通行费）、二手车销售统一发票、机动车销售统一发票、区块链电子发票和全电发票，共计10种发票信息核验。 每份发票每天最多可查验5次。可查验最近5年内（国家税务总局）增值税发票管理系统开具的发票。 税务局数据同步有时延，建议当天新开的发票在24小时后查询。 文字识别服务属于公有云服务，线上用户资源共享，如果需要多并发请求，请提前联系我们。

功能介绍 支持10种增值税发票的信息核验： 增值税专用发票、增值税普通发票、增值税普通发票（卷式）、增值税电子专用发票、增值税电子普通发票、增值税电子普通发票（通行费）、二手车销售统一发票、机动车销售统一发票、区块链电子发票、全电发票，支持返回票面的全部信息。 该接口的使用限制请参见约束与限制，详细使用指导请参见OCR服务使用简介章节。 每份发票，每天最多可查验5次。 可查验最近5年内（国家税务总局）增值税发票管理系统开具的发票。 税务局数据同步有时延，建议当天新开的发票在24小时后查询。

请求示例 “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-table”，“project_id”为项目ID，获取方法请参见获取项目ID。 如何获取Token请参见认证鉴权。 传入表格图片的base64编码文字识别，并不返回置信度信息 POST https://{endpoint}/v2/{project_id}/ocr/general-table Request Header: Content-Type: application/json X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG... Request Body: { "image":"/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAAg...", "return_confidence":false } 传入表格图片的url进行文字识别，并不返回置信度信息 POST https://{endpoint}/v2/{project_id}/ocr/general-table Request Header: Content-Type: application/json X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG... Request Body: { "url":"https://BucketName.obs.xxxx.com/ObjectName", "return_confidence":false }

请求参数 表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例如https://support.huaweicloud.com/api-ocr/zh-cn_image_0282767866.png OBS提供的url，使用OBS数据需要进行授权。包括对服务授权、临时授权、匿名公开授权，详情参见配置OBS访问权限。 说明： 接口响应时间依赖于图片的下载时间，如果图片下载时间过长，会返回接口调用失败。 请保证被检测图片所在的存储服务稳定可靠，推荐使用OBS服务存储图片数据。 url中不能存在中文字符，若存在，中文需要进行utf8编码。 return_text_location 否 Boolean 返回文本块坐标及单元格坐标信息，可选值如下所示。 true：返回文本块和单元格坐标 false：不返回 如果未传入该参数时默认为false，即不返回。 return_char_location 否 Boolean 返回单字符的坐标信息，可选值包括： true：返回单字符的坐标 false：不返回 未传入该参数时默认为false，即不返回。如果此参数为true时，return_text_location必须为true return_confidence 否 Boolean 是否返回置信度的开关，可选值如下所示。 true：返回置信度 false：不返回置信度 如果未传入该参数，系统默认为“false”，即不返回置信度。 return_excel 否 Boolean 是否返回表格转换Microsoft Excel的Base64编码字段。可选值包括： true: 返回'excel'字段，表示xlsx格式的表格识别结果的Base64编码 false: 不返回。默认为false 对返回的Excel编码，可用Python函数 base64.b64decode解码后保存为.xlsx文件。 return_rectification_matrix 否 Boolean 可选值包括： true：返回透视变换矩阵 false：不返回 未传入该参数时默认为false，即不返回透视变换矩阵。 with_borders 否 Boolean 可选值包括： true：输入图像仅包含有线表格，仅进行有线表格识别。 false: 输入图像可能包含无线表格，同时进行有线表格与无线表格识别。 未传入该参数时默认为false，即同时进行有线表格与无线表格识别。当确认输入仅包含有线表格时，该参数设为true可达到更优识别效果。

响应示例 状态码： 200 成功响应样例 { "result" : { "words_region_count" : 2, "words_region_list" : [ { "type" : "text", "words_block_count" : 1, "words_block_list" : [ { "words" : "文字区域识别文字块1", "confidence" : 0.9991 } ] }, { "type" : "table", "words_block_count" : 2, "words_block_list" : [ { "words" : "表格区域识别文字块1", "confidence" : 0.9942, "rows" : [ 0 ], "columns" : [ 0 ] }, { "words" : "表格区域识别文字块2", "confidence" : 0.914, "rows" : [ 0 ], "columns" : [ 1, 2 ] } ] } ] } } 状态码： 400 失败响应样例 { "result" : { "error_code" : "AIS.0103", "error_msg" : "The image size does not meet the requirements." } }

功能介绍 识别表格图片中的文字内容，并将识别的结果以JSON格式返回给用户。返回结果将图片区域（words_region）划分为两类：纯文本区（text）和表格区（table），并返回表格结构（row, column）和文本信息。该接口的使用限制请参见约束与限制，详细使用指导请参见OCR服务使用简介章节。 对于相同板式的图片，可以使用ModelArts Pro服务提供的文字识别套件，零代码搭建出专属的API，详细操作请参见视频指导。 图1 通用表格示例图

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

响应参数 根据识别的结果，可能有不同的HTTP响应状态码（status code）。例如，200表示API调用成功，400表示调用失败，详细的状态码和响应参数说明如下。 状态码： 200 表4 响应Body参数 参数 参数类型 描述 result BusinessCardResult object 识别结果。 调用失败时不返回此字段。 表5 BusinessCardResult 参数 参数类型 描述 name Array of strings 姓名列表。 title Array of strings 职位头衔列表。 company Array of strings 公司列表。 department Array of strings 部门列表。 phone Array of strings 联系方式列表。 address Array of strings 地址列表。 email Array of strings 邮箱列表。 fax Array of strings 传真列表。 postcode Array of strings 邮编列表。 website Array of strings 公司网址列表。 extra_info_list Array of ExtraInfoList objects 其余信息列表。 adjusted_image String 返回矫正后的名片图像的BASE64编码。 表6 ExtraInfoList 参数 参数类型 描述 item String 表示“key”值，例如：bank等。 value String 表示“value”值，例如：bank等。 note Array of strings 对应“item”关联的额外信息，为“bank”时第一个默认为户名，第二个为开户行。 状态码： 400 表7 响应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/business-card”，“project_id”为项目ID，获取方法请参见获取项目ID 如何获取Token请参见认证鉴权。 传入名片图片的base64编码进行文字识别 POST https://{endpoint}/v2/{project_id}/ocr/business-card Request Header: Content-Type: application/json X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG... Request Body: { "image":"/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAA..." } 传入名片图片的url进行文字识别 POST https://{endpoint}/v2/{project_id}/ocr/business-card Request Header: Content-Type: application/json X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG... Request Body: { "url":"https://BucketName.obs.xxxx.com/ObjectName" }

响应示例 状态码：200 成功响应示例 { "result": { "name": ["XX"], "title": ["销售总监"], "company": ["XX有限公司"], "department": ["XX产品部"], "phone": ["+XX XXX XXXX XXXX","XXXX XXXXXXXXX"], "address": ["XXXX"], "email": ["XX"], "fax": ["XXXX XXXXXXXX"], "postcode": [], "website": ["XX"], "extra_info_list": [ { "item": "bank", "value": "XXXXXXXXXXXXXXX", "note": ["张三","XX"] } ] } } 状态码：400 失败响应示例 { "error_code": "AIS.0103", "error_msg": "The image size does not meet the requirements." }