文档提取
开发环境
http://dev-cn.your-api-server.com
开发环境
http://dev-cn.your-api-server.com
POST
/v2/extract
概述
将带有请求的图像发送到Extract API 端点，FormX 将识别文档中的信息。POST
FormX 将使用您选择的提取器来提取并返回 JSON 格式的数据。提取器可以通过 extractor_id 参数指定。还应包括访问令牌。它们可以从门户网站仪表板获取。
图像尺寸建议
提交给提取API的图像应该有足够的大小，以便可以轻松地区分文本和特征。
该 API 支持 JPEG、PDF 和 PNG 图像类型。建议使用最小为1000x750 像素或 100 DPI的图像。
限制
该图像的文件大小为10MB。
图像尺寸限制为单边10,000像素，总像素数<75M。
使用异步模式
如果请求完成时间过长，可以使用异步模式来避免超时。这可以通过表单数据中的参数来启用。async
作业 ID
如果异步作业创建成功，则会返回带有以下内容的响应：202 Accepted``job_id``request_id
json
202 Accepted
{
"job_id": "<string>",
"request_id": "<string>",
"status": "ok"
}
获取提取结果请参考获取异步提取结果
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'http://dev-cn.your-api-server.com/v2/extract' \
--header 'API Key;' \
--header 'Content-Type: application/json' \
--data-raw '{
"extractor_id": "string"
}'响应示例响应示例
200 - 成功示例
{
"metadata": {
"request_id": "string",
"extractor_id": "string",
"job_id": "string",
"usage": 0
},
"documents": [
{
"type_confidence": 0,
"extractor_id": "string",
"formatter_output": {
"additionalProp": [
{
"value": "string",
"bounding_box": [],
"confidence": 0,
"extracted_by": "string"
},
{
"value": [
"string",
true,
0,
0
],
"bounding_box": [],
"confidence": 0,
"extracted_by": "string"
},
{
"value": {
"additionalProp": "Unknown Type: null"
},
"bounding_box": [],
"confidence": 0,
"extracted_by": "string"
},
{
"value": [
{
"additionalProp": "Unknown Type: null"
}
],
"bounding_box": [],
"confidence": 0,
"extracted_by": "string"
}
]
},
"bounding_box": [],
"data": {
"additionalProp": "string"
},
"type": "string",
"metadata": {
"page_no": 0,
"extractor_type": "string",
"slice_no": 0
},
"detailed_data": {
"additionalProp": [
{
"value": "string",
"bounding_box": [],
"confidence": 0,
"extracted_by": "string"
},
{
"value": [
"string",
true,
0,
0
],
"bounding_box": [],
"confidence": 0,
"extracted_by": "string"
},
{
"value": {
"additionalProp": "Unknown Type: null"
},
"bounding_box": [],
"confidence": 0,
"extracted_by": "string"
},
{
"value": [
{
"additionalProp": "Unknown Type: null"
}
],
"bounding_box": [],
"confidence": 0,
"extracted_by": "string"
}
]
}
},
{
"metadata": {
"page_no": 0,
"extractor_type": "string",
"slice_no": 0
},
"error": {
"info": {
"additionalProp": "Unknown Type: null"
},
"message": "string",
"code": 0
},
"extractor_id": "string"
}
],
"status": "ok"
}请求参数
Header 参数
API Key
string
必需
Body 参数application/json
返回响应
修改于 2024-05-23 09:07:12