v1

latestOpenAPI 3.0.12026-07-2654973.2 KB

general information extration

智能抽取API已更新至v3，如需查看旧版API请点击

快速调试：请参考Postman调试教程或Apifox调试教程

post/ai/service/v3/entity_extraction

Request body

schemaobject required

抽取数据结构，参考JSON schema说明

Example request

{
  "file": {
    "file_base64": "/9j/4AAQSk...",
    "file_url": "https://example.com/document.pdf",
    "file_name": "document.pdf"
  },
  "schema": {
    "type": "object",
    "properties": {
      "商品": {
        "type": "string",
        "description": "商品名称"
      }
    },
    "required": [
      "商品"
    ]
  },
  "parse_options": {
    "page_start": 1,
    "page_count": 10,
    "get_image": "objects",
    "parse_mode": "scan"
  },
  "extract_options": {
    "generate_citations": true,
    "stamp": true
  }
}

Response

返回结果

code200 | 40101 | 40102 | 40103 | 40003 | 40004 | 40007 | 40008 | 40302 | 40303 | 40304 | 40305 | 40306 | 40400 | 40422 | 40423 | 40424 | 40425 | 40428 | 500 | 50011 | 50012 | 50207 required

状态码

200: Success (成功)
40101: x-ti-app-id 或 x-ti-secret-code 为空
40102: x-ti-app-id 或 x-ti-secret-code 无效，验证失败
40103: 客户端IP不在白名单
40003: 余额不足，请充值后再使用
40004: Parameter error (参数错误，请检查入参）
40007: 机器人不存在或未发布
40008: 机器人未开通，请至市场开通后重试
40302: 上传文件大小不符，文件大小不超过 50M
40303: 文件类型不支持，接口会返回实际检测到的文件类型，如“当前文件类型为.gif”
40304: 图片尺寸不符，长宽比小于2的图片宽高需在20～20000像素范围内，其他图片的宽高需在20～10000像素范围内
40305: File not uploaded (识别文件未上传）
40306: qps超过限制
40400: 无效的请求链接，请检查链接是否正确
40422: The file is corrupted (文件损坏)
40423: Password required or incorrect password (PDF密码错误)
40424: Page number out of range (页面设置超出文件范围）
40425: The input file format is not supported (输入文件格式不支持）
40428: Process office file failed (word和ppt转pdf失败或者超时)
500: Engine failed (服务器内部错误）
50011: LLM Connection Failed （访问大模型超时）
50012: LLM Engine Failed (大模型引擎错误）
50207: Partial failed (部分页面解析失败)

messagestring required

成功或错误信息

versionstring required

版本号

durationinteger

总耗时(ms)

x_request_idstring

请求ID

statusstring

处理状态

Example response

{
  "code": 200,
  "message": "Success",
  "version": "v3.0.29_20250819",
  "duration": 8267,
  "x_request_id": "7596b8c9d2ddbc9924b66651e9efc174",
  "status": "finished",
  "result": {
    "success_count": 1,
    "extracted_schema": {
      "商品": "童装 Looney Tunes UT（短袖T恤）女装SUPIMA COTTON圆领T恤（短袖）"
    },
    "citations": {
      "商品": {
        "value": "童装 Looney Tunes UT（短袖T恤）女装SUPIMA COTTON圆领T恤（短袖）",
        "bounding_regions": [
          {
            "page_number": 1,
            "position": [
              137,
              599,
              1129,
              599,
              1129,
              625,
              182,
              625
            ],
            "text": "童装 Looney Tunes UT（短袖T恤）女装SUPIMA COTTON圆领T恤（短袖）"
          }
        ]
      }
    },
    "pages": [
      {
        "page_number": 1,
        "image_id": "62bfe3c3a8e9c9cf.jpg",
        "height": 1824,
        "width": 600,
        "status": "Success",
        "durations": 930.178466796875
      }
    ],
    "stamps": [
      {
        "color": "红色",
        "position": [
          1223,
          995,
          1642,
          1007,
          1630,
          1689,
          1621,
          1677
        ],
        "stamp_shape": "圆章",
        "type": "公章",
        "value": "电力公司专用章"
      }
    ]
  },
  "part_durations": {
    "parse_duration": 1080,
    "prompt_duration": 1,
    "llm_duration": 7114,
    "format_duration": 51
  }
}

All 5 operations