Merge branch 'main' into develop

Author: nicola-corbellini

cheshire_cat_api/cat_client.py

@@ -46,9 +46,12 @@ def url(self):
         return f"{secure}{self.settings.base_url}{port}"
 
     def _connect(self):
+        connection_url = f"ws{self.url}/{self.settings.ws.path}"
+        if self.settings.ws.user_id is not None:
+            connection_url += f"/{self.settings.ws.user_id}"
         """"Connect to the WebSocket in a separate thread"""
         self._ws = WebSocketApp(
-            f"ws{self.url}/{self.settings.ws.path}",
+            connection_url,
             on_message=self.on_ws_message,
             on_error=self.on_ws_error,
             on_close=self.on_ws_close,
@@ -71,6 +74,7 @@ def run(self):
                 header_name='access_token',
                 header_value=self.settings.auth_key
             ))
+            time.sleep(2)
             self.is_started = True
             time.sleep(2)
 
@@ -125,12 +129,16 @@ def on_ws_close(self, ws, close_status_code: int, msg: str):
 
         print(f"Connection closed: {msg}")
 
-    def send(self, message: str, prompt_settings: Dict = {}):
+    def send(self, message: str, prompt_settings=None, user_id="user", **kwargs):
         """Send a message to WebSocket server using a separate thread"""
+        if prompt_settings is None:
+            prompt_settings = {}
         if not self.is_closed:
             self._ws.send(json.dumps({
                 "text": message,
-                "prompt_settings": prompt_settings
+                "prompt_settings": prompt_settings,
+                "user_id": user_id,
+                **kwargs
             }))
 
     def close(self):

cheshire_cat_api/utils.py

@@ -23,34 +23,44 @@ class WebSocketSettings:
     Class containing the WebSocket configuration options and variables used by ccat-api package
     """
 
-    def __init__(self):
+    def __init__(self, path='ws', retries=3, delay=5000, on_failed=None, user_id=None):
         # Websocket path to use to communicate with the CCat
-        self.path = 'ws'
+        self.path = path
         # The maximum number of retries before calling on_failed
-        self.retries = 3
+        self.retries = retries
         # The delay for reconnect, in milliseconds
-        self.delay = 5000
+        self.delay = delay
         # The function to call after failing to reconnect
-        self.on_failed = None
+        self.on_failed = on_failed
+        # User to connect with
+        self.user_id = user_id
 
 
 class Settings:
     """
     Class containing all the configuration options and variables used by ccat-api package
     """
 
-    def __init__(self):
+    def __init__(self,
+                 base_url='localhost',
+                 auth_key='',
+                 port=1865,
+                 secure=False,
+                 timeout=10000,
+                 instant=True,
+                 ws=WebSocketSettings(),
+                 ):
         # The URL to which connect to the Cat
-        self.base_url = 'localhost'
+        self.base_url = base_url
         # The key to authenticate the Cat endpoints
-        self.auth_key = ''
+        self.auth_key = auth_key
         # The port to which connect to the Cat
-        self.port = 1865
+        self.port = port
         # Choose to either use the secure protocol or not
-        self.secure = False
+        self.secure = secure
         # Timeout for the endpoints, in milliseconds
-        self.timeout = 10000
+        self.timeout = timeout
         # Choose to either instantly initialize websocket and api client or not
-        self.instant = True
+        self.instant = instant
         # WebSocket Settings
-        self.ws = WebSocketSettings()
+        self.ws = ws

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "cheshire_cat_api"
-version = "1.0.1"
+version = "1.0.2"
 description = "😸 Cheshire-Cat API Client"
 authors = ["Chesire Cat AI"]
 maintainers = [