API 文档
信息抽取 API
从票据、证件、表单等图像中提取结构化信息,支持自定义 JSON Schema,以 JSON 格式返回提取结果
概述
信息抽取 API 可以从票据、证件、表单等图像中提取结构化信息,支持自定义 JSON Schema 定义提取字段,以 JSON 格式返回提取结果。模型会智能识别图像中的对应信息并填充到 Schema 中。
它使用统一的 JSON 请求格式,支持 URL 引用或 base64 编码的图像数据。
身份验证
API 支持以下身份验证方法:
- API 密钥: 通过查询参数传递您的 API 密钥
?key=YOUR_API_KEY
从图像提取结构化信息
使用智能识别技术从图像文件中提取结构化信息,支持自定义 JSON Schema。
请求
POST /api/key-information-extraction
参数:
参数 | 类型 | 必需 | 描述 |
---|---|---|---|
document | object | 是 | 文档对象 |
document.type | string | 是 | 固定值 "image_url" |
document.image_url | string | 是 | 图像 URL 或 base64 数据 |
result_schema | object/string | 是 | JSON Schema,定义要提取的字段 |
filename | string | 否 | 文件名(推荐用于 base64 数据) |
key | string | 否 | API 密钥(查询参数,已登录用户可选) |
result_schema 说明:
- 可以是 JSON 对象或 JSON 字符串
- 最多支持 3 层嵌套
- 只需要定义 key(字段名),value 保持为空字符串
- 支持数组结构
示例:
使用图像 URL:
curl -X POST "https://llmocr.com/api/key-information-extraction?key=YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"document": {
"type": "image_url",
"image_url": "https://llmocr.com/invoice.jpg"
},
"result_schema": {
"销售方名称": "",
"购买方名称": "",
"不含税价": "",
"发票代码": ""
}
}'
使用 Base64 图像数据:
curl -X POST "https://llmocr.com/api/key-information-extraction?key=YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"document": {
"type": "image_url",
"image_url": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEA..."
},
"result_schema": {
"姓名": "",
"身份证号": "",
"地址": ""
},
"filename": "id-card.jpg"
}'
响应
参数:
参数 | 类型 | 描述 |
---|---|---|
id | string | 数据库记录 ID |
filename | string | 文件名 |
content | string | 提取的结构化信息(JSON 字符串格式) |
format | string | 输出格式,固定为 "json" |
timestamp | number | 处理完成时间戳 |
payload | string | API 端点 URL |
示例:
{
"id": "12345",
"filename": "invoice.jpg",
"content": "{\"销售方名称\":\"湖北中基汽车销售服务有限公司\",\"购买方名称\":\"蔡应时\",\"不含税价\":\"270000.00\",\"发票代码\":\"142011726001\"}",
"format": "json",
"timestamp": 1640995200000,
"payload": "https://llmocr.com/api/key-information-extraction?key=YOUR_API_KEY"
}