cheshirecat-python-sdk 1.7.10__tar.gz → 1.8.0__tar.gz

{cheshirecat_python_sdk-1.7.10 → cheshirecat_python_sdk-1.8.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cheshirecat-python-sdk
-Version: 1.7.10
+Version: 1.8.0
 Summary: Python SDK for the Cloud-ready fork of the Cheshire Cat
 Project-URL: Repository, https://github.com/matteocacciola/cheshirecat-python-sdk
 Project-URL: Documentation, https://github.com/matteocacciola/cheshirecat-python-sdk#README

{cheshirecat_python_sdk-1.7.10 → cheshirecat_python_sdk-1.8.0}/cheshirecat_python_sdk/client.py

@@ -18,6 +18,7 @@ from cheshirecat_python_sdk.endpoints import (
     UtilsEndpoint,
     VectorDatabaseEndpoint,
     HealthCheckEndpoint,
+    AgenticWorkflowEndpoint,
 )
 
 
@@ -64,6 +65,10 @@ class CheshireCatClient:
     def auth_handler(self):
         return AuthHandlerEndpoint(self)
 
+    @property
+    def agentic_workflow(self):
+        return AgenticWorkflowEndpoint(self)
+
     @property
     def chunker(self):
         return ChunkerEndpoint(self)

{cheshirecat_python_sdk-1.7.10 → cheshirecat_python_sdk-1.8.0}/cheshirecat_python_sdk/endpoints/__init__.py

@@ -1,4 +1,5 @@
 from cheshirecat_python_sdk.endpoints.admins import AdminsEndpoint
+from cheshirecat_python_sdk.endpoints.agentic_workflow import AgenticWorkflowEndpoint
 from cheshirecat_python_sdk.endpoints.auth import AuthEndpoint
 from cheshirecat_python_sdk.endpoints.auth_handler import AuthHandlerEndpoint
 from cheshirecat_python_sdk.endpoints.chunker import ChunkerEndpoint

cheshirecat_python_sdk-1.8.0/cheshirecat_python_sdk/endpoints/agentic_workflow.py

@@ -0,0 +1,52 @@
+from typing import Dict, Any
+
+from cheshirecat_python_sdk.endpoints.base import AbstractEndpoint
+from cheshirecat_python_sdk.models.api.factories import FactoryObjectSettingsOutput, FactoryObjectSettingOutput
+
+
+class AgenticWorkflowEndpoint(AbstractEndpoint):
+    def __init__(self, client: "CheshireCatClient"):
+        super().__init__(client)
+        self.prefix = "/agentic_workflow"
+
+    def get_agentic_workflows_settings(self, agent_id: str) -> FactoryObjectSettingsOutput:
+        """
+        Get all agentic workflow settings for the agent with the given ID.
+        :param agent_id: The ID of the agent.
+        :return: FactoryObjectSettingsOutput, containing the settings for all agentic workflows.
+        """
+        return self.get(
+            self.format_url("/settings"),
+            agent_id,
+            output_class=FactoryObjectSettingsOutput,
+        )
+
+    def get_agentic_workflow_settings(self, agentic_workflow: str, agent_id: str) -> FactoryObjectSettingOutput:
+        """
+        Get the settings for the agentic workflow with the given name.
+        :param agentic_workflow: The name of the agentic workflow.
+        :param agent_id: The ID of the agent.
+        :return: FactoryObjectSettingOutput, containing the settings for the agentic workflow.
+        """
+        return self.get(
+            self.format_url(f"/settings/{agentic_workflow}"),
+            agent_id,
+            output_class=FactoryObjectSettingOutput,
+        )
+
+    def put_agentic_workflow_settings(
+        self, agentic_workflow: str, agent_id: str, values: Dict[str, Any]
+    ) -> FactoryObjectSettingOutput:
+        """
+        Update the settings for the agentic workflow with the given name.
+        :param agentic_workflow: The name of the agentic workflow.
+        :param agent_id: The ID of the agent.
+        :param values: The new settings for the agentic workflow.
+        :return: FactoryObjectSettingOutput, containing the updated settings for the agentic workflow.
+        """
+        return self.put(
+            self.format_url(f"/settings/{agentic_workflow}"),
+            agent_id,
+            output_class=FactoryObjectSettingOutput,
+            payload=values,
+        )

{cheshirecat_python_sdk-1.7.10 → cheshirecat_python_sdk-1.8.0}/cheshirecat_python_sdk/endpoints/users.py

@@ -11,7 +11,12 @@ class UsersEndpoint(AbstractEndpoint):
         self.prefix = "/users"
 
     def post_user(
-        self, agent_id: str, username: str, password: str, permissions: dict[str, Any] | None = None
+        self,
+        agent_id: str,
+        username: str,
+        password: str,
+        permissions: dict[str, Any] | None = None,
+        metadata: dict[str, Any] | None = None,
     ) -> UserOutput:
         """
         This endpoint is used to create a new user in the system. The user is created with the specified username and
@@ -22,6 +27,7 @@ class UsersEndpoint(AbstractEndpoint):
         :param username: The username of the user to create
         :param password: The password of the user to create
         :param permissions: The permissions of the user to create (optional)
+        :param metadata: The metadata of the user to create (optional)
         :return UserOutput, the created user
         """
         payload = {
@@ -31,6 +37,9 @@ class UsersEndpoint(AbstractEndpoint):
         if permissions is not None:
             payload["permissions"] = permissions  # type: ignore
 
+        if metadata is not None:
+            payload["metadata"] = metadata  # type: ignore
+
         return self.post_json(
             self.prefix,
             agent_id,
@@ -75,6 +84,7 @@ class UsersEndpoint(AbstractEndpoint):
         username: str | None = None,
         password: str | None = None,
         permissions: Dict[str, Any] | None = None,
+        metadata: Dict[str, Any] | None = None,
     ) -> UserOutput:
         """
         The endpoint is used to update the user in the system. The user is identified by the userId parameter, previously
@@ -87,6 +97,7 @@ class UsersEndpoint(AbstractEndpoint):
         :param username: The new username of the user (optional)
         :param password: The new password of the user (optional)
         :param permissions: The new permissions of the user (optional)
+        :param metadata: The new metadata of the user (optional)
         :return UserOutput, the updated user
         """
         payload = {}
@@ -96,6 +107,8 @@ class UsersEndpoint(AbstractEndpoint):
             payload["password"] = password
         if permissions is not None:
             payload["permissions"] = permissions
+        if metadata is not None:
+            payload["metadata"] = metadata
 
         return self.put(self.format_url(user_id), agent_id, output_class=UserOutput, payload=payload)
 

{cheshirecat_python_sdk-1.7.10 → cheshirecat_python_sdk-1.8.0}/cheshirecat_python_sdk/models/api/users.py

@@ -1,10 +1,11 @@
-from typing import Dict, List
+from typing import Dict, List, Any
 from pydantic import BaseModel
 
 
 class UserOutput(BaseModel):
     username: str
     permissions: Dict[str, List[str]]
+    metadata: Dict[str, Any] | None = None
     id: str
     created_at: float | None = None
     updated_at: float | None = None

{cheshirecat_python_sdk-1.7.10 → cheshirecat_python_sdk-1.8.0}/pyproject.toml

@@ -1,7 +1,7 @@
 [project]
 name = "cheshirecat-python-sdk"
 description = "Python SDK for the Cloud-ready fork of the Cheshire Cat"
-version = "1.7.10"
+version = "1.8.0"
 requires-python = ">=3.10"
 license = { file = "LICENSE" }
 authors = [