mirror of
https://github.com/VectifyAI/PageIndex.git
synced 2026-04-24 23:56:21 +02:00
Rename demo script and update README wording
This commit is contained in:
parent
77722838e1
commit
4002dc94de
4 changed files with 7 additions and 7 deletions
10
README.md
10
README.md
|
|
@ -30,7 +30,7 @@
|
|||
<details open>
|
||||
<summary><h2>📢 Updates</h2></summary>
|
||||
|
||||
- 🔥 [**Agentic Vectorless RAG Example**](https://github.com/VectifyAI/PageIndex/blob/main/examples/openai_agents_demo.py): A complete *agentic, vectorless RAG* [example](https://github.com/VectifyAI/PageIndex/blob/main/examples/openai_agents_demo.py) with self-hosted PageIndex, using OpenAI Agents SDK.
|
||||
- 🔥 [**Agentic Vectorless RAG**](https://github.com/VectifyAI/PageIndex/blob/main/examples/agentic_vectorless_rag_demo.py): A simple *agentic, vectorless RAG* [example](https://github.com/VectifyAI/PageIndex/blob/main/examples/agentic_vectorless_rag_demo.py) with self-hosted PageIndex, using OpenAI Agents SDK.
|
||||
- [PageIndex Chat](https://chat.pageindex.ai): A Human-like document analysis agent [platform](https://chat.pageindex.ai) for professional long documents. Also available via [MCP](https://pageindex.ai/mcp) or [API](https://docs.pageindex.ai/quickstart).
|
||||
- [PageIndex Framework](https://pageindex.ai/blog/pageindex-intro): The PageIndex framework — an *agentic, in-context tree index* that enables LLMs to perform *reasoning-based, human-like retrieval* over long documents.
|
||||
|
||||
|
|
@ -81,12 +81,12 @@ The PageIndex service is available as a ChatGPT-style [chat platform](https://ch
|
|||
|
||||
### 🧪 Quick Hands-on
|
||||
|
||||
- 🔥 [**Agentic Vectorless RAG**](examples/openai_agents_demo.py) (**latest**) — a complete **agentic vectorless RAG** [example](https://github.com/VectifyAI/PageIndex/blob/main/examples/openai_agents_demo.py) with *self-hosted* PageIndex, using OpenAI Agents SDK.
|
||||
- 🔥 [**Agentic Vectorless RAG**](examples/agentic_vectorless_rag_demo.py) (**latest**) — a simple but complete **agentic vectorless RAG** [example](https://github.com/VectifyAI/PageIndex/blob/main/examples/agentic_vectorless_rag_demo.py) with *self-hosted* PageIndex, using OpenAI Agents SDK.
|
||||
- Try the [Vectorless RAG](https://github.com/VectifyAI/PageIndex/blob/main/cookbook/pageindex_RAG_simple.ipynb) notebook — a *minimal*, hands-on example of reasoning-based RAG using PageIndex.
|
||||
- Check out [Vision-based Vectorless RAG](https://github.com/VectifyAI/PageIndex/blob/main/cookbook/vision_RAG_pageindex.ipynb) — no OCR; a minimal, vision-based & reasoning-native RAG pipeline that works directly over page images.
|
||||
|
||||
<div align="center">
|
||||
<a href="https://github.com/VectifyAI/PageIndex/blob/main/examples/openai_agents_demo.py" target="_blank" rel="noopener">
|
||||
<a href="https://github.com/VectifyAI/PageIndex/blob/main/examples/agentic_vectorless_rag_demo.py" target="_blank" rel="noopener">
|
||||
<img src="https://img.shields.io/badge/View_on_GitHub-Agentic_Vectorless_RAG-blue?style=for-the-badge&logo=github" alt="View on GitHub: Agentic Vectorless RAG" />
|
||||
</a>
|
||||
<br/>
|
||||
|
|
@ -193,14 +193,14 @@ python3 run_pageindex.py --md_path /path/to/your/document.md
|
|||
|
||||
### Agentic Vectorless RAG Example
|
||||
|
||||
For a complete **agentic vectorless RAG** example with PageIndex, see [`examples/openai_agents_demo.py`](examples/openai_agents_demo.py) (using [OpenAI Agents SDK](https://github.com/openai/openai-agents-python)).
|
||||
For a simple, end-to-end _**agentic vectorless RAG**_ example using PageIndex (with OpenAI Agents SDK), see [`examples/agentic_vectorless_rag_demo.py`](examples/agentic_vectorless_rag_demo.py).
|
||||
|
||||
```bash
|
||||
# Install optional dependency
|
||||
pip3 install openai-agents
|
||||
|
||||
# Run the demo
|
||||
python3 examples/openai_agents_demo.py
|
||||
python3 examples/agentic_vectorless_rag_demo.py
|
||||
```
|
||||
|
||||
<!--
|
||||
|
|
|
|||
|
|
@ -20,7 +20,7 @@ class PageIndexClient:
|
|||
A client for indexing and retrieving document content.
|
||||
Flow: index() -> get_document() / get_document_structure() / get_page_content()
|
||||
|
||||
For agent-based QA, see examples/openai_agents_demo.py.
|
||||
For agent-based QA, see examples/agentic_vectorless_rag_demo.py.
|
||||
"""
|
||||
def __init__(self, api_key: str = None, model: str = None, retrieve_model: str = None, workspace: str = None):
|
||||
if api_key:
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
litellm==1.82.0
|
||||
# openai-agents # optional: required for examples/openai_agents_demo.py
|
||||
# openai-agents # optional: required for examples/agentic_vectorless_rag_demo.py
|
||||
pymupdf==1.26.4
|
||||
PyPDF2==3.0.1
|
||||
python-dotenv==1.1.0
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue