[SYNPY-1544] Synapse Agent OOP Model #1152
Conversation
This comment was marked as outdated.
This comment was marked as outdated.
BWMac
changed the title
| @@ -75,8 +75,29 @@ nav: | |||
| - Core: reference/core.md | |||
| - REST Apis: reference/rest_apis.md | |||
| - Experimental: | |||
| - Object-Orientated Models: reference/oop/models.md | |||
| - Async Object-Orientated Models: reference/oop/models_async.md | |||
| - Mixins: | |||
There was a problem hiding this comment.
This is really nice - thanks for this on the fly refactor
| """Send the job to the Asynchronous Job service and wait for it to complete. | ||
| Arguments: | ||
| post_exchange_args: Additional arguments to pass to the request. |
There was a problem hiding this comment.
Could you update what I wrote here to be a little more verbose on how this is intended to be used? Maybe an example too?
Could you also update the language for the synapse_client docstring to match the other areas of the code?
| f"Timeout waiting for query results: {time.time() - start_time} seconds" | ||
| ) | ||
|
|
||
| return result |
There was a problem hiding this comment.
Should we update this to return back the AsynchronousJobStatus instance instead of the raw result from the API call?
| Returns: | ||
| A AsynchronousJobStatus object. | ||
| """ | ||
| self.state = async_job_status.get("jobState", None) |
There was a problem hiding this comment.
We'll need to instantiate a AsynchronousJobState object here
| - register | ||
| - get | ||
| - start_session | ||
| - get_session | ||
| - prompt |
There was a problem hiding this comment.
These functions are not showing on the doc site:
https://synapsepythonclient--1152.org.readthedocs.build/en/1152/reference/experimental/sync/agent/#synapseclient.models.Agent-functions
I think because it's missing inherited_members: true
| AGENT_AWS_ID = "QOTV3KQM1X" | ||
| AGENT_REGISTRATION_ID = "29" |
There was a problem hiding this comment.
Add a comment what these map to
| await agent_session.update_async(synapse_client=self.syn) | ||
| # THEN I expect the access level to be updated | ||
| assert ( | ||
| agent_session.access_level == AgentSessionAccessLevel.READ_YOUR_PRIVATE_DATA | ||
| ) |
There was a problem hiding this comment.
A better verification of this is to make sure that the data was stored in Synapse. Consider if this silently failed and did not persist the data to Synapse. Your instance would have the updated attribute value, but the next time the session is retrieved it could be using the previous access level.
Perform a new read with a new instance after calling update_async and verify on that newly read instance that it contains the right access_level
|
|
||
| def get_test_agent(self) -> Agent: | ||
| return Agent( | ||
| cloud_agent_id="QOTV3KQM1X", |
There was a problem hiding this comment.
You have the AGENT_AWS_ID constant available
Description:
This PR is the implementation of an OOP model for interacting with the new Synapse Agent API endpoints. The design for the model implementation can be found in Confluence.
The core implementation includes (from "bottom to top"):
synapseclient.api.agent_services:synapseclient.models.AgentPrompt:AgentSessionclass and is not intended to be used directly.AsynchronousCommunicatorMixin which includes reusable logic for starting an async job, waiting for it to complete, and returning the response.synapseclient.models.AgentSession:AgentSessionlogic is used in theAgentclass, and we will generally recommend that users utilize theAgentclass as the primary interface.synapseclient.models.Agent:prompt) becomes the default for prompting, but examples for conducting more than one session at a time can be found in the POC script and class docstring.Notes:
Experimentalsection of the documentation, breaking up each model into it's own markdown script which makes maintaining the docs for OOP models a little easier.