paper-qa

环境要求

• Python 3.11 及以上版本（版本 5 要求 Python 3.11+）
• 一个可用的 LLM API Key，如 OPENAI_API_KEY，或自建兼容 LiteLLM 的开源 LLM 服务
• 若需索引 100 篇以上论文，建议准备 Crossref 和 Semantic Scholar 的 API Key
• 待检索的论文文件目录（支持 PDF、文本文件、Office 文档和源码文件）

安装与启动步骤

1. 1安装 paper-qa

   从 PyPI 安装 PaperQA2（即版本 5），注意必须是 Python 3.11 及以上环境；开发用途请参考 CONTRIBUTING.md。

   pip install paper-qa>=5

   复制

2. 2配置 LLM API Key

   PaperQA2 依赖 LLM 运行，需设置兼容 LiteLLM 的模型 API Key 环境变量；也可改用 llamafile 等自建开源 LLM 服务。

   export OPENAI_API_KEY=sk-xxxxxxxx

   复制

3. 3准备论文目录

   新建一个存放论文的目录，示例中下载了一篇 arXiv PDF 放进去，作为待索引的语料。

   mkdir my_papers
   curl -o my_papers/PaperQA2.pdf https://arxiv.org/pdf/2409.13740
   cd my_papers

   复制

4. 4提问获取答案

   在论文目录下执行 ask 子命令，程序会先索引本地 PDF、抓取元数据，再检索并生成带引用的答案。

   pqa ask 'What is PaperQA2?'

   复制

5. 5命名索引并全文搜索

   把当前目录索引起名保存，之后可用 search 子命令做全文检索，或用 ask 针对该索引提问。

   pqa -i nanomaterials index
   pqa -i nanomaterials search thermoelectrics
   pqa -i nanomaterials ask 'Are there nm scale features in thermoelectric materials?'

   复制

6. 6Python 中调用

   除命令行外，也可在 Python 代码中直接调用 ask 函数，通过 Settings 指定温度、论文目录等参数。

   from paperqa import Settings, ask
   
   answer_response = ask(
       "What is PaperQA2?",
       settings=Settings(temperature=0.5, paper_directory="my_papers"),
   )

   复制

关键配置

如何确认成功

执行 pqa ask 后看到程序索引本地 PDF 并返回带引用的答案，说明运行成功；也可用 pqa view 查看全部当前设置。

常见问题

注意事项

• 命令行中有 pqa --help 可查看全部选项和简短说明，pqa view 可查看所有设置
• 更改 chunk_size 等影响索引的设置后，PaperQA2 会自动重新创建索引
• 不要将真实 API Key 提交到版本库，示例中的 sk-xxxxxxxx 仅为占位
• 本项目为 CalVer 发布，请注意版本号变化带来的差异