智能结构化

更新时间：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信息。

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

curl -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'

# encoding:utf-8

import requests
import base64

'''
智能结构化

'''

request_url = "https://aip.baidubce.com/rest/2.0/ocr/v1/smart_struct"
# 二进制方式打开图片文件
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 SmartStruct{

    /**
    * 重要提示代码中所需工具类
    * 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 smartStruct() {
        // 请求url
        String url = "https://aip.baidubce.com/rest/2.0/ocr/v1/smart_struct";
        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) {
        smartStruct.smartStruct();
    }
}

#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/smart_struct";
static std::string smartStruct_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格式
    smartStruct_result = std::string((char *) ptr, size * nmemb);
    return size * nmemb;
}
/**
* 智能结构化
* @return 调用成功返回0，发生错误返回其他错误码
*/
int smartStruct(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 = smartStruct_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/smart_struct
?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 generalStruct
    {
        // 智能结构化
        public static string smartStruct()
        {
            string token = "[调用鉴权接口获取的token]";
            string host = "https://aip.baidubce.com/rest/2.0/ocr/v1/smart_struct?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("智能结构化:");
            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;
        }
    }
}

返回说明

返回参数

字段	是否必选	类型	说明
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	表示文字行定位位置的长方形的高度

返回示例

{
    "words_result": {
        "struct_info": {
            "group": [
                {
                    "key": [
                        {
                            "word": "MORITA"
                        }
                    ],
                    "value": [
                        {
                            "word": "SHUNSUKE"
                        }
                    ]
                },
                {
                    "key": [
                        {
                            "word": "出生日期"
                        }
                    ],
                    "value": [
                        {
                            "word": "Date of Birth"
                        }
                    ]
                },
                {
                    "key": [
                        {
                            "word": "性别/Sex"
                        }
                    ],
                    "value": [
                        {
                            "word": "男/M"
                        }
                    ]
                },
                {
                    "key": [
                        {
                            "word": "国籍/Nationality"
                        }
                    ],
                    "value": [
                        {
                            "word": "日本/JPN"
                        }
                    ]
                }
            ]
        }
    },
    "log_id": 1768260983737031188,
}

二维码识别

文档解析