[SYNPY-1544] Return the AgentPrompt when calling the prompt function (#1158)

Author: BryanFauble

synapseclient/models/agent.py

@@ -384,7 +384,7 @@ async def prompt_async(
         newer_than: Optional[int] = None,
         *,
         synapse_client: Optional[Synapse] = None,
-    ) -> None:
+    ) -> AgentPrompt:
         """Sends a prompt to the agent and adds the response to the AgentSession's
         chat history. A session must be started before sending a prompt.
 
@@ -431,6 +431,7 @@ async def main():
             client.logger.info(f"RESPONSE:\n{agent_prompt.response}\n")
             if enable_trace:
                 client.logger.info(f"TRACE:\n{agent_prompt.trace}")
+        return agent_prompt
 
 
 @dataclass
@@ -811,7 +812,7 @@ async def prompt_async(
         newer_than: Optional[int] = None,
         *,
         synapse_client: Optional[Synapse] = None,
-    ) -> None:
+    ) -> AgentPrompt:
         """Sends a prompt to the agent for the current session.
             If no session is currently active, a new session will be started.
 
@@ -908,7 +909,7 @@ async def main():
             if not self.current_session:
                 await self.start_session_async(synapse_client=synapse_client)
 
-        await self.current_session.prompt_async(
+        return await self.current_session.prompt_async(
             prompt=prompt,
             enable_trace=enable_trace,
             newer_than=newer_than,

synapseclient/models/protocols/agent_protocol.py

@@ -6,7 +6,12 @@
 from synapseclient import Synapse
 
 if TYPE_CHECKING:
-    from synapseclient.models import Agent, AgentSession, AgentSessionAccessLevel
+    from synapseclient.models import (
+        Agent,
+        AgentPrompt,
+        AgentSession,
+        AgentSessionAccessLevel,
+    )
 
 
 class AgentSessionSynchronousProtocol(Protocol):
@@ -109,7 +114,7 @@ def prompt(
         newer_than: Optional[int] = None,
         *,
         synapse_client: Optional[Synapse] = None,
-    ) -> None:
+    ) -> "AgentPrompt":
         """Sends a prompt to the agent and adds the response to the AgentSession's
         chat history. A session must be started before sending a prompt.
 
@@ -140,7 +145,7 @@ def prompt(
                     print_response=True,
                 )
         """
-        return None
+        return AgentPrompt()
 
 
 class AgentSynchronousProtocol(Protocol):
@@ -313,7 +318,7 @@ def prompt(
         newer_than: Optional[int] = None,
         *,
         synapse_client: Optional[Synapse] = None,
-    ) -> None:
+    ) -> "AgentPrompt":
         """Sends a prompt to the agent for the current session.
             If no session is currently active, a new session will be started.
 
@@ -388,4 +393,4 @@ def prompt(
                     session=my_second_session,
                 )
         """
-        return None
+        return AgentPrompt()