rag
===

.. automodule:: ffai.rag
   :members:
   :undoc-members:
   :show-inheritance:

Classes
-------

.. autoclass:: ffai.rag.BM25Index
   :members:
   :undoc-members:
   :show-inheritance:
   :inherited-members:

.. autoclass:: ffai.rag.CharacterChunker
   :members:
   :undoc-members:
   :show-inheritance:
   :inherited-members:

.. autoclass:: ffai.rag.ChunkDeduplicator
   :members:
   :undoc-members:
   :show-inheritance:
   :inherited-members:

.. autoclass:: ffai.rag.ChunkerBase
   :members:
   :undoc-members:
   :show-inheritance:
   :inherited-members:

.. autoclass:: ffai.rag.ClientAdapter
   :members:
   :undoc-members:
   :show-inheritance:
   :inherited-members:

.. autoclass:: ffai.rag.CodeChunker
   :members:
   :undoc-members:
   :show-inheritance:
   :inherited-members:

.. autoclass:: ffai.rag.ContextualEmbeddings
   :members:
   :undoc-members:
   :show-inheritance:
   :inherited-members:

.. autoclass:: ffai.rag.CrossEncoderReranker
   :members:
   :undoc-members:
   :show-inheritance:
   :inherited-members:

.. autoclass:: ffai.rag.DiversityReranker
   :members:
   :undoc-members:
   :show-inheritance:
   :inherited-members:

.. autoclass:: ffai.rag.GenerationResult
   :members:
   :undoc-members:
   :show-inheritance:
   :inherited-members:

.. autoclass:: ffai.rag.HierarchicalChunker
   :members:
   :undoc-members:
   :show-inheritance:
   :inherited-members:

.. autoclass:: ffai.rag.HierarchicalIndex
   :members:
   :undoc-members:
   :show-inheritance:
   :inherited-members:

.. autoclass:: ffai.rag.HierarchicalTextChunk
   :members:
   :undoc-members:
   :show-inheritance:
   :inherited-members:

.. autoclass:: ffai.rag.HybridSearch
   :members:
   :undoc-members:
   :show-inheritance:
   :inherited-members:

.. autoclass:: ffai.rag.MarkdownChunker
   :members:
   :undoc-members:
   :show-inheritance:
   :inherited-members:

.. autoclass:: ffai.rag.NoopReranker
   :members:
   :undoc-members:
   :show-inheritance:
   :inherited-members:

.. autoclass:: ffai.rag.QueryExpander
   :members:
   :undoc-members:
   :show-inheritance:
   :inherited-members:

.. autoclass:: ffai.rag.QueryResult
   :members:
   :undoc-members:
   :show-inheritance:
   :inherited-members:

.. autoclass:: ffai.rag.RAG
   :members:
   :undoc-members:
   :show-inheritance:
   :inherited-members:

.. autoclass:: ffai.rag.RecursiveChunker
   :members:
   :undoc-members:
   :show-inheritance:
   :inherited-members:

.. autoclass:: ffai.rag.RerankerBase
   :members:
   :undoc-members:
   :show-inheritance:
   :inherited-members:

.. autoclass:: ffai.rag.SearchHit
   :members:
   :undoc-members:
   :show-inheritance:
   :inherited-members:

.. autoclass:: ffai.rag.TextChunk
   :members:
   :undoc-members:
   :show-inheritance:
   :inherited-members:

.. autoclass:: ffai.rag.VectorStore
   :members:
   :undoc-members:
   :show-inheritance:
   :inherited-members:

.. autoclass:: ffai.rag.VectorStoreBase
   :members:
   :undoc-members:
   :show-inheritance:
   :inherited-members:

Functions
---------

.. autofunction:: ffai.rag.chunk_text

.. autofunction:: ffai.rag.format_hits

.. autofunction:: ffai.rag.fuse_search_results

.. autofunction:: ffai.rag.get_chunker

.. autofunction:: ffai.rag.get_reranker

.. autofunction:: ffai.rag.get_store

.. autofunction:: ffai.rag.is_store_available

.. autofunction:: ffai.rag.list_available_stores

.. autofunction:: ffai.rag.list_chunkers

.. autofunction:: ffai.rag.list_stores

.. autofunction:: ffai.rag.litellm_generate_fn

.. autofunction:: ffai.rag.reciprocal_rank_fusion