Agentic flow integration2 (#1861)

* Agentic flow added to - whatsapp broadcast, mail channel, schedule action

* Agentic flow added to - whatsapp broadcast, mail channel, schedule action

* Agentic flow added to - whatsapp broadcast, mail channel, schedule action

* Agentic flow global slots, tagging, context -

---------

Co-authored-by: spandan_mondal <[email protected]>

Author: hasinaxp

kairon/__init__.py

@@ -45,7 +45,7 @@
 
 def create_argument_parser():
     from kairon.cli import importer, training, testing, conversations_deletion, translator, delete_logs,\
-        message_broadcast,content_importer, mail_channel_read
+        message_broadcast,content_importer, mail_channel_read, agentic_flow
 
     parser = ArgumentParser(
         prog="kairon",
@@ -64,6 +64,8 @@ def create_argument_parser():
     message_broadcast.add_subparser(subparsers, parents=parent_parsers)
     content_importer.add_subparser(subparsers, parents=parent_parsers)
     mail_channel_read.add_subparser(subparsers, parents=parent_parsers)
+    agentic_flow.add_subparser(subparsers, parents=parent_parsers)
+
     return parser
 
 

kairon/actions/definitions/schedule.py

@@ -1,3 +1,4 @@
+import json
 from calendar import timegm
 from datetime import datetime
 import pickle
@@ -20,11 +21,12 @@
 from kairon.actions.definitions.base import ActionsBase
 from kairon.events.executors.factory import ExecutorFactory
 from kairon.exceptions import AppException
-from kairon.shared.actions.data_objects import ActionServerLogs, ScheduleAction
+from kairon.shared.actions.data_objects import ActionServerLogs, ScheduleAction, ScheduleActionType
 from kairon.shared.actions.exception import ActionFailure
 from kairon.shared.actions.models import ActionType
 from kairon.shared.actions.utils import ActionUtility
 from kairon.shared.callback.data_objects import CallbackConfig
+from kairon.shared.constants import EventClass
 from kairon.shared.data.constant import TASK_TYPE
 
 
@@ -78,7 +80,8 @@ async def execute(self, dispatcher: CollectingDispatcher, tracker: Tracker, doma
         schedule_action = None
         schedule_time = None
         timezone = None
-        pyscript_code = None
+        execution_info = None
+        event_data = None
         try:
             action_config = self.retrieve_config()
             dispatch_bot_response = action_config.get('dispatch_bot_response', True)
@@ -87,8 +90,6 @@ async def execute(self, dispatcher: CollectingDispatcher, tracker: Tracker, doma
             tracker_data.update({'bot': self.bot})
             schedule_action = action_config['schedule_action']
             timezone = action_config['timezone']
-            callback = CallbackConfig.get_entry(name=schedule_action, bot=self.bot)
-            pyscript_code = callback['pyscript_code']
             schedule_time, _ = ActionUtility.get_parameter_value(tracker_data,
                                                                  action_config['schedule_time'],
                                                                  self.bot)
@@ -98,12 +99,35 @@ async def execute(self, dispatcher: CollectingDispatcher, tracker: Tracker, doma
                                                                                       action_config['params_list'],
                                                                                       self.bot)
             logger.info("schedule_data: " + str(schedule_data_log))
-            event_data = {'data': {'source_code': callback['pyscript_code'],
-                                   'predefined_objects': schedule_data
-                                   },
-                          'date_time': date_parser.parse(schedule_time),
-                          'timezone': action_config['timezone']
-                          }
+
+            if action_config['schedule_action_type'] == ScheduleActionType.PYSCRIPT.value:
+                callback = CallbackConfig.get_entry(name=schedule_action, bot=self.bot)
+                event_data = {'data': {'source_code': callback['pyscript_code'],
+                                       'predefined_objects': schedule_data
+                                       },
+                              'date_time': date_parser.parse(schedule_time),
+                              'timezone': action_config['timezone']
+                              }
+                execution_info = {
+                    'pyscript_code': callback['pyscript_code'],
+                    'type': ScheduleActionType.PYSCRIPT.value
+                }
+            elif action_config['schedule_action_type'] == ScheduleActionType.FLOW.value:
+                event_data = {
+                                'data': {
+                                        'slot_data': json.dumps(schedule_data),
+                                        'flow_name': schedule_action,
+                                        'bot': self.bot,
+                                        'user': tracker.sender_id
+                                    },
+                                  'date_time': date_parser.parse(schedule_time),
+                                  'timezone': action_config['timezone'],
+                                  'is_flow': True
+                              }
+                execution_info = {
+                    'flow': schedule_action,
+                    'type': ScheduleActionType.FLOW.value
+                }
             await self.add_schedule_job(**event_data)
         except Exception as e:
             exception = e
@@ -128,7 +152,7 @@ async def execute(self, dispatcher: CollectingDispatcher, tracker: Tracker, doma
                 schedule_action=schedule_action,
                 schedule_time=schedule_time,
                 timezone=timezone,
-                pyscript_code=pyscript_code,
+                execution_info=execution_info,
                 data=schedule_data_log
             ).save()
         return {}
@@ -137,13 +161,19 @@ async def add_schedule_job(self,
                                date_time: datetime,
                                data: Dict,
                                timezone: Text,
+                               is_flow=False,
                                **kwargs):
         func = obj_to_ref(ExecutorFactory.get_executor().execute_task)
 
         _id = uuid7().hex
-        data['predefined_objects']['event'] = _id
         args = (func, "scheduler_evaluator", data,)
-        kwargs.update({'task_type': TASK_TYPE.ACTION.value})
+        if is_flow:
+            args = (ExecutorFactory.get_executor(), EventClass.agentic_flow, data,)
+            kwargs.update({'task_type': TASK_TYPE.EVENT.value})
+        else:
+            kwargs.update({'task_type': TASK_TYPE.ACTION.value})
+            data['predefined_objects']['event'] = _id
+
         trigger = DateTrigger(run_date=date_time, timezone=timezone)
 
         next_run_time = trigger.get_next_fire_time(None, datetime.now(astimezone(timezone) or get_localzone()))

kairon/api/app/routers/bot/bot.py

@@ -35,6 +35,7 @@
 from kairon.shared.data.audit.processor import AuditDataProcessor
 from kairon.shared.data.constant import ENDPOINT_TYPE, ModelTestType, \
     AuditlogActions
+from kairon.shared.data.data_models import FlowTagChangeRequest
 from kairon.shared.data.data_objects import TrainingExamples, ModelTraining, Rules
 from kairon.shared.data.model_processor import ModelProcessor
 from kairon.shared.data.processor import MongoProcessor
@@ -1684,3 +1685,33 @@ async def trigger_mail_channel_read(
     event.validate()
     event.enqueue()
     return Response(message="mail channel read triggered")
+
+
+@router.post("/change_flow_tag", response_model=Response)
+async def change_flow_tag(
+        request: FlowTagChangeRequest,
+        current_user: User = Security(Authentication.get_current_user_and_bot, scopes=DESIGNER_ACCESS)
+):
+    """
+    change tag or rule or multiflow
+    """
+    data = request.dict()
+    mongo_processor.change_flow_tag(
+        bot = current_user.get_bot(),
+        flow_name=data['name'],
+        tag=data['tag'],
+        flow_type=data['type']
+    )
+    return Response(message=f"Flow tag changed to '{data['tag']}'")
+
+@router.get("/flow_tag/{tag}", response_model=Response)
+async def get_flow_tag(
+        tag: str = Path(description="flow tag"),
+        current_user: User = Security(Authentication.get_current_user_and_bot, scopes=TESTER_ACCESS)
+):
+    """
+    Fetches the flows with the given tag
+    """
+    flows = mongo_processor.get_flows_by_tag(current_user.get_bot(), tag)
+    return Response(data=flows)
+

kairon/cli/agentic_flow.py

@@ -0,0 +1,36 @@
+from argparse import ArgumentParser, ArgumentDefaultsHelpFormatter
+from typing import List
+from rasa.cli import SubParsersAction
+
+from kairon.events.definitions.agentic_flow import AgenticFlowEvent
+
+
+def exec_agentic_flow(args):
+    AgenticFlowEvent(args.bot, args.user).execute(flow_name=args.flow_name, slot_data=args.slot_data)
+
+
+def add_subparser(subparsers: SubParsersAction, parents: List[ArgumentParser]):
+    agentic_fow_parser = subparsers.add_parser(
+        "agentic-flow",
+        conflict_handler="resolve",
+        formatter_class=ArgumentDefaultsHelpFormatter,
+        parents=parents,
+        help="Mail channel initiate reading"
+    )
+    agentic_fow_parser.add_argument('bot',
+                             type=str,
+                             help="Bot id for which command is executed", action='store')
+
+    agentic_fow_parser.add_argument('user',
+                            type=str,
+                            help="Kairon user who is initiating the command", action='store')
+
+    agentic_fow_parser.add_argument('flow_name',
+                             type=str,
+                             help="Kairon flow name to execute", action='store')
+
+    agentic_fow_parser.add_argument('slot_data',
+                                    type=str,
+                                    help="json containing slot values dictionary", action='store')
+
+    agentic_fow_parser.set_defaults(func=exec_agentic_flow)

kairon/events/definitions/agentic_flow.py

@@ -0,0 +1,70 @@
+import asyncio
+import json
+from typing import Text
+from loguru import logger
+from kairon import Utility
+from kairon.events.definitions.base import EventsBase
+from kairon.exceptions import AppException
+from kairon.shared.chat.agent.agent_flow import AgenticFlow
+from kairon.shared.constants import EventClass
+
+
+class AgenticFlowEvent(EventsBase):
+    """
+    Event to execute an agentic flow
+    """
+
+    def __init__(self, bot: Text, user: Text, **kwargs):
+        """
+        Initialise event.
+        """
+        self.bot = bot
+        self.user = user
+        self.flow_name = kwargs.get('flow_name')
+
+    def validate(self):
+        """
+        validate mail channel exists and works properly
+        """
+        if self.flow_name:
+            return AgenticFlow.flow_exists(self.bot, self.flow_name)
+
+    def enqueue(self, **kwargs):
+        """
+        Send event to event server.
+        """
+        try:
+            payload = {'bot': self.bot, 'user': self.user}
+            if flow_name := kwargs.get('flow_name'):
+                payload['flow_name'] = flow_name
+                self.flow_name = flow_name
+            if slot_data := kwargs.get('slot_data'):
+                payload['slot_data'] = slot_data
+            self.validate()
+            Utility.request_event_server(EventClass.agentic_flow, payload)
+        except Exception as e:
+            logger.error(str(e))
+            raise AppException(e)
+
+    def execute(self, **kwargs):
+        """
+        Execute the event.
+        """
+        try:
+            if flow_name := kwargs.get('flow_name'):
+                self.flow_name = flow_name
+
+            slot_vals = {}
+            if slot_data := kwargs.get('slot_data'):
+                if isinstance(slot_data, str):
+                    slot_data = json.loads(slot_data)
+                slot_vals = slot_data
+            flow = AgenticFlow(bot=self.bot, slot_vals=slot_vals)
+            resp, errors = asyncio.run(flow.execute_rule(self.flow_name))
+            logger.info(resp)
+            if errors:
+                logger.error(f"Failed to execute flow {self.flow_name}. Errors: {errors}")
+                raise AppException(f"Failed to execute flow {self.flow_name}. Errors: {errors}")
+        except Exception as e:
+            logger.error(str(e))
+            raise AppException(f"Failed to execute flow {self.flow_name} for bot {self.bot}. Error: {str(e)}")

kairon/events/definitions/factory.py

@@ -1,3 +1,4 @@
+from kairon.events.definitions.agentic_flow import AgenticFlowEvent
 from kairon.events.definitions.content_importer import DocContentImporterEvent
 from kairon.events.definitions.data_importer import TrainingDataImporterEvent
 from kairon.events.definitions.faq_importer import FaqDataImporterEvent
@@ -23,6 +24,7 @@ class EventFactory:
         EventClass.message_broadcast: MessageBroadcastEvent,
         EventClass.content_importer: DocContentImporterEvent,
         EventClass.mail_channel_read_mails: MailReadEvent,
+        EventClass.agentic_flow: AgenticFlowEvent
     }
 
     @staticmethod

kairon/shared/actions/data_objects.py

@@ -1,4 +1,5 @@
 from datetime import datetime
+from enum import Enum
 
 from mongoengine import (
     EmbeddedDocument,
@@ -963,6 +964,10 @@ def clean(self):
             raise ValidationError("Action name cannot start with utter_")
 
 
+class ScheduleActionType(Enum):
+    PYSCRIPT = "pyscript"
+    FLOW = "flow"
+
 @auditlogger.log
 @push_notification.apply
 class ScheduleAction(Auditlog):
@@ -972,6 +977,9 @@ class ScheduleAction(Auditlog):
     schedule_time = EmbeddedDocumentField(CustomActionDynamicParameters)
     timezone = StringField(default="UTC", required=True)
     schedule_action = StringField(required=True)
+    schedule_action_type = StringField(
+        default=ScheduleActionType.PYSCRIPT.value, choices=[type.value for type in ScheduleActionType]
+    )
     response_text = StringField(required=False)
     params_list = ListField(
         EmbeddedDocumentField(CustomActionRequestParameters), required=False

kairon/shared/callback/data_objects.py

@@ -99,7 +99,7 @@ def get_all_names(bot) -> list[str]:
         return list(names)
 
     @staticmethod
-    def get_entry(bot, name) -> dict:
+    def get_entry(bot :str, name :str) -> dict:
         entry = CallbackConfig.objects(bot=bot, name__iexact=name).first()
         if not entry:
             raise AppException(f"Callback Configuration with name '{name}' does not exist!")
@@ -147,7 +147,7 @@ def create_entry(bot: str,
         return config.to_mongo().to_dict()
 
     @staticmethod
-    def get_auth_token(bot, name) -> tuple[str, bool]:
+    def get_auth_token(bot: str, name: str) -> tuple[str, bool]:
         entry = CallbackConfig.objects(bot=bot, name__iexact=name).first()
         if not entry:
             raise AppException(f"Callback Configuration with name '{name}' does not exist!")
@@ -281,7 +281,7 @@ def create_entry(name: str, callback_config_name: str, bot: str, sender_id: str,
         return callback_url, identifier, is_standalone
 
     @staticmethod
-    def get_value_from_json(json_obj, path):
+    def get_value_from_json(json_obj: Any, path: str):
         keys = path.split('.')
         value = json_obj
         try:
@@ -295,7 +295,7 @@ def get_value_from_json(json_obj, path):
         return value
 
     @staticmethod
-    def validate_entry(token: str, identifier: Optional[str] = None, request_body: Any = None):
+    def validate_entry(token: str, identifier: Optional[str] = None, request_body: Any = None) -> tuple[dict, dict]:
         check_nonempty_string(token)
         config_entry = CallbackConfig.verify_auth_token(token)
 
@@ -363,7 +363,7 @@ def create_success_entry(name: str,
                              request_data: Any,
                              metadata: dict,
                              callback_url: str,
-                             callback_source: str):
+                             callback_source: str) -> dict:
         check_nonempty_string(name)
         check_nonempty_string(bot)
         check_nonempty_string(identifier)
@@ -396,7 +396,7 @@ def create_failure_entry(name: str,
                              request_data: Any,
                              metadata: dict,
                              callback_url: str,
-                             callback_source: str):
+                             callback_source: str) -> dict:
         check_nonempty_string(name)
         check_nonempty_string(bot)
         check_nonempty_string(identifier)
@@ -419,7 +419,7 @@ def create_failure_entry(name: str,
         return record.to_mongo().to_dict()
 
     @staticmethod
-    def get_logs(query: dict, offset: int, limit: int):
+    def get_logs(query: dict, offset: int, limit: int) -> tuple[list[dict], int]:
         logs = CallbackLog.objects(**query).skip(offset).limit(limit).exclude('id').order_by('-timestamp').to_json()
         logs_dict_list = json.loads(logs)
         for log in logs_dict_list: