unique_toolkit 0.5.44__tar.gz → 0.5.45__tar.gz

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

@@ -5,6 +5,9 @@ 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.
 

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: unique_toolkit
-Version: 0.5.44
+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,6 +100,9 @@ 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.
 

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

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "unique_toolkit"
-version = "0.5.44"
+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.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)