FormX.ai
  1. 在 HEADER 中指定参数
FormX.ai
  • 入门
  • 在 HEADER 中指定参数
    • 从图像中检测文档
      POST
    • 从图像中检测个人身份信息 (PII)
      POST
    • 文档提取
      POST
    • 文档提取至工作区
      POST
  • 在 FORMDATA 中指定参数
    • 从图像中检测文档
      POST
    • 从图像中检测个人身份信息 (PII)
      POST
    • 文档提取
      POST
    • 文档提取至工作区
      POST
  1. 在 HEADER 中指定参数

文档提取

开发环境
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 参数指定。还应包含访问令牌。它们可以从 Web 门户仪表板获取。

图像尺寸建议#

提交给提取 API 的图像应具有足够大的尺寸,以便可以轻松区分文本和特征。
API 支持 JPEG、PDF 和 PNG 图像类型。建议使用最小1000x750 像素或 100 DPI的图像。

限制#

该图像的文件大小为10MB。
图像尺寸限制为一侧 10,000 像素,总像素数 < 75M。

使用异步模式#

如果请求完成时间过长,可以使用异步模式来避免超时。这可以通过标头中的参数启用。X-WORKER-ASYNC

职位编号#

如果异步作业创建成功,则会返回带有以下内容的响应: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 'X-WORKER-EXTRACTOR-ID;' \
--header 'API Key;' \
--header 'content-type: image/*'
响应示例响应示例
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 参数
content-type
string 
必需
示例值:
image/*
X-WORKER-EXTRACTOR-ID
string 
提取器 ID
必需
API Key
string 
必需

返回响应

🟢200成功
application/json
Body
metadata
object 
请求的元数据
必需
request_id
string 
必需
自动生成的请求 ID
extractor_id
string 
必需
请求中指定的提取器 ID
job_id
string 
可选
异步作业ID,仅出现在异步请求中
usage
integer 
必需
此提取请求中消耗的使用量
documents
array [object {9}] 
提取的文档
必需
type_confidence
integer 
可选
extractor_id
string 
必需
formatter_output
object 
可选
bounding_box
array[string]
可选
data
object 
可选
type
string 
可选
metadata
object 
必需
detailed_data
object 
可选
error
object 
可选
status
string 
必需
🟢202成功
🟠400请求有误
修改于 2024-05-23 08:17:48
上一页
从图像中检测个人身份信息 (PII)
下一页
文档提取至工作区
Built with