Release PB

.github/workflows/test.yml

@@ -0,0 +1,36 @@
+name: Run Python Tests
+
+on:
+  pull_request:
+    types:
+      - opened
+    branches:
+      - PB
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    if: ${{ !startsWith(github.event.pull_request.title, 'Docs:') }}
+    defaults:
+      run:
+        working-directory: '3 - PB/MVP'
+
+    strategy:
+      matrix:
+        python-version: [3.12]
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r src/backend/requirements.txt
+
+      - name: Run tests
+        run: |
+          python -m pytest -v tests

.vscode/settings.json

@@ -0,0 +1,14 @@
+{
+    "python.testing.unittestArgs": [
+        "-v",
+        "-s",
+        "./3 - PB",
+        "-p",
+        "*_test.py"
+    ],
+    "python.testing.pytestEnabled": false,
+    "python.testing.unittestEnabled": true,
+    "python.testing.pytestArgs": [
+        "3 - PB"
+    ]
+}

3 - PB/MVP/.gitignore

@@ -0,0 +1,9 @@
+.DS_Store
+.vscode
+.idea
+__pycache__
+.pytest_cache
+secrets
+__init__.py
+*.pyc
+chroma_db

3 - PB/MVP/src/backend/adapter/_in/web/ask_chatbot_controller.py

@@ -0,0 +1,35 @@
+from application.port._in.ask_chatbot_use_case import AskChatbotUseCase
+from domain.chat.message_response import MessageResponse
+
+from domain.chat.message import Message, MessageSender
+from domain.chat.chat_id import ChatId
+from datetime import datetime, timezone
+
+"""
+This class is the controller for the use case AskChatbotUseCase. It receives the user's message and the chatId and returns a MessageResponse.
+Attributes:
+    useCase (AskChatbotUseCase): The use case for asking the chatbot.
+"""
+class AskChatbotController:
+    def __init__(self, askChatbotUseCase: AskChatbotUseCase):
+        self.askChatbotUseCase = askChatbotUseCase
+
+    def askChatbot(self, message: str, chatId: int = None) -> MessageResponse:
+        """
+        Receives the user's message and the chatId and returns a MessageResponse.
+        Args:
+            message (str): The user's message.
+            chatId (int): The chat's id.
+        Returns:
+            MessageResponse: the response of the operation.
+        """
+        userMessage = Message(
+            message,
+            datetime.now(timezone.utc),
+            None,
+            MessageSender.USER
+        )
+
+        chatId = ChatId(chatId) if chatId is not None else None
+
+        return self.askChatbotUseCase.askChatbot(userMessage, chatId)

3 - PB/MVP/src/backend/adapter/_in/web/change_configuration_controller.py

@@ -0,0 +1,28 @@
+from typing import List
+from application.port._in.change_configuration_use_case import ChangeConfigurationUseCase
+from domain.configuration.configuration_operation_response import ConfigurationOperationResponse
+from domain.configuration.llm_model_configuration import LLMModelType
+
+"""
+This class is the controller for the use case ChangeConfigurationUseCase. It receives the new LLM model and returns a ConfigurationOperationResponse.
+Attributes:
+    useCase (ChangeConfigurationUseCase): The use case for changing the configuration.
+"""
+
+class ChangeConfigurationController:
+    def __init__(self, changeConfigurationUseCase: ChangeConfigurationUseCase): 
+        self.useCase = changeConfigurationUseCase 
+
+    def changeLLMModel(self, LLModel: str) -> ConfigurationOperationResponse:  
+        """
+        Receives the new LLM model and returns a ConfigurationOperationResponse.
+        Args:
+            LLModel (str): The new LLM model.
+        Returns:
+            ConfigurationOperationResponse: the response of the operation.
+        """     
+        try:
+            LLMModelChoice = LLMModelType[LLModel.upper()]      
+            return self.useCase.changeLLMModel(LLMModelChoice)
+        except KeyError:
+            return None

3 - PB/MVP/src/backend/adapter/_in/web/conceal_documents_controller.py

@@ -0,0 +1,23 @@
+from typing import List
+from application.port._in.conceal_documents_use_case import ConcealDocumentsUseCase
+from domain.document.document_operation_response import DocumentOperationResponse
+from domain.document.document_id import DocumentId
+
+"""
+This class is the controller for the use case ConcealDocumentsUseCase. It receives the documents' ids and returns a list of DocumentOperationResponse.
+Attributes:
+    useCase (ConcealDocumentsUseCase): The use case for concealing documents.
+"""
+class ConcealDocumentsController:
+    def __init__(self, concealDocumentsUseCase: ConcealDocumentsUseCase):
+        self.useCase = concealDocumentsUseCase 
+
+    def concealDocuments(self, documentsIds: List[str]) -> List[DocumentOperationResponse]:   
+        """
+        Receives the documents' ids and returns a list of DocumentOperationResponse.
+        Args:
+            documentsIds (List[str]): The documents' ids.
+        Returns:
+            List[DocumentOperationResponse]: the response of the operation.
+        """     
+        return self.useCase.concealDocuments([DocumentId(documentId) for documentId in documentsIds])

3 - PB/MVP/src/backend/adapter/_in/web/delete_chats_controller.py

@@ -0,0 +1,23 @@
+from application.port._in.delete_chats_use_case import DeleteChatsUseCase
+from domain.chat.chat_operation_response import ChatOperationResponse
+from typing import List
+from domain.chat.chat_id import ChatId
+
+"""
+This class is the controller for the use case DeleteChatsUseCase. It receives the chats' ids and returns a list of ChatOperationResponse.
+Attributes:
+    useCase (DeleteChatsUseCase): The use case for deleting chats.
+"""
+class DeleteChatsController:
+    def __init__(self, deleteChatUseCase: DeleteChatsUseCase):
+        self.useCase = deleteChatUseCase
+
+    def deleteChats(self, chatsIdsList: List[int]) -> List[ChatOperationResponse]:
+        """
+        Receives the chats' ids and returns a list of ChatOperationResponse.
+        Args:
+            chatsIdsList (List[int]): The chats' ids.
+        Returns:
+            List[ChatOperationResponse]: the response of the operation.
+        """
+        return self.useCase.deleteChats([ChatId(chatId) for chatId in chatsIdsList])

3 - PB/MVP/src/backend/adapter/_in/web/delete_documents_controller.py

@@ -0,0 +1,30 @@
+from typing import List
+from application.port._in.delete_documents_use_case import DeleteDocumentsUseCase
+from domain.document.document_operation_response import DocumentOperationResponse
+from domain.document.document_id import DocumentId
+
+from domain.exception.exception import ElaborationException
+from api_exceptions import APIElaborationException
+
+"""
+This class is the controller for the use case DeleteDocumentsUseCase. It receives the documents' ids and returns a list of DocumentOperationResponse.
+Attributes:
+    useCase (DeleteDocumentsUseCase): The use case for deleting documents.
+"""
+class DeleteDocumentsController:
+    def __init__(self, deleteDocumentsUseCase: DeleteDocumentsUseCase): 
+        self.useCase = deleteDocumentsUseCase 
+
+
+    def deleteDocuments(self, documentsIds: List[str]) -> List[DocumentOperationResponse]:
+        """
+        Receives the documents' ids and returns a list of DocumentOperationResponse.
+        Args:
+            documentsIds (List[str]): The documents' ids.
+        Returns:
+            List[DocumentOperationResponse]: the response of the operation.
+        """ 
+        try:
+            return self.useCase.deleteDocuments([DocumentId(documentId) for documentId in documentsIds])
+        except ElaborationException as e:
+            raise APIElaborationException(str(e))

3 - PB/MVP/src/backend/adapter/_in/web/embed_documents_controller.py

@@ -0,0 +1,30 @@
+from typing import List
+
+from application.port._in.embed_documents_use_case import EmbedDocumentsUseCase
+from domain.document.document_operation_response import DocumentOperationResponse
+from domain.document.document_id import DocumentId
+
+from domain.exception.exception import ElaborationException
+from api_exceptions import APIElaborationException
+
+"""
+This class is the controller for the use case EmbedDocumentsUseCase. It receives the documents' ids and returns a list of DocumentOperationResponse.
+Attributes:
+    useCase (EmbedDocumentsUseCase): The use case for embedding documents.
+"""
+class EmbedDocumentsController:
+    def __init__(self, embedDocumentsUseCase: EmbedDocumentsUseCase):
+        self.useCase = embedDocumentsUseCase
+
+    def embedDocuments(self, documentsIds: List[str]) -> List[DocumentOperationResponse]:
+        """
+        Receives the documents' ids and returns a list of DocumentOperationResponse.
+        Args:
+            documentsIds (List[str]): The documents' ids.
+        Returns:
+            List[DocumentOperationResponse]: the response of the operation.
+        """
+        try:
+            return self.useCase.embedDocuments([DocumentId(documentId) for documentId in documentsIds])
+        except ElaborationException as e:
+            raise APIElaborationException(str(e)) 

3 - PB/MVP/src/backend/adapter/_in/web/enable_documents_controller.py

@@ -0,0 +1,23 @@
+from typing import List
+from application.port._in.enable_documents_use_case import EnableDocumentsUseCase
+from domain.document.document_operation_response import DocumentOperationResponse
+from domain.document.document_id import DocumentId
+
+"""
+This class is the controller for the use case EnableDocumentsUseCase. It receives the documents' ids and returns a list of DocumentOperationResponse.
+Attributes:
+    useCase (EnableDocumentsUseCase): The use case for enabling documents.
+"""
+class EnableDocumentsController:
+    def __init__(self, enableDocumentsUseCase: EnableDocumentsUseCase):
+        self.useCase = enableDocumentsUseCase
+
+    def enableDocuments(self, documentsIds: List[str]) -> List[DocumentOperationResponse]:     
+        """
+        Receives the documents' ids and returns a list of DocumentOperationResponse.
+        Args:
+            documentsIds (List[str]): The documents' ids.
+        Returns:
+            List[DocumentOperationResponse]: the response of the operation.
+        """      
+        return self.useCase.enableDocuments([DocumentId(documentId) for documentId in documentsIds])

3 - PB/MVP/src/backend/adapter/_in/web/get_chat_messages_controller.py

@@ -0,0 +1,22 @@
+from application.port._in.get_chat_messages_use_case import GetChatMessagesUseCase
+from domain.chat.chat import Chat
+from domain.chat.chat_id import ChatId
+
+"""
+This class is the controller for the use case GetChatMessagesUseCase. It receives the chat's id and returns the chat's messages.
+Attributes:
+    useCase (GetChatMessagesUseCase): The use case for getting the chat's messages.
+"""
+class GetChatMessagesController:
+    def __init__(self, getChatMessagesUseCase: GetChatMessagesUseCase):
+        self.useCase = getChatMessagesUseCase
+
+    def getChatMessages(self, chatId: int) -> Chat:
+        """
+        Receives the chat's id and returns the chat's messages.
+        Args:
+            chatId (int): The chat's id.
+        Returns:
+            Chat: the chat containing the messages required.
+        """
+        return self.useCase.getChatMessages(ChatId(chatId))

3 - PB/MVP/src/backend/adapter/_in/web/get_chats_controller.py

@@ -0,0 +1,25 @@
+from typing import List
+
+from application.port._in.get_chats_use_case import GetChatsUseCase
+from domain.chat.chat_filter import ChatFilter
+from domain.chat.chat_preview import ChatPreview
+
+"""
+This class is the controller for the use case GetChatsUseCase. It receives the search filter and returns a list of ChatPreview.
+Attributes:
+    useCase (GetChatsUseCase): The use case for getting chats.
+"""
+class GetChatsController:
+    def __init__(self, getChatsUseCase: GetChatsUseCase):
+        self.useCase = getChatsUseCase
+
+    def getChats(self, searchFilter:str)-> List[ChatPreview]:
+        """
+        Receives the search filter and returns a list of ChatPreview.
+        Args:
+            searchFilter (str): The search filter.
+        Returns:
+            List[ChatPreview]: the list of ChatPreview that match the search filter.
+        """
+        filter = ChatFilter(searchFilter)
+        return self.useCase.getChats(filter)

3 - PB/MVP/src/backend/adapter/_in/web/get_configuration_controller.py

@@ -0,0 +1,20 @@
+from typing import List
+from application.port._in.get_configuration_use_case import GetConfigurationUseCase
+from domain.configuration.configuration import Configuration
+
+"""
+This class is the controller for the use case GetConfigurationUseCase. It returns the current configuration.
+Attributes:
+    useCase (GetConfigurationUseCase): The use case for getting the configuration.
+"""
+class GetConfigurationController:
+    def __init__(self, getConfigurationUseCase: GetConfigurationUseCase):
+        self.useCase = getConfigurationUseCase
+
+    def getConfiguration(self) -> Configuration:
+        """
+        Returns the current configuration.
+        Returns:
+            Configuration: the current configuration.
+        """ 
+        return self.useCase.getConfiguration()

3 - PB/MVP/src/backend/adapter/_in/web/get_configuration_options_controller.py

@@ -0,0 +1,20 @@
+from typing import List
+from application.port._in.get_configuration_options_use_case import GetConfigurationOptionsUseCase
+from domain.configuration.configuration_options import ConfigurationOptions
+
+"""
+This class is the controller for the use case GetConfigurationOptionsUseCase. It returns the current configuration options.
+Attributes:
+    useCase (GetConfigurationOptionsUseCase): The use case for getting the configuration options.
+"""
+class GetConfigurationOptionsController:
+    def __init__(self, getConfigurationOptionsUseCase: GetConfigurationOptionsUseCase):
+        self.useCase = getConfigurationOptionsUseCase
+
+    def getConfigurationOptions(self) -> ConfigurationOptions:
+        """
+        Returns the current configuration options.  
+        Returns:
+            ConfigurationOptions: the current configuration options.
+        """
+        return self.useCase.getConfigurationOptions()

3 - PB/MVP/src/backend/adapter/_in/web/get_document_content_controller.py

@@ -0,0 +1,30 @@
+from application.port._in.get_documents_content_use_case import GetDocumentsContentUseCase
+from domain.document.document import Document
+from domain.document.document_id import DocumentId
+
+from domain.exception.exception import ElaborationException
+from api_exceptions import APIElaborationException
+
+"""
+This class is the controller for the use case GetDocumentsContentUseCase. It receives the document's id and returns the document's content.
+Attributes:
+    useCase (GetDocumentsContentUseCase): The use case for getting the document's content.
+"""
+class GetDocumentContentController:
+    def __init__(self, getDocumentContentUseCase: GetDocumentsContentUseCase):
+        self.useCase = getDocumentContentUseCase
+
+    def getDocumentContent(self, documentId: str) -> Document:
+        """
+        Receives the document's id and returns the document's content.
+        Args:
+            documentId (str): The document's id.    
+        Returns:
+            Document: the Document containg the relative content.
+        """
+        try:
+            document = self.useCase.getDocumentsContent([DocumentId(documentId)])
+            return document[0] if document is not None else None
+        except ElaborationException as e:
+            raise APIElaborationException(str(e))
+