You need to enable JavaScript to run this app.
最新活动
产品
解决方案
定价
生态与合作
支持与服务
开发者
了解我们
导航

使用文字识别 OCR 获取识别信息

最近更新时间2023.05.19 15:49:36

首次发布时间2021.11.29 19:44:20

本接口支持通过指定服务 ID 以及图片识别场景,获取该场景下图片的识别结果等信息。

请求说明

  • 接口名称:GetImageOCRV2
  • 请求方式:POST
  • 接口地址示例:https://imagex.volcengineapi.com/?Action=GetImageOCRV2&Version=2018-08-01
  • 请求频率限制:100 次/秒
  • 超时时间:30 秒

说明

veImageX 在全球多个区域部署,每个区域有自己对应的 OpenAPI 域名,不支持跨区域调用。具体详情请查看服务地址

请求参数

以下请求参数列表仅列出了该接口的部分公共参数,完整公共参数列表见公共参数

Query

参数类型是否必填描述
ActionString接口名称。
VersionString接口版本。veImageX 当前API的版本为2018-08-01

ServiceId

String

服务 ID。

  • 您可以在 veImageX 控制台 服务管理页面,在创建好的图片服务中获取服务 ID。
  • 您也可以通过 OpenAPI 的方式获取服务 ID,具体请参考获取所有服务信息

Body

参数类型是否必填描述
ImageUrlString图片 URL,仅当StoreUri为空时取值有效,两者都为空时报错。

Scene

String

图片 OCR 识别场景,取值如下所示。

  • general:通用场景,用于通用印刷体场景识别文本信息。
  • license:营业执照场景,用于识别营业执照中社会信用代码等文本信息。
StoreUriString图片文件的存储 URI。

返回参数

参数类型描述
SceneString图片 OCR 识别场景。
GeneralResultArray of GeneralResult通用场景
LicenseResultMap<String,LicenseResult>营业执照场景

LicenseResult

参数类型描述
ContentString图片 OCR 识别的文本内容。
Location[]int文本块的坐标位置。

GeneralResult

参数类型描述
ContentString图片 OCR 识别的文本内容。
ConfidenceString文本置信度。识别出的内容可信程度,值越大内容越准确。
Location[][]int文本块的坐标位置。

示例

请求示例

POST https://imagex.volcengineapi.com/?Action=GetImageOCRV2&Version=2018-08-01&ServiceId=fc51f8f9*
{
    "StoreUri": "***",
    "Scene": "LicenseResult",
    "ImageUrl": "***"
}

正常返回示例

{
    "ResponseMetadata": {
        "RequestId": "201806041104200100100232280022D30",
        "Action": "GetImageOCRV2",
        "Version": "2018-08-01",
        "Service": "imagex",
        "Region": "cn-north-1"
    },
    "Result": {
        "Scene": "license",
        "GeneralResult":{},
        "LicenseResult":{ 
                "USCC": {
                    "content": "9122******2173",
                    "location": [
                        184,
                        456,
                        273,
                        23
                    ]
                },
                "address": {
                    "content": "XX市XX区XX路XX号XX室",
                    "location": [
                        1219,
                        774,
                        361,
                        92
                    ]
                },
                "capital": {
                    "content": "叁佰万元整",
                    "location": [
                        1060,
                        624,
                        319,
                        29
                    ]
                },
                "corporation": {
                    "content": "XX",
                    "location": [
                        184,
                        718,
                        249,
                        29
                    ]
                },
                "expiry_date": {
                    "content": "XXXX年XX月XX日至XXXX年XX月XX日",
                    "location": [
                        1060,
                        722,
                        591,
                        31
                    ]
                },
                "name": {
                    "content": "XX省XX有限公司",
                    "location": [
                        343,
                        623,
                        351,
                        26
                    ]
                },
                "register_date": {
                    "content": "XXXX年XX月XX日",
                    "location": [
                        1059,
                        671,
                        396,
                        34
                    ]
                },
                "scope": {
                    "content": "教育科技领域内的技术研发****",
                    "location": [
                        182,
                        767,
                        697,
                        341
                    ]
                },
                "type": {
                    "content": "有限责任公司(自然人投资或控股)",
                    "location": [
                        341,
                        671,
                        394,
                        29
                    ]
                }
         }
    }
}
  	  

以上示例字段说明如下表所示:

字段描述
USCC统一社会信用代码
name公司名称
type公司类型
address公司地址
corporation公司法人
capital注册资本
register_date成立日期
expiry_date公司营业期限日期
scope经营范围

异常返回示例

{
    "ResponseMetadata": {
        "RequestId": "2022052415272701022524315306968BA4",
        "Action": "GetImageOCRV2",
        "Version": "2018-08-01",
        "Service": "imagex",
        "Region": "cn-north-1",
        "Error": {
            "CodeN": ,
            "Code": "",
            "Message": "参数"
        }
    }
}

错误码

访问错误码附加组件错误码获取详细信息。

服务端 SDK

为了方便您快速开发,veImageX 提供了配套的服务端 SDK,同时支持多种编程语言。建议您使用服务端 SDK 来调用 API,参考文档如下所示: