用途:从图片(截图、照片、扫描件、图表)、PDF 或文档图像中提取文字,可解析发票、收据、表单、表格等结构化文档,也支持手机拍摄照片中的文字识别。输入可为图片或 PDF 的 URL,也可为本地文件路径;用户上传图片时需先保存再以本地路径传入。
主要能力:调用 PP-OCRv5 API 完成 OCR,输出 JSON,关键字段包括 ok(成功与否)、text(完整识别文本)、result(原始 API 响应,用于调试)、error(错误详情)。识别结果应完整展示,不做截断或摘要。适用于纯文本文件、代码或 Markdown 等可直接读取的内容,以及任何不涉及图像转文字的任务。
必要用法:仅使用 PP-OCRv5 API,执行 python scripts/pp-ocrv5/ocr_caller.py。URL 输入使用 --file-url 参数,本地文件使用 --file-path 参数,推荐加 --output result.json --pretty 保存结果。示例:python scripts/pp-ocrv5/ocr_caller.py --file-url "https://example.com/invoice.jpg" --pretty;本地文件示例:python scripts/pp-ocrv5/ocr_caller.py --file-path "./document.pdf" --pretty。首次使用需先配置 API:访问 https://paddleocr.com 获取 API_URL 与 TOKEN,再运行 python scripts/pp-ocrv5/configure.py --api-url "PARSED_URL" --token "PARSED_TOKEN"。可通过 python scripts/pp-ocrv5/smoke_test.py 验证配置与连通性。
限制:不使用内置视觉能力,不提供替代方案,API 失败时直接显示错误并停止,不尝试其他 OCR 方式。若未配置,会提示 CONFIG_ERROR: PADDLEOCR_OCR_API_URL not configured。认证失败(403)需检查令牌,配额超限(429)需等待或升级。模型版本与能力由 API 端点决定。识别质量不佳时建议确认图像清晰度或提供更高分辨率图像。输出格式与提供商 API 约定可参考 references/pp-ocrv5/output_schema.md 与 references/pp-ocrv5/provider_api.md。