通用印刷体识别

最近更新时间:2019-07-16 19:20:13

1. 接口描述

接口请求域名: ocr.tencentcloudapi.com 。

本接口支持多场景、任意版面下整图文字的识别。支持自动识别语言类型,同时支持自选语言种类(推荐),除中英文外,支持日语、韩语、西班牙语、法语、德语、葡萄牙语、越南语、马来语、俄语、意大利语、荷兰语、瑞典语、芬兰语、丹麦语、挪威语、匈牙利语、泰语等多种语言。应用场景包括:印刷文档识别、网络图片识别、广告图文字识别、街景店招识别、菜单识别、视频标题识别、头像文字识别等。

默认接口请求频率限制:20次/秒。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:GeneralBasicOCR
Version String 公共参数,本接口取值:2018-11-19
Region String 公共参数,详见产品支持的 地域列表
ImageBase64 String 图片的 Base64 值。
支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。
支持的图片大小:所下载图片经Base64编码后不超过 3M。图片下载时间不超过 3 秒。
图片的 ImageUrl、ImageBase64 必须提供一个,如果都提供,只使用 ImageUrl。
ImageUrl String 图片的 Url 地址。
支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。
支持的图片大小:所下载图片经 Base64 编码后不超过 3M。图片下载时间不超过 3 秒。
图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议图片存储于腾讯云。
非腾讯云存储的 Url 速度和稳定性可能受一定影响。
Scene String 保留字段。
LanguageType String 识别语言类型。
支持自动识别语言类型,同时支持自选语言种类,默认中英文混合(zh)。
可选值:
zh\auto\jap\kor\
spa\fre\ger\por\
vie\may\rus\ita\
hol\swe\fin\dan\
nor\hun\tha
可选值分别表示:
中英文混合、自动识别、日语、韩语、
西班牙语、法语、德语、葡萄牙语、
越南语、马来语、俄语、意大利语、
荷兰语、瑞典语、芬兰语、丹麦语、
挪威语、匈牙利语、泰语。

3. 输出参数

参数名称 类型 描述
TextDetections Array of TextDetection 检测到的文本信息,具体内容请点击左侧链接。
Language String 检测到的语言类型,目前支持的语言类型参考入参LanguageType说明。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 通用印刷体识别示例代码

输入示例

https://ocr.tencentcloudapi.com/?Action=GeneralBasicOCR
&ImageUrl=https://xx/a.jpg
&<公共请求参数>

输出示例

{
  "Response": {
    "TextDetections": [
      {
        "DetectedText": "夏天的飞鸟,” 飞到我窗前唱歌,又飞去了。",
        "Confidence": 93,
        "Polygon": [
          {
            "X": 30,
            "Y": 147
          },
          {
            "X": 30,
            "Y": 126
          },
          {
            "X": 384,
            "Y": 133
          },
          {
            "X": 384,
            "Y": 155
          }
        ],
        "AdvancedInfo": "{\"Parag\":{\"ParagNo\":1}}"
      },
      {
        "DetectedText": "秋天的黄叶,它们没有什么可唱,只叹息声,飞落在那里。",
        "Confidence": 99,
        "Polygon": [
          {
            "X": 27,
            "Y": 200
          },
          {
            "X": 27,
            "Y": 179
          },
          {
            "X": 532,
            "Y": 185
          },
          {
            "X": 532,
            "Y": 206
          }
        ],
        "AdvancedInfo": "{\"Parag\":{\"ParagNo\":2}}"
      },
      {
        "DetectedText": "Stray birds of summer come to my window to sing and fly away.",
        "Confidence": 79,
        "Polygon": [
          {
            "X": 25,
            "Y": 304
          },
          {
            "X": 25,
            "Y": 285
          },
          {
            "X": 606,
            "Y": 289
          },
          {
            "X": 606,
            "Y": 308
          }
        ],
        "AdvancedInfo": "{\"Parag\":{\"ParagNo\":3}}"
      },
      {
        "DetectedText": "And yellow leaves of autumn, which have no songs, flutter and fall there with a sign.",
        "Confidence": 81,
        "Polygon": [
          {
            "X": 24,
            "Y": 357
          },
          {
            "X": 24,
            "Y": 339
          },
          {
            "X": 782,
            "Y": 342
          },
          {
            "X": 782,
            "Y": 360
          }
        ],
        "AdvancedInfo": "{\"Parag\":{\"ParagNo\":4}}"
      },
      {
        "DetectedText": "飞鸟集",
        "Confidence": 99,
        "Polygon": [
          {
            "X": 844,
            "Y": 558
          },
          {
            "X": 844,
            "Y": 524
          },
          {
            "X": 969,
            "Y": 525
          },
          {
            "X": 969,
            "Y": 560
          }
        ],
        "AdvancedInfo": "{\"Parag\":{\"ParagNo\":5}}"
      },
      {
        "DetectedText": "STRAYBIRDS",
        "Confidence": 99,
        "Polygon": [
          {
            "X": 739,
            "Y": 576
          },
          {
            "X": 739,
            "Y": 594
          },
          {
            "X": 973,
            "Y": 592
          },
          {
            "X": 973,
            "Y": 574
          }
        ],
        "AdvancedInfo": "{\"Parag\":{\"ParagNo\":6}}"
      }
    ],
    "Language": "zh",
    "RequestId": "8dd99adb-5144-43ca-8213-f6a929ce5075"
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation.DownLoadError 文件下载失败。
FailedOperation.EmptyImageError 图片内容为空。
FailedOperation.ImageDecodeFailed 图片解码失败。
FailedOperation.ImageNoText 图片中未检测到文本。
FailedOperation.LanguageNotSupport 输入的Language不支持。
FailedOperation.OcrFailed Ocr识别失败。
FailedOperation.UnKnowError 未知错误。
FailedOperation.UnOpenError 服务未开通。
InvalidParameterValue.InvalidParameterValueLimit 参数值错误。
LimitExceeded.TooLargeFileError 文件内容太大。
ResourcesSoldOut.ChargeStatusException 计费状态异常。