所有文档

          文字识别

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

          接口描述

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

          请求说明

          请求示例

          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二选一 string - 图像数据,base64编码后进行urlencode,要求base64编码和urlencode后大小不超过4M,最短边至少15px,最长边最大4096px,支持 jpg/jpeg/png/bmp 格式,当image字段存在时url字段失效
          url 和image二选一 string - 图片完整URL,URL长度不超过1024字节,URL对应的图片base64编码后大小不超过4M,最短边至少15px,最长边最大4096px,支持jpg/jpeg/png/bmp格式,当image字段存在时url字段失效,不支持https的图片链接
          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:不检测朝向。
          detect_language string true/false 是否检测语言,默认不检测。当前支持(中文、英语、日语、韩语)
          paragraph string true/false 是否输出段落信息
          vertexes_location string true/false 是否返回文字外接多边形顶点位置,不支持单字位置。默认为false
          probability string true/false 是否返回识别结果中每一行的置信度

          请求代码示例

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

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

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

          返回说明

          返回参数

          字段 是否必选 类型 说明
          direction int32 图像方向,当detect_direction=true时存在。
          - -1:未定义,
          - 0:正向,
          - 1: 逆时针90度,
          - 2:逆时针180度,
          - 3:逆时针270度
          log_id uint64 唯一的log id,用于问题定位
          words_result array[] 识别结果数组
          words_result_num uint32 识别结果数,表示words_result的元素个数
          +words string 识别结果字符串
          paragraphs_result array[] 段落检测结果,当 paragraph=true 时返回该字段
          + words_result_idx array[] 一个段落包含的行序号,当 paragraph=true 时返回该字段
          language int32 当detect_language=true时存在
          ++x uint32 水平坐标(坐标0点为左上角)
          ++y uint32 垂直坐标(坐标0点为左上角)
          +location array[] 位置数组(坐标0点为左上角)
          ++left uint32 表示定位位置的长方形左上顶点的水平坐标
          ++top uint32 表示定位位置的长方形左上顶点的垂直坐标
          ++width uint32 表示定位位置的长方形的宽度
          ++height uint32 表示定位位置的长方形的高度
          +words string 识别结果字符串
          +chars array[] 单字符结果,recognize_granularity=small时存在
          ++location array[] 位置数组(坐标0点为左上角)
          +++left uint32 表示定位位置的长方形左上顶点的水平坐标
          +++top uint32 表示定位位置的长方形左上顶点的垂直坐标
          +++width uint32 表示定位定位位置的长方形的宽度
          +++height uint32 表示位置的长方形的高度
          ++char string 单字符识别结果
          probability float 识别结果中每一行的置信度值,包含average:行置信度平均值,variance:行置信度方差,min:行置信度最小值

          返回示例

          HTTP/1.1 200 OK
          x-bce-request-id: 73c4e74c-3101-4a00-bf44-fe246959c05e
          Cache-Control: no-cache
          Server: BWS
          Date: Tue, 18 Oct 2016 02:21:01 GMT
          Content-Type: application/json;charset=UTF-8
          {
          "log_id": 3523983603,
          "direction": 0, //detect_direction=true时存在
          "words_result_num": 2,
          "words_result": [
              {
                  "location": {
                      "left": 35,
                      "top": 53,
                      "width": 193,
                      "height": 109
                  },
                  "words": "感动",
                  "chars": [    //recognize_granularity=small时存在
                      {
                          "location": {
                              "left": 56,
                              "top": 65,
                              "width": 69,
                              "height": 88
                          },
                          "char": "感"
                      },
                      {
                          "location": {
                              "left": 140,
                              "top": 65,
                              "width": 70,
                              "height": 88
                          },
                          "char": "动"
                      }
                  ]
              }
              ...
          ]
          }
          上一篇
          通用文字识别(标准版)
          下一篇
          办公文档识别