SuperAPI AI 工具集

doc-extract-engine

办公与效率

查看项目

更新于 10-16 00:00

技能介绍

用途:通过远程 API 端到端完成 PDF 文档的结构化信息提取,覆盖认证、上传 PDF、AI 对话设计 Schema、创建 Session、SSE 流式提取、对话修正与归档的完整流程。

主要能力:支持注册与登录(或直接提供 token)、上传 PDF、多轮 Schema 对话、创建 Session 并提取、多轮对话修正结果、归档,以及查看历史。提取与对话接口返回 SSE 流,关键事件包括 batch_created、result_update、schema_updated、error、done,可通过 on_event 回调自定义处理。

使用方式:需设置环境变量 EXTRACT_API_URL、EXTRACT_USERNAME、EXTRACT_PASSWORD,或直接提供 EXTRACT_TOKEN;依赖 pip install httpx。方式一为 Python 编程式调用,将 scripts/ 目录加入 sys.path 后 import client,使用 ExtractEngineClient 依次调用 register、login、upload_documents、create_schema_conversation、chat_schema、create_session、extract、chat_correct、end_batch。方式二为 CLI 脚本,如 python scripts/extract_flow.py full --files doc1.pdf doc2.pdf --schema-prompt "提取论文标题、作者、摘要和关键词",也支持 upload、extract、correct、archive、history 等单步操作。

适用场景:从 PDF 提取结构化信息、设计提取 Schema、批量提取文档数据等。

限制与已知问题:每次上传限 1-3 个 PDF 文件;注册邮箱校验严格,不接受 @xxx.local 等保留域名,需使用 @example.com 等合法域名;chat_schema() 的 SSE 流中 schema_updated 事件可能不携带 schema,需用 get_schema_conversation() 兜底获取;提取和对话接口可能耗时较长,客户端 _consume_sse 已设置 timeout=None。所有非 SSE 接口返回统一信封格式 {code, success, message, data}。API 接口详情参见 references/api_guide.md。