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

1. Import the R2R client:

1
from r2r import R2RClient

2. Initialize the client:

1
client = R2RClient("http://localhost:7272")

3. Check if R2R is running correctly:

1
health_response = client.health()
2
# {"status":"ok"}

4. Login (Optional):

1
client.register("[email protected]", "my_password")
2
# client.verify_email("[email protected]", "my_verification_code")
3
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.