# 不动产证识别 - RecognizeRealEstateCertificate #### 功能介绍 识别不动产证中的文字信息，并返回识别的结构化结果。 ![](https://support.huaweicloud.com/api-ocr/public_sys-resources/note_3.0-zh-cn.png) 如果图片中包含多张卡证票据，请调用[智能分类识别](https://support.huaweicloud.com/api-ocr/ocr_03_0113.html)服务。 #### 约束与限制 - 只支持识别PNG、JPG、JPEG、BMP、TIFF格式的图片。 - 图像各边的像素大小在15到8192px之间。单个图片对应的Base64编码不超过10MB。 - 支持图像中不动产证任意角度的水平旋转。 - 能处理反光、暗光等干扰的图片但影响识别精度。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-ocr/ocr_03_0165.html)。 #### 前提条件 在使用之前，需要您完成服务申请和认证鉴权，具体操作流程请参见[开通服务](https://support.huaweicloud.com/api-ocr/ocr_03_0043.html)和[认证鉴权](https://support.huaweicloud.com/api-ocr/ocr_03_0005.html)章节。 ![](https://support.huaweicloud.com/api-ocr/public_sys-resources/note_3.0-zh-cn.png) 用户首次使用需要先[申请开通](https://console.huaweicloud.com/ocr)。服务只需要开通一次即可，后面使用时无需再次申请。如未开通服务，调用服务时会提示ModelArts.4204报错，请在调用服务前先进入控制台开通服务，并注意开通服务区域与调用服务的区域保持一致。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/usermanual-ocr/ocr_01_0105.html)。 #### URI POST /v2/{project_id}/ocr/real-estate-certificate 表1路径参数 | 参数 | 是否必选 | 说明 | |:---|:---|:---| | endpoint | 是 | 终端节点，即调用API的请求地址。 不同服务不同区域的endpoint不同，您可以从[终端节点](https://support.huaweicloud.com/api-ocr/ocr_03_0062.html)中获取。 例如，OCR服务在"华北-北京四"区域的"endpoint"为"ocr.cn-north-4.myhuaweicloud.com"。 | | project_id | 是 | 项目ID，您可以从[获取项目ID](https://support.huaweicloud.com/api-ocr/ocr_03_0130.html)中获取。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | 用户Token。 用于获取操作API的权限。[获取Token接口](https://support.huaweicloud.com/api-ocr/ocr_03_0005.html)响应消息头中X-Subject-Token的值即为Token。 | | Enterprise-Project-Id | 否 | String | 企业项目ID。OCR支持通过企业项目管理（EPS）对不同用户组和用户的资源使用，进行分账。 获取方法：进入"[企业项目管理](https://console.huaweicloud.com/eps/?#/eps/manager/projects)"页面，单击企业项目名称，在企业项目详情页获取Enterprise-Project-Id（企业项目ID）。 ![](https://support.huaweicloud.com/api-ocr/zh-cn_image_0000001699004098.png "点击放大") 企业项目创建步骤请参见用户指南。 说明： 创建企业项目后，在传参时，有以下三类场景。 - 携带正确的ID，正常使用OCR服务，账单的企业项目会被分类到企业ID对应的企业项目中。 - 携带格式正确但不存在的ID，正常使用OCR服务，账单的企业项目会显示对应不存在的企业项目ID。 - 不携带ID或格式错误ID（包含特殊字符等），正常使用OCR服务，账单的企业项目会被分类到"default"中。 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | image | 否 | String | 与url二选一。 图像数据，base64编码，单个图片其对应的Base64编码不超过10MB。图片在Base64编码后会大于图片原本大小，请注意做好边界判断，建议图片大小不超过7MB。图片最小边不小于15像素，最长边不超过8192像素。支持JPG/PNG/BMP/TIFF格式。 图片Base64编码示例如/9j/4AAQSkZJRgABAg...，带有多余前缀会产生The image format is not supported报错。 | | url | 否 | String | 与image二选一。 url中单个图片其对应的Base64编码不超过10MB。图片在Base64编码后会大于图片原本大小，请注意做好边界判断，建议图片大小不超过7MB。图片的URL路径目前仅支持华为云上OBS提供的匿名公开授权访问的URL以及公网URL。 说明： - 接口响应时间依赖于图片的下载时间，如果图片下载时间过长，会返回接口调用失败。 - 请保证被检测图片所在的存储服务稳定可靠，推荐使用OBS服务存储图片数据。 | #### 响应参数 **状态码： 200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | result | [RealEstateCertificateResult] object | 调用成功时表示调用结果。 调用失败时无此字段。 | 表5RealEstateCertificateResult | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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 | 调用失败时的错误码，具体请参见[错误码](https://support.huaweicloud.com/api-ocr/ocr_03_0028.html)。 调用成功时不返回此字段。 | | error_msg | String | 调用失败时的错误信息。 调用成功时无此字段。 | #### 请求示例 ![](https://support.huaweicloud.com/api-ocr/public_sys-resources/note_3.0-zh-cn.png) - Endpoint即调用API的请求地址，不同服务不同区域的Endpoint不同，具体请参见[终端节点](https://support.huaweicloud.com/api-ocr/ocr_03_0062.html)。 例如，不动产证识别服务部署在"华北-北京四"区域的"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](https://support.huaweicloud.com/api-ocr/ocr_03_0130.html)。 - 如何获取Token请参见[认证鉴权](https://support.huaweicloud.com/api-ocr/ocr_03_0005.html)。 - 传入不动产证图片的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" } ``` #### 响应示例 **状态码： 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.0, "ownership_certificate_no" : 0.8931, "obligee" : 0.8879, "ownership" : 0.2806, "estate_location" : 0.8145, "right_type" : 0.0, "right_nature" : 0.0, "usage" : 0.0, "intended_usage" : 0.0, "area" : 0.6588, "total_floors" : 0.0, "floor" : 0.0, "issuer" : 0.974, "issue_date" : 0.9198, "real_estate_certificate_no" : 0.9475, "mortgage_seals" : 0.0, "canceled_mortgage_seals" : 0.0, "year_built" : 0.0, "structure" : 0.0, "revenue_stamps" : 0.0, "property_unit_no" : 0.0 } } } ``` **状态码： 400** 失败响应示例 ``` { "result" : { "error_code" : "AIS.0103", "error_msg" : "The image size does not meet the requirements." } } ``` #### SDK代码示例 SDK代码示例如下。 ![](https://support.huaweicloud.com/api-ocr/public_sys-resources/note_3.0-zh-cn.png) 使用SDK前建议将SDK更新至最新版，防止本地旧版SDK无法使用最新的OCR功能。 - [Java] - 传入不动产证图片的base64编码进行文字识别 ``` package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.ocr.v1.region.OcrRegion; import com.huaweicloud.sdk.ocr.v1.*; import com.huaweicloud.sdk.ocr.v1.model.*; public class RecognizeRealEstateCertificateSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); OcrClient client = OcrClient.newBuilder() .withCredential(auth) .withRegion(OcrRegion.valueOf("")) .build(); RecognizeRealEstateCertificateRequest request = new RecognizeRealEstateCertificateRequest(); RealEstateCertificateRequestBody body = new RealEstateCertificateRequestBody(); body.withImage("/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAA..."); request.withBody(body); try { RecognizeRealEstateCertificateResponse response = client.recognizeRealEstateCertificate(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } ``` - 传入不动产证图片的url进行文字识别 ``` package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.ocr.v1.region.OcrRegion; import com.huaweicloud.sdk.ocr.v1.*; import com.huaweicloud.sdk.ocr.v1.model.*; public class RecognizeRealEstateCertificateSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); OcrClient client = OcrClient.newBuilder() .withCredential(auth) .withRegion(OcrRegion.valueOf("")) .build(); RecognizeRealEstateCertificateRequest request = new RecognizeRealEstateCertificateRequest(); RealEstateCertificateRequestBody body = new RealEstateCertificateRequestBody(); body.withUrl("https://BucketName.obs.myhuaweicloud.com/ObjectName"); request.withBody(body); try { RecognizeRealEstateCertificateResponse response = client.recognizeRealEstateCertificate(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } ``` - [Python] - 传入不动产证图片的base64编码进行文字识别 ``` # coding: utf-8 from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkocr.v1.region.ocr_region import OcrRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkocr.v1 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.getenv("CLOUD_SDK_AK") sk = os.getenv("CLOUD_SDK_SK") credentials = BasicCredentials(ak, sk) \ client = OcrClient.new_builder() \ .with_credentials(credentials) \ .with_region(OcrRegion.value_of("")) \ .build() try: request = RecognizeRealEstateCertificateRequest() request.body = RealEstateCertificateRequestBody( image="/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAA..." ) response = client.recognize_real_estate_certificate(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) ``` - 传入不动产证图片的url进行文字识别 ``` # coding: utf-8 from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkocr.v1.region.ocr_region import OcrRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkocr.v1 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.getenv("CLOUD_SDK_AK") sk = os.getenv("CLOUD_SDK_SK") credentials = BasicCredentials(ak, sk) \ client = OcrClient.new_builder() \ .with_credentials(credentials) \ .with_region(OcrRegion.value_of("")) \ .build() try: request = RecognizeRealEstateCertificateRequest() request.body = RealEstateCertificateRequestBody( url="https://BucketName.obs.myhuaweicloud.com/ObjectName" ) response = client.recognize_real_estate_certificate(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) ``` - [Go] - 传入不动产证图片的base64编码进行文字识别 ``` package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" ocr "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/ocr/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/ocr/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/ocr/v1/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := ocr.NewOcrClient( ocr.OcrClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). Build()) request := &model.RecognizeRealEstateCertificateRequest{} imageRealEstateCertificateRequestBody:= "/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAA..." request.Body = &model.RealEstateCertificateRequestBody{ Image: &imageRealEstateCertificateRequestBody, } response, err := client.RecognizeRealEstateCertificate(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - 传入不动产证图片的url进行文字识别 ``` package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" ocr "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/ocr/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/ocr/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/ocr/v1/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := ocr.NewOcrClient( ocr.OcrClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). Build()) request := &model.RecognizeRealEstateCertificateRequest{} urlRealEstateCertificateRequestBody:= "https://BucketName.obs.myhuaweicloud.com/ObjectName" request.Body = &model.RealEstateCertificateRequestBody{ Url: &urlRealEstateCertificateRequestBody, } response, err := client.RecognizeRealEstateCertificate(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/OCR/sdk?api=RecognizeRealEstateCertificate&version=v1)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 成功响应示例 | | 400 | 失败响应示例 | 状态码请参见[状态码](https://support.huaweicloud.com/api-ocr/ocr_03_0090.html)。 #### 错误码 错误码请参见[错误码](https://support.huaweicloud.com/api-ocr/ocr_03_0028.html)。