华为云用户手册

响应示例 状态码：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." }

请求参数 表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编码。

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

基本概念 账号 用户注册华为云时的账号，账号对其所拥有的资源及云服务具有完全的访问权限，可以重置用户密码、分配用户权限等。由于账号是付费主体，为了确保账号安全，建议您不要直接使用账号进行日常管理工作，而是创建用户并使用他们进行日常管理工作。 用户 由账号在IAM中创建的用户，是云服务的使用人员，具有身份凭证（密码和访问密钥）。 在我的凭证下，您可以查看账号ID和用户ID。通常在调用API的鉴权过程中，您需要用到账号、用户和密码等信息。 区域（Region） 从地理位置和网络时延维度划分，同一个Region内共享弹性计算、块存储、对象存储、VPC网络、弹性公网IP、镜像等公共服务。Region分为通用Region和专属Region，通用Region指面向公共租户提供通用云服务的Region；专属Region指只承载同一类业务或只面向特定租户提供业务服务的专用Region。 详情请参见区域和可用区。 可用区（AZ，Availability Zone） 一个AZ是一个或多个物理数据中心的集合，有独立的风火水电，AZ内逻辑上再将计算、网络、存储等资源划分成多个集群。一个Region中的多个AZ间通过高速光纤相连，以满足用户跨AZ构建高可用性系统的需求。 项目 华为云的区域默认对应一个项目，这个项目由系统预置，用来隔离物理区域间的资源（计算资源、存储资源和网络资源），以默认项目为单位进行授权，用户可以访问您账号中该区域的所有资源。如果您希望进行更加精细的权限控制，可以在区域默认的项目中创建子项目，并在子项目中购买资源，然后以子项目为单位进行授权，使得用户仅能访问特定子项目中资源，使得资源的权限控制更加精确。 图1 项目隔离模型 父主题： 使用前必读

响应示例 状态码：200 成功响应示例 { "result": { "words_block_count": 2, "words_block_list": [ { "words": "大江东去", "type": "text", "confidence": 0.98, "location": [ [282, 45], [461, 47], [460, 77], [280, 76] ] }, { "words": "浪淘尽", "type": "text", "confidence": 0.99, "location": [ [949, 52], [1095, 53], [1100, 87], [953, 86] ] } ] } } 状态码：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例如https://support.huaweicloud.com/api-ocr/zh-cn_image_0288038984.png OBS提供的url，使用OBS数据需要进行授权。包括对服务授权、临时授权、匿名公开授权，详情参见配置OBS访问权限。 说明： 接口响应时间依赖于图片的下载时间，如果图片下载时间过长，会返回接口调用失败。 请保证被检测图片所在的存储服务稳定可靠，推荐使用OBS服务存储图片数据。 url中不能存在中文字符，若存在，中文需要进行utf8编码。 quick_mode 否 Boolean 快速模式开关，针对单行文字图片（要求图片只包含一行文字，且文字区域占比超过50%），打开时可以更快返回识别内容。可选值如下所示。 true：打开快速模式 false：关闭快速模式 未传入该参数时默认为false，即关闭快速模式。 char_set 否 String 字符集设置，用户可以根据实际需要限定输出字符集范围。可选值如下所示。 digit：数字模式 letter：大小写字母模式 digit_letter：数字+字母模式 general：数字+字母+中文模式 未传入该参数时，默认为“general”模式。 detect_direction 否 Boolean 是否校正图片的倾斜角度，可选值如下。 true：校正图片的倾斜角度 false：不校正图片的倾斜角度 支持任意角度的校正，未传入该参数时默认为“false”。 待识别图片如果存在倾斜，建议将此参数设置为“true”。

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

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

使用临时授权请求鉴权 开启公共读授权访问，虽然使用比较方便，但若对于敏感的信息，例如个人的私有数据，存在泄露风险。此场景下，可以考虑OBS提供的临时授权功能。 OBS服务支持用户对OBS服务中的对象构造一个特定URL，URL中会包含鉴权信息，任何用户都可以通过该URL访问OBS中的对象，但该URL只在Expires指定的失效时间内有效。该方式用于在不提供给其他人Secret Access Key的情况下，让其他人能够执行自己定义的操作。 进一步了解和使用OBS临时授权功能，请参见《对象存储服务SDK参考》对应语言的“授权访问”章节的相关内容，下载相关的SDK及示例代码，并进行相关的编码开发，以支持相关的URL获取。

响应示例 状态码：200 成功响应示例 { "result" : { "extracted_data" : { "contact_info" : { "name" : "张三", "phone" : "13112345678", "province" : "广东省", "city" : "深圳市", "district" : "龙岗区", "detail_address" : "五和大道华为D区" }, "image_size" : { "height" : 480, "width" : 640 } }, "words_block_count" : 2, "words_block_list" : [ { "words" : "收件人：张三，联系电话：13112345678，收件地址：广东省深圳市龙岗区五和大道华为D区", "confidence" : 0.9188, "location" : [ [ 13, 476 ], [ 91, 332 ], [ 125, 351 ], [ 48, 494 ] ], "font_list" : [ "黑体", "Arial", "华文中宋体", "微软正黑粗体", "文泉驿等宽正黑体" ], "font_scores" : [ 0.36, 0.2761, 0.2117, 0.0616, 0.0606 ] }, { "words" : "方正字体", "confidence" : 0.8631, "location" : [ [ 13, 476 ], [ 91, 332 ], [ 125, 351 ], [ 48, 494 ] ], "font_list" : [ "方正铭石体", "方正黑简体", "文泉驿等宽正黑体", "腾祥孔淼石头简体", "微软正黑粗体" ], "font_scores" : [ 0.9999, 0.0, 0.0, 0.0, 0.0 ] } ] } } 状态码：400 失败响应示例 { "error_code": "AIS.0103", "error_msg": "The image size does not meet the requirements." }

请求示例 “endpoint”即调用API的请求地址，不同服务不同区域的“endpoint”不同，具体请参见终端节点。 例如，网络图片识别服务部署在“华南-广州”区域的“endpoint”为“ocr.cn-south-1.myhuaweicloud.com”或“ocr.cn-south-1.myhuaweicloud.cn”，请求URL为“https://ocr.cn-south-1.myhuaweicloud.com/v2/{project_id}/ocr/web-image”，“project_id”为项目ID，获取方法请参见获取项目ID。 如何获取Token请参见认证鉴权。 传入网络图片的base64编码进行文字识别，识别过程校验图片倾斜角度，判断待识别字体类型，并校验图片是否包含联系人信息 POST https://{endpoint}/v2/{project_id}/ocr/web-image Request Header: Content-Type: application/json X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG... Request Body: { "image":"/9j/4AAQSkZJRgABAgEASABIAAD/...", "extract_type" : [ "contact_info", "image_size" ], "detect_direction" : true, "detect_font" : true } 传入网络图片的url进行文字识别，识别过程校验图片倾斜角度，判断待识别字体类型，并校验图片是否包含联系人信息 POST https://{endpoint}/v2/{project_id}/ocr/web-image Request Header: Content-Type: application/json X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG... Request Body: { "url":"https://BucketName.obs.xxxx.com/ObjectName", "extract_type" : [ "contact_info", "image_size" ], "detect_direction" : true, "detect_font" : true }

请求参数 表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）。 企业项目创建步骤请参见用户指南。 说明： 该功能仅支持开通在华北-北京四、华东-上海一区域的API。 创建企业项目后，在传参时，有以下三类场景。 携带正确的ID，正常使用OCR服务，账单归到企业ID对应的企业项目中。 携带错误的ID，正常使用OCR服务，账单的企业项目会被分类为“未归集”。 不携带ID，正常使用OCR服务，账单的企业项目会被分类为“未归集”。 表3 请求Body参数 参数 是否必选 参数类型 说明 image 否 String 该参数与url二选一。 图片的Base64编码，要求Base64编码后大小不超过10MB。 图片最短边不小于15px，最长边不超过8192px，支持JPG、JPEG、PNG、BMP、TIFF、TGA、WEBP、ICO、PCX、GIF格式。 图片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_0288038400.png OBS提供的url，使用OBS数据需要进行授权。包括对服务授权、临时授权、匿名公开授权，详情参见配置OBS访问权限。 说明： 接口响应时间依赖于图片的下载时间，如果图片下载时间过长，会返回接口调用失败。 请保证被检测图片所在的存储服务稳定可靠，推荐使用OBS服务存储图片数据。 url中不能存在中文字符，若存在，中文需要进行utf8编码。 detect_direction 否 Boolean 是否校正图片的倾斜角度，可选值如下。 true：校正图片的倾斜角度 false：不校正图片的倾斜角度 支持任意角度的校正，未传入该参数时默认为“false”。 待识别图片如果存在倾斜，建议将此参数设置为“true”。 extract_type 否 Array of strings 结构化数据提取参数列表，目前只支持联系人信息、图像宽高，其入参值分别为“contact_info”，“image_size”。 若不填写该参数或删除该参数，默认不提取该参数值。 detect_font 否 Boolean 为Boolean类型，若不传该字段，默认不检测切片字体，为True时，将检测切片的字体类型，并返回最相似的5种字体名称。 detect_text_direction 否 Boolean 为Boolean类型，若不传该字段，默认为True，即检测每个字段的文字方向。为False时，则不检测文字方向。若图片中所有文字方向均是水平朝上时，建议将该值设为False，即不检测文字方向。

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

响应示例 状态码：200 成功响应示例1 { "result" : { "code" : "144031624150", "number" : "00446874", "machine_printed_code" : "144031624150", "machine_printed_number" : "00446874", "issue_date" : "2017-07-19", "machine_number" : "49991450XXXX", "buyer_name" : "深圳市宝安区XXX", "buyer_organization_number" : "XXX", "buyer_id" : "XXX", "seller_name" : "深圳市XXX服务有限公司", "seller_phone" : "0755-XXX", "seller_id" : "XXX", "seller_account" : "XXX", "seller_address" : "深圳市宝安区松岗街道办XXX", "seller_bank" : "建设银行深圳XX支行", "vehicle_type" : "多用途乘用车", "brand_model" : "东风日产牌/XXX", "manufacturing_location" : "大连市", "quality_certificate" : "XXX", "import_certificate" : "", "inspection_number" : "", "engine_number" : "XXX", "vehicle_identification_number" : "XXX", "tonnage" : "", "seating_capacity" : "5", "tax_authority" : "深圳市宝安区国家税务局XXX税务分局", "tax_authority_code" : "144030614", "tax_payment_receipt" : "", "tax_rate" : "17%", "tax" : "￥21475.21", "tax_exclusive_price" : "￥126324.79", "total" : "￥147800.00", "total_chinese" : "壹拾肆万柒仟捌佰圆整", "fiscal_code" : "" } } 成功响应示例2 { "result" : { "used_vehicle_market_name" : "动车交易有限公司", "auction_org_bank_account" : "10468888888830", "seller_phone" : "13988888888", "buyer_id" : "AB37836SDWGDUOHDOEHD3", "machine_printed_number" : "00888858", "auction_org_id" : "AB37836SDWGDUOHDOEHD3", "auction_org_name" : "某拍卖行", "buyer_name" : "汽车贸易有限公司", "used_vehicle_market_id" : "91DEDD3782733DJ6R", "used_vehicle_market_phone" : "07588888888", "code" : "044008888817", "machine_number" : "4888888182", "used_vehicle_market_address" : "佛山市", "seller_address" : "广东省佛山市", "auction_org_address" : "广东省佛山市", "brand_model" : "吉利莫车型", "licence_plate_number" : "粤A88888", "seller_id" : "AB37836SDWGDUOHDOEHD3", "machine_printed_code" : "10468888888830", "registration_number" : "1234EHWEGG8888830", "buyer_phone" : "13988888888", "vehicle_type" : "小型轿车", "drawer_name" : "张三", "total" : "￥20000.00", "total_chinese" : "贰万圆整", "issue_date" : "1987-12-27", "seller_name" : "李四", "vehicle_identification_number" : "L6T7804826379E3GG875", "auction_org_phone" : "13988888888", "used_vehicle_market_bank_account" : "中国农业银行", "buyer_address" : "佛山市", "dept_motor_vehicles" : "广东省佛山市车管所", "remark" : "免税开具", "reverse_issue" : false, "number" : "003753534", "fiscal_code" : "017807816386738245", "type" : "二手车销售统一发票" } } 状态码：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/mvs-invoice”，“project_id”为项目ID，获取方法请参见获取项目ID 如何获取Token请参见认证鉴权。 传入机动车销售发票图片的base64编码进行文字识别 POST https://{endpoint}/v2/{project_id}/ocr/mvs-invoice Request Header: Content-Type: application/json X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG... Request Body: { "image" : "/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAA...", "type" : "auto" } 传入机动车销售发票图片的url进行文字识别 POST https://{endpoint}/v2/{project_id}/ocr/mvs-invoice Request Header: Content-Type: application/json X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG... Request Body: { "url":"https://BucketName.obs.xxxx.com/ObjectName" }

响应参数 根据识别的结果，可能有不同的HTTP响应状态码（status code）。例如，200表示API调用成功，400表示调用失败，详细的状态码和响应参数说明如下。 状态码： 200 表4 响应Body参数 参数 参数类型 描述 result MvsInvoiceResult object 识别结果。 调用失败时不返回此字段。 表5 MvsInvoiceResult 参数 参数类型 描述 code String 发票代码。 number String 发票号码。 machine_printed_code String 机打代码。 machine_printed_number String 机打号码。 issue_date String 开票日期。 machine_number String 机器编号。 buyer_name String 购买方的名称、二手车买方单位/个人。 buyer_organization_number String 购买方身份证号码/组织机构代码。 buyer_id String 购买方纳税人识别号、二手车买方单位代码/身份证号。 buyer_address String 二手车买方单位/个人住址，当请求参数"type"设置为"auto"或"used"时才返回。 buyer_phone String 二手车买方单位/个人电话，当请求参数"type"设置为"auto"或"used"时才返回。 seller_name String 销货单位名称、二手车卖方单位/个人。 seller_phone String 销售方电话、二手车卖方电话。 seller_id String 销售方纳税人识别号、二手车卖方单位代码/身份证号。 seller_account String 销售方账号。 seller_address String 销售方地址、二手车卖方单位/个人地址。 licence_plate_number String 二手车车牌照号，当请求参数"type"设置为"auto"或"used"时才返回。 registration_number String 二手车登记证号，当请求参数"type"设置为"auto"或"used"时才返回。 dept_motor_vehicles String 二手车转入地车管所名称，当请求参数"type"设置为"auto"或"used"时才返回。 seller_bank 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 车辆识别代号/车架号码。 tonnage String 吨位。 seating_capacity String 限乘人数。 tax_authority String 主管税务机关。 tax_authority_code String 主管税务机关代码。 tax_payment_receipt String 完税凭证号码。 tax_rate String 增值税税率或征收率。 tax String 增值税税额。 tax_exclusive_price String 不含税价。 total String 价税合计、二手车车价合计（小写）。 total_chinese String 价税合计大写、二手车车价合计（大写）。 fiscal_code String 税控码。 auction_org_name String 二手车经营拍卖单位名称，当请求参数"type"设置为"auto"或"used"时才返回。 auction_org_address String 二手车经营拍卖单位地址，当请求参数"type"设置为"auto"或"used"时才返回。 auction_org_id String 二手车经营拍卖单位纳税人识别号，当请求参数"type"设置为"auto"或"used"时才返回。 auction_org_bank_account String 二手车经营拍卖单位银行和账号，当请求参数"type"设置为"auto"或"used"时才返回。 auction_org_phone String 二手车经营拍卖单位电话，当请求参数"type"设置为"auto"或"used"时才返回。 used_vehicle_market_name String 二手车市场名称，当请求参数"type"设置为"auto"或"used"时才返回。 used_vehicle_market_id String 二手车市场纳税人识别号，当请求参数"type"设置为"auto"或"used"时才返回。 used_vehicle_market_address String 二手车市场地址，当请求参数"type"设置为"auto"或"used"时才返回。 used_vehicle_market_bank_account String 二手车市场银行和账号，当请求参数"type"设置为"auto"或"used"时才返回。 used_vehicle_market_phone String 二手车市场电话，当请求参数"type"设置为"auto"或"used"时才返回。 reverse_issue Boolean 二手车反向开具标识，True表示是反向开具发票，False表示不是反向开具发票。 当请求参数"type"设置为"auto"或"used"时才返回。 remark String 备注。 drawer_name String 开票人。 type String 枚举值，机动车销售统一发票或者二手车销售统一发票。 当入参中包含type时返回。 text_location Object 检测框对象，内部为字段-框坐标对。如 code:[[x0, y0],[x1,y1],[x2,y2],[x3,y3]], 点的顺序是左上角、右上角、右下角、左下角。如果原图找不到字段，返回空列表。 confidence Object 字段文字内容置信度，内容为字段-字符置信度对,如code:0.9999。这个数值为字段中每个字符置信度，格式为fp32，保留四位。若字段不存在则返回0.0。 状态码： 400 表6 响应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、PDF格式。多页PDF仅识别第一页。 图片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，返回体中会包含text_location对象，内容是各字段的检测框四点坐标。 如果为False或者没有这个key，返回体中不包含text_location对象。 return_confidence 否 Boolean 如果为True，返回体中包含confidence对象，内容是各字段的置信度。 如果为False或者没有这个key，返回体中不包含confidence对象。 type 否 String 如果没有type字段则默认返回原机动车销售发票出参。 如果存在type字段但是不属于 auto、new或者used三个枚举值，API返回AIS.0101入参错误。 如果type为auto，API自动判断发票类型，并在返回参数中添加type出参以指明发票类型。 如果type为new，API在检测出的类型为机动车发票时返回原版机动车发票出参并添加type出参（机动车销售统一发票），不一致时报错AIS.0104图像质量差。 如果type为used，API在检测出的类型为二手车时返回二手车发票出参，并添加type出参（二手车销售统一发票），不一致时报错AIS.0104图像质量差。

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

请求URI 请求URI由如下部分组成。 {URI-scheme} :// {endpoint} / {resource-path} ? {query-string} 尽管请求URI包含在请求消息头中，但大多数语言或框架都要求您从请求消息中单独传递它，所以在此单独强调。 表1 URI中的参数说明 参数 说明 URI-scheme 表示用于传输请求的协议，当前所有API均采用HTTPS协议。 endpoint 指定承载REST服务端点的服务器域名或IP，不同服务不同区域的endpoint不同，您可以从终端节点章节查看。 例如OCR服务在“华北-北京四”区域的“endpoint”为“ocr.cn-north-4.myhuaweicloud.com”。 resource-path 资源路径，也即API访问路径。 从具体API的URI章节获取，例如网络图片识别API的“resource-path”为“v2/{project_id}/ocr/web-image”。 query-string 查询参数，是可选部分，并不是每个API都有查询参数。查询参数前面需要带一个“？”，形式为“参数名=参数取值”，例如“limit=10”，表示查询不超过10条数据。 例如，在“华北-北京四”区域调用网络图片识别API，则需使用“华北-北京四”区域的endpoint（ocr.cn-north-4.myhuaweicloud.com），拼接起来如下所示。 https://ocr.cn-north-4.myhuaweicloud.com/v2/{project_id}/ocr/web-image 图1 URI示意图 为查看方便，在每个具体API的URI部分，只给出resource-path部分，并将请求方法写在一起。这是因为URI-scheme都是HTTPS，而endpoint在同一个区域也相同，所以简洁起见将这两部分省略。

请求方法 HTTP请求方法（也称为操作或动词），它告诉服务你正在请求什么类型的操作。 表2 HTTP方法 方法 说明 GET 请求服务器返回指定资源。 PUT 请求服务器更新指定资源。 POST 请求服务器新增资源或执行特殊操作。 DELETE 请求服务器删除指定资源，如删除对象等。 HEAD 请求服务器资源头部。 PATCH 请求服务器更新资源的部分内容。 当资源不存在的时候，PATCH可能会去创建一个新的资源。 例如，网络图片识别URI部分，您可以看到其请求方法为“POST”，则其请求为： POST https://ocr.cn-north-4.myhuaweicloud.com/v2/{project_id}/ocr/web-image

请求消息头 附加请求头字段，如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”，请求鉴权信息等。 Content-Type：消息体的类型（格式），必选，默认取值为“application/json”，有其他取值时会在具体接口中专门说明。 X-Auth-Token：用户Token，可选，当使用Token方式认证时，必须填充该字段。用户Token请参考认证鉴权章节。 添加消息头后的请求如下所示。 POST https://ocr.cn-north-4.myhuaweicloud.com/v2/{project_id}/ocr/web-image Content-Type: application/json x-auth-token: MIIaBgYJKoZIhvcNAQcC…

请求消息体 请求消息体通常以结构化格式发出，与请求消息头中Content-type对应，传递除请求消息头之外的内容。若请求消息体中参数支持中文，则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。 例如，对于网络图片识别接口，您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示。 POST https://ocr.cn-north-4.myhuaweicloud.com/v2/{project_id}/ocr/web-image Request Header: Content-Type: application/json X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG... Request Body: { "image":"/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAAgABwESAAMAA..." } 到这里为止这个请求需要的内容就具备齐全了，您可以使用curl、Postman或直接编写代码等方式发送请求调用API。

响应示例 状态码：200 成功响应示例 { "result": { "location": "上海市", "code": "130XXXXXXXX88", "number": "00XXXX08", "phone_number": "62XXX22", "company": "", "taxi_number": "GXXXXXX", "certificate_number": "3XXXX9", "identification_number": "", "date": "2019-03-15", "boarding_time": "12:03", "alighting_time": "12:15", "time": "12:03-12:15", "unit_price": "￥2.50", "distance": "7.8", "waiting_time": "00:02:09", "fare": "￥29.00", "fuel_oil_surcharge": "￥0.00", "call_service_surcharge": "￥0.00", "total": "￥29.00", "confidence": { "location": 0.9977, "code": 0.9998, "number": 0.9976, "phone_number": 0.859, "company": 0, "taxi_number": 0.9607, "certificate_number": 0.9411, "identification_number": 0, "date": 0.9665, "boarding_time": 0.9847, "alighting_time": 0.9798, "time": 0.9798, "unit_price": 0.9174, "distance": 0.9731, "waiting_time": 0.9936, "fare": 0.9896, "fuel_oil_surcharge": 0.8433, "call_service_surcharge": 0.7843, "total": 0.9896 } } } 状态码：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/taxi-invoice”，“project_id”为项目ID，获取方法请参见获取项目ID 如何获取Token请参见认证鉴权。 传入出租车发票图片的base64编码进行文字识别 POST https://{endpoint}/v2/{project_id}/ocr/taxi-invoice Request Header: Content-Type: application/json X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG... Request Body: { "image":"/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAA..." } 传入出租车发票图片的url进行文字识别 POST https://{endpoint}/v2/{project_id}/ocr/taxi-invoice Request Header: Content-Type: application/json X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG... Request Body: { "url":"https://BucketName.obs.xxxx.com/ObjectName" }

响应参数 根据识别的结果，可能有不同的HTTP响应状态码（status code）。例如，200表示API调用成功，400表示调用失败，详细的状态码和响应参数说明如下。 状态码： 200 表4 响应Body参数 参数 参数类型 描述 result TaxiInvoiceResult object 识别结果。 调用失败时不返回此字段。 表5 TaxiInvoiceResult 参数 参数类型 描述 location String 归属地区。 code String 发票代码。 number String 发票号码。 phone_number String 电话（包括电话、监督电话）。 company String 单位。 taxi_number String 车号。 certificate_number String 证号。 identification_number String 识别编号。 date String 开票日期。 boarding_time String 上车时间。 alighting_time String 下车时间。 time String 时间(起止时间、上下车时间)。 unit_price String 单价。 distance String 总里程。 waiting_time String 等候时间。 fare String 金额。 fuel_oil_surcharge String 燃油附加费。 call_service_surcharge String 电调费（预约费）。 total 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/taxi-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类型，则会报非法参数错误。

配置介绍 表1 配置说明 参数 配置说明 使用当前用户token 是否使用当前用户token来获得鉴权。 获取token地址 如不使用当前用户token，需配置token地址。 获取token请求体 如不使用当前用户token，需配置token请求体。 请求地址 配置请求地址。 请求参数 （可选）配置请求参数。 请求头 （可选）配置请求头。 请求方式 配置请求方式，支持如下请求方式。 GET PUT POST DELETE PATCH 请求体 （可选）输入请求体内容。 任务名称 请自定义输入任务名称。

开通功能模块 进入开通功能模块页面。 在“开通功能模块”页面，单击勾选所需多活版本和功能点，单击右下角的“确定”。 图1 开通功能模块 表1 功能模块配置参数 参数 配置说明 版本 选择多活版本，可选择“同城多活”或“异地多活”。 功能点 “同城多活”选择如下所需功能点： MySQL Oracle PostgreSQL Redis MongoDB Elasticsearch OpenGauss API监控 收费模式 开通功能模块的收费模式，默认“按需计费”。具体计费说明，请参考价格详情。

配置介绍 表1 配置说明 参数 配置说明 任务所在region 选择任务所在区域。 内网域名 选择内网域名。 记录集类型 选择记录集类型。 A – 将域名指向IPv4地址 CNAME – 将域名指向另外一个域名 MX – 将域名指向邮件服务器地址 TXT – 设置文本记录 SRV – 记录提供特定服务的服务器 记录集的值 填写记录集的值。 主机记录 填写主机记录。 主机记录指域名前缀，如不填写，默认添加时使用内网域名。当“记录集类型”选择“CNAME”时，主机记录为必填项。 TTL（单位：秒） 填写TTL值。 TTL(Time-To-Live)指解析记录在本地DNS服务器中的缓存时间。如果您的服务地址经常更换，建议TTL值设置相对小些，反之，建议设置相对大些。 TTL应为300~2147483647之间的整数，如不填写，则默认300秒。 任务名称 请自定义输入任务名称。