SuperAPI AI 工具集

paperless-search

写作与研究

查看项目

更新于 10-16 01:38

技能介绍

用途:这是一个用于在 Paperless-ngx 文档档案中检索资料的技能,通过 REST API 完成查询,适合让智能体帮用户查找发票、合同等已归档文件。

配置方式:读取配置文件 ~/.config/paperless-search/config.json,内容为实例 URL 与 API 令牌: { "url": "https://paperless.example.com", "token": "your-api-token-here" } 令牌可在 Paperless Web UI 中点击右上角用户名进入 My Profile,用圆形箭头按钮生成或重新生成。配置缺失或异常时,需让用户提供 URL 和有效令牌,再写入上述文件。

主要能力:调用 /api/documents/ 列表或搜索文档,/api/documents/{id}/ 获取含 OCR 全文的单篇文档,/api/tags/、/api/correspondents/、/api/document_types/ 列出标签、通信方和文档类型。/api/documents/ 支持查询参数:query 全文搜索、correspondent__id 按通信方、tags__id__all 要求包含全部标签、document_type__id 按类型、created__date__gte 与 created__date__lte 按创建日期范围、ordering 排序、page_size 每页数量。

用法要点:先用 jq 从配置读出 URL 和令牌,再以 Authorization: Token 头发起请求。生成文档链接时须从配置读取基础 URL,拼接 /documents/{id}/details,不可硬编码或猜测地址。

排查问题:可用 cat 配置文件配合 jq . 校验 JSON,或用 curl 请求 /api/documents/?page_size=1 测试连接。常见错误包括 401 Unauthorized(令牌失效,需重新生成)、Connection refused(URL 错误或服务未运行)、null 或解析错误(配置缺失或格式不当)。

限制:资料未提供搜索结果数量上限、权限范围、速率限制及具体部署要求等信息。