Changelog
=========

All notable changes to ragit are documented here.

For the complete changelog with migration guides, see `CHANGELOG.md <https://github.com/rodmena-limited/ragit/blob/main/CHANGELOG.md>`_.

Version 0.11.0 (Current)
------------------------

**Thread Safety & Persistence**

- RAGAssistant is now thread-safe using lock-free atomic operations
- Added ``save_index()`` and ``load_index()`` for index persistence
- Added context manager protocol to OllamaProvider
- Added ``is_indexed`` and ``chunk_count`` properties

**Security**

- API keys no longer stored in session headers (prevents log exposure)

**Dependencies Removed**

- Removed ``scikit-learn`` (unused)
- Removed ``pandas`` (unused)
- Removed ``trio`` (async works with ``asyncio.run()``)

Version 0.10.0
--------------

**Resilience & Error Handling**

- Added retry with exponential backoff via ``resilient-circuit``
- Added circuit breaker pattern for fault tolerance
- Added custom exception hierarchy (``RagitError``, ``ProviderError``, ``IndexingError``)
- Added structured logging with ``log_operation()`` context manager

Version 0.9.0
-------------

**Breaking: Removed SentenceTransformersProvider**

- Use ``OllamaProvider`` with nomic-embed-text instead
- Removed ``sentence-transformers`` dependency

Version 0.8.0
-------------

**Breaking: Explicit Provider Required**

- Must provide ``embed_fn``, ``generate_fn``, or ``provider``
- No more implicit Ollama fallback

Version 0.7.1
-------------

**Performance Optimizations**

- Pre-normalized embedding matrices for O(1) cosine similarity
- Batch embedding API calls instead of individual calls
- Efficient top-k selection using ``numpy.argpartition``
- Immutable ``EmbeddingResponse`` with tuple embeddings

**Code Quality**

- Full mypy --strict compliance
- 94% test coverage with 150 tests
- Thread-safety documentation (now thread-safe as of v0.11.0)

Version 0.7.0
-------------

**New Features**

- High-level ``RAGAssistant`` class for document Q&A
- Document loading utilities (``load_text``, ``load_directory``)
- Multiple chunking strategies (overlap, separator, RST sections)
- Code generation with ``generate_code()``

**API Changes**

- ``EmbeddingResponse.embedding`` is now a tuple (immutable)
- Added ``embed_batch()`` for efficient batch embeddings

Version 0.4.0
-------------

**New Features**

- ``RagitExperiment`` for hyperparameter optimization
- Grid search over chunk sizes, overlaps, and retrieval parameters
- Evaluation metrics: answer correctness, context relevance, faithfulness

**Improvements**

- Better error handling in provider classes
- Progress bars for long-running operations

Version 0.3.0
-------------

**New Features**

- Ollama provider for LLM and embedding operations
- Environment variable configuration
- Support for cloud Ollama providers

Version 0.2.0
-------------

**Initial Release**

- Core experiment framework
- Document and chunk data structures
- Basic vector store implementation
- Evaluation result classes

Versioning
----------

ragit follows `Semantic Versioning <https://semver.org/>`_:

- **MAJOR**: Incompatible API changes
- **MINOR**: New functionality, backwards compatible
- **PATCH**: Bug fixes, backwards compatible

Deprecation Policy
------------------

- Deprecated features are marked in documentation
- Deprecated features remain for at least one minor version
- Removal is announced in changelog

Upgrade Guide
-------------

0.6.x to 0.7.x
^^^^^^^^^^^^^^

**Breaking Changes**

1. ``EmbeddingResponse.embedding`` is now a tuple:

.. code-block:: python

   # Before (0.6.x)
   embedding = response.embedding  # list[float]

   # After (0.7.x)
   embedding = response.embedding  # tuple[float, ...]

   # If you need a list
   embedding_list = list(response.embedding)

2. ``embed_batch()`` is now required for custom providers:

.. code-block:: python

   class MyProvider(BaseEmbeddingProvider):
       def embed_batch(self, texts: list[str], model: str) -> list[EmbeddingResponse]:
           # Required implementation
           pass

**Migration Steps**

1. Update any code that modifies embeddings (they're now immutable)
2. Implement ``embed_batch()`` in custom providers
3. Run tests to verify compatibility