搜索本产品文档关键词
通用文字识别(标准含位置版)
所有文档
menu

文字识别

通用文字识别(标准含位置版)

接口描述

基于业界领先的深度学习技术,提供多场景、多语种、高精度的整图文字检测和识别服务。在通用文字识别的基础上,返回文字在图片中的位置信息,方便用户进行版式的二次处理。

在线调试

您可以在 示例代码中心 中调试该接口,可进行签名验证、查看在线调用的请求内容和返回结果、示例代码的自动生成。

请求说明

请求示例

HTTP 方法:POST

请求URL: https://aip.baidubce.com/rest/2.0/ocr/v1/general

URL参数:

参数
access_token 通过API Key和Secret Key获取的access_token,参考“Access Token获取

Header如下:

参数
Content-Type application/x-www-form-urlencoded

Body中放置请求参数,参数详情如下:

请求参数

参数
是否必选
类型
可选值范围
说明
image 和 url/pdf_file/ofd_file 四选一 string - 图像数据,base64编码后进行urlencode,要求base64编码和urlencode后大小不超过8M,最短边至少15px,最长边最大4096px,支持jpg/jpeg/png/bmp格式
优先级:image > url > pdf_file > ofd_file ,当image字段存在时,url、pdf_file、ofd_file 字段失效
url 和 image/pdf_file/ofd_file 四选一 string - 图片完整url,url长度不超过1024字节,url对应的图片base64编码后大小不超过8M,最短边至少15px,最长边最大4096px,支持jpg/jpeg/png/bmp格式
优先级:image > url > pdf_file > ofd_file,当image字段存在时,url字段失效
请注意关闭URL防盗链
pdf_file 和 image/url/ofd_file 四选一 string - PDF文件,base64编码后进行urlencode,要求base64编码和urlencode后大小不超过8M,最短边至少15px,最长边最大4096px
优先级:image > url > pdf_file > ofd_file,当image、url字段存在时,pdf_file字段失效
pdf_file_num string - 需要识别的PDF文件的对应页码,当 pdf_file 参数有效时,识别传入页码的对应页面内容,若不传入,则默认识别第 1 页
ofd_file 和 image/url/pdf_file 四选一 string - OFD文件,base64编码后进行urlencode,要求base64编码和urlencode后大小不超过8M,最短边至少15px,最长边最大4096px
优先级:image > url > pdf_file > ofd_file,当image、url、pdf_file字段存在时,ofd_file字段失效
ofd_file_num string - 需要识别的OFD文件的对应页码,当 ofd_file 参数有效时,识别传入页码的对应页面内容,若不传入,则默认识别第 1 页
recognize_granularity string big/small 是否定位单字符位置,big:不定位单字符位置,默认值;small:定位单字符位置
language_type string CHN_ENG
ENG
JAP
KOR
FRE
SPA
POR
GER
ITA
RUS
识别语言类型,默认为CHN_ENG
可选值包括:
- CHN_ENG:中英文混合
- ENG:英文
- JAP:日语
- KOR:韩语
- FRE:法语
- SPA:西班牙语
- POR:葡萄牙语
- GER:德语
- ITA:意大利语
- RUS:俄语
detect_direction string true/false 是否检测图像朝向,默认不检测,即:false。朝向是指输入图像是正常方向、逆时针旋转90/180/270度。可选值包括:
- true:检测朝向
- false:不检测朝向
输入非正向图片时,若想要达到较好识别效果,建议将此参数设置为“true”
detect_language string true/false 是否检测语言,默认不检测,即:false。当前支持中文、英语、日语、韩语
paragraph string true/false 是否输出段落信息
vertexes_location string true/false 是否返回文字外接多边形顶点位置,不支持单字位置。默认为false
probability string true/false 是否返回识别结果中每一行的置信度

请求代码示例

提示一:使用示例代码前,请记得替换其中的示例Token、图片地址或Base64信息。

提示二:部分语言依赖的类或库,请在代码注释中查看下载地址。

1curl -i -k 'https://aip.baidubce.com/rest/2.0/ocr/v1/general?access_token=【调用鉴权接口获取的token】' --data 'image=【图片Base64编码,需UrlEncode】' -H 'Content-Type:application/x-www-form-urlencoded'
1# encoding:utf-8
2
3import requests
4import base64
5
6request_url = "https://aip.baidubce.com/rest/2.0/ocr/v1/general"
7# 二进制方式打开图片文件
8f = open('[本地文件]', 'rb')
9img = base64.b64encode(f.read())
10
11params = {"image":img}
12access_token = '[调用鉴权接口获取的token]'
13request_url = request_url + "?access_token=" + access_token
14headers = {'content-type': 'application/x-www-form-urlencoded'}
15response = requests.post(request_url, data=params, headers=headers)
16if response:
17    print (response.json())
1package com.baidu.ai.aip;
2
3import com.baidu.ai.aip.utils.Base64Util;
4import com.baidu.ai.aip.utils.FileUtil;
5import com.baidu.ai.aip.utils.HttpUtil;
6
7import java.net.URLEncoder;
8
9public class General {
10
11    /**
12    * 重要提示代码中所需工具类
13    * FileUtil,Base64Util,HttpUtil,GsonUtils请从
14    * https://ai.baidu.com/file/658A35ABAB2D404FBF903F64D47C1F72
15    * https://ai.baidu.com/file/C8D81F3301E24D2892968F09AE1AD6E2
16    * https://ai.baidu.com/file/544D677F5D4E4F17B4122FBD60DB82B3
17    * https://ai.baidu.com/file/470B3ACCA3FE43788B5A963BF0B625F3
18    * 下载
19    */
20    public static String general() {
21        // 请求url
22        String url = "https://aip.baidubce.com/rest/2.0/ocr/v1/general";
23        try {
24            // 本地文件路径
25            String filePath = "[本地文件路径]";
26            byte[] imgData = FileUtil.readFileByBytes(filePath);
27            String imgStr = Base64Util.encode(imgData);
28            String imgParam = URLEncoder.encode(imgStr, "UTF-8");
29
30            String param = "image=" + imgParam;
31
32            // 注意这里仅为了简化编码每一次请求都去获取access_token,线上环境access_token有过期时间, 客户端可自行缓存,过期后重新获取。
33            String accessToken = "[调用鉴权接口获取的token]";
34
35            String result = HttpUtil.post(url, accessToken, param);
36            System.out.println(result);
37            return result;
38        } catch (Exception e) {
39            e.printStackTrace();
40        }
41        return null;
42    }
43
44    public static void main(String[] args) {
45        General.general();
46    }
47}
1#include <iostream>
2#include <curl/curl.h>
3
4// libcurl库下载链接:https://curl.haxx.se/download.html
5// jsoncpp库下载链接:https://github.com/open-source-parsers/jsoncpp/
6const static std::string request_url = "https://aip.baidubce.com/rest/2.0/ocr/v1/general";
7static std::string general_result;
8/**
9 * curl发送http请求调用的回调函数,回调函数中对返回的json格式的body进行了解析,解析结果储存在全局的静态变量当中
10 * @param 参数定义见libcurl文档
11 * @return 返回值定义见libcurl文档
12 */
13static size_t callback(void *ptr, size_t size, size_t nmemb, void *stream) {
14    // 获取到的body存放在ptr中,先将其转换为string格式
15    general_result = std::string((char *) ptr, size * nmemb);
16    return size * nmemb;
17}
18/**
19 * OCR 通用文字识别
20 * @return 调用成功返回0,发生错误返回其他错误码
21 */
22int general(std::string &json_result, const std::string &access_token) {
23    std::string url = request_url + "?access_token=" + access_token;
24    CURL *curl = NULL;
25    CURLcode result_code;
26    int is_success;
27    curl = curl_easy_init();
28    if (curl) {
29        curl_easy_setopt(curl, CURLOPT_URL, url.data());
30        curl_easy_setopt(curl, CURLOPT_POST, 1);
31        curl_httppost *post = NULL;
32        curl_httppost *last = NULL;
33        curl_formadd(&post, &last, CURLFORM_COPYNAME, "image", CURLFORM_COPYCONTENTS, "【base64_img】", CURLFORM_END);
34
35        curl_easy_setopt(curl, CURLOPT_HTTPPOST, post);
36        curl_easy_setopt(curl, CURLOPT_WRITEFUNCTION, callback);
37        result_code = curl_easy_perform(curl);
38        if (result_code != CURLE_OK) {
39            fprintf(stderr, "curl_easy_perform() failed: %s\n",
40                    curl_easy_strerror(result_code));
41            is_success = 1;
42            return is_success;
43        }
44        json_result = general_result;
45        curl_easy_cleanup(curl);
46        is_success = 0;
47    } else {
48        fprintf(stderr, "curl_easy_init() failed.");
49        is_success = 1;
50    }
51    return is_success;
52}
1<?php
2/**
3 * 发起http post请求(REST API), 并获取REST请求的结果
4 * @param string $url
5 * @param string $param
6 * @return - http response body if succeeds, else false.
7 */
8function request_post($url = '', $param = '')
9{
10    if (empty($url) || empty($param)) {
11        return false;
12    }
13
14    $postUrl = $url;
15    $curlPost = $param;
16    // 初始化curl
17    $curl = curl_init();
18    curl_setopt($curl, CURLOPT_URL, $postUrl);
19    curl_setopt($curl, CURLOPT_HEADER, 0);
20    // 要求结果为字符串且输出到屏幕上
21    curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
22    curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, false);
23    // post提交方式
24    curl_setopt($curl, CURLOPT_POST, 1);
25    curl_setopt($curl, CURLOPT_POSTFIELDS, $curlPost);
26    // 运行curl
27    $data = curl_exec($curl);
28    curl_close($curl);
29
30    return $data;
31}
32
33$token = '[调用鉴权接口获取的token]';
34$url = 'https://aip.baidubce.com/rest/2.0/ocr/v1/general?access_token=' . $token;
35$img = file_get_contents('[本地文件路径]');
36$img = base64_encode($img);
37$bodys = array(
38    'image' => $img
39);
40$res = request_post($url, $bodys);
41
42var_dump($res);
1using System;
2using System.IO;
3using System.Net;
4using System.Text;
5using System.Web;
6
7namespace com.baidu.ai
8{
9    public class General
10    {
11        // OCR 通用识别
12        public static string general()
13        {
14            string token = "[调用鉴权接口获取的token]";
15            string host = "https://aip.baidubce.com/rest/2.0/ocr/v1/general?access_token=" + token;
16            Encoding encoding = Encoding.Default;
17            HttpWebRequest request = (HttpWebRequest)WebRequest.Create(host);
18            request.Method = "post";
19            request.KeepAlive = true;
20            // 图片的base64编码
21            string base64 = getFileBase64("[本地图片文件]");
22            String str = "image=" + HttpUtility.UrlEncode(base64);
23            byte[] buffer = encoding.GetBytes(str);
24            request.ContentLength = buffer.Length;
25            request.GetRequestStream().Write(buffer, 0, buffer.Length);
26            HttpWebResponse response = (HttpWebResponse)request.GetResponse();
27            StreamReader reader = new StreamReader(response.GetResponseStream(), Encoding.Default);
28            string result = reader.ReadToEnd();
29            Console.WriteLine("OCR 通用识别:");
30            Console.WriteLine(result);
31            return result;
32        }
33
34        public static String getFileBase64(String fileName) {
35            FileStream filestream = new FileStream(fileName, FileMode.Open);
36            byte[] arr = new byte[filestream.Length];
37            filestream.Read(arr, 0, (int)filestream.Length);
38            string baser64 = Convert.ToBase64String(arr);
39            filestream.Close();
40            return baser64;
41        }
42    }
43}

返回说明

返回参数

字段
是否必选
类型
说明
log_id uint64 唯一的log id,用于问题定位
direction int32 图像方向,当 detect_direction=true 时返回该字段。
- - 1:未定义,
- 0:正向,
- 1:逆时针90度,
- 2:逆时针180度,
- 3:逆时针270度
language int32 语种类型,当 detect_language=true 时返回该字段。
- - 1:未定义,
- 0:英文,
- 1:日文,
- 2:韩文,
- 3:中文
words_result_num uint32 识别结果数,表示words_result的元素个数
words_result array[] 识别结果数组
+ words string 识别结果字符串
+ location array[] 位置数组(坐标0点为左上角)
++ left uint32 表示定位位置的长方形左上顶点的水平坐标
++ top uint32 表示定位位置的长方形左上顶点的垂直坐标
++ width uint32 表示定位位置的长方形的宽度
++ height uint32 表示定位位置的长方形的高度
+ chars array[] 单字符结果,当 recognize_granularity=small 时返回该字段
++ char string 单字符识别结果,当 recognize_granularity=small 时返回该字段
++ location array[] 位置数组(坐标0点为左上角),当 recognize_granularity=small 时返回该字段
+++ left uint32 表示定位位置的长方形左上顶点的水平坐标,当 recognize_granularity=small 时返回该字段
+++ top uint32 表示定位位置的长方形左上顶点的垂直坐标,当 recognize_granularity=small 时返回该字段
+++ width uint32 表示定位定位位置的长方形的宽度,当 recognize_granularity=small 时返回该字段
+++ height uint32 表示位置的长方形的高度,当 recognize_granularity=small 时返回该字段
+ probability object 表示识别结果中每一行的置信度值,包含average:行置信度平均值,variance:行置信度方差,min:行置信度最小值,当 probability=true 时返回该字段
+ vertexes_location array[] 识别结果中每一行的外包四边形点坐标,当 vertexes_location=true 时返回该字段
++ x uint32 水平坐标(坐标0点为左上角)
++ y uint32 垂直坐标(坐标0点为左上角)
+ finegrained_vertexes_location array[] 识别结果中每一行的多边形轮廓点坐标,当 vertexes_location=true 时返回该字段
++ x uint32 水平坐标(坐标0点为左上角)
++ y uint32 垂直坐标(坐标0点为左上角)
+ min_finegrained_vertexes_location array[] 表示 finegrained_poly_location对应的最小外包矩形点坐标,当 vertexes_location=true 时返回该字段
++ x uint32 水平坐标(坐标0点为左上角)
++ y uint32 垂直坐标(坐标0点为左上角)
paragraphs_result array[] 段落检测结果,当 paragraph=true 时返回该字段
+ words_result_idx array[] 一个段落包含的行序号,当 paragraph=true 时返回该字段
+ finegrained_vertexes_location array[] 识别结果中每一行的多边形轮廓点坐标,当 paragraph=true && vertexes_location=true 时返回该字段
++ x uint32 水平坐标(坐标0点为左上角)
++ y uint32 垂直坐标(坐标0点为左上角)
+ min_finegrained_vertexes_location array[] 表示 finegrained_poly_location对应的最小外包矩形点坐标,当 paragraph=true && vertexes_location=true 时返回该字段
++ x uint32 水平坐标(坐标0点为左上角)
++ y uint32 垂直坐标(坐标0点为左上角)
paragraphs_result_num uint32 识别结果数,表示 paragraphs_result 的元素个数,当 paragraph=true 时返回该字段
pdf_file_size string 传入PDF文件的总页数,当 pdf_file 参数有效时返回该字段
ofd_file_size string 传入OFD文件的总页数,当 ofd_file 参数有效时返回该字段

返回示例

JSON
1{
2    "log_id": 1390595283741573120,
3    "words_result_num": 2
4    "words_result": [
5        {
6            "words": " OCR",
7            "location": {
8                "top": 14,
9                "left": 47,
10                "width": 132,
11                "height": 54
12           }
13        },
14        {
15            "words": "百度文字识别",
16            "location": {
17                "top": 84,
18                "left": 47,
19                "width": 204,
20                "height": 39
21            }
22        }
23    ],
24}
上一篇
通用文字识别(标准版)
下一篇
办公文档识别