Embedding

Embedding System

R2R uses embeddings as the foundation for semantic search and similarity matching capabilities. The embedding system is responsible for converting text into high-dimensional vectors that capture semantic meaning, enabling powerful search and retrieval operations.

Embedding Configuration

The embedding system can be customized through the embedding section in your r2r.toml file, along with corresponding environment variables for sensitive information:

1
[embedding]
2
provider = "litellm" # defaults to "litellm"
3
base_model = "openai/text-embedding-3-small" # defaults to "openai/text-embedding-3-large"
4
base_dimension = 512 # defaults to 3072
5
batch_size = 512 # defaults to 128
6
rerank_model = "BAAI/bge-reranker-v2-m3" # defaults to None
7
concurrent_request_limit = 256 # defaults to 256

Relevant environment variables to the above configuration would be OPENAI_API_KEY, OPENAI_API_BASE, HUGGINGFACE_API_KEY, and HUGGINGFACE_API_BASE.

Advanced Embedding Features in R2R

R2R leverages several advanced embedding features to provide robust text processing and retrieval capabilities:

Concurrent Request Management

The system implements sophisticated request handling with rate limiting and concurrency control:

1. Rate Limiting: Prevents API throttling through intelligent request scheduling
2. Concurrent Processing: Manages multiple embedding requests efficiently
3. Error Handling: Implements retry logic with exponential backoff

Performance Considerations

When configuring embeddings in R2R, consider these optimization strategies:

1. Batch Size Optimization:

   • Larger batch sizes improve throughput but increase latency
   • Consider provider-specific rate limits when setting batch size
   • Balance memory usage with processing speed

2. Concurrent Requests:

   • Adjust concurrent_request_limit based on provider capabilities
   • Monitor API usage and adjust limits accordingly
   • Consider implementing local caching for frequently embedded texts

3. Model Selection:

   • Balance embedding dimension size with accuracy requirements
   • Consider cost per token for different providers
   • Evaluate multilingual requirements when choosing models

4. Resource Management:

   • Monitor memory usage with large batch sizes
   • Implement appropriate error handling and retry strategies
   • Consider implementing local model fallbacks for critical systems

Supported LiteLLM Providers

1
provider = "litellm"
2
base_model = "openai/text-embedding-3-small"
3
base_dimension = 512

1
export OPENAI_API_KEY=your_openai_key
2
# .. set other environment variables
3
4
export R2R_CONFIG_PATH=path_to_your_config
5
python -m r2r.serve