synapseclient 4.6.1__tar.gz → 4.7.0__tar.gz

{synapseclient-4.6.1/synapseclient.egg-info → synapseclient-4.7.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: synapseclient
-Version: 4.6.1
+Version: 4.7.0
 Summary: A client for Synapse, a collaborative, open-source research platform that allows teams to share data, track analyses, and collaborate.
 Home-page: https://www.synapse.org
 Author: The Synapse Engineering Team

{synapseclient-4.6.1 → synapseclient-4.7.0}/synapseclient/api/__init__.py

@@ -1,4 +1,12 @@
 # These are all of the models that are used by the Synapse client.
+from .agent_services import (
+    get_agent,
+    get_session,
+    get_trace,
+    register_agent,
+    start_session,
+    update_session,
+)
 from .annotations import set_annotations, set_annotations_async
 from .configuration_services import (
     get_client_authenticated_s3_profile,
@@ -78,4 +86,11 @@ __all__ = [
     "get_transfer_config",
     # entity_factory
     "get_from_entity_factory",
+    # agent_services
+    "register_agent",
+    "get_agent",
+    "start_session",
+    "get_session",
+    "update_session",
+    "get_trace",
 ]

synapseclient-4.7.0/synapseclient/api/agent_services.py

@@ -0,0 +1,189 @@
+"""This module is responsible for exposing the services defined at:
+<https://rest-docs.synapse.org/rest/#org.sagebionetworks.repo.web.controller.AgentController>
+"""
+
+import json
+from typing import TYPE_CHECKING, Any, Dict, Optional
+
+if TYPE_CHECKING:
+    from synapseclient import Synapse
+
+
+async def register_agent(
+    cloud_agent_id: str,
+    cloud_alias_id: Optional[str] = None,
+    *,
+    synapse_client: Optional["Synapse"] = None,
+) -> Dict[str, Any]:
+    """
+    Registers an agent with Synapse OR gets existing agent registration.
+    Sends a request matching
+    <https://rest-docs.synapse.org/rest/org/sagebionetworks/repo/model/agent/AgentRegistrationRequest.html>
+
+    Arguments:
+        cloud_agent_id: The cloud provider ID of the agent to register.
+        cloud_alias_id: The cloud provider alias ID of the agent to register.
+                        In the Synapse API, this defaults to 'TSTALIASID'.
+        synapse_client: If not passed in and caching was not disabled by
+                `Synapse.allow_client_caching(False)` this will use the last created
+                instance from the Synapse class constructor.
+
+    Returns:
+        The registered agent matching
+            <https://rest-docs.synapse.org/rest/org/sagebionetworks/repo/model/agent/AgentRegistration.html>
+    """
+    from synapseclient import Synapse
+
+    client = Synapse.get_client(synapse_client=synapse_client)
+
+    request = {"awsAgentId": cloud_agent_id}
+    if cloud_alias_id:
+        request["awsAliasId"] = cloud_alias_id
+    return await client.rest_put_async(
+        uri="/agent/registration", body=json.dumps(request)
+    )
+
+
+async def get_agent(
+    registration_id: str,
+    *,
+    synapse_client: Optional["Synapse"] = None,
+) -> Dict[str, Any]:
+    """
+    Gets information about an existing agent registration.
+
+    Arguments:
+        registration_id: The ID of the agent registration to get.
+        synapse_client: If not passed in and caching was not disabled by
+                `Synapse.allow_client_caching(False)` this will use the last created
+                instance from the Synapse class constructor.
+
+    Returns:
+        The requested agent registration matching
+            <https://rest-docs.synapse.org/rest/org/sagebionetworks/repo/model/agent/AgentRegistration.html>
+    """
+    from synapseclient import Synapse
+
+    client = Synapse.get_client(synapse_client=synapse_client)
+    return await client.rest_get_async(uri=f"/agent/registration/{registration_id}")
+
+
+async def start_session(
+    access_level: str,
+    agent_registration_id: str,
+    *,
+    synapse_client: Optional["Synapse"] = None,
+) -> Dict[str, Any]:
+    """
+    Starts a new chat session with an agent.
+    Sends a request matching
+    <https://rest-docs.synapse.org/rest/org/sagebionetworks/repo/model/agent/CreateAgentSessionRequest.html>
+
+    Arguments:
+        access_level: The access level of the agent.
+        agent_registration_id: The ID of the agent registration to start the session for.
+        synapse_client: If not passed in and caching was not disabled by
+                `Synapse.allow_client_caching(False)` this will use the last created
+                instance from the Synapse class constructor.
+    """
+    from synapseclient import Synapse
+
+    client = Synapse.get_client(synapse_client=synapse_client)
+
+    request = {
+        "agentAccessLevel": access_level,
+        "agentRegistrationId": agent_registration_id,
+    }
+    return await client.rest_post_async(uri="/agent/session", body=json.dumps(request))
+
+
+async def get_session(
+    id: str,
+    *,
+    synapse_client: Optional["Synapse"] = None,
+) -> Dict[str, Any]:
+    """
+    Gets information about an existing chat session.
+
+    Arguments:
+        id: The ID of the session to get.
+        synapse_client: If not passed in and caching was not disabled by
+                `Synapse.allow_client_caching(False)` this will use the last created
+                instance from the Synapse class constructor.
+
+    Returns:
+        The requested session matching
+            <https://rest-docs.synapse.org/rest/org/sagebionetworks/repo/model/agent/AgentSession.html>
+    """
+    from synapseclient import Synapse
+
+    client = Synapse.get_client(synapse_client=synapse_client)
+    return await client.rest_get_async(uri=f"/agent/session/{id}")
+
+
+async def update_session(
+    id: str,
+    access_level: str,
+    *,
+    synapse_client: Optional["Synapse"] = None,
+) -> Dict[str, Any]:
+    """
+    Updates the access level for a chat session.
+    Sends a request matching
+    <https://rest-docs.synapse.org/rest/org/sagebionetworks/repo/model/agent/UpdateAgentSessionRequest.html>
+
+    Arguments:
+        id: The ID of the session to update.
+        access_level: The access level of the agent.
+        synapse_client: If not passed in and caching was not disabled by
+                `Synapse.allow_client_caching(False)` this will use the last created
+                instance from the Synapse class constructor.
+    """
+    from synapseclient import Synapse
+
+    client = Synapse.get_client(synapse_client=synapse_client)
+
+    request = {
+        "sessionId": id,
+        "agentAccessLevel": access_level,
+    }
+    return await client.rest_put_async(
+        uri=f"/agent/session/{id}", body=json.dumps(request)
+    )
+
+
+async def get_trace(
+    prompt_id: str,
+    *,
+    newer_than: Optional[int] = None,
+    synapse_client: Optional["Synapse"] = None,
+) -> Dict[str, Any]:
+    """
+    Gets the trace of a prompt.
+    Sends a request matching
+    <https://rest-docs.synapse.org/rest/org/sagebionetworks/repo/model/agent/TraceEventsRequest.html>
+
+    Arguments:
+        prompt_id: The token of the prompt to get the trace for.
+        newer_than: The timestamp to get trace results newer than. Defaults to None (all results).
+                    Timestamps should be in milliseconds since the epoch per the API documentation.
+                    https://rest-docs.synapse.org/rest/org/sagebionetworks/repo/model/agent/TraceEvent.html
+        synapse_client: If not passed in and caching was not disabled by
+                `Synapse.allow_client_caching(False)` this will use the last created
+                instance from the Synapse class constructor.
+
+    Returns:
+        The trace matching
+            <https://rest-docs.synapse.org/rest/org/sagebionetworks/repo/model/agent/TraceEventsResponse.html>
+    """
+    from synapseclient import Synapse
+
+    client = Synapse.get_client(synapse_client=synapse_client)
+
+    request = {
+        "jobId": prompt_id,
+        "newerThanTimestamp": newer_than,
+    }
+    return await client.rest_post_async(
+        uri=f"/agent/chat/trace/{prompt_id}", body=json.dumps(request)
+    )

{synapseclient-4.6.1 → synapseclient-4.7.0}/synapseclient/client.py

@@ -6373,20 +6373,17 @@ class Synapse(object):
         Returns:
             JSON encoding of response
         """
-        try:
-            response = await self._rest_call_async(
-                "get",
-                uri,
-                None,
-                endpoint,
-                headers,
-                retry_policy,
-                requests_session_async_synapse,
-                **kwargs,
-            )
-            return self._return_rest_body(response)
-        except Exception:
-            self.logger.exception("Error in rest_get_async")
+        response = await self._rest_call_async(
+            "get",
+            uri,
+            None,
+            endpoint,
+            headers,
+            retry_policy,
+            requests_session_async_synapse,
+            **kwargs,
+        )
+        return self._return_rest_body(response)
 
     async def rest_post_async(
         self,

{synapseclient-4.6.1 → synapseclient-4.7.0}/synapseclient/core/constants/concrete_types.py

@@ -68,3 +68,6 @@ MULTIPART_UPLOAD_COPY_REQUEST = (
 # Activity/Provenance
 USED_URL = "org.sagebionetworks.repo.model.provenance.UsedURL"
 USED_ENTITY = "org.sagebionetworks.repo.model.provenance.UsedEntity"
+
+# Agent
+AGENT_CHAT_REQUEST = "org.sagebionetworks.repo.model.agent.AgentChatRequest"

{synapseclient-4.6.1 → synapseclient-4.7.0}/synapseclient/models/__init__.py

@@ -1,5 +1,11 @@
 # These are all of the models that are used by the Synapse client.
 from synapseclient.models.activity import Activity, UsedEntity, UsedURL
+from synapseclient.models.agent import (
+    Agent,
+    AgentPrompt,
+    AgentSession,
+    AgentSessionAccessLevel,
+)
 from synapseclient.models.annotations import Annotations
 from synapseclient.models.file import File, FileHandle
 from synapseclient.models.folder import Folder
@@ -38,4 +44,8 @@ __all__ = [
     "TeamMember",
     "UserProfile",
     "UserPreference",
+    "Agent",
+    "AgentSession",
+    "AgentSessionAccessLevel",
+    "AgentPrompt",
 ]