智能结构化
更新时间:2024-12-09
接口描述
支持智能提取图片中的字段结构化信息,无需训练灵活提取。适用于各类证照、票据、表单等版式中的结构化信息录入场景。
在线调试
您可以在 示例代码中心 中调试该接口,可进行签名验证、查看在线调用的请求内容和返回结果、示例代码的自动生成。
请求说明
请求示例
HTTP 方法:POST
请求URL: https://aip.baidubce.com/rest/2.0/ocr/v1/smart_struct
URL参数:
参数 | 值 |
---|---|
access_token | 通过API Key和Secret Key获取的access_token,参考“Access Token获取” |
Header如下:
参数 | 值 |
---|---|
Content-Type | application/x-www-form-urlencoded |
Body中放置请求参数,参数详情如下:
请求参数
参数 | 是否必选 | 类型 | 可选值范围 | 说明 |
---|---|---|---|---|
image | 和 url/pdf_file 三选一 | string | - | 图像数据,base64编码,大小不超过4M,最短边至少15px,最长边最大4096px,支持jpg/jpeg/png/bmp格式 优先级:image > url > pdf_file,当image字段存在时,url、pdf_file字段失效 |
url | 和 image/pdf_file 三选一 | string | - | 图片完整url,url长度不超过1024字节,url对应的图片base64编码后大小不超过4M,最短边至少15px,最长边最大4096px,支持jpg/jpeg/png/bmp格式优先级:image > url > pdf_file,当image字段存在时,url字段失效请注意关闭URL防盗链 |
pdf_file | 和 image/url 三选一 | string | - | PDF文件,base64编码后进行urlencode,要求base64编码,大小不超过4M,最短边至少15px,最长边最大4096px优先级:image > url > pdf_file,当image、url字段存在时,pdf_file字段失效 |
pdf_file_num | 否 | string | - | 需要识别的PDF文件的对应页码,当 pdf_file 参数有效时,识别传入页码的对应页面内容,若不传入,则默认识别第 1 页 |
return_relation | 否 | string | true/false | 是否返回结构化对应关系及单文本行结果,默认为 false,即不返回,为 true 时返回,针对relations、line_info 2个数组 |
请求代码示例
提示一:使用示例代码前,请记得替换其中的示例Token、图片地址或Base64信息。
提示二:部分语言依赖的类或库,请在代码注释中查看下载地址。
1curl -i -k 'https://aip.baidubce.com/rest/2.0/ocr/v1/smart_struct?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
6'''
7智能结构化
8
9'''
10
11request_url = "https://aip.baidubce.com/rest/2.0/ocr/v1/smart_struct"
12# 二进制方式打开图片文件
13f = open('[本地文件]', 'rb')
14img = base64.b64encode(f.read())
15
16params = {"image":img}
17access_token = '[调用鉴权接口获取的token]'
18request_url = request_url + "?access_token=" + access_token
19headers = {'content-type': 'application/x-www-form-urlencoded'}
20response = requests.post(request_url, data=params, headers=headers)
21if response:
22 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
9/**
10* 智能结构化
11*/
12public class SmartStruct{
13
14 /**
15 * 重要提示代码中所需工具类
16 * FileUtil,Base64Util,HttpUtil,GsonUtils请从
17 * https://ai.baidu.com/file/658A35ABAB2D404FBF903F64D47C1F72
18 * https://ai.baidu.com/file/C8D81F3301E24D2892968F09AE1AD6E2
19 * https://ai.baidu.com/file/544D677F5D4E4F17B4122FBD60DB82B3
20 * https://ai.baidu.com/file/470B3ACCA3FE43788B5A963BF0B625F3
21 * 下载
22 */
23 public static String smartStruct() {
24 // 请求url
25 String url = "https://aip.baidubce.com/rest/2.0/ocr/v1/smart_struct";
26 try {
27 // 本地文件路径
28 String filePath = "[本地文件路径]";
29 byte[] imgData = FileUtil.readFileByBytes(filePath);
30 String imgStr = Base64Util.encode(imgData);
31 String imgParam = URLEncoder.encode(imgStr, "UTF-8");
32
33 String param = "image=" + imgParam;
34
35 // 注意这里仅为了简化编码每一次请求都去获取access_token,线上环境access_token有过期时间, 客户端可自行缓存,过期后重新获取。
36 String accessToken = "[调用鉴权接口获取的token]";
37
38 String result = HttpUtil.post(url, accessToken, param);
39 System.out.println(result);
40 return result;
41 } catch (Exception e) {
42 e.printStackTrace();
43 }
44 return null;
45 }
46
47 public static void main(String[] args) {
48 smartStruct.smartStruct();
49 }
50}
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/smart_struct";
7static std::string smartStruct_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 smartStruct_result = std::string((char *) ptr, size * nmemb);
16 return size * nmemb;
17}
18/**
19* 智能结构化
20* @return 调用成功返回0,发生错误返回其他错误码
21*/
22int smartStruct(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 = smartStruct_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/smart_struct
35?access_token=' . $token;
36$img = file_get_contents('[本地文件路径]');
37$img = base64_encode($img);
38$bodys = array(
39 'image' => $img
40);
41$res = request_post($url, $bodys);
42
43var_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 generalStruct
10 {
11 // 智能结构化
12 public static string smartStruct()
13 {
14 string token = "[调用鉴权接口获取的token]";
15 string host = "https://aip.baidubce.com/rest/2.0/ocr/v1/smart_struct?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("智能结构化:");
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,用于问题定位 |
pdf_file_size | 否 | string | 传入PDF文件的总页数,当 pdf_file 参数有效时返回该字段 |
object_id_num | 否 | uint32 | 文本行结果数,表示 object_id 的个数,当 if_relation=true 时返回 |
words_result | 是 | object{} | 识别结果数组 |
+ struct_info | 是 | object{} | 非表格区的 k-v 按结构化对应展示信息 |
++ group | 是 | array[] | key 文字行的信息 |
+++ key | 是 | array[] | key 文字行的信息 |
++++ word | 是 | string | key 文字行的文字结果 |
++++ line__probability | 是 | string | key 文字行的文字结果识别置信度 |
++++ line_location | 是 | object{} | key 文字行的位置 |
+++++ left | 是 | uint32 | 表示 key 文字行定位位置的长方形左上顶点的水平坐标 |
+++++ top | 是 | uint32 | 表示 key 文字行定位位置的长方形左上顶点的垂直坐标 |
+++++ width | 是 | uint32 | 表示 key 文字行定位位置的长方形的宽度 |
+++++ height | 是 | uint32 | 表示 key 文字行定位位置的长方形的高度 |
+++ value | 是 | array[] | value 文字行的信息 |
++++ word | 是 | string | value 文字行的文字结果 |
++++ line__probability | 是 | string | value 文字行的文字结果识别置信度 |
++++ line_location | 是 | object{} | value 文字行的位置 |
+++++ left | 是 | uint32 | 表示 value 文字行定位位置的长方形左上顶点的水平坐标 |
+++++ top | 是 | uint32 | 表示 value 文字行定位位置的长方形左上顶点的垂直坐标 |
+++++ width | 是 | uint32 | 表示 value 文字行定位位置的长方形的宽度 |
+++++ height | 是 | uint32 | 表示 value 文字行定位位置的长方形的高度 |
+ relations | 否 | object{} | 结构化对应关系,当 if_relation=true 时返回,以下字段均返回 |
++ kv_relations | 否 | array[] | 非表格区的 k-v 结构化关系,可支持一对一、一对多的关系 |
+++ root_node | 否 | uint32 | 根节点的 object_id,即 k-v 区的 key |
+++ leaf_nodes | 否 | array[] | 由根节点指向叶子节点的 object_id,及 k-v 区的 values |
++ table_relations | 否 | object{} | 表格区的结构关系 |
+++ kk_relations | 否 | array[] | 表格区的 k-k 结构关系,即多级表头的结构关系,可支持一对一、一对多的关系 |
++++ root_node | 否 | uint32 | 根节点的 object_id,即表格/表单区 k-k 关系的【前者 key】 |
++++ leaf_nodes | 否 | array[] | 由【前者 key】根节点指向叶子节点【后者 key】的object_id |
+++ kv_relations | 否 | array[] | 表格区的k-v结构关系,可支持一对一、一对多的关系 |
++++ root_node | 否 | uint32 | 根节点的 object_id,即表格区 k-v 关系的 key |
++++ leaf_nodes | 否 | array[] | 由根节点指向叶子节点的 object_id,即表格/表单区k-v关系的values |
+++ vv_relations | 否 | array[] | 表格区的v-v结构关系,可支持一对一、一对多的关系 |
++++ root_node | 否 | uint32 | 根节点的 object_id,即表格区v-v关系的【前者 value】 |
++++ leaf_nodes | 否 | array[] | 由【前者 value】根节点指向叶子节点【后者 value】的 object_id |
+ line_info | 否 | object{} | 文字行的识别结果、类别、置信度、位置信息等,当 if_relation=true 时返回,以下字段均返回 |
++ object_id | 否 | uint | 文字行的 id,唯一标识,按从上到下从左到右顺序,依次顺位排列 |
++ block_id | 否 | uint | 换行文字的 id,另一唯一标识,属于同一个词义的 n 个文字行的 block_id一致,按从上到下从左到右顺序,依次顺位排列。说明:block 只针非表格区 key、表格区 key、表格区 value。非换行的 block 元素固定返回 -1 |
++ word | 否 | string | 文字行的文字结果 |
++ line_class | 否 | string | 文字行的类别,key 表示非表格区的 key 值,value 表示非表格区的 value 值,table_value 表格区的 value 值,other 表示无结构化关系的文本行 |
++ line_class_probability | 否 | string | line_class 的分类置信度 |
++ line__probability | 否 | string | 文字行的文字结果识别置信度 |
++ line_location | 否 | object{} | 文字行的位置 |
+++ left | 否 | uint32 | 表示文字行定位位置的长方形左上顶点的水平坐标 |
+++ top | 否 | uint32 | 表示文字行定位位置的长方形左上顶点的垂直坐标 |
+++ width | 否 | uint32 | 表示文字行定位位置的长方形的宽度 |
+++ height | 否 | uint32 | 表示文字行定位位置的长方形的高度 |
返回示例
JSON
1{
2 "words_result": {
3 "struct_info": {
4 "group": [
5 {
6 "key": [
7 {
8 "word": "MORITA"
9 }
10 ],
11 "value": [
12 {
13 "word": "SHUNSUKE"
14 }
15 ]
16 },
17 {
18 "key": [
19 {
20 "word": "出生日期"
21 }
22 ],
23 "value": [
24 {
25 "word": "Date of Birth"
26 }
27 ]
28 },
29 {
30 "key": [
31 {
32 "word": "性别/Sex"
33 }
34 ],
35 "value": [
36 {
37 "word": "男/M"
38 }
39 ]
40 },
41 {
42 "key": [
43 {
44 "word": "国籍/Nationality"
45 }
46 ],
47 "value": [
48 {
49 "word": "日本/JPN"
50 }
51 ]
52 }
53 ]
54 }
55 },
56 "log_id": 1768260983737031188,
57}