unique_toolkit 0.5.55__py3-none-any.whl → 0.6.0__py3-none-any.whl

unique_toolkit/_common/validate_required_values.py

@@ -0,0 +1,21 @@
+from typing import Sequence, TypeVar
+
+T = TypeVar("T")
+
+
+def validate_required_values(values: Sequence[T | None]) -> Sequence[T]:
+    """
+    Validates that all values are not None and returns the sequence.
+
+    Args:
+        values: Sequence of possibly None values
+
+    Returns:
+        The same sequence, now guaranteed to have no None values
+
+    Raises:
+        ValueError: If any values are None
+    """
+    if any(v is None for v in values):
+        raise ValueError("Required values cannot be None")
+    return values  # type: ignore  # We know these aren't None after validation

unique_toolkit/app/__init__.py

@@ -5,6 +5,24 @@ from .performance.async_tasks import (
     run_async_tasks_parallel as run_async_tasks_parallel,
 )
 from .performance.async_wrapper import to_async as to_async
+from .schemas import (
+    BaseEvent as BaseEvent,
+)
+from .schemas import (
+    ChatEvent as ChatEvent,
+)
+from .schemas import (
+    ChatEventAdditionalParameters as ChatEventAdditionalParameters,
+)
+from .schemas import (
+    ChatEventAssistantMessage as ChatEventAssistantMessage,
+)
+from .schemas import (
+    ChatEventPayload as ChatEventPayload,
+)
+from .schemas import (
+    ChatEventUserMessage as ChatEventUserMessage,
+)
 from .schemas import (
     Event as Event,
 )
@@ -23,3 +41,5 @@ from .schemas import (
 from .verification import (
     verify_signature_and_construct_event as verify_signature_and_construct_event,
 )
+
+DOMAIN_NAME = "app"

unique_toolkit/app/schemas.py

@@ -3,6 +3,7 @@ from typing import Any, Optional
 
 from humps import camelize
 from pydantic import BaseModel, ConfigDict
+from typing_extensions import deprecated
 
 # set config to convert camelCase to snake_case
 model_config = ConfigDict(
@@ -16,7 +17,21 @@ class EventName(StrEnum):
     EXTERNAL_MODULE_CHOSEN = "unique.chat.external-module.chosen"
 
 
-class EventUserMessage(BaseModel):
+class BaseEvent(BaseModel):
+    model_config = model_config
+
+    id: str
+    event: str
+    user_id: str
+    company_id: str
+
+
+###
+# ChatEvent schemas
+###
+
+
+class ChatEventUserMessage(BaseModel):
     model_config = model_config
 
     id: str
@@ -26,21 +41,51 @@ class EventUserMessage(BaseModel):
     language: str
 
 
-class EventAssistantMessage(BaseModel):
+@deprecated(
+    "Use `ChatEventUserMessage` instead. "
+    "This class will be removed in the next major version."
+)
+class EventUserMessage(ChatEventUserMessage):
+    """Deprecated: Use `ChatEventUserMessage` instead."""
+
+    pass
+
+
+class ChatEventAssistantMessage(BaseModel):
     model_config = model_config
 
     id: str
     created_at: str
 
 
-class EventAdditionalParameters(BaseModel):
+@deprecated(
+    "Use `ChatEventAssistantMessage` instead. "
+    "This class will be removed in the next major version."
+)
+class EventAssistantMessage(ChatEventAssistantMessage):
+    """Deprecated: Use `ChatEventAssistantMessage` instead."""
+
+    pass
+
+
+class ChatEventAdditionalParameters(BaseModel):
     model_config = model_config
 
     translate_to_language: Optional[str] = None
     content_id_to_translate: Optional[str] = None
 
 
-class EventPayload(BaseModel):
+@deprecated(
+    "Use `ChatEventAdditionalParameters` instead. "
+    "This class will be removed in the next major version."
+)
+class EventAdditionalParameters(ChatEventAdditionalParameters):
+    """Deprecated: Use `ChatEventAdditionalParameters` instead."""
+
+    pass
+
+
+class ChatEventPayload(BaseModel):
     model_config = model_config
 
     name: str
@@ -48,15 +93,27 @@ class EventPayload(BaseModel):
     configuration: dict[str, Any]
     chat_id: str
     assistant_id: str
-    user_message: EventUserMessage
-    assistant_message: EventAssistantMessage
+    user_message: ChatEventUserMessage
+    assistant_message: ChatEventAssistantMessage
     text: Optional[str] = None
-    additional_parameters: Optional[EventAdditionalParameters] = None
+    additional_parameters: Optional[ChatEventAdditionalParameters] = None
     user_metadata: Optional[dict[str, Any]] = None
     tool_parameters: Optional[dict[str, Any]] = None
     metadata_filter: Optional[dict[str, Any]] = None
 
 
+@deprecated("""UUse `ChatEventPayload` instead.
+            This class will be removed in the next major version.""")
+class EventPayload(ChatEventPayload):
+    user_message: EventUserMessage
+    assistant_message: EventAssistantMessage
+    additional_parameters: Optional[EventAdditionalParameters] = None
+
+
+@deprecated(
+    """Use the more specific `ChatEvent` instead that has the same properties. \
+This class will be removed in the next major version."""
+)
 class Event(BaseModel):
     model_config = model_config
 
@@ -67,3 +124,12 @@ class Event(BaseModel):
     payload: EventPayload
     created_at: Optional[int] = None
     version: Optional[str] = None
+
+
+class ChatEvent(BaseEvent):
+    model_config = model_config
+
+    event: EventName
+    payload: ChatEventPayload
+    created_at: Optional[int] = None
+    version: Optional[str] = None

unique_toolkit/chat/__init__.py

@@ -1,9 +1,10 @@
+from .constants import DOMAIN_NAME as DOMAIN_NAME
 from .schemas import ChatMessage as ChatMessage
+from .schemas import ChatMessageAssessment as ChatMessageAssessment
+from .schemas import ChatMessageAssessmentLabel as ChatMessageAssessmentLabel
+from .schemas import ChatMessageAssessmentStatus as ChatMessageAssessmentStatus
+from .schemas import ChatMessageAssessmentType as ChatMessageAssessmentType
 from .schemas import ChatMessageRole as ChatMessageRole
-from .schemas import MessageAssessment as MessageAssessment
-from .schemas import MessageAssessmentLabel as MessageAssessmentLabel
-from .schemas import MessageAssessmentStatus as MessageAssessmentStatus
-from .schemas import MessageAssessmentType as MessageAssessmentType
 from .service import ChatService as ChatService
 from .utils import (
     convert_chat_history_to_injectable_string as convert_chat_history_to_injectable_string,

unique_toolkit/chat/constants.py

@@ -0,0 +1,3 @@
+DOMAIN_NAME = "chat"
+DEFAULT_PERCENT_OF_MAX_TOKENS = 0.15
+DEFAULT_MAX_MESSAGES = 4