ragit 0.3__py3-none-any.whl → 0.10.1__py3-none-any.whl

ragit/__init__.py

@@ -1,2 +1,128 @@
-# __init__.py
-from .main import VectorDBManager
+#
+# Copyright RODMENA LIMITED 2025
+# SPDX-License-Identifier: Apache-2.0
+#
+"""
+Ragit - RAG toolkit for document Q&A and hyperparameter optimization.
+
+Quick Start
+-----------
+>>> from ragit import RAGAssistant
+>>>
+>>> # With custom embedding function (retrieval-only)
+>>> def my_embed(text: str) -> list[float]:
+...     # Your embedding implementation
+...     pass
+>>> assistant = RAGAssistant("docs/", embed_fn=my_embed)
+>>> results = assistant.retrieve("How do I create a REST API?")
+>>>
+>>> # With Ollama
+>>> from ragit.providers import OllamaProvider
+>>> assistant = RAGAssistant("docs/", provider=OllamaProvider())
+>>> answer = assistant.ask("How do I create a REST API?")
+
+Optimization
+------------
+>>> from ragit import RagitExperiment, Document, BenchmarkQuestion
+>>>
+>>> docs = [Document(id="doc1", content="...")]
+>>> benchmark = [BenchmarkQuestion(question="What is X?", ground_truth="...")]
+>>>
+>>> # With explicit provider
+>>> experiment = RagitExperiment(docs, benchmark, provider=OllamaProvider())
+>>> results = experiment.run()
+>>> print(results[0])  # Best configuration
+"""
+
+import logging
+import os
+
+from ragit.version import __version__
+
+# Set up logging
+logger = logging.getLogger("ragit")
+logger.setLevel(os.getenv("RAGIT_LOG_LEVEL", "INFO"))
+
+if not logger.handlers:
+    formatter = logging.Formatter("%(asctime)s - %(name)s - %(levelname)s - %(message)s")
+    handler = logging.StreamHandler()
+    handler.setFormatter(formatter)
+    logger.addHandler(handler)
+
+# Public API (imports after logging setup)
+from ragit.assistant import RAGAssistant  # noqa: E402
+from ragit.core.experiment.experiment import (  # noqa: E402
+    BenchmarkQuestion,
+    Chunk,
+    Document,
+    RAGConfig,
+    RagitExperiment,
+)
+from ragit.core.experiment.results import EvaluationResult, ExperimentResults  # noqa: E402
+from ragit.exceptions import (  # noqa: E402
+    ConfigurationError,
+    EvaluationError,
+    ExceptionAggregator,
+    GenerationError,
+    IndexingError,
+    ProviderError,
+    RagitError,
+    RetrievalError,
+)
+from ragit.loaders import (  # noqa: E402
+    chunk_by_separator,
+    chunk_document,
+    chunk_rst_sections,
+    chunk_text,
+    deduplicate_documents,
+    generate_document_id,
+    load_directory,
+    load_text,
+)
+from ragit.monitor import ExecutionMonitor  # noqa: E402
+from ragit.providers import (  # noqa: E402
+    BaseEmbeddingProvider,
+    BaseLLMProvider,
+    FunctionProvider,
+    OllamaProvider,
+)
+
+__all__ = [
+    "__version__",
+    # High-level API
+    "RAGAssistant",
+    # Document loading
+    "load_text",
+    "load_directory",
+    "chunk_text",
+    "chunk_document",
+    "chunk_by_separator",
+    "chunk_rst_sections",
+    "generate_document_id",
+    "deduplicate_documents",
+    # Core classes
+    "Document",
+    "Chunk",
+    # Providers
+    "OllamaProvider",
+    "FunctionProvider",
+    "BaseLLMProvider",
+    "BaseEmbeddingProvider",
+    # Exceptions
+    "RagitError",
+    "ConfigurationError",
+    "ProviderError",
+    "IndexingError",
+    "RetrievalError",
+    "GenerationError",
+    "EvaluationError",
+    "ExceptionAggregator",
+    # Monitoring
+    "ExecutionMonitor",
+    # Optimization
+    "RagitExperiment",
+    "BenchmarkQuestion",
+    "RAGConfig",
+    "EvaluationResult",
+    "ExperimentResults",
+]