unique_toolkit 0.5.51__tar.gz → 0.5.52__tar.gz

{unique_toolkit-0.5.51 → unique_toolkit-0.5.52}/CHANGELOG.md

@@ -5,6 +5,10 @@ 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.52] - 2025-02-01
+- Add `MessageAssessment` schemas and functions to `ChatService` to handle message assessments.
+- Fix `LanguageModelService.complete_async_util` to use the correct async method.
+
 ## [0.5.51] - 2025-01-30
 - Add missing structured output arguments in complete_async
 

{unique_toolkit-0.5.51 → unique_toolkit-0.5.52}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: unique_toolkit
-Version: 0.5.51
+Version: 0.5.52
 Summary: 
 License: Proprietary
 Author: Martin Fadler
@@ -55,8 +55,8 @@ The `unique_toolkit.app` module encompasses functions for initializing and secur
 
 The `unique_toolkit.chat` module encompasses all chat related functionality.
 
-- `service.py` comprises the ChatService and provides an interface to manage and load the chat history and interact with the chat ui, e.g., creating a new assistant message.
-- `schemas.py` comprises all relevant schemas, e.g., ChatMessage, used in the ChatService.
+- `service.py` comprises the ChatService and provides an interface to manage and load the chat history and interact with the chat ui, e.g., creating a new assistant message, modifying messages, and managing message assessments.
+- `schemas.py` comprises all relevant schemas, e.g., ChatMessage, MessageAssessment, used in the ChatService.
 - `utils.py` comprises utility functions to use and convert ChatMessage objects in assistants, e.g., convert_chat_history_to_injectable_string converts the chat history to a string that can be injected into a prompt. 
 
 ## Content
@@ -100,6 +100,10 @@ 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.52] - 2025-02-01
+- Add `MessageAssessment` schemas and functions to `ChatService` to handle message assessments.
+- Fix `LanguageModelService.complete_async_util` to use the correct async method.
+
 ## [0.5.51] - 2025-01-30
 - Add missing structured output arguments in complete_async
 

{unique_toolkit-0.5.51 → unique_toolkit-0.5.52}/README.md

@@ -33,8 +33,8 @@ The `unique_toolkit.app` module encompasses functions for initializing and secur
 
 The `unique_toolkit.chat` module encompasses all chat related functionality.
 
-- `service.py` comprises the ChatService and provides an interface to manage and load the chat history and interact with the chat ui, e.g., creating a new assistant message.
-- `schemas.py` comprises all relevant schemas, e.g., ChatMessage, used in the ChatService.
+- `service.py` comprises the ChatService and provides an interface to manage and load the chat history and interact with the chat ui, e.g., creating a new assistant message, modifying messages, and managing message assessments.
+- `schemas.py` comprises all relevant schemas, e.g., ChatMessage, MessageAssessment, used in the ChatService.
 - `utils.py` comprises utility functions to use and convert ChatMessage objects in assistants, e.g., convert_chat_history_to_injectable_string converts the chat history to a string that can be injected into a prompt. 
 
 ## Content

{unique_toolkit-0.5.51 → unique_toolkit-0.5.52}/pyproject.toml

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

unique_toolkit-0.5.52/unique_toolkit/chat/__init__.py

@@ -0,0 +1,10 @@
+from .schemas import ChatMessage as ChatMessage
+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-0.5.51 → unique_toolkit-0.5.52}/unique_toolkit/chat/schemas.py

@@ -1,3 +1,4 @@
+from datetime import datetime
 from enum import StrEnum
 from typing import Optional
 
@@ -60,3 +61,37 @@ class ChatMessage(BaseModel):
         if self.role == ChatMessageRole.TOOL and not self.tool_call_id:
             raise ValueError("tool_call_ids is required when role is 'tool'")
         return self
+
+
+class MessageAssessmentStatus(StrEnum):
+    PENDING = "PENDING"
+    DONE = "DONE"
+    ERROR = "ERROR"
+
+
+class MessageAssessmentLabel(StrEnum):
+    POSITIVE = "POSITIVE"
+    NEGATIVE = "NEGATIVE"
+    VERIFIED = "VERIFIED"
+    UNVERIFIED = "UNVERIFIED"
+
+
+class MessageAssessmentType(StrEnum):
+    HALLUCINATION = "HALLUCINATION"
+    COMPLIANCE = "COMPLIANCE"
+
+
+class MessageAssessment(BaseModel):
+    model_config = model_config
+
+    id: str
+    object: str
+    message_id: str
+    assistant_message_id: str
+    status: MessageAssessmentStatus
+    explanation: str
+    label: MessageAssessmentLabel
+    type: MessageAssessmentType
+    is_visible: bool
+    created_at: datetime
+    updated_at: datetime

{unique_toolkit-0.5.51 → unique_toolkit-0.5.52}/unique_toolkit/chat/service.py

@@ -8,7 +8,14 @@ from unique_sdk._list_object import ListObject
 from unique_toolkit._common import _time_utils
 from unique_toolkit._common._base_service import BaseService
 from unique_toolkit.app.schemas import Event
-from unique_toolkit.chat.schemas import ChatMessage, ChatMessageRole
+from unique_toolkit.chat.schemas import (
+    ChatMessage,
+    ChatMessageRole,
+    MessageAssessment,
+    MessageAssessmentLabel,
+    MessageAssessmentStatus,
+    MessageAssessmentType,
+)
 from unique_toolkit.content.schemas import ContentReference
 from unique_toolkit.content.utils import count_tokens
 
@@ -587,3 +594,165 @@ class ChatService(BaseService):
             "completedAt": completed_at_datetime,
         }
         return params
+
+    def create_message_assessment(
+        self,
+        assistant_message_id: str,
+        status: MessageAssessmentStatus,
+        explanation: str,
+        label: MessageAssessmentLabel,
+        type: MessageAssessmentType,
+        is_visible: bool = True,
+    ) -> MessageAssessment:
+        """
+        Creates a message assessment for an assistant message synchronously.
+
+        Args:
+            assistant_message_id (str): The ID of the assistant message to assess
+            status (MessageAssessmentStatus): The status of the assessment (e.g. "DONE")
+            explanation (str): Explanation of the assessment
+            label (MessageAssessmentLabel): The assessment label (e.g. "NEGATIVE")
+            type (MessageAssessmentType): The type of assessment (e.g. "HALLUCINATION")
+            is_visible (bool): Whether the assessment is visible to users. Defaults to True.
+
+        Returns:
+            MessageAssessment: The created message assessment
+
+        Raises:
+            Exception: If the creation fails
+        """
+        try:
+            assessment = unique_sdk.MessageAssessment.create(
+                user_id=self.event.user_id,
+                company_id=self.event.company_id,
+                assistant_message_id=assistant_message_id,
+                status=status.name,
+                explanation=explanation,
+                label=label.name,
+                type=type.name,
+                isVisible=is_visible,
+            )
+            return MessageAssessment(**assessment)
+        except Exception as e:
+            self.logger.error(f"Failed to create message assessment: {e}")
+            raise e
+
+    async def create_message_assessment_async(
+        self,
+        assistant_message_id: str,
+        status: MessageAssessmentStatus,
+        explanation: str,
+        label: MessageAssessmentLabel,
+        type: MessageAssessmentType,
+        is_visible: bool = True,
+    ) -> MessageAssessment:
+        """
+        Creates a message assessment for an assistant message asynchronously.
+
+        Args:
+            assistant_message_id (str): The ID of the assistant message to assess
+            status (MessageAssessmentStatus): The status of the assessment (e.g. "DONE")
+            explanation (str): Explanation of the assessment
+            label (MessageAssessmentLabel): The assessment label (e.g. "NEGATIVE")
+            type (MessageAssessmentType): The type of assessment (e.g. "HALLUCINATION")
+            is_visible (bool): Whether the assessment is visible to users. Defaults to True.
+
+        Returns:
+            MessageAssessment: The created message assessment
+
+        Raises:
+            Exception: If the creation fails
+        """
+        try:
+            assessment = await unique_sdk.MessageAssessment.create_async(
+                user_id=self.event.user_id,
+                company_id=self.event.company_id,
+                assistant_message_id=assistant_message_id,
+                status=status.name,
+                explanation=explanation,
+                label=label.name,
+                type=type.name,
+                isVisible=is_visible,
+            )
+            return MessageAssessment(**assessment)
+        except Exception as e:
+            self.logger.error(f"Failed to create message assessment: {e}")
+            raise e
+
+    def modify_message_assessment(
+        self,
+        assistant_message_id: str,
+        status: MessageAssessmentStatus,
+        explanation: str,
+        label: MessageAssessmentLabel,
+        type: MessageAssessmentType,
+    ) -> MessageAssessment:
+        """
+        Modifies a message assessment for an assistant message synchronously.
+
+        Args:
+            assistant_message_id (str): The ID of the assistant message to assess
+            status (MessageAssessmentStatus): The status of the assessment (e.g. "DONE")
+            explanation (str): Explanation of the assessment
+            label (MessageAssessmentLabel): The assessment label (e.g. "NEGATIVE")
+            type (MessageAssessmentType): The type of assessment (e.g. "HALLUCINATION")
+
+        Returns:
+            dict: The modified message assessment
+
+        Raises:
+            Exception: If the modification fails
+        """
+        try:
+            assessment = unique_sdk.MessageAssessment.modify(
+                user_id=self.event.user_id,
+                company_id=self.event.company_id,
+                assistant_message_id=assistant_message_id,
+                status=status.name,
+                explanation=explanation,
+                label=label.name,
+                type=type.name,
+            )
+            return MessageAssessment(**assessment)
+        except Exception as e:
+            self.logger.error(f"Failed to modify message assessment: {e}")
+            raise e
+
+    async def modify_message_assessment_async(
+        self,
+        assistant_message_id: str,
+        status: MessageAssessmentStatus,
+        explanation: str,
+        label: MessageAssessmentLabel,
+        type: MessageAssessmentType,
+    ) -> MessageAssessment:
+        """
+        Modifies a message assessment for an assistant message asynchronously.
+
+        Args:
+            assistant_message_id (str): The ID of the assistant message to assess
+            status (MessageAssessmentStatus): The status of the assessment (e.g. "DONE")
+            explanation (str): Explanation of the assessment
+            label (MessageAssessmentLabel): The assessment label (e.g. "NEGATIVE")
+            type (MessageAssessmentType): The type of assessment (e.g. "HALLUCINATION")
+
+        Returns:
+            MessageAssessment: The modified message assessment
+
+        Raises:
+            Exception: If the modification fails
+        """
+        try:
+            assessment = await unique_sdk.MessageAssessment.modify_async(
+                user_id=self.event.user_id,
+                company_id=self.event.company_id,
+                assistant_message_id=assistant_message_id,
+                status=status.name,
+                explanation=explanation,
+                label=label.name,
+                type=type.name,
+            )
+            return MessageAssessment(**assessment)
+        except Exception as e:
+            self.logger.error(f"Failed to modify message assessment: {e}")
+            raise e

{unique_toolkit-0.5.51 → unique_toolkit-0.5.52}/unique_toolkit/language_model/service.py

@@ -84,8 +84,9 @@ class LanguageModelService(BaseService):
             self.logger.error(f"Error completing: {e}")
             raise e
 
+    @classmethod
     async def complete_async_util(
-        self,
+        cls,
         company_id: str,
         messages: LanguageModelMessages,
         model_name: LanguageModelName | str,
@@ -122,7 +123,7 @@ class LanguageModelService(BaseService):
         Raises:
             Exception: If an error occurs during the request, an exception is raised and logged.
         """
-        options, model, messages_dict, _ = self._prepare_completion_params_util(
+        options, model, messages_dict, _ = cls._prepare_completion_params_util(
             messages=messages,
             model_name=model_name,
             temperature=temperature,
@@ -369,8 +370,9 @@ class LanguageModelService(BaseService):
         }
         return options
 
+    @classmethod
     def _prepare_completion_params_util(
-        self,
+        cls,
         messages: LanguageModelMessages,
         model_name: LanguageModelName | str,
         temperature: float,
@@ -391,10 +393,10 @@ class LanguageModelService(BaseService):
             - search_context (Optional[dict]): Processed content chunks if provided
         """
 
-        options = self._add_tools_to_options({}, tools)
+        options = cls._add_tools_to_options({}, tools)
 
         if structured_output_model:
-            options = self._add_response_format_to_options(
+            options = cls._add_response_format_to_options(
                 options, structured_output_model, structured_output_enforce_schema
             )
 

unique_toolkit-0.5.51/unique_toolkit/chat/__init__.py

@@ -1,6 +0,0 @@
-from .schemas import ChatMessage as ChatMessage
-from .schemas import ChatMessageRole as ChatMessageRole
-from .service import ChatService as ChatService
-from .utils import (
-    convert_chat_history_to_injectable_string as convert_chat_history_to_injectable_string,
-)