文档首页> 文字识别 OCR> API参考> API> 防疫健康码识别

更新时间：2024-05-07 GMT+08:00

在线调试

CLI示例

查看PDF

防疫健康码识别

功能介绍

支持对全国各地区不同版式的防疫健康码中的姓名、健康码更新时间、健康码颜色，并将识别的结构化结果返回给用户。

支持识别4种健康码颜色，包括绿码、黄码、红码、灰码；支持返回各个关键字段的置信度，以便提高人工校验效率。

已推出三码合一功能（健康码、核酸检测记录、行程卡）。您只需要调用1个接口，即可智能结构化识别健康码、核酸检测记录、行程卡等页面信息，包括防疫码类别、姓名、身份证号码、手机号码、省份、城市、健康码或行程卡的更新时间、健康码或行程卡颜色、疫苗接种情况、核酸检测结果、核酸检测机构、核酸检测结果更新时间、核酸检测采样时间、行程卡的途经地址等14个关键字段。

图1 防疫健康码版式示例图
点击放大

约束与限制

支持全国不同地区健康码的识别。
只支持识别PNG、JPG、JPEG、BMP、TIFF格式图片。
图像各边的像素大小在15px到8192px之间。
图像中健康码区域有效占比超过80%，保证整张健康码内容及其边缘包含在图像内。
推荐采用手机截图图像。
支持图像中健康码任意角度的水平旋转（需开启方向检测）。
能处理反光、暗光等干扰的图片但影响识别精度。
目前只支持识别单张健康码。

调用方法

请参见如何调用API。

前提条件

在使用防疫健康码识别之前，需要您完成服务申请和认证鉴权，具体操作流程请参见开通服务和认证鉴权章节。

用户首次使用需要先申请开通。服务只需要开通一次即可，后面使用时无需再次申请。如未开通服务，调用服务时会提示ModelArts.4204报错，请在调用服务前先进入控制台开通服务，并注意开通服务区域与调用服务的区域保持一致。

URI

POST /v2/{project_id}/ocr/health-code

表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。不携带ID或格式错误ID（包含特殊字符等），正常使用OCR服务，账单的企业项目会被分类到"default"中。

表3 请求Body参数
参数	是否必选	参数类型	描述
image	否	String	与url二选一。图片的Base64编码，图片尺寸不小于15×15像素，最长边不超过8192像素，支持JPG/JPEG/PNG/BMP/TIFF格式。图片Base64编码示例如/9j/4AAQSkZJRgABAg...，带有多余前缀会产生The image format is not supported报错。
url	否	String	与image二选一。图片的URL路径，目前仅支持华为云上OBS提供的匿名公开授权访问的URL以及公网URL。
detect_direction	否	Boolean	校正图片的倾斜角度开关，可选值如下所示： true：校正图片的倾斜角度 false：不校正图片的倾斜角度支持任意角度的校正，未传入该参数时默认为“false”。待识别图片如果存在倾斜，建议将此参数设置为“true”。

响应参数

状态码： 200

表4 响应Body参数
参数	参数类型	描述
result	HealthCodeResult object	识别结果。调用失败时此字段为空。

表5 HealthCodeResult
参数	参数类型	描述
type	String	防疫码类别：健康码：health_code 核酸检测记录：pcr_test_record 通信行程卡：travel_card 其他：other
name	String	姓名
idcard_number	String	身份证号码
phone_number	String	手机号码
province	String	省份
city	String	城市
time	String	健康码或行程卡的更新时间
color	String	健康码或行程卡颜色。健康码颜色可选值包括： "green"，绿码 "yellow"，黄码 "red"，红码 "gray"，灰码行程卡颜色可选值包括： "green"，绿码 "yellow"，黄码 "red"，红码
vaccination_status	String	疫苗接种情况，可选值包括：未接种接种中无接种记录已接种1针已接种2针已接种3针已完成新冠疫苗接种
test_interval	String	核酸检测间隔时长，可选值包括： 24小时内 48小时内 72小时内 5天内 7天内 7天外
pcr_test_result	String	核酸检测结果，可选值包括： "positive",即阳性 "negative",即阴性 "unknown",未知
pcr_test_organization	String	核酸检测机构
pcr_test_time	String	核酸检测结果更新时间
pcr_sampling_time	String	核酸检测采样时间
reached_city	Array of strings	行程卡的途径地址
confidence	Object	各个字段的置信度。
words_block_count	Integer	代表检测识别出来的文字块数目。
words_block_list	Array of HealthCodeWordsBlockList objects	识别文字块列表，输出顺序从左到右，从上到下。

表6 HealthCodeWordsBlockList
参数	参数类型	描述
words	String	文字块识别结果。
location	Array<Array<Integer>>	识别到的文字块的区域位置信息，列表形式，分别表示文字块4个顶点的（x,y）坐标。采用图像坐标系，图像坐标原点为图像左上角，x轴沿水平方向，y轴沿竖直方向。
confidence	Float	各个字段的置信度

状态码： 400

表7 响应Body参数
参数	参数类型	描述
error_code	String	调用失败时的错误码，具体请参见错误码。调用成功时无此字段。
error_msg	String	调用失败时的错误信息。调用成功时无此字段。

请求示例

ndpoint即调用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/health-code”，“project_id”为项目ID，获取方法请参见获取项目ID。
如何获取Token请参见认证鉴权。

传入防疫健康码图片的base64编码进行文字识别

POST https://ocr.cn-north-4.myhuaweicloud.com/v2/{project_id}/health-code
Request Header:
Content-Type: application/json
X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG...
Request Body:
{
  "image" : "/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAA..."
}

传入防疫健康码图片的url进行文字识别

POST https://ocr.cn-north-4.myhuaweicloud.com/v2/{project_id}/health-code
Request Header:
Content-Type: application/json
X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG...
Request Body:
{
  "url" : "https://BucketName.obs.myhuaweicloud.com/ObjectName"
}

响应示例

状态码： 200

成功响应样例

{
  "result" : {
    "type" : "health_code",
    "name" : "**余",
    "idcard_number" : "",
    "phone_number" : "",
    "province" : "安徽省",
    "city" : "合肥市",
    "time" : "2022-03-30 15:37:13",
    "color" : "green",
    "vaccination_status" : "x 2已接种新冠疫苗",
    "pcr_test_result" : "",
    "pcr_test_organization" : "",
    "pcr_test_time" : "",
    "pcr_sampling_time" : "",
    "reached_city" : "",
    "confidence" : {
      "type" : 0.615,
      "name" : 0.9003,
      "idcard_number" : 0,
      "phone_number" : 0,
      "province" : 0,
      "city" : 0.8785,
      "time" : 0.9174,
      "color" : 0.615,
      "vaccination_status" : 0.8691,
      "pcr_test_result" : 0,
      "pcr_test_organization" : 0,
      "pcr_test_time" : 0,
      "pcr_sampling_time" : 0,
      "reached_city" : 0
    },
    "words_block_count" : 16,
    "words_block_list" : [ {
      "words" : "文字块1",
      "confidence" : 0.8327,
      "location" : [ [ 754, 21 ], [ 855, 21 ], [ 855, 60 ], [ 754, 60 ] ]
    }, {
      "words" : "文字块2",
      "confidence" : 0.7972,
      "location" : [ [ 929, 22 ], [ 1022, 22 ], [ 1022, 59 ], [ 929, 59 ] ]
    } ]
  }
}

状态码： 400

失败响应样例

{
  "error_code" : "AIS.0103",
  "error_msg" : "The image size does not meet the requirements."
}

SDK代码示例

SDK代码示例如下。

传入防疫健康码图片的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 RecognizeHealthCodeSolution {

    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("<YOUR REGION>"))
                .build();
        RecognizeHealthCodeRequest request = new RecognizeHealthCodeRequest();
        HealthCodeRequestBody body = new HealthCodeRequestBody();
        body.withImage("/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAA...");
        request.withBody(body);
        try {
            RecognizeHealthCodeResponse response = client.recognizeHealthCode(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 RecognizeHealthCodeSolution {

    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("<YOUR REGION>"))
                .build();
        RecognizeHealthCodeRequest request = new RecognizeHealthCodeRequest();
        HealthCodeRequestBody body = new HealthCodeRequestBody();
        body.withUrl("https://BucketName.obs.myhuaweicloud.com/ObjectName");
        request.withBody(body);
        try {
            RecognizeHealthCodeResponse response = client.recognizeHealthCode(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());
        }
    }
}

            

          

        
       

传入防疫健康码图片的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("<YOUR REGION>")) \
        .build()

    try:
        request = RecognizeHealthCodeRequest()
        request.body = HealthCodeRequestBody(
            image="/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAA..."
        )
        response = client.recognize_health_code(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("<YOUR REGION>")) \
        .build()

    try:
        request = RecognizeHealthCodeRequest()
        request.body = HealthCodeRequestBody(
            url="https://BucketName.obs.myhuaweicloud.com/ObjectName"
        )
        response = client.recognize_health_code(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

            

          

        
       

传入防疫健康码图片的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("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.RecognizeHealthCodeRequest{}
	imageHealthCodeRequestBody:= "/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAA..."
	request.Body = &model.HealthCodeRequestBody{
		Image: &imageHealthCodeRequestBody,
	}
	response, err := client.RecognizeHealthCode(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("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.RecognizeHealthCodeRequest{}
	urlHealthCodeRequestBody:= "https://BucketName.obs.myhuaweicloud.com/ObjectName"
	request.Body = &model.HealthCodeRequestBody{
		Url: &urlHealthCodeRequestBody,
	}
	response, err := client.RecognizeHealthCode(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

            

          

        
       

更多编程语言的SDK代码示例，请参见API Explorer的代码示例页签，可生成自动对应的SDK代码示例。

状态码

状态码	描述
200	成功响应样例
400	失败响应样例

状态码请参见状态码。

错误码

错误码请参见错误码。

父主题： API

上一篇：银行回单识别

下一篇：核酸检测记录识别

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在我的云声建议查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

如您有其它疑问，您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问

防疫健康码识别

功能介绍

约束与限制

调用方法

前提条件

URI

请求参数

响应参数

请求示例

响应示例

SDK代码示例

状态码

错误码

相关文档

相关产品

意见反馈

文档内容是否对您有帮助？

7*24

备案

专业服务

退订

建议反馈

售前咨询热线