AlphaAvatar RAG Plugin
A modular Retrieval-Augmented Generation (RAG) middleware for AlphaAvatar, enabling agents to store, search, and ground answers on user-provided or locally stored knowledge.
This plugin allows AlphaAvatar agents to work with persistent knowledge bases built from files, documents, and web content—decoupling agent reasoning from raw context windows and enabling long-term, reusable memory through retrieval.
The default backend is RAGAnything, but the plugin is designed to support multiple RAG frameworks in a pluggable way.
Features
-
Persistent Knowledge Indexing Ingest and store documents (PDF / Markdown / text / HTML / web snapshots) into a searchable local index.
-
Grounded Answer Generation Retrieve relevant chunks and generate answers grounded in explicit sources rather than model-only knowledge.
-
Unified RAG Interface Abstracts indexing and querying behind a clean, agent-friendly API, independent of the underlying RAG engine.
-
Incremental & Reusable Memory Indexes can be extended, refreshed, and reused across conversations and sessions.
-
Seamless Integration with DeepResearch Designed to work naturally with DeepResearch outputs (scraped pages, downloaded PDFs) for building long-term knowledge bases.
When to Use RAG
Use indexing() when:
- The user explicitly asks to save, store, remember, or archive content (e.g. “保存一下”, “留着以后查”, “做个资料库”)
- The user provides files or URLs and implies future reuse
- Multiple documents are downloaded or collected (e.g. via DeepResearch)
- The same or similar documents are referenced repeatedly across turns
Use query() when:
- The user asks questions about previously indexed content
- Answers must be grounded in user-owned data
- Searching across a growing local knowledge base is required
Functionality
It exposes two core operations (op) that can be composed into an agent workflow:
-
indexing Persist files, documents, or web content into a searchable local index. Use this when the content should be saved for future retrieval.
-
query Retrieve relevant chunks from an existing index and generate grounded answers. Use this when answering questions based on previously indexed content.
Typical Workflow
-
Acquire content
- User uploads files
- Local file paths are provided
- Web pages are scraped or downloaded via DeepResearch
-
Decide persistence intent
- Explicit user intent → index directly
- Ambiguous intent → ask a clarification question
-
Index content
- Call
indexing()to build or update the knowledge base
- Call
-
Retrieve & answer
- Call
query()to retrieve relevant chunks - Generate grounded, source-aware answers
- Call
Installation
pip install alpha-avatar-plugins-rag
Supported RAG Frameworks
Default: RAG-Anything
RAGAnything is a flexible RAG framework optimized for:
- Heterogeneous document formats
- Incremental indexing
- Local-first storage and retrieval
- Agent-oriented workflows
It provides the default indexing and querying backend for the AlphaAvatar RAG plugin.
Additional RAG backends can be integrated in the future without changing agent logic.
Metadata
Release files for alpha-avatar-plugins-rag 0.6.7
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| alpha_avatar_plugins_rag-0.6.7.tar.gz | 8.3 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| alpha_avatar_plugins_rag-0.6.7-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 17.3 kB
Release files / alpha_avatar_plugins_rag-0.6.7.tar.gz
| Download URL | alpha_avatar_plugins_rag-0.6.7.tar.gz |
|---|---|
| Size | 8.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
80047f9334f5e12da04ae440a45475d3ef4d3fefdb1af8977ae201d474129bff
|
|
BLAKE2b-256 checksum How to use checksums |
123a663eec89c9d5ebab7e4b0755928a71a3a1f825ba90e635952f627b02d51c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.11.16
|
Release files / alpha_avatar_plugins_rag-0.6.7-py3-none-any.whl
| Download URL | alpha_avatar_plugins_rag-0.6.7-py3-none-any.whl |
|---|---|
| Size | 9.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
b6a8d57091b37bf96596dc2b6d3d3097066f47016dbf8af4b4b61f88b93f9d48
|
|
BLAKE2b-256 checksum How to use checksums |
01ffe654bf779c6e2ae5278e2fa4febe6e764871126487375ff302748e1e3ef0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.11.16
|
Security for alpha-avatar-plugins-rag 0.6.7
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.