网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络服务
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
威胁检测服务 MTD
态势感知 SA
认证测试中心 CTC
边缘安全 EdgeSec
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts 盘古助手
华为云Astro大屏应用
计算
弹性云服务器 ECS
Flexus云服务
裸金属服务器 BMS
云手机服务器 CPH
专属主机 DeH
弹性伸缩 AS
镜像服务 IMS
函数工作流 FunctionGraph
云耀云服务器(旧版)
VR云渲游平台 CVR
Huawei Cloud EulerOS
网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络服务
CDN与智能边缘
内容分发网络 CDN
智能边缘云 IEC
智能边缘平台 IEF
CloudPond云服务
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
威胁检测服务 MTD
态势感知 SA
认证测试中心 CTC
边缘安全 EdgeSec
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
可信智能计算服务 TICS
推荐系统 RES
云搜索服务 CSS
数据可视化 DLV
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
数据治理中心 DataArts Studio
湖仓构建 LakeFormation
智能数据洞察 DataArts Insight
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
开天aPaaS
应用平台 AppStage
开天企业工作台 MSSE
开天集成工作台 MSSI
API中心 API Hub
云消息服务 KooMessage
交换数据空间 EDS
云地图服务 KooMap
云手机服务 KooPhone
组织成员账号 OrgID
云空间服务 KooDrive
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
区块链
区块链服务 BCS
数字资产链 DAC
华为云区块链引擎服务 HBS
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
价格
成本优化最佳实践
专属云商业逻辑
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
其他
管理控制台
消息中心
产品价格详情
系统权限
客户关联华为云合作伙伴须知
公共问题
宽限期保留期
奖励推广计划
活动
云服务信任体系能力说明
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts 盘古助手
华为云Astro大屏应用
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
高性能弹性文件服务 SFS Turbo
弹性文件服务 SFS
存储容灾服务 SDRS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
云存储网关 CSG
专属分布式存储服务 DSS
数据工坊 DWR
地图数据 MapDS
键值存储服务 KVS
容器
云容器引擎 CCE
云容器实例 CCI
容器镜像服务 SWR
云原生服务中心 OSC
应用服务网格 ASM
华为云UCS
数据库
云数据库 RDS
数据复制服务 DRS
文档数据库服务 DDS
分布式数据库中间件 DDM
云数据库 GaussDB
云数据库 GeminiDB
数据管理服务 DAS
数据库和应用迁移 UGO
云数据库 TaurusDB
人工智能
AI开发平台ModelArts
华为HiLens
图引擎服务 GES
图像识别 Image
文字识别 OCR
自然语言处理 NLP
内容审核 Moderation
图像搜索 ImageSearch
医疗智能体 EIHealth
企业级AI应用开发专业套件 ModelArts Pro
人脸识别服务 FRS
对话机器人服务 CBS
语音交互服务 SIS
人证核身服务 IVS
视频智能分析服务 VIAS
城市智能体
自动驾驶云服务 Octopus
盘古大模型 PanguLargeModels
IoT物联网
设备接入 IoTDA
IoT物联网
全球SIM联接 GSL
IoT数据分析 IoTA
路网数字化服务 DRIS
IoT边缘 IoTEdge
设备发放 IoTDP
企业应用
域名注册服务 Domains
云解析服务 DNS
企业门户 EWP
ICP备案
商标注册
华为云WeLink
华为云会议 Meeting
隐私保护通话 PrivateNumber
语音通话 VoiceCall
消息&短信 MSGSMS
云管理网络
SD-WAN 云服务
边缘数据中心管理 EDCM
云桌面 Workspace
应用与数据集成平台 ROMA Connect
ROMA资产中心 ROMA Exchange
API全生命周期管理 ROMA API
政企自服务管理 ESM
视频
实时音视频 SparkRTC
视频直播 Live
视频点播 VOD
媒体处理 MPC
视频接入服务 VIS
数字内容生产线 MetaStudio
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
迁移中心 MGC
专属云
专属计算集群 DCC
开发者工具
SDK开发指南
API签名指南
DevStar
华为云命令行工具服务 KooCLI
Huawei Cloud Toolkit
CodeArts API
云化转型
云架构中心
云采用框架
用户服务
账号中心
费用中心
成本中心
资源中心
企业管理
工单管理
客户运营能力
国际站常见问题
支持计划
专业服务
合作伙伴支持计划
我的凭证
华为云公共事业服务云平台
工业软件
工业数字模型驱动引擎
硬件开发工具链平台云服务
工业数据转换引擎云服务
文档首页/ 文字识别 OCR/ API参考/ API/ 智能文档解析
更新时间:2025-01-23 GMT+08:00
分享

智能文档解析

功能介绍

对证件、票据、表单等多版式文档进行文字识别、版面分析、键值对提取以及表格识别等任务,并以json格式返回识别的结构化结果。

约束与限制

  • 支持中英文及部分中文繁体字。
  • 只支持识别PNG、JPG、JPEG、BMP、GIF、TIFF、WEBP、PCX、ICO、PSD格式的图片以及PDF文档,PDF只支持单页识别,可通过pdf_page_number参数指定页码。
  • 图像各边的像素大小在15px到8192px之间。
  • 图像中识别区域有效占比超过80%,保证所有文字及其边缘包含在图像内。
  • 支持图像任意角度的水平旋转。
  • 单页字符数不大于1800,以获得较优的识别效果。
  • 目前不支持复杂背景(如户外自然场景、防伪水印等)和文字扭曲图像的文档解析。
  • 文字识别服务属于公有云服务,线上用户资源共享,如果需要多并发请求,请提前联系我们

调用方法

请参见如何调用API

前提条件

在使用之前,需要您完成服务申请和认证鉴权,具体操作流程请参见开通服务认证鉴权章节。

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

URI

POST /v2/{project_id}/ocr/smart-document-recognizer

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,您可以从获取项目ID中获取。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。 Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,响应消息头中X-Subject-Token的值即为Token。

Enterprise-Project-Id

String

企业项目ID。OCR支持通过企业项目管理(EPS)对不同用户组和用户的资源使用,进行分账。 获取方法:进入“企业项目管理”页面,单击企业项目名称,在企业项目详情页获取Enterprise-Project-Id(企业项目ID)。 企业项目创建步骤请参见用户指南。

说明:

创建企业项目后,在传参时,有以下三类场景。

  • 携带正确的ID,正常使用OCR服务,账单的企业项目会被分类到企业ID对应的企业项目中。
  • 携带格式正确但不存在的ID,正常使用OCR服务,账单的企业项目会显示对应不存在的企业项目ID。
  • 不携带ID或格式错误ID(包含特殊字符等),正常使用OCR服务,账单的企业项目会被分类到"default"中。
表3 请求Body参数

参数

是否必选

参数类型

描述

data

String

与url二选一。图片或PDF格式,base64编码,要求base64编码后大小不超过10M。 图像尺寸不小于15×15像素,最长边不超过8192像素,支持JPG/PNG/BMP/TIFF格式。 PDF以144dpi的分辨率转为图像进行文档解析,需符合上述图像尺寸规定。若PDF有多页,当前仅对第1页进行识别。

url

String

与data二选一。 图片或PDF的URL路径,图片大小不超过10MB,目前支持:

  • 公网http/https url
  • OBS提供的url,使用OBS数据需要进行授权。包括对服务授权、临时授权、匿名公开授权,详情参见配置OBS访问权限
说明:
  • 接口响应时间依赖于图片的下载时间,如果图片下载时间过长,会返回接口调用失败。
  • 请保证被检测图片所在的存储服务稳定可靠,推荐使用OBS服务存储图片数据。
  • url中不能存在中文字符,若存在,中文需要进行utf8编码。

single_orientation_mode

Boolean

单朝向模式开关。可选值包括:

  • true:打开单朝向模式
  • false:关闭单朝向模式

图片文字方向一致时,打开该开关可提升识别精度;图片文字方向不一致时,关闭该开关可支持多朝向文字识别。未传入该参数时默认为true,既默认图片中的字段为单朝向。

language

String

语种选择,未传入该参数时默认为中英文识别模式。参考华为云通用文字支持语种

kv

Boolean

是否进行键值对(key-value)提取。若是,结果会以“kv_result”这一关键字返回。

table

Boolean

是否进行表格识别。此处表格特指逻辑表格,通常具有M行N列的形式,且第一行或第一列为表头。若是,结果会以“table_result”这一关键字返回。

layout

Boolean

是否进行版面分析。若是,结果会以“layout_result”这一关键字返回。

return_excel

Boolean

仅当table为True时有效。是否返回表格转换Microsoft Excel的Base64编码字段。

form

Boolean

是否进行有线表单识别。有线表单指关键信息以有线单元格形式进行呈现,例如户口本、机动车发票等。若是,结果会以"form_result"这一关键字返回。

formula

Boolean

是否进行公式识别,识别结果为latex序列。若是,结果会以“formula_result”这一关键字返回。

  • 开启公式识别后会降低响应速度。
  • 当前仅支持3行以内公式识别,不支持3行以上的多行公式。

kv_map

String

需要传入字典的json序列化后字符串,用于对kv_result中的特定key值进行归一化映射。例如,kv_result中包含{"名称":"小明"}的键值对,若传入{"名称":"姓名"}的kv_map,则返回结果为{“姓名”:“小明”}。

说明:

参数传入示例:

  • "kv_map":"{"名称":"姓名"}"

erase_seal

Boolean

是否进行印章擦除。开启后,可提升印章遮挡区域的文字识别精度。

pdf_page_number

Integer

指定PDF页码识别。传入该参数时,则识别指定页码的内容。如果不传该参数,则默认识别第1页。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

result

Array of SmartDocumentRecognizerResult objects

调用成功时返回的结果列表,按页面顺序返回,列表第一项为第一页识别结果,依次类推。 调用失败时无此字段。

表5 SmartDocumentRecognizerResult

参数

参数类型

描述

ocr_result

SmartDocumentRecognizerOcrResult object

文字识别结果。

kv_result

SmartDocumentRecognizerKvResult object

键值对提取结果。当输入参数“kv”为“true”时,才返回该参数。

table_result

SmartDocumentRecognizerTableResult object

表格识别结果。当输入参数“table”为“true”时,才返回该参数。

layout_result

SmartDocumentRecognizerLayoutResult object

版面分析结果。当输入参数“layout”为“true”时,才返回该参数。

form_result

SmartDocumentRecognizerFormResult object

有线表单识别结果。当输入参数"form"为true时,才返回该参数。

formula_result

SmartDocumentRecognizerFormulaResult object

公式识别结果。

表6 SmartDocumentRecognizerOcrResult

参数

参数类型

描述

direction

Float

图片朝向。

words_block_count

Integer

识别文字块数目。

words_block_list

Array of SmartDocumentRecognizerWordsBlockList objects

识别文字块列表,输出顺序从左到右,先上后下。

表7 SmartDocumentRecognizerWordsBlockList

参数

参数类型

描述

words

String

文字块识别结果。

location

Array<Array<Integer>>

文字块的区域位置信息,列表形式,包含文字区域四个顶点的二维坐标(x,y);坐标原点为图片左上角,x轴沿水平方向,y轴沿竖直方向。

confidence

Float

文字块识别结果的置信度。

表8 SmartDocumentRecognizerKvResult

参数

参数类型

描述

kv_block_count

Integer

模型识别到的键值对数量。

kv_block_list

Array of SmartDocumentRecognizerKVBlock objects

键值对识别结果列表。

表9 SmartDocumentRecognizerKVBlock

参数

参数类型

描述

key

String

key-value对(键值对)中的key,例如“姓名:小明”中的“姓名”

value

String

key-value对(键值对)中的value,例如“姓名:小明”中的“小明”

words_block_count

Integer

该键值对中所包含的文本框数量。

words_block_list

Array of SmartDocumentRecognizerKVWordsBlock objects

文本框识别结果列表。

表10 SmartDocumentRecognizerKVWordsBlock

参数

参数类型

描述

words

String

文字块识别结果。

location

Array<Array<Integer>>

文字块的区域位置信息,列表形式,包含文字区域四个顶点的二维坐标(x,y);坐标原点为图片左上角,x轴沿水平方向,y轴沿竖直方向。

type

String

类型。

表11 SmartDocumentRecognizerTableResult

参数

参数类型

描述

table_count

Integer

模型识别到的表格数量。

table_list

Array of SmartDocumentRecognizerTableBlock objects

表格识别结果列表。

表12 SmartDocumentRecognizerLayoutResult

参数

参数类型

描述

layout_block_count

Integer

模型识别到的文档版面区域数量。

layout_block_list

Array of SmartDocumentRecognizerLayoutBlock objects

文档版面区域识别结果列表。

表13 SmartDocumentRecognizerLayoutBlock

参数

参数类型

描述

location

Array<Array<Integer>>

文字块的区域位置信息,列表形式,包含文字区域四个顶点的二维坐标(x,y);坐标原点为图片左上角,x轴沿水平方向,y轴沿竖直方向。

type

String

文档区域类别,包含text、title、sub_title、image、image_caption、form、table、table_caption、header、footer、page_number、reference、formula、stamp、directory共15个类别。

text

String

文档区域文字内容。对于表格与图像,不返回其中的文字内容。

words_ids

Array of integers

文字识别结果索引列表,表示ocr_result的words_block_list中哪些文本框位于该文档区域内。

table_id

Integer

仅当type为"table"且入参table为True时返回该字段,表示当前逻辑表格区域对应table_result中哪一项识别结果。

form_id

Integer

仅当type为"form"且入参form为True时返回该字段,表示当前有线表单区域对应form_result中哪一项识别结果。

表14 SmartDocumentRecognizerFormResult

参数

参数类型

描述

form_count

Integer

模型识别到的有线表单数量。

form_list

Array of SmartDocumentRecognizerTableBlock objects

有线表单识别结果列表。

表15 SmartDocumentRecognizerTableBlock

参数

参数类型

描述

location

Array<Array<Integer>>

当前表格的位置信息,列表形式,分别表示文字块4个顶点的x, y坐标;坐标原点为图片左上角,x轴沿水平方向,y轴沿竖直方向。

words_block_count

Integer

表格中所包含的单元格数量。

words_block_list

Array of SmartDocumentRecognizerTableWordsBlock objects

单元格识别结果列表。

excel

String

表格识别结果的base64编码,仅当return_excel为True时返回该字段。对返回的excel编码可用base64.b64decode解码并保存为.xlsx文件。

表16 SmartDocumentRecognizerTableWordsBlock

参数

参数类型

描述

words

String

单元格内的文字识别结果。

rows

Array of integers

文字块占用的行信息,编号从0开始,列表形式,数据类型为Integer。

columns

Array of integers

文字块占用的列信息,编号从0开始,列表形式,数据类型为Integer。

表17 SmartDocumentRecognizerFormulaResult

参数

参数类型

描述

formula_count

Integer

数学公式数量。

formula_list

Array of SmartDocumentRecognizerFormulaBlock objects

数学公式识别结果列表。

表18 SmartDocumentRecognizerFormulaBlock

参数

参数类型

描述

formula

String

数学公式识别结果,以latex字符串表示。

location

Array<Array<Integer>>

数学公式位置信息,列表形式,分别表示4个顶点的x, y坐标;坐标原点为图片左上角,x轴沿水平方向,y轴沿竖直方向。

状态码: 400

表19 响应Body参数

参数

参数类型

描述

error_code

String

调用失败时的错误码,具体请参见错误码

调用成功时不返回此字段。

error_msg

String

调用失败时的错误信息。 调用成功时无此字段。

请求示例

  • “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/smart-document-recognizer”“project_id”为项目ID,获取方法请参见获取项目ID

  • 如何获取Token请参见认证鉴权
  • 传入文档图片的base64编码进行文字识别
    POST https://{endpoint}/v2/{project_id}/ocr/smart-document-recognizer 
      
     { 
       "data" : "/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAA..." 
     }
  • 传入文档图片的url进行文字识别
    POST https://{endpoint}/v2/{project_id}/ocr/smart-document-recognizer 
      
     { 
       "url" : "https://BucketName.obs.myhuaweicloud.com/ObjectName" 
     }

响应示例

状态码: 200

成功响应示例

{
  "result" : [ {
    "formula_result" : {
      "formula_count" : 1,
      "formula_list" : [ {
        "formula" : "\\\\int _ { L } \\\\left ( 2 x y ^ { 3 } - y ^ { 2 } \\\\cos x \\\\right ) \\\\mathrm { d } x + \\\\left ( 1 - 2 y \\\\sin x + 3 x ^ { 2 } y ^ { 2 } \\\\right ) \\\\mathrm { d } y",
        "location" : [ [ 171, 919 ], [ 950, 919 ], [ 950, 967 ], [ 171, 967 ] ]
      } ]
    }
  }, {
    "layout_result" : {
      "layout_block_count" : 19,
      "layout_block_list" : [ {
        "location" : [ [ 1165, 368 ], [ 2031, 368 ], [ 2031, 465 ], [ 1165, 465 ] ],
        "type" : "title",
        "text" : "黑龙江增值税专用发票",
        "words_ids" : [ 0 ]
      }, {
        "location" : [ [ 15, 19 ], [ 1078, 19 ], [ 1078, 637 ], [ 15, 637 ] ],
        "type" : "form",
        "text" : "xxxx",
        "words_ids" : [ 2, 3, 4 ],
        "form_id" : 0
      }, {
        "location" : [ [ 18, 180 ], [ 1077, 180 ], [ 1077, 636 ], [ 18, 636 ] ],
        "type" : "table",
        "text" : "xxxx",
        "words_ids" : [ 0, 1, 2 ],
        "table_id" : 0
      } ]
    }
  }, {
    "form_result" : {
      "form_count" : 1,
      "form_list" : [ {
        "location" : [ [ 15, 19 ], [ 1074, 19 ], [ 1074, 636 ], [ 15, 636 ] ],
        "words_block_count" : 24,
        "words_block_list" : [ {
          "words" : "xxx",
          "rows" : [ 0 ],
          "columns" : [ 0, 1, 2 ]
        }, {
          "words" : "xxxx",
          "rows" : [ 1 ],
          "columns" : [ 0, 1, 2 ]
        } ],
        "excel" : "UEsDBBQAAAAIAAAAIQBhXUk6TwEAAI8EAAATAAAAW0NvbnRlbnRfVHlwZX..."
      } ]
    }
  }, {
    "table_result" : {
      "table_count" : 1,
      "table_list" : [ {
        "words_block_count" : 24,
        "words_block_list" : [ {
          "words" : "货物或应税劳务、服务名称",
          "rows" : [ 0 ],
          "columns" : [ 0 ]
        }, {
          "words" : "规格型号",
          "rows" : [ 0 ],
          "columns" : [ 1 ]
        } ],
        "excel" : "xxxx",
        "location" : [ [ 275, 967 ], [ 2919, 967 ], [ 2919, 1177 ], [ 275, 1177 ] ]
      } ]
    }
  }, {
    "kv_result" : {
      "kv_block_count" : 25,
      "kv_block_list" : [ {
        "key" : "开票日期",
        "value" : "2017年08月31日",
        "words_block_count" : 2,
        "words_block_list" : [ {
          "words" : "开票日期",
          "location" : [ [ 2241, 589 ], [ 2480, 592 ], [ 2480, 646 ], [ 2241, 643 ] ],
          "type" : "key"
        }, {
          "words" : "2017年08月31日",
          "location" : [ [ 2479, 591 ], [ 2850, 595 ], [ 2850, 649 ], [ 2479, 645 ] ],
          "type" : "value"
        } ]
      } ]
    }
  }, {
    "ocr_result" : {
      "direction" : 0.4767,
      "words_block_count" : 67,
      "words_block_list" : [ {
        "words" : "黑龙江增值税专用发票",
        "location" : [ [ 430, 100 ], [ 874, 99 ], [ 874, 139 ], [ 430, 141 ] ],
        "confidence" : 0.9552
      } ]
    }
  } ]
}

状态码: 400

失败响应示例

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

SDK代码示例

SDK代码示例如下。

使用SDK前建议将SDK更新至最新版,防止本地旧版SDK无法使用最新的OCR功能。

  • 传入文档图片的base64编码进行文字识别
     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    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 RecognizeSmartDocumentRecognizerSolution {
    
        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();
            RecognizeSmartDocumentRecognizerRequest request = new RecognizeSmartDocumentRecognizerRequest();
            SmartDocumentRecognizerRequestBody body = new SmartDocumentRecognizerRequestBody();
            body.withData("/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAA...");
            request.withBody(body);
            try {
                RecognizeSmartDocumentRecognizerResponse response = client.recognizeSmartDocumentRecognizer(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进行文字识别
     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    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 RecognizeSmartDocumentRecognizerSolution {
    
        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();
            RecognizeSmartDocumentRecognizerRequest request = new RecognizeSmartDocumentRecognizerRequest();
            SmartDocumentRecognizerRequestBody body = new SmartDocumentRecognizerRequestBody();
            body.withUrl("https://BucketName.obs.myhuaweicloud.com/ObjectName");
            request.withBody(body);
            try {
                RecognizeSmartDocumentRecognizerResponse response = client.recognizeSmartDocumentRecognizer(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编码进行文字识别
     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    # 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 = RecognizeSmartDocumentRecognizerRequest()
            request.body = SmartDocumentRecognizerRequestBody(
                data="/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAA..."
            )
            response = client.recognize_smart_document_recognizer(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进行文字识别
     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    # 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 = RecognizeSmartDocumentRecognizerRequest()
            request.body = SmartDocumentRecognizerRequestBody(
                url="https://BucketName.obs.myhuaweicloud.com/ObjectName"
            )
            response = client.recognize_smart_document_recognizer(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编码进行文字识别
     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    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.RecognizeSmartDocumentRecognizerRequest{}
    	dataSmartDocumentRecognizerRequestBody:= "/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAA..."
    	request.Body = &model.SmartDocumentRecognizerRequestBody{
    		Data: &dataSmartDocumentRecognizerRequestBody,
    	}
    	response, err := client.RecognizeSmartDocumentRecognizer(request)
    	if err == nil {
            fmt.Printf("%+v\n", response)
        } else {
            fmt.Println(err)
        }
    }
    
  • 传入文档图片的url进行文字识别
     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    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.RecognizeSmartDocumentRecognizerRequest{}
    	urlSmartDocumentRecognizerRequestBody:= "https://BucketName.obs.myhuaweicloud.com/ObjectName"
    	request.Body = &model.SmartDocumentRecognizerRequestBody{
    		Url: &urlSmartDocumentRecognizerRequestBody,
    	}
    	response, err := client.RecognizeSmartDocumentRecognizer(request)
    	if err == nil {
            fmt.Printf("%+v\n", response)
        } else {
            fmt.Println(err)
        }
    }
    

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

状态码

状态码

描述

200

成功响应示例

400

失败响应示例

状态码请参见状态码

错误码

错误码请参见错误码

相关文档