Python SDK
Introduction
Build, scale, and manage user-facing Retrieval-Augmented Generation applications.
R2R Python SDK Documentation
Installation
Before starting, make sure you have completed the R2R installation.
Install the R2R Python SDK:
pip install r2r
Getting Started
- Import the R2R client:
from r2r import R2RClient
- Initialize the client:
client = R2RClient("http://localhost:7272")
- Check if R2R is running correctly:
health_response = client.health()
# {"status":"ok"}
- Login (Optional):
client.register("[email protected]", "my_password")
# client.verify_email("[email protected]", "my_verification_code")
client.login("[email protected]", "my_password")
When using authentication the commands below automatically restrict the scope to a user’s available documents.
Additional Documentation
For more detailed information on specific functionalities of R2R, please refer to the following documentation:
- Document Ingestion: Learn how to add, retrieve, and manage documents in R2R.
- Search & RAG: Explore various querying techniques and Retrieval-Augmented Generation capabilities.
- Authentication: Understand how to manage users and implement authentication in R2R.
- Observability: Learn about analytics and monitoring tools for your R2R system.
Was this page helpful?