1.文档提取接口说明

文档提取接口(API)定义:支持图片/PDF 文档信息提取,可根据提示词智能提取文档内容,返回结构化结果。

1.1主要功能

文档提取接口能够识别并提取图片/PDF中的文档信息。其主要功能包括:

智能提取:
支持根据提示词智能提取文档中的关键信息。
多格式支持:
支持图片和PDF格式的文档提取。
多页处理:
支持多页PDF文档的批量提取处理。
稳定高效:
提供稳定的服务,响应及时,处理速度快。

1.2API接入

支持各种程序和设备接入,包括小程序、APP、采集设备等,灵活适用于不同应用场景。

2.请求信息

2.1请求地址(URL)

POST https://ocr-api.shiliuai.com/api/doc_extract/v1

2.2请求方式

POST

2.3请求头(header)

参数 类型 说明
Content-Type string application/json
Authorization string 'APPCODE ' + 您的AppCode(注意英文空格)
参数 类型 说明
Content-Type string application/json
x-ca-key string 您的AppKey
x-ca-timestamp string 时间戳(毫秒)
x-ca-signature string 签名sign
str = app_key&timestamp&app_secret
sign = md5(str)

2.4请求体(body)

参数 是否必填 类型 说明
file_base64 必填其中之一 string base64编码的图片文件或PDF文件
file_url string 图片文件或PDF文件的url
prompt 选填 string 关于文档信息提取的提示词,比如:"以json格式输出文档内容。",默认以text形式输出

3.返回信息

3.1返回类型

JSON

3.2返回码

参数名 类型 说明
code int 返回码,200表示成功
msg string 返回信息

3.3返回信息

参数名 类型 说明
code int 错误码
msg string 错误信息(英文)
msg_cn string 错误信息(中文)
success bool 识别是否成功
file_id string 请求文件ID
request_id string 唯一请求ID
data object 具体见返回示例

3.4返回示例

成功返回示例

成功示例:
{
    'code': 200,
    'msg': 'OK',
    'msg_cn': '成功',
    'success': True,
    'file_id': file id,
    'request_id': request id,
    'data': {
        "page_count": 5,        // int, 文件页面总数
        "process_pages": 5,     // int, 处理页面数
        "content": content      // 文档提取结果
    }
}

错误返回示例

失败示例:
{
    'code': error code,
    'msg': error message,
    'msg_cn': 中文错误信息,
    'success': False,
    'file_id': file id,
    'request_id': request id,
    'data': {}
}

3.5错误码

错误码 说明
200 成功
400 请求错误
401 未授权
500 服务错误

具体错误原因请看msg或msg_cn

4.示例代码

4.1 Python

同步调用

# -*- coding: utf-8 -*-
import requests
import base64
import json

# 请求接口
URL = "https://ocr-api.shiliuai.com/api/doc_extract/v1"

# 图片/pdf文件转base64
def get_base64(file_path):
    with open(file_path, "rb") as f:
        data = f.read()
    return base64.b64encode(data).decode("utf8")

def demo(appcode, file_path):
    # 请求头
    headers = {
        "Authorization": "APPCODE %s" % appcode,
        "Content-Type": "application/json"
    }

    # 请求体
    b64 = get_base64(file_path)
    data = {
        "file_base64": b64,
        "prompt": ""
    }

    # 请求
    response = requests.post(url=URL, headers=headers, json=data)
    content = json.loads(response.content)
    print(content)

if __name__ == "__main__":
    appcode = "你的APPCODE"
    file_path = "本地文件路径"
    demo(appcode, file_path)
# -*- coding: utf-8 -*-
import requests
import base64
import json
import hashlib
import time

# 请求接口
URL = "https://ocr-api.shiliuai.com/api/doc_extract/v1"

# 图片/pdf文件转base64
def get_base64(file_path):
    with open(file_path, "rb") as f:
        data = f.read()
    return base64.b64encode(data).decode("utf8")

# md5
def md5(s):
    return hashlib.md5(s.encode("utf8")).hexdigest()

def demo(app_key, app_secret, file_path):
    # 请求头(签名)
    t = int(time.time() * 1000)
    s = "%s&%s&%s" % (app_key, t, app_secret)
    sign = md5(s)
    headers = {
        "x-ca-key": app_key,
        "x-ca-timestamp": str(t),
        "x-ca-signature": sign,
        "Content-Type": "application/json"
    }

    # 请求体
    b64 = get_base64(file_path)
    data = {
        "file_base64": b64,
        "prompt": ""
    }

    # 请求
    response = requests.post(url=URL, headers=headers, json=data)
    content = json.loads(response.content)
    print(content)

if __name__ == "__main__":
    app_key = "你的APP_KEY"
    app_secret = "你的APP_SECRET"
    file_path = "本地文件路径"
    demo(app_key, app_secret, file_path)

4.2 PHP

//图片/pdf转base64
function get_base64($path){
    if($fp = fopen($path, "rb", 0)) {
        $binary = fread($fp, filesize($path));// 文件读取
        fclose($fp);
        $b64 = base64_encode($binary);// 转base64
    }else{
        $b64="";
        printf("%s 文件不存在", $path);
    }
    return $b64;
}

$url = "https://ocr-api.shiliuai.com/api/doc_extract/v1";
$appcode = "你的APPCODE";
$file_path = "文件路径";
$method = "POST";

// 请求头
$headers = array();
array_push($headers, "Authorization:APPCODE " . $appcode);
array_push($headers, "Content-Type:application/json");

// 请求体
$b64 = get_base64($file_path);
$data = array(
    "file_base64" => $b64,
    "prompt" => ""
);
$post_data = json_encode($data);

// 请求
$curl = curl_init();
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, $method);
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_FAILONERROR, false);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_HEADER, true);
curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, false);
curl_setopt($curl, CURLOPT_SSL_VERIFYHOST, false);
curl_setopt($curl, CURLOPT_POSTFIELDS, $post_data);

$result = curl_exec($curl);
var_dump($result);
function get_base64($path){
    if($fp = fopen($path, "rb", 0)) {
        $binary = fread($fp, filesize($path));// 文件读取
        fclose($fp);
        $b64 = base64_encode($binary);// 转base64
    }else{
        $b64="";
        printf("%s 文件不存在", $path);
    }
    return $b64;
}

$url = "https://ocr-api.shiliuai.com/api/doc_extract/v1";
$file_path = "文件路径";
$method = "POST";

//请求头(签名)
$app_key = "你的app_key";
$app_secret = "你的app_secret";
$timestamp = round(microtime(true) * 1000); // 毫秒时间戳
$sign_string = $app_key . "&" . $timestamp . "&" . $app_secret;
$sign = md5($sign_string);

$headers = array();
array_push($headers, "Content-Type:application/json");
array_push($headers, "x-ca-key:" . $app_key);
array_push($headers, "x-ca-timestamp:" . $timestamp);
array_push($headers, "x-ca-signature:" . $sign);

// 请求体
$b64 = get_base64($file_path);
$data = array(
    "file_base64" => $b64,
    "prompt" => ""
);
$post_data = json_encode($data);

// 请求
$curl = curl_init();
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, $method);
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_FAILONERROR, false);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_HEADER, true);
curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, false);
curl_setopt($curl, CURLOPT_SSL_VERIFYHOST, false);
curl_setopt($curl, CURLOPT_POSTFIELDS, $post_data);

$result = curl_exec($curl);
var_dump($result);

4.3 Java

import com.alibaba.fastjson2.JSON;
import com.alibaba.fastjson2.JSONObject;
import org.apache.http.HttpResponse;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;
import org.apache.commons.io.FileUtils;
import java.io.File;
import java.io.IOException;
import java.util.HashMap;
import java.util.Map;
import java.util.Base64;

public class Main {
    public static String get_base64(String path) {
        String b64 = "";
        try {
            byte[] content = FileUtils.readFileToByteArray(new File(path));
            b64 = Base64.getEncoder().encodeToString(content);
        } catch (IOException e) {
            e.printStackTrace();
        }
        return b64;
    }

    public static void main(String[] args) {
        String url = "https://ocr-api.shiliuai.com/api/doc_extract/v1";// 请求接口
        String appcode = "你的APPCODE";
        String file_path = "本地文件路径";

        Map headers = new HashMap<>();
        headers.put("Authorization", "APPCODE " + appcode);
        headers.put("Content-Type", "application/json");

        JSONObject requestObj = new JSONObject();
        requestObj.put("file_base64", get_base64(file_path));
        requestObj.put("prompt", "");
        String bodys = requestObj.toString();

        try (CloseableHttpClient httpClient = HttpClients.createDefault()) {
            HttpPost httpPost = new HttpPost(url);
            for (Map.Entry entry : headers.entrySet()) {
                httpPost.addHeader(entry.getKey(), entry.getValue());
            }
            StringEntity entity = new StringEntity(bodys, "UTF-8");
            httpPost.setEntity(entity);
            HttpResponse response = httpClient.execute(httpPost);
            int stat = response.getStatusLine().getStatusCode();
            if (stat != 200) {
                System.out.println("Http code: " + stat);
                return;
            }
            String res = EntityUtils.toString(response.getEntity());
            JSONObject res_obj = JSON.parseObject(res);
            System.out.println(res_obj.toJSONString());
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}
import com.alibaba.fastjson2.JSON;
import com.alibaba.fastjson2.JSONObject;
import org.apache.commons.io.FileUtils;
import org.apache.http.HttpResponse;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;
import java.io.File;
import java.io.IOException;
import java.util.HashMap;
import java.util.Map;
import java.util.Base64;
import java.security.MessageDigest;
import java.security.NoSuchAlgorithmException;

public class Demo {
    public static String get_base64(String path) {
        String b64 = "";
        try {
            File file = new File(path);
            if (!file.exists()) {
                System.err.println("文件不存在: " + path);
                return b64;
            }
            byte[] content = FileUtils.readFileToByteArray(file);
            b64 = Base64.getEncoder().encodeToString(content);
        } catch (IOException e) {
            System.err.println("读取文件失败: " + e.getMessage());
            e.printStackTrace();
        }
        return b64;
    }

    public static String MD5(String input) {
        try {
            MessageDigest md = MessageDigest.getInstance("MD5");
            byte[] messageDigest = md.digest(input.getBytes());
            StringBuilder hexString = new StringBuilder();
            for (byte b : messageDigest) {
                String hex = Integer.toHexString(0xff & b);
                if (hex.length() == 1) hexString.append('0');
                hexString.append(hex);
            }
            return hexString.toString();
        } catch (NoSuchAlgorithmException e) {
            e.printStackTrace();
        }
        return null;
    }

    public static void main(String[] args) {
        String url = "https://ocr-api.shiliuai.com/api/doc_extract/v1";// 请求接口
        String file_path = "本地文件路径";
        String app_key = "你的APPKEY";
        String app_secret = "你的APPSECRET";
        String timestamp = System.currentTimeMillis() + "";
        String sign = MD5(app_key + "&" + timestamp + "&" + app_secret);

        Map headers = new HashMap<>();
        headers.put("Content-Type", "application/json");
        headers.put("x-ca-key", app_key);
        headers.put("x-ca-timestamp", timestamp);
        headers.put("x-ca-signature", sign);

        JSONObject requestObj = new JSONObject();
        requestObj.put("file_base64", get_base64(file_path));
        requestObj.put("prompt", "");
        String bodys = requestObj.toString();

        try (CloseableHttpClient httpClient = HttpClients.createDefault()) {
            HttpPost httpPost = new HttpPost(url);
            for (Map.Entry entry : headers.entrySet()) {
                httpPost.addHeader(entry.getKey(), entry.getValue());
            }
            StringEntity entity = new StringEntity(bodys, "UTF-8");
            httpPost.setEntity(entity);
            HttpResponse response = httpClient.execute(httpPost);
            int stat = response.getStatusLine().getStatusCode();
            if (stat != 200) {
                System.out.println("Http code: " + stat);
                System.out.println("Http  " + EntityUtils.toString(response.getEntity()));
                return;
            }
            String res = EntityUtils.toString(response.getEntity());
            JSONObject res_obj = JSON.parseObject(res);
            System.out.println(res_obj.toJSONString());
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

4.4 JavaScript

// 需 Node.js 18+(内置 fetch)
const fs = require('fs');

const apiUrl = 'https://ocr-api.shiliuai.com/api/doc_extract/v1';
const appcode = '你的APPCODE';
const filePath = '本地文件路径';

async function main() {
  const fileBase64 = fs.readFileSync(filePath).toString('base64');

  const res = await fetch(apiUrl, {
    method: 'POST',
    headers: {
      Authorization: 'APPCODE ' + appcode,
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({ file_base64: fileBase64, prompt: '' })
  });

  const text = await res.text();
  if (!res.ok) {
    console.error('Http code:', res.status, text);
    return;
  }
  console.log(JSON.stringify(JSON.parse(text), null, 2));
}

main().catch(console.error);
// 需 Node.js 18+(内置 fetch)
const fs = require('fs');
const crypto = require('crypto');

const apiUrl = 'https://ocr-api.shiliuai.com/api/doc_extract/v1';
const filePath = '本地文件路径';
const appKey = '你的APPKEY';
const appSecret = '你的APPSECRET';
const timestamp = Date.now().toString();
const signHex = crypto.createHash('md5').update(appKey + '&' + timestamp + '&' + appSecret).digest('hex');

async function main() {
  const fileBase64 = fs.readFileSync(filePath).toString('base64');

  const res = await fetch(apiUrl, {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      'x-ca-key': appKey,
      'x-ca-timestamp': timestamp,
      'x-ca-signature': signHex
    },
    body: JSON.stringify({ file_base64: fileBase64, prompt: '' })
  });

  const text = await res.text();
  if (!res.ok) {
    console.error('Http code:', res.status, text);
    return;
  }
  console.log(JSON.stringify(JSON.parse(text), null, 2));
}

main().catch(console.error);

4.5 C#

using System;
using System.Collections.Generic;
using System.IO;
using System.Net.Http;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
using Newtonsoft.Json.Linq;

namespace MyCSharpApp
{
    public class Program
    {
        public static string GetBase64(string path)
        {
            string b64 = "";
            try
            {
                byte[] content = File.ReadAllBytes(path);
                b64 = Convert.ToBase64String(content);
            }
            catch (Exception e)
            {
                Console.WriteLine(e.Message);
            }
            return b64;
        }

        public static async Task Main(string[] args)
        {
            string url = "https://ocr-api.shiliuai.com/api/doc_extract/v1";// 请求接口
            string appcode = "你的APPCODE";
            string file_path = "本地文件路径";

            Dictionary headers = new Dictionary
            {
                { "Authorization", "APPCODE " + appcode }
            };

            JObject requestObj = new JObject();
            requestObj["file_base64"] = GetBase64(file_path);
            requestObj["prompt"] = "";
            string body = requestObj.ToString();

            try
            {
                using (HttpClient client = new HttpClient())
                {
                    foreach (var header in headers)
                    {
                        client.DefaultRequestHeaders.Add(header.Key, header.Value);
                    }
                    StringContent content = new StringContent(body, Encoding.UTF8, "application/json");
                    HttpResponseMessage response = await client.PostAsync(url, content);
                    if (!response.IsSuccessStatusCode)
                    {
                        Console.WriteLine($"Http code: {(int)response.StatusCode}");
                        return;
                    }
                    string responseContent = await response.Content.ReadAsStringAsync();
                    JObject resObj = JObject.Parse(responseContent);
                    Console.WriteLine(resObj.ToString(Formatting.Indented));
                }
            }
            catch (Exception e)
            {
                Console.WriteLine(e.Message);
            }
        }
    }
}
using System;
using System.Collections.Generic;
using System.IO;
using System.Net.Http;
using System.Security.Cryptography;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
using Newtonsoft.Json.Linq;

namespace MyCSharpApp
{
    public class Program
    {
        public static string GetBase64(string path)
        {
            string b64 = "";
            try
            {
                byte[] content = File.ReadAllBytes(path);
                b64 = Convert.ToBase64String(content);
            }
            catch (Exception e)
            {
                Console.Error.WriteLine("读取文件失败: " + e.Message);
            }
            return b64;
        }

        public static string CalculateMD5(string input)
        {
            try
            {
                using (MD5 md5 = MD5.Create())
                {
                    byte[] inputBytes = Encoding.UTF8.GetBytes(input);
                    byte[] hashBytes = md5.ComputeHash(inputBytes);
                    StringBuilder sb = new StringBuilder();
                    for (int i = 0; i < hashBytes.Length; i++)
                    {
                        sb.Append(hashBytes[i].ToString("x2"));
                    }
                    return sb.ToString();
                }
            }
            catch (Exception e)
            {
                Console.WriteLine(e.Message);
                return string.Empty;
            }
        }

        public static async Task Main(string[] args)
        {
            string url = "https://ocr-api.shiliuai.com/api/doc_extract/v1";// 请求接口
            string file_path = "本地文件路径";
            string app_key = "你的APPKEY";
            string app_secret = "你的APPSECRET";
            string timestamp = DateTimeOffset.Now.ToUnixTimeMilliseconds().ToString();
            string sign = CalculateMD5(app_key + "&" + timestamp + "&" + app_secret);

            Dictionary headers = new Dictionary
            {
                { "x-ca-key", app_key },
                { "x-ca-timestamp", timestamp },
                { "x-ca-signature", sign }
            };

            JObject requestObj = new JObject();
            requestObj["file_base64"] = GetBase64(file_path);
            requestObj["prompt"] = "";
            string body = requestObj.ToString();

            try
            {
                using (HttpClient client = new HttpClient())
                {
                    foreach (var header in headers)
                    {
                        client.DefaultRequestHeaders.Add(header.Key, header.Value);
                    }
                    StringContent content = new StringContent(body, Encoding.UTF8, "application/json");
                    HttpResponseMessage response = await client.PostAsync(url, content);
                    if (!response.IsSuccessStatusCode)
                    {
                        Console.WriteLine($"Http code: {(int)response.StatusCode}");
                        Console.WriteLine($"Http {await response.Content.ReadAsStringAsync()}");
                        return;
                    }
                    string responseContent = await response.Content.ReadAsStringAsync();
                    JObject resObj = JObject.Parse(responseContent);
                    Console.WriteLine(resObj.ToString(Formatting.Indented));
                }
            }
            catch (Exception e)
            {
                Console.WriteLine(e.Message);
            }
        }
    }
}