# 印章识别 - RecognizeSeal #### 功能介绍 检测和识别合同文件或常用票据中的印章，并可擦除和提取图片中的印章，通过JSON格式返回印章检测、识别、擦除和提取的结果。该接口的使用限制请参见[约束与限制]，详细使用指导请参见[OCR服务使用简介](https://support.huaweicloud.com/qs-ocr/ocr_05_0001.html)章节。 #### 约束与限制 - 支持JPEG、JPG、PNG、BMP、TIFF、PDF格式，多页PDF默认识别第一页，或者您可以指定要识别的页码。 - 图像各边的像素大小在15px到8192px之间。单个图片、PDF文件其对应的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/seal 表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。 | | Content-Type | 是 | String | 发送的实体的MIME类型，参数值为"application/json"。 | | 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_0000001829684345.png "点击放大") 企业项目创建步骤请参见用户指南。 说明： 创建企业项目后，在传参时，有以下三类场景。 - 携带正确的ID，正常使用OCR服务，账单的企业项目会被分类到企业ID对应的企业项目中。 - 携带格式正确但不存在的ID，正常使用OCR服务，账单的企业项目会显示对应不存在的企业项目ID。 - 不携带ID或格式错误ID（包含特殊字符等），正常使用OCR服务，账单的企业项目会被分类到"default"中。 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | data | 否 | String | 该参数与url二选一。 图片的Base64编码，要求 单个图片、PDF文件其对应的Base64编码不超过10MB。文件在Base64编码后会大于文件原本大小，请注意做好边界判断，建议文件大小不超过7MB。 图片最短边不小于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二选一。 单个图片、PDF文件其对应的Base64编码不超过10MB。文件在Base64编码后会大于文件原本大小，请注意做好边界判断，建议文件大小不超过7MB。 图片的url路径目前支持： - 公网http/https url例如https://support.huaweicloud.com/api-ocr/zh-cn_image_0000001079447456.png - OBS提供的url，使用OBS数据需要进行授权。包括对服务授权、临时授权、匿名公开授权，详情参见[配置OBS访问权限](https://support.huaweicloud.com/api-ocr/ocr_03_0132.html)。 说明： - 接口响应时间依赖于图片的下载时间，如果图片下载时间过长，会返回接口调用失败。 - 请保证被检测图片所在的存储服务稳定可靠，推荐使用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页。 | #### 响应参数 **状态码： 200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | result | [SealResult] object | 调用成功时表示调用结果。 调用失败时无此字段。 | 表5SealResult | 参数 | 参数类型 | 描述 | |:---|:---|:---| | seal_list | Array of [SealList] objects | 印章信息列表。 | | erased_seal_image | String | 在输入图片基础上进行印章擦除后的base64编码图片。 | 表6SealList | 参数 | 参数类型 | 描述 | |:---|:---|:---| | type | String | 印章类型，当前支持circle（圆形章）、ellipse（椭圆章）、rectangle（方形章）、triangle（三角章）、rhombus（菱形章）五种。 | | seal_image | String | 提取的单个印章base64编码图片。 | | confidence | Float | 印章位置的置信度。 | | location | Array\\> | 印章位置，列表形式，包含印章区域四个顶点的二维坐标（x,y），坐标原点为图片左上角，x轴沿水平方向，y轴沿竖直方向。 | | words_block_list | Array of [SealWordsBlockList] objects | 印章文本块列表。 | 表7SealWordsBlockList | 参数 | 参数类型 | 描述 | |:---|:---|:---| | words | String | 印章文本块。 | | words_confidence | Float | 印章文本块的置信度。 | **状态码： 400** 表8响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 调用失败时的错误码，具体请参见[错误码](https://support.huaweicloud.com/api-ocr/ocr_03_0028.html)。 调用成功时不返回此字段。 | | error_msg | String | 调用失败时的错误信息。 调用成功时无此字段。 | #### 请求示例 - 传入印章图片的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" } ``` #### 响应示例 **状态码： 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." } } ``` #### 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 RecognizeSealSolution { 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(); RecognizeSealRequest request = new RecognizeSealRequest(); SealRequestBody body = new SealRequestBody(); body.withData("/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAA..."); request.withBody(body); try { RecognizeSealResponse response = client.recognizeSeal(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 RecognizeSealSolution { 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(); RecognizeSealRequest request = new RecognizeSealRequest(); SealRequestBody body = new SealRequestBody(); body.withUrl("https://BucketName.obs.myhuaweicloud.com/ObjectName"); request.withBody(body); try { RecognizeSealResponse response = client.recognizeSeal(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 = RecognizeSealRequest() request.body = SealRequestBody( data="/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAA..." ) response = client.recognize_seal(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 = RecognizeSealRequest() request.body = SealRequestBody( url="https://BucketName.obs.myhuaweicloud.com/ObjectName" ) response = client.recognize_seal(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.RecognizeSealRequest{} dataSealRequestBody:= "/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAA..." request.Body = &model.SealRequestBody{ Data: &dataSealRequestBody, } response, err := client.RecognizeSeal(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.RecognizeSealRequest{} urlSealRequestBody:= "https://BucketName.obs.myhuaweicloud.com/ObjectName" request.Body = &model.SealRequestBody{ Url: &urlSealRequestBody, } response, err := client.RecognizeSeal(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=RecognizeSeal&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)。