Repolode
thiswillbeyourgithub

thiswillbeyourgithub/wdoc

基于 RAG 的命令行工具,可跨 PDF、音频、视频、Anki 等多种文档进行总结和提问,支持任意 LLM 服务商。

Star
549
Fork
47
未关闭 Issue
2
最近提交
10天前

这是什么?

wdoc 是一个基于 Python 的 RAG 系统,用于同时总结和查询大量异构文档。它可以加载 PDF、EPUB、Office 文件、音视频(通过 Whisper 或 Deepgram 转写)、YouTube 视频和播放列表、网页、Anki 牌组、Logseq 图谱等多种来源,并统一建立索引。回答以 Markdown 形式给出,并标注每条信息来自哪份源文档。

查询流程是先用向量检索召回候选文本块,再由较便宜的模型过滤无关文档,之后由较强的模型逐篇作答,最后按语义聚类分批合并答案。总结模式按块处理文本,输出带缩进的要点列表。模型调用基于 LiteLLM,可接入 OpenAI、Anthropic、Mistral、Ollama 等服务商;私有模式下会禁用 API 密钥并限制外部连接。

使用方式包括命令行、Python 库,以及实验性的 Docker Gradio 网页界面。可选依赖让基础安装保持精简,项目还提供 Open-WebUI 工具。

核心功能

  • 01支持 15 种以上文件类型,包括 PDF、EPUB、Office 文档、音视频、YouTube、Anki 和 Logseq。
  • 02可将多种来源合并到同一索引中统一查询。
  • 03回答附带来源标注,可追溯到具体文档。
  • 04通过 LiteLLM 支持多种 LLM 服务商,包括经 Ollama 运行的本地模型。
  • 05提供私有模式,禁用 API 密钥并限制外部网络连接。
  • 06总结功能以缩进要点形式保留作者的论证过程。

适用场景

  • 跨个人 PDF、笔记和收藏文章进行提问检索。
  • 将长视频、播客或课程录音总结为结构化笔记。
  • 结合其他学习资料查询 Anki 记忆卡片。
  • 在私有模式下用本地大模型对敏感文件做问答。

快速上手

  1. 1

    使用 uvx 运行 wdoc,通过网页搜索获取带来源的答案

    uvx wdoc web "How is Nvidia today this month?"
  2. 2

    使用完整扩展包查询 PDF(请将链接替换为你自己的)

    uvx wdoc[full] --path=$link --task=query --filetype="online_pdf" --query="What does it say about alphago?" --query_retrievers='basic_multiquery' --top_k=auto_200_500

使用前须知

  • 采用 AGPL-3.0 许可证,这是一种 copyleft 许可证,要求衍生的网络服务公开源代码。
  • 项目仍在积极开发中,作者称其可用但仍有许多计划功能和待修复的小问题。
  • 默认模型通过 OpenRouter 提供,除非配置本地 LLM,否则通常需要付费 API 密钥。
  • 普通安装仅支持 PDF 和网页加载器,其他文件类型需要安装 [full] 扩展。

收录于专题

标签

常见问题

wdoc 是什么?
基于 RAG 的命令行工具,可跨 PDF、音频、视频、Anki 等多种文档进行总结和提问,支持任意 LLM 服务商。 wdoc 是一个基于 Python 的 RAG 系统,用于同时总结和查询大量异构文档。它可以加载 PDF、EPUB、Office 文件、音视频(通过 Whisper 或 Deepgram 转写)、YouTube 视频和播放列表、网页、Anki 牌组、Logseq 图谱等多种来源,并统一建立索引。回答以 Markdown 形式给出,并标注每条信息来自哪份源文档。
wdoc 可以免费使用吗?用的什么许可证?
wdoc 以 AGPL-3.0 许可证开源。用于商业产品前,请先确认许可证条款。
wdoc 还在维护吗?
活跃维护中。wdoc 最近一次提交是在 2026年10月28日。
wdoc 适合用来做什么?
跨个人 PDF、笔记和收藏文章进行提问检索。 将长视频、播客或课程录音总结为结构化笔记。 结合其他学习资料查询 Anki 记忆卡片。 在私有模式下用本地大模型对敏感文件做问答。
wdoc 怎么安装和运行?
使用 uvx 运行 wdoc,通过网页搜索获取带来源的答案: uvx wdoc web "How is Nvidia today this month?" 使用完整扩展包查询 PDF(请将链接替换为你自己的): uvx wdoc[full] --path=$link --task=query --filetype="online_pdf" --query="What does it say about alphago?" --query_retrievers='basic_multiquery' --top_k=auto_200_500
在哪里获取 wdoc?
源代码和安装说明在 GitHub 上:https://github.com/thiswillbeyourgithub/wdoc

概要由 AI 根据项目 README 生成;GitHub 数据每日更新。

相关项目