besser-agentic-framework 4.3.2__tar.gz → 4.3.3__tar.gz

{besser_agentic_framework-4.3.2/besser_agentic_framework.egg-info → besser_agentic_framework-4.3.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: besser-agentic-framework
-Version: 4.3.2
+Version: 4.3.3
 Summary: BESSER Agentic Framework (BAF)
 Author: Luxembourg Institute of Science and Technology
 License: MIT
@@ -18,7 +18,8 @@ Requires-Dist: dateparser==1.1.8
 Requires-Dist: langdetect==1.0.9
 Requires-Dist: markdownify==1.2.2
 Requires-Dist: nltk==3.9.1
-Requires-Dist: numpy==1.26.4
+Requires-Dist: numpy==1.26.4; python_version < "3.13"
+Requires-Dist: numpy<3,>=2.1; python_version >= "3.13"
 Requires-Dist: pandas==2.3.3
 Requires-Dist: python-telegram-bot==21.0
 Requires-Dist: psycopg2-binary>=2.9.10
@@ -27,7 +28,8 @@ Requires-Dist: pyvis==0.3.2
 Requires-Dist: PyYAML==6.0.2
 Requires-Dist: requests==2.31.0
 Requires-Dist: snowballstemmer==2.2.0
-Requires-Dist: sqlalchemy==2.0.29
+Requires-Dist: sqlalchemy==2.0.29; python_version < "3.13"
+Requires-Dist: sqlalchemy<2.1,>=2.0.31; python_version >= "3.13"
 Requires-Dist: streamlit==1.40.0
 Requires-Dist: streamlit-antd-components==0.3.2
 Requires-Dist: text2num==2.5.0
@@ -35,16 +37,19 @@ Requires-Dist: websocket-client==1.6.4
 Requires-Dist: websockets==11.0.3
 Requires-Dist: bcrypt==4.0.1
 Provides-Extra: extras
-Requires-Dist: spacy==3.7.2; extra == "extras"
+Requires-Dist: spacy==3.8.7; extra == "extras"
 Requires-Dist: scikit-learn>=1.7.0; extra == "extras"
 Requires-Dist: librosa==0.10.1; extra == "extras"
 Requires-Dist: SpeechRecognition==3.10.0; extra == "extras"
 Requires-Dist: soundfile==0.13.1; extra == "extras"
 Requires-Dist: opencv-python==4.10.0.84; extra == "extras"
 Requires-Dist: plotly==5.18.0; extra == "extras"
-Requires-Dist: chromadb==0.5.4; extra == "extras"
-Requires-Dist: langchain==0.2.9; extra == "extras"
-Requires-Dist: langchain-community==0.2.7; extra == "extras"
+Requires-Dist: chromadb==0.5.4; python_version < "3.13" and extra == "extras"
+Requires-Dist: chromadb==1.0.0; python_version >= "3.13" and extra == "extras"
+Requires-Dist: langchain==0.2.9; python_version < "3.13" and extra == "extras"
+Requires-Dist: langchain-community==0.2.7; python_version < "3.13" and extra == "extras"
+Requires-Dist: langchain==0.3.10; python_version >= "3.13" and extra == "extras"
+Requires-Dist: langchain-community==0.3.10; python_version >= "3.13" and extra == "extras"
 Requires-Dist: pypdf==4.3.1; extra == "extras"
 Requires-Dist: tiktoken==0.9.0; extra == "extras"
 Provides-Extra: llms
@@ -53,9 +58,9 @@ Requires-Dist: replicate==0.23.1; extra == "llms"
 Requires-Dist: transformers==4.53.0; extra == "llms"
 Provides-Extra: tensorflow
 Requires-Dist: keras==3.12.0; extra == "tensorflow"
-Requires-Dist: tensorflow==2.20.0; extra == "tensorflow"
+Requires-Dist: tensorflow-cpu==2.20.0; extra == "tensorflow"
 Provides-Extra: torch
-Requires-Dist: torch==2.5.1; extra == "torch"
+Requires-Dist: torch==2.6.0+cpu; extra == "torch"
 Requires-Dist: scikit-learn>=1.7.0; extra == "torch"
 Provides-Extra: docs
 Requires-Dist: sphinx==7.2.3; extra == "docs"
@@ -64,24 +69,27 @@ Requires-Dist: sphinx-paramlinks==0.6.0; extra == "docs"
 Requires-Dist: furo==2023.8.19; extra == "docs"
 Requires-Dist: m2r2==0.3.3; extra == "docs"
 Provides-Extra: all
-Requires-Dist: spacy==3.7.2; extra == "all"
+Requires-Dist: spacy==3.8.7; extra == "all"
 Requires-Dist: scikit-learn>=1.7.0; extra == "all"
 Requires-Dist: librosa==0.10.1; extra == "all"
 Requires-Dist: SpeechRecognition==3.10.0; extra == "all"
 Requires-Dist: soundfile==0.13.1; extra == "all"
 Requires-Dist: opencv-python==4.10.0.84; extra == "all"
 Requires-Dist: plotly==5.18.0; extra == "all"
-Requires-Dist: chromadb==0.5.4; extra == "all"
-Requires-Dist: langchain==0.2.9; extra == "all"
-Requires-Dist: langchain-community==0.2.7; extra == "all"
+Requires-Dist: chromadb==0.5.4; python_version < "3.13" and extra == "all"
+Requires-Dist: chromadb==1.0.0; python_version >= "3.13" and extra == "all"
+Requires-Dist: langchain==0.2.9; python_version < "3.13" and extra == "all"
+Requires-Dist: langchain-community==0.2.7; python_version < "3.13" and extra == "all"
+Requires-Dist: langchain==0.3.10; python_version >= "3.13" and extra == "all"
+Requires-Dist: langchain-community==0.3.10; python_version >= "3.13" and extra == "all"
 Requires-Dist: pypdf==4.3.1; extra == "all"
 Requires-Dist: tiktoken==0.9.0; extra == "all"
 Requires-Dist: openai==1.93.0; extra == "all"
 Requires-Dist: replicate==0.23.1; extra == "all"
 Requires-Dist: transformers==4.53.0; extra == "all"
 Requires-Dist: keras==3.12.0; extra == "all"
-Requires-Dist: tensorflow==2.20.0; extra == "all"
-Requires-Dist: torch==2.5.1; extra == "all"
+Requires-Dist: tensorflow-cpu==2.20.0; extra == "all"
+Requires-Dist: torch==2.6.0+cpu; extra == "all"
 Requires-Dist: scikit-learn>=1.7.0; extra == "all"
 Dynamic: license-file
 Dynamic: provides-extra

{besser_agentic_framework-4.3.2 → besser_agentic_framework-4.3.3}/baf/core/agent.py

@@ -24,7 +24,7 @@ from baf.db.monitoring_db import MonitoringDB
 from baf.exceptions.exceptions import AgentNotTrainedError, DuplicatedEntityError, DuplicatedInitialStateError, \
     DuplicatedIntentError, DuplicatedStateError, InitialStateNotFound
 from baf.exceptions.logger import logger
-from baf.library.transition.events.base_events import ReceiveMessageEvent, ReceiveJSONEvent
+from baf.library.transition.events.base_events import ReceiveMessageEvent, ReceiveJSONEvent, ReceiveFileEvent
 from baf.nlp.intent_classifier.intent_classifier_configuration import IntentClassifierConfiguration, \
     SimpleIntentClassifierConfiguration
 from baf.nlp.intent_classifier.intent_classifier_prediction import IntentClassifierPrediction
@@ -534,6 +534,9 @@ class Agent:
             else:
                 t = MessageType.STR
             session.save_message(Message(t=t, content=event.message, is_user=True, timestamp=datetime.now()))
+        if isinstance(event, ReceiveFileEvent):
+            session.save_message(Message(t=MessageType.FILE, content=event.file.get_json_string(), is_user=True, timestamp=datetime.now()))
+
         logger.info(f'Received event: {event.log()}')
 
     def process(self, session: Session, message: Any, is_user_message: bool) -> Any:
@@ -602,12 +605,14 @@ class Agent:
         else:
             return None
 
-    def _new_session(self, session_id: str, platform: Platform) -> Session:
+    def _new_session(self, session_id: str, platform: Platform, username: str or None = None, session_name: str or None = None) -> Session:
         """Create a new session for the agent.
 
         Args:
             session_id (str): the session id
             platform (Platform): the platform where the session is to be created and used
+            username (str): the name of the session user (optional)
+            session_name (str): the name of the session (optional)
 
         Returns:
             Session: the session
@@ -616,7 +621,7 @@ class Agent:
             raise ValueError(f'Trying to create a new session with an existing id" {session_id}')
         if platform not in self._platforms:
             raise ValueError(f"Platform {platform.__class__.__name__} not found in agent '{self.name}'")
-        session = Session(session_id, self, platform)
+        session = Session(session_id, self, platform, username, session_name)
         self._sessions[session_id] = session
         if self._persist_sessions and self._monitoring_db_session_exists(session_id, platform):
             dest_state = self._monitoring_db_get_last_state_of_session(session_id, platform)
@@ -635,10 +640,10 @@ class Agent:
         session._run_event_thread()
         return session
 
-    def get_or_create_session(self, session_id: str, platform: Platform) -> Session:
+    def get_or_create_session(self, session_id: str, platform: Platform, username: str or None = None, session_name: str or None = None) -> Session:
         session = self._get_session(session_id)
         if session is None:
-            session = self._new_session(session_id, platform)
+            session = self._new_session(session_id, platform, username, session_name)
         return session
 
     def close_session(self, session_id: str) -> None:

besser_agentic_framework-4.3.3/baf/core/message.py

@@ -0,0 +1,114 @@
+from datetime import datetime
+from enum import Enum
+from typing import Any
+
+from baf.platforms.payload import PayloadAction
+
+
+class MessageType(Enum):
+    """Enumeration of the different message types in :class:`Message`."""
+
+    STR = 'str'
+    JSON = 'json'
+    MARKDOWN = 'markdown'
+    HTML = 'html'
+    FILE = 'file'
+    IMAGE = 'image'
+    DATAFRAME = 'dataframe'
+    PLOTLY = 'plotly'
+    LOCATION = 'location'
+    OPTIONS = 'options'
+    AUDIO = 'audio'
+    RAG_ANSWER = 'rag_answer'
+    UI = 'ui'
+
+
+def get_message_type(value: str):
+    for message_type in MessageType:
+        if message_type.value == value:
+            return message_type
+    return None
+
+
+class Message:
+    """
+    A conversation message. It is used by the streamlit UI to display the messages properly, depending on the sender
+    (i.e., user or agent) and the type (string, audio, file, DataFrame, plot, etc.)
+
+    Args:
+        t (MessageType): The type of the message
+        content (Any): The message content
+        is_user (bool): Whether the message comes from the user (true) or the agent (false)
+        timestamp (datetime): The timestamp of the message (when the message was sent)
+
+    Attributes:
+        type (MessageType): The type of the message
+        content (Any): The message content
+        is_user (bool): Whether the message comes from the user (true) or the agent (false)
+        timestamp (datetime): The timestamp of the message (when the message was sent)
+    """
+
+    def __init__(self, t: MessageType, content: Any, is_user: bool, timestamp: datetime):
+        self.type: MessageType = t
+        self.content: Any = content
+        self.is_user: bool = is_user
+        self.timestamp: datetime = timestamp
+        # TODO: Parse content to specific type (in DB, messages are stored a str)
+
+    def get_action(self):
+        if self.is_user:
+            match self.type:
+                case MessageType.STR:
+                    return PayloadAction.USER_MESSAGE
+                case MessageType.JSON:
+                    return PayloadAction.USER_MESSAGE  # TODO: Not implemented
+                case MessageType.MARKDOWN:
+                    return PayloadAction.USER_MESSAGE  # TODO: Not implemented
+                case MessageType.HTML:
+                    return PayloadAction.USER_MESSAGE  # TODO: Not implemented
+                case MessageType.FILE:
+                    return PayloadAction.USER_FILE
+                case MessageType.IMAGE:
+                    return PayloadAction.USER_FILE  # TODO: Not implemented
+                case MessageType.DATAFRAME:
+                    return PayloadAction.USER_MESSAGE  # TODO: Not implemented
+                case MessageType.PLOTLY:
+                    return PayloadAction.USER_MESSAGE  # TODO: Not implemented
+                case MessageType.LOCATION:
+                    return PayloadAction.USER_MESSAGE  # TODO: Not implemented
+                case MessageType.OPTIONS:
+                    return PayloadAction.USER_MESSAGE  # TODO: Not implemented
+                case MessageType.AUDIO:
+                    return PayloadAction.USER_VOICE
+                case MessageType.RAG_ANSWER:
+                    return PayloadAction.USER_MESSAGE  # TODO: Not implemented
+                case MessageType.UI:
+                    return PayloadAction.USER_MESSAGE  # TODO: Not implemented
+        else:
+            match self.type:
+                case MessageType.STR:
+                    return PayloadAction.AGENT_REPLY_STR
+                case MessageType.JSON:
+                    return PayloadAction.AGENT_REPLY_STR  # TODO: Not implemented
+                case MessageType.MARKDOWN:
+                    return PayloadAction.AGENT_REPLY_MARKDOWN
+                case MessageType.HTML:
+                    return PayloadAction.AGENT_REPLY_HTML
+                case MessageType.FILE:
+                    return PayloadAction.AGENT_REPLY_FILE
+                case MessageType.IMAGE:
+                    return PayloadAction.AGENT_REPLY_IMAGE
+                case MessageType.DATAFRAME:
+                    return PayloadAction.AGENT_REPLY_DF
+                case MessageType.PLOTLY:
+                    return PayloadAction.AGENT_REPLY_PLOTLY
+                case MessageType.LOCATION:
+                    return PayloadAction.AGENT_REPLY_LOCATION
+                case MessageType.OPTIONS:
+                    return PayloadAction.AGENT_REPLY_OPTIONS
+                case MessageType.AUDIO:
+                    return PayloadAction.AGENT_REPLY_AUDIO
+                case MessageType.RAG_ANSWER:
+                    return PayloadAction.AGENT_REPLY_RAG
+                case MessageType.UI:
+                    return PayloadAction.AGENT_REPLY_UI

{besser_agentic_framework-4.3.2 → besser_agentic_framework-4.3.3}/baf/core/session.py

@@ -39,9 +39,13 @@ class Session:
         session_id (str): The session id, which must unique among all agent sessions
         agent (Agent): The agent the session belongs to
         platform (Platform): The platform where the session has been created
+        username (str): the name of the session user (optional)
+        session_name (str): the name of the session (optional)
 
     Attributes:
         _id (str): The session id, which must unique among all agent sessions
+        _username (str): the name of the session user (optional)
+        _session_name (str): the name of the session (optional)
         _agent (str): The agent the session belongs to
         _platform (str): The platform where the session has been created
         _current_state (str): The current state in the agent for this session
@@ -60,8 +64,12 @@ class Session:
             session_id: str,
             agent: 'Agent',
             platform: 'Platform',
+            username: str or None = None,
+            session_name: str or None = None
     ):
         self._id: str = session_id
+        self._username: str = username
+        self._session_name: str = session_name
         self._agent: 'Agent' = agent
         self._platform: 'Platform' = platform
         self._current_state: 'State' = self._agent.initial_state()
@@ -133,6 +141,17 @@ class Session:
 
         def start_event_loop():
             logger.debug(f'Starting Event Loop for session: {self.id}')
+            # Wait for the platform to finish starting before running the agent.
+            # Platforms run in their own threads and may not be ready immediately.
+            timeout = 30  # seconds
+            elapsed = 0.0
+            interval = 0.05  # 50ms polling interval
+            while not self._platform.running:
+                if elapsed >= timeout:
+                    logger.error(f'Platform did not start within {timeout}s for session {self.id}. Aborting session start.')
+                    return
+                time.sleep(interval)
+                elapsed += interval
             asyncio.set_event_loop(self._event_loop)
             asyncio.get_event_loop().call_soon(self.manage_transition)
             self._event_loop.run_forever()

{besser_agentic_framework-4.3.2 → besser_agentic_framework-4.3.3}/baf/core/state.py

@@ -275,8 +275,12 @@ class State:
             TransitionBuilder: the transition builder
         """
         event = ReceiveFileEvent()
+        if allowed_types:
+            params = {'allowed_types': allowed_types}
+        else:
+            params = {}
         transition_builder: TransitionBuilder = TransitionBuilder(source=self, event=event)
-        transition_builder.with_condition(function=file_type, params={'allowed_types': allowed_types})
+        transition_builder.with_condition(function=file_type, params=params)
         return transition_builder
 
     def check_transitions(self, session: Session) -> None:

{besser_agentic_framework-4.3.2 → besser_agentic_framework-4.3.3}/baf/core/transition/transition_builder.py

@@ -62,7 +62,7 @@ class TransitionBuilder:
         if len(func_params) == 1:
             # session param
             condition_function = function
-        elif len(func_params) == 2 and params:
+        elif len(func_params) == 2 and params is not None:
             # (session, params) param
             condition_function = partial(function, params=params)
         else:

{besser_agentic_framework-4.3.2 → besser_agentic_framework-4.3.3}/baf/db/monitoring_db.py

@@ -90,6 +90,8 @@ class MonitoringDB:
             id = Column(Integer, primary_key=True, autoincrement=True)
             agent_name = Column(String, nullable=False)
             session_id = Column(String, nullable=False)
+            session_name = Column(String, nullable=True)
+            username = Column(String, nullable=True)
             platform_name = Column(String, nullable=False)
             timestamp = Column(DateTime, nullable=False)
             variables = Column(String, nullable=True)
@@ -100,7 +102,7 @@ class MonitoringDB:
         class TableIntentPrediction(Base):
             __tablename__ = TABLE_INTENT_PREDICTION
             id = Column(Integer, primary_key=True, autoincrement=True)
-            session_id = Column(Integer, ForeignKey(f'{TABLE_SESSION}.id'), nullable=False)
+            session_id = Column(Integer, ForeignKey(f'{TABLE_SESSION}.id', ondelete='CASCADE'), nullable=False)
             message = Column(String, nullable=False)
             timestamp = Column(DateTime, nullable=False)
             intent_classifier = Column(String, nullable=False)
@@ -110,7 +112,7 @@ class MonitoringDB:
         class TableParameter(Base):
             __tablename__ = TABLE_PARAMETER
             id = Column(Integer, primary_key=True, autoincrement=True)
-            intent_prediction_id = Column(Integer, ForeignKey(f'{TABLE_INTENT_PREDICTION}.id'), nullable=False)
+            intent_prediction_id = Column(Integer, ForeignKey(f'{TABLE_INTENT_PREDICTION}.id', ondelete='CASCADE'), nullable=False)
             name = Column(String, nullable=False)
             value = Column(String)
             info = Column(String)
@@ -118,7 +120,7 @@ class MonitoringDB:
         class TableTransition(Base):
             __tablename__ = TABLE_TRANSITION
             id = Column(Integer, primary_key=True, autoincrement=True)
-            session_id = Column(Integer, ForeignKey(f'{TABLE_SESSION}.id'), nullable=False)
+            session_id = Column(Integer, ForeignKey(f'{TABLE_SESSION}.id', ondelete='CASCADE'), nullable=False)
             source_state = Column(String, nullable=False)
             dest_state = Column(String, nullable=False)
             event = Column(String, nullable=True)
@@ -128,7 +130,7 @@ class MonitoringDB:
         class TableChat(Base):
             __tablename__ = TABLE_CHAT
             id = Column(Integer, primary_key=True, autoincrement=True)
-            session_id = Column(Integer, ForeignKey(f'{TABLE_SESSION}.id'), nullable=False)
+            session_id = Column(Integer, ForeignKey(f'{TABLE_SESSION}.id', ondelete='CASCADE'), nullable=False)
             type = Column(String, nullable=False)
             content = Column(JSONB, nullable=False)  # JSONB allows to handle the dictionary (TTS messages)
             is_user = Column(Boolean, nullable=False)
@@ -137,7 +139,7 @@ class MonitoringDB:
         class TableEvent(Base):
             __tablename__ = TABLE_EVENT
             id = Column(Integer, primary_key=True, autoincrement=True)
-            session_id = Column(Integer, ForeignKey(f'{TABLE_SESSION}.id'), nullable=True)
+            session_id = Column(Integer, ForeignKey(f'{TABLE_SESSION}.id', ondelete='CASCADE'), nullable=True)
             event = Column(String, nullable=False)
             info = Column(String, nullable=True)
             timestamp = Column(DateTime, nullable=False)
@@ -153,6 +155,8 @@ class MonitoringDB:
         """
         table = Table(TABLE_SESSION, MetaData(), autoload_with=self.conn)
         stmt = insert(table).values(
+            username=session._username,
+            session_name=session._session_name,
             agent_name=session._agent.name,
             session_id=session.id,
             platform_name=session.platform.__class__.__name__,

{besser_agentic_framework-4.3.2 → besser_agentic_framework-4.3.3}/baf/library/transition/events/base_events.py

@@ -71,12 +71,15 @@ class ReceiveMessageEvent(Event):
         message = session._agent.process(session=session, message=message, is_user_message=human)
         
         try:
-            payload = json.loads(message)
-            if isinstance(payload, dict):
-                event = ReceiveJSONEvent(payload, session_id, human)
+            if isinstance(message, dict):
+                event = ReceiveJSONEvent(message, session_id, human)
             else:
-                event = ReceiveTextEvent(message, session_id, human)
-        except json.JSONDecodeError:
+                payload = json.loads(message)
+                if isinstance(payload, dict):
+                    event = ReceiveJSONEvent(payload, session_id, human)
+                else:
+                    event = ReceiveTextEvent(message, session_id, human)
+        except Exception as e:
             event = ReceiveTextEvent(message, session_id, human)
         finally:
             return event

{besser_agentic_framework-4.3.2 → besser_agentic_framework-4.3.3}/baf/platforms/payload.py

@@ -1,4 +1,5 @@
 import json
+from datetime import datetime
 
 from enum import Enum
 
@@ -19,6 +20,9 @@ class PayloadAction(Enum):
     """PayloadAction: Indicates that the user intends to set a session variable. The payload must include a dictionary containing the variable name and its value, sent as a Payload message.
     """
 
+    USER_UPDATE_UI = 'user_update_ui'
+    """PayloadAction: Indicates that the payload's purpose is to send a UI update from the user."""
+
     RESET = 'reset'
     """PayloadAction: Use the :class:`~baf.platforms.websocket.websocket_platform.WebSocketPlatform` on this
     agent.
@@ -74,6 +78,11 @@ class PayloadAction(Enum):
     dictionary containing the audio data (as a base 64 String) and the metadata to reconstruct the audio array, composed
     of sample_rate, dtype and shape."""
 
+    AGENT_REPLY_UI = 'agent_reply_ui'
+    """PayloadAction: Indicates that the payload's purpose is to send an agent reply containing a UI, which is based on
+    the GUI metamodel in :class:`besser.BUML.metamodel.gui.graphical_ui.GUIModel`.
+    """
+
     FETCH_USER_MESSAGES = 'fetch_user_messages'
     """PayloadAction: Request to fetch old messages for a given user."""
 
@@ -103,10 +112,11 @@ class Payload:
                 return Payload(action, payload_message, history=history)
         return None
 
-    def __init__(self, action: PayloadAction, message: str or dict = None, history: bool = False):
+    def __init__(self, action: PayloadAction, message: str or dict = None, history: bool = False, timestamp: datetime = None):
         self.action: str = action.value
         self.message: str or dict = message
         self.history: bool = history
+        self.timestamp: datetime = timestamp
 
 
 class PayloadEncoder(json.JSONEncoder):
@@ -130,10 +140,14 @@ class PayloadEncoder(json.JSONEncoder):
         """
         if isinstance(obj, Payload):
             # Convert the Payload object to a dictionary
+            timestamp = getattr(obj, 'timestamp', None)
+            if timestamp:
+                timestamp = timestamp.strftime("%Y-%m-%d %H:%M:%S")
             payload_dict = {
                 'action': obj.action,
                 'message': obj.message,
                 'history': getattr(obj, 'history', None),
+                'timestamp': timestamp
             }
             return payload_dict
         return super().default(obj)