unique_toolkit 0.5.55__tar.gz → 0.6.0__tar.gz

{unique_toolkit-0.5.55 → unique_toolkit-0.6.0}/CHANGELOG.md

@@ -5,6 +5,21 @@ 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.0] - 2025-02-21
+- make for each domain, its base functionality accessible from `functions.py`
+- make it possible to instantiate the domain services directly from different event types, inhereted from common `BaseEvent`
+- extend the functionalities in the ShortTermMemoryService by adding the `find_latest_memory` and `create_memory` functions for sync and async usage
+- remove logger dependency from service classes
+- marked deprecated:
+  - `from_chat_event` in ShortTermMemoryService, use `ShortTermMemoryService(event=event)` instead
+  - `complete_async_util` in LanguageModelService, use `functions.complete_async` instead
+  - `stream_complete_async` in LanguageModelService, use `stream_complete_to_chat_async` instead
+  - `stream_complete` in LanguageModelService, use `stream_complete_to_chat` instead
+  - `Event` and nested schemas in `app`, use `ChatEvent` and `ChatEventUserMessage`, `ChatEventAssistantMessage` and `ChatEventToolMessage` instead
+
+## [0.5.56] - 2025-02-19
+- Add `MessageAssessment` title field and change label values
+
 ## [0.5.55] - 2025-02-18
 - Log `contentId` for better debugging
 
@@ -35,7 +50,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Move tool_calls to assistant message as not needed anywhere else.
 
 ## [0.5.46] - 2025-01-07
-- Added `AZURE_GPT_35_TURBO_0125` as new model into toolkit.
+ - Added `AZURE_GPT_35_TURBO_0125` as new model into toolkit.
 
 ## [0.5.45] - 2025-01-03
 - Added `ShortTermMemoryService` class to handle short term memory.

{unique_toolkit-0.5.55 → unique_toolkit-0.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: unique_toolkit
-Version: 0.5.55
+Version: 0.6.0
 Summary: 
 License: Proprietary
 Author: Martin Fadler
@@ -29,10 +29,9 @@ The Toolkit is structured along the following domains:
 - `unique_toolkit.content`
 - `unique_toolkit.embedding`
 - `unique_toolkit.language_model`
+- `unique_toolkit.short_term_memory`
 
-Each domain comprises a service class (in `service.py`) which encapsulates the basic functionalities to interact with the domain entities, the schemas 
-(in `schemas.py`) used in the service and required for interacting with the service functions, utility functions (in `utils.py`) which give additional
-functionality to interact with the domain entities (all domains except embedding) and other domain specific functionalities which are explained in the respective domain documentation.
+Each domain comprises a set of functions (in `functions.py`) and a service class (in `service.py`) which encapsulates the basic functionalities to interact with the domain entities, the schemas (in `schemas.py`) used in the service and required for interacting with the service functions, utility functions (in `utils.py`) which give additional functionality to interact with the domain entities (all domains except embedding) and other domain specific functionalities which are explained in the respective domain documentation.
 
 In addition, the `unique_toolkit.app` module provides functions to initialize apps that interact with the Unique platform. It also includes some utility functions to run async tasks in parallel (async webserver and app implementation required).
 
@@ -55,14 +54,16 @@ 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, modifying messages, and managing message assessments.
-- `schemas.py` comprises all relevant schemas, e.g., ChatMessage, MessageAssessment, used in the ChatService.
+- `functions.py` comprises the functions to manage and load the chat history and interact with the chat ui, e.g., creating a new assistant message.
+- `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.
 - `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
 
 The `unique_toolkit.content` module encompasses all content related functionality. Content can be any type of textual data that is stored in the Knowledgebase on the Unique platform. During the ingestion of the content, the content is parsed, split in chunks, indexed, and stored in the database.
 
+- `functions.py` comprises the functions to manage and load the chat history and interact with the chat ui, e.g., creating a new assistant message.
 - `service.py` comprises the ContentService and provides an interface to interact with the content, e.g., search content, search content chunks, upload and download content.
 - `schemas.py` comprises all relevant schemas, e.g., Content and ContentChunk, used in the ContentService.
 - `utils.py` comprise utility functions to manipulate Content and ContentChunk objects, e.g., sort_content_chunks and merge_content_chunks.
@@ -71,6 +72,7 @@ The `unique_toolkit.content` module encompasses all content related functionalit
 
 The `unique_toolkit.embedding` module encompasses all embedding related functionality. Embeddings are used to represent textual data in a high-dimensional space. The embeddings can be used to calculate the similarity between two texts, for instance.
 
+- `functions.py` comprises the functions to embed text and calculate the similarity between two texts.
 - `service.py` encompasses the EmbeddingService and provides an interface to interact with the embeddings, e.g., embed text and calculate the similarity between two texts.
 - `schemas.py` comprises all relevant schemas, e.g., Embeddings, used in the EmbeddingService.
 
@@ -80,10 +82,19 @@ The `unique_toolkit.language_model` module encompasses all language model relate
 Unique platform.
 
 - `infos.py` comprises the information on all language models deployed through the Unique platform. We recommend to use the LanguageModel class, initialized with the LanguageModelName, e.g., LanguageModel(LanguageModelName.AZURE_GPT_35_TURBO_0125) to get the information on the specific language model like the name, version, token limits or retirement date.
+- `functions.py` comprises the functions to complete and stream complete to chat.
 - `service.py` comprises the LanguageModelService and provides an interface to interact with the language models, e.g., complete or stream_complete. 
 - `schemas.py` comprises all relevant schemas, e.g., LanguageModelResponse, used in the LanguageModelService.
 - `utils.py` comprises utility functions to parse the output of the language model, e.g., convert_string_to_json finds and parses the last json object in a string.
 
+## Short Term Memory
+
+The `unique_toolkit.short_term_memory` module encompasses all short term memory related functionality.
+
+- `functions.py` comprises the functions to manage and load the chat history and interact with the chat ui, e.g., creating a new assistant message.
+- `service.py` comprises the ShortTermMemoryService and provides an interface to interact with the short term memory, e.g., create memory.
+- `schemas.py` comprises all relevant schemas, e.g., ShortTermMemory, used in the ShortTermMemoryService.
+
 # Development instructions
 
 1. Install poetry on your system (through `brew` or `pipx`).
@@ -100,6 +111,21 @@ 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.0] - 2025-02-21
+- make for each domain, its base functionality accessible from `functions.py`
+- make it possible to instantiate the domain services directly from different event types, inhereted from common `BaseEvent`
+- extend the functionalities in the ShortTermMemoryService by adding the `find_latest_memory` and `create_memory` functions for sync and async usage
+- remove logger dependency from service classes
+- marked deprecated:
+  - `from_chat_event` in ShortTermMemoryService, use `ShortTermMemoryService(event=event)` instead
+  - `complete_async_util` in LanguageModelService, use `functions.complete_async` instead
+  - `stream_complete_async` in LanguageModelService, use `stream_complete_to_chat_async` instead
+  - `stream_complete` in LanguageModelService, use `stream_complete_to_chat` instead
+  - `Event` and nested schemas in `app`, use `ChatEvent` and `ChatEventUserMessage`, `ChatEventAssistantMessage` and `ChatEventToolMessage` instead
+
+## [0.5.56] - 2025-02-19
+- Add `MessageAssessment` title field and change label values
+
 ## [0.5.55] - 2025-02-18
 - Log `contentId` for better debugging
 
@@ -130,7 +156,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Move tool_calls to assistant message as not needed anywhere else.
 
 ## [0.5.46] - 2025-01-07
-- Added `AZURE_GPT_35_TURBO_0125` as new model into toolkit.
+ - Added `AZURE_GPT_35_TURBO_0125` as new model into toolkit.
 
 ## [0.5.45] - 2025-01-03
 - Added `ShortTermMemoryService` class to handle short term memory.

{unique_toolkit-0.5.55 → unique_toolkit-0.6.0}/README.md

@@ -7,10 +7,9 @@ The Toolkit is structured along the following domains:
 - `unique_toolkit.content`
 - `unique_toolkit.embedding`
 - `unique_toolkit.language_model`
+- `unique_toolkit.short_term_memory`
 
-Each domain comprises a service class (in `service.py`) which encapsulates the basic functionalities to interact with the domain entities, the schemas 
-(in `schemas.py`) used in the service and required for interacting with the service functions, utility functions (in `utils.py`) which give additional
-functionality to interact with the domain entities (all domains except embedding) and other domain specific functionalities which are explained in the respective domain documentation.
+Each domain comprises a set of functions (in `functions.py`) and a service class (in `service.py`) which encapsulates the basic functionalities to interact with the domain entities, the schemas (in `schemas.py`) used in the service and required for interacting with the service functions, utility functions (in `utils.py`) which give additional functionality to interact with the domain entities (all domains except embedding) and other domain specific functionalities which are explained in the respective domain documentation.
 
 In addition, the `unique_toolkit.app` module provides functions to initialize apps that interact with the Unique platform. It also includes some utility functions to run async tasks in parallel (async webserver and app implementation required).
 
@@ -33,14 +32,16 @@ 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, modifying messages, and managing message assessments.
-- `schemas.py` comprises all relevant schemas, e.g., ChatMessage, MessageAssessment, used in the ChatService.
+- `functions.py` comprises the functions to manage and load the chat history and interact with the chat ui, e.g., creating a new assistant message.
+- `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.
 - `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
 
 The `unique_toolkit.content` module encompasses all content related functionality. Content can be any type of textual data that is stored in the Knowledgebase on the Unique platform. During the ingestion of the content, the content is parsed, split in chunks, indexed, and stored in the database.
 
+- `functions.py` comprises the functions to manage and load the chat history and interact with the chat ui, e.g., creating a new assistant message.
 - `service.py` comprises the ContentService and provides an interface to interact with the content, e.g., search content, search content chunks, upload and download content.
 - `schemas.py` comprises all relevant schemas, e.g., Content and ContentChunk, used in the ContentService.
 - `utils.py` comprise utility functions to manipulate Content and ContentChunk objects, e.g., sort_content_chunks and merge_content_chunks.
@@ -49,6 +50,7 @@ The `unique_toolkit.content` module encompasses all content related functionalit
 
 The `unique_toolkit.embedding` module encompasses all embedding related functionality. Embeddings are used to represent textual data in a high-dimensional space. The embeddings can be used to calculate the similarity between two texts, for instance.
 
+- `functions.py` comprises the functions to embed text and calculate the similarity between two texts.
 - `service.py` encompasses the EmbeddingService and provides an interface to interact with the embeddings, e.g., embed text and calculate the similarity between two texts.
 - `schemas.py` comprises all relevant schemas, e.g., Embeddings, used in the EmbeddingService.
 
@@ -58,10 +60,19 @@ The `unique_toolkit.language_model` module encompasses all language model relate
 Unique platform.
 
 - `infos.py` comprises the information on all language models deployed through the Unique platform. We recommend to use the LanguageModel class, initialized with the LanguageModelName, e.g., LanguageModel(LanguageModelName.AZURE_GPT_35_TURBO_0125) to get the information on the specific language model like the name, version, token limits or retirement date.
+- `functions.py` comprises the functions to complete and stream complete to chat.
 - `service.py` comprises the LanguageModelService and provides an interface to interact with the language models, e.g., complete or stream_complete. 
 - `schemas.py` comprises all relevant schemas, e.g., LanguageModelResponse, used in the LanguageModelService.
 - `utils.py` comprises utility functions to parse the output of the language model, e.g., convert_string_to_json finds and parses the last json object in a string.
 
+## Short Term Memory
+
+The `unique_toolkit.short_term_memory` module encompasses all short term memory related functionality.
+
+- `functions.py` comprises the functions to manage and load the chat history and interact with the chat ui, e.g., creating a new assistant message.
+- `service.py` comprises the ShortTermMemoryService and provides an interface to interact with the short term memory, e.g., create memory.
+- `schemas.py` comprises all relevant schemas, e.g., ShortTermMemory, used in the ShortTermMemoryService.
+
 # Development instructions
 
 1. Install poetry on your system (through `brew` or `pipx`).

{unique_toolkit-0.5.55 → unique_toolkit-0.6.0}/pyproject.toml

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

unique_toolkit-0.6.0/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-0.5.55 → unique_toolkit-0.6.0}/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-0.6.0/unique_toolkit/app/schemas.py

@@ -0,0 +1,135 @@
+from enum import StrEnum
+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(
+    alias_generator=camelize,
+    populate_by_name=True,
+    arbitrary_types_allowed=True,
+)
+
+
+class EventName(StrEnum):
+    EXTERNAL_MODULE_CHOSEN = "unique.chat.external-module.chosen"
+
+
+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
+    text: str
+    original_text: str
+    created_at: str
+    language: str
+
+
+@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
+
+
+@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
+
+
+@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
+    description: str
+    configuration: dict[str, Any]
+    chat_id: str
+    assistant_id: str
+    user_message: ChatEventUserMessage
+    assistant_message: ChatEventAssistantMessage
+    text: Optional[str] = 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
+
+    id: str
+    event: EventName
+    user_id: str
+    company_id: str
+    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-0.6.0/unique_toolkit/chat/__init__.py

@@ -0,0 +1,11 @@
+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 .service import ChatService as ChatService
+from .utils import (
+    convert_chat_history_to_injectable_string as convert_chat_history_to_injectable_string,
+)

unique_toolkit-0.6.0/unique_toolkit/chat/constants.py

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