dr-doc-search 是一个 GitHub 上的开源项目,旨在让 AI 替你阅读论文或书籍。它基于 GPT-3 构建,核心功能是“与书对话”(Converse with a book),即用户上传 PDF 文件后,可以通过提问的方式获取文档中的信息。
主要能力:
- 为 PDF 文件创建索引并生成嵌入(embeddings)。
- 支持使用 OpenAI API 或 HuggingFace 模型来生成嵌入和答案。
- 提供命令行界面和 Web 界面(端口 5006)进行问答。
- 可以指定 PDF 的起始和结束页码。
- 输出目录默认为用户主目录下的 OutputDir/dr-doc-search/<pdf-name>,可通过 --app-dir 参数更改。
使用方式:
- 安装:需要 Python 3.7+ 和 Poetry。克隆仓库后,创建虚拟环境并安装依赖。
- 设置 OpenAI API 密钥(从 OpenAI 获取)。从 1.5.0 版本起,可以跳过 OpenAI,使用 HuggingFace 模型。
- 生成索引和嵌入:运行训练命令,例如使用 HuggingFace 生成嵌入。
- 提问:使用生成的索引开始提问,或打开 Web 界面(端口 5006)。使用 HuggingFace 模型时需提供 --llm 参数。
适用场景:
- 需要快速从 PDF 书籍、论文或文档中提取信息的研究人员、学生或开发者。
- 希望以对话方式探索长篇文档内容的用户。
限制与注意事项:
- 项目与 OpenAI 无关联。OpenAI API 和 GPT-3 语言模型在试用期后不是免费的。
- Windows 用户需在 IMCONV 环境变量中设置 ImageMagick 可执行文件的位置。
- 具体安装命令、代码示例和更多选项请参考官方文档和 GitHub 仓库。
项目地址:https://github.com/namuan/dr-doc-search 文档:https://namuan.github.io/dr-doc-search PyPI:https://pypi.org/project/dr-doc-search/