_Released on January 23, 2025_
We’re excited to announce the newest release of R2R: **v3.3.30**! This version contains major enhancements to the agent’s capabilities, new Docker Swarm support, additional configuration options for security and extended model support, and numerous other improvements and fixes. Below is an overview of the most noteworthy changes.
---
🚀 Major Agent Upgrades
Date & Knowledge Base Awareness
- **Date awareness**: Agents now have improved context about current dates and times, enabling more precise and contextually correct responses.
- **Knowledge base insights**: Agents can query all available documents, their summaries, collections, and sizes. This means more intelligent retrieval and referencing of ingested data, paving the way for advanced summarization and context understanding.
Enhanced Tooling
- **New `content` tool**: Fetch the raw content of any document directly, enabling single-document summarizations and specialized analysis without a broad search.
- **`web_search` tool enabled by default**: Agents can call the web search tool to gather external information. This is configured out-of-the-box for the Rowland environment and can be toggled as needed.
- **`local_search` improvements**: Continues to be available for local knowledge retrieval, now with refined logic to ensure faster and more accurate searches.
Improved Agent Configuration
- **Refactored agent settings**: `agent_config` replaces the older `self.config.agent` usage, streamlining how agent behavior is controlled and removing extraneous parameters.
- **Cleaner messaging flows**: Internally, message-handling logic was overhauled for greater consistency, resulting in fewer edge cases and a more robust conversation flow.
---
🛠 New Features & Enhancements
Docker Swarm Support
- **Horizontal scaling**: R2R can now be deployed via Docker Swarm for easier clustering in distributed environments.
- **Updated Compose files**: `compose.full.swarm.yaml`, `compose.full.yaml`, and `compose.yaml` include references for seamless Docker Swarm service orchestration.
XAI / GROK Integration
- **New `XAI_API_KEY` environment variable**: Allows use of advanced XAI/GROK models.
- **Example Compose updates**: `XAI_API_KEY` is now present in `.env.example` and Docker Compose configurations, so you can pass authentication for these models automatically.
JWT Auth Provider
- **JWT-based authentication**: Added as a new auth provider, enabling a more secure and standardized authentication flow across R2R setups.
- **Integration**: Configure your JWT settings in the R2R config files to protect endpoints with token-based security.
Knowledge Graph & Document Processing
- **kg_clustering & kg_community_summary fixes**: Corrected indexing and `num_communities` handling, and improved the functions’ return structures for better downstream usage.
- **Hatchet fallback ingestion**: Introduced a fallback ingestion path to ensure documents are successfully processed even if the primary method encounters errors.
- **Empty page allowance**: The PDF parser no longer raises an error for empty pages, making ingestion more robust across diverse document formats.
- **Automatic `total_tokens` column**: R2R now automatically adds a `total_tokens` column to the `documents` table if missing, avoiding migration blockers and reducing friction for existing installations.
Configuration Examples & Cleanup
- **Combined Example TOML**: All possible configuration parameters are now grouped into a single example `r2r.toml`, making it simpler to discover and enable new features.
- **Refactored agent & retrieval logic**: Extraction of common RAG agent patterns into a dedicated `RAGAgentMixin`. Simplifies how local/web searches and content lookups are handled in agent code.
- **Pre-commit linting**: Ensures consistent code style and quality, lowering the bar for new contributors to keep the repository clean.
---
🐛 Bug Fixes & Stability
- **Agent runtime spec corrections**: Addressed edge cases where the agent would misinterpret or fail to execute runtime specifications.
- **Graph extraction patches**: Improved how graph data is extracted and utilized, reducing errors in advanced knowledge graph operations.
- **RAG streaming resilience**: Re-introduced and enhanced streaming capabilities for RAG-based queries, fixing stability issues in streaming responses.
- **Build cluster logic**: Patched a bug in the cluster-building logic to ensure robust knowledge graph creation even in complex document sets.
---
⚙️ Developer Experience
- **Dockerfile for Unstructured**: Updated with the latest NLTK data changes. Streamlines building and running the unstructured text processing environment by removing outdated Dockerfiles and consolidating dependencies.
- **Code refactoring & cleaning**: Removal of deprecated pipelines, improved logging messages, and better error handling throughout the codebase.
- **Testing improvements**: Extended and refactored tests, including coverage for new agent tools, collection ID filters, and database migrations.
---
👥 New Contributors
- **[[mstickel](https://github.com/mstickel)](https://github.com/mstickel)** contributed JWT auth provider in [[#1833](https://github.com/SciPhi-AI/R2R/pull/1833)](https://github.com/SciPhi-AI/R2R/pull/1833).
- **[[ArturTanona](https://github.com/ArturTanona)](https://github.com/ArturTanona)** contributed XAI API Key support in [[#1865](https://github.com/SciPhi-AI/R2R/pull/1865)](https://github.com/SciPhi-AI/R2R/pull/1865).
Thank you for helping make R2R even better!
---
Getting Started & Upgrading
1. **Pull the latest docker images** or update your code from the [[R2R GitHub repository](https://github.com/SciPhi-AI/R2R)](https://github.com/SciPhi-AI/R2R).
2. **Set up new environment variables** (`XAI_API_KEY`) if you intend to use XAI/GROK model features.
3. **Run migrations** to ensure the new `total_tokens` column is present in the `documents` table. R2R automatically attempts to add this column if it’s missing, with no downtime or data loss.
4. **Review your `r2r.toml`** (or equivalent config) for updated agent and RAG entries, especially if you want to enable or disable new search tools at runtime.
---
Full Changelog
For a comprehensive list of changes, including commits and pull requests, see the official [[GitHub comparison between v3.3.29 and v3.3.30](https://github.com/SciPhi-AI/R2R/compare/v3.3.29...v3.3.30)](https://github.com/SciPhi-AI/R2R/compare/v3.3.29...v3.3.30).
---
We appreciate your support and feedback. If you have questions or run into any issues, please open an issue on [[GitHub](https://github.com/SciPhi-AI/R2R/issues)](https://github.com/SciPhi-AI/R2R/issues) or reach out on our community forum. Happy building!