Skip to content

Commit

Permalink
Emrgnt cmplxty patch 2 (#1657)
Browse files Browse the repository at this point in the history
* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update r2r_azure.toml

* Update pyproject.toml
  • Loading branch information
emrgnt-cmplxty authored Dec 4, 2024
1 parent d693f69 commit f715d4e
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 19 deletions.
34 changes: 17 additions & 17 deletions py/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
</h3>

# About
R2R (RAG to Riches) is the most advanced AI retrieval system, supporting Retrieval-Augmented Generation (RAG) with production-ready features. Built around a containerized [RESTful API](https://r2r-docs.sciphi.ai/api-reference/introduction), R2R offers multimodal content ingestion, hybrid search functionality, configurable GraphRAG, and comprehensive user and document management.
R2R (RAG to Riches) is the most advanced AI retrieval system, supporting Retrieval-Augmented Generation (RAG) with production-ready features. Built around a containerized [RESTful API]([https://r2r-docs.sciphi.ai/api-reference/introduction](https://r2r-docs.sciphi.ai/api-and-sdks/introduction)), R2R offers multimodal content ingestion, hybrid search functionality, configurable GraphRAG, and comprehensive user and document management.

For a more complete view of R2R, check out the [full documentation](https://r2r-docs.sciphi.ai/).

Expand All @@ -33,7 +33,7 @@ For a more complete view of R2R, check out the [full documentation](https://r2r-
- Release 3.3.0&nbsp;&nbsp;&nbsp;&nbsp;December 3, 2024&nbsp;&nbsp;&nbsp;&nbsp;

Warning: These changes are breaking!
- [V3 API Specification](https://r2r-docs.sciphi.ai/api-reference/introduction)
- [V3 API Specification](https://r2r-docs.sciphi.ai/api-and-sdks/introduction)

## Install with pip
The recommended way to get started with R2R is by using our CLI.
Expand Down Expand Up @@ -63,27 +63,27 @@ The command above will install the `full` installation which includes Hatchet fo

## Getting Started

- [Installation](/documentation/installation/overview): Quick installation of R2R using Docker or pip
- [Quickstart](/documentation/quickstart): A quick introduction to R2R's core features
- [Setup](/documentation/configuration/overview): Learn how to setup and configure R2R
- [API & SDKs](/api-and-sdks/introduction): API reference and Python/JS SDKs for interacting with R2R
- [Installation](https://r2r-docs.sciphi.ai/documentation/installation/overview): Quick installation of R2R using Docker or pip
- [Quickstart](https://r2r-docs.sciphi.ai/documentation/quickstart): A quick introduction to R2R's core features
- [Setup](https://r2r-docs.sciphi.ai/documentation/configuration/overview): Learn how to setup and configure R2R
- [API & SDKs](https://r2r-docs.sciphi.ai/api-and-sdks/introduction): API reference and Python/JS SDKs for interacting with R2R

## Cookbooks

- Advanced RAG Pipelines
- [RAG Agent](/cookbooks/rag-agent): R2R's powerful RAG agent
- [Hybrid Search](/cookbooks/hybrid-search): Introduction to hybrid search
- [Advanced RAG](/cookbooks/advanced-rag): Advanced RAG features
- [RAG Agent](https://r2r-docs.sciphi.ai/cookbooks/agent): R2R's powerful RAG agent
- [Hybrid Search](https://r2r-docs.sciphi.ai/cookbooks/hybrid-search): Introduction to hybrid search
- [Advanced RAG](https://r2r-docs.sciphi.ai/cookbooks/advanced-rag): Advanced RAG features

- Orchestration
- [Orchestration](/cookbooks/orchestration): R2R event orchestration

- Auth & Admin Features
- [Web Development](/cookbooks/web-dev): Building webapps using R2R
- [User Auth](/cookbooks/user-auth): Authenticating users
- [Collections](/cookbooks/collections): Document collections
- [Analytics & Observability](/cookbooks/observability): End-to-end logging and analytics
- [Web Application](/cookbooks/application): Connecting with the R2R Application
- [Orchestration](https://r2r-docs.sciphi.ai/cookbooks/orchestration): R2R event orchestration

- User Management
- [Web Development](https://r2r-docs.sciphi.ai/cookbooks/web-dev): Building webapps using R2R
- [User Auth](https://r2r-docs.sciphi.ai/cookbooks/user-auth): Authenticating users
- [Collections](https://r2r-docs.sciphi.ai/cookbooks/collections): Document collections
- [Analytics & Observability](https://r2r-docs.sciphi.ai/cookbooks/observability): End-to-end logging and analytics
- [Web Application](https://r2r-docs.sciphi.ai/cookbooks/application): Connecting with the R2R Application


## Community
Expand Down
1 change: 0 additions & 1 deletion py/core/configs/r2r_azure.toml
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,5 @@ document_summary_model = "azure/gpt-4o-mini"
vision_img_model = "azure/gpt-4o"
vision_pdf_model = "azure/gpt-4o"

document_summary_model = "azure/gpt-4o-mini"
[ingestion.chunk_enrichment_settings]
generation_config = { model = "azure/gpt-4o-mini" }
2 changes: 1 addition & 1 deletion py/pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ build-backend = "poetry.core.masonry.api"
[tool.poetry]
name = "r2r"
readme = "README.md"
version = "3.3.0"
version = "3.3.1"

description = "SciPhi R2R"
authors = ["Owen Colegrove <[email protected]>"]
Expand Down

0 comments on commit f715d4e

Please sign in to comment.