agno 2.1.4__py3-none-any.whl → 2.1.5__py3-none-any.whl

agno/workflow/workflow.py

@@ -24,7 +24,7 @@ from fastapi import WebSocket
 from pydantic import BaseModel
 
 from agno.agent.agent import Agent
-from agno.db.base import BaseDb, SessionType
+from agno.db.base import AsyncBaseDb, BaseDb, SessionType
 from agno.exceptions import InputCheckError, OutputCheckError, RunCancelledException
 from agno.media import Audio, File, Image, Video
 from agno.models.message import Message
@@ -129,7 +129,7 @@ class Workflow:
     steps: Optional[WorkflowSteps] = None
 
     # Database to use for this workflow
-    db: Optional[BaseDb] = None
+    db: Optional[Union[BaseDb, AsyncBaseDb]] = None
 
     # Default session_id to use for this workflow (autogenerated if not set)
     session_id: Optional[str] = None
@@ -148,6 +148,8 @@ class Workflow:
     stream: Optional[bool] = None
     # Stream the intermediate steps from the Workflow
     stream_intermediate_steps: bool = False
+    # Stream events from executors (agents/teams/functions) within steps
+    stream_executor_events: bool = True
 
     # Persist the events on the run response
     store_events: bool = False
@@ -180,7 +182,7 @@ class Workflow:
         id: Optional[str] = None,
         name: Optional[str] = None,
         description: Optional[str] = None,
-        db: Optional[BaseDb] = None,
+        db: Optional[Union[BaseDb, AsyncBaseDb]] = None,
         steps: Optional[WorkflowSteps] = None,
         session_id: Optional[str] = None,
         session_state: Optional[Dict[str, Any]] = None,
@@ -189,6 +191,7 @@ class Workflow:
         debug_mode: Optional[bool] = False,
         stream: Optional[bool] = None,
         stream_intermediate_steps: bool = False,
+        stream_executor_events: bool = True,
         store_events: bool = False,
         events_to_skip: Optional[List[Union[WorkflowRunEvent, RunEvent, TeamRunEvent]]] = None,
         store_executor_outputs: bool = True,
@@ -212,6 +215,7 @@ class Workflow:
         self.events_to_skip = events_to_skip or []
         self.stream = stream
         self.stream_intermediate_steps = stream_intermediate_steps
+        self.stream_executor_events = stream_executor_events
         self.store_executor_outputs = store_executor_outputs
         self.input_schema = input_schema
         self.metadata = metadata
@@ -229,6 +233,9 @@ class Workflow:
             else:
                 self.id = str(uuid4())
 
+    def _has_async_db(self) -> bool:
+        return self.db is not None and isinstance(self.db, AsyncBaseDb)
+
     def _validate_input(
         self, input: Optional[Union[str, Dict[str, Any], List[Any], BaseModel, List[Message]]]
     ) -> Optional[Union[str, List, Dict, Message, BaseModel]]:
@@ -401,6 +408,33 @@ class Workflow:
             new_session_name = f"{truncated_desc} - {datetime_str}"
         return new_session_name
 
+    async def aset_session_name(
+        self, session_id: Optional[str] = None, autogenerate: bool = False, session_name: Optional[str] = None
+    ) -> WorkflowSession:
+        """Set the session name and save to storage, using an async database"""
+        session_id = session_id or self.session_id
+
+        if session_id is None:
+            raise Exception("Session ID is not set")
+
+        # -*- Read from storage
+        session = await self.aget_session(session_id=session_id)  # type: ignore
+
+        if autogenerate:
+            # -*- Generate name for session
+            session_name = self._generate_workflow_session_name()
+            log_debug(f"Generated Workflow Session Name: {session_name}")
+        elif session_name is None:
+            raise Exception("Session name is not set")
+
+        # -*- Rename session
+        session.session_data["session_name"] = session_name  # type: ignore
+
+        # -*- Save to storage
+        await self.asave_session(session=session)  # type: ignore
+
+        return session  # type: ignore
+
     def set_session_name(
         self, session_id: Optional[str] = None, autogenerate: bool = False, session_name: Optional[str] = None
     ) -> WorkflowSession:
@@ -428,6 +462,16 @@ class Workflow:
 
         return session  # type: ignore
 
+    async def aget_session_name(self, session_id: Optional[str] = None) -> str:
+        """Get the session name for the given session ID and user ID."""
+        session_id = session_id or self.session_id
+        if session_id is None:
+            raise Exception("Session ID is not set")
+        session = await self.aget_session(session_id=session_id)  # type: ignore
+        if session is None:
+            raise Exception("Session not found")
+        return session.session_data.get("session_name", "") if session.session_data else ""
+
     def get_session_name(self, session_id: Optional[str] = None) -> str:
         """Get the session name for the given session ID and user ID."""
         session_id = session_id or self.session_id
@@ -438,6 +482,16 @@ class Workflow:
             raise Exception("Session not found")
         return session.session_data.get("session_name", "") if session.session_data else ""
 
+    async def aget_session_state(self, session_id: Optional[str] = None) -> Dict[str, Any]:
+        """Get the session state for the given session ID and user ID."""
+        session_id = session_id or self.session_id
+        if session_id is None:
+            raise Exception("Session ID is not set")
+        session = await self.aget_session(session_id=session_id)  # type: ignore
+        if session is None:
+            raise Exception("Session not found")
+        return session.session_data.get("session_state", {}) if session.session_data else {}
+
     def get_session_state(self, session_id: Optional[str] = None) -> Dict[str, Any]:
         """Get the session state for the given session ID and user ID."""
         session_id = session_id or self.session_id
@@ -448,6 +502,13 @@ class Workflow:
             raise Exception("Session not found")
         return session.session_data.get("session_state", {}) if session.session_data else {}
 
+    async def adelete_session(self, session_id: str):
+        """Delete the current session and save to storage"""
+        if self.db is None:
+            return
+        # -*- Delete session
+        await self.db.delete_session(session_id=session_id)  # type: ignore
+
     def delete_session(self, session_id: str):
         """Delete the current session and save to storage"""
         if self.db is None:
@@ -455,6 +516,25 @@ class Workflow:
         # -*- Delete session
         self.db.delete_session(session_id=session_id)
 
+    async def aget_run_output(self, run_id: str, session_id: Optional[str] = None) -> Optional[WorkflowRunOutput]:
+        """Get a RunOutput from the database."""
+        if self._workflow_session is not None:
+            run_response = self._workflow_session.get_run(run_id=run_id)
+            if run_response is not None:
+                return run_response
+            else:
+                log_warning(f"RunOutput {run_id} not found in AgentSession {self._workflow_session.session_id}")
+                return None
+        else:
+            workflow_session = await self.aget_session(session_id=session_id)  # type: ignore
+            if workflow_session is not None:
+                run_response = workflow_session.get_run(run_id=run_id)
+                if run_response is not None:
+                    return run_response
+                else:
+                    log_warning(f"RunOutput {run_id} not found in AgentSession {session_id}")
+        return None
+
     def get_run_output(self, run_id: str, session_id: Optional[str] = None) -> Optional[WorkflowRunOutput]:
         """Get a RunOutput from the database."""
         if self._workflow_session is not None:
@@ -474,6 +554,26 @@ class Workflow:
                     log_warning(f"RunOutput {run_id} not found in AgentSession {session_id}")
         return None
 
+    async def aget_last_run_output(self, session_id: Optional[str] = None) -> Optional[WorkflowRunOutput]:
+        """Get the last run response from the database."""
+        if (
+            self._workflow_session is not None
+            and self._workflow_session.runs is not None
+            and len(self._workflow_session.runs) > 0
+        ):
+            run_response = self._workflow_session.runs[-1]
+            if run_response is not None:
+                return run_response
+        else:
+            workflow_session = await self.aget_session(session_id=session_id)  # type: ignore
+            if workflow_session is not None and workflow_session.runs is not None and len(workflow_session.runs) > 0:
+                run_response = workflow_session.runs[-1]
+                if run_response is not None:
+                    return run_response
+            else:
+                log_warning(f"No run responses found in WorkflowSession {session_id}")
+                return None
+
     def get_last_run_output(self, session_id: Optional[str] = None) -> Optional[WorkflowRunOutput]:
         """Get the last run response from the database."""
         if (
@@ -531,6 +631,68 @@ class Workflow:
 
         return workflow_session
 
+    async def aread_or_create_session(
+        self,
+        session_id: str,
+        user_id: Optional[str] = None,
+    ) -> WorkflowSession:
+        from time import time
+
+        # Returning cached session if we have one
+        if self._workflow_session is not None and self._workflow_session.session_id == session_id:
+            return self._workflow_session
+
+        # Try to load from database
+        workflow_session = None
+        if self.db is not None:
+            log_debug(f"Reading WorkflowSession: {session_id}")
+
+            workflow_session = cast(WorkflowSession, await self._aread_session(session_id=session_id))
+
+        if workflow_session is None:
+            # Creating new session if none found
+            log_debug(f"Creating new WorkflowSession: {session_id}")
+            workflow_session = WorkflowSession(
+                session_id=session_id,
+                workflow_id=self.id,
+                user_id=user_id,
+                workflow_data=self._get_workflow_data(),
+                session_data={},
+                metadata=self.metadata,
+                created_at=int(time()),
+            )
+
+        # Cache the session if relevant
+        if workflow_session is not None and self.cache_session:
+            self._workflow_session = workflow_session
+
+        return workflow_session
+
+    async def aget_session(
+        self,
+        session_id: Optional[str] = None,
+    ) -> Optional[WorkflowSession]:
+        """Load an WorkflowSession from database.
+
+        Args:
+            session_id: The session_id to load from storage.
+
+        Returns:
+            WorkflowSession: The WorkflowSession loaded from the database or created if it does not exist.
+        """
+        if not session_id and not self.session_id:
+            raise Exception("No session_id provided")
+
+        session_id_to_load = session_id or self.session_id
+
+        # Try to load from database
+        if self.db is not None and session_id_to_load is not None:
+            workflow_session = cast(WorkflowSession, await self._aread_session(session_id=session_id_to_load))
+            return workflow_session
+
+        log_warning(f"WorkflowSession {session_id_to_load} not found in db")
+        return None
+
     def get_session(
         self,
         session_id: Optional[str] = None,
@@ -556,6 +718,25 @@ class Workflow:
         log_warning(f"WorkflowSession {session_id_to_load} not found in db")
         return None
 
+    async def asave_session(self, session: WorkflowSession) -> None:
+        """Save the WorkflowSession to storage, using an async database.
+
+        Returns:
+            Optional[WorkflowSession]: The saved WorkflowSession or None if not saved.
+        """
+        if self.db is not None and session.session_data is not None:
+            if session.session_data.get("session_state") is not None:
+                session.session_data["session_state"].pop("current_session_id", None)
+                session.session_data["session_state"].pop("current_user_id", None)
+                session.session_data["session_state"].pop("current_run_id", None)
+                session.session_data["session_state"].pop("workflow_id", None)
+                session.session_data["session_state"].pop("run_id", None)
+                session.session_data["session_state"].pop("session_id", None)
+                session.session_data["session_state"].pop("workflow_name", None)
+
+            await self._aupsert_session(session=session)  # type: ignore
+            log_debug(f"Created or updated WorkflowSession record: {session.session_id}")
+
     def save_session(self, session: WorkflowSession) -> None:
         """Save the WorkflowSession to storage
 
@@ -576,6 +757,17 @@ class Workflow:
             log_debug(f"Created or updated WorkflowSession record: {session.session_id}")
 
     # -*- Session Database Functions
+    async def _aread_session(self, session_id: str) -> Optional[WorkflowSession]:
+        """Get a Session from the database."""
+        try:
+            if not self.db:
+                raise ValueError("Db not initialized")
+            session = await self.db.get_session(session_id=session_id, session_type=SessionType.WORKFLOW)  # type: ignore
+            return session if isinstance(session, (WorkflowSession, type(None))) else None
+        except Exception as e:
+            log_warning(f"Error getting session from db: {e}")
+            return None
+
     def _read_session(self, session_id: str) -> Optional[WorkflowSession]:
         """Get a Session from the database."""
         try:
@@ -587,9 +779,19 @@ class Workflow:
             log_warning(f"Error getting session from db: {e}")
             return None
 
-    def _upsert_session(self, session: WorkflowSession) -> Optional[WorkflowSession]:
+    async def _aupsert_session(self, session: WorkflowSession) -> Optional[WorkflowSession]:
         """Upsert a Session into the database."""
+        try:
+            if not self.db:
+                raise ValueError("Db not initialized")
+            result = await self.db.upsert_session(session=session)  # type: ignore
+            return result if isinstance(result, (WorkflowSession, type(None))) else None
+        except Exception as e:
+            log_warning(f"Error upserting session into db: {e}")
+            return None
 
+    def _upsert_session(self, session: WorkflowSession) -> Optional[WorkflowSession]:
+        """Upsert a Session into the database."""
         try:
             if not self.db:
                 raise ValueError("Db not initialized")
@@ -1158,6 +1360,7 @@ class Workflow:
                         session_id=session.session_id,
                         user_id=self.user_id,
                         stream_intermediate_steps=stream_intermediate_steps,
+                        stream_executor_events=self.stream_executor_events,
                         workflow_run_response=workflow_run_response,
                         session_state=session_state,
                         step_index=i,
@@ -1228,7 +1431,8 @@ class Workflow:
                             enriched_event = self._enrich_event_with_workflow_context(
                                 event, workflow_run_response, step_index=i, step=step
                             )
-                            yield self._handle_event(enriched_event, workflow_run_response)  # type: ignore
+                            if self.stream_executor_events:
+                                yield self._handle_event(enriched_event, workflow_run_response)  # type: ignore
 
                     # Break out of main step loop if early termination was requested
                     if "early_termination" in locals() and early_termination:
@@ -1540,7 +1744,10 @@ class Workflow:
 
         self._update_session_metrics(session=session, workflow_run_response=workflow_run_response)
         session.upsert_run(run=workflow_run_response)
-        self.save_session(session=session)
+        if self._has_async_db():
+            await self.asave_session(session=session)
+        else:
+            self.save_session(session=session)
         # Always clean up the run tracking
         cleanup_run(workflow_run_response.run_id)  # type: ignore
 
@@ -1643,6 +1850,7 @@ class Workflow:
                         session_id=session.session_id,
                         user_id=self.user_id,
                         stream_intermediate_steps=stream_intermediate_steps,
+                        stream_executor_events=self.stream_executor_events,
                         workflow_run_response=workflow_run_response,
                         session_state=session_state,
                         step_index=i,
@@ -1714,9 +1922,10 @@ class Workflow:
                             enriched_event = self._enrich_event_with_workflow_context(
                                 event, workflow_run_response, step_index=i, step=step
                             )
-                            yield self._handle_event(
-                                enriched_event, workflow_run_response, websocket_handler=websocket_handler
-                            )  # type: ignore
+                            if self.stream_executor_events:
+                                yield self._handle_event(
+                                    enriched_event, workflow_run_response, websocket_handler=websocket_handler
+                                )  # type: ignore
 
                     # Break out of main step loop if early termination was requested
                     if "early_termination" in locals() and early_termination:
@@ -1817,7 +2026,10 @@ class Workflow:
         # Store the completed workflow response
         self._update_session_metrics(session=session, workflow_run_response=workflow_run_response)
         session.upsert_run(run=workflow_run_response)
-        self.save_session(session=session)
+        if self._has_async_db():
+            await self.asave_session(session=session)
+        else:
+            self.save_session(session=session)
 
         # Log Workflow Telemetry
         if self.telemetry:
@@ -1850,7 +2062,10 @@ class Workflow:
         )
 
         # Read existing session from database
-        workflow_session = self.read_or_create_session(session_id=session_id, user_id=user_id)
+        if self._has_async_db():
+            workflow_session = await self.aread_or_create_session(session_id=session_id, user_id=user_id)
+        else:
+            workflow_session = self.read_or_create_session(session_id=session_id, user_id=user_id)
         self._update_metadata(session=workflow_session)
 
         # Update session state from DB
@@ -1871,7 +2086,10 @@ class Workflow:
 
         # Store PENDING response immediately
         workflow_session.upsert_run(run=workflow_run_response)
-        self.save_session(session=workflow_session)
+        if self._has_async_db():
+            await self.asave_session(session=workflow_session)
+        else:
+            self.save_session(session=workflow_session)
 
         # Prepare execution input
         inputs = WorkflowExecutionInput(
@@ -1890,7 +2108,10 @@ class Workflow:
             try:
                 # Update status to RUNNING and save
                 workflow_run_response.status = RunStatus.running
-                self.save_session(session=workflow_session)
+                if self._has_async_db():
+                    await self.asave_session(session=workflow_session)
+                else:
+                    self.save_session(session=workflow_session)
 
                 await self._aexecute(
                     session=workflow_session,
@@ -1906,7 +2127,10 @@ class Workflow:
                 logger.error(f"Background workflow execution failed: {e}")
                 workflow_run_response.status = RunStatus.error
                 workflow_run_response.content = f"Background execution failed: {str(e)}"
-                self.save_session(session=workflow_session)
+                if self._has_async_db():
+                    await self.asave_session(session=workflow_session)
+                else:
+                    self.save_session(session=workflow_session)
 
         # Create and start asyncio task
         loop = asyncio.get_running_loop()
@@ -1941,7 +2165,10 @@ class Workflow:
         )
 
         # Read existing session from database
-        workflow_session = self.read_or_create_session(session_id=session_id, user_id=user_id)
+        if self._has_async_db():
+            workflow_session = await self.aread_or_create_session(session_id=session_id, user_id=user_id)
+        else:
+            workflow_session = self.read_or_create_session(session_id=session_id, user_id=user_id)
         self._update_metadata(session=workflow_session)
 
         # Update session state from DB
@@ -1962,7 +2189,10 @@ class Workflow:
 
         # Store PENDING response immediately
         workflow_session.upsert_run(run=workflow_run_response)
-        self.save_session(session=workflow_session)
+        if self._has_async_db():
+            await self.asave_session(session=workflow_session)
+        else:
+            self.save_session(session=workflow_session)
 
         # Prepare execution input
         inputs = WorkflowExecutionInput(
@@ -1981,7 +2211,10 @@ class Workflow:
             try:
                 # Update status to RUNNING and save
                 workflow_run_response.status = RunStatus.running
-                self.save_session(session=workflow_session)
+                if self._has_async_db():
+                    await self.asave_session(session=workflow_session)
+                else:
+                    self.save_session(session=workflow_session)
 
                 # Execute with streaming - consume all events (they're auto-broadcast via _handle_event)
                 async for event in self._aexecute_stream(
@@ -2003,7 +2236,10 @@ class Workflow:
                 logger.error(f"Background streaming workflow execution failed: {e}")
                 workflow_run_response.status = RunStatus.error
                 workflow_run_response.content = f"Background streaming execution failed: {str(e)}"
-                self.save_session(session=workflow_session)
+                if self._has_async_db():
+                    await self.asave_session(session=workflow_session)
+                else:
+                    self.save_session(session=workflow_session)
 
         # Create and start asyncio task for background streaming execution
         loop = asyncio.get_running_loop()
@@ -2012,6 +2248,18 @@ class Workflow:
         # Return SAME object that will be updated by background execution
         return workflow_run_response
 
+    async def aget_run(self, run_id: str) -> Optional[WorkflowRunOutput]:
+        """Get the status and details of a background workflow run - SIMPLIFIED"""
+        if self.db is not None and self.session_id is not None:
+            session = await self.db.aget_session(session_id=self.session_id, session_type=SessionType.WORKFLOW)  # type: ignore
+            if session and isinstance(session, WorkflowSession) and session.runs:
+                # Find the run by ID
+                for run in session.runs:
+                    if run.run_id == run_id:
+                        return run
+
+        return None
+
     def get_run(self, run_id: str) -> Optional[WorkflowRunOutput]:
         """Get the status and details of a background workflow run - SIMPLIFIED"""
         if self.db is not None and self.session_id is not None:
@@ -2086,6 +2334,8 @@ class Workflow:
         **kwargs: Any,
     ) -> Union[WorkflowRunOutput, Iterator[WorkflowRunOutputEvent]]:
         """Execute the workflow synchronously with optional streaming"""
+        if self._has_async_db():
+            raise Exception("`run()` is not supported with an async DB. Please use `arun()`.")
 
         input = self._validate_input(input)
         if background:
@@ -2273,7 +2523,10 @@ class Workflow:
         )
 
         # Read existing session from database
-        workflow_session = self.read_or_create_session(session_id=session_id, user_id=user_id)
+        if self._has_async_db():
+            workflow_session = await self.aread_or_create_session(session_id=session_id, user_id=user_id)
+        else:
+            workflow_session = self.read_or_create_session(session_id=session_id, user_id=user_id)
         self._update_metadata(session=workflow_session)
 
         # Update session state from DB
@@ -2403,6 +2656,8 @@ class Workflow:
             show_step_details: Whether to show individual step outputs
             console: Rich console instance (optional)
         """
+        if self._has_async_db():
+            raise Exception("`print_response()` is not supported with an async DB. Please use `aprint_response()`.")
 
         if stream is None:
             stream = self.stream or False
@@ -2635,6 +2890,18 @@ class Workflow:
             session.session_data = {}
         session.session_data["session_metrics"] = session_metrics.to_dict()
 
+    async def aget_session_metrics(self, session_id: Optional[str] = None) -> Optional[Metrics]:
+        """Get the session metrics for the given session ID and user ID."""
+        session_id = session_id or self.session_id
+        if session_id is None:
+            raise Exception("Session ID is required")
+
+        session = await self.aget_session(session_id=session_id)  # type: ignore
+        if session is None:
+            raise Exception("Session not found")
+
+        return self._get_session_metrics(session=session)
+
     def get_session_metrics(self, session_id: Optional[str] = None) -> Optional[Metrics]:
         """Get the session metrics for the given session ID and user ID."""
         session_id = session_id or self.session_id
@@ -2727,27 +2994,27 @@ class Workflow:
         **kwargs: Any,
     ) -> None:
         """
-            Run an interactive command-line interface to interact with the workflow.
-        
-            This method creates a CLI interface that allows users to interact with the workflow
-            either by providing a single input or through continuous interactive prompts.
-            
-            Arguments:
-                input: Optional initial input to process before starting interactive mode.
-                session_id: Optional session identifier for maintaining conversation context.
-                user_id: Optional user identifier for tracking user-specific data.
-                user: Display name for the user in the CLI prompt. Defaults to "User".
-                emoji: Emoji to display next to the user name in prompts. Defaults to ":technologist:".
-                stream: Whether to stream the workflow response. If None, uses workflow default.
-                stream_intermediate_steps: Whether to stream intermediate step outputs. If None, uses workflow default.
-                markdown: Whether to render output as markdown. Defaults to True.
-                show_time: Whether to display timestamps in the output. Defaults to True.
-                show_step_details: Whether to show detailed step information. Defaults to True.
-                exit_on: List of commands that will exit the CLI. Defaults to ["exit", "quit", "bye", "stop"].
-                **kwargs: Additional keyword arguments passed to the workflow's print_response method.
-            
-            Returns:
-                None: This method runs interactively and does not return a value.
+        Run an interactive command-line interface to interact with the workflow.
+
+        This method creates a CLI interface that allows users to interact with the workflow
+        either by providing a single input or through continuous interactive prompts.
+
+        Arguments:
+            input: Optional initial input to process before starting interactive mode.
+            session_id: Optional session identifier for maintaining conversation context.
+            user_id: Optional user identifier for tracking user-specific data.
+            user: Display name for the user in the CLI prompt. Defaults to "User".
+            emoji: Emoji to display next to the user name in prompts. Defaults to ":technologist:".
+            stream: Whether to stream the workflow response. If None, uses workflow default.
+            stream_intermediate_steps: Whether to stream intermediate step outputs. If None, uses workflow default.
+            markdown: Whether to render output as markdown. Defaults to True.
+            show_time: Whether to display timestamps in the output. Defaults to True.
+            show_step_details: Whether to show detailed step information. Defaults to True.
+            exit_on: List of commands that will exit the CLI. Defaults to ["exit", "quit", "bye", "stop"].
+            **kwargs: Additional keyword arguments passed to the workflow's print_response method.
+
+        Returns:
+            None: This method runs interactively and does not return a value.
         """
 
         from rich.prompt import Prompt
@@ -2799,27 +3066,27 @@ class Workflow:
         **kwargs: Any,
     ) -> None:
         """
-            Run an interactive command-line interface to interact with the workflow.
-        
-            This method creates a CLI interface that allows users to interact with the workflow
-            either by providing a single input or through continuous interactive prompts.
-            
-            Arguments:
-                input: Optional initial input to process before starting interactive mode.
-                session_id: Optional session identifier for maintaining conversation context.
-                user_id: Optional user identifier for tracking user-specific data.
-                user: Display name for the user in the CLI prompt. Defaults to "User".
-                emoji: Emoji to display next to the user name in prompts. Defaults to ":technologist:".
-                stream: Whether to stream the workflow response. If None, uses workflow default.
-                stream_intermediate_steps: Whether to stream intermediate step outputs. If None, uses workflow default.
-                markdown: Whether to render output as markdown. Defaults to True.
-                show_time: Whether to display timestamps in the output. Defaults to True.
-                show_step_details: Whether to show detailed step information. Defaults to True.
-                exit_on: List of commands that will exit the CLI. Defaults to ["exit", "quit", "bye", "stop"].
-                **kwargs: Additional keyword arguments passed to the workflow's print_response method.
-            
-            Returns:
-                None: This method runs interactively and does not return a value.
+        Run an interactive command-line interface to interact with the workflow.
+
+        This method creates a CLI interface that allows users to interact with the workflow
+        either by providing a single input or through continuous interactive prompts.
+
+        Arguments:
+            input: Optional initial input to process before starting interactive mode.
+            session_id: Optional session identifier for maintaining conversation context.
+            user_id: Optional user identifier for tracking user-specific data.
+            user: Display name for the user in the CLI prompt. Defaults to "User".
+            emoji: Emoji to display next to the user name in prompts. Defaults to ":technologist:".
+            stream: Whether to stream the workflow response. If None, uses workflow default.
+            stream_intermediate_steps: Whether to stream intermediate step outputs. If None, uses workflow default.
+            markdown: Whether to render output as markdown. Defaults to True.
+            show_time: Whether to display timestamps in the output. Defaults to True.
+            show_step_details: Whether to show detailed step information. Defaults to True.
+            exit_on: List of commands that will exit the CLI. Defaults to ["exit", "quit", "bye", "stop"].
+            **kwargs: Additional keyword arguments passed to the workflow's print_response method.
+
+        Returns:
+            None: This method runs interactively and does not return a value.
         """
 
         from rich.prompt import Prompt