Paperless-ngx
通过 AI 使用 Paperless-ngx，搜索归档文档、总结提取的正文并更新文档元数据。
搜索文档正文和元数据，读取归档记录、更新分类，并取回原始文件或归档文件。连接也支持文档上传、PDF 操作和档案管理，具体取决于你的权限。
Agent 能在 Paperless-ngx 里做什么
按任务分组，每组列出要调用的操作。
总结归档文档
搜索归档并读取选定文档的提取文本。
- List Documents
- Get Document
整理文档元数据
读取当前元数据后，应用指定标题或分类变更。
- Get Document
- Update Document
取得归档文件
通过临时下载链接取回归档文档。
- Download Document
导入和整理文档文件
通过文件 URL 上传文档、合并 PDF，或把选中的档案导出为 ZIP 压缩包。
- Upload Document
- Merge Documents
- Bulk Download Documents
- Get Task
可以交给 Agent 的任务
方括号里填你的内容，任务标出的其他应用也要连接。
查找合同续约条款
搜索归档合同，从正文中提取续约日期和通知要求。
查找 [供应商] 的归档合同，整理续约日期和解约通知期限，注明文档 ID；正文没有写明的内容请标出。
统一发票归档信息
修改发票标题并添加指定标签，同时保留现有分类。
将文档 [ID] 重命名为 [供应商 — 发票号 — 日期]，添加标签 [标签 ID]，保留已有标签和其他元数据。
取得归档文件
通过临时下载链接取回归档文档。
取得文档 [ID] 原始上传文件的下载 URL。
导出票据交给会计
查找指定期间的票据，把原始文件打包成一个 ZIP 下载。
查找 [开始日期] 至 [结束日期]、带有标签 [标签 ID] 的票据，把原始文件打包成 ZIP，返回下载链接和文档清单。
操作139
Paperless-ngx 连接器提供的全部操作，附名称和 id。
- List Documents
list_documents列出或搜索已连接用户可见的文档，默认每页 25 条。过滤条件与 Paperless-ngx 的查询参数一一对应：id、标题、归档序列号、日期、联系人、文档类型、存储路径、标签、所有者、自定义字段、MIME 类型与内容查找可以组合使用；未建模的参数放入 additional_filters。query、text、title_search 与 more_like_id 改为走搜索索引查询，结果带 __search_hit__ 并按相关度排序，每次调用只能使用其中一个。只列出根文档；文件版本出现在每个文档的 versions 数组里。需要 view_document 权限。 - Get Document
get_document获取单个文档及其元数据、标签、自定义字段、备注、文件版本与 duplicate_documents (校验和相同的其他文档)。content 为最新版本提取出的文本，除非用 version 选择了其他版本。需要 view_document 权限以及对该文档的查看权限。 - Update Document
update_document部分更新一个文档：标题、内容、联系人、文档类型、存储路径、标签、创建日期、归档序列号、自定义字段、移除收件箱标签、所有者与对象权限。只发送提供的字段 (PATCH)；tags 与 custom_fields 会替换整个列表。修改 owner 或 set_permissions 需要是所有者或超级用户。响应带完整的 permissions 对象。需要 change_document 权限以及对该文档的修改权限。 - Delete Document
delete_document把一个文档及其全部文件版本移入回收站。回收站中的文档在配置的回收站保留期 (默认 30 天) 到期前可以恢复，并会立即从搜索索引中移除。需要 delete_document 权限以及对该文档的删除权限。 - Get Document Root
get_document_root解析任意文档 id 对应的根文档，包括文件版本的 id 与回收站中文档的 id。对根文档而言答案就是它自己的 id。需要对根文档的查看权限。 - Get Document Metadata
get_document_metadata获取文档的文件级元数据：校验和、大小、MIME 类型、媒体文件名、是否存在归档 PDF、原始文件与归档文件的解析器元数据 (例如 PDF 信息与 XMP 字段)，以及检测到的内容语言。未给 version 时读取最新版本。需要对该文档的查看权限。 - Get Document Suggestions
get_document_suggestions根据匹配规则与训练好的分类器，获取文档的联系人、标签、文档类型、存储路径与日期建议。结果会缓存，直到文档或分类器发生变化。需要对该文档的修改权限 (否则 403)。 - Get Document Ai Suggestions
get_document_ai_suggestions让配置好的语言模型为文档给出标题、标签、联系人、文档类型、存储路径与日期建议。模型选中的已有对象以 id 返回，它提议的新名称单独返回。需要实例启用 AI：否则 Paperless-ngx 返回 400 AI is required for this feature，AI 配置无效时返回 400，模型超时时返回 503。调用会在模型作答期间阻塞，并需要对该文档的修改权限。 - Download Document
download_document下载文档的文件，并以临时的连接器文件 URL 返回。默认在存在归档 PDF 时提供归档 PDF，否则提供原始上传文件；original=true 时始终提供原始文件。Paperless-ngx 的 preview 端点提供完全相同的字节，只是以内联方式返回，因此不作为单独的 action 暴露。对回收站中的文档与文件版本同样有效。需要对该文档的查看权限；超过 200 MiB 的文件会被拒绝。 - Get Document Thumbnail
get_document_thumbnail下载文档 (或其某个文件版本) 的 WebP 缩略图，并以临时的连接器文件 URL 返回。需要对该文档的查看权限。 - List Document Notes
list_document_notes列出附加在文档上的备注，最新的在前，每条都带作者。需要 view_note 权限以及对该文档的查看权限。 - Add Document Note
add_document_note以已连接用户的身份给文档添加一条备注，并返回完整的备注列表。同时会更新文档的 modified 时间戳并重新建立索引。需要 add_note 权限以及对该文档的修改权限。 - Delete Document Note
delete_document_note删除文档上的一条备注，并返回剩余的备注。需要 delete_note 权限以及对该文档的修改权限；备注 id 不属于该文档时返回 404。 - List Document Share Links
list_document_share_links列出文档尚未过期的分享链接，最新的在前。需要对该文档的修改权限 (Paperless-ngx 把读取分享链接视为分享操作)。 - Get Document History
get_document_history获取文档的审计记录：该文档及其自定义字段值的每一条已记录的创建、更新、删除与访问条目，最新的在前，附带变更的字段与操作用户。需要实例启用审计日志 (PAPERLESS_AUDIT_LOG_ENABLED，否则返回 400 Audit log is disabled)、auditlog.view_logentry 权限，并且已连接用户必须是文档所有者或超级用户，或者文档没有所有者。 - Email Document
email_document通过 Paperless-ngx 实例上配置的邮件服务器，把一个文档作为邮件附件发送。存在归档 PDF 时附加归档 PDF，除非 use_archive_version 为 false。Paperless-ngx 会经由其集合级 email 端点、以单个文档 id 处理此请求。需要 view_document 权限、对该文档的查看权限，以及已配置的外发邮件服务器 (否则返回 500 Error emailing documents)。 - Email Documents
email_documents通过 Paperless-ngx 实例上配置的邮件服务器，把多个文档作为同一封邮件的附件发送。存在归档 PDF 时附加归档 PDF，除非 use_archive_version 为 false。需要 view_document 权限、对每个文档的查看权限 (否则 403)，以及已配置的外发邮件服务器 (否则返回 500 Error emailing documents)。 - Update Document Version
update_document_version为文档上传一个新的文件版本。连接器在服务端下载 fileUrl，并以 multipart 表单字段 document 提交；Paperless-ngx 在后台把它作为根文档的新版本消费，标题、标签等元数据保持共享。返回 Celery 任务 id，用 get_task 轮询。需要 change_document 权限以及对根文档的修改权限；不支持的文件类型会以 400 拒绝。 - Delete Document Version
delete_document_version永久删除文档的一个非根文件版本。根 (原始) 版本不能用这种方式删除，请改为删除文档 (否则返回 400)。需要对根文档的删除权限。 - Update Document Version Label
update_document_version_label设置或清除文档某个文件版本 (包括根版本) 的标签。需要对根文档的修改权限。
Paperless-ngx 怎么登录
- 登录方式
- API Key提供 Paperless-ngx API Token 与公网实例 URL。
- 需要准备
- 提供 API 版本 10 的 Paperless-ngx 3.0 或更新实例，以及文档查看或修改权限。