文档中心

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

最近更新时间：2024.01.31 15:19:59

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

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

注意事项

请求频率：单用户请求频率限制为 5 次/秒。
超时时间：超时时间约为 30 秒。
前提条件：已开通文字识别 OCR 组件能力。
计费说明：文字识别 OCR 功能属于增值服务项，故使用后会产生增值服务费用，当前支持后付费的计费方式，具体请参见增值服务。
服务地址：veImageX 在全球多个区域部署，每个区域有自己对应的 OpenAPI 域名，不支持跨区域调用。具体详情请查看服务地址。

请求说明

请求方式：POST
接口地址：https://imagex.volcengineapi.com/?Action=GetImageOCRV2&Version=2018-08-01

请求参数

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

Query

参数类型是否必选示例值描述

Action String 是 GetImageOCRV2 接口名称。当前 API 的名称为 GetImageOCRV2。

Version String 是 2018-08-01 接口版本。当前 API 的版本为 2018-08-01。

参数	类型	是否必选	示例值	描述
Action	String	是	`GetImageOCRV2`	接口名称。当前 API 的名称为 `GetImageOCRV2`。
Version	String	是	`2018-08-01`	接口版本。当前 API 的版本为 2018-08-01。
ServiceId	String	是	`8j**9o`	服务 ID。您可以在 veImageX 控制台服务管理页面，在创建好的图片服务中获取服务 ID。您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息。

ServiceId

String

是

8j**9o

服务 ID。

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

Body

参数类型是否必选示例值描述

ImageUrl String 否 http://test.com/example.png 图片 URL，仅当StoreUri为空时取值有效，两者都为空时报错。

参数	类型	是否必选	示例值	描述
ImageUrl	String	否	`http://test.com/example.png`	图片 URL，仅当`StoreUri`为空时取值有效，两者都为空时报错。
Scene	String	是	`general`	图片 OCR 识别场景，取值如下所示。 general：通用场景，用于通用印刷体场景识别文本信息。 license：营业执照场景，用于识别营业执照中社会信用代码等文本信息。注意当前仅支持识别图片中简体中文和简体英文这两种文本信息。
StoreUri	String	是	`test.com/example.png`	图片文件的存储 URI。

Scene

String

是

general

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

general：通用场景，用于通用印刷体场景识别文本信息。
license：营业执照场景，用于识别营业执照中社会信用代码等文本信息。

注意

当前仅支持识别图片中简体中文和简体英文这两种文本信息。

StoreUri String 是 test.com/example.png 图片文件的存储 URI。

返回参数

参数	类型	示例值	描述
Scene	String	`general`	图片 OCR 识别场景。
GeneralResult	Array of GeneralResult	`-`	通用场景
LicenseResult	Map<String,LicenseResult>	`-`	营业执照场景

LicenseResult

参数	类型	示例值	描述
Content	String	`叁佰万元整`	图片 OCR 识别的文本内容。
Location	[]int	`[x1,y1,x2,y2]`	文本块的坐标位置。

GeneralResult

参数	类型	示例值	描述
Content	String	`花朵`	图片 OCR 识别的文本内容。
Confidence	String	`0.99161786`	文本置信度。识别出的内容可信程度，值越大内容越准确。
Location	[][]int	`[[x1,y1],[x2,y2]]`	文本块的坐标位置。

示例

请求示例

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": "201806041104200100100232280022D30",
        "Action": "GetImageOCRV2",
        "Version": "2018-08-01",
        "Service": "imagex",
        "Region": "cn-north-1"
    },
    "Result": {
        "Scene": "general",
        "LicenseResult":{},
        "GeneralResult":[ 
	            {
                "Content": "SCJDGL",
                "Location": [
                    [
                        1537,
                        243
                    ],
                    [
                        1776,
                        248
                    ]
                ],
                "Confidence": "0.99161786"
            },
            {
                "Content": "营业执照",
                "Location": [
                    [
                        573,
                        343
                    ]
                ],
                "Confidence": "1.0"
            }
        ]
    }
}

错误码

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

服务端 SDK

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