DocPeek

Your document Swiss-army knife API. Generate previews, titles, filenames, descriptions, and summaries for DOC, DOCX, and PDF files.

原始信息汇总

DocPeek 数据集概述

基本描述

DocPeek 是一个文档处理与AI分析API，被描述为“文档瑞士军刀API”。它能够为DOC、DOCX和PDF等文件生成预览、标题、文件名、描述和摘要。

核心功能

1. 文档预览（异步）

从支持的文档生成图像缩略图。

• 适用场景：文件浏览器、文档管理系统、电子邮件附件预览、搜索结果缩略图、内容管理仪表板。
• 选项：支持单次请求多个尺寸、PNG或JPG输出格式、自动提取多页文档的第一页。

2. 格式转换（异步）

在支持的格式之间无缝转换文档。

• 支持转换：
  • PDF → PNG, DOC, DOCX
  • DOC/DOCX → PDF, TXT, PNG, JPG
  • XLS/XLSX → PDF, CSV, PNG, JPG
  • CSV → PDF, XLSX, PNG, JPG
  • TXT → PDF, DOC, DOCX, PNG, JPG

3. AI驱动功能

• 摘要：从任何文档中提取关键点作为要点摘要，可配置长度（1-10个要点）。
• 标题生成：基于文档内容自动生成描述性标题。
• 文件名建议：基于文档内容生成简洁、描述性的文件名。
• 描述生成：生成文档内容的详细描述。

技术规格

支持的文件格式

格式	扩展名	描述
PDF	.pdf	便携式文档格式
Word	.doc, .docx	Microsoft Word 文档
Excel	.xls, .xlsx	Microsoft Excel 电子表格
CSV	.csv	逗号分隔值文件
Text	.txt	纯文本文件
Images	.jpg, .png	JPEG 和 PNG 图像

最大文件大小：200MB

输入方式

• 文件上传：通过 multipart/form-data 直接发送文档。
• URL输入：传递可公开访问文档的URL，由DocPeek获取并处理。

实时流式传输

AI驱动的端点支持**服务器发送事件（SSE）**流式传输。添加 ?stream=true 可实时接收生成的响应。

端点详情

异步端点（需轮询任务状态）

1. 预览 (POST /api/v1/preview)

   • 参数：file（二进制）或 url（字符串）、sizes（字符串，JSON）、output_format（字符串）。
   • 响应：返回任务ID，需轮询 GET /api/v1/job/{id} 获取结果。

2. 转换 (POST /api/v1/convert)

   • 参数：file（二进制）或 url（字符串）、output_format（字符串，必需）。
   • 响应：返回任务ID，需轮询 GET /api/v1/job/{id} 获取结果。

3. 任务状态 (GET /api/v1/job/:id)

   • 参数：id（字符串，路径，必需）。
   • 状态：pending（等待中）、processing（处理中）、completed（已完成）、failed（失败）。

同步端点（直接返回结果）

1. 摘要 (POST /api/v1/summary)
   • 参数：file（二进制）或 url（字符串）、length（整数）。
2. 标题 (POST /api/v1/title)
   • 参数：file（二进制）或 url（字符串）。
3. 文件名 (POST /api/v1/filename)
   • 参数：file（二进制）或 url（字符串）。
4. 描述 (POST /api/v1/describe)
   • 参数：file（二进制）或 url（字符串）。

响应格式

异步端点响应示例

json { "success": true, "job": { "id": "507f1f77bcf86cd799439011", "status": "pending", "type": "preview", "poll_url": "/api/v1/job/507f1f77bcf86cd799439011" } }

同步端点响应示例

json { "success": true, "summary": "- Key point 1

• Key point 2..." }

错误响应示例

json { "success": false, "errors": { "body": [{ "message": "File type not allowed" }] } }

限制与最佳实践

• 速率限制：每个用户同时进行的任务（仅预览和转换）最大数量为2。
• 超时时间：根据端点不同，约为2-3分钟。
• 轮询策略：建议使用指数退避策略进行轮询。

使用案例

• 文档管理系统
• 电子邮件客户端
• 搜索引擎
• 文件组织工具
• 内容平台
• 归档系统
• 工作流自动化