unique_toolkit 0.5.43__tar.gz → 0.5.45__tar.gz

{unique_toolkit-0.5.43 → unique_toolkit-0.5.45}/CHANGELOG.md

@@ -5,7 +5,11 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), 
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.5.45] - 2025-01-03
+- Added `ShortTermMemoryService` class to handle short term memory.
 
+## [0.5.44] - 2024-12-18
+- Add `event_constructor` to `verify_signature_and_construct_event` to allow for custom event construction.
 
 ## [0.5.43] - 2024-12-13
 - Add `Prompt` class to handle templated prompts that can be formatted into LanguageModelSystemMessage and LanguageModelUserMessage.

{unique_toolkit-0.5.43 → unique_toolkit-0.5.45}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: unique_toolkit
-Version: 0.5.43
+Version: 0.5.45
 Summary: 
 License: Proprietary
 Author: Martin Fadler
@@ -17,7 +17,7 @@ Requires-Dist: python-dotenv (>=1.0.1,<2.0.0)
 Requires-Dist: regex (>=2024.5.15,<2025.0.0)
 Requires-Dist: tiktoken (>=0.7.0,<0.8.0)
 Requires-Dist: typing-extensions (>=4.9.0,<5.0.0)
-Requires-Dist: unique-sdk (>=0.9.14,<0.10.0)
+Requires-Dist: unique-sdk (>=0.9.17,<0.10.0)
 Description-Content-Type: text/markdown
 
 # Unique Toolkit
@@ -100,7 +100,11 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), 
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.5.45] - 2025-01-03
+- Added `ShortTermMemoryService` class to handle short term memory.
 
+## [0.5.44] - 2024-12-18
+- Add `event_constructor` to `verify_signature_and_construct_event` to allow for custom event construction.
 
 ## [0.5.43] - 2024-12-13
 - Add `Prompt` class to handle templated prompts that can be formatted into LanguageModelSystemMessage and LanguageModelUserMessage.

{unique_toolkit-0.5.43 → unique_toolkit-0.5.45}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "unique_toolkit"
-version = "0.5.43"
+version = "0.5.45"
 description = ""
 authors = [
     "Martin Fadler <martin.fadler@unique.ch>",
@@ -20,7 +20,7 @@ numpy = "^1.26.4"
 python-dotenv = "^1.0.1"
 regex = "^2024.5.15"
 tiktoken = "^0.7.0"
-unique-sdk = "^0.9.14"
+unique-sdk = "^0.9.17"
 
 [tool.poetry.group.dev.dependencies]
 ruff = "0.5.0"

{unique_toolkit-0.5.43 → unique_toolkit-0.5.45}/unique_toolkit/app/verification.py

@@ -1,4 +1,5 @@
 import logging
+from typing import Callable, TypeVar
 
 import unique_sdk
 
@@ -11,12 +12,16 @@ class WebhookVerificationError(Exception):
     pass
 
 
+T = TypeVar("T")
+
+
 def verify_signature_and_construct_event(
     headers: dict[str, str],
     payload: bytes,
     endpoint_secret: str,
     logger: logging.Logger = logging.getLogger(__name__),
-):
+    event_constructor: Callable[..., T] = Event,
+) -> T:
     """
     Verify the signature of a webhook and construct an event object.
 
@@ -25,18 +30,14 @@ def verify_signature_and_construct_event(
         payload (bytes): The raw payload of the webhook request.
         endpoint_secret (str): The secret used to verify the webhook signature.
         logger (logging.Logger): A logger instance for logging messages.
-
+        event_constructor (Callable[..., T]): A callable that constructs an event object.
     Returns:
-        Union[Event, Tuple[Dict[str, bool], int]]:
-            If successful, returns an Event object.
-            If unsuccessful, returns a tuple with an error response and HTTP status code.
+        T: The constructed event object.
 
     Raises:
         WebhookVerificationError: If there's an error during verification or event construction.
     """
 
-    # Only verify the event if there is an endpoint secret defined
-    # Otherwise use the basic event deserialized with json
     sig_header = headers.get("X-Unique-Signature")
     timestamp = headers.get("X-Unique-Created-At")
 
@@ -52,7 +53,7 @@ def verify_signature_and_construct_event(
             endpoint_secret,
         )
         logger.info("✅  Webhook signature verification successful.")
-        return Event(**event)
+        return event_constructor(**event)
     except unique_sdk.SignatureVerificationError as e:
         logger.error("⚠️  Webhook signature verification failed. " + str(e))
         raise WebhookVerificationError(f"Signature verification failed: {str(e)}")

unique_toolkit-0.5.45/unique_toolkit/short_term_memory/schemas.py

@@ -0,0 +1,49 @@
+import json
+
+from humps import camelize
+from pydantic import BaseModel, ConfigDict, Field, field_validator
+
+model_config = ConfigDict(
+    alias_generator=camelize,
+    populate_by_name=True,
+    arbitrary_types_allowed=True,
+)
+
+
+class ShortTermMemory(BaseModel):
+    model_config = model_config
+
+    id: str
+    key: str = Field(alias="object")
+    chat_id: str | None
+    message_id: str | None
+    data: str | dict | int | float | bool | list | None
+
+    @field_validator("chat_id", "message_id", mode="before")
+    def validate_chat_id_or_message_id(cls, v, info):
+        field_name = info.field_name
+        data = info.data
+
+        # Get the other field's value
+        other_field = "message_id" if field_name == "chat_id" else "chat_id"
+        other_value = data.get(other_field)
+
+        # Check if both are None
+        if v is None and other_value is None:
+            camel_name = camelize(field_name)
+            raise ValueError(
+                f"Either {camel_name} or messageId must be provided"
+                if field_name == "chat_id"
+                else f"Either chatId or {camel_name} must be provided"
+            )
+
+        return v
+
+    @field_validator("data", mode="before")
+    def validate_data(cls, v):
+        if isinstance(v, str):
+            try:
+                return json.loads(v)
+            except json.JSONDecodeError:
+                return v
+        return v

unique_toolkit-0.5.45/unique_toolkit/short_term_memory/service.py

@@ -0,0 +1,57 @@
+import json
+
+from unique_sdk.api_resources._short_term_memory import (
+    ShortTermMemory as ShortTermMemoryAPI,
+)
+
+from unique_toolkit.app import Event
+
+from .schemas import ShortTermMemory
+
+
+class ShortTermMemoryService:
+    def __init__(
+        self,
+        user_id: str,
+        company_id: str,
+        chat_id: str | None,
+        message_id: str | None = None,
+    ):
+        assert chat_id or message_id, "Either chat_id or message_id must be provided"
+        self.user_id = user_id
+        self.company_id = company_id
+        self.chat_id = chat_id
+        self.message_id = message_id
+
+    @classmethod
+    def from_chat_event(cls, chat_event: Event) -> "ShortTermMemoryService":
+        return cls(
+            user_id=chat_event.user_id,
+            company_id=chat_event.company_id,
+            chat_id=chat_event.payload.chat_id,
+            message_id=chat_event.payload.user_message.id,
+        )
+
+    async def get(self, key: str) -> ShortTermMemory:
+        stm = await ShortTermMemoryAPI.find_latest_async(
+            user_id=self.user_id,
+            company_id=self.company_id,
+            memoryName=key,
+            chatId=self.chat_id,
+            messageId=self.message_id,
+        )
+
+        return ShortTermMemory(**stm)
+
+    async def set(self, key: str, value: str | dict):
+        if isinstance(value, dict):
+            value = json.dumps(value)
+        stm = await ShortTermMemoryAPI.create_async(
+            user_id=self.user_id,
+            company_id=self.company_id,
+            memoryName=key,
+            chatId=self.chat_id,
+            messageId=self.message_id,
+            data=value,
+        )
+        return ShortTermMemory(**stm)