通用文字识别

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Query 参数

image

string

可选

要么前端把图片流编码后传到后端，要么前端上传文件到后端，后端编码后设置

图像数据，base64编码后进行urlencode，要求base64编码和urlencode后大小不超过8M，最短边至少15px，最长边最大4096px，支持jpg/jpeg/png/bmp格式优先级：image > url > pdf_file > ofd_file ，当image字段存在时，url、pdf_file、ofd_file 字段失效

language_type

string

必需

识别语言类型，默认为CHN_ENG
通用文字识别可选值包括：

CHN_ENG：中英文混合
ENG：英文
JAP：日语
KOR：韩语
FRE：法语
SPA：西班牙语
POR：葡萄牙语
GER：德语
ITA：意大利语
RUS：俄语

手写文字识别可选值可以增加： - auto_detect：自动检测语言，并识别 - DAN：丹麦语 - DUT：荷兰语 - MAL：马来语 - SWE：瑞典语 - IND：印尼语 - POL：波兰语 - ROM：罗马尼亚语 - TUR：土耳其语 - GRE：希腊语 - HUN：匈牙利语 - THA：泰语 - VIE：越南语 - ARA：阿拉伯语 - HIN：印地语

默认值:

CHN_ENG

detect_direction

boolean

可选

是否检测图像朝向，默认不检测，即：false。朝向是指输入图像是正常方向、逆时针旋转90/180/270度。可选值包括:

true：检测朝向；

false：不检测朝向。

detect_language

boolean

可选

是否检测语言，默认不检测，即：false。当前支持中文、英语、日语、韩语

paragraph

boolean

是否输出段落信息

可选

probability

boolean

可选

是否返回识别结果中每一行的置信度

detect_alteration

boolean

可选

是否检测涂改痕迹，适用于手写作文场景，默认不检测，可选值包括：
true：检测，涂改痕迹部分用“☰”返回；
false：不检测

recognize_granularity

string

可选

是否定位单字符位置，默认不定位。可选值包括：
big：不定位单字符位置；
small：定位单字符位置，可返回单字符候选字及置信度

Header 参数

Authorization

string

可选

云记-鸿蒙-用户登录otken

默认值:

Bearer {{token}}

token

string

可选

云记-安卓-web-用户登录otken

默认值:

appVersionCode

string

云记-安卓-版本号

可选

默认值:

408

Accept-Language

string

云记-鸿蒙-语言

可选

默认值:

zh

language

string

可选

云记-安卓-web-语言

默认值:

en

Body 参数multipart/form-data

file

必需

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://jnotetest-hm.jideos.com/jnotes/platform/baidu/ai/basic-general?language_type' \
--header 'Authorization: Bearer 01uohrj-elUlvNnLxb3uuYDy28LD3Pum49U531TlDWhqS2QbLMm1LhhWaW42TN8UV6caM_E9bvB6qkSBXZu0jCHQ9PdX9NnDIb7UdofssDFhwkuOijQ6T6ZPbBl5jEO7' \
--header 'token: 01uohrj-elUlvNnLxb3uuYDy28LD3Pum49U531TlDWhqS2QbLMm1LhhWaW42TN8UV6caM_E9bvB6qkSBXZu0jCHQ9PdX9NnDIb7UdofssDFhwkuOijQ6T6ZPbBl5jEO7' \
--header 'appVersionCode: 408' \
--header 'Accept-Language: zh' \
--header 'language: en' \
--form 'file=@""'

返回响应

🟢200成功

application/json

Body

code

integer

可选

msg

string

可选

data

object (OcrGeneralBasicResponse)

可选

log_id

integer <int64>

可选

唯一的log id，用于问题定位

words_result_num

integer

可选

识别结果数，表示words_result的元素个数

direction

integer

可选

图像方向，当 detect_direction=true 时返回该字段。

1：未定义，

0：正向，

1：逆时针90度，

2：逆时针180度，

3：逆时针270度

words_result

array[object (OcrWordsResult) {4}]

识别结果数组

可选

paragraphs_result

array[object (ParagraphsResult) {1}]

可选

段落检测结果，当 paragraph=true 时返回该字段

paragraphs_result_num

integer

可选

识别结果数，表示 paragraphs_result的元素个数，当 paragraph=true 时返回该字段

language

integer

可选

语种类型，当 detect_language=true 时返回该字段。

1：未定义，

0：英文，

1：日文，

2：韩文，

3：中文

pdf_file_size

string

可选

传入PDF文件的总页数，当 pdf_file 参数有效时返回该字段

ofd_file_size

string

可选

传入OFD文件的总页数，当 ofd_file 参数有效时返回该字段

示例

{
  "code": 0,
  "msg": "",
  "data": {
    "log_id": 0,
    "words_result_num": 0,
    "direction": 0,
    "words_result": [
      {
        "words": "",
        "probability": {
          "average": "",
          "min": "",
          "variance": ""
        },
        "location": {
          "top": 0,
          "left": 0,
          "width": 0,
          "height": 0
        },
        "chars": [
          {
            "char": "",
            "candidates": [
              {
                "prob": "",
                "word": ""
              }
            ],
            "location": {
              "top": 0,
              "left": 0,
              "width": 0,
              "height": 0
            }
          }
        ]
      }
    ],
    "paragraphs_result": [
      {
        "words_result_idx": [
          0
        ]
      }
    ],
    "paragraphs_result_num": 0,
    "language": 0,
    "pdf_file_size": "",
    "ofd_file_size": ""
  }
}