unique_toolkit 0.6.6__tar.gz → 0.6.8__tar.gz

{unique_toolkit-0.6.6 → unique_toolkit-0.6.8}/CHANGELOG.md

@@ -5,6 +5,12 @@ 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.6.8] - 2025-03-11
+- Add `verify_request_and_construct_event` to `verification.py`
+
+## [0.6.7] - 2025-03-10
+- Extend language model message builder
+
 ## [0.6.6] - 2025-03-10
 - Add o1, o1-mini and o3-mini models
 - Remove deprecated gpt4 models

{unique_toolkit-0.6.6 → unique_toolkit-0.6.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: unique_toolkit
-Version: 0.6.6
+Version: 0.6.8
 Summary: 
 License: Proprietary
 Author: Martin Fadler
@@ -111,6 +111,12 @@ 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.6.8] - 2025-03-11
+- Add `verify_request_and_construct_event` to `verification.py`
+
+## [0.6.7] - 2025-03-10
+- Extend language model message builder
+
 ## [0.6.6] - 2025-03-10
 - Add o1, o1-mini and o3-mini models
 - Remove deprecated gpt4 models

{unique_toolkit-0.6.6 → unique_toolkit-0.6.8}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "unique_toolkit"
-version = "0.6.6"
+version = "0.6.8"
 description = ""
 authors = [
     "Martin Fadler <martin.fadler@unique.ch>",

{unique_toolkit-0.6.6 → unique_toolkit-0.6.8}/unique_toolkit/app/schemas.py

@@ -102,7 +102,7 @@ class ChatEventPayload(BaseModel):
     metadata_filter: Optional[dict[str, Any]] = None
 
 
-@deprecated("""UUse `ChatEventPayload` instead.
+@deprecated("""Use `ChatEventPayload` instead.
             This class will be removed in the next major version.""")
 class EventPayload(ChatEventPayload):
     user_message: EventUserMessage

unique_toolkit-0.6.8/unique_toolkit/app/verification.py

@@ -0,0 +1,112 @@
+import json
+import logging
+import os
+from typing import Callable, TypeVar
+
+import unique_sdk
+from pydantic import ValidationError
+
+from unique_toolkit.app.schemas import Event
+
+logger = logging.getLogger(f"toolkit.{__name__}")
+
+
+class WebhookVerificationError(Exception):
+    """Custom exception for webhook verification errors."""
+
+    pass
+
+
+T = TypeVar("T")
+
+
+def verify_signature_and_construct_event(
+    headers: dict[str, str],
+    payload: bytes,
+    endpoint_secret: str,
+    logger: logging.Logger = logger,
+    event_constructor: Callable[..., T] = Event,
+) -> T:
+    """
+    Verify the signature of a webhook and construct an event object.
+
+    Args:
+        headers (Dict[str, str]): The headers of the webhook request.
+        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:
+        T: The constructed event object.
+
+    Raises:
+        WebhookVerificationError: If there's an error during verification or event construction.
+    """
+
+    sig_header = headers.get("X-Unique-Signature")
+    timestamp = headers.get("X-Unique-Created-At")
+
+    if not sig_header or not timestamp:
+        logger.error("⚠️  Webhook signature or timestamp headers missing.")
+        raise WebhookVerificationError("Signature or timestamp headers missing")
+
+    try:
+        event = unique_sdk.Webhook.construct_event(
+            payload,
+            sig_header,
+            timestamp,
+            endpoint_secret,
+        )
+        logger.info("✅  Webhook signature verification successful.")
+        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)}")
+
+
+def verify_request_and_construct_event(
+    assistant_name: str,
+    payload: bytes,
+    headers: dict[str, str],
+    event_constructor: Callable[..., Event] = Event,
+) -> tuple[str, int] | tuple[Event, int]:
+    """Check the payload, authenticate and genenrate the event if the payload is correct"""
+    logger.info(f"{assistant_name} - received request")
+
+    try:
+        payload_decoded = json.loads(payload)
+    except json.decoder.JSONDecodeError as e:
+        logger.error(f"Error decoding payload: {e}", exc_info=True)
+        return "Invalid payload", 400
+
+    endpoint_secret = os.environ.get("ENDPOINT_SECRET", None)
+    if endpoint_secret:
+        response = verify_signature_and_construct_event(
+            headers=headers,  # type: ignore
+            payload=payload,
+            endpoint_secret=endpoint_secret,
+            logger=logger,
+            event_constructor=event_constructor,
+        )
+        if isinstance(response, tuple):
+            return response  # Error response
+        event = response  # This is an event since it is not a tuple
+    else:
+        try:
+            event = event_constructor(**payload_decoded)
+        except ValidationError as e:
+            # pydantic errors https://docs.pydantic.dev/2.10/errors/errors/
+            logger.error(f"Validation error with model: {e.json()}", exc_info=True)
+            raise ValidationError(e)
+        except ValueError as e:
+            logger.error(f"Error deserializing event: {e}", exc_info=True)
+            return "Invalid event", 400
+
+    if not event.payload.name == assistant_name:
+        logger.error(
+            f"{assistant_name}: Incorrect assistant: {event.payload.name}: Expected {assistant_name}"
+        )
+        return f"Not {assistant_name} event", 400
+
+    logger.info(f"{assistant_name} - received event")
+    return event, 200

{unique_toolkit-0.6.6 → unique_toolkit-0.6.8}/unique_toolkit/language_model/builder.py

@@ -3,6 +3,7 @@ from typing_extensions import Self
 from unique_toolkit.language_model import (
     LanguageModelAssistantMessage,
     LanguageModelMessage,
+    LanguageModelMessageRole,
     LanguageModelMessages,
     LanguageModelSystemMessage,
     LanguageModelToolMessage,
@@ -14,6 +15,11 @@ class MessagesBuilder:
     def __init__(self):
         self.messages: list[LanguageModelMessage] = []
 
+    def message_append(self, role: LanguageModelMessageRole, content: str):
+        message = LanguageModelMessage(role=role, content=content)
+        self.messages.append(message)
+        return self
+
     def system_message_append(self, content: str) -> Self:
         """Appends a system message to the messages list."""
         message = LanguageModelSystemMessage(content=content)
@@ -26,15 +32,18 @@ class MessagesBuilder:
         self.messages.append(message)
         return self  # Return self to allow method chaining
 
-    def image_message_append(self, content: str, images: list[str]) -> Self:
-        message = LanguageModelUserMessage(
+    def image_message_append(
+        self, content: str, images: list[str], role=LanguageModelMessageRole.USER
+    ) -> Self:
+        message = LanguageModelMessage(
+            role=role,
             content=[
                 {"type": "text", "text": content},
                 *[
                     {"type": "image_url", "imageUrl": {"url": image}}
                     for image in images
                 ],
-            ]
+            ],
         )
         self.messages.append(message)
         return self

unique_toolkit-0.6.6/unique_toolkit/app/verification.py

@@ -1,59 +0,0 @@
-import logging
-from typing import Callable, TypeVar
-
-import unique_sdk
-
-from unique_toolkit.app.schemas import Event
-
-
-class WebhookVerificationError(Exception):
-    """Custom exception for webhook verification errors."""
-
-    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.
-
-    Args:
-        headers (Dict[str, str]): The headers of the webhook request.
-        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:
-        T: The constructed event object.
-
-    Raises:
-        WebhookVerificationError: If there's an error during verification or event construction.
-    """
-
-    sig_header = headers.get("X-Unique-Signature")
-    timestamp = headers.get("X-Unique-Created-At")
-
-    if not sig_header or not timestamp:
-        logger.error("⚠️  Webhook signature or timestamp headers missing.")
-        raise WebhookVerificationError("Signature or timestamp headers missing")
-
-    try:
-        event = unique_sdk.Webhook.construct_event(
-            payload,
-            sig_header,
-            timestamp,
-            endpoint_secret,
-        )
-        logger.info("✅  Webhook signature verification successful.")
-        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)}")