ragit

Getting Started

  • Installation
    • Prerequisites
    • Installing from PyPI
    • Installing from Source
    • Development Installation
    • Verification
    • Next Steps
  • Quickstart Guide
    • Installation
    • Your First RAG Assistant
    • Retrieval
    • Generation (requires LLM)
    • Document Loading
    • Chunk Settings
    • Hyperparameter Optimization

User Guide

  • Core Concepts
    • What is RAG?
      • The RAG Pipeline
      • Why RAG Matters
    • Document Chunking
      • Chunk Size
      • Chunk Overlap
    • Embeddings
      • How Embeddings Work
      • Embedding Models
    • Vector Similarity Search
      • Cosine Similarity
      • Pre-normalized Embeddings
    • Top-K Retrieval
      • Trade-offs
    • Prompt Augmentation
    • RAG Evaluation Metrics
      • Answer Correctness
      • Context Relevance
      • Faithfulness
      • Combined Score
    • Hyperparameter Optimization
      • Indexing Parameters
      • Inference Parameters
    • Thread Safety
  • Configuration
    • Environment Variables
      • Ollama Connection
      • Model Defaults
      • Logging
    • Using a .env File
    • Configuration Examples
      • Local Development
      • Cloud Ollama Provider
      • Split LLM and Embedding Servers
      • Production Deployment
    • Accessing Configuration in Code
    • Overriding Configuration
    • Model Recommendations
      • LLM Models
      • Embedding Models
    • Troubleshooting Configuration
      • Connection Issues
      • Timeout Issues
      • Model Not Found
  • RAG Optimization
    • Why Optimize?
    • Setting Up an Experiment
      • Prepare Documents
      • Create Benchmark Questions
    • Running the Experiment
      • Basic Experiment
      • Custom Search Space
      • Limiting Configurations
    • Understanding Results
      • Examining Results
      • Result Attributes
      • Evaluation Metrics
    • Applying Optimal Settings
    • Saving and Loading Results
    • Advanced Optimization
      • Custom Provider
      • Progress Tracking
    • Optimization Tips
      • Start Broad, Then Narrow
      • Quality vs Speed Trade-offs
      • Representative Benchmark
  • Platform Integration
    • Flask Integration
      • Basic Flask Application
      • Thread-Safe Flask Application
    • FastAPI Integration
      • Basic FastAPI Application
      • Production FastAPI with Dependency Injection
    • Command Line Interface
      • Basic CLI Tool
      • Advanced CLI with Click
    • Jupyter Notebook Integration
    • Docker Deployment

API Reference

  • RAGAssistant API
    • Class Reference
      • RAGAssistant
        • RAGAssistant.__init__()
        • RAGAssistant.add_documents()
        • RAGAssistant.remove_documents()
        • RAGAssistant.update_documents()
        • RAGAssistant.retrieve()
        • RAGAssistant.retrieve_with_context()
        • RAGAssistant.get_context_with_window()
        • RAGAssistant.get_context()
        • RAGAssistant.generate()
        • RAGAssistant.ask()
        • RAGAssistant.generate_code()
        • RAGAssistant.num_chunks
        • RAGAssistant.chunk_count
        • RAGAssistant.is_indexed
        • RAGAssistant.num_documents
        • RAGAssistant.has_llm
        • RAGAssistant.save_index()
        • RAGAssistant.load_index()
    • Quick Reference
      • Constructor
      • Methods
        • ask()
        • retrieve()
        • generate()
        • generate_code()
    • Examples
      • Basic Usage
      • Custom Configuration
      • Multiple Document Sources
      • Recursive Loading
      • Getting Sources with Answers
    • Index Persistence
    • Thread Safety
    • Internal Attributes
  • Experiment API
    • RagitExperiment
      • RagitExperiment
        • RagitExperiment.__init__()
        • RagitExperiment.provider
        • RagitExperiment.define_search_space()
        • RagitExperiment.evaluate_config()
        • RagitExperiment.run()
        • RagitExperiment.get_best_config()
    • Data Classes
      • Document
        • Document
      • BenchmarkQuestion
        • BenchmarkQuestion
      • EvaluationResult
        • EvaluationResult
      • ExperimentResults
        • ExperimentResults
    • Quick Reference
      • Creating an Experiment
      • Running with Default Settings
      • Custom Search Space
      • Evaluating Single Configuration
      • Analyzing Results
      • Exporting Results
    • SimpleVectorStore
      • SimpleVectorStore
        • SimpleVectorStore.__init__()
        • SimpleVectorStore.chunks
        • SimpleVectorStore.add()
        • SimpleVectorStore.clear()
        • SimpleVectorStore.search()
  • Providers API
    • OllamaProvider
      • OllamaProvider
        • OllamaProvider.EMBEDDING_DIMENSIONS
        • OllamaProvider.MAX_EMBED_CHARS
        • OllamaProvider.DEFAULT_TIMEOUTS
        • OllamaProvider.__init__()
        • OllamaProvider.session
        • OllamaProvider.close()
        • OllamaProvider.provider_name
        • OllamaProvider.dimensions
        • OllamaProvider.is_available()
        • OllamaProvider.list_models()
        • OllamaProvider.generate()
        • OllamaProvider.embed()
        • OllamaProvider.embed_batch()
        • OllamaProvider.embed_batch_async()
        • OllamaProvider.chat()
        • OllamaProvider.generate_circuit_status
        • OllamaProvider.embed_circuit_status
        • OllamaProvider.clear_embedding_cache()
        • OllamaProvider.embedding_cache_info()
      • Quick Reference
      • Checking Availability
      • Text Generation
      • Creating Embeddings
      • Resource Management
      • Performance Features
    • Base Classes
      • BaseLLMProvider
        • BaseLLMProvider
      • BaseEmbeddingProvider
        • BaseEmbeddingProvider
    • Response Classes
      • LLMResponse
        • LLMResponse
      • EmbeddingResponse
        • EmbeddingResponse
    • Creating Custom Providers
      • Using Custom Providers
    • Embedding Model Dimensions
  • Loaders API
    • Document Loading
      • load_text()
        • load_text()
      • load_directory()
        • load_directory()
    • Text Chunking
      • chunk_text()
        • chunk_text()
      • chunk_document()
        • chunk_document()
      • chunk_by_separator()
        • chunk_by_separator()
      • chunk_rst_sections()
        • chunk_rst_sections()
    • Data Classes
      • Chunk
        • Chunk
      • Document
        • Document
    • Complete Examples
      • Loading and Chunking a Project
      • Processing Different File Types
      • Building a Document Index

Community

  • Contributing
    • Development Setup
    • Code Quality Standards
      • Linting
      • Formatting
      • Type Checking
      • Testing
    • Code Style Guidelines
    • File Headers
    • Testing Guidelines
      • Test Structure
      • Writing Tests
      • Using Fixtures
    • Adding New Features
    • Adding New Providers
    • Pull Request Process
    • Issue Tracking
    • Getting Help
    • License
  • Changelog
    • Version 0.11.0 (Current)
    • Version 0.10.0
    • Version 0.9.0
    • Version 0.8.0
    • Version 0.7.1
    • Version 0.7.0
    • Version 0.4.0
    • Version 0.3.0
    • Version 0.2.0
    • Versioning
    • Deprecation Policy
    • Upgrade Guide
      • 0.6.x to 0.7.x
ragit
  • Search

© Copyright 2025, RODMENA LIMITED.

Built with Sphinx using a theme provided by Read the Docs.