快速入门

Java

步骤 1：配置Java环境

java -version

<dependency>
  <groupId>com.aliyun</groupId>
  <artifactId>ocr_api20210707</artifactId>
  <version>3.1.2</version>
</dependency>

步骤 2：调用文字识别OCR接口

运行以下代码调用文字识别API：

import com.aliyun.ocr_api20210707.models.RecognizeAllTextResponse;
import com.aliyun.tea.*;

public class Sample {

    public static com.aliyun.ocr_api20210707.Client createClient() throws Exception {
        com.aliyun.teaopenapi.models.Config config = new com.aliyun.teaopenapi.models.Config()
                // 必填，请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_ID。
                .setAccessKeyId(System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID"))
                // 必填，请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_SECRET。
                .setAccessKeySecret(System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET"));
        config.endpoint = "ocr-api.cn-hangzhou.aliyuncs.com";
        return new com.aliyun.ocr_api20210707.Client(config);
    }

    public static void main(String[] args_) throws Exception {
        java.util.List<String> args = java.util.Arrays.asList(args_);
        com.aliyun.ocr_api20210707.Client client = Sample.createClient();
        com.aliyun.ocr_api20210707.models.RecognizeAllTextRequest recognizeAllTextRequest = new com.aliyun.ocr_api20210707.models.RecognizeAllTextRequest()
                .setUrl("https://img.alicdn.com/tfs/TB1q5IeXAvoK1RjSZFNXXcxMVXa-483-307.jpg")
                .setType("IdCard");
        com.aliyun.teautil.models.RuntimeOptions runtime = new com.aliyun.teautil.models.RuntimeOptions();
        try {
            RecognizeAllTextResponse resp = client.recognizeAllTextWithOptions(recognizeAllTextRequest, runtime);
            System.out.println(com.aliyun.teautil.Common.toJSONString(resp.body.data));
        } catch (TeaException error) {
            // 此处仅做打印展示，请谨慎对待异常处理，在工程项目中切勿直接忽略异常。
            // 错误 message
            System.out.println(error.getMessage());
            // 诊断地址
            System.out.println(error.getData().get("Recommend"));
            com.aliyun.teautil.Common.assertAsString(error.message);
        } catch (Exception _error) {
            TeaException error = new TeaException(_error.getMessage(), _error);
            // 此处仅做打印展示，请谨慎对待异常处理，在工程项目中切勿直接忽略异常。
            // 错误 message
            System.out.println(error.getMessage());
            // 诊断地址
            System.out.println(error.getData().get("Recommend"));
            com.aliyun.teautil.Common.assertAsString(error.message);
        }
    }
}

{
	"height": 307,
	"subImageCount": 1,
	"subImages": [{
		"angle": 0,
		"kvInfo": {
			"data": {
				"address": "上海市西藏南路-瞿溪路弘辉名苑",
				"ethnicity": "汉",
				"sex": "女",
				"name": "方大呆",
				"idNumber": "371002200610020000",
				"birthDate": "2006年10月2日"
			},
			"kvCount": 6,
			"kvDetails": {
				"address": {
					"keyName": "address",
					"keyConfidence": 100,
					"value": "上海市西藏南路-瞿溪路弘辉名苑",
					"valueConfidence": 100,
					"valueAngle": 0
				},
				"ethnicity": {
					"keyName": "ethnicity",
					"keyConfidence": 100,
					"value": "汉",
					"valueConfidence": 100,
					"valueAngle": 0
				},
				"sex": {
					"keyName": "sex",
					"keyConfidence": 100,
					"value": "女",
					"valueConfidence": 100,
					"valueAngle": 0
				},
				"name": {
					"keyName": "name",
					"keyConfidence": 100,
					"value": "方大呆",
					"valueConfidence": 100,
					"valueAngle": 0
				},
				"idNumber": {
					"keyName": "idNumber",
					"keyConfidence": 100,
					"value": "371002200610020000",
					"valueConfidence": 100,
					"valueAngle": 0
				},
				"birthDate": {
					"keyName": "birthDate",
					"keyConfidence": 100,
					"value": "2006年10月2日",
					"valueConfidence": 100,
					"valueAngle": 0
				}
			}
		},
		"qualityInfo": {
			"isCopy": false
		},
		"subImageId": 0,
		"type": "身份证正面"
	}],
	"width": 483
}

Python

步骤 1：配置 Python 环境

# 如果运行失败，您可以将python替换成python3再运行
python -V

pip install alibabacloud_ocr_api20210707==3.1.2

步骤 2：调用文字识别OCR接口

您可以新建一个Python文件，命名为hello_ocr.py，将以下代码复制到hello_ocr.py中并保存。

# -*- coding: utf-8 -*-
import os
import sys

from typing import List

from alibabacloud_ocr_api20210707.client import Client as ocr_api20210707Client
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_ocr_api20210707 import models as ocr_api_20210707_models
from alibabacloud_tea_util import models as util_models
from alibabacloud_tea_util.client import Client as UtilClient

class Sample:
    def __init__(self):
        pass

    @staticmethod
    def create_client() -> ocr_api20210707Client:
        config = open_api_models.Config(
            # 必填，请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_ID。,
            access_key_id=os.environ['ALIBABA_CLOUD_ACCESS_KEY_ID'],
            # 必填，请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_SECRET。,
            access_key_secret=os.environ['ALIBABA_CLOUD_ACCESS_KEY_SECRET']
        )
        config.endpoint = f'ocr-api.cn-hangzhou.aliyuncs.com'
        return ocr_api20210707Client(config)

    @staticmethod
    def main(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        recognize_all_text_request = ocr_api_20210707_models.RecognizeAllTextRequest(
            url='https://img.alicdn.com/tfs/TB1q5IeXAvoK1RjSZFNXXcxMVXa-483-307.jpg',
            type='IdCard'
        )
        runtime = util_models.RuntimeOptions()
        try:
            resp = client.recognize_all_text_with_options(recognize_all_text_request, runtime)
            print(resp.body.data)
        except Exception as error:
            # 此处仅做打印展示，请谨慎对待异常处理，在工程项目中切勿直接忽略异常。
            # 错误 message
            print(error.message)
            # 诊断地址
            print(error.data.get("Recommend"))
            UtilClient.assert_as_string(error.message)

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        recognize_all_text_request = ocr_api_20210707_models.RecognizeAllTextRequest(
            url='https://img.alicdn.com/tfs/TB1q5IeXAvoK1RjSZFNXXcxMVXa-483-307.jpg',
            type='IdCard'
        )
        runtime = util_models.RuntimeOptions()
        try:
            # 复制代码运行请自行打印 API 的返回值
            await client.recognize_all_text_with_options_async(recognize_all_text_request, runtime)
        except Exception as error:
            # 此处仅做打印展示，请谨慎对待异常处理，在工程项目中切勿直接忽略异常。
            # 错误 message
            print(error.message)
            # 诊断地址
            print(error.data.get("Recommend"))
            UtilClient.assert_as_string(error.message)

if __name__ == '__main__':
    Sample.main(sys.argv[1:])

{
	'Height': 307,
	'SubImageCount': 1,
	'SubImages': [{
		'Angle': 0,
		'FigureInfo': {},
		'KvInfo': {
			'Data': {
				'address': '上海市西藏南路-瞿溪路弘辉名苑',
				'ethnicity': '汉',
				'sex': '女',
				'name': '方大呆',
				'idNumber': '371002200610020000',
				'birthDate': '2006年10月2日'
			},
			'KvCount': 6,
			'KvDetails': {
				'address': {
					'KeyName': 'address',
					'KeyConfidence': 100,
					'Value': '上海市西藏南路-瞿溪路弘辉名苑',
					'ValueConfidence': 100,
					'ValuePoints': [],
					'ValueAngle': 0
				},
				'ethnicity': {
					'KeyName': 'ethnicity',
					'KeyConfidence': 100,
					'Value': '汉',
					'ValueConfidence': 100,
					'ValuePoints': [],
					'ValueAngle': 0
				},
				'sex': {
					'KeyName': 'sex',
					'KeyConfidence': 100,
					'Value': '女',
					'ValueConfidence': 100,
					'ValuePoints': [],
					'ValueAngle': 0
				},
				'name': {
					'KeyName': 'name',
					'KeyConfidence': 100,
					'Value': '方大呆',
					'ValueConfidence': 100,
					'ValuePoints': [],
					'ValueAngle': 0
				},
				'idNumber': {
					'KeyName': 'idNumber',
					'KeyConfidence': 100,
					'Value': '371002200610020000',
					'ValueConfidence': 100,
					'ValuePoints': [],
					'ValueAngle': 0
				},
				'birthDate': {
					'KeyName': 'birthDate',
					'KeyConfidence': 100,
					'Value': '2006年10月2日',
					'ValueConfidence': 100,
					'ValuePoints': [],
					'ValueAngle': 0
				}
			}
		},
		'QualityInfo': {
			'IsCopy': False
		},
		'SubImageId': 0,
		'SubImagePoints': [],
		'Type': '身份证正面'
	}],
	'Width': 483
}