项目预览
项目数据
项目介绍
Star 增长趋势
本站每日记录该项目 GitHub 星标变化,观测越久曲线越完整
数据来源:GitHub API 逐日快照 · 收录于 2026-08-09 · 当前星标 ★ 40168
使用教程
环境要求
- Python 环境(README 使用 pip 安装)
- 可用的 OpenAI API Key
- 待索引的文档,例如 PDF 文件(示例为 report.pdf)
安装与启动步骤
-
1安装 PageIndex SDK
使用 pip 安装最新版 pageindex 包,安装后即可在本地 Python 代码中导入使用。
pip install -U pageindex -
2配置 LLM 密钥
把 OpenAI API Key 写入环境变量 OPENAI_API_KEY,示例值需替换为你自己的真实密钥。
import os os.environ["OPENAI_API_KEY"] = "your-openai-key" -
3初始化客户端
创建 PageIndexClient,index 指定构建树索引的模型,chat 指定检索树的模型。
from pageindex import PageIndexClient client = PageIndexClient( index="gpt-5.6-luna", # model to build the tree index chat="gpt-5.6-sol", # model to search the tree ) -
4提交文档建索引
调用 submit_document 传入本地文档路径,返回结果中的 doc_id 用于后续检索,需妥善保存。
doc_id = client.submit_document("report.pdf")["doc_id"] -
5提问验证检索
用 client.chat 针对该 doc_id 提问,返回结果即推理式检索得到的答案。
answer = client.chat("What was the 2023 operating margin?", doc_id=doc_id) print(answer)
关键配置
| 配置项 | 必填 | 说明 | 示例 |
|---|---|---|---|
OPENAI_API_KEY | 是 | 本地模式调用 LLM 的密钥,写入环境变量后客户端读取 | your-openai-key |
index | 是 | PageIndexClient 参数,指定构建树索引所用的模型 | gpt-5.6-luna |
chat | 是 | PageIndexClient 参数,指定检索树时所用的模型 | gpt-5.6-sol |
如何确认成功
运行提问脚本后能正常 print 出 answer 答案内容、无报错,即表示索引与检索流程跑通。
常见问题
Q:需要向量数据库或做分块吗?
A:不需要。README 明确说明 PageIndex 是 Vectorless, Reasoning-based RAG,无需向量库、无需分块。
Q:必须用 OpenAI 的密钥吗?
A:README 的本地模式示例使用 OPENAI_API_KEY;同时提到同一客户端可指向 PageIndex Cloud,配 API Key 使用,具体见官方文档。
Q:index 和 chat 可以是同一个模型吗?
A:README 示例中分别用 gpt-5.6-luna 建索引、gpt-5.6-sol 检索,两个参数可分别指定不同模型。
Q:支持哪些文档格式?
A:README 提到 PageIndex Flash 面向 text-based PDF(文本型 PDF),示例文档为 report.pdf。
注意事项
- 文档索引需调用你指定的 LLM,会产生相应的 API 调用与费用
- 请勿把真实 API Key 硬编码上传到公开仓库
- 更多云端与开发者用法见官方文档 docs.pageindex.ai
核心亮点
- 创新性地用推理替代向量检索,在复杂逻辑查询上准确率更高
- 支持 agentic AI 集成,检索过程可动态调整策略
- 文档索引结构设计合理,便于扩展自定义推理规则
不足之处
- 推理式检索延迟可能高于向量检索,不适合超低延迟场景
- 文档/社区待观察
适用场景
- 法律合同条款的关联查询与推理
- 科研论文中跨章节的结论溯源
- 企业内部知识库的复杂决策支持
替代项目
LlamaIndex、Haystack、LangChain
同类项目推荐
llm-app
开源
开箱即用的 AI 模板,上午搭好下午就用上
A no-code RAG server that keeps answers in sync with your documents. Works with 8 ve···
awesome-decision-models
开源
一页找齐决策模型 API、运行时与论文
A curated list of decision models (System One / typed decision models): hosted APIs,···
awesome-llm
开源
一页清单,快速找到 LLM 框架、工具与学习资料
A curated list of awesome LLM frameworks, libraries and software.
album-ai
开源
跟相册聊天,用大白话找照片,AI 自动理解内容
AI-First Album: Chat with your gallery using plain language! LLM Vision + RAG + Albu···
haiku.rag
开源
用 LanceDB + Pydantic AI 快速搭建生产级智能 RAG 应用
Agentic RAG for local and self-hosted document search: hybrid retrieval, reranking a···
rag-ecosystem
开源
手把手拆解RAG每个零件,看完就能自己搭
Understand and code every important component of RAG architecture
crw
开源
极速轻量爬虫+搜索API,AI智能体即插即用
Fast, lightweight Firecrawl/Tavily alternative in Rust. Web scraper, crawler & searc···
carrot
开源
逛 AI 工具不迷路,一站式筛出免费好用的
AI 工具导航大全,帮你快速筛选免费、实用、高效的网站资源
awesome-VLLMs
开源
一页看全视觉大模型论文脉络,调研选题不迷路
This repository collects papers on VLLM applications. We will update new papers irre···
