Removes example setting annotations with Agent class (#1156)

* removes annotation example * pre-commit
Sage-Bionetworks · Jan 29, 2025 · cd8820a · cd8820a
1 parent d085b02
commit cd8820a
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 13 deletions.
diff --git a/synapseclient/models/agent.py b/synapseclient/models/agent.py
@@ -826,8 +826,8 @@ async def prompt_async(
                     `Synapse.allow_client_caching(False)` this will use the last created
                     instance from the Synapse class constructor.
 
-        Example: Prompt the baseline Synapse Agent to add annotations to a file on Synapse
-            The baseline Synpase Agent can be used to add annotations to files.
+        Example: Prompt the baseline Synapse Agent.
+            The baseline Synapse Agent is equivilent to the Agent available in the Synapse UI.
 
                 import asyncio
                 from synapseclient import Synapse
@@ -838,11 +838,8 @@ async def prompt_async(
 
                 async def main():
                     my_agent = Agent()
-                    await my_agent.start_session_async(
-                        access_level=AgentSessionAccessLevel.WRITE_YOUR_PRIVATE_DATA
-                    )
                     await my_agent.prompt_async(
-                        prompt="Add the annotation 'test' to the file 'syn123456789'",
+                        prompt="Can you tell me about the AD Knowledge Portal dataset?",
                         enable_trace=True,
                         print_response=True,
                     )

diff --git a/synapseclient/models/protocols/agent_protocol.py b/synapseclient/models/protocols/agent_protocol.py
@@ -328,21 +328,18 @@ def prompt(
                     `Synapse.allow_client_caching(False)` this will use the last created
                     instance from the Synapse class constructor.
 
-        Example: Prompt the baseline Synapse Agent to add annotations to a file on Synapse
-            The baseline Synpase Agent can be used to add annotations to files.
+        Example: Prompt the baseline Synapse Agent.
+            The baseline Synapse Agent is equivilent to the Agent available in the Synapse UI.
 
             from synapseclient import Synapse
-            from synapseclient.models import Agent, AgentSessionAccessLevel
+            from synapseclient.models import Agent
 
             syn = Synapse()
             syn.login()
 
             my_agent = Agent()
-            my_agent.start_session(
-                access_level=AgentSessionAccessLevel.WRITE_YOUR_PRIVATE_DATA
-            )
             my_agent.prompt(
-                prompt="Add the annotation 'test' to the file 'syn123456789'",
+                prompt="Can you tell me about the AD Knowledge Portal dataset?",
                 enable_trace=True,
                 print_response=True,
             )