rag-core-api 3.2.0__tar.gz

rag_core_api-3.2.0/PKG-INFO

@@ -0,0 +1,31 @@
+Metadata-Version: 2.3
+Name: rag-core-api
+Version: 3.2.0
+Summary: The core of the rag-template.
+Author: STACKIT Data and AI Consulting
+Author-email: data-ai-consulting@stackit.cloud
+Requires-Python: >=3.13,<4.0
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: datasets (>=3.5.1,<4.0.0)
+Requires-Dist: dependency-injector (>=4.46.0,<5.0.0)
+Requires-Dist: deprecated (>=1.2.18,<2.0.0)
+Requires-Dist: fastapi (>=0.118.0,<0.119.0)
+Requires-Dist: fastembed (>=0.7.0,<0.8.0)
+Requires-Dist: flashrank (>=0.2.10,<0.3.0)
+Requires-Dist: langchain-community (==0.3.30)
+Requires-Dist: langchain-ollama (>=0.3.2,<0.4.0)
+Requires-Dist: langchain-qdrant (>=0.2.0,<0.3.0)
+Requires-Dist: langchain-text-splitters (>=0.3.9)
+Requires-Dist: langdetect (>=1.0.9,<2.0.0)
+Requires-Dist: langfuse (==3.6.1)
+Requires-Dist: langgraph (>=0.6.0,<0.7.0)
+Requires-Dist: openai (>=1.77.0,<2.0.0)
+Requires-Dist: pillow (>=11.2.1,<12.0.0)
+Requires-Dist: pytest-asyncio (>=0.26.0,<0.27.0)
+Requires-Dist: pyyaml (>=6.0.2,<7.0.0)
+Requires-Dist: qdrant-client (>=1.14.2,<2.0.0)
+Requires-Dist: rag-core-lib (>=3.2.0,<4.0.0)
+Requires-Dist: ragas (>=0.3.0,<0.4.0)
+Requires-Dist: requests-oauthlib (>=2.0.0,<3.0.0)
+Requires-Dist: uvicorn (>=0.37.0,<0.38.0)

rag_core_api-3.2.0/pyproject.toml

@@ -0,0 +1,126 @@
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.poetry]
+name = "rag-core-api"
+version = "v3.2.0"
+description = "The core of the rag-template."
+authors = ["STACKIT Data and AI Consulting <data-ai-consulting@stackit.cloud>"]
+packages = [{ include = "rag_core_api", from = "src" }]
+
+[tool.poetry.dependencies]
+python = "^3.13"
+rag-core-lib = "^3.2.0"
+uvicorn = "^0.37.0"
+langchain-qdrant = "^0.2.0"
+dependency-injector = "^4.46.0"
+fastapi = "^0.118.0"
+requests-oauthlib = "^2.0.0"
+qdrant-client = "^1.14.2"
+deprecated = "^1.2.18"
+datasets = "^3.5.1"
+ragas = "^0.3.0"
+flashrank = "^0.2.10"
+pyyaml = "^6.0.2"
+openai = "^1.77.0"
+langgraph = "^0.6.0"
+pillow = "^11.2.1"
+langchain-ollama = "^0.3.2"
+pytest-asyncio = "^0.26.0"
+langchain-community = "0.3.30"
+fastembed = "^0.7.0"
+langdetect = "^1.0.9"
+langfuse = "3.6.1"
+langchain-text-splitters = ">=0.3.9"
+
+[tool.poetry.group.dev.dependencies]
+debugpy = "^1.8.14"
+pytest = "^8.3.5"
+coverage = "^7.8.0"
+flake8 = "^7.2.0"
+flake8-black = "^0.4.0"
+flake8-pyproject = "^1.2.3"
+flake8-quotes = "^3.4.0"
+flake8-return = "^1.2.0"
+flake8-annotations-complexity = "^0.1.0"
+flake8-bandit = "^4.1.1"
+flake8-bugbear = "^24.12.12"
+flake8-builtins = "^2.5.0"
+flake8-comprehensions = "^3.15.0"
+flake8-eradicate = "^1.5.0"
+flake8-expression-complexity = "^0.0.11"
+flake8-pytest-style = "^2.1.0"
+pep8-naming = "^0.15.1"
+flake8-eol = "^0.0.8"
+flake8-exceptions = "^0.0.1a0"
+flake8-simplify = "^0.22.0"
+flake8-wot = "^0.2.0"
+flake8-function-order = "^0.0.5"
+flake8-tidy-imports = "^4.10.0"
+black = "^25.1.0"
+# flake8-logging-format = "^2024.24.12"
+# flake8-docstrings = "^1.7.0"
+
+
+[tool.flake8]
+exclude= [".eggs", "src/rag_core_api/models", ".git", ".hg", ".mypy_cache", ".tox", ".venv", ".devcontainer", "venv", "_build", "buck-out", "build", "dist", "**/__init__.py"]
+statistics = true
+show-source = false
+max-complexity = 8
+max-annotations-complexity = 3
+docstring-convention = 'numpy'
+max-line-length = 120
+ignore = ["E203", "W503", "E704"]
+inline-quotes = '"'
+docstring-quotes = '"""'
+multiline-quotes = '"""'
+dictionaries = ["en_US", "python", "technical", "pandas"]
+ban-relative-imports = true
+per-file-ignores = """
+  ./src/rag_core_api/prompt_templates/*: E501,D100,
+  ./src/rag_core_api/apis/rag_api.py: B008,WOT001,
+  ./src/rag_core_api/impl/rag_api.py: B008,
+  ./src/rag_core_api/prompt_templates/*: E501,
+  ./src/rag_core_api/dependency_container.py: CCE002,CCE001,
+  ./src/rag_core_api/apis/rag_api_base.py: WOT001,
+  ./tests/rag_api_test.py: E402,S101,S105,I252,D409,
+  ./tests/*: S101,S105,I252,D409,
+"""
+
+[tool.black]
+line-length = 120
+exclude = """
+/(
+     .eggs
+    | .git
+    | .hg
+    | .mypy_cache
+    | .nox
+    | .pants.d
+    | .tox
+    | .venv
+    | _build
+    | buck-out
+    | build
+    | dist
+    | node_modules
+    | venv
+)/
+"""
+
+[tool.isort]
+profile = "black"
+skip = ['.eggs', '.git', '.hg', '.mypy_cache', '.nox', '.pants.d', '.tox', '.venv', '_build', 'buck-out', 'build', 'dist', 'node_modules', 'venv']
+skip_gitignore = true
+known_local_folder = ["rag_core_api", "rag_core_lib"]
+
+[tool.pylint]
+max-line-length = 120
+
+[tool.pytest.ini_options]
+log_cli = true
+log_cli_level = "DEBUG"
+pythonpath = ["src", "tests"]
+testpaths = ["tests"]
+

rag_core_api-3.2.0/src/rag_core_api/api_endpoints/chat.py

@@ -0,0 +1,28 @@
+"""Module for base class of chat endpoint."""
+
+from abc import ABC, abstractmethod
+
+from rag_core_api.models.chat_request import ChatRequest
+from rag_core_api.models.chat_response import ChatResponse
+
+
+class Chat(ABC):
+    """Base class for chat endpoint."""
+
+    @abstractmethod
+    async def achat(self, session_id: str, chat_request: ChatRequest) -> ChatResponse:
+        """
+        Abstract method to handle asynchronous chat requests.
+
+        Parameters
+        ----------
+        session_id : str
+            The unique identifier for the chat session.
+        chat_request : ChatRequest
+            The request object containing the chat details.
+
+        Returns
+        -------
+        ChatResponse
+            The response object containing the chat results.
+        """

rag_core_api-3.2.0/src/rag_core_api/api_endpoints/information_piece_remover.py

@@ -0,0 +1,27 @@
+"""Module for the InformationPieceRemover abstract base class."""
+
+from abc import ABC, abstractmethod
+
+from rag_core_api.models.delete_request import DeleteRequest
+
+
+class InformationPieceRemover(ABC):
+    """Abstract base class for removing information pieces.
+
+    This class defines the interface for removing information pieces based on a given delete request.
+    """
+
+    @abstractmethod
+    def remove_information_piece(self, delete_request: DeleteRequest) -> None:
+        """
+        Remove information pieces based on the given delete request.
+
+        Parameters
+        ----------
+        delete_request : DeleteRequest
+            The request object containing the details of the information pieces to be deleted.
+
+        Returns
+        -------
+        None
+        """

rag_core_api-3.2.0/src/rag_core_api/api_endpoints/information_piece_uploader.py

@@ -0,0 +1,27 @@
+"""Module for the InformationPiecesUploader abstract base class."""
+
+from abc import ABC, abstractmethod
+
+from rag_core_api.models.information_piece import InformationPiece
+
+
+class InformationPiecesUploader(ABC):
+    """Abstract base class for uploading information pieces.
+
+    This class defines the interface for uploading a list of information pieces.
+    """
+
+    @abstractmethod
+    def upload_information_piece(self, information_piece: list[InformationPiece]) -> None:
+        """
+        Abstract method to upload a list of information pieces.
+
+        Parameters
+        ----------
+        information_piece : list[InformationPiece]
+            A list of InformationPiece objects to be uploaded.
+
+        Returns
+        -------
+        None
+        """

rag_core_api-3.2.0/src/rag_core_api/apis/rag_api.py

@@ -0,0 +1,195 @@
+"""Module containing the RAG API endpoints."""
+
+# coding: utf-8
+# flake8: noqa: D105
+
+import importlib
+import logging
+import pkgutil
+from asyncio import FIRST_COMPLETED, CancelledError, create_task, sleep, wait
+from contextlib import suppress
+from typing import Any, Awaitable, List  # noqa: F401
+
+from fastapi import (  # noqa: F401
+    APIRouter,
+    BackgroundTasks,
+    Body,
+    Cookie,
+    Depends,
+    Form,
+    Header,
+    HTTPException,
+    Path,
+    Query,
+    Request,
+    Response,
+    Security,
+    status,
+)
+
+import rag_core_api.impl
+from rag_core_api.apis.rag_api_base import BaseRagApi
+from rag_core_api.models.chat_request import ChatRequest
+from rag_core_api.models.chat_response import ChatResponse
+from rag_core_api.models.delete_request import DeleteRequest
+from rag_core_api.models.information_piece import InformationPiece
+
+logger = logging.getLogger(__name__)
+
+router = APIRouter()
+
+ns_pkg = rag_core_api.impl
+for _, name, _ in pkgutil.iter_modules(ns_pkg.__path__, ns_pkg.__name__ + "."):
+    importlib.import_module(name)
+
+
+async def _disconnected(request: Request) -> None:
+    while True:
+        try:
+            if await request.is_disconnected():
+                break
+            await sleep(1.0)
+        except CancelledError:
+            break
+
+
+@router.post(
+    "/chat/{session_id}",
+    responses={
+        200: {"model": ChatResponse, "description": "OK."},
+        500: {"description": "Internal Server Error!"},
+    },
+    tags=["rag"],
+    response_model_by_alias=True,
+)
+async def chat(
+    request: Request,
+    session_id: str = Path(..., description=""),
+    chat_request: ChatRequest = Body(None, description="Chat with RAG."),
+) -> ChatResponse | None:
+    """
+    Asynchronously handles the chat endpoint for the RAG API.
+
+    Parameters
+    ----------
+    request : Request
+        The request object.
+    session_id : str
+        The session ID for the chat.
+    chat_request : ChatRequest, optional
+        The chat request payload
+
+    Returns
+    -------
+    ChatResponse or None
+        The chat response if the chat task completes successfully, otherwise None.
+
+    Raises
+    ------
+    CancelledError
+        If the task is cancelled.
+
+    Notes
+    -----
+    This function creates two asynchronous tasks: one for handling disconnection and one for processing the chat
+    request. It waits for either task to complete first and cancels the remaining tasks.
+    """
+    disconnect_task = create_task(_disconnected(request))
+    chat_task = create_task(BaseRagApi.subclasses[0]().chat(session_id, chat_request))
+    done, pending = await wait(
+        [disconnect_task, chat_task],
+        return_when=FIRST_COMPLETED,
+    )
+
+    # cancel all remaining tasks
+    for task in pending:
+        task.cancel()
+        with suppress(CancelledError):
+            await task
+    if chat_task in done:
+        return chat_task.result()
+    logger.info("Request got cancelled!")
+    return None
+
+
+@router.post(
+    "/evaluate",
+    responses={
+        201: {"description": "Accepted."},
+        500: {"description": "Internal Server Error."},
+    },
+    tags=["rag"],
+    response_model_by_alias=True,
+)
+async def evaluate() -> None:
+    """
+    Asynchronously evaluate the RAG.
+
+    Returns
+    -------
+    None
+    """
+    return await BaseRagApi.subclasses[0]().evaluate()
+
+
+@router.post(
+    "/information_pieces/remove",
+    responses={
+        202: {"description": "Accepted."},
+        404: {"description": "Ressource not Found"},
+        422: {"description": "ID or metadata missing."},
+        500: {"description": "Internal Server Error."},
+    },
+    tags=["rag"],
+    summary="remove information piece",
+    response_model_by_alias=True,
+)
+async def remove_information_piece(
+    delete_request: DeleteRequest = Body(None, description=""),
+) -> None:
+    """
+    Asynchronously removes information pieces.
+
+    This endpoint removes information pieces based on the provided delete request.
+
+    Parameters
+    ----------
+    delete_request : DeleteRequest
+        The request body containing the details for the information piece to be removed.
+
+    Returns
+    -------
+    None
+    """
+    return await BaseRagApi.subclasses[0]().remove_information_piece(delete_request)
+
+
+@router.post(
+    "/information_pieces/upload",
+    responses={
+        201: {"description": "The file was successful uploaded."},
+        422: {"model": str, "description": "Wrong json format."},
+        500: {"model": str, "description": "Internal Server Error."},
+    },
+    tags=["rag"],
+    summary="Upload information pieces for vectordatabase",
+    response_model_by_alias=True,
+)
+async def upload_information_piece(
+    information_piece: List[InformationPiece] = Body(None, description=""),
+) -> None:
+    """
+    Asynchronously uploads information pieces for vectordatabase.
+
+    This endpoint allows for the upload of information pieces to the vector database.
+
+    Parameters
+    ----------
+    information_piece : List[InformationPiece]
+        A list of information pieces to be uploaded (default None).
+
+    Returns
+    -------
+    None
+    """
+    return await BaseRagApi.subclasses[0]().upload_information_piece(information_piece)

rag_core_api-3.2.0/src/rag_core_api/apis/rag_api_base.py

@@ -0,0 +1,102 @@
+"""Module containing the base RAG API class."""
+
+# coding: utf-8
+# flake8: noqa: D105
+
+from typing import ClassVar, Dict, List, Tuple  # noqa: F401
+
+from rag_core_api.models.chat_request import ChatRequest
+from rag_core_api.models.chat_response import ChatResponse
+from rag_core_api.models.delete_request import DeleteRequest
+from rag_core_api.models.information_piece import InformationPiece
+
+
+class BaseRagApi:
+    """Base class for RAG API.
+
+    This class serves as the base for the RAG API implementations. It provides
+    asynchronous methods for handling chat, evaluating the RAG, removing information
+    pieces, and uploading information pieces to a vector database.
+
+    Attributes
+    subclasses : ClassVar[Tuple]
+        A tuple that holds all subclasses of BaseRagApi.
+    """
+
+    subclasses: ClassVar[Tuple] = ()
+
+    def __init_subclass__(cls, **kwargs):
+        super().__init_subclass__(**kwargs)
+        BaseRagApi.subclasses = BaseRagApi.subclasses + (cls,)
+
+    async def chat(
+        self,
+        session_id: str,
+        chat_request: ChatRequest,
+    ) -> ChatResponse:
+        """
+        Asynchronously handles the chat endpoint for the RAG API.
+
+        Parameters
+        ----------
+        request : Request
+            The request object.
+        session_id : str
+            The session ID for the chat.
+        chat_request : ChatRequest, optional
+            The chat request payload
+
+        Returns
+        -------
+        ChatResponse or None
+            The chat response if the chat task completes successfully, otherwise None.
+        """
+
+    async def evaluate(
+        self,
+    ) -> None:
+        """
+        Asynchronously evaluate the RAG.
+
+        Returns
+        -------
+        None
+        """
+
+    async def remove_information_piece(
+        self,
+        delete_request: DeleteRequest,
+    ) -> None:
+        """
+        Asynchronously removes information pieces.
+
+        This endpoint removes information pieces based on the provided delete request.
+
+        Parameters
+        ----------
+        delete_request : DeleteRequest
+            The request body containing the details for the information piece to be removed.
+
+        Returns
+        -------
+        None
+        """
+
+    async def upload_information_piece(
+        self,
+        information_piece: List[InformationPiece],
+    ) -> None:
+        """
+        Asynchronously uploads information pieces for vectordatabase.
+
+        This endpoint allows for the upload of information pieces to the vector database.
+
+        Parameters
+        ----------
+        information_piece : List[InformationPiece]
+            A list of information pieces to be uploaded (default None).
+
+        Returns
+        -------
+        None
+        """