使用场景

用户可以通过 wdoc 快速查询一个 PDF 文件中的特定内容，并获取详细的答案。

使用 wdoc 对 YouTube 视频进行总结，提取关键信息并生成 Markdown 格式的总结。

将 wdoc 用于个人知识库（如 Anki 卡片），快速检索和总结卡片内容。

产品特色

支持 15+ 种文件类型（如 PDF、网页、YouTube 视频等），并能同时查询多种文件类型。

使用 LangChain 处理文档，支持超过 100 种语言模型，包括本地和私有 LLM。

采用高级 RAG 技术，通过嵌入式检索和语义聚类生成高质量答案。

提供强大的总结功能，将文档的推理过程和论点压缩为易于阅读的 Markdown 格式。

支持本地和私有模式，确保数据安全，不泄露任何信息。

支持多种任务，如查询、搜索、总结以及总结后查询。

提供详细的文档和命令行帮助，方便用户快速上手。

可扩展性强，支持作为工具或库集成到其他项目中。

使用教程

1. 安装 wdoc：使用 pip 安装 wdoc，例如 `pip install wdoc`。

2. 设置环境变量：添加所选语言模型的 API 密钥作为环境变量。

3. 启动 wdoc：运行 `wdoc --task=query --path=文档路径 --filetype=文件类型` 进行查询。

4. 使用总结功能：运行 `wdoc --task=summarize --path=文档路径 --filetype=文件类型` 生成总结。

5. 保存和加载索引：使用 `--save_embeds_as` 保存索引，使用 `--load_embeds_from` 加载索引，以加快查询速度。

6. 使用高级功能：结合 `--query_retrievers` 和 `--top_k` 等参数优化查询效果。

7. 查看帮助文档：运行 `wdoc --help` 查看详细命令和参数说明。